ToolBar Class Reference

Works with ToolManager and ToolDock to provide a dockable window in which buttons can be placed. More...

#include <ToolBar.h>

Inheritance diagram for ToolBar:

Collaboration diagram for ToolBar:

Public Types
using	Holder = wxWindowPtr< ToolBar >

Public Member Functions
	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

Static Public Member Functions
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 (AudacityProject &project, AButton &button, const ComponentInterfaceSymbol commands[], size_t nCommands)
static void	MakeButtonBackgroundsSmall ()
static void	MakeButtonBackgroundsLarge ()

Protected Member Functions
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 ()

Static Protected Member Functions
static void	MakeMacRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)
static void	MakeRecoloredImage (teBmps eBmpOut, teBmps eBmpIn)
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
AudacityProject &	mProject
TranslatableString	mLabel
wxString	mSection
int	mType

Private Member Functions
void	SetLabel (const wxString &label) override
void	Init (wxWindow *parent, int type, const wxString &title, const wxString &label)

Private Attributes
wxWindow *	mParent
Grabber *	mGrabber
ToolBarResizer *	mResizer
wxBoxSizer *	mHSizer
bool	mVisible
bool	mResizable
bool	mPositioned

Friends
class	ToolBarResizer

Detailed Description

Works with ToolManager and ToolDock to provide a dockable window in which buttons can be placed.

Definition at line 95 of file ToolBar.h.

Member Typedef Documentation

Holder

using ToolBar::Holder = wxWindowPtr<ToolBar>

Definition at line 102 of file ToolBar.h.

Constructor & Destructor Documentation

ToolBar()

ToolBar::ToolBar	(	AudacityProject &	project,
		int	type,
		const TranslatableString &	label,
		const wxString &	section,
		bool	resizable = false
	)

Definition at line 330 of file ToolBar.cpp.

: wxPanelWrapper()
, mProject{ project }
{
   // Save parameters
   mType = type;
   mLabel = label;
   mSection = section;
   mResizable = resizable;
 
   // Initialize everything
   mParent = NULL;
   mHSizer = NULL;
   mVisible = false;
   mPositioned = false;
 
   mGrabber = NULL;
   mResizer = NULL;
   SetId(mType);
}

~ToolBar()

ToolBar::~ToolBar ( )

virtual

Definition at line 358 of file ToolBar.cpp.

{
}

Member Function Documentation

AcceptsFocus()

bool ToolBar::AcceptsFocus ( ) const

inlineoverride

Definition at line 109 of file ToolBar.h.

{ return false; };

Add() [1/3]

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

protected

Definition at line 718 of file ToolBar.cpp.

{
   mHSizer->Add( width,
                 height,
                 proportion,
                 flag,
                 border,
                 userData );
}

References flag, and mHSizer.

Add() [2/3]

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

protected

Definition at line 702 of file ToolBar.cpp.

{
   mHSizer->Add( sizer,
                 proportion,
                 flag,
                 border,
                 userData );
}

References flag, and mHSizer.

Add() [3/3]

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

protected

Definition at line 686 of file ToolBar.cpp.

{
   mHSizer->Add( window,
                 proportion,
                 flag,
                 border,
                 userData );
}

References flag, and mHSizer.

Referenced by EditToolBar::AddButton(), ScrubbingToolBar::AddButton(), TranscriptionToolBar::AddButton(), ControlToolBar::ArrangeButtons(), DeviceToolBar::Populate(), MeterToolBar::Populate(), MixerToolBar::Populate(), SelectionBar::Populate(), TimeToolBar::Populate(), ToolsToolBar::Populate(), and TranscriptionToolBar::Populate().

Here is the caller graph for this function:

AddSpacer()

void ToolBar::AddSpacer ( int  size = 14 )

protected

Definition at line 736 of file ToolBar.cpp.

{
   mHSizer->AddSpacer( size );
}

References mHSizer, and size.

Referenced by EditToolBar::AddSeparator().

Here is the caller graph for this function:

AddStretchSpacer()

void ToolBar::AddStretchSpacer ( int  prop = 1 )

protected

Definition at line 744 of file ToolBar.cpp.

{
   mHSizer->AddStretchSpacer( prop );
}

References mHSizer.

Create()

void ToolBar::Create ( wxWindow *  parent )

virtual

Reimplemented in TranscriptionToolBar, ToolsToolBar, SpectralSelectionBar, SelectionBar, ScrubbingToolBar, MixerToolBar, MeterToolBar, EditToolBar, DeviceToolBar, and ControlToolBar.

Definition at line 475 of file ToolBar.cpp.

