ToolsToolBar Class Reference

A kind of ToolBar with Tools on it. More...

#include <ToolsToolBar.h>

Inheritance diagram for ToolsToolBar:

Collaboration diagram for ToolsToolBar:

Public Member Functions
	ToolsToolBar (AudacityProject &project)
virtual	~ToolsToolBar ()
void	UpdatePrefs () override
void	OnTool (wxCommandEvent &evt)
void	OnToolChanged (ProjectSettingsEvent)
void	DoToolChanged ()
void	Populate () override
void	Repaint (wxDC *WXUNUSED(dc)) override
void	EnableDisableButtons () override
Public Member Functions inherited from ToolBar
	ToolBar (AudacityProject &project, const TranslatableString &label, const Identifier &section, bool resizable=false)
virtual	~ToolBar ()
virtual bool	ShownByDefault () const
	Whether the toolbar should be shown by default. Default implementation returns true. More...
virtual bool	HideAfterReset () const
	Default implementation returns false. More...
virtual DockID	DefaultDockID () const
	Which dock the toolbar defaults into. Default implementation chooses the top dock. More...
bool	AcceptsFocus () const override
bool	AcceptsFocusFromKeyboard () 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	GetIndex () const
	Get a value used for computing cascading positions of undocked bars. More...
void	SetIndex (int index)
	Set a value used for computing cascading positions of undocked bars. More...
TranslatableString	GetTitle ()
TranslatableString	GetLabel ()
Identifier	GetSection ()
ToolDock *	GetDock ()
void	SetPreferredNeighbors (Identifier left, Identifier top={})
void	SetLabel (const TranslatableString &label)
virtual void	SetDocked (ToolDock *dock, bool pushed)
std::pair< Identifier, Identifier >	PreferredNeighbors () const noexcept
	Defaults to (NoBarID, NoBarId) More...
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 Identifier	ID ()
static ToolsToolBar &	Get (AudacityProject &project)
static const ToolsToolBar &	Get (const AudacityProject &project)
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 ()

Private Types
enum	{ numTools = 4 }

Private Member Functions
void	Create (wxWindow *parent) override
void	RegenerateTooltips () override
wxImage *	MakeToolImage (wxImage *tool, wxImage *mask, int style)

Private Attributes
Observer::Subscription	mSubscription
AButton *	mTool [numTools]
wxGridSizer *	mToolSizer
int	mCurrentTool

Additional Inherited Members
Public Types inherited from ToolBar
enum	DockID { TopDockID = 1 , BotDockID = 2 }
	Identifies one of the docking areas for toolbars. More...
using	Holder = wxWindowPtr< ToolBar >
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
Identifier	mSection
int	mIndex {0}

Detailed Description

A kind of ToolBar with Tools on it.

This class, which is a child of Toolbar, creates the window containing the tool selection (ibeam, envelope, move, zoom). 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.

See also

Themability of Audacity

Definition at line 37 of file ToolsToolBar.h.

Member Enumeration Documentation

anonymous enum

anonymous enum

private

Enumerator
numTools

Definition at line 64 of file ToolsToolBar.h.

{ numTools = 4 };

Constructor & Destructor Documentation

ToolsToolBar()

ToolsToolBar::ToolsToolBar

(

AudacityProject &

project

)

Definition at line 105 of file ToolsToolBar.cpp.

: ToolBar(project, XO("Tools"), ID())
{
   using namespace ToolCodes;
 
   //Read the following wxASSERTs as documentating a design decision
   wxASSERT( selectTool   == selectTool   - firstTool );
   wxASSERT( envelopeTool == envelopeTool - firstTool );
   wxASSERT( drawTool     == drawTool     - firstTool );
   wxASSERT( multiTool    == multiTool    - firstTool );
   bool multiToolActive = false;
   gPrefs->Read(wxT("/GUI/ToolBars/Tools/MultiToolActive"), &multiToolActive);
 
   if (multiToolActive)
      mCurrentTool = multiTool;
   else
      mCurrentTool = selectTool;
 
   mSubscription = ProjectSettings::Get(project)
      .Subscribe(*this, &ToolsToolBar::OnToolChanged);
}

References ToolCodes::drawTool, ToolCodes::envelopeTool, ToolCodes::firstTool, ProjectSettings::Get(), gPrefs, mCurrentTool, mSubscription, ToolCodes::multiTool, OnToolChanged(), project, audacity::BasicSettings::Read(), ToolCodes::selectTool, Observer::Publisher< Message, NotifyAll >::Subscribe(), and wxT().

Here is the call graph for this function:

~ToolsToolBar()

ToolsToolBar::~ToolsToolBar ( )

virtual

Definition at line 127 of file ToolsToolBar.cpp.

{
   static_assert(
      ToolsToolBar::numTools <= ToolCodes::numTools,
      "mismatch in number of tools" );
}

References ToolCodes::numTools, and numTools.

Member Function Documentation

Create()

void ToolsToolBar::Create ( wxWindow *  parent )

