ToolBarButtons Class Reference

#include <ToolBarButtons.h>

Collaboration diagram for ToolBarButtons:

Classes
struct	Entry

Public Types
using	ButtonList = std::vector< Entry >

Public Member Functions
	ToolBarButtons (ToolBar *const parent, AudacityProject &project, ButtonList buttonList, int size, int firstButtonId)
void	OnButton (wxCommandEvent &event)
AButton *	CreateButton (teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, const TranslatableString &label, bool toggle=false)
void	SetEnabled (int id, bool state)
void	SetCustomEnableDisableButtonsAction (std::function< void()> action)
void	PopUp (int id)
void	PushDown (int id)
void	EnableDisableButtons ()
void	RegenerateTooltips ()

Private Member Functions
void	ForAllButtons (int Action)

Private Attributes
ToolBar *	mParent
AudacityProject &	mProject
int	mFirstButtonId
std::vector< AButton * >	mButtons
ButtonList	mButtonList
std::function< void()>	mCustomEnableDisableButtonsAction

Detailed Description

Definition at line 24 of file ToolBarButtons.h.

Member Typedef Documentation

ButtonList

using ToolBarButtons::ButtonList = std::vector<Entry>

Definition at line 32 of file ToolBarButtons.h.

Constructor & Destructor Documentation

ToolBarButtons()

ToolBarButtons::ToolBarButtons	(	ToolBar *const	parent,
		AudacityProject &	project,
		ButtonList	buttonList,
		int	size,
		int	firstButtonId
	)

Definition at line 31 of file ToolBarButtons.cpp.

   : mParent(parent)
   , mProject(project)
   , mFirstButtonId(firstButtonId)
   , mButtons(size)
   , mButtonList(std::move(buttonList))
{
}

Member Function Documentation

CreateButton()

AButton * ToolBarButtons::CreateButton	(	teBmps	eEnabledUp,
		teBmps	eEnabledDown,
		teBmps	eDisabled,
		int	id,
		const TranslatableString &	label,
		bool	toggle = false
	)

Definition at line 64 of file ToolBarButtons.cpp.

{
   AButton *&r = mButtons[thisButtonId];
 
   r = ToolBar::MakeButton(mParent,
      bmpRecoloredUpSmall, bmpRecoloredDownSmall, bmpRecoloredUpHiliteSmall, bmpRecoloredHiliteSmall,
      eEnabledUp, eEnabledDown, eDisabled,
      wxWindowID(thisButtonId + mFirstButtonId),
      wxDefaultPosition,
      toggle,
      theTheme.ImageSize( bmpRecoloredUpSmall ));
 
   r->SetLabel(label);
 
   return r;
}

References ThemeBase::ImageSize(), label, ToolBar::MakeButton(), mButtons, mFirstButtonId, mParent, AButton::SetLabel(), and theTheme.

Referenced by CutCopyPasteToolBar::AddButton(), and EditToolBar::AddButton().

Here is the call graph for this function:

Here is the caller graph for this function:

EnableDisableButtons()

void ToolBarButtons::EnableDisableButtons

(

)

Definition at line 101 of file ToolBarButtons.cpp.

{
   ForAllButtons( TBActEnableDisable );
}

References ForAllButtons(), and TBActEnableDisable.

Referenced by CutCopyPasteToolBar::EnableDisableButtons(), and EditToolBar::EnableDisableButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

ForAllButtons()

void ToolBarButtons::ForAllButtons ( int  Action )

private

Definition at line 111 of file ToolBarButtons.cpp.

{
   CommandManager* cm = nullptr;
 
   if (Action & TBActEnableDisable) {
      cm = &CommandManager::Get( mProject );
 
      if (mCustomEnableDisableButtonsAction)
         mCustomEnableDisableButtonsAction();
   }
 
   for (const auto &entry : mButtonList) {
#if wxUSE_TOOLTIPS
      if ( Action & TBActTooltips ) {
         ComponentInterfaceSymbol command{
            entry.commandName, entry.untranslatedLabel };
         ToolBar::SetButtonToolTip( mProject,
            *mButtons[entry.tool], &command, 1u );
      }
#endif
      if (cm) {
         SetEnabled(entry.tool, cm->GetEnabled(entry.commandName));
      }
   }
}

References entry, CommandManager::Get(), CommandManager::GetEnabled(), mButtonList, mButtons, mCustomEnableDisableButtonsAction, mProject, ToolBar::SetButtonToolTip(), SetEnabled(), TBActEnableDisable, and TBActTooltips.

Referenced by EnableDisableButtons(), and RegenerateTooltips().

