A wxButton with mouse-over behaviour. More...

#include <AButton.h>

Inheritance diagram for AButton:

Collaboration diagram for AButton:

Classes
class	Listener

struct	Resetter

Public Types
enum	Type { TextButton , ImageButton , FrameButton , FrameTextButton }

enum	AButtonState { AButtonUp , AButtonOver , AButtonDown , AButtonOverDown , AButtonDis , AButtonStateCount }

Public Member Functions
	AButton (wxWindow *parent=nullptr, wxWindowID id=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, bool toggle=false)

	AButton (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, const wxImage &up, const wxImage &over, const wxImage &down, const wxImage &overDown, const wxImage &dis, bool toggle)

virtual	~AButton ()

void	SetButtonType (Type type)

void	SetFrameMid (int mid)

void	SetToolTip (const TranslatableString &toolTip)

void	SetLabel (const TranslatableString &label)

bool	AcceptsFocus () const override

bool	AcceptsFocusFromKeyboard () const override

void	SetFocusFromKbd () override

void	SetImages (const wxImage &up, const wxImage &over, const wxImage &down, const wxImage &overDown, const wxImage &dis)

void	SetAlternateImages (unsigned idx, const wxImage &up, const wxImage &over, const wxImage &down, const wxImage &overDown, const wxImage &dis)

void	SetIcon (const wxImage &icon)

void	SetIcon (AButtonState state, const wxImage &icon)

void	SetIcons (const wxImage &up, const wxImage &down, const wxImage &disabled)

void	SetAlternateIcon (unsigned idx, const wxImage &icon)

void	SetAlternateIcon (unsigned idx, AButtonState state, const wxImage &icon)

void	SetAlternateIcons (unsigned idx, const wxImage &up, const wxImage &down, const wxImage &disabled)

void	SetAlternateIdx (unsigned idx)

void	FollowModifierKeys ()

void	SetFocusRect (const wxRect &r)

bool	IsEnabled () const

void	Disable ()

void	Enable ()

void	SetEnabled (bool state)

void	PushDown ()

void	PopUp ()

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnSize (wxSizeEvent &event)

void	OnMouseEvent (wxMouseEvent &event)

void	UpdateStatus ()

void	OnCaptureLost (wxMouseCaptureLostEvent &event)

void	OnKeyDown (wxKeyEvent &event)

void	OnSetFocus (wxFocusEvent &event)

void	OnKillFocus (wxFocusEvent &event)

void	OnCharHook (wxKeyEvent &event)

bool	WasShiftDown ()

bool	WasControlDown ()

bool	IsDown ()

bool	IsDoubleClicked () const

void	ClearDoubleClicked ()

void	SetButtonToggles (bool toggler)

bool	IsToggle () const noexcept

void	InteractionOver ()

void	Toggle ()

void	Click ()

void	SetShift (bool shift)

void	SetControl (bool control)

wxSize	DoGetBestClientSize () const override

AButtonState	GetState ()

void	UseDisabledAsDownHiliteImage (bool flag)

Static Public Member Functions
static TempAllowFocus	TemporarilyAllowFocus ()

Private Types
using	TempAllowFocus = std::unique_ptr< bool, Resetter >

Private Member Functions
bool	HasAlternateImages (unsigned idx) const

void	Init (wxWindow *parent, wxWindowID id, const wxPoint &pos, const wxSize &size, bool toggle)

Private Attributes
unsigned	mAlternateIdx {0}

bool	mToggle {false}

bool	mWasShiftDown {false}

bool	mWasControlDown {false}

bool	mCursorIsInWindow {false}

bool	mButtonIsDown {false}

bool	mIsClicking {false}

bool	mEnabled {true}

bool	mUseDisabledAsDownHiliteImage {false}

bool	mIsDoubleClicked {false}

std::vector< std::array< wxImage, AButtonStateCount > >	mIcons

std::vector< std::array< wxImage, AButtonStateCount > >	mImages

wxRect	mFocusRect

bool	mForceFocusRect {false}

std::unique_ptr< Listener >	mListener

Type	mType {ImageButton}

int	mFrameMid {1}

Static Private Attributes
static bool	s_AcceptsFocus { false }

Friends
class	AButtonAx

Detailed Description

A wxButton with mouse-over behaviour.

AButton is a custom button class for Audacity. The main feature it supports that a wxButton does not is mouseovers.

It uses an image for all of its states: up, over, down, and disabled, allowing any sort of customization you want. Currently it does not support transparency effects, so the image musts be rectangular and opaque.

Definition at line 104 of file AButton.h.

Member Typedef Documentation

◆ TempAllowFocus

using AButton::TempAllowFocus = std::unique_ptr<bool, Resetter>

private

Definition at line 251 of file AButton.h.

Member Enumeration Documentation

◆ AButtonState

enum AButton::AButtonState

Enumerator
AButtonUp
AButtonOver
AButtonDown
AButtonOverDown
AButtonDis
AButtonStateCount

Definition at line 118 of file AButton.h.

                     {
      AButtonUp,
      AButtonOver,
      AButtonDown,
      AButtonOverDown,
      AButtonDis,
 
      AButtonStateCount
   };

◆ Type

enum AButton::Type

Enumerator
TextButton
ImageButton
FrameButton
FrameTextButton

Definition at line 110 of file AButton.h.

   {
      TextButton,
      ImageButton,
      FrameButton,
      FrameTextButton,
   };

Constructor & Destructor Documentation

◆ AButton() [1/2]

AButton::AButton	(	wxWindow *	parent = `nullptr`,
		wxWindowID	id = `wxID_ANY`,
		const wxPoint &	pos = `wxDefaultPosition`,
		const wxSize &	size = `wxDefaultSize`,
		bool	toggle = `false`
	)

