\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}
wxToolBarBase\\
\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
-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
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}
\latexignore{\rtfignore{\wxheading{Members}}}
+
\membersection{wxToolBar::wxToolBar}\label{wxtoolbarconstr}
\func{}{wxToolBar}{\void}
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::AddControl}\label{wxtoolbaraddcontrol}
\func{bool}{AddControl}{\param{wxControl*}{ control}}
\docparam{control}{The control to be added.}
+
\membersection{wxToolBar::AddSeparator}\label{wxtoolbaraddseparator}
\func{void}{AddSeparator}{\void}
\helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
+
\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}}
-\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{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
-to add an existing tool.
+you to add an existing tool.
\wxheading{Parameters}
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}
\helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool},\rtfsp
\helpref{wxToolBar::Realize}{wxtoolbarrealize}
+
\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{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}.
\helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
+
\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{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
\helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
+
\membersection{wxToolBar::DeleteTool}\label{wxtoolbardeletetool}
\func{bool}{DeleteTool}{\param{int }{toolId}}
\helpref{DeleteToolByPos}{wxtoolbardeletetoolbypos}
+
\membersection{wxToolBar::DeleteToolByPos}\label{wxtoolbardeletetoolbypos}
\func{bool}{DeleteToolByPos}{\param{size\_t }{pos}}
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}}
\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}
+
\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}}
-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}
-\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.
\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}
-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}
\helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
\helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize}
+
\membersection{wxToolBar::GetToolBitmapSize}\label{wxtoolbargettoolbitmapsize}
\func{wxSize}{GetToolBitmapSize}{\void}
\helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
\helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
+
\membersection{wxToolBar::GetMargins}\label{wxtoolbargetmargins}
\constfunc{wxSize}{GetMargins}{\void}
\helpref{wxToolBar::SetMargins}{wxtoolbarsetmargins}
+
\membersection{wxToolBar::GetToolClientData}\label{wxtoolbargettoolclientdata}
\constfunc{wxObject*}{GetToolClientData}{\param{int }{toolId}}
\wxheading{Return value}
-Client data, or NULL if there is none.
+Client data, or \NULL if there is none.
+
\membersection{wxToolBar::GetToolEnabled}\label{wxtoolbargettoolenabled}
\helpref{wxToolBar::EnableTool}{wxtoolbarenabletool}
+
\membersection{wxToolBar::GetToolLongHelp}\label{wxtoolbargettoollonghelp}
\constfunc{wxString}{GetToolLongHelp}{\param{int }{toolId}}
\helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp},\rtfsp
\helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
+
\membersection{wxToolBar::GetToolPacking}\label{wxtoolbargettoolpacking}
\constfunc{int}{GetToolPacking}{\void}
\helpref{wxToolBar::SetToolPacking}{wxtoolbarsettoolpacking}
+
\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}
\helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
+
\membersection{wxToolBar::GetToolShortHelp}\label{wxtoolbargettoolshorthelp}
\constfunc{wxString}{GetToolShortHelp}{\param{int }{toolId}}
\helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
\helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
+
\membersection{wxToolBar::GetToolState}\label{wxtoolbargettoolstate}
\constfunc{bool}{GetToolState}{\param{int }{toolId}}
\helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
+
\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.
\helpref{AddControl}{wxtoolbaraddcontrol},\\
\helpref{InsertTool}{wxtoolbarinserttool}
+
\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.
\helpref{AddSeparator}{wxtoolbaraddseparator},\\
\helpref{InsertTool}{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{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.
\helpref{InsertControl}{wxtoolbarinsertcontrol},\\
\helpref{InsertSeparator}{wxtoolbarinsertseparator}
+
\membersection{wxToolBar::OnLeftClick}\label{wxtoolbaronleftclick}
\func{bool}{OnLeftClick}{\param{int}{ toolId}, \param{bool}{ toggleDown}}
\helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
\helpref{wxToolBar::OnRightClick}{wxtoolbaronrightclick}
+
\membersection{wxToolBar::OnMouseEnter}\label{wxtoolbaronmouseenter}
\func{void}{OnMouseEnter}{\param{int}{ toolId}}
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}}
\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::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.
\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}}
\helpref{wxToolBar::GetMargins}{wxtoolbargetmargins}, \helpref{wxSize}{wxsize}
+
\membersection{wxToolBar::SetToolBitmapSize}\label{wxtoolbarsettoolbitmapsize}
\func{void}{SetToolBitmapSize}{\param{const wxSize\&}{ size}}
\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::SetToolLongHelp}\label{wxtoolbarsettoollonghelp}
\func{void}{SetToolLongHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}
\helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
\helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp},\rtfsp
+
\membersection{wxToolBar::SetToolPacking}\label{wxtoolbarsettoolpacking}
\func{void}{SetToolPacking}{\param{int}{ packing}}
\helpref{wxToolBar::GetToolPacking}{wxtoolbargettoolpacking}
+
\membersection{wxToolBar::SetToolShortHelp}\label{wxtoolbarsettoolshorthelp}
\func{void}{SetToolShortHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}
\helpref{wxToolBar::GetToolShortHelp}{wxtoolbargettoolshorthelp}, \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp}
+
\membersection{wxToolBar::SetToolSeparation}\label{wxtoolbarsettoolseparation}
\func{void}{SetToolSeparation}{\param{int}{ separation}}
\helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}
+
\membersection{wxToolBar::ToggleTool}\label{wxtoolbartoggletool}
\func{void}{ToggleTool}{\param{int }{toolId}, \param{const bool}{ toggle}}