added SetStatusText method (avoiding dc.Clear)

[wxWidgets.git] / docs / latex / wx / toolbar.tex

diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex
index 7601e656275655a10c7bdc835f73f65b4b9d6d4d..d5c0824faa5281924ae111dc2c2728f9a7527fcf 100644 (file)
--- a/docs/latex/wx/toolbar.tex
+++ b/docs/latex/wx/toolbar.tex
@@ -1,71 +1,162 @@
-\section{\class{wxToolBarBase}}\label{wxtoolbarbase}
+\section{\class{wxToolBar}}\label{wxtoolbar}

 
 

-{\bf wxToolBarBase} is the base class for a number of toolbar classes.  The most portable
-one of these is the generic \helpref{wxToolBarSimple}{wxtoolbarsimple} class. {\bf wxToolBarBase} defines
-automatic scrolling management functionality which is identical to \helpref{wxScrolledWindow}{wxscrolledwindow},
-so please refer to this class also.
+The name wxToolBar is defined to be a synonym for one of the following classes:
+
+\begin{itemize}\itemsep=0pt
+\item {\bf wxToolBar95} The native Windows 95 toolbar. Used on Windows 95, NT 4 and above.
+\item {\bf wxToolBarMSW} A Windows implementation. Used on 16-bit Windows.
+\item {\bf wxToolBarGTK} The GTK toolbar.
+\item {\bf wxToolBarSimple} A simple implementation, with scrolling.
+Used on platforms with no native toolbar control, or where scrolling is required.
+\end{itemize}
+
+Note that the base class {\bf wxToolBarBase} defines
+automatic scrolling management functionality which is similar
+to \helpref{wxScrolledWindow}{wxscrolledwindow}, so please refer to this class also.
+Not all toolbars support scrolling, but wxToolBarSimple does.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 

+wxToolBarBase\\

 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxControl}{wxcontrol}\\
 \helpref{wxWindow}{wxwindow}\\
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/toolbar.h> (to allow wxWindows to select an appropriate toolbar class)\\
+<wx/tbarbase.h> (the base class)\\
+<wx/tbarmsw.h> (the non-Windows 95 Windows toolbar class)\\
+<wx/tbar95.h> (the Windows 95/98 toolbar class)\\
+<wx/tbarsmpl.h> (the generic simple toolbar class)
+

 \wxheading{Remarks}
 
 \wxheading{Remarks}
 

-Because there is a variety of toolbar classes, you may wish to choose which class
-is best for your application on each platform, and define {\bf wxToolBar} appropriately. For example:
-
-\begin{verbatim}
-#if WIN95
-class wxToolBar: public wxToolBar95
-#elif defined(wx_msw)
-class wxToolBar: public wxToolBarMSW
-#else
-class wxToolBar: public wxToolBarSimple
-#endif
-{
-};
-\end{verbatim}
-
-TODO: maybe change the confusing names: GetDefaultSize becomes GetToolBitmapSize, and
-GetDefaultButtonSize becomes GetToolSize. Document SetRows for wxToolBar95, and make it
-part of the base API?
+You may also create a toolbar that is managed by the frame, by
+calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.

 
 

-\wxheading{Event handling}
+Due to the use of native toolbars on the various platforms, certain adaptions will
+often have to be made in order to get optimal look on all platforms as some platforms
+ignore the values for explicit placement and use their own layout and the meaning
+of a "separator" is a vertical line under Windows95 vs. simple space under GTK etc.
+
+{\bf wxToolBar95:} Note that this toolbar paints tools to reflect user-selected colours.
+The toolbar orientation must always be {\bf wxHORIZONTAL}.
+
+{\bf wxToolBarGtk:} The toolbar orientation is ignored and is always {\bf wxHORIZONTAL}.
+
+\wxheading{Window styles}
+
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxTB\_FLAT}}{Gives the toolbar a flat look ('coolbar' or 'flatbar' style). Windows 95 and GTK 1.2 only.}
+\twocolitem{\windowstyle{wxTB\_DOCKABLE}}{Makes the toolbar floatable and dockable. GTK only.}
+\twocolitem{\windowstyle{wxTB\_HORIZONTAL}}{Specifies horizontal layout.}
+\twocolitem{\windowstyle{wxTB\_VERTICAL}}{Specifies vertical layout (not available for the GTK and Windows 95
+toolbar).}
+\twocolitem{\windowstyle{wxTB\_3DBUTTONS}}{Gives wxToolBarSimple a mild 3D look to its buttons.}
+\end{twocollist}
+
+See also \helpref{window styles overview}{windowstyles}.

 
 

-Derive a new class from an existing toolbar class, and override appropriate virtual functions.
+\wxheading{Event handling}

 
 