Definition at line 118 of file AButton.cpp.

{
   Init(parent, id, pos, size, toggle);
}

References Init(), and size.

Here is the call graph for this function:

◆ AButton() [2/2]

AButton::AButton	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos,
		const wxSize &	size,
		const wxImage &	up,
		const wxImage &	over,
		const wxImage &	down,
		const wxImage &	overDown,
		const wxImage &	dis,
		bool	toggle
	)

Definition at line 123 of file AButton.cpp.

{
   Init(parent, id, pos, size, toggle);
 
   SetAlternateImages(0, up, over, down, overDown, dis);
 
   SetMinSize(mImages[0][AButtonUp].GetSize());
   SetMaxSize(mImages[0][AButtonUp].GetSize());
}

References AButtonUp, Init(), mImages, SetAlternateImages(), and size.

Here is the call graph for this function:

◆ ~AButton()

AButton::~AButton ( )

virtual

Definition at line 142 of file AButton.cpp.

{
   if(HasCapture())
      ReleaseMouse();
}

Member Function Documentation

◆ AcceptsFocus()

bool AButton::AcceptsFocus ( ) const

inlineoverride

Definition at line 158 of file AButton.h.

158{ return s_AcceptsFocus; }

AButton::s_AcceptsFocus

static bool s_AcceptsFocus

Definition: AButton.h:249

◆ AcceptsFocusFromKeyboard()

bool AButton::AcceptsFocusFromKeyboard ( ) const

inlineoverride

Definition at line 159 of file AButton.h.

159{ return mEnabled; }

AButton::mEnabled

bool mEnabled

Definition: AButton.h:276

◆ ClearDoubleClicked()

void AButton::ClearDoubleClicked ( )

inline

Definition at line 230 of file AButton.h.

230{ mIsDoubleClicked = false; }

AButton::mIsDoubleClicked

bool mIsDoubleClicked

Definition: AButton.h:278

◆ Click()

void AButton::Click ( )

Definition at line 664 of file AButton.cpp.

{
   wxCommandEvent event(wxEVT_COMMAND_BUTTON_CLICKED, GetId());
   event.SetEventObject(this);
   // Be sure to use SafelyProcessEvent so that exceptions do not propagate
   // out of DoDefaultAction
   GetEventHandler()->SafelyProcessEvent(event);
}

References wxEVT_COMMAND_BUTTON_CLICKED.

Referenced by OnCharHook(), and OnMouseEvent().

Here is the caller graph for this function:

◆ Disable()

void AButton::Disable ( )

Definition at line 627 of file AButton.cpp.

{
   // Bug 1565: Tooltips not showing on disabled buttons.
   // The fix is to NOT tell windows that the button is disabled.
   // The button's appearance will still change to show it is disabled
   // since we control that rather than windows.
#ifndef __WXMSW__
   wxWindow::Enable(false);
#endif
   if (GetCapture()==this)
      ReleaseMouse();
   if ( mEnabled ) {
      mEnabled = false;
      Refresh(false);
   }
}

References mEnabled.

Referenced by TranscriptionToolBar::Create(), AudioSetupToolBar::EnableDisableButtons(), and RealtimeEffectPanel::ResetTrack().

Here is the caller graph for this function:

◆ DoGetBestClientSize()

wxSize AButton::DoGetBestClientSize ( ) const

override

Definition at line 683 of file AButton.cpp.

{
   const auto imageIdx = HasAlternateImages(mAlternateIdx) ? mAlternateIdx : 0;
   if(imageIdx == mAlternateIdx || HasAlternateImages(imageIdx))
   {
      const auto& image = mImages[imageIdx][AButtonUp];
      switch(mType)
      {
      case FrameButton:
         {
            const auto icon = !mIcons.empty() ? &mIcons[0][AButtonUp] : nullptr;
            if(icon->IsOk())
               return icon->GetSize();
            return image.GetSize();
         }
      case FrameTextButton:
         {
            //Only AButtonUp is used to estimate size
            auto icon = !mIcons.empty() ? &mIcons[0][AButtonUp] : nullptr;
            if(!GetLabel().IsEmpty())
            {
               const auto border = (image.GetSize() - wxSize { mFrameMid, mFrameMid }) / 4;
               
               wxMemoryDC dc;
               dc.SetFont(GetFont());
               auto bestSize = dc.GetTextExtent(GetLabel());
               if(icon != nullptr && icon->IsOk())
               {
                  bestSize.x = std::max(bestSize.x, icon->GetWidth());
                  bestSize.y = bestSize.y > 0
                     ? bestSize.y + border.y + icon->GetHeight()
                     : icon->GetHeight();
               }
               if(bestSize.x > 0)
                  bestSize.x += border.x * 2;
               if(bestSize.y > 0)
                  bestSize.y += border.y * 2;
               return bestSize;
            }
            if(icon->Ok())
               return icon->GetSize();
            return image.GetSize();
         }
      case TextButton:
         return {-1, image.GetHeight() };
      default:
         return image.GetSize();
      }
   }
   return wxWindow::DoGetBestClientSize();
}

References AButtonUp, FrameButton, FrameTextButton, HasAlternateImages(), mAlternateIdx, mFrameMid, mIcons, mImages, mType, and TextButton.

Here is the call graph for this function:

◆ Enable()

void AButton::Enable ( )

Definition at line 618 of file AButton.cpp.

{
   bool changed = wxWindow::Enable(true);
   if ( !mEnabled ) {
      mEnabled = true;
      Refresh(false);
   }
}

References mEnabled.

