Consistent wxWindow::Enable with wxRadioBox::Enable for control and its items. wxRadi...

[wxWidgets.git] / docs / latex / wx / toolbar.tex

diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex
index cab5e1990836438f49c2f850e86b7cad4e5b57e3..f9ed017eba3f170629c3316c9984194e8b415e5c 100644 (file)
--- a/docs/latex/wx/toolbar.tex
+++ b/docs/latex/wx/toolbar.tex
@@ -25,7 +25,7 @@ wxToolBarBase\\
 
 \wxheading{Include files}
 
 
 \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)\\
 <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,7 +41,29 @@ 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.
 
 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}
 
 
 \wxheading{Window styles}
 


@@ -51,12 +73,11 @@ of a "separator" is a vertical line under Windows95 vs. simple space under GTK e
 \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\_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\_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 (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\_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
+\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}
 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}


@@ -67,30 +88,22 @@ native toolbar ignores {\tt wxTB\_NOICONS} style. Also, toggling the
 
 \wxheading{Event handling}
 
 
 \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
 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.
 
 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
 \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\_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
 \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


@@ -126,11 +139,11 @@ Constructs a toolbar.
 
 \docparam{id}{Window identifier. If -1, will automatically create an identifier.}
 
 
 \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.}
 
 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.}
 should generate a default size for the window.}
 
 \docparam{style}{Window style. See \helpref{wxToolBar}{wxtoolbar} for details.}


@@ -147,7 +160,7 @@ tools.
 You may also create a toolbar that is managed by the frame, by
 calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
 
 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}
 
 
 \func{void}{\destruct{wxToolBar}}{\void}
 


@@ -173,13 +186,13 @@ Adds a separator for spacing groups of tools.
 
 \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
 
 
 \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
 

-\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp
+\func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\rtfsp

 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{wxItemKind}{ kind = wxITEM\_NORMAL}}
 
 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{wxItemKind}{ kind = wxITEM\_NORMAL}}
 

-\func{wxToolBarTool*}{AddTool}{\param{int}{ toolId},\rtfsp
+\func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\rtfsp

 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap},\rtfsp
 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2 = wxNullBitmap},\rtfsp


@@ -188,7 +201,7 @@ Adds a separator for spacing groups of tools.
 \param{const wxString\& }{longHelpString = ""},\rtfsp
 \param{wxObject* }{clientData = NULL}}
 
 \param{const wxString\& }{longHelpString = ""},\rtfsp
 \param{wxObject* }{clientData = NULL}}
 

-\func{wxToolBarTool*}{AddTool}{\param{wxToolBarTool* }{tool}}
+\func{wxToolBarToolBase*}{AddTool}{\param{wxToolBarToolBase* }{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
 
 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


@@ -240,7 +253,7 @@ order to have the tools appear.
 
 \membersection{wxToolBar::AddCheckTool}\label{wxtoolbaraddchecktool}
 
 
 \membersection{wxToolBar::AddCheckTool}\label{wxtoolbaraddchecktool}
 

-\func{wxToolBarTool*}{AddCheckTool}{\param{int}{ toolId},\rtfsp
+\func{wxToolBarToolBase*}{AddCheckTool}{\param{int}{ toolId},\rtfsp

 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2},\rtfsp
 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2},\rtfsp


@@ -257,7 +270,7 @@ as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.
 
 \membersection{wxToolBar::AddRadioTool}\label{wxtoolbaraddradiotool}
 
 
 \membersection{wxToolBar::AddRadioTool}\label{wxtoolbaraddradiotool}
 

-\func{wxToolBarTool*}{AddRadioTool}{\param{int}{ toolId},\rtfsp
+\func{wxToolBarToolBase*}{AddRadioTool}{\param{int}{ toolId},\rtfsp

 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2},\rtfsp
 \param{const wxString\&}{ label},\rtfsp
 \param{const wxBitmap\&}{ bitmap1},\rtfsp
 \param{const wxBitmap\&}{ bitmap2},\rtfsp


@@ -327,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}
 
 \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.
+

 \membersection{wxToolBar::FindControl}\label{wxtoolbarfindcontrol}
 
 \func{wxControl*}{FindControl}{\param{int }{id}}
 \membersection{wxToolBar::FindControl}\label{wxtoolbarfindcontrol}
 
 \func{wxControl*}{FindControl}{\param{int }{id}}


@@ -336,7 +356,7 @@ NULL if no corresponding control is found.
 
 \membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}
 
 
 \membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}
 

