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

#include <ToolBar.h>

Inheritance diagram for ToolBar:

Public Types
using	Holder = Destroy_ptr< ToolBar >

Public Member Functions
	ToolBar (int type, const wxString &label, const wxString &section, bool resizable=false)

virtual	~ToolBar ()

bool	AcceptsFocus () const override

virtual void	Create (wxWindow *parent)

virtual void	EnableDisableButtons ()=0

virtual void	ReCreateButtons ()

virtual void	UpdatePrefs ()

virtual void	RegenerateTooltips ()=0

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)

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 (AButton &button, const TranslatedInternalString commands[], size_t nCommands)

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

virtual void	Repaint (wxDC *dc)=0

void	OnErase (wxEraseEvent &event)

void	OnPaint (wxPaintEvent &event)

void	OnMouseEvents (wxMouseEvent &event)

Protected Attributes
wxString	mLabel

wxString	mSection

int	mType

Private Member Functions
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 87 of file ToolBar.h.

Member Typedef Documentation

using ToolBar::Holder = Destroy_ptr<ToolBar>

Definition at line 92 of file ToolBar.h.

Constructor & Destructor Documentation

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

Definition at line 307 of file ToolBar.cpp.

References label.

 : wxPanelWrapper()
 {
    // 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 ( )

virtual

Definition at line 334 of file ToolBar.cpp.

335 {

336 }

Member Function Documentation

bool ToolBar::AcceptsFocus ( ) const

inlineoverride

Definition at line 97 of file ToolBar.h.

97 { return false; };

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

protected

Definition at line 611 of file ToolBar.cpp.

References mHSizer.

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

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

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

protected

Definition at line 627 of file ToolBar.cpp.

References mHSizer.

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

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

protected

Definition at line 643 of file ToolBar.cpp.

References mHSizer.

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

void ToolBar::AddSpacer ( int size = 14 )

protected

Definition at line 661 of file ToolBar.cpp.

References mHSizer.

Referenced by EditToolBar::AddSeparator().

 {
    mHSizer->AddSpacer( size );
 }

void ToolBar::AddStretchSpacer ( int prop = 1 )

protected

Definition at line 669 of file ToolBar.cpp.

References mHSizer.

 {
    mHSizer->AddStretchSpacer( prop );
 }

void ToolBar::Create ( wxWindow * parent )

virtual

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

Definition at line 438 of file ToolBar.cpp.

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

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

 {
    // 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;
 }

void ToolBar::Detach ( wxWindow * window )

protected

Definition at line 677 of file ToolBar.cpp.

References mHSizer.

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

 {
    mHSizer->Detach( window );
 }

void ToolBar::Detach ( wxSizer * sizer )

protected

Definition at line 685 of file ToolBar.cpp.

References mHSizer.

 {
    mHSizer->Detach( sizer );
 }

virtual void ToolBar::EnableDisableButtons ( )

pure virtual

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

Referenced by Scrubber::OnToggleScrubRuler(), ToolManager::Reset(), and ControlToolBar::StopPlaying().

bool ToolBar::Expose ( bool show = true )

virtual

Reimplemented in MeterToolBar.

Definition at line 411 of file ToolBar.cpp.

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

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

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

ToolDock * ToolBar::GetDock ( )

Definition at line 560 of file ToolBar.cpp.

Referenced by ToolManager::Expose(), IsDocked(), ToolManager::ReadConfig(), ReCreateButtons(), DeviceToolBar::RepositionCombos(), ToolManager::Reset(), Updated(), and ToolManager::WriteConfig().

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

virtual wxSize ToolBar::GetDockedSize ( )

inlinevirtual

Reimplemented in MeterToolBar.

Definition at line 129 of file ToolBar.h.

Referenced by ToolDock::Dock().

129 { return GetMinSize(); }

virtual int ToolBar::GetInitialWidth ( )

inlinevirtual

Resizable toolbars should implement these.

Reimplemented in MeterToolBar, and DeviceToolBar.

Definition at line 127 of file ToolBar.h.

Referenced by GetMinToolbarWidth(), and ReCreateButtons().

127 { return -1; }

wxString ToolBar::GetLabel ( )

Definition at line 350 of file ToolBar.cpp.

References mLabel.

Referenced by Create(), and GetTitle().

 {
    return mLabel;
 }

virtual int ToolBar::GetMinToolbarWidth ( )

inlinevirtual

Reimplemented in MeterToolBar, and DeviceToolBar.

Definition at line 128 of file ToolBar.h.

References GetInitialWidth().

Referenced by ReCreateButtons().

128 { return GetInitialWidth(); }

ToolBar::GetInitialWidth

virtual int GetInitialWidth()

Resizable toolbars should implement these.

Definition: ToolBar.h:127

int ToolBar::GetResizeGrabberWidth ( )

protected

Returns the width in pixels of the resizer element.

Definition at line 889 of file ToolBar.cpp.

References RWIDTH.

 {
    return RWIDTH;
 }

wxString ToolBar::GetSection ( )

Definition at line 358 of file ToolBar.cpp.

References mSection.

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

 {
    return mSection;
 }

wxBoxSizer * ToolBar::GetSizer ( )

protected

Definition at line 603 of file ToolBar.cpp.

References mHSizer.

Referenced by ControlToolBar::ArrangeButtons(), SpectralSelectionBar::OnChoice(), MeterToolBar::OnSize(), SpectralSelectionBar::Populate(), and SelectionBar::Populate().

 {
    return mHSizer;
 }

wxString ToolBar::GetTitle ( )

Definition at line 341 of file ToolBar.cpp.

References _(), and GetLabel().

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

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

int ToolBar::GetType ( )

Definition at line 366 of file ToolBar.cpp.

References mType.

Referenced by ToolManager::ReadConfig(), and ToolDock::VisitLayout().

 {
    return mType;
 }

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

private

bool ToolBar::IsDocked ( ) const

Definition at line 390 of file ToolBar.cpp.

References GetDock().

Referenced by ToolManager::Expose(), Expose(), ToolManager::IsVisible(), ToolManager::OnGrabber(), ToolFrame::OnMotion(), DeviceToolBar::RepositionCombos(), ToolManager::Reset(), Updated(), and ToolManager::WriteConfig().

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

bool ToolBar::IsPositioned ( )

inline

Definition at line 121 of file ToolBar.h.

References mPositioned.

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

121 { return mPositioned; };

ToolBar::mPositioned

bool mPositioned

Definition: ToolBar.h:228

bool ToolBar::IsResizable ( ) const

Definition at line 382 of file ToolBar.cpp.

References mResizable.

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

 {
    return mResizable;
 }

bool ToolBar::IsVisible ( ) const

Definition at line 398 of file ToolBar.cpp.

References mVisible.

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

 {
    return mVisible;
 }

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 798 of file ToolBar.cpp.

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

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

 {
    // 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);
 }

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	Foregrounde 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 765 of file ToolBar.cpp.

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

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

 {
    // 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;
 }

void ToolBar::MakeButtonBackgroundsLarge ( )

protected

Definition at line 701 of file ToolBar.cpp.

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

Referenced by ControlToolBar::Populate().

 {
 
    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 );
    }
 }