Referenced by TranscriptionToolBar::Create(), AudioSetupToolBar::EnableDisableButtons(), and RealtimeEffectPanel::SetTrack().

Here is the caller graph for this function:

◆ FollowModifierKeys()

void AButton::FollowModifierKeys ( )

Definition at line 298 of file AButton.cpp.

{
   if(!mListener)
      mListener = std::make_unique<Listener>(this);
}

References mListener.

Referenced by ControlToolBar::Populate(), and TranscriptionToolBar::Populate().

Here is the caller graph for this function:

◆ GetState()

AButton::AButtonState AButton::GetState ( )

Definition at line 310 of file AButton.cpp.

{
   AButtonState state;
 
   if (!mEnabled && (!mToggle || !mButtonIsDown))
      return AButtonDis;
 
   if (mCursorIsInWindow) {
      if (mToggle) {
         if (mIsClicking) {
            state = mButtonIsDown ? AButtonUp : AButtonDown;
            if (mUseDisabledAsDownHiliteImage) {
               state = mButtonIsDown ? AButtonOverDown : AButtonDis;
            }
         }
         else {
            state = mButtonIsDown ? AButtonOverDown : AButtonOver;
            if (mUseDisabledAsDownHiliteImage) {
               state = mButtonIsDown ? AButtonDis : AButtonOver;
            }
         }
      }
      else {
         if (mIsClicking) {
            state = mButtonIsDown ? AButtonOver : AButtonDown;
         }
         else {
            state = mButtonIsDown ? AButtonOverDown : AButtonOver;
         }
      }
   }
   else {
      state = mButtonIsDown ? AButtonDown : AButtonUp;
   }
 
   return state;
}

References AButtonDis, AButtonDown, AButtonOver, AButtonOverDown, AButtonUp, mButtonIsDown, mCursorIsInWindow, mEnabled, mIsClicking, mToggle, and mUseDisabledAsDownHiliteImage.

Referenced by OnMouseEvent(), and OnPaint().

Here is the caller graph for this function:

◆ HasAlternateImages()

bool AButton::HasAlternateImages ( unsigned idx ) const

private

Definition at line 445 of file AButton.cpp.

{
   if (mImages.size() <= idx)
      return false;
 
   const auto &arr = mImages[idx];
   return (arr[0].Ok() &&
           arr[1].Ok() &&
           arr[2].Ok() &&
           arr[3].Ok() &&
           arr[4].Ok());
}

References mImages.

Referenced by DoGetBestClientSize(), and OnPaint().

Here is the caller graph for this function:

◆ Init()

void AButton::Init	(	wxWindow *	parent,
		wxWindowID	id,
		const wxPoint &	pos,
		const wxSize &	size,
		bool	toggle
	)

private

Definition at line 174 of file AButton.cpp.

{
   SetBackgroundStyle(wxBG_STYLE_PAINT);
   SetBackgroundColour(theTheme.Colour(clrMedium));
 
   // Bug in wxWidgets 2.8.12: by default pressing Enter on an AButton is interpreted as
   // a navigation event - move to next control. As a workaround, the style wxWANTS_CHARS
   // results in all characters being available in the OnKeyDown function below. Note
   // that OnKeyDown now has to handle navigation.
   Create(parent, id, pos, size, wxWANTS_CHARS);
 
   mToggle = toggle;
 
   mFocusRect = GetClientRect().Deflate( 3, 3 );
 
#if wxUSE_ACCESSIBILITY
   SetName( wxT("") );
   SetAccessible(safenew AButtonAx(this));
#endif
}

References AButtonAx, ThemeBase::Colour(), mFocusRect, mToggle, safenew, size, theTheme, and wxT().

Referenced by AButton().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InteractionOver()

void AButton::InteractionOver ( )

inline

Definition at line 236 of file AButton.h.

236{ if( !mToggle ) PopUp();}

AButton::PopUp

void PopUp()

Definition: AButton.cpp:652

◆ IsDoubleClicked()

bool AButton::IsDoubleClicked ( ) const

inline

Definition at line 229 of file AButton.h.

229{ return mIsDoubleClicked; }

◆ IsDown()

bool AButton::IsDown ( )

inline

Definition at line 226 of file AButton.h.

226{ return mButtonIsDown;}

Referenced by ControlToolBar::EnableDisableButtons(), RealtimeEffectPanel::MakeMasterEffectPane(), RealtimeEffectPanel::MakeTrackEffectPane(), EffectUIHost::OnEnable(), AudioSetupToolBar::ReCreateButtons(), ControlToolBar::ReCreateButtons(), and ControlToolBar::StateForStatusBar().

Here is the caller graph for this function:

◆ IsEnabled()

bool AButton::IsEnabled ( ) const

inline

Definition at line 197 of file AButton.h.

197{ return mEnabled; }

◆ IsToggle()

bool AButton::IsToggle ( ) const

noexcept

◆ OnCaptureLost()

void AButton::OnCaptureLost ( wxMouseCaptureLostEvent & event )

Definition at line 540 of file AButton.cpp.

{
   wxMouseEvent e(wxEVT_LEFT_UP);
   e.m_x = -1;
   e.m_y = -1;
   OnMouseEvent(e);
}

References OnMouseEvent().

Here is the call graph for this function:

◆ OnCharHook()

void AButton::OnCharHook ( wxKeyEvent & event )

Definition at line 572 of file AButton.cpp.

