added HasHandlerForPath() (modified patch 1514524)

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

diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex
index 3f465944cce8b0949999192f011a522634d67ec6..3ed722010cd5734b54f96338991a981cd0297b7b 100644 (file)
--- a/docs/latex/wx/toolbar.tex
+++ b/docs/latex/wx/toolbar.tex
@@ -6,15 +6,8 @@ The name wxToolBar is defined to be a synonym for one of the following classes:
 \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 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}
 
 \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}
 
 wxToolBarBase\\
 \wxheading{Derived from}
 
 wxToolBarBase\\


@@ -26,20 +19,18 @@ wxToolBarBase\\
 \wxheading{Include files}
 
 <wx/toolbar.h> (to allow wxWidgets to select an appropriate toolbar class)\\
 \wxheading{Include files}
 
 <wx/toolbar.h> (to allow wxWidgets 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)
+<wx/tbarbase.h> (the base class)

 
 \wxheading{Remarks}
 
 You may also create a toolbar that is managed by the frame, by
 
 \wxheading{Remarks}
 
 You may also create a toolbar that is managed by the frame, by

-calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
+calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}. Under Pocket PC,
+you should \arg{always} use this function for creating the toolbar
+to be managed by the frame, so that wxWidgets can use a combined
+menubar and toolbar. Where you manage your own toolbars, create a wxToolBar
+as usual.

 
 

-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.
+The meaning of a "separator" is a vertical line under Windows and simple space under GTK+.

 
 {\bf wxToolBar95:} Note that this toolbar paints tools to reflect system-wide colours.
 If you use more than 16 colours in your tool bitmaps, you may wish to suppress
 
 {\bf wxToolBar95:} Note that this toolbar paints tools to reflect system-wide colours.
 If you use more than 16 colours in your tool bitmaps, you may wish to suppress


@@ -58,7 +49,7 @@ use:
   wxSystemOptions::SetOption(wxT("msw.remap"), 2);
 \end{verbatim}
 
   wxSystemOptions::SetOption(wxT("msw.remap"), 2);
 \end{verbatim}
 

-then colour remapping is switched of, and a transparent background used. But only
+then colour remapping is switched off, and a transparent background used. But only

 use this option under Windows XP with true colour:
 
 \begin{verbatim}
 use this option under Windows XP with true colour:
 
 \begin{verbatim}


@@ -80,6 +71,7 @@ use this option under Windows XP with true colour:
 \twocolitem{\windowstyle{wxTB\_HORZ\_LAYOUT}}{Shows the text and the icons alongside, not vertically stacked (Windows and GTK
 2 only). This style must be used with wxTB\_TEXT.}
 \twocolitem{\windowstyle{wxTB\_HORZ\_TEXT}}{Combination of wxTB\_HORZ\_LAYOUT and wxTB\_TEXT.}
 \twocolitem{\windowstyle{wxTB\_HORZ\_LAYOUT}}{Shows the text and the icons alongside, not vertically stacked (Windows and GTK
 2 only). This style must be used with wxTB\_TEXT.}
 \twocolitem{\windowstyle{wxTB\_HORZ\_TEXT}}{Combination of wxTB\_HORZ\_LAYOUT and wxTB\_TEXT.}

+\twocolitem{\windowstyle{wxTB\_NO\_TOOLTIPS}}{Don't show the short help tooltips for the tools when the mouse hovers over them.}

 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}. Note that the Win32
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}. Note that the Win32


@@ -88,7 +80,7 @@ native toolbar ignores {\tt wxTB\_NOICONS} style. Also, toggling the
 
 \wxheading{Event handling}
 
 
 \wxheading{Event handling}
 

-The toolbar class emits menu commands in the same was that a frame menubar does,
+The toolbar class emits menu commands in the same way 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
 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


@@ -119,6 +111,7 @@ Pass the id of the toolbar itself. The value of wxCommandEvent::GetSelection is
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxToolBar::wxToolBar}\label{wxtoolbarconstr}
 
 \func{}{wxToolBar}{\void}
 \membersection{wxToolBar::wxToolBar}\label{wxtoolbarconstr}
 
 \func{}{wxToolBar}{\void}


