MF_BYCOMMAND is zero so don't try to test it

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

diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex
index 5be98e077a11ea2ea9fcf38a1b82042f179321c3..c6d63f58ff036a31516acecd213bf043db7d988e 100644 (file)
--- a/docs/latex/wx/toolbar.tex
+++ b/docs/latex/wx/toolbar.tex
@@ -6,14 +6,11 @@ The name wxToolBar is defined to be a synonym for one of the following classes:
 \item {\bf wxToolBar95} The native Windows 95 toolbar. Used on Windows 95, NT 4 and above.
 \item {\bf wxToolBarMSW} A Windows implementation. Used on 16-bit Windows.
 \item {\bf wxToolBarGTK} The GTK toolbar.
 \item {\bf wxToolBar95} The native Windows 95 toolbar. Used on Windows 95, NT 4 and above.
 \item {\bf wxToolBarMSW} A Windows implementation. Used on 16-bit Windows.
 \item {\bf wxToolBarGTK} The GTK toolbar.

-\item {\bf wxToolBarSimple} A simple implementation, with scrolling.
-Used on platforms with no native toolbar control, or where scrolling is required.

 \end{itemize}
 
 Note that the base class {\bf wxToolBarBase} defines
 automatic scrolling management functionality which is similar
 to \helpref{wxScrolledWindow}{wxscrolledwindow}, so please refer to this class also.
 \end{itemize}
 
 Note that the base class {\bf wxToolBarBase} defines
 automatic scrolling management functionality which is similar
 to \helpref{wxScrolledWindow}{wxscrolledwindow}, so please refer to this class also.

-Not all toolbars support scrolling, but wxToolBarSimple does.

 
 \wxheading{Derived from}
 
 
 \wxheading{Derived from}
 


@@ -25,21 +22,19 @@ wxToolBarBase\\
 
 \wxheading{Include files}
 
 
 \wxheading{Include files}
 

-<wx/toolbar.h> (to allow wxWindows 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/tbarsmpl.h> (the generic simple toolbar class)
+<wx/toolbar.h> (to allow wxWidgets to select an appropriate toolbar class)\\
+<wx/tbarbase.h> (the base class)

 
 \wxheading{Remarks}
 
 You may also create a toolbar that is managed by the frame, by
 
 \wxheading{Remarks}
 
 You may also create a toolbar that is managed by the frame, by

-calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
+calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}. Under Pocket PC,
+you should {\it always} use this function for creating the toolbar
+to be managed by the frame, so that wxWidgets can use a combined
+menubar and toolbar. Where you manage your own toolbars, create a wxToolBar
+as usual.

 
 

-Due to the use of native toolbars on the various platforms, certain adaptions will
-often have to be made in order to get optimal look on all platforms as some platforms
-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.
+The meaning of a "separator" is a vertical line under Windows and simple space under GTK+.

 
 {\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
 
 {\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


@@ -51,6 +46,20 @@ before creating the toolbar:
   wxSystemOptions::SetOption(wxT("msw.remap"), 0);
 \end{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}
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}


@@ -74,7 +83,7 @@ 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


@@ -125,11 +134,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.}


@@ -146,7 +155,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}
 


@@ -172,13 +181,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


@@ -187,12 +196,12 @@ 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
 specify some of the more rarely used button features. The last version allows
 
 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. The last version allows

-to add an existing tool.
+you to add an existing tool.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -239,7 +248,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


@@ -256,7 +265,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


@@ -318,8 +327,7 @@ Enables or disables the tool.
 
 \wxheading{Remarks}
 
 
 \wxheading{Remarks}
 

-For wxToolBarSimple, does nothing. Some other implementations
-will change the visible state of the tool to indicate that it is disabled.
+Some implementations will change the visible state of the tool to indicate that it is disabled.

 
 \wxheading{See also}
 
 
 \wxheading{See also}
 


@@ -328,7 +336,7 @@ will change the visible state of the tool to indicate that it is disabled.
 
 \membersection{wxToolBar::FindById}\label{wxtoolbarfindbyid}
 
 
 \membersection{wxToolBar::FindById}\label{wxtoolbarfindbyid}
 

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

 
 Returns a pointer to the tool identified by {\it id} or
 NULL if no corresponding tool is found.
 
 Returns a pointer to the tool identified by {\it id} or
 NULL if no corresponding tool is found.


@@ -342,7 +350,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.
 


@@ -459,7 +467,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}
 


@@ -506,7 +514,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.
 


@@ -519,7 +527,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.
 


@@ -532,13 +540,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.


@@ -596,7 +604,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}


@@ -634,7 +642,7 @@ This function should be called after you have added tools.
 
 \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.


@@ -646,6 +654,13 @@ change to take place, it will happen immediately.
 
 \helpref{DeleteTool}{wxtoolbardeletetool}
 
 
 \helpref{DeleteTool}{wxtoolbardeletetool}
 

+\membersection{wxToolBar::SetBitmapResource}\label{wxtoolbarsetbitmapresource}
+
+\func{void}{SetBitmapResource}{\param{int }{resourceId}}
+
+Sets the bitmap resource identifier for specifying tool bitmaps as indices
+into a custom bitmap. Windows CE only.
+

 \membersection{wxToolBar::SetMargins}\label{wxtoolbarsetmargins}
 
 \func{void}{SetMargins}{\param{const wxSize\&}{ size}}
 \membersection{wxToolBar::SetMargins}\label{wxtoolbarsetmargins}
 
 \func{void}{SetMargins}{\param{const wxSize\&}{ size}}