{
   switch(event.GetKeyCode())
   {
   case WXK_RETURN:
   case WXK_NUMPAD_ENTER:
      if( !mEnabled )
         break;
      mWasShiftDown = event.ShiftDown();
      mWasControlDown = event.ControlDown();
      if(mToggle)
      {
         mButtonIsDown = !mButtonIsDown;
         Refresh(false);
#if wxUSE_ACCESSIBILITY
         GetAccessible()->NotifyEvent(wxACC_EVENT_OBJECT_NAMECHANGE,
            this, wxOBJID_CLIENT, wxACC_SELF);
#endif
      }
      Click();
      break;
   default:
      event.Skip();
   }
}

References Click(), mButtonIsDown, mEnabled, mToggle, mWasControlDown, and mWasShiftDown.

Here is the call graph for this function:

◆ OnErase()

void AButton::OnErase ( wxEraseEvent & event )

Definition at line 429 of file AButton.cpp.

{
   // Ignore it to prevent flashing
}

◆ OnKeyDown()

void AButton::OnKeyDown ( wxKeyEvent & event )

Definition at line 550 of file AButton.cpp.

{
   switch( event.GetKeyCode() )
   {
   case WXK_RIGHT:
   case WXK_DOWN:
      Navigate(wxNavigationKeyEvent::IsForward);
      break;
   case WXK_LEFT:
   case WXK_UP:
      Navigate(wxNavigationKeyEvent::IsBackward);
      break;
   case WXK_TAB:
      Navigate(wxNavigationKeyEvent::FromTab | (event.ShiftDown()
               ? wxNavigationKeyEvent::IsBackward
               : wxNavigationKeyEvent::IsForward));
      break;
   default:
      event.Skip();
   }
}

◆ OnKillFocus()

void AButton::OnKillFocus ( wxFocusEvent & event )

Definition at line 603 of file AButton.cpp.

{
   Refresh( false );
}

◆ OnMouseEvent()

void AButton::OnMouseEvent ( wxMouseEvent & event )

Definition at line 458 of file AButton.cpp.

{
   wxSize clientSize = GetClientSize();
   AButtonState prevState = GetState();
 
   if (event.Entering()) {
      // Bug 1201:  On Mac, unsetting and re-setting the tooltip may be needed
      // to make it pop up when we want it.
      auto text = GetToolTipText();
      UnsetToolTip();
      wxWindow::SetToolTip(text);
      mCursorIsInWindow = true;
   }
   else if (event.Leaving())
      mCursorIsInWindow = false;
   else
      mCursorIsInWindow =
         (event.m_x >= 0 && event.m_y >= 0 &&
          event.m_x < clientSize.x && event.m_y < clientSize.y);
 
   if (mEnabled && event.IsButton()) {
      if (event.ButtonIsDown(wxMOUSE_BTN_LEFT)) {
         mIsClicking = true;
         if (event.ButtonDClick())
            mIsDoubleClicked = true;
         if( !HasCapture() )
            CaptureMouse();
      }
      else if (mIsClicking) {
         mIsClicking = false;
 
         if (HasCapture())
            ReleaseMouse();
 
         if (mCursorIsInWindow && (mToggle || !mButtonIsDown)) {
            if (mToggle)
               mButtonIsDown = !mButtonIsDown;
 
            mWasShiftDown = event.ShiftDown();
            mWasControlDown = event.ControlDown();
 
            Click();
         }
      }
   }
 
   // Only redraw and change tooltips if the state has changed.
   AButtonState newState = GetState();
 
   if (newState != prevState) {
      Refresh(false);
 
      if (mCursorIsInWindow)
         UpdateStatus();
      else {
         auto pProject = FindProjectFromWindow( this );
         if (pProject)
            ProjectStatus::Get( *pProject ).Set({});
      }
   }
   else
      event.Skip();
}

References Click(), FindProjectFromWindow(), ProjectStatus::Get(), GetState(), mButtonIsDown, mCursorIsInWindow, mEnabled, mIsClicking, mIsDoubleClicked, mToggle, mWasControlDown, mWasShiftDown, ProjectStatus::Set(), and UpdateStatus().

Referenced by OnCaptureLost().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ OnPaint()

void AButton::OnPaint ( wxPaintEvent & event )

Definition at line 348 of file AButton.cpp.

{
   wxBufferedPaintDC dc(this);
 
   dc.SetPen(*wxTRANSPARENT_PEN);
   dc.SetBrush(GetBackgroundColour());
   dc.Clear();
 
   const auto buttonRect = GetClientRect();
   const auto imageIdx = HasAlternateImages(mAlternateIdx) ? mAlternateIdx : 0;
   
   if(imageIdx == mAlternateIdx || HasAlternateImages(imageIdx))
   {
      const auto buttonState = GetState();
      if(mType == ImageButton)
         dc.DrawBitmap(mImages[imageIdx][buttonState], buttonRect.GetTopLeft());
      else if(mType == FrameButton || mType == FrameTextButton)
      {
         wxBitmap bitmap = mImages[imageIdx][buttonState];
         AColor::DrawFrame(dc, buttonRect, bitmap, mFrameMid);
 
         const auto border = bitmap.GetSize() / 4;
 
         wxImage* icon{};
         if(mIcons.size() > mAlternateIdx)
            icon = &mIcons[mAlternateIdx][buttonState];
         if((icon == nullptr || !icon->IsOk()) && !mIcons.empty())
         {
            icon = &mIcons[0][buttonState];
            if(!icon->IsOk())
               icon = &mIcons[0][AButtonUp];
         }
         if(mType == FrameTextButton && !GetLabel().IsEmpty())
         {
            dc.SetFont(GetFont());
            auto textRect = buttonRect;
            if(icon != nullptr && icon->IsOk())
            {
               auto fontMetrics = dc.GetFontMetrics();
               auto sumHeight = fontMetrics.height + icon->GetHeight() + border.y;
 
               dc.DrawBitmap(*icon,
                  buttonRect.x + (buttonRect.width - icon->GetWidth()) / 2,
                  buttonRect.y + (buttonRect.height - sumHeight) / 2);
               textRect = wxRect(
                     buttonRect.x,
                     buttonRect.y + buttonRect.height / 2 + sumHeight / 2 - fontMetrics.height,
                     buttonRect.width,
                     fontMetrics.height);
            }
            dc.SetPen(GetForegroundColour());
            dc.DrawLabel(GetLabel(), textRect, wxALIGN_CENTER);
         }
         else if(icon != nullptr && icon->IsOk())
         {
            dc.DrawBitmap(*icon,
               buttonRect.x + (buttonRect.width - icon->GetWidth()) / 2,
                  buttonRect.y + (buttonRect.height - icon->GetHeight()) / 2);
         }
      }
      else
      {
         wxBitmap bitmap = mImages[imageIdx][buttonState];
         AColor::DrawHStretch(dc, GetClientRect(), bitmap);
         if(!GetLabel().IsEmpty())
         {
            dc.SetFont(GetFont());
            const auto text = TrackArt::TruncateText(dc, GetLabel(), GetClientSize().GetWidth() - 6);
            if(!text.IsEmpty())
            {
               dc.SetPen(GetForegroundColour());
               dc.DrawLabel(text, GetClientRect(), wxALIGN_CENTER);
            }
         }
      }
   }
   
   if(HasFocus())
      AColor::DrawFocus( dc, mFocusRect );
}