@@ -160,12 +153,14 @@ tools.
 You may also create a toolbar that is managed by the frame, by
 calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
 
 You may also create a toolbar that is managed by the frame, by
 calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
 

+

 \membersection{wxToolBar::\destruct{wxToolBar}}\label{wxtoolbardtor}
 
 \func{void}{\destruct{wxToolBar}}{\void}
 
 Toolbar destructor.
 
 \membersection{wxToolBar::\destruct{wxToolBar}}\label{wxtoolbardtor}
 
 \func{void}{\destruct{wxToolBar}}{\void}
 
 Toolbar destructor.
 

+

 \membersection{wxToolBar::AddControl}\label{wxtoolbaraddcontrol}
 
 \func{bool}{AddControl}{\param{wxControl*}{ control}}
 \membersection{wxToolBar::AddControl}\label{wxtoolbaraddcontrol}
 
 \func{bool}{AddControl}{\param{wxControl*}{ control}}


@@ -174,6 +169,7 @@ Adds any control to the toolbar, typically e.g. a combobox.
 
 \docparam{control}{The control to be added.}
 
 
 \docparam{control}{The control to be added.}
 

+

 \membersection{wxToolBar::AddSeparator}\label{wxtoolbaraddseparator}
 
 \func{void}{AddSeparator}{\void}
 \membersection{wxToolBar::AddSeparator}\label{wxtoolbaraddseparator}
 
 \func{void}{AddSeparator}{\void}


@@ -184,29 +180,30 @@ Adds a separator for spacing groups of tools.
 
 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
 
 
 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
 

+

 \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
 
 \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
 

-\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp
+\func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\rtfsp

 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{wxItemKind}{ kind = wxITEM\_NORMAL}}
 
 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{wxItemKind}{ kind = wxITEM\_NORMAL}}
 

-\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp
+\func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\rtfsp

 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap},\rtfsp
 \param{wxItemKind}{ kind = wxITEM\_NORMAL},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},
 \param{const wxString\& }{longHelpString = ""},\rtfsp
 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap},\rtfsp
 \param{wxItemKind}{ kind = wxITEM\_NORMAL},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},
 \param{const wxString\& }{longHelpString = ""},\rtfsp

-\param{wxObject* }{clientData = NULL}}
+\param{wxObject* }{clientData = \NULL}}

 
 

-\func{wxToolBarTool*}{AddTool}{\param{wxToolBarTool* }{tool}}
+\func{wxToolBarToolBase*}{AddTool}{\param{wxToolBarToolBase* }{tool}}

 
 Adds a tool to the toolbar. The first (short and most commonly used) version
 has fewer parameters than the full version at the price of not being able to
 specify some of the more rarely used button features. The last version allows
 
 Adds a tool to the toolbar. The first (short and most commonly used) version
 has fewer parameters than the full version at the price of not being able to
 specify some of the more rarely used button features. The last version allows

-to add an existing tool.
+you to add an existing tool.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -219,13 +216,11 @@ toggled) or wxITEM\_RADIO for a checkable tool which makes part of a radio
 group of tools each of which is automatically unchecked whenever another button
 in the group is checked}
 
 group of tools each of which is automatically unchecked whenever another button
 in the group is checked}
 

-\docparam{bitmap1}{The primary tool bitmap for toggle and button tools.}
+\docparam{bitmap1}{The primary tool bitmap.}

 
 

-\docparam{bitmap2}{The second bitmap specifies the on-state bitmap for a toggle
-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
-border is drawn around the tool (colour displays) or the pixmap is shown
-as a pressed button (GTK). }
+\docparam{bitmap2}{The bitmap used when the tool is disabled. If it is equal to
+wxNullBitmap, the disabled bitmap is automatically generated by greing the
+normal one.}

 
 \docparam{shortHelpString}{This string is used for the tools tooltip}
 
 
 \docparam{shortHelpString}{This string is used for the tools tooltip}
 


@@ -251,15 +246,16 @@ order to have the tools appear.
 \helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool},\rtfsp
 \helpref{wxToolBar::Realize}{wxtoolbarrealize}
 
 \helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool},\rtfsp
 \helpref{wxToolBar::Realize}{wxtoolbarrealize}
 

