A ToolBar that has the edit buttons on it. More...

#include <EditToolBar.h>

Inheritance diagram for EditToolBar:

Collaboration diagram for EditToolBar:

Public Member Functions
	EditToolBar (AudacityProject &project)

virtual	~EditToolBar ()

void	Create (wxWindow *parent) override

void	OnButton (wxCommandEvent &event)

void	Populate () override

void	Repaint (wxDC *WXUNUSED(dc)) override

void	EnableDisableButtons () override

void	UpdatePrefs () override

Public Member Functions inherited from ToolBar
	ToolBar (AudacityProject &project, int type, const TranslatableString &label, const wxString &section, bool resizable=false)

virtual	~ToolBar ()

bool	AcceptsFocus () const override

virtual void	SetToDefaultSize ()

virtual void	Create (wxWindow *parent)

virtual void	EnableDisableButtons ()=0

virtual void	ReCreateButtons ()

void	UpdatePrefs () override

virtual void	RegenerateTooltips ()=0

int	GetType ()

TranslatableString	GetTitle ()

TranslatableString	GetLabel ()

wxString	GetSection ()

ToolDock *	GetDock ()

void	SetLabel (const TranslatableString &label)

virtual void	SetDocked (ToolDock *dock, bool pushed)

virtual bool	Expose (bool show=true)

bool	IsResizable () const

bool	IsVisible () const

bool	IsDocked () const

bool	IsPositioned ()

void	SetVisible (bool bVisible)

void	SetPositioned ()

virtual int	GetInitialWidth ()
	Resizable toolbars should implement these. More...

virtual int	GetMinToolbarWidth ()

virtual wxSize	GetDockedSize ()

wxSize	GetSmartDockedSize ()

virtual void	ResizingDone ()