-TODO: make consistent with other event handling; have wxToolBarEvent and appropriate macros.
+The toolbar class emits menu commands in the same was that a frame menubar does,
+so you can use one EVT\_MENU macro for both a menu item and a toolbar button.
+The event handler functions take a wxCommandEvent argument. For most event macros,
+the identifier of the tool is passed, but for EVT\_TOOL\_ENTER the toolbar
+window is passed and the tool id is retrieved from the wxCommandEvent.
+This is because the id may be -1 when the mouse moves off a tool, and -1 is not
+allowed as an identifier in the event system.
+
+Note that tool commands (and UI update events for tools) are first sent to
+the focus window within the frame that contains the toolbar. If no window within the frame has the focus,
+then the events are sent directly to the toolbar (and up the hierarchy to the
+frame, depending on where the application has put its event handlers). This allows command and UI update
+handling to be processed by specific windows and controls, and not necessarily
+by the application frame.
+
+\twocolwidtha{7cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf EVT\_TOOL(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
+(a synonym for wxEVT\_COMMAND\_MENU\_SELECTED). Pass the id of the tool.}
+\twocolitem{{\bf EVT\_MENU(id, func)}}{The same as EVT\_TOOL.}
+\twocolitem{{\bf EVT\_TOOL\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
+for a range id identifiers. Pass the ids of the tools.}
+\twocolitem{{\bf EVT\_MENU\_RANGE(id1, id2, func)}}{The same as EVT\_TOOL\_RANGE.}
+
+\twocolitem{{\bf EVT\_TOOL\_RCLICKED(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event.
+Pass the id of the tool.}
+\twocolitem{{\bf EVT\_TOOL\_RCLICKED\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event
+for a range of ids. Pass the ids of the tools.}
+\twocolitem{{\bf EVT\_TOOL\_ENTER(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_ENTER event.
+Pass the id of the toolbar itself. The value of wxCommandEvent::GetSelection is the tool id, or -1 if the mouse cursor has moved off a tool.}
+\end{twocollist}

 
 \wxheading{See also}
 
 \overview{Toolbar overview}{wxtoolbaroverview},\rtfsp
 
 \wxheading{See also}
 
 \overview{Toolbar overview}{wxtoolbaroverview},\rtfsp

-\helpref{wxToolBarSimple}{wxtoolbarsimple},\rtfsp
-\helpref{wxToolBarMSW}{wxtoolbarmsw},\rtfsp
-\helpref{wxToolBar95}{wxtoolbar95},\rtfsp

 \helpref{wxScrolledWindow}{wxscrolledwindow}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 \helpref{wxScrolledWindow}{wxscrolledwindow}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

-\membersection{wxToolBarBase::wxToolBarBase}\label{wxtoolbarbaseconstr}
+\membersection{wxToolBar::wxToolBar}\label{wxtoolbarconstr}

 
 

-\func{}{wxToolBarBase}{\void}
+\func{}{wxToolBar}{\void}

 
 Default constructor.
 
 
 Default constructor.
 

-%\wxheading{See also}
-%
-%\helpref{wxToolBarBase::Create}{wxtoolbarbasecreate}
-%
-\membersection{wxToolBarBase::\destruct{wxToolBarBase}}
+\func{}{wxToolBar}{\param{wxWindow*}{ parent}, \param{wxWindowID }{id},
+ \param{const wxPoint\& }{pos = wxDefaultPosition},
+ \param{const wxSize\& }{size = wxDefaultSize},
+ \param{long }{style = wxTB\_HORIZONTAL \pipe wxNO\_BORDER},
+ \param{const wxString\& }{name = wxPanelNameStr}}
+
+Constructs a toolbar.
+
+\wxheading{Parameters}
+
+\docparam{parent}{Pointer to a parent window.}
+
+\docparam{id}{Window identifier. If -1, will automatically create an identifier.}
+
+\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWindows
+should generate a default position for the window. If using the wxWindow class directly, supply
+an actual position.}
+
+\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWindows
+should generate a default size for the window.}
+
+\docparam{style}{Window style. See \helpref{wxToolBar}{wxtoolbar} for details.}
+
+\docparam{name}{Window name.}
+
+\wxheading{Remarks}
+
+After a toolbar is created, you use \helpref{wxToolBar::AddTool}{wxtoolbaraddtool} and
+perhaps \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}, and then you
+must call \helpref{wxToolBar::Realize}{wxtoolbarrealize} to construct and display the toolbar
+tools.
+
+You may also create a toolbar that is managed by the frame, by
+calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
+
+\membersection{wxToolBar::\destruct{wxToolBar}}

 
 

-\func{void}{\destruct{wxToolBarBase}}{\void}
+\func{void}{\destruct{wxToolBar}}{\void}

 
 Toolbar destructor.
 
 
 Toolbar destructor.
 

-\membersection{wxToolBarBase::AddSeparator}\label{wxtoolbarbaseaddseparator}
+\membersection{wxToolBar::AddControl}\label{wxtoolbaraddcontrol}
+
+\func{bool}{AddControl}{\param{wxControl*}{ control}}
+
+Adds any control to the toolbar, typically e.g. a combobox.
+
+\docparam{control}{The control to be added.}
+
+\membersection{wxToolBar::AddSeparator}\label{wxtoolbaraddseparator}

 
 \func{void}{AddSeparator}{\void}
 
 
 \func{void}{AddSeparator}{\void}
 


@@ -73,20 +164,24 @@ Adds a separator for spacing groups of tools.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::AddTool}{wxtoolbarbaseaddtool}, \helpref{wxToolBarBase::SetToolSeparation}{wxtoolbarbasesettoolseparation}
+\helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}

 
 

-\membersection{wxToolBarBase::AddTool}\label{wxtoolbarbaseaddtool}
+\membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}

 
 

-\func{wxToolBarBaseTool*}{AddTool}{\param{const int}{ toolIndex}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
-\param{const wxBitmap\&}{ bitmap2 = (wxBitmap *)NULL}, \param{const bool}{ isToggle = FALSE},\rtfsp
-\param{const float}{ xPos = -1}, \param{const float}{ yPos = -1},\rtfsp
-\param{wxObject *}{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
+\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
+\param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}

 
 

-Adds a tool to the toolbar.
+\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
+\param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = FALSE},\rtfsp
+\param{long}{ xPos = -1}, \param{long}{ yPos = -1},\rtfsp
+\param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
+
+Adds a tool to the toolbar. The first (short and most commonly used) version
+adds a normal (and not a togglable) button without any associated client data.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{An integer by which
+\docparam{toolId}{An integer by which

 the tool may be identified in subsequent operations.}
 
 \docparam{isToggle}{Specifies whether the tool is a toggle or not: a toggle tool may be in
 the tool may be identified in subsequent operations.}
 
 \docparam{isToggle}{Specifies whether the tool is a toggle or not: a toggle tool may be in


@@ -95,87 +190,87 @@ two states, whereas a non-toggle tool is just a button.}
 \docparam{bitmap1}{The primary tool bitmap for toggle and button tools.}
 
 \docparam{bitmap2}{The second bitmap specifies the on-state bitmap for a toggle
 \docparam{bitmap1}{The primary tool bitmap for toggle and button tools.}
 
 \docparam{bitmap2}{The second bitmap specifies the on-state bitmap for a toggle

-tool. If this is NULL, either an inverted version of the primary bitmap is
+tool. If this is wxNullBitmap, either an inverted version of the primary bitmap is

 used for the on-state of a toggle tool (monochrome displays) or a black
 used for the on-state of a toggle tool (monochrome displays) or a black

-border is drawn around the tool (colour displays). Note that to pass a NULL value,
-you need to cast it to (wxBitmap *) so that C++ can construct an appropriate temporary
-wxBitmap object.}
+border is drawn around the tool (colour displays) or the pixmap is shown
+as a pressed button (GTK). }

 
 \docparam{xPos}{Specifies the x position of the tool if automatic layout is not suitable.}
 
 \docparam{yPos}{Specifies the y position of the tool if automatic layout is not suitable.}
 
 \docparam{clientData}{An optional pointer to client data which can be
 
 \docparam{xPos}{Specifies the x position of the tool if automatic layout is not suitable.}
 
 \docparam{yPos}{Specifies the y position of the tool if automatic layout is not suitable.}
 
 \docparam{clientData}{An optional pointer to client data which can be

-retrieved later using \helpref{wxToolBarBase::GetToolClientData}{wxtoolbarbasegettoolclientdata}.}
-
-\docparam{shortHelpString}{Used for displaying a tooltip for the tool in the
-Windows 95 implementation of wxButtonBar. Pass the empty string if this is not required.}
-
-\docparam{longHelpString}{Used to displayer longer help, such as status line help.
-Pass the empty string if this is not required.}
-
-\wxheading{See also}
-
-\helpref{wxToolBarBase::AddSeparator}{wxtoolbarbaseaddseparator}
-
-\membersection{wxToolBarBase::CreateTools}\label{wxtoolbarbasecreatetools}
+retrieved later using \helpref{wxToolBar::GetToolClientData}{wxtoolbargettoolclientdata}.}

 
 

-\func{bool}{CreateTools}{\void}
+\docparam{shortHelpString}{This string is used for the tools tooltip}

 
 

-Call this function after all tools have been added to the toolbar, to actually
-create the tools.
+\docparam{longHelpString}{This string is shown in the statusbar (if any) of the
+parent frame when the mouse pointer is inside the tool}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Strictly speaking, this is required only for the Windows 95 version of wxButtonBar,
-but for portability it should be called anyway.
+After you have added tools to a toolbar, you must call \helpref{wxToolBar::Realize}{wxtoolbarrealize} in
+order to have the tools appear.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::AddTool}{wxtoolbarbaseaddtool}
+\helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator},
+\helpref{wxToolBar::InsertTool}{wxtoolbarinserttool},
+\helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool},
+\helpref{wxToolBar::Realize}{wxtoolbarrealize},

 
 