+

 \membersection{wxToolBar::AddCheckTool}\label{wxtoolbaraddchecktool}
 
 \membersection{wxToolBar::AddCheckTool}\label{wxtoolbaraddchecktool}
 

-\func{wxToolBarTool*}{AddCheckTool}{\param{int}{ toolId},\rtfsp
+\func{wxToolBarToolBase*}{AddCheckTool}{\param{int}{ toolId},\rtfsp

 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{const wxString\& }{longHelpString = ""},\rtfsp
 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{const wxString\& }{longHelpString = ""},\rtfsp

-\param{wxObject* }{clientData = NULL}}
+\param{wxObject* }{clientData = \NULL}}

 
 Adds a new check (or toggle) tool to the toolbar. The parameters are the same
 as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.
 
 Adds a new check (or toggle) tool to the toolbar. The parameters are the same
 as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.


@@ -268,15 +264,16 @@ as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.
 
 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
 
 
 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
 

+

 \membersection{wxToolBar::AddRadioTool}\label{wxtoolbaraddradiotool}
 
 \membersection{wxToolBar::AddRadioTool}\label{wxtoolbaraddradiotool}
 

-\func{wxToolBarTool*}{AddRadioTool}{\param{int}{ toolId},\rtfsp
+\func{wxToolBarToolBase*}{AddRadioTool}{\param{int}{ toolId},\rtfsp

 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{const wxString\& }{longHelpString = ""},\rtfsp
 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{const wxString\& }{longHelpString = ""},\rtfsp

-\param{wxObject* }{clientData = NULL}}
+\param{wxObject* }{clientData = \NULL}}

 
 Adds a new radio tool to the toolbar. Consecutive radio tools form a radio
 group such that exactly one button in the group is pressed at any moment, in
 
 Adds a new radio tool to the toolbar. Consecutive radio tools form a radio
 group such that exactly one button in the group is pressed at any moment, in


@@ -291,6 +288,7 @@ others are not.
 
 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
 
 
 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
 

+

 \membersection{wxToolBar::DeleteTool}\label{wxtoolbardeletetool}
 
 \func{bool}{DeleteTool}{\param{int }{toolId}}
 \membersection{wxToolBar::DeleteTool}\label{wxtoolbardeletetool}
 
 \func{bool}{DeleteTool}{\param{int }{toolId}}


@@ -308,6 +306,7 @@ Returns true if the tool was deleted, false otherwise.
 
 \helpref{DeleteToolByPos}{wxtoolbardeletetoolbypos}
 
 
 \helpref{DeleteToolByPos}{wxtoolbardeletetoolbypos}
 

+

 \membersection{wxToolBar::DeleteToolByPos}\label{wxtoolbardeletetoolbypos}
 
 \func{bool}{DeleteToolByPos}{\param{size\_t }{pos}}
 \membersection{wxToolBar::DeleteToolByPos}\label{wxtoolbardeletetoolbypos}
 
 \func{bool}{DeleteToolByPos}{\param{size\_t }{pos}}


@@ -315,6 +314,7 @@ Returns true if the tool was deleted, false otherwise.
 This function behaves like \helpref{DeleteTool}{wxtoolbardeletetool} but it
 deletes the tool at the specified position and not the one with the given id.
 
 This function behaves like \helpref{DeleteTool}{wxtoolbardeletetool} but it
 deletes the tool at the specified position and not the one with the given id.
 

+

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


@@ -332,31 +332,33 @@ Enables or disables the tool.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-For wxToolBarSimple, does nothing. Some other implementations
-will change the visible state of the tool to indicate that it is disabled.
+Some implementations will change the visible state of the tool to indicate that it is disabled.

 
 \wxheading{See also}
 
 \helpref{wxToolBar::GetToolEnabled}{wxtoolbargettoolenabled},\rtfsp
 \helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
 
 
 \wxheading{See also}
 
 \helpref{wxToolBar::GetToolEnabled}{wxtoolbargettoolenabled},\rtfsp
 \helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
 

+

 \membersection{wxToolBar::FindById}\label{wxtoolbarfindbyid}
 
 \membersection{wxToolBar::FindById}\label{wxtoolbarfindbyid}
 

