wxToolBar

Implements methods from the following classes

• wxControl

Methods

• wxToolBar
  Default constructor.
• AddCheckTool
  Adds a new check (or toggle) tool to the toolbar.
• AddControl
  Adds any control to the toolbar, typically e.g. a wxComboBox.
• AddRadioTool
  Adds a new radio tool to the toolbar.
• AddSeparator
  Adds a separator for spacing groups of tools.
• AddStretchableSpace
  Adds a stretchable space to the toolbar.
• AddTool
  Adds a tool to the toolbar.
• ClearTools
  Deletes all the tools in the toolbar.
• DeleteTool
  Removes the specified tool from the toolbar and deletes it.
• DeleteToolByPos
  This function behaves like DeleteTool() but it deletes the tool at the specified position and not the one with the given id.
• EnableTool
  Enables or disables the tool.
• FindById
  Returns a pointer to the tool identified by id or NULL if no corresponding tool is found.
• FindControl
  Returns a pointer to the control identified by id or NULL if no corresponding control is found.
• FindToolForPosition
  Finds a tool for the given mouse position.
• GetMargins
  Returns the left/right and top/bottom margins, which are also used for inter-toolspacing.
• GetToolBitmapSize
  Returns the size of bitmap that the toolbar expects to have.
• GetToolByPos
  Returns a pointer to the tool at ordinal position pos.
• GetToolClientData
  Get any client data associated with the tool.
• GetToolEnabled
  Called to determine whether a tool is enabled (responds to user input).
• GetToolLongHelp
  Returns the long help for the given tool.
• GetToolPacking
  Returns the value used for packing tools.
• GetToolPos
  Returns the tool position in the toolbar, or wxNOT_FOUND if the tool is not found.
• GetToolSeparation
  Returns the default separator size.
• GetToolShortHelp
  Returns the short help for the given tool.
• GetToolSize
  Returns the size of a whole button, which is usually larger than a tool bitmap because of added 3D effects.
• GetToolState
  Gets the on/off state of a toggle tool.
• GetToolsCount
  Returns the number of tools in the toolbar.
• InsertControl
  Inserts the control into the toolbar at the given position.
• InsertSeparator
  Inserts the separator into the toolbar at the given position.
• InsertStretchableSpace
  Inserts a stretchable space at the given position.
• InsertTool
  Inserts the tool with the specified attributes into the toolbar at the given position.
• OnLeftClick
  Called when the user clicks on a tool with the left mouse button.
• OnMouseEnter
  This is called when the mouse cursor moves into a tool or out of the toolbar.
• OnRightClick
• Realize
  This function should be called after you have added tools.
• RemoveTool
  Removes the given tool from the toolbar but doesn't delete it.
• SetDropdownMenu
  Sets the dropdown menu for the tool given by its id.
• SetMargins
  Set the margins for the toolbar.
• SetToolBitmapSize
  Sets the default size of each tool bitmap.
• SetToolClientData
  Sets the client data associated with the tool.
• SetToolDisabledBitmap
  Sets the bitmap to be used by the tool with the given ID when the tool is in a disabled state.
• SetToolLongHelp
  Sets the long help for the given tool.
• SetToolNormalBitmap
  Sets the bitmap to be used by the tool with the given ID.
• SetToolPacking
  Sets the value used for spacing tools.
• SetToolSeparation
  Sets the default separator size.
• SetToolShortHelp
  Sets the short help for the given tool.
• ToggleTool
  Toggles a tool on or off.

Static Methods

wxToolBar

wxToolBar ( )

Default constructor.
wxToolBar ( wxWindow &$parent, integer $id, wxPoint $pos=wxDefaultPosition, wxSize $size=wxDefaultSize, integer $style=wxTB_HORIZONTAL, string $name=wxToolBarNameStr )

Constructs a toolbar.

AddCheckTool

wxToolBarToolBase& AddCheckTool ( integer $toolId, string $label, wxBitmap $bitmap1, wxBitmap $bmpDisabled=wxNullBitmap, string $shortHelp=wxEmptyString, string $longHelp=wxEmptyString, wxObject &$clientData=NULL )

Adds a new check (or toggle) tool to the toolbar.

AddControl

wxToolBarToolBase& AddControl ( wxControl &$control, string $label=wxEmptyString )

Adds any control to the toolbar, typically e.g. a wxComboBox.

AddRadioTool

wxToolBarToolBase& AddRadioTool ( integer $toolId, string $label, wxBitmap $bitmap1, wxBitmap $bmpDisabled=wxNullBitmap, string $shortHelp=wxEmptyString, string $longHelp=wxEmptyString, wxObject &$clientData=NULL )

Adds a new radio tool to the toolbar.

AddSeparator

wxToolBarToolBase& AddSeparator ( )

Adds a separator for spacing groups of tools.

AddStretchableSpace

wxToolBarToolBase& AddStretchableSpace ( )

Adds a stretchable space to the toolbar.

AddTool

wxToolBarToolBase& AddTool ( integer $toolId, string $label, wxBitmap $bitmap, string $shortHelp=wxEmptyString, wxItemKind $kind=wxITEM_NORMAL )

Adds a tool to the toolbar.
wxToolBarToolBase& AddTool ( integer $toolId, string $label, wxBitmap $bitmap, wxBitmap $bmpDisabled, wxItemKind $kind=wxITEM_NORMAL, string $shortHelpString=wxEmptyString, string $longHelpString=wxEmptyString, wxObject &$clientData=NULL )