References AButtonUp, AColor::DrawFocus(), AColor::DrawFrame(), AColor::DrawHStretch(), FrameButton, FrameTextButton, GetState(), HasAlternateImages(), ImageButton, mAlternateIdx, mFocusRect, mFrameMid, mIcons, mImages, mType, TrackArt::TruncateText(), and wxImage().

Here is the call graph for this function:

◆ OnSetFocus()

void AButton::OnSetFocus ( wxFocusEvent & event )

Definition at line 598 of file AButton.cpp.

{
   Refresh( false );
}

◆ OnSize()

void AButton::OnSize ( wxSizeEvent & event )

Definition at line 434 of file AButton.cpp.

{
   if (!mForceFocusRect)
   {
      mFocusRect = GetClientRect().Deflate( 3, 3 );
   }
   Refresh(false);
}

References mFocusRect, and mForceFocusRect.

◆ PopUp()

void AButton::PopUp ( )

Definition at line 652 of file AButton.cpp.

{
   if (mButtonIsDown) {
      mButtonIsDown = false;
 
      this->Refresh(false);
   }
 
   if (GetCapture()==this)
      ReleaseMouse();
}

References mButtonIsDown.

Referenced by ExpandingToolBar::Collapse(), ToolsToolBar::DoToolChanged(), audacity::cloud::ShareAudioToolbar::MakeShareAudioButton(), AudioSetupToolBar::OnAudioSetup(), ControlToolBar::OnFF(), ControlToolBar::OnIdle(), ControlToolBar::OnRewind(), RealtimeEffectPanel::RealtimeEffectPanel(), ToolBar::SetButton(), TranscriptionToolBar::SetButton(), ControlToolBar::SetPlay(), TranscriptionToolBar::SetPlaying(), RealtimeEffectPanel::SetTrack(), ExpandingToolBar::TryAutoCollapse(), AdornedRulerPanel::UpdateButtonStates(), EffectUIHost::UpdateControls(), and MixerTrackCluster::UpdateForStateChange().

Here is the caller graph for this function:

◆ PushDown()

void AButton::PushDown ( )

Definition at line 644 of file AButton.cpp.

{
   if (!mButtonIsDown) {
      mButtonIsDown = true;
      this->Refresh(false);
   }
}

References mButtonIsDown.

Referenced by ToolsToolBar::DoToolChanged(), ExpandingToolBar::Expand(), ControlToolBar::OnFF(), ControlToolBar::OnIdle(), ControlToolBar::OnRewind(), RealtimeEffectPanel::RealtimeEffectPanel(), AudioSetupToolBar::ReCreateButtons(), ControlToolBar::ReCreateButtons(), ToolBar::SetButton(), TranscriptionToolBar::SetButton(), ControlToolBar::SetPlay(), TranscriptionToolBar::SetPlaying(), ControlToolBar::SetStop(), RealtimeEffectPanel::SetTrack(), ExpandingToolBar::TryAutoExpand(), EffectUIHost::UpdateControls(), and MixerTrackCluster::UpdateForStateChange().

Here is the caller graph for this function:

◆ SetAlternateIcon() [1/2]

void AButton::SetAlternateIcon	(	unsigned	idx,
		AButtonState	state,
		const wxImage &	icon
	)

Definition at line 267 of file AButton.cpp.

{
   if(1 + idx > mIcons.size())
      mIcons.resize(1 + idx);
   mIcons[idx][state] = icon;
   Refresh(false);
}

References mIcons.

◆ SetAlternateIcon() [2/2]

void AButton::SetAlternateIcon	(	unsigned	idx,
		const wxImage &	icon
	)

Definition at line 257 of file AButton.cpp.

{
   if(1 + idx > mIcons.size())
      mIcons.resize(1 + idx);
   mIcons[idx][AButtonUp] = icon;
   mIcons[idx][AButtonOver] = mIcons[idx][AButtonDown] =
      mIcons[idx][AButtonDis] = mIcons[idx][AButtonOverDown] = wxNullImage;
   Refresh(false);
}