-\func{wxToolBarTool*}{FindById}{\param{int }{id}}
+\func{wxToolBarToolBase*}{FindById}{\param{int }{id}}
+
+Returns a pointer to the tool identified by \arg{id} or
+\NULL if no corresponding tool is found.

 
 

-Returns a pointer to the tool identified by {\it id} or
-NULL if no corresponding tool is found.

 
 \membersection{wxToolBar::FindControl}\label{wxtoolbarfindcontrol}
 
 \func{wxControl*}{FindControl}{\param{int }{id}}
 
 
 \membersection{wxToolBar::FindControl}\label{wxtoolbarfindcontrol}
 
 \func{wxControl*}{FindControl}{\param{int }{id}}
 

-Returns a pointer to the control identified by {\it id} or
-NULL if no corresponding control is found.
+Returns a pointer to the control identified by \arg{id} or 
+\NULL if no corresponding control is found.
+

 
 \membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}
 
 
 \membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}
 

-\constfunc{wxToolBarTool*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}
+\constfunc{wxToolBarToolBase*}{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.
 


@@ -368,11 +370,12 @@ Finds a tool for the given mouse position.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-A pointer to a tool if a tool is found, or NULL otherwise.
+A pointer to a tool if a tool is found, or \NULL otherwise.

 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-Used internally, and should not need to be used by the programmer.
+Currently not implemented in wxGTK (always returns \NULL there).
+

 
 \membersection{wxToolBar::GetToolSize}\label{wxtoolbargettoolsize}
 
 
 \membersection{wxToolBar::GetToolSize}\label{wxtoolbargettoolsize}
 


@@ -386,6 +389,7 @@ of added 3D effects.
 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize}
 
 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize}
 

+

 \membersection{wxToolBar::GetToolBitmapSize}\label{wxtoolbargettoolbitmapsize}
 
 \func{wxSize}{GetToolBitmapSize}{\void}
 \membersection{wxToolBar::GetToolBitmapSize}\label{wxtoolbargettoolbitmapsize}
 
 \func{wxSize}{GetToolBitmapSize}{\void}


@@ -402,6 +406,7 @@ and not the eventual size of the tool button.
 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
 
 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
 

+

 \membersection{wxToolBar::GetMargins}\label{wxtoolbargetmargins}
 
 \constfunc{wxSize}{GetMargins}{\void}
 \membersection{wxToolBar::GetMargins}\label{wxtoolbargetmargins}
 
 \constfunc{wxSize}{GetMargins}{\void}


@@ -412,6 +417,7 @@ Returns the left/right and top/bottom margins, which are also used for inter-too
 
 \helpref{wxToolBar::SetMargins}{wxtoolbarsetmargins}
 
 
 \helpref{wxToolBar::SetMargins}{wxtoolbarsetmargins}
 

+

 \membersection{wxToolBar::GetToolClientData}\label{wxtoolbargettoolclientdata}
 
 \constfunc{wxObject*}{GetToolClientData}{\param{int }{toolId}}
 \membersection{wxToolBar::GetToolClientData}\label{wxtoolbargettoolclientdata}
 
 \constfunc{wxObject*}{GetToolClientData}{\param{int }{toolId}}


@@ -424,7 +430,8 @@ Get any client data associated with the tool.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-Client data, or NULL if there is none.
+Client data, or \NULL if there is none.
+

 
 \membersection{wxToolBar::GetToolEnabled}\label{wxtoolbargettoolenabled}
 
 
 \membersection{wxToolBar::GetToolEnabled}\label{wxtoolbargettoolenabled}
 


@@ -444,6 +451,7 @@ true if the tool is enabled, false otherwise.
 
 \helpref{wxToolBar::EnableTool}{wxtoolbarenabletool}
 
 
 \helpref{wxToolBar::EnableTool}{wxtoolbarenabletool}
 

+

 \membersection{wxToolBar::GetToolLongHelp}\label{wxtoolbargettoollonghelp}
 
 \constfunc{wxString}{GetToolLongHelp}{\param{int }{toolId}}
 \membersection{wxToolBar::GetToolLongHelp}\label{wxtoolbargettoollonghelp}
 
 \constfunc{wxString}{GetToolLongHelp}{\param{int }{toolId}}


@@ -459,6 +467,7 @@ Returns the long help for the given tool.
 \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp},\rtfsp
 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
 
 \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp},\rtfsp
 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
 

+

 \membersection{wxToolBar::GetToolPacking}\label{wxtoolbargettoolpacking}
 
 \constfunc{int}{GetToolPacking}{\void}
 \membersection{wxToolBar::GetToolPacking}\label{wxtoolbargettoolpacking}
 
 \constfunc{int}{GetToolPacking}{\void}


@@ -469,11 +478,13 @@ Returns the value used for packing tools.
 
 \helpref{wxToolBar::SetToolPacking}{wxtoolbarsettoolpacking}
 
 
 \helpref{wxToolBar::SetToolPacking}{wxtoolbarsettoolpacking}
 

+

 \membersection{wxToolBar::GetToolPos}\label{wxtoolbargettoolpos}
 
 \constfunc{int}{GetToolPos}{\param{int }{toolId}}
 
 \membersection{wxToolBar::GetToolPos}\label{wxtoolbargettoolpos}
 
 \constfunc{int}{GetToolPos}{\param{int }{toolId}}
 

-Returns the tool position in the toolbar, or wxNOT\_FOUND if the tool is not found.
+Returns the tool position in the toolbar, or {\tt wxNOT\_FOUND} if the tool is not found.
+

 
 \membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation}
 
 
 \membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation}
 


@@ -485,6 +496,7 @@ Returns the default separator size.
 
 \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
 
 
 \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
 

+

 \membersection{wxToolBar::GetToolShortHelp}\label{wxtoolbargettoolshorthelp}
 
 \constfunc{wxString}{GetToolShortHelp}{\param{int }{toolId}}
 \membersection{wxToolBar::GetToolShortHelp}\label{wxtoolbargettoolshorthelp}
 
 \constfunc{wxString}{GetToolShortHelp}{\param{int }{toolId}}


@@ -500,6 +512,7 @@ Returns the short help for the given tool.
 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
 
 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
 

+

 \membersection{wxToolBar::GetToolState}\label{wxtoolbargettoolstate}
 
 \constfunc{bool}{GetToolState}{\param{int }{toolId}}
 \membersection{wxToolBar::GetToolState}\label{wxtoolbargettoolstate}
 
 \constfunc{bool}{GetToolState}{\param{int }{toolId}}


@@ -518,9 +531,10 @@ true if the tool is toggled on, false otherwise.
 
 \helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
 
 
 \helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
 

+

 \membersection{wxToolBar::InsertControl}\label{wxtoolbarinsertcontrol}
 
 \membersection{wxToolBar::InsertControl}\label{wxtoolbarinsertcontrol}
 

-\func{wxToolBarTool *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}
+\func{wxToolBarToolBase *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}

 
 Inserts the control into the toolbar at the given position.
 
 
 Inserts the control into the toolbar at the given position.
 


@@ -531,9 +545,10 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
 \helpref{AddControl}{wxtoolbaraddcontrol},\\
 \helpref{InsertTool}{wxtoolbarinserttool}
 
 \helpref{AddControl}{wxtoolbaraddcontrol},\\
 \helpref{InsertTool}{wxtoolbarinserttool}
 

+

 \membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator}
 
 \membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator}
 

-\func{wxToolBarTool *}{InsertSeparator}{\param{size\_t }{pos}}
+\func{wxToolBarToolBase *}{InsertSeparator}{\param{size\_t }{pos}}

 
 Inserts the separator into the toolbar at the given position.
 
 
 Inserts the separator into the toolbar at the given position.
 


@@ -544,15 +559,16 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
 \helpref{AddSeparator}{wxtoolbaraddseparator},\\
 \helpref{InsertTool}{wxtoolbarinserttool}
 
 \helpref{AddSeparator}{wxtoolbaraddseparator},\\
 \helpref{InsertTool}{wxtoolbarinserttool}
 

+

 \membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
 
 \membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
 

-\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
+\func{wxToolBarToolBase *}{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{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 = ""}}
+\param{wxObject* }{clientData = \NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}

 
 