{
   // Save parameters
   mParent = parent;
 
   // Create the window and label it
   wxPanelWrapper::Create( mParent,
                    mType,
                    wxDefaultPosition,
                    wxDefaultSize,
                    wxNO_BORDER | wxTAB_TRAVERSAL,
                    GetTitle() );
   wxPanelWrapper::SetLabel( GetLabel() );
 
   // Go do the rest of the creation
   ReCreateButtons();
 
   // ToolManager depends on this appearing to be visible for proper dock construction
   mVisible = true;
}

References wxPanelWrapper::Create(), GetLabel(), GetTitle(), mParent, mType, mVisible, ReCreateButtons(), and wxPanelWrapper::SetLabel().

Referenced by ControlToolBar::Create(), DeviceToolBar::Create(), EditToolBar::Create(), MeterToolBar::Create(), MixerToolBar::Create(), ScrubbingToolBar::Create(), SelectionBar::Create(), ToolsToolBar::Create(), TranscriptionToolBar::Create(), and ToolManager::ReadConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

Detach() [1/2]

void ToolBar::Detach ( wxSizer *  sizer )

protected

Definition at line 760 of file ToolBar.cpp.

{
   mHSizer->Detach( sizer );
}

References mHSizer.

Detach() [2/2]

void ToolBar::Detach ( wxWindow *  window )

protected

Definition at line 752 of file ToolBar.cpp.

{
   mHSizer->Detach( window );
}

References mHSizer.

Referenced by ControlToolBar::ArrangeButtons(), and ControlToolBar::ReCreateButtons().

Here is the caller graph for this function:

EnableDisableButtons()

virtual void ToolBar::EnableDisableButtons ( )

pure virtual

Implemented in TranscriptionToolBar, ToolsToolBar, TimeToolBar, SpectralSelectionBar, SelectionBar, ScrubbingToolBar, MixerToolBar, MeterToolBar, EditToolBar, DeviceToolBar, and ControlToolBar.

Referenced by ToolManager::Reset(), and ProjectAudioManager::Stop().

Here is the caller graph for this function:

Expose()

bool ToolBar::Expose ( bool  show = true )

virtual

Reimplemented in MeterToolBar.

Definition at line 444 of file ToolBar.cpp.

{
   bool was = mVisible;
 
   SetVisible( show );
 
   if( IsDocked() )
   {
      Show( show );
      if( show )
      {
         Refresh();
      }
   }
   else
   {
      wxWindow * pParent = GetParent();
      if( !IsPositioned() && show ){
         SetPositioned();
         pParent->CentreOnParent();
         pParent->Move( pParent->GetPosition() + wxSize( mType*10, mType*10 ));
      }
      pParent->Show( show );
   }
 
   return was;
}

References IsDocked(), IsPositioned(), mType, mVisible, SetPositioned(), and SetVisible().

Referenced by MeterToolBar::Expose(), ToolDock::Expose(), and ToolManager::Expose().

Here is the call graph for this function:

Here is the caller graph for this function:

GetDock()

ToolDock * ToolBar::GetDock

(

)

Definition at line 630 of file ToolBar.cpp.

{
   return dynamic_cast<ToolDock*>(GetParent());
}

Referenced by ToolManager::DoneDragging(), ToolManager::Expose(), IsDocked(), ReCreateButtons(), ToolManager::Reset(), Updated(), and ToolManager::WriteConfig().

Here is the caller graph for this function:

GetDockedSize()

virtual wxSize ToolBar::GetDockedSize ( )

inlinevirtual

Reimplemented in TimeToolBar, and MeterToolBar.

Definition at line 145 of file ToolBar.h.

{ return GetMinSize(); }

Referenced by ToolDock::Dock().

Here is the caller graph for this function:

GetInitialWidth()

virtual int ToolBar::GetInitialWidth ( )

inlinevirtual

Resizable toolbars should implement these.

Reimplemented in TranscriptionToolBar, TimeToolBar, MixerToolBar, MeterToolBar, and DeviceToolBar.

Definition at line 143 of file ToolBar.h.

{ return -1; }

Referenced by SetToDefaultSize().

Here is the caller graph for this function:

GetLabel()

TranslatableString ToolBar::GetLabel

(

)

Definition at line 374 of file ToolBar.cpp.

{
   return mLabel;
}

References mLabel.

Referenced by Create(), and GetTitle().

Here is the caller graph for this function:

GetMinToolbarWidth()

virtual int ToolBar::GetMinToolbarWidth ( )

inlinevirtual

Reimplemented in TranscriptionToolBar, TimeToolBar, MixerToolBar, MeterToolBar, and DeviceToolBar.

Definition at line 144 of file ToolBar.h.