Adds a tool to the toolbar.

ClearTools

ClearTools ( )

Deletes all the tools in the toolbar.

DeleteTool

bool DeleteTool ( integer $toolId )

Removes the specified tool from the toolbar and deletes it.

DeleteToolByPos

bool DeleteToolByPos ( integer $pos )

This function behaves like DeleteTool() but it deletes the tool at the specified position and not the one with the given id.

EnableTool

EnableTool ( integer $toolId, bool $enable )

Enables or disables the tool.

FindById

wxToolBarToolBase& FindById ( integer $id )

Returns a pointer to the tool identified by id or NULL if no corresponding tool is found.

FindControl

wxControl& FindControl ( integer $id )

Returns a pointer to the control identified by id or NULL if no corresponding control is found.

FindToolForPosition

wxToolBarToolBase& FindToolForPosition ( integer $x, integer $y )

Finds a tool for the given mouse position.

GetMargins

wxSize GetMargins ( )

Returns the left/right and top/bottom margins, which are also used for inter-toolspacing.

GetToolBitmapSize

wxSize GetToolBitmapSize ( )

Returns the size of bitmap that the toolbar expects to have.

GetToolByPos

wxToolBarToolBase GetToolByPos ( integer $pos )

Returns a pointer to the tool at ordinal position pos.

GetToolClientData

wxObject& GetToolClientData ( integer $toolId )

Get any client data associated with the tool.

GetToolEnabled

bool GetToolEnabled ( integer $toolId )

Called to determine whether a tool is enabled (responds to user input).

GetToolLongHelp

string GetToolLongHelp ( integer $toolId )

Returns the long help for the given tool.

GetToolPacking

integer GetToolPacking ( )

Returns the value used for packing tools.

GetToolPos

integer GetToolPos ( integer $toolId )

Returns the tool position in the toolbar, or wxNOT_FOUND if the tool is not found.

GetToolSeparation

integer GetToolSeparation ( )

Returns the default separator size.

GetToolShortHelp

string GetToolShortHelp ( integer $toolId )

Returns the short help for the given tool.

GetToolSize

wxSize GetToolSize ( )

Returns the size of a whole button, which is usually larger than a tool bitmap because of added 3D effects.

GetToolState

bool GetToolState ( integer $toolId )

Gets the on/off state of a toggle tool.

GetToolsCount

integer GetToolsCount ( )

Returns the number of tools in the toolbar.

InsertControl

wxToolBarToolBase& InsertControl ( integer $pos, wxControl &$control, string $label=wxEmptyString )

Inserts the control into the toolbar at the given position.

InsertSeparator

wxToolBarToolBase& InsertSeparator ( integer $pos )

Inserts the separator into the toolbar at the given position.

InsertStretchableSpace

wxToolBarToolBase& InsertStretchableSpace ( integer $pos )

Inserts a stretchable space at the given position.

InsertTool

wxToolBarToolBase& InsertTool ( integer $pos, wxToolBarToolBase &$tool )

Inserts the tool with the specified attributes into the toolbar at the given position.
wxToolBarToolBase& InsertTool ( integer $pos, integer $toolId, string $label, wxBitmap $bitmap, wxBitmap $bmpDisabled=wxNullBitmap, wxItemKind $kind=wxITEM_NORMAL, string $shortHelp=wxEmptyString, string $longHelp=wxEmptyString, wxObject &$clientData=NULL )

Inserts the tool with the specified attributes into the toolbar at the given position.

OnLeftClick

bool OnLeftClick ( integer $toolId, bool $toggleDown )

Called when the user clicks on a tool with the left mouse button.

OnMouseEnter

OnMouseEnter ( integer $toolId )

This is called when the mouse cursor moves into a tool or out of the toolbar.

OnRightClick

OnRightClick ( integer $toolId, integer $x, integer $y )

Realize

bool Realize ( )

This function should be called after you have added tools.

RemoveTool

wxToolBarToolBase& RemoveTool ( integer $id )

Removes the given tool from the toolbar but doesn't delete it.

SetDropdownMenu

bool SetDropdownMenu ( integer $id, wxMenu &$menu )

Sets the dropdown menu for the tool given by its id.

SetMargins

SetMargins ( wxSize $size )

Set the margins for the toolbar.

SetToolBitmapSize

SetToolBitmapSize ( wxSize $size )

Sets the default size of each tool bitmap.

SetToolClientData

SetToolClientData ( integer $id, wxObject &$clientData )

Sets the client data associated with the tool.

SetToolDisabledBitmap

SetToolDisabledBitmap ( integer $id, wxBitmap $bitmap )

Sets the bitmap to be used by the tool with the given ID when the tool is in a disabled state.

SetToolLongHelp

SetToolLongHelp ( integer $toolId, string $helpString )

Sets the long help for the given tool.

SetToolNormalBitmap

SetToolNormalBitmap ( integer $id, wxBitmap $bitmap )

Sets the bitmap to be used by the tool with the given ID.

SetToolPacking

SetToolPacking ( integer $packing )

Sets the value used for spacing tools.

SetToolSeparation

SetToolSeparation ( integer $separation )

Sets the default separator size.

SetToolShortHelp

SetToolShortHelp ( integer $toolId, string $helpString )

Sets the short help for the given tool.

ToggleTool

ToggleTool ( integer $toolId, bool $toggle )

Toggles a tool on or off.