References AButtonDis, AButtonDown, AButtonOver, AButtonOverDown, AButtonUp, and mIcons.

Referenced by SetIcon().

Here is the caller graph for this function:

◆ SetAlternateIcons()

void AButton::SetAlternateIcons	(	unsigned	idx,
		const wxImage &	up,
		const wxImage &	down,
		const wxImage &	disabled
	)

Definition at line 275 of file AButton.cpp.

{
   if(1 + idx > mIcons.size())
      mIcons.resize(1 + idx);
   mIcons[idx][AButtonUp] = up;
   mIcons[idx][AButtonOver] = up;
   mIcons[idx][AButtonDown] = down;
   mIcons[idx][AButtonOverDown] = down;
   mIcons[idx][AButtonDis] = disabled;
   Refresh(false);
}

References AButtonDis, AButtonDown, AButtonOver, AButtonOverDown, AButtonUp, and mIcons.

Referenced by ControlToolBar::Populate(), and SetIcons().

Here is the caller graph for this function:

◆ SetAlternateIdx()

void AButton::SetAlternateIdx ( unsigned idx )

Definition at line 287 of file AButton.cpp.

{
   // If alternate-image-state is already correct then
   // nothing to do (saves repainting button).
   if( mAlternateIdx == idx )
      return;
   mAlternateIdx = idx;
   Refresh(false);
   PostSizeEventToParent();
}

References mAlternateIdx.

Referenced by MixerTrackCluster::OnButton_Mute(), MixerTrackCluster::OnButton_Solo(), ControlToolBar::OnIdle(), ControlToolBar::ReCreateButtons(), ControlToolBar::SetPlay(), TranscriptionToolBar::SetPlaying(), and MixerTrackCluster::UpdateForStateChange().

Here is the caller graph for this function:

◆ SetAlternateImages()

void AButton::SetAlternateImages	(	unsigned	idx,
		const wxImage &	up,
		const wxImage &	over,
		const wxImage &	down,
		const wxImage &	overDown,
		const wxImage &	dis
	)

Definition at line 226 of file AButton.cpp.

{
   if (1 + idx > mImages.size())
      mImages.resize(1 + idx);
   mImages[idx][AButtonUp] = up;
   mImages[idx][AButtonOver] = over;
   mImages[idx][AButtonDown] = down;
   mImages[idx][AButtonOverDown] = overDown;
   mImages[idx][AButtonDis] = dis;
}

References AButtonDis, AButtonDown, AButtonOver, AButtonOverDown, AButtonUp, and mImages.

Referenced by AButton(), ToolBar::MakeAlternateImages(), and SetImages().

Here is the caller graph for this function:

◆ SetButtonToggles()

void AButton::SetButtonToggles ( bool toggler )

inline

Definition at line 232 of file AButton.h.

232{ mToggle = toggler;}

Referenced by ControlToolBar::Populate().

Here is the caller graph for this function:

◆ SetButtonType()

void AButton::SetButtonType ( Type type )

Definition at line 148 of file AButton.cpp.

{
   if(mType != type)
   {
      mType = type;
      InvalidateBestSize();
      Refresh(false);
      PostSizeEventToParent();
   }
}

References mType.

Referenced by AudioSetupToolBar::MakeAudioSetupButton(), SelectionBar::MakeSetupButton(), audacity::cloud::ShareAudioToolbar::MakeShareAudioButton(), and MeterToolBar::Populate().

Here is the caller graph for this function:

◆ SetControl()

void AButton::SetControl ( bool control )

Definition at line 678 of file AButton.cpp.

{
   mWasControlDown = control;
}

References mWasControlDown.

Referenced by ControlToolBar::SetPlay().

Here is the caller graph for this function:

◆ SetEnabled()

void AButton::SetEnabled ( bool state )

inline

Definition at line 200 of file AButton.h.

                               {
      state ? Enable() : Disable();
   }

Referenced by audacity::cloud::ShareAudioToolbar::EnableDisableButtons(), ControlToolBar::EnableDisableButtons(), TranscriptionToolBar::EnableDisableButtons(), RealtimeEffectListWindow::ReloadEffectsList(), and TranscriptionToolBar::SetEnabled().

Here is the caller graph for this function:

◆ SetFocusFromKbd()

void AButton::SetFocusFromKbd ( )

override

Definition at line 215 of file AButton.cpp.

{
   auto temp = TemporarilyAllowFocus();
   SetFocus();
}

References BasicUI::SetFocus(), and TemporarilyAllowFocus().

Here is the call graph for this function:

◆ SetFocusRect()

void AButton::SetFocusRect ( const wxRect & r )

Definition at line 304 of file AButton.cpp.

{
   mFocusRect = r;
   mForceFocusRect = true;
}

References mFocusRect, and mForceFocusRect.

Referenced by ToolBar::MakeButton().

Here is the caller graph for this function:

◆ SetFrameMid()

void AButton::SetFrameMid ( int mid )

Definition at line 159 of file AButton.cpp.

{
   if(mid == mFrameMid)
      return;
   mFrameMid = mid;
 
   if(mType == FrameButton)
   {
      InvalidateBestSize();
      Refresh(false);
      PostSizeEventToParent();
   }
}

References FrameButton, mFrameMid, and mType.

Referenced by MeterToolBar::Populate().

Here is the caller graph for this function:

◆ SetIcon() [1/2]

void AButton::SetIcon	(	AButtonState	state,
		const wxImage &	icon
	)

Definition at line 247 of file AButton.cpp.

{
   SetAlternateIcon(0, state, icon);
}

References SetAlternateIcon().

Here is the call graph for this function:

◆ SetIcon() [2/2]

void AButton::SetIcon ( const wxImage & icon )