-\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
-\param{wxToolBarTool* }{tool}}
+\func{wxToolBarToolBase *}{InsertTool}{\param{size\_t }{pos},\rtfsp
+\param{wxToolBarToolBase* }{tool}}

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


@@ -565,6 +581,7 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
 \helpref{InsertControl}{wxtoolbarinsertcontrol},\\
 \helpref{InsertSeparator}{wxtoolbarinsertseparator}
 
 \helpref{InsertControl}{wxtoolbarinsertcontrol},\\
 \helpref{InsertSeparator}{wxtoolbarinsertseparator}
 

+

 \membersection{wxToolBar::OnLeftClick}\label{wxtoolbaronleftclick}
 
 \func{bool}{OnLeftClick}{\param{int}{ toolId}, \param{bool}{ toggleDown}}
 \membersection{wxToolBar::OnLeftClick}\label{wxtoolbaronleftclick}
 
 \func{bool}{OnLeftClick}{\param{int}{ toolId}, \param{bool}{ toggleDown}}


@@ -591,6 +608,7 @@ specifying that toggle operations are not permitted in some circumstances.
 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
 \helpref{wxToolBar::OnRightClick}{wxtoolbaronrightclick}
 
 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
 \helpref{wxToolBar::OnRightClick}{wxtoolbaronrightclick}
 

+

 \membersection{wxToolBar::OnMouseEnter}\label{wxtoolbaronmouseenter}
 
 \func{void}{OnMouseEnter}{\param{int}{ toolId}}
 \membersection{wxToolBar::OnMouseEnter}\label{wxtoolbaronmouseenter}
 
 \func{void}{OnMouseEnter}{\param{int}{ toolId}}


@@ -613,6 +631,7 @@ such as a short description on the status line.}
 With some derived toolbar classes, if the mouse moves quickly out of the toolbar, wxWidgets 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, wxWidgets may not be able to
 detect it. Therefore this function may not always be called when expected.
 

+

 \membersection{wxToolBar::OnRightClick}\label{wxtoolbaronrightclick}
 
 \func{void}{OnRightClick}{\param{int}{ toolId}, \param{float}{ x}, \param{float}{ y}}
 \membersection{wxToolBar::OnRightClick}\label{wxtoolbaronrightclick}
 
 \func{void}{OnRightClick}{\param{int}{ toolId}, \param{float}{ x}, \param{float}{ y}}


@@ -640,15 +659,17 @@ A typical use of this member might be to pop up a menu.
 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
 \helpref{wxToolBar::OnLeftClick}{wxtoolbaronleftclick}
 
 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
 \helpref{wxToolBar::OnLeftClick}{wxtoolbaronleftclick}
 

+

 \membersection{wxToolBar::Realize}\label{wxtoolbarrealize}
 
 \func{bool}{Realize}{\void}
 
 This function should be called after you have added tools.
 
 \membersection{wxToolBar::Realize}\label{wxtoolbarrealize}
 
 \func{bool}{Realize}{\void}
 
 This function should be called after you have added tools.
 

+

 \membersection{wxToolBar::RemoveTool}\label{wxtoolbarremovetool}
 
 \membersection{wxToolBar::RemoveTool}\label{wxtoolbarremovetool}
 

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

 
 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.
 
 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.


@@ -660,6 +681,15 @@ change to take place, it will happen immediately.
 
 \helpref{DeleteTool}{wxtoolbardeletetool}
 
 
 \helpref{DeleteTool}{wxtoolbardeletetool}
 

+
+\membersection{wxToolBar::SetBitmapResource}\label{wxtoolbarsetbitmapresource}
+
+\func{void}{SetBitmapResource}{\param{int }{resourceId}}
+
+Sets the bitmap resource identifier for specifying tool bitmaps as indices
+into a custom bitmap. Windows CE only.
+
+

 \membersection{wxToolBar::SetMargins}\label{wxtoolbarsetmargins}
 
 \func{void}{SetMargins}{\param{const wxSize\&}{ size}}
 \membersection{wxToolBar::SetMargins}\label{wxtoolbarsetmargins}
 
 \func{void}{SetMargins}{\param{const wxSize\&}{ size}}