-\membersection{wxToolBarBase::DrawTool}\label{wxtoolbarbasedrawtool}
+\membersection{wxToolBar::DeleteTool}\label{wxtoolbardeletetool}

 
 

-\func{void}{DrawTool}{\param{wxMemoryDC\& }{memDC}, \param{wxToolBarBaseTool* }{tool}}
+\func{bool}{DeleteTool}{\param{int }{toolId}}

 
 

-Draws the specified tool onto the canvas using the given memory device context.
+Removes the specified tool from the toolbar and deletes it. If you don't want
+to delete the tool, but just to remove it from the toolbar (to possibly add it
+back later), you may use \helpref{RemoveTool}{wxtoolbarremovetool} instead.

 
 

-\wxheading{Parameters}
+Note that it is unnecessary to call \helpref{Realize}{wxtoolbarrealize} for the
+change to take place, it will happen immediately.
+
+Returns TRUE if the tool was deleted, FALSE otherwise.

 
 

-\docparam{memDC}{A memory DC to be used for drawing the tool.}
+\wxheading{See also}

 
 

-\docparam{tool}{Tool to be drawn.}
+\helpref{DeleteToolByPos}{wxtoolbardeletetoolbypos}

 
 

-\wxheading{Remarks}
+\membersection{wxToolBar::DeleteToolByPos}\label{wxtoolbardeletetoolbypos}

 
 

-For internal use only.
+\func{bool}{DeleteToolByPos}{\param{size\_t }{pos}}

 
 

-\membersection{wxToolBarBase::EnableTool}\label{wxtoolbarbaseenabletool}
+This function behaves like \helpref{DeleteTool}{wxtoolbardeletetool} but it
+deletes the tool at the specified position and not the one with the given id.

 
 

-\func{void}{EnableTool}{\param{const int }{toolIndex}, \param{const bool}{ enable}}
+\membersection{wxToolBar::EnableTool}\label{wxtoolbarenabletool}
+
+\func{void}{EnableTool}{\param{int }{toolId}, \param{const bool}{ enable}}

 
 Enables or disables the tool.
 
 \wxheading{Parameters}
 
 
 Enables or disables the tool.
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{Tool to enable or disable.}
+\docparam{toolId}{Tool to enable or disable.}

 
 \docparam{enable}{If TRUE, enables the tool, otherwise disables it.}
 
 
 \docparam{enable}{If TRUE, enables the tool, otherwise disables it.}
 

+{\bf NB:} This function should only be called after 
+\helpref{Realize}{wxtoolbarrealize}.
+

 \wxheading{Remarks}
 
 \wxheading{Remarks}
 

-For \helpref{wxToolBarSimple}{wxtoolbarsimple}, does nothing. Some other implementations
+For wxToolBarSimple, does nothing. Some other implementations

 will change the visible state of the tool to indicate that it is disabled.
 
 \wxheading{See also}
 
 will change the visible state of the tool to indicate that it is disabled.
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::GetToolEnabled}{wxtoolbarbasegettoolenabled},\rtfsp
-%\helpref{wxToolBarBase::SetToolState}{wxtoolbarbasesettoolstate},\rtfsp
-\helpref{wxToolBarBase::ToggleTool}{wxtoolbarbasetoggletool}
+\helpref{wxToolBar::GetToolEnabled}{wxtoolbargettoolenabled},\rtfsp
+\helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}

 
 

-\membersection{wxToolBarBase::FindToolForPosition}\label{wxtoolbarbasefindtoolforposition}
+\membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}

 
 

-\constfunc{wxToolBarBaseTool*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}
+\constfunc{wxToolBarTool*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}

 
 Finds a tool for the given mouse position.
 
 
 Finds a tool for the given mouse position.
 


@@ -193,35 +288,35 @@ A pointer to a tool if a tool is found, or NULL otherwise.
 
 Used internally, and should not need to be used by the programmer.
 
 
 Used internally, and should not need to be used by the programmer.
 

-\membersection{wxToolBarBase::GetDefaultButtonSize}\label{wxtoolbarbasegetdefaultbuttonsize}
+\membersection{wxToolBar::GetToolSize}\label{wxtoolbargettoolsize}

 
 

