Autres/audacity
1
0
Fork 0
mirror of https://github.com/cookiengineer/audacity synced 2025-08-16 08:34:10 +02:00
Code Issues Releases Wiki Activity

Improve status bar messages and tooltips for pushbuttons

Browse Source
This commit is contained in:
Paul Licameli 2016-05-02 00:31:06 -04:00
parent 0e9cb10979
commit 8cfa9e217f
2 changed files with 98 additions and 58 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
src/widgets/Ruler.cpp
View File

@ -1910,17 +1910,12 @@ wxFont &AdornedRulerPanel::GetButtonFont() const
done = true;
mButtonFont.SetPointSize(mButtonFontSize);
wxCoord width, height;
for (unsigned ii = 0;
done && ii < static_cast<unsigned>(Button::NumButtons); ++ii) {
auto button = static_cast<Button>(ii);
for (auto button = StatusChoice::FirstButton; done && IsButton(button); ++button) {
auto allowableWidth = GetButtonRect(button).GetWidth() - 2;
// 2 corresponds with the Inflate(-1, -1)
GetParent()->GetTextExtent(wxGetTranslation(PushbuttonLabels[ii]),
&width,
&height,
NULL,
NULL,
&mButtonFont);
GetParent()->GetTextExtent(
wxGetTranslation(GetPushButtonStrings(button)->label),
&width, &height, NULL, NULL, &mButtonFont);
done = width < allowableWidth;
}
mButtonFontSize--;
@ -1944,6 +1939,7 @@ void AdornedRulerPanel::RegenerateTooltips()
}
else {
switch(mPrevZone) {
case StatusChoice::QuickPlayButton :
case StatusChoice::EnteringQP :
if (!mQuickPlayEnabled) {
this->SetToolTip(_("Quick-Play disabled"));
@ -1952,6 +1948,14 @@ void AdornedRulerPanel::RegenerateTooltips()
this->SetToolTip(_("Quick-Play enabled"));
}
break;
case StatusChoice::ScrubBarButton :
if (!mShowScrubbing) {
this->SetToolTip(_("Scrub bar hidden"));
}
else {
this->SetToolTip(_("Scrub bar shown"));
}
break;
case StatusChoice::EnteringScrubZone :
this->SetToolTip(_("Scrub Bar"));
break;
@ -2162,6 +2166,7 @@ void AdornedRulerPanel::OnMouseEvents(wxMouseEvent &evt)
}
const bool overButtons = GetButtonAreaRect().Contains(evt.GetPosition());
const StatusChoice button = FindButton(evt.GetPosition());
const bool inScrubZone = !overButtons &&
// only if scrubbing is allowed now
mProject->GetScrubber().CanScrub() &&
@ -2169,7 +2174,7 @@ void AdornedRulerPanel::OnMouseEvents(wxMouseEvent &evt)
mScrubZone.Contains(evt.GetPosition());
const StatusChoice zone =
overButtons
? StatusChoice::EnteringPushbuttons
? button
: inScrubZone
? StatusChoice::EnteringScrubZone
: StatusChoice::EnteringQP;
@ -2255,20 +2260,13 @@ void AdornedRulerPanel::OnMouseEvents(wxMouseEvent &evt)
return;
}
if (HasCapture() && mCaptureState != Button::NoButton)
if (HasCapture() && mCaptureState != StatusChoice::NoButton)
HandlePushbuttonEvent(evt);
else if (!HasCapture() && overButtons) {
if (evt.ButtonDown()) {
auto position = evt.GetPosition();
for (unsigned ii = 0; ii < static_cast<unsigned>(Button::NumButtons); ++ii) {
auto button = static_cast<Button>(ii);
if(GetButtonRect(button).Contains(position)) {
CaptureMouse();
mCaptureState = button;
Refresh();
break;
}
}
if (evt.ButtonDown() && button != StatusChoice::NoButton) {
CaptureMouse();
mCaptureState = button;
Refresh();
}
}
// Handle popup menus
@ -2464,7 +2462,7 @@ void AdornedRulerPanel::HandleQPRelease(wxMouseEvent &evt)
if (HasCapture())
ReleaseMouse();
mCaptureState = Button::NoButton;
mCaptureState = StatusChoice::NoButton;
if (mPlayRegionEnd < mPlayRegionStart) {
// Swap values to ensure mPlayRegionStart < mPlayRegionEnd
@ -2571,8 +2569,12 @@ void AdornedRulerPanel::UpdateStatusBarAndTooltips(StatusChoice choice)
wxString message {};
if (choice == StatusChoice::EnteringPushbuttons)
;
if (IsButton(choice)) {
bool state = GetButtonState(choice);
const auto &strings = *GetPushButtonStrings(choice);
message += wxGetTranslation(state ? strings.disable : strings.enable);
message += wxT(" ") + _("(Right-Click for options)");
}
else {
const auto &scrubber = mProject->GetScrubber();
const bool scrubbing = scrubber.HasStartedScrubbing();
@ -2839,32 +2841,45 @@ wxRect AdornedRulerPanel::GetButtonAreaRect() const
return rect;
}
wxRect AdornedRulerPanel::GetButtonRect( Button button ) const
wxRect AdornedRulerPanel::GetButtonRect( StatusChoice button ) const
{
if (!IsButton(button))
return wxRect {};
wxRect rect { GetButtonAreaRect() };
// Reduce the height
rect.height -= (GetRulerHeight() - ProperRulerHeight);
auto num = static_cast<unsigned>(button);
auto denom = static_cast<unsigned>(Button::NumButtons);
auto denom = static_cast<unsigned>(StatusChoice::NumButtons);
rect.x += (num * rect.width) / denom;
rect.width = (((1 + num) * rect.width) / denom) - rect.x;
return rect;
}
bool AdornedRulerPanel::InButtonRect( Button button ) const
bool AdornedRulerPanel::InButtonRect( StatusChoice button ) const
{
return GetButtonRect(button).Contains(ScreenToClient(::wxGetMousePosition()));
}
bool AdornedRulerPanel::GetButtonState( Button button ) const
auto AdornedRulerPanel::FindButton( wxPoint position ) const -> StatusChoice
{
for (auto button = StatusChoice::FirstButton; IsButton(button); ++button) {
if(GetButtonRect(button).Contains(position))
return button;
}
return StatusChoice::NoButton;
}
bool AdornedRulerPanel::GetButtonState( StatusChoice button ) const
{
switch(button) {
case Button::QuickPlay:
case StatusChoice::QuickPlayButton:
return mQuickPlayEnabled;
case Button::ScrubBar:
case StatusChoice::ScrubBarButton:
return mShowScrubbing;
default:
wxASSERT(false);
@ -2872,15 +2887,15 @@ bool AdornedRulerPanel::GetButtonState( Button button ) const
}
}
void AdornedRulerPanel::ToggleButtonState( Button button )
void AdornedRulerPanel::ToggleButtonState( StatusChoice button )
{
switch(button) {
case Button::QuickPlay: {
case StatusChoice::QuickPlayButton: {
wxCommandEvent dummy;
OnToggleQuickPlay(dummy);
}
break;
case Button::ScrubBar:
case StatusChoice::ScrubBarButton:
OnToggleScrubbing();
break;
default:
@ -2888,14 +2903,15 @@ void AdornedRulerPanel::ToggleButtonState( Button button )
}
}
const wxString AdornedRulerPanel::PushbuttonLabels
[static_cast<size_t>(AdornedRulerPanel::Button::NumButtons)] {
XO("Quick-Play"),
const AdornedRulerPanel::ButtonStrings AdornedRulerPanel::PushbuttonLabels
[static_cast<size_t>(StatusChoice::NumButtons)]
{
{ XO("Quick-Play"), XO("Enable Quick-Play"), XO("Disable Quick-Play") },
/* i18n-hint: A long screen area (bar) controlling variable speed play (scrubbing) */
XO("Scrub Bar"),
{ XO("Scrub Bar"), XO("Show Scrub Bar"), XO("Hide Scrub Bar") },
};
void AdornedRulerPanel::DoDrawPushbutton(wxDC *dc, Button button, bool down) const
void AdornedRulerPanel::DoDrawPushbutton(wxDC *dc, StatusChoice button, bool down) const
{
// Adapted from TrackInfo::DrawMuteSolo()
@ -2916,7 +2932,7 @@ void AdornedRulerPanel::DoDrawPushbutton(wxDC *dc, Button button, bool down) con
dc->SetTextForeground(theTheme.Colour(clrTrackPanelText));
wxCoord textWidth, textHeight;
wxString str = wxGetTranslation(PushbuttonLabels[static_cast<unsigned>(button)]);
wxString str = wxGetTranslation(GetPushButtonStrings(button)->label);
dc->SetFont(GetButtonFont());
dc->GetTextExtent(str, &textWidth, &textHeight);
dc->DrawText(str, bev.x + (bev.width - textWidth) / 2,
@ -2929,9 +2945,11 @@ void AdornedRulerPanel::HandlePushbuttonEvent(wxMouseEvent &evt)
if(evt.ButtonUp()) {
if(HasCapture())
ReleaseMouse();
if(InButtonRect(mCaptureState))
if(InButtonRect(mCaptureState)) {
ToggleButtonState(mCaptureState);
mCaptureState = Button::NoButton;
UpdateStatusBarAndTooltips(mCaptureState);
}
mCaptureState = StatusChoice::NoButton;
}
Refresh();
@ -2944,8 +2962,7 @@ void AdornedRulerPanel::DoDrawPushbuttons(wxDC *dc) const
AColor::MediumTrackInfo(dc, false);
dc->DrawRectangle(background);
for (unsigned ii = 0; ii < static_cast<unsigned>(Button::NumButtons); ++ii) {
auto button = static_cast<Button>(ii);
for (auto button = StatusChoice::FirstButton; IsButton(button); ++button) {
auto state = GetButtonState(button);
auto toggle = (button == mCaptureState && InButtonRect(button));
auto down = (state != toggle);

51
src/widgets/Ruler.h
View File

@ -328,12 +328,31 @@ private:
void HandleQPRelease(wxMouseEvent &event);
enum class StatusChoice {
EnteringPushbuttons,
EnteringQP,
FirstButton = 0,
QuickPlayButton = FirstButton,
ScrubBarButton,
NumButtons,
NoButton = -1,
EnteringQP = NumButtons,
EnteringScrubZone,
Leaving,
NoChange
};
friend inline StatusChoice &operator++ (StatusChoice &choice) {
choice = static_cast<StatusChoice>(1 + static_cast<int>(choice));
return choice;
}
static inline bool IsButton(StatusChoice choice)
{
auto integer = static_cast<int>(choice);
return integer >= 0 &&
integer < static_cast<int>(StatusChoice::NumButtons);
}
static inline bool IsButton(int choice)
{ return IsButton(static_cast<StatusChoice>(choice)); }
void UpdateStatusBarAndTooltips(StatusChoice choice);
void OnCaptureLost(wxMouseCaptureLostEvent &evt);
@ -349,20 +368,24 @@ private:
void DoDrawPlayRegion(wxDC * dc);
wxRect GetButtonAreaRect() const;
enum class Button {
QuickPlay = 0,
ScrubBar,
NumButtons,
NoButton = -1
struct ButtonStrings {
wxString label, enable, disable;
};
static const wxString PushbuttonLabels[];
static const ButtonStrings PushbuttonLabels[];
static const ButtonStrings *GetPushButtonStrings(StatusChoice choice)
{
if(IsButton(choice))
return &PushbuttonLabels[static_cast<size_t>(choice)];
return nullptr;
}
wxRect GetButtonRect( Button button ) const;
bool InButtonRect( Button button ) const;
bool GetButtonState( Button button ) const;
void ToggleButtonState( Button button );
void DoDrawPushbutton(wxDC *dc, Button button, bool down) const;
wxRect GetButtonRect( StatusChoice button ) const;
bool InButtonRect( StatusChoice button ) const;
StatusChoice FindButton( wxPoint position ) const;
bool GetButtonState( StatusChoice button ) const;
void ToggleButtonState( StatusChoice button );
void DoDrawPushbutton(wxDC *dc, StatusChoice button, bool down) const;
void DoDrawPushbuttons(wxDC *dc) const;
void HandlePushbuttonEvent(wxMouseEvent &evt);
@ -435,7 +458,7 @@ private:
bool mQuickPlayEnabled;
Button mCaptureState { Button::NoButton };
StatusChoice mCaptureState { StatusChoice::NoButton };
enum MouseEventState {
mesNone,