Audacity  2.2.0
ToolDock Class Referencefinal

A dynamic panel where a ToolBar can be docked. More...

#include <ToolDock.h>

Inheritance diagram for ToolDock:
wxTabTraversalWrapper< Base >

Classes

class  LayoutVisitor
 

Public Member Functions

 ToolDock (ToolManager *manager, wxWindow *parent, int dockid)
 Methods for ToolDock. More...
 
 ~ToolDock ()
 
bool AcceptsFocus () const override
 
void LoadConfig ()
 
void LayoutToolBars ()
 
void Expose (int type, bool show)
 
int GetOrder (ToolBar *bar)
 
void Dock (ToolBar *bar, bool deflate, ToolBarConfiguration::Position ndx=ToolBarConfiguration::UnspecifiedPosition)
 
void Undock (ToolBar *bar)
 
ToolBarConfiguration::Position PositionBar (ToolBar *t, const wxPoint &pos, wxRect &rect)
 
ToolBarConfigurationGetConfiguration ()
 
void WrapConfiguration (ToolBarConfiguration &backup)
 
void RestoreConfiguration (ToolBarConfiguration &backup)
 
void Updated ()
 
- Public Member Functions inherited from wxTabTraversalWrapper< Base >
template<typename... Args>
 wxTabTraversalWrapper (Args &&...args)
 
 ~wxTabTraversalWrapper ()
 

Protected Member Functions

void OnErase (wxEraseEvent &event)
 
void OnSize (wxSizeEvent &event)
 
void OnPaint (wxPaintEvent &event)
 
void OnGrabber (GrabberEvent &event)
 
void OnMouseEvents (wxMouseEvent &event)
 

Private Member Functions

void VisitLayout (LayoutVisitor &visitor, ToolBarConfiguration *pWrappedConfiguration=nullptr)
 

Private Attributes

int mTotalToolBarHeight
 
wxWindow * mParent
 
ToolManagermManager
 
ToolBarConfiguration mConfiguration
 
ToolBarConfiguration mWrappedConfiguration
 
ToolBarmBars [ToolBarCount]
 

Detailed Description

A dynamic panel where a ToolBar can be docked.

Constructor & Destructor Documentation

ToolDock::ToolDock ( ToolManager manager,
wxWindow *  parent,
int  dockid 
)

Methods for ToolDock.

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

ToolDock::~ToolDock ( )

Member Function Documentation

bool ToolDock::AcceptsFocus ( ) const
inlineoverride
int ToolDock::GetOrder ( ToolBar bar)
void ToolDock::LayoutToolBars ( )
void ToolDock::LoadConfig ( )

References Dock(), Expose(), and GetConfiguration().

Referenced by ToolManager::ReadConfig().

void ToolDock::OnErase ( wxEraseEvent &  event)
protected
void ToolDock::OnGrabber ( GrabberEvent event)
protected
void ToolDock::OnMouseEvents ( wxMouseEvent &  event)
protected
void ToolDock::OnPaint ( wxPaintEvent &  event)
protected
void ToolDock::OnSize ( wxSizeEvent &  event)
protected
ToolBarConfiguration::Position ToolDock::PositionBar ( ToolBar t,
const wxPoint &  pos,
wxRect &  rect 
)
void ToolDock::Updated ( )

Referenced by Dock(), Expose(), and ToolBar::Updated().

Member Data Documentation

ToolBar* ToolDock::mBars[ToolBarCount]
private

Referenced by Dock(), Expose(), Undock(), and VisitLayout().

ToolManager* ToolDock::mManager
private

Referenced by OnGrabber().

wxWindow* ToolDock::mParent
private
int ToolDock::mTotalToolBarHeight
private
ToolBarConfiguration ToolDock::mWrappedConfiguration
private

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