X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/e6c96a7ca418179cee6b1418bd9c59be641d5456..265accbe551ec481a3270b220933a0e99596fb7c:/docs/latex/wx/toolbar.tex

diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex
index 48de0b04a7..974007cf09 100644
--- a/docs/latex/wx/toolbar.tex
+++ b/docs/latex/wx/toolbar.tex
@@ -25,7 +25,7 @@ wxToolBarBase\\
 
 \wxheading{Include files}
 
-<wx/toolbar.h> (to allow wxWindows to select an appropriate toolbar class)\\
+<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)\\
@@ -41,22 +41,45 @@ often have to be made in order to get optimal look on all platforms as some plat
 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.
 
-{\bf wxToolBar95:} Note that this toolbar paints tools to reflect user-selected colours.
+{\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
+this behaviour, otherwise system colours in your bitmaps will inadvertently be
+mapped to system colours. To do this, set the {\tt msw.remap} system option
+before creating the toolbar:
+
+\begin{verbatim}
+  wxSystemOptions::SetOption(wxT("msw.remap"), 0);
+\end{verbatim}
+
+If you wish to use 32-bit images (which include an alpha channel for transparency)
+use:
+
+\begin{verbatim}
+  wxSystemOptions::SetOption(wxT("msw.remap"), 2);
+\end{verbatim}
+
+then colour remapping is switched off, and a transparent background used. But only
+use this option under Windows XP with true colour:
+
+\begin{verbatim}
+  (wxTheApp->GetComCtl32Version() >= 600 && ::wxDisplayDepth() >= 32)
+\end{verbatim}
 
 \wxheading{Window styles}
 
 \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\_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\_TEXT}}{Shows 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}}{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.}
 \end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}. Note that the Win32
@@ -65,30 +88,22 @@ native toolbar ignores {\tt wxTB\_NOICONS} style. Also, toggling the
 
 \wxheading{Event handling}
 
-The toolbar class emits menu commands in the same was that a frame menubar does,
+The toolbar class emits menu commands in the same way that a frame menubar does,
 so you can use one EVT\_MENU macro for both a menu item and a toolbar button.
 The event handler functions take a wxCommandEvent argument. For most event macros,
 the identifier of the tool is passed, but for EVT\_TOOL\_ENTER the toolbar
-window is passed and the tool id is retrieved from the wxCommandEvent.
-This is because the id may be -1 when the mouse moves off a tool, and -1 is not
+window identifier is passed and the tool identifier is retrieved from the wxCommandEvent.
+This is because the identifier may be -1 when the mouse moves off a tool, and -1 is not
 allowed as an identifier in the event system.
 
-Note that tool commands (and UI update events for tools) are first sent to
-the focus window within the frame that contains the toolbar. If no window within the frame has the focus,
-then the events are sent directly to the toolbar (and up the hierarchy to the
-frame, depending on where the application has put its event handlers). This allows command and UI update
-handling to be processed by specific windows and controls, and not necessarily
-by the application frame.
-
 \twocolwidtha{7cm}
 \begin{twocollist}\itemsep=0pt
 \twocolitem{{\bf EVT\_TOOL(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
 (a synonym for wxEVT\_COMMAND\_MENU\_SELECTED). Pass the id of the tool.}
 \twocolitem{{\bf EVT\_MENU(id, func)}}{The same as EVT\_TOOL.}
 \twocolitem{{\bf EVT\_TOOL\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_CLICKED event
-for a range id identifiers. Pass the ids of the tools.}
+for a range of identifiers. Pass the ids of the tools.}
 \twocolitem{{\bf EVT\_MENU\_RANGE(id1, id2, func)}}{The same as EVT\_TOOL\_RANGE.}
-
 \twocolitem{{\bf EVT\_TOOL\_RCLICKED(id, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event.
 Pass the id of the tool.}
 \twocolitem{{\bf EVT\_TOOL\_RCLICKED\_RANGE(id1, id2, func)}}{Process a wxEVT\_COMMAND\_TOOL\_RCLICKED event
@@ -124,11 +139,11 @@ Constructs a toolbar.
 
 \docparam{id}{Window identifier. If -1, will automatically create an identifier.}
 
-\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWindows
+\docparam{pos}{Window position. wxDefaultPosition is (-1, -1) which indicates that wxWidgets
 should generate a default position for the window. If using the wxWindow class directly, supply
 an actual position.}
 
-\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWindows
+\docparam{size}{Window size. wxDefaultSize is (-1, -1) which indicates that wxWidgets
 should generate a default size for the window.}
 
 \docparam{style}{Window style. See \helpref{wxToolBar}{wxtoolbar} for details.}
@@ -145,7 +160,7 @@ tools.
 You may also create a toolbar that is managed by the frame, by
 calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
 
-\membersection{wxToolBar::\destruct{wxToolBar}}
+\membersection{wxToolBar::\destruct{wxToolBar}}\label{wxtoolbardtor}
 
 \func{void}{\destruct{wxToolBar}}{\void}
 
@@ -325,6 +340,13 @@ will change the visible state of the tool to indicate that it is disabled.
 \helpref{wxToolBar::GetToolEnabled}{wxtoolbargettoolenabled},\rtfsp
 \helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
 
+\membersection{wxToolBar::FindById}\label{wxtoolbarfindbyid}
+
+\func{wxToolBarTool*}{FindById}{\param{int }{id}}
+
+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}}
@@ -451,7 +473,7 @@ Returns the value used for packing tools.
 
 \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}
 
@@ -588,7 +610,7 @@ such as a short description on the status line.}
 
 \wxheading{Remarks}
 
-With some derived toolbar classes, if the mouse moves quickly out of the toolbar, wxWindows may not be able to
+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}
@@ -624,9 +646,6 @@ A typical use of this member might be to pop up a menu.
 
 This function should be called after you have added tools.
 
-If you are using absolute positions for your tools when using a wxToolBarSimple object,
-do not call this function. You must call it at all other times.
-
 \membersection{wxToolBar::RemoveTool}\label{wxtoolbarremovetool}
 
 \func{wxToolBarTool *}{RemoveTool}{\param{int }{id}}
@@ -788,3 +807,4 @@ Only applies to a tool that has been specified as a toggle tool.
 \wxheading{See also}
 
 \helpref{wxToolBar::GetToolState}{wxtoolbargettoolstate}
+