{ return GetInitialWidth(); }

Referenced by ReCreateButtons().

Here is the caller graph for this function:

GetResizeGrabberWidth()

int ToolBar::GetResizeGrabberWidth ( )

protected

Returns the width in pixels of the resizer element.

Definition at line 955 of file ToolBar.cpp.

{
   return RWIDTH;
}

References RWIDTH.

GetSection()

wxString ToolBar::GetSection

(

)

Definition at line 382 of file ToolBar.cpp.

{
   return mSection;
}

References mSection.

Referenced by ToolManager::ReadConfig(), and ToolManager::WriteConfig().

Here is the caller graph for this function:

GetSizer()

wxBoxSizer * ToolBar::GetSizer ( )

protected

Definition at line 678 of file ToolBar.cpp.

{
   return mHSizer;
}

References mHSizer.

Referenced by ControlToolBar::ArrangeButtons(), MeterToolBar::OnSize(), TimeToolBar::OnSize(), and TimeToolBar::SetResizingLimits().

Here is the caller graph for this function:

GetSmartDockedSize()

wxSize ToolBar::GetSmartDockedSize

(

)

Definition at line 503 of file ToolBar.cpp.

{
   const int tbs = toolbarSingle + toolbarGap;
   wxSize sz = GetSize();
   // 46 is the size where we switch from expanded to compact.
   if( sz.y < 46 )
      sz.y = tbs-1;
   else 
      sz.y = 2 * tbs -1;
   return sz;
}

References toolbarGap, and toolbarSingle.

Referenced by MeterToolBar::GetDockedSize().

Here is the caller graph for this function:

GetTitle()

TranslatableString ToolBar::GetTitle

(

)

Definition at line 365 of file ToolBar.cpp.

{
   /* i18n-hint: %s will be replaced by the name of the kind of toolbar.*/
   return XO("Audacity %s Toolbar").Format( GetLabel() );
}

References GetLabel(), and XO.