-\constfunc{wxToolBarTool*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}
+\constfunc{wxToolBarToolBase*}{FindToolForPosition}{\param{const float}{ x}, \param{const float}{ y}}

 
 Finds a tool for the given mouse position.
 
 
 Finds a tool for the given mouse position.
 


@@ -453,7 +473,7 @@ Returns the value used for packing tools.
 
 \constfunc{int}{GetToolPos}{\param{int }{toolId}}
 
 
 \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}
 
 
 \membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation}
 


@@ -500,7 +520,7 @@ true if the tool is toggled on, false otherwise.
 
 \membersection{wxToolBar::InsertControl}\label{wxtoolbarinsertcontrol}
 
 
 \membersection{wxToolBar::InsertControl}\label{wxtoolbarinsertcontrol}
 

-\func{wxToolBarTool *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}
+\func{wxToolBarToolBase *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}

 
 Inserts the control into the toolbar at the given position.
 
 
 Inserts the control into the toolbar at the given position.
 


@@ -513,7 +533,7 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
 
 \membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator}
 
 
 \membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator}
 

-\func{wxToolBarTool *}{InsertSeparator}{\param{size\_t }{pos}}
+\func{wxToolBarToolBase *}{InsertSeparator}{\param{size\_t }{pos}}

 
 Inserts the separator into the toolbar at the given position.
 
 
 Inserts the separator into the toolbar at the given position.
 


@@ -526,13 +546,13 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
 
 \membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
 
 
 \membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
 

-\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
+\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{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 = ""}}
 

-\func{wxToolBarTool *}{InsertTool}{\param{size\_t }{pos},\rtfsp
-\param{wxToolBarTool* }{tool}}
+\func{wxToolBarToolBase *}{InsertTool}{\param{size\_t }{pos},\rtfsp
+\param{wxToolBarToolBase* }{tool}}

 
 Inserts the tool with the specified attributes into the toolbar at the given
 position.
 
 Inserts the tool with the specified attributes into the toolbar at the given
 position.


@@ -590,7 +610,7 @@ such as a short description on the status line.}
 
 \wxheading{Remarks}
 
 
 \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}
 detect it. Therefore this function may not always be called when expected.
 
 \membersection{wxToolBar::OnRightClick}\label{wxtoolbaronrightclick}


@@ -626,12 +646,9 @@ A typical use of this member might be to pop up a menu.
 
 This function should be called after you have added tools.
 
 
 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}
 
 \membersection{wxToolBar::RemoveTool}\label{wxtoolbarremovetool}
 

-\func{wxToolBarTool *}{RemoveTool}{\param{int }{id}}
+\func{wxToolBarToolBase *}{RemoveTool}{\param{int }{id}}

 
 Removes the given tool from the toolbar but doesn't delete it. This allows to
 insert/add this tool back to this (or another) toolbar later.
 
 Removes the given tool from the toolbar but doesn't delete it. This allows to
 insert/add this tool back to this (or another) toolbar later.


@@ -790,3 +807,4 @@ Only applies to a tool that has been specified as a toggle tool.
 \wxheading{See also}
 
 \helpref{wxToolBar::GetToolState}{wxtoolbargettoolstate}
 \wxheading{See also}
 
 \helpref{wxToolBar::GetToolState}{wxtoolbargettoolstate}

+