void ToolBar::MakeButtonBackgroundsSmall ( )

protected

Definition at line 727 of file ToolBar.cpp.

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

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

 {
 
    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 );
    }
 }

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

protected

Definition at line 690 of file ToolBar.cpp.

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

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

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

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

protected

Definition at line 695 of file ToolBar.cpp.

References MakeMacRecoloredImage().

Referenced by MakeButtonBackgroundsLarge(), and MakeButtonBackgroundsSmall().

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

void ToolBar::OnErase ( wxEraseEvent & event )

protected

Definition at line 853 of file ToolBar.cpp.

 {
    // Ignore it to prevent flashing
 }

void ToolBar::OnMouseEvents ( wxMouseEvent & event )

protected

Definition at line 882 of file ToolBar.cpp.

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

void ToolBar::OnPaint ( wxPaintEvent & event )

protected

Definition at line 861 of file ToolBar.cpp.

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

 {
    //wxPaintDC dc( (wxWindow *) event.GetEventObject() );
    wxPaintDC dc( this );
    // Start with a clean background
    //
    // Under GTK, we specifically set the toolbar background to the background
    // colour in the system theme.
 #if defined( __WXGTK__ )
    //dc.SetBackground( wxBrush( wxSystemSettings::GetColour( wxSYS_COLOUR_BACKGROUND ) ) );
 #endif
 
    // Themed background colour.
    dc.SetBackground( wxBrush( theTheme.Colour( clrMedium  ) ) );
    dc.Clear();
 
 #ifdef USE_AQUA_THEME
    Repaint( &dc );
 #endif
 }

virtual void ToolBar::Populate ( )

protectedpure virtual

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

Referenced by ReCreateButtons().

void ToolBar::ReCreateButtons ( )

virtual

Reimplemented in ControlToolBar, and MeterToolBar.

Definition at line 459 of file ToolBar.cpp.

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