Referenced by Create(), SetDocked(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

GetType()

int ToolBar::GetType

(

)

Definition at line 390 of file ToolBar.cpp.

{
   return mType;
}

References mType.

Referenced by ToolDock::VisitLayout().

Here is the caller graph for this function:

Init()

void ToolBar::Init ( wxWindow *  parent, int  type, const wxString &  title, const wxString &  label  )

private

IsDocked()

bool ToolBar::IsDocked

(

)

const

Definition at line 423 of file ToolBar.cpp.

{
   return const_cast<ToolBar*>(this)->GetDock() != nullptr;
}

References GetDock().

Referenced by Expose(), ToolManager::Expose(), ToolManager::IsVisible(), ToolManager::OnGrabber(), ToolFrame::OnMotion(), ReCreateButtons(), ToolManager::Reset(), TimeToolBar::SetResizingLimits(), Updated(), and ToolManager::WriteConfig().

Here is the call graph for this function:

Here is the caller graph for this function:

IsPositioned()

bool ToolBar::IsPositioned ( )

inline

Definition at line 137 of file ToolBar.h.

{ return mPositioned; };

Referenced by Expose(), and ToolManager::WriteConfig().

Here is the caller graph for this function:

IsResizable()

bool ToolBar::IsResizable

(

)

const

Definition at line 415 of file ToolBar.cpp.

{
   return mResizable;
}

References mResizable.

Referenced by ToolFrame::OnMotion(), ToolFrame::OnPaint(), ReCreateButtons(), and ToolManager::Reset().

Here is the caller graph for this function:

IsVisible()

bool ToolBar::IsVisible

(

)

const

Definition at line 431 of file ToolBar.cpp.

{
   return mVisible;
}

References mVisible.

Referenced by ToolDock::Dock(), ToolManager::IsVisible(), and ToolBarConfiguration::Write().

Here is the caller graph for this function:

MakeAlternateImages()

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

static

Definition at line 873 of file ToolBar.cpp.

{
   // wxMax to cater for case of image being bigger than the button.
   int xoff = wxMax( 0, (size.GetWidth() - theTheme.Image(eStandardUp).GetWidth())/2);
   int yoff = wxMax( 0, (size.GetHeight() - theTheme.Image(eStandardUp).GetHeight())/2);
 
   typedef std::unique_ptr<wxImage> wxImagePtr;
   wxImagePtr up        (OverlayImage(eUp,     eStandardUp, xoff, yoff));
   wxImagePtr hilite    (OverlayImage(eHilite, eStandardUp, xoff, yoff));
   wxImagePtr down      (OverlayImage(eDown,   eStandardDown, xoff + 1, yoff + 1));
   wxImagePtr downHi    (OverlayImage(eDownHi, eStandardDown, xoff + 1, yoff + 1));
   wxImagePtr disable   (OverlayImage(eUp,     eDisabled, xoff, yoff));
 
   button.SetAlternateImages(idx, *up, *hilite, *down, *downHi, *disable);
}

References ThemeBase::Image(), OverlayImage(), AButton::SetAlternateImages(), size, and theTheme.

Referenced by ControlToolBar::MakeAlternateImages(), TranscriptionToolBar::MakeAlternateImages(), and AdornedRulerPanel::ReCreateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeButton()

AButton * ToolBar::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

Makes a button and its four different state bitmaps

Parameters

parent	Parent window for the button.
eUp	Background for when button is Up.
eDown	Background for when button is Down.
eHilite	Background for when button is Hilit.
eStandardUp	Foreground when enabled, up.
eStandardDown	Foreground when enabled, down.
eDisabled	Foreground when disabled.
id	Windows Id.
placement	Placement position
processdownevents	true iff button handles down events.
size	Size of the background.

Definition at line 840 of file ToolBar.cpp.

{
   // wxMax to cater for case of image being bigger than the button.
   int xoff = wxMax( 0, (size.GetWidth() - theTheme.Image(eStandardUp).GetWidth())/2);
   int yoff = wxMax( 0, (size.GetHeight() - theTheme.Image(eStandardUp).GetHeight())/2);
 
   typedef std::unique_ptr<wxImage> wxImagePtr;
   wxImagePtr up2        (OverlayImage(eUp,     eStandardUp, xoff, yoff));
   wxImagePtr hilite2    (OverlayImage(eHilite, eStandardUp, xoff, yoff));
   wxImagePtr down2      (OverlayImage(eDown,   eStandardDown, xoff + 1, yoff + 1));
   wxImagePtr downHi2    (OverlayImage(eDownHi, eStandardDown, xoff + 1, yoff + 1));
   wxImagePtr disable2   (OverlayImage(eUp,     eDisabled, xoff, yoff));
 
   wxASSERT(parent); // to justify safenew
   AButton * button =
      safenew AButton(parent, id, placement, size, *up2, *hilite2, *down2, *downHi2,
            *disable2, processdownevents);
 
   return button;
}

References ThemeBase::Image(), OverlayImage(), safenew, size, and theTheme.

Referenced by EditToolBar::AddButton(), ScrubbingToolBar::AddButton(), TranscriptionToolBar::AddButton(), ControlToolBar::MakeButton(), ToolsToolBar::MakeTool(), and AdornedRulerPanel::ReCreateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeButtonBackgroundsLarge()

void ToolBar::MakeButtonBackgroundsLarge ( )

static

Definition at line 776 of file ToolBar.cpp.

{
 
   bool bUseAqua = false;
 
#ifdef EXPERIMENTAL_THEME_PREFS
   gPrefs->Read( wxT("/GUI/ShowMac"), &bUseAqua, false);
#endif
 
#ifdef USE_AQUA_THEME
   bUseAqua = !bUseAqua;
#endif
 
   if( bUseAqua ){
      MakeMacRecoloredImage( bmpRecoloredUpLarge,       bmpMacUpButton );
      MakeMacRecoloredImage( bmpRecoloredDownLarge,     bmpMacDownButton );
      MakeMacRecoloredImage( bmpRecoloredUpHiliteLarge, bmpMacHiliteUpButton );
      MakeMacRecoloredImage( bmpRecoloredHiliteLarge,   bmpMacHiliteButton );
   } else {
      MakeRecoloredImage( bmpRecoloredUpLarge,       bmpUpButtonLarge );
      MakeRecoloredImage( bmpRecoloredDownLarge,     bmpDownButtonLarge );
      MakeRecoloredImage( bmpRecoloredUpHiliteLarge, bmpHiliteUpButtonLarge );
      MakeRecoloredImage( bmpRecoloredHiliteLarge,   bmpHiliteButtonLarge );
   }
}

References gPrefs, MakeMacRecoloredImage(), and MakeRecoloredImage().

Referenced by ControlToolBar::Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeButtonBackgroundsSmall()

void ToolBar::MakeButtonBackgroundsSmall ( )

static

Definition at line 802 of file ToolBar.cpp.

{
 
   bool bUseAqua = false;
 
#ifdef EXPERIMENTAL_THEME_PREFS
   gPrefs->Read( wxT("/GUI/ShowMac"), &bUseAqua, false);
#endif
 
#ifdef USE_AQUA_THEME
   bUseAqua = !bUseAqua;
#endif
 
   if( bUseAqua ){
      MakeMacRecoloredImage( bmpRecoloredUpSmall,       bmpMacUpButtonSmall );
      MakeMacRecoloredImage( bmpRecoloredDownSmall,     bmpMacDownButtonSmall );
      MakeMacRecoloredImage( bmpRecoloredUpHiliteSmall, bmpMacHiliteUpButtonSmall );
      MakeMacRecoloredImage( bmpRecoloredHiliteSmall,   bmpMacHiliteButtonSmall );
   } else {
      MakeRecoloredImage(    bmpRecoloredUpSmall,       bmpUpButtonSmall );
      MakeRecoloredImage(    bmpRecoloredDownSmall,     bmpDownButtonSmall );
      MakeRecoloredImage(    bmpRecoloredUpHiliteSmall, bmpHiliteUpButtonSmall );
      MakeRecoloredImage(    bmpRecoloredHiliteSmall,   bmpHiliteButtonSmall );
   }
}

References gPrefs, MakeMacRecoloredImage(), and MakeRecoloredImage().

Referenced by EditToolBar::Populate(), ScrubbingToolBar::Populate(), ToolsToolBar::Populate(), TranscriptionToolBar::Populate(), and AdornedRulerPanel::ReCreateButtons().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeMacRecoloredImage()

void ToolBar::MakeMacRecoloredImage ( teBmps  eBmpOut, teBmps  eBmpIn  )

staticprotected

Definition at line 765 of file ToolBar.cpp.

{
   theTheme.ReplaceImage( eBmpOut, &theTheme.Image( eBmpIn ));
}

References ThemeBase::Image(), ThemeBase::ReplaceImage(), and theTheme.

Referenced by MakeButtonBackgroundsLarge(), MakeButtonBackgroundsSmall(), and MakeRecoloredImage().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeRecoloredImage()

void ToolBar::MakeRecoloredImage ( teBmps  eBmpOut, teBmps  eBmpIn  )

staticprotected

Definition at line 770 of file ToolBar.cpp.

{
   // Don't recolour the buttons...
   MakeMacRecoloredImage( eBmpOut, eBmpIn );
}

References MakeMacRecoloredImage().

Referenced by MakeButtonBackgroundsLarge(), and MakeButtonBackgroundsSmall().

Here is the call graph for this function:

Here is the caller graph for this function:

OnErase()

void ToolBar::OnErase ( wxEraseEvent &  event )

protected

Definition at line 929 of file ToolBar.cpp.

{
   // Ignore it to prevent flashing
}

OnMouseEvents()

void ToolBar::OnMouseEvents ( wxMouseEvent &  event )

protected

Definition at line 948 of file ToolBar.cpp.

{
   // Do this hack so scrubber can detect mouse drags anywhere
   event.ResumePropagation(wxEVENT_PROPAGATE_MAX);
   event.Skip();
}

OnPaint()

void ToolBar::OnPaint ( wxPaintEvent &  event )

protected

Definition at line 937 of file ToolBar.cpp.

{
   wxPaintDC dc( this );
 
   // Themed background colour.
   dc.SetBackground( wxBrush( theTheme.Colour( clrMedium  ) ) );
   dc.Clear();
 
   Repaint( &dc );
}

References ThemeBase::Colour(), Repaint(), and theTheme.

Here is the call graph for this function:

Populate()

virtual void ToolBar::Populate ( )

protectedpure virtual

Implemented in TranscriptionToolBar, ToolsToolBar, TimeToolBar, SpectralSelectionBar, SelectionBar, ScrubbingToolBar, MixerToolBar, MeterToolBar, EditToolBar, DeviceToolBar, and ControlToolBar.

Referenced by ReCreateButtons().

Here is the caller graph for this function:

ReCreateButtons()

void ToolBar::ReCreateButtons ( )

virtual

Reimplemented in MeterToolBar, and ControlToolBar.

Definition at line 516 of file ToolBar.cpp.

{
   wxSize sz3 = GetSize();
   //wxLogDebug( "x:%i y:%i",sz3.x, sz3.y);
 
   // SetSizer(NULL) detaches mHSizer and deletes it.
   // Do not use Detach() here, as that attempts to detach mHSizer from itself!
   SetSizer( NULL );
 
   // Get rid of any children we may have
   DestroyChildren();
   mGrabber = NULL;
   mResizer = NULL;
   SetLayoutDirection(wxLayout_LeftToRight);
 
   // Refresh the background before populating
   if (!IsDocked())
   {
      GetParent()->Refresh();
   }
 
   {
      // Create the main sizer
      auto ms = std::make_unique<wxBoxSizer>(wxHORIZONTAL);
 
      // Create the grabber and add it to the main sizer
      mGrabber = safenew Grabber(this, mType);
      ms->Add(mGrabber, 0, wxEXPAND | wxALIGN_LEFT | wxALIGN_TOP | wxRIGHT, 1);
 
      // Use a box sizer for laying out controls
      ms->Add((mHSizer = safenew wxBoxSizer(wxHORIZONTAL)), 1, wxEXPAND);
 
      // Go add all the rest of the gadgets
      Populate();
 
      // Add some space for the resize border
      if (IsResizable())
      {
         // Create the resizer and add it to the main sizer
         mResizer = safenew ToolBarResizer(this);
         ms->Add(mResizer, 0, wxEXPAND | wxALIGN_TOP | wxLEFT, 1);
         mResizer->SetToolTip(_("Click and drag to resize toolbar"));
      }
      
      // Set dock after possibly creating resizer.
      // (Re)Establish dock state
      SetDocked(GetDock(), false);
 
      // Set the sizer
      SetSizerAndFit(ms.release());
   }
 
   // Recalculate the height to be a multiple of toolbarSingle
   const int tbs = toolbarSingle + toolbarGap;
   wxSize sz = GetSize();
   sz.y = ( ( ( sz.y + tbs -1) / tbs ) * tbs ) - 1;
 
   // Set the true AND minimum sizes and do final layout
   if(IsResizable())
   {
      // JKC we're going to allow all resizable toolbars to be resized
      // to 1 unit high, typically 27 pixels.
      wxSize sz2 = sz;
      sz2.SetWidth(GetMinToolbarWidth());
      sz2.y = tbs -1;
      SetMinSize(sz2);
      
      // sz2 is now the minimum size.
      // sz3 is the size we were.
 
      // We're recreating buttons, and we want to preserve original size.
      // But not if that makes the size too small.
 
      // Size at least as big as minimum.
      if( sz3.y < sz2.y )
         sz3.y = sz2.y;
      if( sz3.x < sz2.x )
         sz3.x = sz2.x;
      SetSize(sz3);
   }
   else
   {
      SetInitialSize(sz);
   }
   Layout();
}

References _, GetDock(), GetMinToolbarWidth(), IsDocked(), IsResizable(), mGrabber, mHSizer, mResizer, mType, Populate(), safenew, SetDocked(), toolbarGap, ToolBarResizer, and toolbarSingle.

Referenced by Create(), ProjectWindow::OnThemeChange(), SelectionBar::OnUpdate(), ControlToolBar::ReCreateButtons(), MeterToolBar::ReCreateButtons(), and ToolManager::Reset().

Here is the call graph for this function:

Here is the caller graph for this function:

RegenerateTooltips()

virtual void ToolBar::RegenerateTooltips ( )

pure virtual

Implemented in TranscriptionToolBar, ToolsToolBar, TimeToolBar, SpectralSelectionBar, SelectionBar, ScrubbingToolBar, MixerToolBar, MeterToolBar, EditToolBar, DeviceToolBar, and ControlToolBar.

Repaint()

virtual void ToolBar::Repaint ( wxDC *  dc )

protectedpure virtual

Implemented in ControlToolBar.

Referenced by OnPaint().

Here is the caller graph for this function:

ResizingDone()

virtual void ToolBar::ResizingDone ( )

inlinevirtual

Reimplemented in TimeToolBar.

Definition at line 186 of file ToolBar.h.

{};

Referenced by ToolBarResizer::OnLeftUp(), and ToolManager::ReadConfig().

Here is the caller graph for this function:

SetButton()

void ToolBar::SetButton ( bool  down, AButton *  button  )

protected

Definition at line 914 of file ToolBar.cpp.

{
   if( down )
   {
      button->PushDown();
   }
   else
   {
      button->PopUp();
   }
}

References AButton::PopUp(), and AButton::PushDown().

Here is the call graph for this function:

SetButtonToolTip()

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

static

Definition at line 897 of file ToolBar.cpp.

{
   TranslatableString result;
   const auto project = &theProject;
   const auto commandManager =
      project ? &CommandManager::Get( *project ) : nullptr;
   if (commandManager)
      result =
         commandManager->DescribeCommandsAndShortcuts(commands, nCommands);
   button.SetToolTip( result );
}

References CommandManager::Get(), and AButton::SetToolTip().

Referenced by ScrubbingToolBar::DoRegenerateTooltips(), EditToolBar::ForAllButtons(), ControlToolBar::RegenerateTooltips(), ToolsToolBar::RegenerateTooltips(), TranscriptionToolBar::RegenerateTooltips(), and AdornedRulerPanel::UpdateButtonStates().

Here is the call graph for this function:

Here is the caller graph for this function:

SetDocked()

void ToolBar::SetDocked ( ToolDock *  dock, bool  pushed  )

virtual

Reimplemented in TimeToolBar, and MeterToolBar.

Definition at line 638 of file ToolBar.cpp.

{
   // Remember it
//   mDock = dock;
 
   // Change the tooltip of the grabber
#if wxUSE_TOOLTIPS
   mGrabber->SetToolTip( GetTitle() );
#endif
 
   // Set the grabber button state
   mGrabber->PushButton( pushed );
 
   if (mResizer)
   {
      mResizer->Show(dock != NULL);
      Layout();
   }
}

References GetTitle(), mGrabber, mResizer, Grabber::PushButton(), and Grabber::SetToolTip().

Referenced by ToolDock::Dock(), ToolManager::DoneDragging(), ToolManager::HandleEscapeKey(), ToolManager::OnMouse(), ToolManager::ReadConfig(), ReCreateButtons(), ToolManager::Reset(), MeterToolBar::SetDocked(), TimeToolBar::SetDocked(), and ToolManager::UndockBar().

Here is the call graph for this function:

Here is the caller graph for this function:

SetLabel() [1/2]

void ToolBar::SetLabel

(

const TranslatableString &

label

)

Definition at line 405 of file ToolBar.cpp.

{
   // Only this overload is publicly accessible when you have a pointer to
   // Toolbar or a subclass of it
   mLabel = label;
}

References label, and mLabel.

SetLabel() [2/2]

void ToolBar::SetLabel ( const wxString &  label )

overrideprivate

Definition at line 398 of file ToolBar.cpp.

{
   // Probably shouldn't reach this overload, but perhaps virtual function
   // dispatch will take us here from a pointer to the wxPanel base class
   mLabel = Verbatim( label );
}

References label, mLabel, and Verbatim().

Referenced by ControlToolBar::UpdatePrefs(), DeviceToolBar::UpdatePrefs(), EditToolBar::UpdatePrefs(), MeterToolBar::UpdatePrefs(), MixerToolBar::UpdatePrefs(), ScrubbingToolBar::UpdatePrefs(), SelectionBar::UpdatePrefs(), TimeToolBar::UpdatePrefs(), and TranscriptionToolBar::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

SetPositioned()

void ToolBar::SetPositioned ( )

inline

Definition at line 139 of file ToolBar.h.

{ mPositioned = true;};

Referenced by Expose(), ToolManager::ReadConfig(), and ToolManager::UndockBar().

Here is the caller graph for this function:

SetToDefaultSize()

void ToolBar::SetToDefaultSize ( )

virtual

Reimplemented in TimeToolBar.

Definition at line 496 of file ToolBar.cpp.

                              {
   wxSize sz;
   sz.SetHeight( -1 );
   sz.SetWidth( GetInitialWidth());
   SetSize( sz );
}

References GetInitialWidth().

Referenced by ToolManager::Reset().

Here is the call graph for this function:

Here is the caller graph for this function:

SetVisible()

void ToolBar::SetVisible

(

bool

bVisible

)

Definition at line 436 of file ToolBar.cpp.

{
   mVisible = bVisible;
}

References mVisible.

Referenced by Expose(), and ToolManager::ReadConfig().

Here is the caller graph for this function:

Updated()

void ToolBar::Updated ( )

protected

Definition at line 661 of file ToolBar.cpp.

{
   if( IsDocked() )
      GetDock()->Updated();
   else
      // Bug 2120.  Changing the choice also changes the size of the toolbar so
      // we need to update the client size, even if undocked.
      // If modifying/improving this, remember to test both changing the choice,
      // and clicking on the choice but not actually changing it.
      GetParent()->SetClientSize( GetSize() + wxSize( 2,2));
   //wxCommandEvent e( EVT_TOOLBAR_UPDATED, GetId() );
   //GetParent()->GetEventHandler()->AddPendingEvent( e );
}

References GetDock(), IsDocked(), and ToolDock::Updated().

Referenced by SelectionBar::OnUpdate(), TimeToolBar::OnUpdate(), ToolBarResizer::ResizeBar(), TimeToolBar::ResizingDone(), SelectionBar::SelectionModeUpdated(), TimeToolBar::SetDocked(), TimeToolBar::SetToDefaultSize(), ControlToolBar::UpdatePrefs(), and MixerToolBar::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

UpdatePrefs()

void ToolBar::UpdatePrefs ( )

overridevirtual

Implements PrefsListener.

Reimplemented in TranscriptionToolBar, and ToolsToolBar.

Definition at line 605 of file ToolBar.cpp.

{
#if wxUSE_TOOLTIPS
   // Change the tooltip of the grabber
   if ( mGrabber )
   {
      mGrabber->SetToolTip( GetTitle() );
   }
 
   // Change the tooltip of the resizer
   if ( mResizer )
   {
      mResizer->SetToolTip( _("Click and drag to resize toolbar") );
      wxSizeEvent e;
      GetParent()->GetEventHandler()->AddPendingEvent( e );
      GetParent()->Refresh();
   }
#endif
 
   return;
}

References _, GetTitle(), mGrabber, mResizer, and Grabber::SetToolTip().

Referenced by ControlToolBar::UpdatePrefs(), DeviceToolBar::UpdatePrefs(), EditToolBar::UpdatePrefs(), MeterToolBar::UpdatePrefs(), MixerToolBar::UpdatePrefs(), ScrubbingToolBar::UpdatePrefs(), SelectionBar::UpdatePrefs(), TimeToolBar::UpdatePrefs(), ToolsToolBar::UpdatePrefs(), and TranscriptionToolBar::UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

ToolBarResizer

friend class ToolBarResizer

friend

Definition at line 258 of file ToolBar.h.

Referenced by ReCreateButtons().

Member Data Documentation

mGrabber

Grabber* ToolBar::mGrabber

private

Definition at line 244 of file ToolBar.h.

Referenced by ReCreateButtons(), SetDocked(), and UpdatePrefs().

mHSizer

wxBoxSizer* ToolBar::mHSizer

private

Definition at line 247 of file ToolBar.h.

Referenced by Add(), AddSpacer(), AddStretchSpacer(), Detach(), GetSizer(), and ReCreateButtons().

mLabel

TranslatableString ToolBar::mLabel

protected

Definition at line 236 of file ToolBar.h.

Referenced by GetLabel(), and SetLabel().

mParent

wxWindow* ToolBar::mParent

private

Definition at line 242 of file ToolBar.h.

Referenced by Create().

mPositioned

bool ToolBar::mPositioned

private

Definition at line 251 of file ToolBar.h.

mProject

AudacityProject& ToolBar::mProject

protected

Definition at line 235 of file ToolBar.h.

Referenced by ScrubbingToolBar::DoRegenerateTooltips(), ToolsToolBar::DoToolChanged(), ControlToolBar::EnableDisableButtons(), DeviceToolBar::EnableDisableButtons(), ScrubbingToolBar::EnableDisableButtons(), TranscriptionToolBar::EnableDisableButtons(), MeterToolBar::Expose(), EditToolBar::ForAllButtons(), TranscriptionToolBar::GetSamples(), MixerToolBar::OnAudioCapture(), EditToolBar::OnButton(), ScrubbingToolBar::OnButton(), ControlToolBar::OnFF(), ControlToolBar::OnIdle(), SelectionBar::OnIdle(), TimeToolBar::OnIdle(), ControlToolBar::OnKeyEvent(), ControlToolBar::OnLoop(), ControlToolBar::OnPause(), ControlToolBar::OnPlay(), ControlToolBar::OnRecord(), ControlToolBar::OnRewind(), ControlToolBar::OnStop(), ToolsToolBar::OnTool(), ToolsToolBar::OnToolChanged(), TranscriptionToolBar::PlayAtSpeed(), ControlToolBar::PlayDefault(), MeterToolBar::Populate(), TimeToolBar::Populate(), MeterToolBar::ReCreateButtons(), ControlToolBar::RegenerateTooltips(), ToolsToolBar::RegenerateTooltips(), TranscriptionToolBar::RegenerateTooltips(), TranscriptionToolBar::SetPlaySpeed(), ControlToolBar::StartScrolling(), ControlToolBar::StartScrollingIfPreferred(), ControlToolBar::StateForStatusBar(), ControlToolBar::StopScrolling(), and ControlToolBar::UpdateStatusBar().

mResizable

bool ToolBar::mResizable

private

Definition at line 250 of file ToolBar.h.

Referenced by IsResizable().

mResizer

ToolBarResizer* ToolBar::mResizer

private

Definition at line 245 of file ToolBar.h.

Referenced by ReCreateButtons(), SetDocked(), and UpdatePrefs().

mSection

wxString ToolBar::mSection

protected

Definition at line 237 of file ToolBar.h.

Referenced by GetSection().

mType

int ToolBar::mType

protected

Definition at line 238 of file ToolBar.h.

Referenced by Create(), Expose(), GetType(), and ReCreateButtons().

mVisible

bool ToolBar::mVisible

private

Definition at line 249 of file ToolBar.h.

Referenced by Create(), Expose(), IsVisible(), and SetVisible().

---

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

• ToolBar.h
• ToolBar.cpp