overrideprivatevirtual

Reimplemented from ToolBar.

Definition at line 270 of file ToolsToolBar.cpp.

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

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

Here is the call graph for this function:

DoToolChanged()

void ToolsToolBar::DoToolChanged

(

)

Definition at line 254 of file ToolsToolBar.cpp.

{
   auto &projectSettings = ProjectSettings::Get( mProject );
   using namespace ToolCodes;
   mCurrentTool = projectSettings.GetTool() - firstTool;
   for (int i = 0; i < numTools; i++)
      if (i == mCurrentTool)
         mTool[i]->PushDown();
      else
         mTool[i]->PopUp();
 
   gPrefs->Write(wxT("/GUI/ToolBars/Tools/MultiToolActive"),
                 mTool[multiTool]->IsDown());
   gPrefs->Flush();
}

References ToolCodes::firstTool, audacity::BasicSettings::Flush(), ProjectSettings::Get(), gPrefs, mCurrentTool, ToolBar::mProject, mTool, ToolCodes::multiTool, numTools, AButton::PopUp(), AButton::PushDown(), audacity::BasicSettings::Write(), and wxT().

Referenced by OnToolChanged(), and Populate().

Here is the call graph for this function:

Here is the caller graph for this function:

EnableDisableButtons()

void ToolsToolBar::EnableDisableButtons ( )

inlineoverridevirtual

Implements ToolBar.

Definition at line 56 of file ToolsToolBar.h.

{};

Get() [1/2]

ToolsToolBar & ToolsToolBar::Get ( AudacityProject &  project )

static

Definition at line 134 of file ToolsToolBar.cpp.

{
   auto &toolManager = ToolManager::Get( project );
   return *static_cast<ToolsToolBar*>(toolManager.GetToolBar(ID()));
}

References ToolManager::Get(), ID(), and project.

Referenced by Get(), and anonymous_namespace{ToolsToolBar.cpp}::SetTool().

Here is the call graph for this function:

Here is the caller graph for this function:

Get() [2/2]

const ToolsToolBar & ToolsToolBar::Get ( const AudacityProject &  project )

static

Definition at line 140 of file ToolsToolBar.cpp.

{
   return Get( const_cast<AudacityProject&>( project )) ;
}

References Get(), and project.

Here is the call graph for this function:

ID()

Identifier ToolsToolBar::ID ( )

static

Definition at line 99 of file ToolsToolBar.cpp.

{
   return wxT("Tools");
}

References wxT().

Referenced by Get().

Here is the call graph for this function:

Here is the caller graph for this function:

MakeToolImage()

wxImage * ToolsToolBar::MakeToolImage ( wxImage *  tool, wxImage *  mask, int  style  )

private

OnTool()

void ToolsToolBar::OnTool

(

wxCommandEvent &

evt

)

Definition at line 234 of file ToolsToolBar.cpp.

{
   // This will cause callback to OnToolChanged
   auto iTool = evt.GetId() - ToolCodes::firstTool - FirstToolID;
   auto pButton = mTool[iTool];
   if (pButton->IsDown())
      ProjectSettings::Get( mProject ).SetTool( iTool );
   else
      // Don't stay up
      pButton->PushDown();
}

References ToolCodes::firstTool, FirstToolID, ProjectSettings::Get(), ToolBar::mProject, mTool, and ProjectSettings::SetTool().

Here is the call graph for this function:

OnToolChanged()

void ToolsToolBar::OnToolChanged

(

ProjectSettingsEvent

evt

)

Definition at line 246 of file ToolsToolBar.cpp.

{
   if (evt.type != ProjectSettingsEvent::ChangedTool)
      return;
   DoToolChanged();
   Viewport::Get(mProject).Redraw();
}

References ProjectSettingsEvent::ChangedTool, DoToolChanged(), Viewport::Get(), ToolBar::mProject, Viewport::Redraw(), and ProjectSettingsEvent::type.

Referenced by ToolsToolBar().

Here is the call graph for this function:

Here is the caller graph for this function:

Populate()

void ToolsToolBar::Populate ( )

overridevirtual

Implements ToolBar.

Definition at line 202 of file ToolsToolBar.cpp.