Definition at line 242 of file AButton.cpp.

{
   SetAlternateIcon(0, icon);
}

References SetAlternateIcon().

Referenced by AudioSetupToolBar::MakeAudioSetupButton(), audacity::cloud::ShareAudioToolbar::MakeShareAudioButton(), and MeterToolBar::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetIcons()

void AButton::SetIcons	(	const wxImage &	up,
		const wxImage &	down,
		const wxImage &	disabled
	)

Definition at line 252 of file AButton.cpp.

{
   SetAlternateIcons(0, up, down, disabled);
}

References SetAlternateIcons().

Here is the call graph for this function:

◆ SetImages()

void AButton::SetImages	(	const wxImage &	up,
		const wxImage &	over,
		const wxImage &	down,
		const wxImage &	overDown,
		const wxImage &	dis
	)

Definition at line 221 of file AButton.cpp.

{
   SetAlternateImages(0, up, over, down, overDown, dis);
}

References SetAlternateImages().

Referenced by AudioSetupToolBar::MakeAudioSetupButton(), audacity::cloud::ShareAudioToolbar::MakeShareAudioButton(), and MeterToolBar::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetLabel()

void AButton::SetLabel ( const TranslatableString & label )

Definition at line 205 of file AButton.cpp.

{
   wxWindow::SetLabel( toolTip.Stripped().Translation() );
   if(mType == FrameButton)
      InvalidateBestSize();
}

References FrameButton, mType, TranslatableString::Stripped(), and TranslatableString::Translation().

Referenced by TranscriptionToolBar::AddButton(), AudioSetupToolBar::MakeAudioSetupButton(), ToolBar::MakeButton(), audacity::cloud::ShareAudioToolbar::MakeShareAudioButton(), MeterToolBar::Populate(), and AdornedRulerPanel::UpdateButtonStates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetShift()

void AButton::SetShift ( bool shift )

Definition at line 673 of file AButton.cpp.

{
   mWasShiftDown = shift;
}

References mWasShiftDown.

Referenced by ControlToolBar::SetPlay().

Here is the caller graph for this function:

◆ SetToolTip()

void AButton::SetToolTip ( const TranslatableString & toolTip )

Definition at line 200 of file AButton.cpp.

{
   wxWindow::SetToolTip( toolTip.Stripped().Translation() );
}

References TranslatableString::Stripped(), and TranslatableString::Translation().

Referenced by MeterToolBar::Populate(), TranscriptionToolBar::RegenerateTooltips(), and ToolBar::SetButtonToolTip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ TemporarilyAllowFocus()

auto AButton::TemporarilyAllowFocus ( )

static

Definition at line 735 of file AButton.cpp.

                                                      {
   s_AcceptsFocus = true;
   return TempAllowFocus{ &s_AcceptsFocus };
}

References s_AcceptsFocus.

Referenced by anonymous_namespace{NavigationMenus.cpp}::NextOrPrevFrame(), ToolManager::RestoreFocus(), and SetFocusFromKbd().

Here is the caller graph for this function:

◆ Toggle()

void AButton::Toggle ( )

inline

Definition at line 237 of file AButton.h.

237{ mButtonIsDown ? PopUp() : PushDown();}

AButton::PushDown

void PushDown()

Definition: AButton.cpp:644

◆ UpdateStatus()

void AButton::UpdateStatus ( )

Definition at line 522 of file AButton.cpp.

{
   if (mCursorIsInWindow) {
#if wxUSE_TOOLTIPS // Not available in wxX11
      // Display the tooltip in the status bar
      wxToolTip * pTip = this->GetToolTip();
      if( pTip ) {
         auto tipText = Verbatim( pTip->GetTip() );
         if (!mEnabled)
            tipText.Join( XO("(disabled)"), " " );
         auto pProject = FindProjectFromWindow( this );
         if (pProject)
            ProjectStatus::Get( *pProject ).Set( tipText );
      }
#endif
   }
}

References FindProjectFromWindow(), ProjectStatus::Get(), mCursorIsInWindow, mEnabled, ProjectStatus::Set(), Verbatim(), and XO().

Referenced by OnMouseEvent(), and AdornedRulerPanel::UpdateButtonStates().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ UseDisabledAsDownHiliteImage()

void AButton::UseDisabledAsDownHiliteImage ( bool flag )

Definition at line 195 of file AButton.cpp.

{
   mUseDisabledAsDownHiliteImage = flag;
}

References flag, and mUseDisabledAsDownHiliteImage.

◆ WasControlDown()

bool AButton::WasControlDown ( )

Definition at line 613 of file AButton.cpp.

{
   return mWasControlDown;
}

References mWasControlDown.

Referenced by TranscriptionToolBar::OnPlaySpeed(), and ControlToolBar::PlayDefault().

Here is the caller graph for this function:

◆ WasShiftDown()

bool AButton::WasShiftDown ( )

Definition at line 608 of file AButton.cpp.

{
   return mWasShiftDown;
}

References mWasShiftDown.

Referenced by MixerTrackCluster::OnButton_Mute(), MixerTrackCluster::OnButton_Solo(), ControlToolBar::OnFF(), ControlToolBar::OnRecord(), ControlToolBar::OnRewind(), ControlToolBar::PlayDefault(), and ControlToolBar::ReCreateButtons().

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ AButtonAx

friend class AButtonAx

friend

Definition at line 105 of file AButton.h.

Referenced by Init().

Member Data Documentation

◆ mAlternateIdx

unsigned AButton::mAlternateIdx {0}

private

Definition at line 262 of file AButton.h.

Referenced by DoGetBestClientSize(), OnPaint(), and SetAlternateIdx().