Public Member Functions inherited from wxPanelWrapper
	wxPanelWrapper ()

	wxPanelWrapper (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

bool	Create (wxWindow *parent, wxWindowID winid=wxID_ANY, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=wxTAB_TRAVERSAL\|wxNO_BORDER, const TranslatableString &name=XO("Panel"))

void	SetLabel (const TranslatableString &label)

void	SetName (const TranslatableString &name)

void	SetToolTip (const TranslatableString &toolTip)

void	SetName ()

Public Member Functions inherited from wxTabTraversalWrapper< wxPanel >
	wxTabTraversalWrapper (Args &&... args)

	wxTabTraversalWrapper (const wxTabTraversalWrapper &)=delete

	wxTabTraversalWrapper (wxTabTraversalWrapper &&)=delete

wxTabTraversalWrapper &	operator= (const wxTabTraversalWrapper &)=delete

wxTabTraversalWrapper &	operator= (wxTabTraversalWrapper &&)=delete

Private Member Functions
void	AddSeparator ()

void	MakeButtons ()

void	RegenerateTooltips () override

void	ForAllButtons (int Action)

Static Private Member Functions
static AButton *	AddButton (EditToolBar *pBar, teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, const TranslatableString &label, bool toggle=false)

Private Attributes
AButton *	mButtons [ETBNumButtons]

wxGridSizer *	mToolSizer

wxImage *	upImage

wxImage *	downImage

wxImage *	hiliteImage

Additional Inherited Members
Public Types inherited from ToolBar
using	Holder = wxWindowPtr< ToolBar >

Static Public Member Functions inherited from ToolBar
static AButton *	MakeButton (wxWindow *parent, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxWindowID id, wxPoint placement, bool processdownevents, wxSize size)

static AButton *	MakeButton (ToolBar *parent, teBmps eEnabledUp, teBmps eEnabledDown, teBmps eDisabled, int id, bool processdownevents, const TranslatableString &label)

static void	MakeAlternateImages (AButton &button, int idx, teBmps eUp, teBmps eDown, teBmps eHilite, teBmps eDownHi, teBmps eStandardUp, teBmps eStandardDown, teBmps eDisabled, wxSize size)

static void	SetButtonToolTip (AudacityProject &project, AButton &button, const ComponentInterfaceSymbol commands[], size_t nCommands)

static void	MakeButtonBackgroundsSmall ()

static void	MakeButtonBackgroundsLarge ()

Protected Member Functions inherited from ToolBar
void	SetButton (bool down, AButton *button)

wxBoxSizer *	GetSizer ()

void	Add (wxWindow window, int proportion=0, int flag=wxALIGN_TOP, int border=0, wxObject userData=NULL)

void	Add (wxSizer sizer, int proportion=0, int flag=0, int border=0, wxObject userData=NULL)

void	Add (int width, int height, int proportion=0, int flag=0, int border=0, wxObject *userData=NULL)

void	AddSpacer (int size=14)

void	AddStretchSpacer (int prop=1)

void	Detach (wxWindow *window)

void	Detach (wxSizer *sizer)

void	Updated ()

int	GetResizeGrabberWidth ()
	Returns the width in pixels of the resizer element. More...

virtual void	Populate ()=0

virtual void	Repaint (wxDC *dc)=0

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnMouseEvents (wxMouseEvent &event)

Protected Member Functions inherited from PrefsListener
virtual void	UpdateSelectedPrefs (int id)

	PrefsListener ()

virtual	~PrefsListener ()

virtual void	UpdatePrefs ()=0

Static Protected Member Functions inherited from ToolBar
static void	MakeMacRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeMacRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

static void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

static void	MakeRecoloredImageSize (teBmps eBmpOut, teBmps eBmpIn, const wxSize &size)

Static Protected Member Functions inherited from PrefsListener
static void	Broadcast (int id=0)
	Call this static function to notify all PrefsListener objects. More...

Protected Attributes inherited from ToolBar
AudacityProject &	mProject

TranslatableString	mLabel

wxString	mSection

int	mType

Detailed Description

A ToolBar that has the edit buttons on it.

This class, which is a child of Toolbar, creates the window containing interfaces to commonly-used edit functions that are otherwise only available through menus. The window can be embedded within a normal project window, or within a ToolBarFrame.

All of the controls in this window were custom-written for Audacity - they are not native controls on any platform - however, it is intended that the images could be easily replaced to allow "skinning" or just customization to match the look and feel of each platform.

Definition at line 65 of file EditToolBar.h.

Constructor & Destructor Documentation

◆ EditToolBar()

EditToolBar::EditToolBar ( AudacityProject & project )

◆ ~EditToolBar()

EditToolBar::~EditToolBar ( )

virtual

Definition at line 81 of file EditToolBar.cpp.

82{

83}

Member Function Documentation

◆ AddButton()

AButton * EditToolBar::AddButton	(	EditToolBar *	pBar,
		teBmps	eEnabledUp,
		teBmps	eEnabledDown,
		teBmps	eDisabled,
		int	id,
		const TranslatableString &	label,
		bool	toggle = `false`
	)

staticprivate

This is a convenience function that allows for button creation in MakeButtons() with fewer arguments Very similar to code in ControlToolBar...

Definition at line 99 of file EditToolBar.cpp.

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

References first_ETB_ID, id, ThemeBase::ImageSize(), label, ToolBar::MakeButton(), mButtons, mToolSizer, AButton::SetLabel(), and theTheme.

Referenced by Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ AddSeparator()

void EditToolBar::AddSeparator ( )

private

Definition at line 91 of file EditToolBar.cpp.

{
   mToolSizer->AddSpacer(0);
}

References mToolSizer.

Referenced by Populate().

Here is the caller graph for this function:

◆ Create()

void EditToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 85 of file EditToolBar.cpp.

{
   ToolBar::Create(parent);
   UpdatePrefs();
}

References ToolBar::Create(), and UpdatePrefs().

Here is the call graph for this function:

◆ EnableDisableButtons()

void EditToolBar::EnableDisableButtons ( )

overridevirtual

Implements ToolBar.

Definition at line 196 of file EditToolBar.cpp.

{
   ForAllButtons( ETBActEnableDisable );
}

References ETBActEnableDisable, and ForAllButtons().

Here is the call graph for this function:

◆ ForAllButtons()

void EditToolBar::ForAllButtons ( int Action )

private

Definition at line 225 of file EditToolBar.cpp.

{
   AudacityProject *p;
   CommandManager* cm = nullptr;
 
   if( Action & ETBActEnableDisable ){
      p = &mProject;
      cm = &CommandManager::Get( *p );
#ifdef OPTION_SYNC_LOCK_BUTTON
      bool bSyncLockTracks;
      gPrefs->Read(wxT("/GUI/SyncLockTracks"), &bSyncLockTracks, false);
 
      if (bSyncLockTracks)
         mButtons[ETBSyncLockID]->PushDown();
      else
         mButtons[ETBSyncLockID]->PopUp();
#endif
   }
 
 
   for (const auto &entry : EditToolbarButtonList) {
#if wxUSE_TOOLTIPS
      if( Action & ETBActTooltips ){
         ComponentInterfaceSymbol command{
            entry.commandName, entry.untranslatedLabel };
         ToolBar::SetButtonToolTip( mProject,
            *mButtons[entry.tool], &command, 1u );
      }
#endif
      if (cm) {
         mButtons[entry.tool]->SetEnabled(cm->GetEnabled(entry.commandName));
      }
   }
}

References EditToolbarButtonList, entry, ETBActEnableDisable, ETBActTooltips, CommandManager::Get(), CommandManager::GetEnabled(), gPrefs, mButtons, ToolBar::mProject, AButton::PopUp(), AButton::PushDown(), ToolBar::SetButtonToolTip(), and AButton::SetEnabled().

Referenced by EnableDisableButtons(), and RegenerateTooltips().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeButtons()

void EditToolBar::MakeButtons ( )

private

◆ OnButton()

void EditToolBar::OnButton ( wxCommandEvent & event )

Definition at line 260 of file EditToolBar.cpp.

{
   int id = event.GetId()-first_ETB_ID;
   // Be sure the pop-up happens even if there are exceptions, except for buttons which toggle.
   auto cleanup = finally( [&] { mButtons[id]->InteractionOver();});
 
   AudacityProject *p = &mProject;
   auto &cm = CommandManager::Get( *p );
 
   auto flags = MenuManager::Get(*p).GetUpdateFlags();
   const CommandContext context( *p );
   ::HandleTextualCommand( cm,
      EditToolbarButtonList[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 EditToolbarButtonList, first_ETB_ID, CommandManager::Get(), MenuManager::Get(), MenuManager::GetUpdateFlags(), HandleTextualCommand(), id, AButton::InteractionOver(), mButtons, and ToolBar::mProject.

Here is the call graph for this function:

◆ Populate()

void EditToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 122 of file EditToolBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
   MakeButtonBackgroundsSmall();
 
   Add(mToolSizer = safenew wxGridSizer(2, 5, 1, 1));
 
   /* Buttons */
   // Tooltips match menu entries.
   // We previously had longer tooltips which were not more clear.
   AddButton(this, bmpZoomIn, bmpZoomIn, bmpZoomInDisabled, ETBZoomInID,
      XO("Zoom In"));
   AddButton(this, bmpZoomOut, bmpZoomOut, bmpZoomOutDisabled, ETBZoomOutID,
      XO("Zoom Out"));
   AddButton(this, bmpZoomSel, bmpZoomSel, bmpZoomSelDisabled, ETBZoomSelID,
      XO("Zoom to Selection"));
   AddButton(this, bmpZoomFit, bmpZoomFit, bmpZoomFitDisabled, ETBZoomFitID,
      XO("Fit to Width"));
 
#ifdef EXPERIMENTAL_ZOOM_TOGGLE_BUTTON
   AddButton(this, bmpZoomToggle, bmpZoomToggle, bmpZoomToggleDisabled, ETBZoomToggleID,
      XO("Zoom Toggle"));
#endif
 
   // Tooltips slightly more verbose than the menu entries are.
   AddButton(this, bmpTrim, bmpTrim, bmpTrimDisabled, ETBTrimID,
      XO("Trim audio outside selection"));
   AddButton(this, bmpSilence, bmpSilence, bmpSilenceDisabled, ETBSilenceID,
      XO("Silence audio selection"));
 
#ifdef OPTION_SYNC_LOCK_BUTTON
   AddButton(this, bmpSyncLockTracksUp, bmpSyncLockTracksDown, bmpSyncLockTracksUp, ETBSyncLockID,
      XO("Sync-Lock Tracks"), true);
#else
   AddSeparator();
#endif
 
   AddButton(this, bmpUndo, bmpUndo, bmpUndoDisabled, ETBUndoID,
      XO("Undo"));
   AddButton(this, bmpRedo, bmpRedo, bmpRedoDisabled, ETBRedoID,
      XO("Redo"));
 
   mButtons[ETBZoomInID]->SetEnabled(false);
   mButtons[ETBZoomOutID]->SetEnabled(false);
#ifdef EXPERIMENTAL_ZOOM_TOGGLE_BUTTON
   mButtons[ETBZoomToggleID]->SetEnabled(false);
#endif
 
   mButtons[ETBZoomSelID]->SetEnabled(false);
   mButtons[ETBZoomFitID]->SetEnabled(false);
 
#ifdef OPTION_SYNC_LOCK_BUTTON
   mButtons[ETBSyncLockID]->PushDown();
#endif
 
   RegenerateTooltips();
}

References ToolBar::Add(), AddButton(), AddSeparator(), ThemeBase::Colour(), ETBRedoID, ETBSilenceID, ETBTrimID, ETBUndoID, ETBZoomFitID, ETBZoomInID, ETBZoomOutID, ETBZoomSelID, ToolBar::MakeButtonBackgroundsSmall(), mButtons, mToolSizer, AButton::PushDown(), RegenerateTooltips(), safenew, AButton::SetEnabled(), theTheme, and XO.

Here is the call graph for this function:

◆ RegenerateTooltips()

void EditToolBar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 191 of file EditToolBar.cpp.

{
   ForAllButtons( ETBActTooltips );
}

References ETBActTooltips, and ForAllButtons().

Referenced by Populate(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ Repaint()

void EditToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 77 of file EditToolBar.h.

77{};

◆ UpdatePrefs()

void EditToolBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Definition at line 180 of file EditToolBar.cpp.

{
   RegenerateTooltips();
 
   // Set label to pull in language change
   SetLabel(XO("Edit"));
 
   // Give base class a chance
   ToolBar::UpdatePrefs();
}

References RegenerateTooltips(), ToolBar::SetLabel(), ToolBar::UpdatePrefs(), and XO.

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

◆ downImage

wxImage* EditToolBar::downImage

private

Definition at line 100 of file EditToolBar.h.

◆ hiliteImage

wxImage* EditToolBar::hiliteImage

private

Definition at line 101 of file EditToolBar.h.

◆ mButtons

AButton* EditToolBar::mButtons[ETBNumButtons]

private

Definition at line 95 of file EditToolBar.h.

Referenced by AddButton(), ForAllButtons(), OnButton(), and Populate().

◆ mToolSizer

wxGridSizer* EditToolBar::mToolSizer

private

Definition at line 97 of file EditToolBar.h.

Referenced by AddButton(), AddSeparator(), and Populate().

◆ upImage

wxImage* EditToolBar::upImage

private

Definition at line 99 of file EditToolBar.h.

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

Public Member Functions

Private Member Functions

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EditToolBar()

◆ ~EditToolBar()

Member Function Documentation

◆ AddButton()

◆ AddSeparator()

◆ Create()

◆ EnableDisableButtons()

◆ ForAllButtons()

◆ MakeButtons()

◆ OnButton()

◆ Populate()

◆ RegenerateTooltips()

◆ Repaint()

◆ UpdatePrefs()

Member Data Documentation

◆ downImage

◆ hiliteImage

◆ mButtons

◆ mToolSizer

◆ upImage