@@ -685,6 +715,7 @@ default (zero-size) margins are to be overridden.
 
 \helpref{wxToolBar::GetMargins}{wxtoolbargetmargins}, \helpref{wxSize}{wxsize}
 
 
 \helpref{wxToolBar::GetMargins}{wxtoolbargetmargins}, \helpref{wxSize}{wxsize}
 

+

 \membersection{wxToolBar::SetToolBitmapSize}\label{wxtoolbarsettoolbitmapsize}
 
 \func{void}{SetToolBitmapSize}{\param{const wxSize\&}{ size}}
 \membersection{wxToolBar::SetToolBitmapSize}\label{wxtoolbarsettoolbitmapsize}
 
 \func{void}{SetToolBitmapSize}{\param{const wxSize\&}{ size}}


@@ -708,12 +739,14 @@ and not the eventual size of the tool button.
 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize},\rtfsp
 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
 
 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize},\rtfsp
 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
 

+

 \membersection{wxToolBar::SetToolClientData}\label{wxtoolbarsettoolclientdata}
 
 \func{void}{SetToolClientData}{\param{int }{id}, \param{wxObject* }{clientData}}
 
 Sets the client data associated with the tool.
 
 \membersection{wxToolBar::SetToolClientData}\label{wxtoolbarsettoolclientdata}
 
 \func{void}{SetToolClientData}{\param{int }{id}, \param{wxObject* }{clientData}}
 
 Sets the client data associated with the tool.
 

+

 \membersection{wxToolBar::SetToolLongHelp}\label{wxtoolbarsettoollonghelp}
 
 \func{void}{SetToolLongHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}
 \membersection{wxToolBar::SetToolLongHelp}\label{wxtoolbarsettoollonghelp}
 
 \func{void}{SetToolLongHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}


@@ -735,6 +768,7 @@ You might use the long help for displaying the tool purpose on the status line.
 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp},\rtfsp
 
 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp},\rtfsp
 

+

 \membersection{wxToolBar::SetToolPacking}\label{wxtoolbarsettoolpacking}
 
 \func{void}{SetToolPacking}{\param{int}{ packing}}
 \membersection{wxToolBar::SetToolPacking}\label{wxtoolbarsettoolpacking}
 
 \func{void}{SetToolPacking}{\param{int}{ packing}}


@@ -754,6 +788,7 @@ and for spacing in the horizontal direction if the toolbar is vertical.
 
 \helpref{wxToolBar::GetToolPacking}{wxtoolbargettoolpacking}
 
 
 \helpref{wxToolBar::GetToolPacking}{wxtoolbargettoolpacking}
 

+

 \membersection{wxToolBar::SetToolShortHelp}\label{wxtoolbarsettoolshorthelp}
 
 \func{void}{SetToolShortHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}
 \membersection{wxToolBar::SetToolShortHelp}\label{wxtoolbarsettoolshorthelp}
 
 \func{void}{SetToolShortHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}


@@ -774,6 +809,7 @@ An application might use short help for identifying the tool purpose in a toolti
 
 \helpref{wxToolBar::GetToolShortHelp}{wxtoolbargettoolshorthelp}, \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp}
 
 
 \helpref{wxToolBar::GetToolShortHelp}{wxtoolbargettoolshorthelp}, \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp}
 

+

 \membersection{wxToolBar::SetToolSeparation}\label{wxtoolbarsettoolseparation}
 
 \func{void}{SetToolSeparation}{\param{int}{ separation}}
 \membersection{wxToolBar::SetToolSeparation}\label{wxtoolbarsettoolseparation}
 
 \func{void}{SetToolSeparation}{\param{int}{ separation}}


@@ -788,6 +824,7 @@ Sets the default separator size. The default value is 5.
 
 \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}
 
 
 \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}
 

+

 \membersection{wxToolBar::ToggleTool}\label{wxtoolbartoggletool}
 
 \func{void}{ToggleTool}{\param{int }{toolId}, \param{const bool}{ toggle}}
 \membersection{wxToolBar::ToggleTool}\label{wxtoolbartoggletool}
 
 \func{void}{ToggleTool}{\param{int }{toolId}, \param{const bool}{ toggle}}