◆ mButtonIsDown

bool AButton::mButtonIsDown {false}

private

Definition at line 274 of file AButton.h.

Referenced by GetState(), OnCharHook(), OnMouseEvent(), PopUp(), and PushDown().

◆ mCursorIsInWindow

bool AButton::mCursorIsInWindow {false}

private

Definition at line 273 of file AButton.h.

Referenced by GetState(), OnMouseEvent(), and UpdateStatus().

◆ mEnabled

bool AButton::mEnabled {true}

private

Definition at line 276 of file AButton.h.

Referenced by Disable(), Enable(), GetState(), OnCharHook(), OnMouseEvent(), and UpdateStatus().

◆ mFocusRect

wxRect AButton::mFocusRect

private

Definition at line 283 of file AButton.h.

Referenced by Init(), OnPaint(), OnSize(), and SetFocusRect().

◆ mForceFocusRect

bool AButton::mForceFocusRect {false}

private

Definition at line 284 of file AButton.h.

Referenced by OnSize(), and SetFocusRect().

◆ mFrameMid

int AButton::mFrameMid {1}

private

Definition at line 289 of file AButton.h.

Referenced by DoGetBestClientSize(), OnPaint(), and SetFrameMid().

◆ mIcons

std::vector<std::array<wxImage, AButtonStateCount> > AButton::mIcons

private

Definition at line 280 of file AButton.h.

Referenced by DoGetBestClientSize(), OnPaint(), SetAlternateIcon(), and SetAlternateIcons().

◆ mImages

std::vector<std::array<wxImage, AButtonStateCount> > AButton::mImages

private

Definition at line 281 of file AButton.h.

Referenced by AButton(), DoGetBestClientSize(), HasAlternateImages(), OnPaint(), and SetAlternateImages().

◆ mIsClicking

bool AButton::mIsClicking {false}

private

Definition at line 275 of file AButton.h.

Referenced by GetState(), and OnMouseEvent().

◆ mIsDoubleClicked

bool AButton::mIsDoubleClicked {false}

private

Definition at line 278 of file AButton.h.

Referenced by OnMouseEvent().

◆ mListener

std::unique_ptr<Listener> AButton::mListener

private

Definition at line 286 of file AButton.h.

Referenced by FollowModifierKeys().

◆ mToggle

bool AButton::mToggle {false}

private

Definition at line 263 of file AButton.h.

Referenced by GetState(), Init(), OnCharHook(), and OnMouseEvent().

◆ mType

Type AButton::mType {ImageButton}

private

Definition at line 288 of file AButton.h.

Referenced by DoGetBestClientSize(), OnPaint(), SetButtonType(), SetFrameMid(), and SetLabel().

◆ mUseDisabledAsDownHiliteImage

bool AButton::mUseDisabledAsDownHiliteImage {false}

private

Definition at line 277 of file AButton.h.

Referenced by GetState(), and UseDisabledAsDownHiliteImage().

◆ mWasControlDown

bool AButton::mWasControlDown {false}

private

Definition at line 271 of file AButton.h.

Referenced by OnCharHook(), OnMouseEvent(), SetControl(), and WasControlDown().

◆ mWasShiftDown

bool AButton::mWasShiftDown {false}

private

Definition at line 270 of file AButton.h.

Referenced by OnCharHook(), OnMouseEvent(), SetShift(), and WasShiftDown().

◆ s_AcceptsFocus

bool AButton::s_AcceptsFocus { false }

staticprivate

Definition at line 249 of file AButton.h.

Referenced by TemporarilyAllowFocus().

The documentation for this class was generated from the following files:

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ TempAllowFocus

Member Enumeration Documentation

◆ AButtonState

◆ Type

Constructor & Destructor Documentation

◆ AButton() [1/2]

◆ AButton() [2/2]

◆ ~AButton()

Member Function Documentation

◆ AcceptsFocus()

◆ AcceptsFocusFromKeyboard()

◆ ClearDoubleClicked()

◆ Click()

◆ Disable()

◆ DoGetBestClientSize()

◆ Enable()

◆ FollowModifierKeys()

◆ GetState()

◆ HasAlternateImages()

◆ Init()

◆ InteractionOver()

◆ IsDoubleClicked()

◆ IsDown()

◆ IsEnabled()

◆ IsToggle()

◆ OnCaptureLost()

◆ OnCharHook()

◆ OnErase()

◆ OnKeyDown()

◆ OnKillFocus()

◆ OnMouseEvent()

◆ OnPaint()

◆ OnSetFocus()

◆ OnSize()

◆ PopUp()

◆ PushDown()

◆ SetAlternateIcon() [1/2]

◆ SetAlternateIcon() [2/2]

◆ SetAlternateIcons()

◆ SetAlternateIdx()

◆ SetAlternateImages()

◆ SetButtonToggles()

◆ SetButtonType()

◆ SetControl()

◆ SetEnabled()

◆ SetFocusFromKbd()

◆ SetFocusRect()

◆ SetFrameMid()

◆ SetIcon() [1/2]

◆ SetIcon() [2/2]

◆ SetIcons()

◆ SetImages()

◆ SetLabel()

◆ SetShift()

◆ SetToolTip()

◆ TemporarilyAllowFocus()

◆ Toggle()

◆ UpdateStatus()

◆ UseDisabledAsDownHiliteImage()

◆ WasControlDown()

◆ WasShiftDown()

Friends And Related Function Documentation

◆ AButtonAx

Member Data Documentation

◆ mAlternateIdx

◆ mButtonIsDown

◆ mCursorIsInWindow

◆ mEnabled

◆ mFocusRect