{
   SetBackgroundColour( theTheme.Colour( clrMedium  ) );
   MakeButtonBackgroundsSmall();
 
   Add(mToolSizer = safenew wxGridSizer(2, 2, toolbarSpacing, toolbarSpacing),
      0, wxALIGN_CENTRE | wxALL, toolbarSpacing);
 
   /* Tools */
   using namespace ToolCodes;
   mTool[ selectTool   ] =
      MakeToolsToolBarButton(this, selectTool, XO("Selection Tool"), theTheme.Image(bmpIBeam));
      //MakeTool( this, bmpIBeam, selectTool, XO("Selection Tool") );
   mTool[ envelopeTool ] =
      MakeToolsToolBarButton(this, envelopeTool, XO("Envelope Tool"), theTheme.Image(bmpEnvelope));
      //MakeTool( this, bmpEnvelope, envelopeTool, XO("Envelope Tool") );
   mTool[ drawTool     ] =
      MakeToolsToolBarButton(this, drawTool, XO("Draw Tool"), theTheme.Image(bmpDraw));
      //MakeTool( this, bmpDraw, drawTool, XO("Draw Tool") );
   mTool[ multiTool    ] =
      MakeToolsToolBarButton(this, multiTool, XO("Multi-Tool"), theTheme.Image(bmpMulti));
      //MakeTool( this, bmpMulti, multiTool, XO("Multi-Tool") );
   mToolSizer->Add(mTool[selectTool]);
   mToolSizer->Add(mTool[envelopeTool]);
   mToolSizer->Add(mTool[drawTool]);
   mToolSizer->Add(mTool[multiTool]);
 
   DoToolChanged();
 
   RegenerateTooltips();
}

References ToolBar::Add(), ThemeBase::Colour(), DoToolChanged(), ToolCodes::drawTool, ToolCodes::envelopeTool, ThemeBase::Image(), ToolBar::MakeButtonBackgroundsSmall(), mTool, mToolSizer, ToolCodes::multiTool, RegenerateTooltips(), safenew, ToolCodes::selectTool, theTheme, toolbarSpacing, and XO().

Here is the call graph for this function:

RegenerateTooltips()

void ToolsToolBar::RegenerateTooltips ( )

overrideprivatevirtual

Implements ToolBar.

Definition at line 145 of file ToolsToolBar.cpp.

{
 
// JKC:
//   Under Win98 Tooltips appear to be buggy, when you have a lot of
//   tooltip messages flying around.  I found that just creating a
//   twelfth tooltip caused Audacity to crash when it tried to show
//   any tooltip.
//
//   Win98 does NOT recover from this crash - for any application which is
//   using tooltips will also crash thereafter...  so you must reboot.
//   Rather weird.
//
//   Getting windows to process more of its stacked up messages seems
//   to workaround the problem.  The problem is not fully understood though
//   (as of April 2003).
 
   // Vaughan, October 2003: Now we're crashing on Win2K if
   // "Quit when closing last window" is unchecked, when we come back
   // through here, on either of the wxSafeYield calls.
   // James confirms that commenting them out does not cause his original problem
   // to reappear, so they're commented out now.
   //    wxSafeYield(); //Deal with some queued up messages...
 
   #if wxUSE_TOOLTIPS
 
   using namespace ToolCodes;
 
   static const struct Entry {
      int tool;
      CommandID commandName;
      TranslatableString untranslatedLabel;
   } table[] = {
      { selectTool,   wxT("SelectTool"),    XO("Selection Tool")  },
      { envelopeTool, wxT("EnvelopeTool"),  XO("Envelope Tool")   },
      { drawTool,     wxT("DrawTool"),      XO("Draw Tool")       },
      { multiTool,    wxT("MultiTool"),     XO("Multi-Tool")      },
   };
 
   for (const auto &entry : table) {
      ComponentInterfaceSymbol command{
         entry.commandName, entry.untranslatedLabel };
      ToolBar::SetButtonToolTip( mProject,
         *mTool[entry.tool], &command, 1u );
   }
   #endif
 
   //    wxSafeYield();
   return;
}

References ToolCodes::drawTool, entry, ToolCodes::envelopeTool, ToolBar::mProject, mTool, ToolCodes::multiTool, ToolCodes::selectTool, ToolBar::SetButtonToolTip(), wxT(), and XO().

Referenced by Populate(), and UpdatePrefs().

Here is the call graph for this function:

Here is the caller graph for this function:

Repaint()

void ToolsToolBar::Repaint ( wxDC *  WXUNUSEDdc )

inlineoverride

Definition at line 55 of file ToolsToolBar.h.

{};

UpdatePrefs()

void ToolsToolBar::UpdatePrefs ( )

overridevirtual

Reimplemented from ToolBar.

Definition at line 196 of file ToolsToolBar.cpp.

{
   RegenerateTooltips();
   ToolBar::UpdatePrefs();
}

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

Referenced by Create().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

mCurrentTool

int ToolsToolBar::mCurrentTool

private

Definition at line 69 of file ToolsToolBar.h.

Referenced by DoToolChanged(), and ToolsToolBar().

mSubscription

Observer::Subscription ToolsToolBar::mSubscription

private

Definition at line 66 of file ToolsToolBar.h.

Referenced by ToolsToolBar().

mTool

AButton* ToolsToolBar::mTool[numTools]

private

Definition at line 67 of file ToolsToolBar.h.

Referenced by DoToolChanged(), OnTool(), Populate(), and RegenerateTooltips().

mToolSizer

wxGridSizer* ToolsToolBar::mToolSizer

private

Definition at line 68 of file ToolsToolBar.h.

Referenced by Populate().

---

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

• ToolsToolBar.h
• ToolsToolBar.cpp