X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/cc81d32f2bf8c159f3b1bf6ddaf62e6d77720209..8695c06a6a5a87b80dfe862a7757fc7e06168455:/docs/latex/wx/toolbar.tex diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex index 4326648f39..cab5e19908 100644 --- a/docs/latex/wx/toolbar.tex +++ b/docs/latex/wx/toolbar.tex @@ -47,16 +47,18 @@ of a "separator" is a vertical line under Windows95 vs. simple space under GTK e \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.} +\twocolitem{\windowstyle{wxTB\_FLAT}}{Gives the toolbar a flat look (Windows and GTK only).} +\twocolitem{\windowstyle{wxTB\_DOCKABLE}}{Makes the toolbar floatable and dockable (GTK only).} +\twocolitem{\windowstyle{wxTB\_HORIZONTAL}}{Specifies horizontal layout (default).} +\twocolitem{\windowstyle{wxTB\_VERTICAL}}{Specifies vertical layout.} +\twocolitem{\windowstyle{wxTB\_3DBUTTONS}}{Only for wxToolBarSimple: gives a mild 3D look to its buttons.} \twocolitem{\windowstyle{wxTB\_TEXT}}{Show the text in the toolbar buttons; by default only icons are shown.} \twocolitem{\windowstyle{wxTB\_NOICONS}}{Specifies no icons in the toolbar buttons; by default they are shown.} -\twocolitem{\windowstyle{wxTB\_NODIVIDER}}{Specifies no divider above the toolbar; by default it is shown. Windows only.} -\twocolitem{\windowstyle{wxTB\_NOALIGN}}{Specifies no alignment with the parent window. Windows only.} +\twocolitem{\windowstyle{wxTB\_NODIVIDER}}{Specifies no divider (border) above the toolbar (Windows only).} +\twocolitem{\windowstyle{wxTB\_NOALIGN}}{Specifies no alignment with the parent window (Windows only, not very useful).} +\twocolitem{\windowstyle{wxTB\_HORZ\_LAYOUT}}{Show 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.} \end{twocollist} See also \helpref{window styles overview}{windowstyles}. Note that the Win32 @@ -186,9 +188,12 @@ Adds a separator for spacing groups of tools. \param{const wxString\& }{longHelpString = ""},\rtfsp \param{wxObject* }{clientData = NULL}} +\func{wxToolBarTool*}{AddTool}{\param{wxToolBarTool* }{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. +specify some of the more rarely used button features. The last version allows +to add an existing tool. \wxheading{Parameters} @@ -217,6 +222,8 @@ parent frame when the mouse pointer is inside the tool} \docparam{clientData}{An optional pointer to client data which can be retrieved later using \helpref{wxToolBar::GetToolClientData}{wxtoolbargettoolclientdata}.} +\docparam{tool}{The tool to be added.} + \wxheading{Remarks} After you have added tools to a toolbar, you must call \helpref{wxToolBar::Realize}{wxtoolbarrealize} in @@ -442,6 +449,12 @@ Returns the value used for packing tools. \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. + \membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation} \constfunc{int}{GetToolSeparation}{\void} @@ -518,6 +531,9 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place. \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap}, \param{bool}{ isToggle = false},\rtfsp \param{wxObject* }{clientData = NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}} +\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp +\param{wxToolBarTool* }{tool}} + Inserts the tool with the specified attributes into the toolbar at the given position. @@ -677,7 +693,7 @@ and not the eventual size of the tool button. \membersection{wxToolBar::SetToolClientData}\label{wxtoolbarsettoolclientdata} -\func{void}{GetToolClientData}{\param{wxObject* }{clientData}} +\func{void}{SetToolClientData}{\param{int }{id}, \param{wxObject* }{clientData}} Sets the client data associated with the tool. @@ -774,5 +790,3 @@ Only applies to a tool that has been specified as a toggle tool. \wxheading{See also} \helpref{wxToolBar::GetToolState}{wxtoolbargettoolstate} - -