-\func{wxSize}{GetDefaultButtonSize}{\void}
+\func{wxSize}{GetToolSize}{\void}

 
 Returns the size of a whole button, which is usually larger than a tool bitmap because
 of added 3D effects.
 
 \wxheading{See also}
 
 
 Returns the size of a whole button, which is usually larger than a tool bitmap because
 of added 3D effects.
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::SetDefaultSize}{wxtoolbarbasesetdefaultsize},\rtfsp
-\helpref{wxToolBarBase::GetDefaultSize}{wxtoolbarbasegetdefaultsize}
+\helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
+\helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize}

 
 

-\membersection{wxToolBarBase::GetDefaultSize}\label{wxtoolbarbasegetdefaultsize}
+\membersection{wxToolBar::GetToolBitmapSize}\label{wxtoolbargettoolbitmapsize}

 
 

-\func{wxSize}{GetDefaultSize}{\void}
+\func{wxSize}{GetToolBitmapSize}{\void}

 
 Returns the size of bitmap that the toolbar expects to have. The default bitmap size is 16 by 15 pixels.
 
 \wxheading{Remarks}
 
 
 Returns the size of bitmap that the toolbar expects to have. The default bitmap size is 16 by 15 pixels.
 
 \wxheading{Remarks}
 

-Note that this is the size of the bitmap you pass to \helpref{wxToolBarBase::AddTool}{wxtoolbarbaseaddtool},
+Note that this is the size of the bitmap you pass to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool},

 and not the eventual size of the tool button.
 
 \wxheading{See also}
 
 and not the eventual size of the tool button.
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::SetDefaultSize}{wxtoolbarbasesetdefaultsize},\rtfsp
-\helpref{wxToolBarBase::GetDefaultButtonSize}{wxtoolbarbasegetdefaultbuttonsize}
+\helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
+\helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}

 
 

-\membersection{wxToolBarBase::GetMargins}\label{wxtoolbarbasegetmargins}
+\membersection{wxToolBar::GetMargins}\label{wxtoolbargetmargins}

 
 \constfunc{wxSize}{GetMargins}{\void}
 
 
 \constfunc{wxSize}{GetMargins}{\void}
 


@@ -229,69 +324,56 @@ Returns the left/right and top/bottom margins, which are also used for inter-too
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::SetMargins}{wxtoolbarbasesetmargins}
+\helpref{wxToolBar::SetMargins}{wxtoolbarsetmargins}

 
 

-\membersection{wxToolBarBase::GetMaxSize}\label{wxtoolbarbasegetmaxsize}
+\membersection{wxToolBar::GetToolClientData}\label{wxtoolbargettoolclientdata}

 
 

-\constfunc{void}{GetMaxSize}{\param{float*}{ w}, \param{float*}{ h}}
-
-Gets the maximum size taken up by the tools after layout, including margins.
-This can be used to size a frame around the toolbar canvas.
-
-\wxheading{Parameters}
-
-\docparam{w}{Receives the maximum horizontal size.}
-
-\docparam{h}{Receives the maximum vertical size.}
-
-\membersection{wxToolBarBase::GetToolClientData}\label{wxtoolbarbasegettoolclientdata}
-
-\constfunc{wxObject*}{GetToolClientData}{\param{const int }{toolIndex}}
+\constfunc{wxObject*}{GetToolClientData}{\param{int }{toolId}}

 
 Get any client data associated with the tool.
 
 \wxheading{Parameters}
 
 
 Get any client data associated with the tool.
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{Index of the tool, as passed to \helpref{wxToolBarBase::AddTool}{wxtoolbarbaseaddtool}.}
+\docparam{toolId}{Id of the tool, as passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}

 
 \wxheading{Return value}
 
 Client data, or NULL if there is none.
 
 
 \wxheading{Return value}
 
 Client data, or NULL if there is none.
 

-\membersection{wxToolBarBase::GetToolEnabled}\label{wxtoolbarbasegettoolenabled}
+\membersection{wxToolBar::GetToolEnabled}\label{wxtoolbargettoolenabled}

 
 

-\constfunc{bool}{GetToolEnabled}{\param{const int }{toolIndex}}
+\constfunc{bool}{GetToolEnabled}{\param{int }{toolId}}

 
 Called to determine whether a tool is enabled (responds to user input).
 
 \wxheading{Parameters}
 
 
 Called to determine whether a tool is enabled (responds to user input).
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{Index of the tool in question.}
+\docparam{toolId}{Id of the tool in question.}

 
 \wxheading{Return value}
 
 TRUE if the tool is enabled, FALSE otherwise.
 
 
 \wxheading{Return value}
 
 TRUE if the tool is enabled, FALSE otherwise.
 

-%\wxheading{See also}
-%
-%\helpref{wxToolBarBase::SetToolEnabled}{wxtoolbarbasesettoolenabled}
-%
-\membersection{wxToolBarBase::GetToolLongHelp}\label{wxtoolbarbasegettoollonghelp}
+\wxheading{See also}
+
+\helpref{wxToolBar::EnableTool}{wxtoolbarenabletool}

 
 

-\constfunc{wxString}{GetToolLongHelp}{\param{const int }{toolIndex}}
+\membersection{wxToolBar::GetToolLongHelp}\label{wxtoolbargettoollonghelp}
+
+\constfunc{wxString}{GetToolLongHelp}{\param{int }{toolId}}

 
 Returns the long help for the given tool.
 
 \wxheading{Parameters}
 
 
 Returns the long help for the given tool.
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{The tool in question.}
+\docparam{toolId}{The tool in question.}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::SetToolLongHelp}{wxtoolbarbasesettoollonghelp},\rtfsp
-\helpref{wxToolBarBase::SetToolShortHelp}{wxtoolbarbasesettoolshorthelp}\rtfsp
+\helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp},\rtfsp
+\helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp

 
 

-\membersection{wxToolBarBase::GetToolPacking}\label{wxtoolbarbasegettoolpacking}
+\membersection{wxToolBar::GetToolPacking}\label{wxtoolbargettoolpacking}

 
 \constfunc{int}{GetToolPacking}{\void}
 
 
 \constfunc{int}{GetToolPacking}{\void}
 