Referenced by Theme::ApplyUpdatedImages(), Create(), SpectralSelectionBar::OnUpdate(), SelectionBar::OnUpdate(), MeterToolBar::ReCreateButtons(), ControlToolBar::ReCreateButtons(), and ToolManager::Reset().

 {
    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;
 
    {
       // 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);
       // Initial size at least as big as minimum.
       if( sz3.y < sz2.y )
          sz3.y = sz2.y;
       if( sz3.x < sz2.x )
          sz3.x = GetInitialWidth();
       //sz.SetWidth();
       SetSize(sz3);
    }
    else
    {
       SetInitialSize(sz);
    }
    Layout();
 }

virtual void ToolBar::RegenerateTooltips ( )

pure virtual

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

Referenced by ToolManager::RegenerateTooltips().

virtual void ToolBar::Repaint ( wxDC * dc )

protectedpure virtual

Implemented in ControlToolBar.

Referenced by OnPaint().

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

protected

Definition at line 838 of file ToolBar.cpp.

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

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

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

static

Definition at line 823 of file ToolBar.cpp.

References GetActiveProject().

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

 {
    wxString result;
    const auto project = GetActiveProject();
    const auto commandManager =
       project ? project->GetCommandManager() : nullptr;
    if (commandManager)
       result =
          commandManager->DescribeCommandsAndShortcuts(commands, nCommands);
    button.SetToolTip(result);
 }

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

Definition at line 568 of file ToolBar.cpp.

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

Referenced by ToolDock::Dock(), ToolManager::HandleEscapeKey(), ToolManager::OnMouse(), ReCreateButtons(), ToolManager::Reset(), and ToolManager::UndockBar().

 {
    // 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();
       Fit();
    }
 }

void ToolBar::SetLabel ( const wxString & label )

override

Definition at line 374 of file ToolBar.cpp.

References label, and mLabel.

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

 {
    mLabel = label;
 }

void ToolBar::SetPositioned ( )

inline

Definition at line 123 of file ToolBar.h.

References mPositioned.

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

123 { mPositioned = true;};

ToolBar::mPositioned

bool mPositioned

Definition: ToolBar.h:228

void ToolBar::SetVisible ( bool bVisible )

Definition at line 403 of file ToolBar.cpp.

References mVisible.

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

 {
    mVisible = bVisible;
 }

void ToolBar::Updated ( )

protected

Definition at line 592 of file ToolBar.cpp.

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

Referenced by SpectralSelectionBar::OnChoice(), SpectralSelectionBar::OnUpdate(), SelectionBar::OnUpdate(), ToolBarResizer::ResizeBar(), SelectionBar::SelectionModeUpdated(), MixerToolBar::UpdatePrefs(), and ControlToolBar::UpdatePrefs().

 {
    if( IsDocked() )
       GetDock()->Updated();
    //wxCommandEvent e( EVT_TOOLBAR_UPDATED, GetId() );
    //GetParent()->GetEventHandler()->AddPendingEvent( e );
 }

void ToolBar::UpdatePrefs ( )

virtual

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

Definition at line 535 of file ToolBar.cpp.

References _(), GetTitle(), mGrabber, and mResizer.

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

 {
 #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;
 }

Friends And Related Function Documentation

friend class ToolBarResizer

friend

Definition at line 235 of file ToolBar.h.

Referenced by ReCreateButtons().

Member Data Documentation

Grabber* ToolBar::mGrabber

private

Definition at line 221 of file ToolBar.h.

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

wxBoxSizer* ToolBar::mHSizer

private

Definition at line 224 of file ToolBar.h.

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

wxString ToolBar::mLabel

protected

Definition at line 213 of file ToolBar.h.

Referenced by GetLabel(), and SetLabel().

wxWindow* ToolBar::mParent

private

Definition at line 219 of file ToolBar.h.

Referenced by Create().

bool ToolBar::mPositioned

private

Definition at line 228 of file ToolBar.h.

Referenced by IsPositioned(), and SetPositioned().

bool ToolBar::mResizable

private

Definition at line 227 of file ToolBar.h.

Referenced by IsResizable().

ToolBarResizer* ToolBar::mResizer

private

Definition at line 222 of file ToolBar.h.

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

wxString ToolBar::mSection

protected

Definition at line 214 of file ToolBar.h.

Referenced by GetSection().

int ToolBar::mType

protected

Definition at line 215 of file ToolBar.h.

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

bool ToolBar::mVisible

private

Definition at line 226 of file ToolBar.h.

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

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

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation