X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/5b2acc3a4f02058e76cdcbfad5d57a0988bbb138..8060b0be0e5b8cc8b033158b8cfb241efeb82876:/docs/latex/wx/toolbar.tex diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex index ea95dbe2e8..8907395080 100644 --- a/docs/latex/wx/toolbar.tex +++ b/docs/latex/wx/toolbar.tex @@ -73,6 +73,7 @@ use this option under Windows XP with true colour: \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 @@ -164,12 +165,20 @@ 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} @@ -289,6 +298,11 @@ others are not. \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} @@ -359,7 +373,7 @@ Returns a pointer to the control identified by \arg{id} or \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. @@ -378,6 +392,13 @@ A pointer to a tool if a tool is found, or \NULL otherwise. 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} \func{wxSize}{GetToolSize}{\void} @@ -748,6 +769,17 @@ and not the eventual size of the tool button. 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}} @@ -811,6 +843,15 @@ An application might use short help for identifying the tool purpose in a toolti \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}}