@@ -299,9 +381,9 @@ Returns the value used for packing tools.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::SetToolPacking}{wxtoolbarbasesettoolpacking}
+\helpref{wxToolBar::SetToolPacking}{wxtoolbarsettoolpacking}

 
 

-\membersection{wxToolBarBase::GetToolSeparation}\label{wxtoolbarbasegettoolseparation}
+\membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation}

 
 \constfunc{int}{GetToolSeparation}{\void}
 
 
 \constfunc{int}{GetToolSeparation}{\void}
 


@@ -309,61 +391,97 @@ Returns the default separator size.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::SetToolSeparation}{wxtoolbarbasesettoolseparation}
+\helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}

 
 

-\membersection{wxToolBarBase::GetToolShortHelp}\label{wxtoolbarbasegettoolshorthelp}
+\membersection{wxToolBar::GetToolShortHelp}\label{wxtoolbargettoolshorthelp}

 
 

-\constfunc{wxString}{GetToolShortHelp}{\param{const int }{toolIndex}}
+\constfunc{wxString}{GetToolShortHelp}{\param{int }{toolId}}

 
 Returns the short help for the given tool.
 
 
 Returns the short help for the given tool.
 

-Returns the long help for the given tool.
-

 \wxheading{Parameters}
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{The tool in question.}
+\docparam{toolId}{The tool in question.}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::GetToolLongHelp}{wxtoolbarbasegettoollonghelp},\rtfsp
-\helpref{wxToolBarBase::SetToolShortHelp}{wxtoolbarbasesettoolshorthelp}\rtfsp
+\helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
+\helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp

 
 

-\membersection{wxToolBarBase::GetToolState}\label{wxtoolbarbasegettoolstate}
+\membersection{wxToolBar::GetToolState}\label{wxtoolbargettoolstate}

 
 

-\constfunc{bool}{GetToolState}{\param{const int }{toolIndex}}
+\constfunc{bool}{GetToolState}{\param{int }{toolId}}

 
 Gets the on/off state of a toggle tool.
 
 \wxheading{Parameters}
 
 
 Gets the on/off state of a toggle tool.
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{The tool in question.}
+\docparam{toolId}{The tool in question.}

 
 \wxheading{Return value}
 
 TRUE if the tool is toggled on, FALSE otherwise.
 
 
 \wxheading{Return value}
 
 TRUE if the tool is toggled on, FALSE otherwise.
 

-%\wxheading{See also}
-%
-%\helpref{wxToolBarBase::SetToolState}{wxtoolbarbasesettoolstate}
-%
-\membersection{wxToolBarBase::Layout}\label{wxtoolbarbaselayout}
+\wxheading{See also}
+
+\helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
+
+\membersection{wxToolBar::InsertControl}\label{wxtoolbarinsertcontrol}
+
+\func{wxToolBarTool *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}
+
+Inserts the control into the toolbar at the given position.
+
+You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
+
+\wxheading{See also}
+
+\helpref{AddControl}{wxtoolbaraddcontrol},\\
+\helpref{InsertTool}{wxtoolbarinserttool}
+
+\membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator}
+
+\func{wxToolBarTool *}{InsertSeparator}{\param{size\_t }{pos}}
+
+Inserts the separator into the toolbar at the given position.

 
 

-\func{void}{Layout}{\void}
+You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.

 
 

-Called by the application after the tools have been added to
-automatically lay the tools out on the canvas. If you have given
-absolute positions when adding the tools, do not call this.
+\wxheading{See also}
+
+\helpref{AddSeparator}{wxtoolbaraddseparator},\\
+\helpref{InsertTool}{wxtoolbarinserttool}
+
+\membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
+
+\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
+\param{int}{ toolId}, \param{const wxBitmap\&}{ bitmap1},\rtfsp
+\param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = FALSE},\rtfsp
+\param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
+
+Inserts the tool with the specified attributes into the toolbar at the given
+position.
+
+You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
+
+\wxheading{See also}

 
 

-\membersection{wxToolBarBase::OnLeftClick}\label{wxtoolbarbaseonleftclick}
+\helpref{AddTool}{wxtoolbaraddtool},\\
+\helpref{InsertControl}{wxtoolbarinsertcontrol},\\
+\helpref{InsertSeparator}{wxtoolbarinsertseparator}

 
 

-\func{bool}{OnLeftClick}{\param{int}{ toolIndex}, \param{bool}{ toggleDown}}
+\membersection{wxToolBar::OnLeftClick}\label{wxtoolbaronleftclick}

 
 

-Called when the user clicks on a tool with the left mouse button. The
-programmer should override this function to detect left tool clicks.
+\func{bool}{OnLeftClick}{\param{int}{ toolId}, \param{bool}{ toggleDown}}
+
+Called when the user clicks on a tool with the left mouse button.
+
+This is the old way of detecting tool clicks; although it will still work,
+you should use the EVT\_MENU or EVT\_TOOL macro instead.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{The identifier passed to \helpref{wxToolBarBase::AddTool}{wxtoolbarbaseaddtool}.}
+\docparam{toolId}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}

 
 \docparam{toggleDown}{TRUE if the tool is a toggle and the toggle is down, otherwise is FALSE.}
 
 
 \docparam{toggleDown}{TRUE if the tool is a toggle and the toggle is down, otherwise is FALSE.}
 


@@ -375,19 +493,22 @@ specifying that toggle operations are not permitted in some circumstances.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::OnMouseEnter}{wxtoolbarbaseonmouseenter},\rtfsp
-\helpref{wxToolBarBase::OnRightClick}{wxtoolbarbaseonrightclick}
+\helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
+\helpref{wxToolBar::OnRightClick}{wxtoolbaronrightclick}

 
 

-\membersection{wxToolBarBase::OnMouseEnter}\label{wxtoolbarbaseonmouseenter}
+\membersection{wxToolBar::OnMouseEnter}\label{wxtoolbaronmouseenter}

 
 

-\func{void}{OnMouseEnter}{\param{int}{ toolIndex}}
+\func{void}{OnMouseEnter}{\param{int}{ toolId}}

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

+This is the old way of detecting mouse enter events; although it will still work,
+you should use the EVT\_TOOL\_ENTER macro instead.
+

 \wxheading{Parameters}
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{Greater than -1 if the mouse cursor has moved into the tool,
+\docparam{toolId}{Greater than -1 if the mouse cursor has moved into the tool,

 or -1 if the mouse cursor has moved. The
 programmer can override this to provide extra information about the tool,
 such as a short description on the status line.}
 or -1 if the mouse cursor has moved. The
 programmer can override this to provide extra information about the tool,
 such as a short description on the status line.}


