\item {\bf wxToolBarGTK} The GTK toolbar.
\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.
-
\wxheading{Derived from}
wxToolBarBase\\
You may also create a toolbar that is managed by the frame, by
calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}. Under Pocket PC,
-you should {\it always} use this function for creating the toolbar
+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.
\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.}
+\twocolitem{\windowstyle{wxTB\_BOTTOM}}{Align the toolbar at the bottom of parent window.}
+\twocolitem{\windowstyle{wxTB\_RIGHT}}{Align the toolbar at the right side of parent window.}
\end{twocollist}
See also \helpref{window styles overview}{windowstyles}. Note that the Win32
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.}
+\twocolitem{{\bf EVT\_TOOL\_DROPDOWN(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_DROPDOWN\_CLICKED event. If unhandled, displays the default dropdown menu set using \helpref{wxToolBar::SetDropdownMenu}{wxtoolbarsetdropdownmenu}.}
+\end{twocollist}
+
+\wxheading{wxItemKind}
+
+There are several different types of tools you can add to a toolbar. These
+types are controlled by the wxItemKind enumeration which has the following
+values:
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{{\bf wxITEM\_NORMAL}}{Normal tool button}
+\twocolitem{{\bf wxITEM\_CHECK}}{Check (or toggle) tool button.}
+\twocolitem{{\bf wxITEM\_NORMAL}}{Radio tool button. See \helpref{wxToolBar::AddRadioTool}{wxtoolbaraddradiotool} for details}
+\twocolitem{{\bf wxITEM\_DROPDOWN}}{Normal tool button with a dropdown arrow
+next to it. Clicking the dropdown arrow sends a wxEVT\_COMMAND\_TOOL\_DROPDOWN\_CLICKED
+event and may also display the menu previously associated with the item with
+\helpref{wxToolBar::SetDropdownMenu}{wxtoolbarsetdropdownmenu}. Currently this
+type of tools is supported under MSW and GTK.}
\end{twocollist}
\wxheading{See also}
\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}}
+\func{bool}{AddControl}{\param{wxControl*}{ control}, \param{const wxString&}{ label = ""}}
Adds any control to the toolbar, typically e.g. a combobox.
\docparam{control}{The control to be added.}
+\docparam{label}{Text to be displayed near the control.}
+
+\wxheading{Remarks}
+
+wxMSW: the label is only displayed if there is enough space available below the embedded control.
+
+wxMac: labels are only displayed if wxWidgets is built with wxMAC\_USE\_NATIVE\_TOOLBAR set to 1
+
+
\membersection{wxToolBar::AddSeparator}\label{wxtoolbaraddseparator}
\func{void}{AddSeparator}{\void}
\helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
+
\membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
\func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\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{wxToolBarToolBase*}{AddTool}{\param{wxToolBarToolBase* }{tool}}
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{wxToolBarToolBase*}{AddCheckTool}{\param{int}{ toolId},\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{wxToolBarToolBase*}{AddRadioTool}{\param{int}{ toolId},\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::ClearTools}\label{wxtoolbarcleartools}
+
+\func{void}{ClearTools}{\void}
+
+Deletes all the tools in the toolbar.
+
\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}}
\helpref{wxToolBar::GetToolEnabled}{wxtoolbargettoolenabled},\rtfsp
\helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
+
\membersection{wxToolBar::FindById}\label{wxtoolbarfindbyid}
\func{wxToolBarToolBase*}{FindById}{\param{int }{id}}
-Returns a pointer to the tool identified by {\it id} or
-NULL if no corresponding tool is found.
+Returns a pointer to the tool identified by \arg{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{wxToolBarToolBase*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}
+\constfunc{wxToolBarToolBase*}{FindToolForPosition}{\param{wxCoord }{x}, \param{wxCoord }{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::GetToolsCount}\label{wxtoolbargettoolscount}
+
+\constfunc{int}{GetToolsCount}{\void}
+
+Returns the number of tools in the toolbar.
+
\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 {\tt wxNOT\_FOUND} if the tool is not found.
+
\membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation}
\constfunc{int}{GetToolSeparation}{\void}
\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{wxToolBarToolBase *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}
\helpref{AddControl}{wxtoolbaraddcontrol},\\
\helpref{InsertTool}{wxtoolbarinserttool}
+
\membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator}
\func{wxToolBarToolBase *}{InsertSeparator}{\param{size\_t }{pos}}
\helpref{AddSeparator}{wxtoolbaraddseparator},\\
\helpref{InsertTool}{wxtoolbarinserttool}
+
\membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
\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{wxToolBarToolBase *}{InsertTool}{\param{size\_t }{pos},\rtfsp
\param{wxToolBarToolBase* }{tool}}
\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{wxToolBarToolBase *}{RemoveTool}{\param{int }{id}}
\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::SetDropdownMenu}\label{wxtoolbarsetdropdownmenu}
+
+\func{bool}{SetDropdownMenu}{\param{int }{id}, \param{wxMenu* }{menu}}
+
+Sets the dropdown menu for the tool given by its \arg{id}. The tool itself will
+delete the menu when it's no longer needed.
+
+If you define a EVT\_TOOL\_DROPDOWN handler in your program, you must call
+\helpref{wxEvent::Skip()}{wxeventskip} from it or the menu won't be displayed.
+
+
\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::SetToolDisabledBitmap}\label{wxtoolbarsettooldisabledbitmap}
+
+\func{void}{SetToolDisabledBitmap}{\param{int }{id}, \param{const wxBitmap\& }{bitmap}}
+
+Sets the bitmap to be used by the tool with the given ID when the tool
+is in a disabled state. This can only be used on Button tools, not
+controls. NOTE: The native toolbar classes on the main platforms all
+synthesize the disabled bitmap from the normal bitmap, so this
+function will have no effect on those platforms.
+
+
\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::SetToolNormalBitmap}\label{wxtoolbarsettoolnormalbitmap}
+
+\func{void}{SetToolNormalBitmap}{\param{int }{id}, \param{const wxBitmap\& }{bitmap}}
+
+Sets the bitmap to be used by the tool with the given ID. This can
+only be used on Button tools, not controls.
+
+
+
\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}}
projects / wxWidgets.git / blobdiff