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

#include <EditToolBar.h>

Inheritance diagram for EditToolBar:

Public Member Functions
	EditToolBar ()

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 (int type, const wxString &label, const wxString &section, bool resizable=false)

virtual	~ToolBar ()

bool	AcceptsFocus () const override

virtual void	ReCreateButtons ()

int	GetType ()

wxString	GetTitle ()

wxString	GetLabel ()

wxString	GetSection ()

ToolDock *	GetDock ()

void	SetLabel (const wxString &label) override

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 ()

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 wxString &name=_("Panel"))

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

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

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 wxChar label, bool toggle=false)

Private Attributes
AButton *	mButtons [ETBNumButtons]

wxImage *	upImage

wxImage *	downImage

wxImage *	hiliteImage

Additional Inherited Members
Public Types inherited from ToolBar
using	Holder = Destroy_ptr< 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 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 (AButton &button, const TranslatedInternalString commands[], size_t nCommands)

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

void	MakeMacRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)

void	MakeButtonBackgroundsLarge ()

void	MakeButtonBackgroundsSmall ()

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	Repaint (wxDC *dc)=0

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnMouseEvents (wxMouseEvent &event)

Protected Attributes inherited from ToolBar
wxString	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 that is managed by a global ToolBarStub called gControlToolBarStub.

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 73 of file EditToolBar.h.

Constructor & Destructor Documentation

EditToolBar::EditToolBar ( )

EditToolBar::~EditToolBar ( )

virtual

Definition at line 84 of file EditToolBar.cpp.

85 {

86 }

Member Function Documentation

AButton * EditToolBar::AddButton	(	EditToolBar *	pBar,
		teBmps	eEnabledUp,
		teBmps	eEnabledDown,
		teBmps	eDisabled,
		int	id,
		const wxChar *	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 101 of file EditToolBar.cpp.

References ToolBar::Add(), first_ETB_ID, ThemeBase::ImageSize(), ToolBar::MakeButton(), mButtons, and theTheme.

Referenced by Populate().

 {
    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);
 // JKC: Unlike ControlToolBar, does not have a focus rect.  Shouldn't it?
 // r->SetFocusRect( r->GetRect().Deflate( 4, 4 ) );
 
    pBar->Add( r, 0, wxALIGN_CENTER );
 
    return r;
 }

void EditToolBar::AddSeparator ( )

private

Definition at line 93 of file EditToolBar.cpp.

References ToolBar::AddSpacer().

Referenced by Populate().

 {
    AddSpacer();
 }

void EditToolBar::Create ( wxWindow * parent )

overridevirtual

Reimplemented from ToolBar.

Definition at line 88 of file EditToolBar.cpp.

References ToolBar::Create().

 {
    ToolBar::Create(parent);
 }

void EditToolBar::EnableDisableButtons ( )

overridevirtual

Implements ToolBar.

Definition at line 218 of file EditToolBar.cpp.

References ETBActEnableDisable, and ForAllButtons().

 {
    ForAllButtons( ETBActEnableDisable );
 }

void EditToolBar::ForAllButtons ( int Action )

private

Definition at line 255 of file EditToolBar.cpp.

References EditToolbarButtonList, ETBActEnableDisable, ETBActTooltips, GetActiveProject(), AudacityProject::GetCommandManager(), CommandManager::GetEnabled(), gPrefs, mButtons, AButton::PopUp(), AButton::PushDown(), ToolBar::SetButtonToolTip(), and AButton::SetEnabled().

Referenced by EnableDisableButtons(), and RegenerateTooltips().

 {
    AudacityProject *p;
    CommandManager* cm = nullptr;
 
    if( Action & ETBActEnableDisable ){
       p = GetActiveProject();
       if (!p) return;
       cm = p->GetCommandManager();
       if (!cm) return;
 #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 ){
          TranslatedInternalString command{
             entry.commandName, wxGetTranslation(entry.untranslatedLabel) };
          ToolBar::SetButtonToolTip( *mButtons[entry.tool], &command, 1u );
       }
 #endif
       if (cm) {
          mButtons[entry.tool]->SetEnabled(cm->GetEnabled(entry.commandName));
       }
    }
 }

void EditToolBar::MakeButtons ( )

private

void EditToolBar::OnButton ( wxCommandEvent & event )

Definition at line 291 of file EditToolBar.cpp.

References EditToolbarButtonList, first_ETB_ID, GetActiveProject(), AudacityProject::GetCommandManager(), AudacityProject::GetUpdateFlags(), CommandManager::HandleTextualCommand(), AButton::InteractionOver(), mButtons, and NoFlagsSpecifed.

 {
    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 = GetActiveProject();
    if (!p) return;
    CommandManager* cm = p->GetCommandManager();
    if (!cm) return;
 
    auto flags = p->GetUpdateFlags();
    const CommandContext context( *GetActiveProject() );
    cm->HandleTextualCommand(EditToolbarButtonList[id].commandName, context, flags, NoFlagsSpecifed);
 }

void EditToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 127 of file EditToolBar.cpp.

References _(), AddButton(), AddSeparator(), ThemeBase::Colour(), ETBCopyID, ETBCutID, ETBPasteID, ETBRedoID, ETBSilenceID, ETBTrimID, ETBUndoID, ETBZoomFitID, ETBZoomInID, ETBZoomOutID, ETBZoomSelID, ETBZoomToggleID, ToolBar::MakeButtonBackgroundsSmall(), mButtons, AButton::PushDown(), RegenerateTooltips(), AButton::SetEnabled(), and theTheme.

 {
    SetBackgroundColour( theTheme.Colour( clrMedium  ) );
    MakeButtonBackgroundsSmall();
 
    /* Buttons */
    // Tooltips slightly more verbose than the menu entries are.
    AddButton(this, bmpCut, bmpCut, bmpCutDisabled, ETBCutID,
       _("Cut selection"));
    AddButton(this, bmpCopy, bmpCopy, bmpCopyDisabled, ETBCopyID,
       _("Copy selection"));
    AddButton(this, bmpPaste, bmpPaste, bmpPasteDisabled, ETBPasteID,
       _("Paste"));
    AddButton(this, bmpTrim, bmpTrim, bmpTrimDisabled, ETBTrimID,
       _("Trim audio outside selection"));
    AddButton(this, bmpSilence, bmpSilence, bmpSilenceDisabled, ETBSilenceID,
       _("Silence audio selection"));
 
    AddSeparator();
 
    AddButton(this, bmpUndo, bmpUndo, bmpUndoDisabled, ETBUndoID,
       _("Undo"));
    AddButton(this, bmpRedo, bmpRedo, bmpRedoDisabled, ETBRedoID,
       _("Redo"));
 
    AddSeparator();
 
 #ifdef OPTION_SYNC_LOCK_BUTTON
    AddButton(this, bmpSyncLockTracksUp, bmpSyncLockTracksDown, bmpSyncLockTracksUp, ETBSyncLockID,
                _("Sync-Lock Tracks"), true);
 
    AddSeparator();
 #endif
 
    // Tooltips match menu entries.
    // We previously had longer tooltips which were not more clear.
    AddButton(this, bmpZoomIn, bmpZoomIn, bmpZoomInDisabled, ETBZoomInID,
       _("Zoom In"));
    AddButton(this, bmpZoomOut, bmpZoomOut, bmpZoomOutDisabled, ETBZoomOutID,
       _("Zoom Out"));
    AddButton(this, bmpZoomSel, bmpZoomSel, bmpZoomSelDisabled, ETBZoomSelID,
       _("Zoom to Selection"));
    AddButton(this, bmpZoomFit, bmpZoomFit, bmpZoomFitDisabled, ETBZoomFitID,
       _("Fit to Width"));
 
 #ifdef EXPERIMENTAL_ZOOM_TOGGLE_BUTTON
    AddButton(this, bmpZoomToggle, bmpZoomToggle, bmpZoomToggleDisabled, ETBZoomToggleID,
       _("Zoom Toggle"));
 #endif
 
 
 
    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);
    mButtons[ETBPasteID]->SetEnabled(false);
 
 #ifdef OPTION_SYNC_LOCK_BUTTON
    mButtons[ETBSyncLockID]->PushDown();
 #endif
 
 #if defined(EXPERIMENTAL_EFFECTS_RACK)
    AddSeparator();
    AddButton(this, bmpEditEffects, bmpEditEffects, bmpEditEffects, ETBEffectsID,
       _("Show Effects Rack"), true);
 #endif
 
    RegenerateTooltips();
 }

void EditToolBar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 213 of file EditToolBar.cpp.

References ETBActTooltips, and ForAllButtons().

Referenced by Populate(), and UpdatePrefs().

 {
    ForAllButtons( ETBActTooltips );
 }

void EditToolBar::Repaint ( wxDC * WXUNUSEDdc )

inlineoverride

Definition at line 85 of file EditToolBar.h.

85 {};

void EditToolBar::UpdatePrefs ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 202 of file EditToolBar.cpp.

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

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

Member Data Documentation

wxImage* EditToolBar::downImage

private

Definition at line 106 of file EditToolBar.h.

wxImage* EditToolBar::hiliteImage

private

Definition at line 107 of file EditToolBar.h.

AButton* EditToolBar::mButtons[ETBNumButtons]

private

Definition at line 103 of file EditToolBar.h.

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

wxImage* EditToolBar::upImage

private

Definition at line 105 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

Member Function Documentation

Member Data Documentation