@@ -397,16 +518,19 @@ such as a short description on the status line.}
 With some derived toolbar classes, if the mouse moves quickly out of the toolbar, wxWindows may not be able to
 detect it. Therefore this function may not always be called when expected.
 
 With some derived toolbar classes, if the mouse moves quickly out of the toolbar, wxWindows may not be able to
 detect it. Therefore this function may not always be called when expected.
 

-\membersection{wxToolBarBase::OnRightClick}\label{wxtoolbarbaseonrightclick}
+\membersection{wxToolBar::OnRightClick}\label{wxtoolbaronrightclick}

 
 

-\func{void}{OnRightClick}{\param{int}{ toolIndex}, \param{float}{ x}, \param{float}{ y}}
+\func{void}{OnRightClick}{\param{int}{ toolId}, \param{float}{ x}, \param{float}{ y}}

 
 Called when the user clicks on a tool with the right mouse button. The
 programmer should override this function to detect right tool clicks.
 
 
 Called when the user clicks on a tool with the right mouse button. The
 programmer should override this function to detect right tool clicks.
 

+This is the old way of detecting tool right clicks; although it will still work,
+you should use the EVT\_TOOL\_RCLICKED macro instead.
+

 \wxheading{Parameters}
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{The identifier passed to \helpref{wxToolBarBase::AddTool}{wxtoolbarbaseaddtool}.}
+\docparam{toolId}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.}

 
 \docparam{x}{The x position of the mouse cursor.}
 
 
 \docparam{x}{The x position of the mouse cursor.}
 


@@ -418,37 +542,37 @@ A typical use of this member might be to pop up a menu.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::OnMouseEnter}{wxtoolbarbaseonmouseenter},\rtfsp
-\helpref{wxToolBarBase::OnLeftClick}{wxtoolbarbaseonleftclick}
+\helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
+\helpref{wxToolBar::OnLeftClick}{wxtoolbaronleftclick}

 
 

-\membersection{wxToolBarBase::SetDefaultSize}\label{wxtoolbarbasesetdefaultsize}
+\membersection{wxToolBar::Realize}\label{wxtoolbarrealize}

 
 

-\func{void}{SetDefaultSize}{\param{const wxSize\&}{ size}}
+\func{bool}{Realize}{\void}

 
 

-Sets the default size of each tool bitmap. The default bitmap size is 16 by 15 pixels.
+This function should be called after you have added tools.

 
 

-\wxheading{Parameters}
+If you are using absolute positions for your tools when using a wxToolBarSimple object,
+do not call this function. You must call it at all other times.

 
 

-\docparam{size}{The size of the bitmaps in the toolbar.}
+\membersection{wxToolBar::RemoveTool}\label{wxtoolbarremovetool}

 
 

-\wxheading{Remarks}
+\func{wxToolBarTool *}{RemoveTool}{\param{int }{id}}

 
 

-This should be called to tell the toolbar what the tool bitmap size is. Call
-it before you add tools.
+Removes the given tool from the toolbar but doesn't delete it. This allows to
+insert/add this tool back to this (or another) toolbar later.

 
 

-Note that this is the size of the bitmap you pass to \helpref{wxToolBarBase::AddTool}{wxtoolbarbaseaddtool},
-and not the eventual size of the tool button.
+Note that it is unnecessary to call \helpref{Realize}{wxtoolbarrealize} for the
+change to take place, it will happen immediately.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::GetDefaultSize}{wxtoolbarbasegetdefaultsize},\rtfsp
-\helpref{wxToolBarBase::GetDefaultButtonSize}{wxtoolbarbasegetdefaultbuttonsize}
+\helpref{DeleteTool}{wxtoolbardeletetool}

 
 

-\membersection{wxToolBarBase::SetMargins}\label{wxtoolbarbasesetmargins}
+\membersection{wxToolBar::SetMargins}\label{wxtoolbarsetmargins}

 
 \func{void}{SetMargins}{\param{const wxSize\&}{ size}}
 
 
 \func{void}{SetMargins}{\param{const wxSize\&}{ size}}
 

-\func{void}{SetMargins}{\param{const int}{ x}, \param{const int}{ y}}
+\func{void}{SetMargins}{\param{int}{ x}, \param{int}{ y}}

 
 Set the values to be used as margins for the toolbar.
 
 
 Set the values to be used as margins for the toolbar.
 


@@ -467,304 +591,129 @@ default (zero-size) margins are to be overridden.
 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::GetMargins}{wxtoolbarbasegetmargins}, \helpref{wxSize}{wxsize}
+\helpref{wxToolBar::GetMargins}{wxtoolbargetmargins}, \helpref{wxSize}{wxsize}

 
 

-\membersection{wxToolBarBase::SetToolLongHelp}\label{wxtoolbarbasesettoollonghelp}
+\membersection{wxToolBar::SetToolBitmapSize}\label{wxtoolbarsettoolbitmapsize}

 
 

-\func{void}{SetToolLongHelp}{\param{int }{toolIndex}, \param{const wxString\& }{helpString}}
+\func{void}{SetToolBitmapSize}{\param{const wxSize\&}{ size}}

 
 

-Sets the long help for the given tool.
+Sets the default size of each tool bitmap. The default bitmap size is 16 by 15 pixels.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{The tool in question.}
-
-\docparam{helpString}{A string for the long help.}
+\docparam{size}{The size of the bitmaps in the toolbar.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-You might use the long help for displaying the tool purpose on the status line.
-
-\wxheading{See also}
-
-\helpref{wxToolBarBase::GetToolLongHelp}{wxtoolbarbasegettoollonghelp},\rtfsp
-\helpref{wxToolBarBase::SetToolShortHelp}{wxtoolbarbasesettoolshorthelp},\rtfsp
-
-\membersection{wxToolBarBase::SetToolPacking}\label{wxtoolbarbasesettoolpacking}
-
-\func{void}{SetToolPacking}{\param{const int}{ packing}}
-
-Sets the value used for spacing tools. The default value is 1.
+This should be called to tell the toolbar what the tool bitmap size is. Call
+it before you add tools.

 
 

-\wxheading{Parameters}
+Note that this is the size of the bitmap you pass to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool},
+and not the eventual size of the tool button.

 
 