Here is the call graph for this function:

Here is the caller graph for this function:

OnButton()

void ToolBarButtons::OnButton

(

wxCommandEvent &

event

)

Definition at line 40 of file ToolBarButtons.cpp.

{
   int id = event.GetId() - mFirstButtonId;
 
   // Be sure the pop-up happens even if there are exceptions, except for buttons which toggle.
   auto cleanup = finally( [&] { mButtons[id]->InteractionOver(); });
 
   auto flags = CommandManager::Get(mProject).GetUpdateFlags();
   const CommandContext context( mProject );
 
   CommandDispatch::HandleTextualCommand(
      mButtonList[id].commandName, context, flags, false );
 
#if defined(__WXMAC__)
   // Bug 2402
   // LLL: It seems that on the Mac the IDLE events are processed
   //      differently than on Windows/GTK and the AdornedRulerPanel's
   //      OnPaint() method gets called sooner that expected. This is
   //      evident when zooming from this toolbar only. When zooming from
   //      the Menu or from keyboard ommand, the zooming works correctly.
   wxTheApp->ProcessIdle();
#endif
}

References CommandManager::Get(), CommandManager::GetUpdateFlags(), CommandDispatch::HandleTextualCommand(), id, mButtonList, mButtons, mFirstButtonId, and mProject.

Referenced by CutCopyPasteToolBar::OnButton(), and EditToolBar::OnButton().

Here is the call graph for this function:

Here is the caller graph for this function:

PopUp()

void ToolBarButtons::PopUp

(

int

id

)

Definition at line 91 of file ToolBarButtons.cpp.

{
   mButtons[id]->PopUp();
}

References id, and mButtons.

Referenced by EditToolBar::EditToolBar().

Here is the caller graph for this function:

PushDown()

void ToolBarButtons::PushDown

(

int

id

)

Definition at line 96 of file ToolBarButtons.cpp.

{
   mButtons[id]->PushDown();
}

References id, and mButtons.

Referenced by EditToolBar::EditToolBar(), and EditToolBar::Populate().

Here is the caller graph for this function:

RegenerateTooltips()

void ToolBarButtons::RegenerateTooltips

(

)

Definition at line 106 of file ToolBarButtons.cpp.

{
   ForAllButtons( TBActTooltips );
}

References ForAllButtons(), and TBActTooltips.

Referenced by CutCopyPasteToolBar::RegenerateTooltips(), and EditToolBar::RegenerateTooltips().

Here is the call graph for this function:

Here is the caller graph for this function:

SetCustomEnableDisableButtonsAction()

void ToolBarButtons::SetCustomEnableDisableButtonsAction

(

std::function< void()>

action

)

Definition at line 86 of file ToolBarButtons.cpp.

{
   mCustomEnableDisableButtonsAction = std::move(action);
}

References mCustomEnableDisableButtonsAction.

Referenced by EditToolBar::EditToolBar().

Here is the caller graph for this function:

SetEnabled()

void ToolBarButtons::SetEnabled	(	int	id,
		bool	state
	)

Definition at line 81 of file ToolBarButtons.cpp.

{
   mButtons[id]->SetEnabled(state);
}

References id, and mButtons.

Referenced by ForAllButtons(), CutCopyPasteToolBar::Populate(), and EditToolBar::Populate().

Here is the caller graph for this function:

Member Data Documentation

mButtonList

ButtonList ToolBarButtons::mButtonList

private

Definition at line 60 of file ToolBarButtons.h.

Referenced by ForAllButtons(), and OnButton().

mButtons

std::vector<AButton*> ToolBarButtons::mButtons

private

Definition at line 59 of file ToolBarButtons.h.

Referenced by CreateButton(), ForAllButtons(), OnButton(), PopUp(), PushDown(), and SetEnabled().

mCustomEnableDisableButtonsAction

std::function<void()> ToolBarButtons::mCustomEnableDisableButtonsAction

private

Definition at line 62 of file ToolBarButtons.h.

Referenced by ForAllButtons(), and SetCustomEnableDisableButtonsAction().

mFirstButtonId

int ToolBarButtons::mFirstButtonId

private

Definition at line 57 of file ToolBarButtons.h.

Referenced by CreateButton(), and OnButton().

mParent

ToolBar* ToolBarButtons::mParent

private

Definition at line 55 of file ToolBarButtons.h.

Referenced by CreateButton().

mProject

AudacityProject& ToolBarButtons::mProject

private

Definition at line 56 of file ToolBarButtons.h.

Referenced by ForAllButtons(), and OnButton().

---

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

• ToolBarButtons.h
• ToolBarButtons.cpp