X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/f89a1397df5061fb3be31c855d79641e42164c6d..2f7b6734e447a4f4e3634118ab6d69356eff3cc1:/docs/latex/wx/toolbar.tex diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex index 6b1ddc01d0..0fe30b435e 100644 --- a/docs/latex/wx/toolbar.tex +++ b/docs/latex/wx/toolbar.tex @@ -47,16 +47,29 @@ 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\_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\_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 (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 +199,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 +233,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 @@ -282,7 +300,7 @@ back later), you may use \helpref{RemoveTool}{wxtoolbarremovetool} instead. Note that it is unnecessary to call \helpref{Realize}{wxtoolbarrealize} for the change to take place, it will happen immediately. -Returns TRUE if the tool was deleted, FALSE otherwise. +Returns true if the tool was deleted, false otherwise. \wxheading{See also} @@ -305,7 +323,7 @@ Enables or disables the tool. \docparam{toolId}{Tool to enable or disable.} -\docparam{enable}{If TRUE, enables the tool, otherwise disables it.} +\docparam{enable}{If true, enables the tool, otherwise disables it.} {\bf NB:} This function should only be called after \helpref{Realize}{wxtoolbarrealize}. @@ -411,7 +429,7 @@ Called to determine whether a tool is enabled (responds to user input). \wxheading{Return value} -TRUE if the tool is enabled, FALSE otherwise. +true if the tool is enabled, false otherwise. \wxheading{See also} @@ -442,6 +460,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} @@ -479,7 +503,7 @@ Gets the on/off state of a toggle tool. \wxheading{Return value} -TRUE if the tool is toggled on, FALSE otherwise. +true if the tool is toggled on, false otherwise. \wxheading{See also} @@ -515,9 +539,12 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place. \func{wxToolBarTool *}{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{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. @@ -542,11 +569,11 @@ you should use the EVT\_MENU or EVT\_TOOL macro instead. \docparam{toolId}{The identifier passed to \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.} -\docparam{toggleDown}{TRUE if the tool is a toggle and the toggle is down, otherwise is FALSE.} +\docparam{toggleDown}{true if the tool is a toggle and the toggle is down, otherwise is false.} \wxheading{Return value} -If the tool is a toggle and this function returns FALSE, the toggle +If the tool is a toggle and this function returns false, the toggle toggle state (internal and visual) will not be changed. This provides a way of specifying that toggle operations are not permitted in some circumstances. @@ -677,7 +704,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. @@ -765,7 +792,7 @@ Toggles a tool on or off. This does not cause any event to get emitted. \docparam{toolId}{Tool in question.} -\docparam{toggle}{If TRUE, toggles the tool on, otherwise toggles it off.} +\docparam{toggle}{If true, toggles the tool on, otherwise toggles it off.} \wxheading{Remarks} @@ -774,5 +801,3 @@ Only applies to a tool that has been specified as a toggle tool. \wxheading{See also} \helpref{wxToolBar::GetToolState}{wxtoolbargettoolstate} - -