-\docparam{packing}{The value for packing.}
+\wxheading{See also}

 
 

-\wxheading{Remarks}
+\helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize},\rtfsp
+\helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}

 
 

-The packing is used for spacing in the vertical direction if the toolbar is horizontal,
-and for spacing in the horizontal direction if the toolbar is vertical.
+\membersection{wxToolBar::SetToolClientData}\label{wxtoolbarsettoolclientdata}

 
 

-\wxheading{See also}
+\func{void}{GetToolClientData}{\param{wxObject* }{clientData}}

 
 

-\helpref{wxToolBarBase::GetToolPacking}{wxtoolbarbasegettoolpacking}
+Sets the client data associated with the tool.

 
 

-\membersection{wxToolBarBase::SetToolShortHelp}\label{wxtoolbarbasesettoolshorthelp}
+\membersection{wxToolBar::SetToolLongHelp}\label{wxtoolbarsettoollonghelp}

 
 

-\func{void}{SetToolShortHelp}{\param{const int }{toolIndex}, \param{const wxString\& }{helpString}}
+\func{void}{SetToolLongHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}

 
 

-Sets the short help for the given tool.
+Sets the long help for the given tool.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{The tool in question.}
+\docparam{toolId}{The tool in question.}

 
 

-\docparam{helpString}{The string for the short help.}
+\docparam{helpString}{A string for the long help.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-An application might use short help for identifying the tool purpose in a tooltip.
-
-\wxheading{See also}
-
-\helpref{wxToolBarBase::GetToolShortHelp}{wxtoolbarbasegettoolshorthelp}, \helpref{wxToolBarBase::SetToolLongHelp}{wxtoolbarbasesettoollonghelp}
-
-\membersection{wxToolBarBase::SetToolSeparation}\label{wxtoolbarbasesettoolseparation}
-
-\func{void}{SetToolSeparation}{\param{const int}{ separation}}
-
-Sets the default separator size. The default value is 5.
-
-\wxheading{Parameters}
-
-\docparam{separation}{The separator size.}
+You might use the long help for displaying the tool purpose on the status line.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::AddSeparator}{wxtoolbarbaseaddseparator}
+\helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
+\helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp},\rtfsp

 
 

-\membersection{wxToolBarBase::ToggleTool}\label{wxtoolbarbasetoggletool}
+\membersection{wxToolBar::SetToolPacking}\label{wxtoolbarsettoolpacking}

 
 

-\func{void}{ToggleTool}{\param{const int }{toolIndex}, \param{const bool}{ toggle}}
+\func{void}{SetToolPacking}{\param{int}{ packing}}

 
 

-Toggles a tool on or off.
+Sets the value used for spacing tools. The default value is 1.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{toolIndex}{Tool in question.}
-
-\docparam{toggle}{If TRUE, toggles the tool on, otherwise toggles it off.}
+\docparam{packing}{The value for packing.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Only applies to a tool that has been specified as a toggle tool.
+The packing is used for spacing in the vertical direction if the toolbar is horizontal,
+and for spacing in the horizontal direction if the toolbar is vertical.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\helpref{wxToolBarBase::GetToolState}{wxtoolbarbasegettoolstate}
+\helpref{wxToolBar::GetToolPacking}{wxtoolbargettoolpacking}

 
 

-\section{\class{wxToolBar95}}\label{wxtoolbar95}
+\membersection{wxToolBar::SetToolShortHelp}\label{wxtoolbarsettoolshorthelp}

 
 

-This class should be used when a 3D-effect toolbar is required under Windows 95.
-It uses the native toolbar control.
+\func{void}{SetToolShortHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}

 
 

-\wxheading{Derived from}
-
-\helpref{wxToolBarBase}{wxtoolbarbase}\\
-\helpref{wxControl}{wxcontrol}\\
-\helpref{wxWindow}{wxwindow}\\
-\helpref{wxEvtHandler}{wxevthandler}\\
-\helpref{wxObject}{wxobject}
+Sets the short help for the given tool.

 
 

-\wxheading{Window styles}
+\wxheading{Parameters}

 
 

-There are no specific styles for this class.
+\docparam{toolId}{The tool in question.}

 
 

-See also \helpref{window styles overview}{windowstyles}.
+\docparam{helpString}{The string for the short help.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Note that this toolbar paints tools to reflect user-selected colours.
-The toolbar orientation must always be {\bf wxVERTICAL}.
-
-For member functions, see the documentation for \helpref{wxToolBarBase}{wxtoolbarbase}.
+An application might use short help for identifying the tool purpose in a tooltip.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\overview{Toolbar overview}{wxtoolbaroverview},\rtfsp
-\helpref{wxToolBarBase}{wxtoolbarbase},\rtfsp
-\helpref{wxToolBarSimple}{wxtoolbarsimple},\rtfsp
-\helpref{wxToolBarMSW}{wxtoolbarmsw}
-
-\latexignore{\rtfignore{\wxheading{Members}}}
+\helpref{wxToolBar::GetToolShortHelp}{wxtoolbargettoolshorthelp}, \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp}

 
 

-\membersection{wxToolBar95::wxToolBar95}\label{wxtoolbar95constr}
+\membersection{wxToolBar::SetToolSeparation}\label{wxtoolbarsettoolseparation}

 
 

-\func{}{wxToolBar95}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp
-\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long }{style = 0}, \param{const int }{orientation = wxVERTICAL},\rtfsp
-\param{const int }{nRowsOrColumns = 1}, \param{const wxString\& }{name = ``toolBar"}}
+\func{void}{SetToolSeparation}{\param{int}{ separation}}

 
 

-Constructs a toolbar.
+Sets the default separator size. The default value is 5.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{parent}{Parent window. Must not be NULL.}
-
-\docparam{id}{Window identifier. A value of -1 indicates a default value.}
-
-\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
-
-\docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
-
-\docparam{orientation}{Specifies a wxVERTICAL or wxHORIZONTAL orientation for laying out
-the toolbar.}
-
-\docparam{nRowsOrColumns}{Specifies the number of rows or
-columns, whose meaning depends on {\it orientation}.  If laid out
-vertically, {\it nRowsOrColumns} specifies the number of rows to draw
-before the next column is started; if horizontal, it refers to the
-number of columns to draw before the next row is started.}
-
-\docparam{style}{Window style. See \helpref{wxToolBar95}{wxtoolbar95}.}
-
-\docparam{name}{Window name.}
-
-\section{\class{wxToolBarMSW}}\label{wxtoolbarmsw}
-
-This class should be used when a 3D-effect toolbar is required for Windows versions earlier
-than Windows 95.
-
-\wxheading{Derived from}
-
-\helpref{wxToolBarBase}{wxtoolbarbase}\\
-\helpref{wxControl}{wxcontrol}\\
-\helpref{wxWindow}{wxwindow}\\
-\helpref{wxEvtHandler}{wxevthandler}\\
-\helpref{wxObject}{wxobject}
-
-\wxheading{Window styles}
-
-There are no specific styles for this class.
-
-See also \helpref{window styles overview}{windowstyles}.
-
-\wxheading{Remarks}
-
-Note that this toolbar does not paint tools to reflect user-selected colours: grey shading is used.
-
-For member functions, see the documentation for \helpref{wxToolBarBase}{wxtoolbarbase}.
+\docparam{separation}{The separator size.}

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\overview{Toolbar overview}{wxtoolbaroverview},\rtfsp
-\helpref{wxToolBarBase}{wxtoolbarbase},\rtfsp
-\helpref{wxToolBarSimple}{wxtoolbarsimple},\rtfsp
-\helpref{wxToolBar95}{wxtoolbar95}
-
-\latexignore{\rtfignore{\wxheading{Members}}}
+\helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}

 
 

-\membersection{wxToolBarMSW::wxToolBarMSW}\label{wxtoolbarmswconstr}
+\membersection{wxToolBar::ToggleTool}\label{wxtoolbartoggletool}

 
 

-\func{}{wxToolBarMSW}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp
-\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long }{style = 0}, \param{const int }{orientation = wxVERTICAL},\rtfsp
-\param{const int }{nRowsOrColumns = 1}, \param{const wxString\& }{name = ``toolBar"}}
+\func{void}{ToggleTool}{\param{int }{toolId}, \param{const bool}{ toggle}}

 
 

-Constructs a toolbar.
+Toggles a tool on or off. This does not cause any event to get emitted.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 

-\docparam{parent}{Parent window. Must not be NULL.}
-
-\docparam{id}{Window identifier. A value of -1 indicates a default value.}
-
-\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
-
-\docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
-
-\docparam{orientation}{Specifies a wxVERTICAL or wxHORIZONTAL orientation for laying out
-the toolbar.}
-
-\docparam{nRowsOrColumns}{Specifies the number of rows or
-columns, whose meaning depends on {\it orientation}.  If laid out
-vertically, {\it nRowsOrColumns} specifies the number of rows to draw
-before the next column is started; if horizontal, it refers to the
-number of columns to draw before the next row is started.}
-
-\docparam{style}{Window style. See \helpref{wxToolBarMSW}{wxtoolbarmsw}.}
-
-\docparam{name}{Window name.}
-
-
-\section{\class{wxToolBarSimple}}\label{wxtoolbarsimple}
-
-This is the generic toolbar class which has an identical appearance
-on all platforms.
-
-\wxheading{Derived from}
-
-\helpref{wxToolBarBase}{wxtoolbarbase}\\
-\helpref{wxControl}{wxcontrol}\\
-\helpref{wxWindow}{wxwindow}\\
-\helpref{wxEvtHandler}{wxevthandler}\\
-\helpref{wxObject}{wxobject}
+\docparam{toolId}{Tool in question.}

 
 

-\wxheading{Window styles}
-
-\twocolwidtha{5cm}
-\begin{twocollist}\itemsep=0pt
-\twocolitem{\windowstyle{wxTB\_3DBUTTONS}}{Gives the simple toolbar a mild 3D look to its buttons.}
-\end{twocollist}
-
-See also \helpref{window styles overview}{windowstyles}.
+\docparam{toggle}{If TRUE, toggles the tool on, otherwise toggles it off.}

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-In this class, disabling a toolbar tool does not change its appearance.
-
-For member functions, see the documentation for \helpref{wxToolBarBase}{wxtoolbarbase}.
+Only applies to a tool that has been specified as a toggle tool.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 

-\overview{Toolbar overview}{wxtoolbaroverview},\rtfsp
-\helpref{wxToolBarBase}{wxtoolbarbase},\rtfsp
-\helpref{wxToolBarSimple}{wxtoolbarsimple},\rtfsp
-\helpref{wxToolBar95}{wxtoolbar95}
-
-\latexignore{\rtfignore{\wxheading{Members}}}
-
-\membersection{wxToolBarSimple::wxToolBarSimple}\label{wxtoolbarsimpleconstr}
-
-\func{}{wxToolBarSimple}{\param{wxWindow*}{ parent}, \param{const wxWindowID }{id},\rtfsp
-\param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long }{style = 0}, \param{const int }{orientation = wxVERTICAL},\rtfsp
-\param{const int }{nRowsOrColumns = 1}, \param{const wxString\& }{name = ``toolBar"}}
-
-Constructs a toolbar.
-
-\wxheading{Parameters}
-
-\docparam{parent}{Parent window. Must not be NULL.}
-
-\docparam{id}{Window identifier. A value of -1 indicates a default value.}
-
-\docparam{pos}{Window position. If the position (-1, -1) is specified then a default position is chosen.}
-
-\docparam{size}{Window size. If the default size (-1, -1) is specified then a default size is chosen.}
-
-\docparam{orientation}{Specifies a wxVERTICAL or wxHORIZONTAL orientation for laying out
-the toolbar.}
-
-\docparam{nRowsOrColumns}{Specifies the number of rows or
-columns, whose meaning depends on {\it orientation}.  If laid out
-vertically, {\it nRowsOrColumns} specifies the number of rows to draw
-before the next column is started; if horizontal, it refers to the
-number of columns to draw before the next row is started.}
-
-\docparam{style}{Window style. See \helpref{wxToolBarSimple}{wxtoolbarsimple}.}
-
-\docparam{name}{Window name.}
-
+\helpref{wxToolBar::GetToolState}{wxtoolbargettoolstate}