mention that SetItemToolTip() is for wxMSW and wxGTK2 only

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

diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex
index ea7abe14f88cb677e401770936938bb28719aa4d..6ec2b91e408b962daaa8b6620c567e63ac59f37d 100644 (file)
--- a/docs/latex/wx/toolbar.tex
+++ b/docs/latex/wx/toolbar.tex
@@ -8,10 +8,6 @@ The name wxToolBar is defined to be a synonym for one of the following classes:
 \item {\bf wxToolBarGTK} The GTK toolbar.
 \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.
-
 \wxheading{Derived from}
 
 wxToolBarBase\\
@@ -23,19 +19,18 @@ wxToolBarBase\\
 \wxheading{Include files}
 
 <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)
 
 \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 \arg{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
@@ -115,6 +110,7 @@ Pass the id of the toolbar itself. The value of wxCommandEvent::GetSelection is
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxToolBar::wxToolBar}\label{wxtoolbarconstr}
 
 \func{}{wxToolBar}{\void}
@@ -156,12 +152,14 @@ tools.
 You may also create a toolbar that is managed by the frame, by
 calling \helpref{wxFrame::CreateToolBar}{wxframecreatetoolbar}.
 
+
 \membersection{wxToolBar::\destruct{wxToolBar}}\label{wxtoolbardtor}
 
 \func{void}{\destruct{wxToolBar}}{\void}
 
 Toolbar destructor.
 
+
 \membersection{wxToolBar::AddControl}\label{wxtoolbaraddcontrol}
 
 \func{bool}{AddControl}{\param{wxControl*}{ control}}
@@ -170,6 +168,7 @@ Adds any control to the toolbar, typically e.g. a combobox.
 
 \docparam{control}{The control to be added.}
 
+
 \membersection{wxToolBar::AddSeparator}\label{wxtoolbaraddseparator}
 
 \func{void}{AddSeparator}{\void}
@@ -180,6 +179,7 @@ Adds a separator for spacing groups of tools.
 
 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}, \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
 
+
 \membersection{wxToolBar::AddTool}\label{wxtoolbaraddtool}
 
 \func{wxToolBarToolBase*}{AddTool}{\param{int}{ toolId},\rtfsp
@@ -195,7 +195,7 @@ Adds a separator for spacing groups of tools.
 \param{wxItemKind}{ kind = wxITEM\_NORMAL},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},
 \param{const wxString\& }{longHelpString = ""},\rtfsp
-\param{wxObject* }{clientData = NULL}}
+\param{wxObject* }{clientData = \NULL}}
 
 \func{wxToolBarToolBase*}{AddTool}{\param{wxToolBarToolBase* }{tool}}
 
@@ -215,13 +215,11 @@ toggled) or wxITEM\_RADIO for a checkable tool which makes part of a radio
 group of tools each of which is automatically unchecked whenever another button
 in the group is checked}
 
-\docparam{bitmap1}{The primary tool bitmap for toggle and button tools.}
+\docparam{bitmap1}{The primary tool bitmap.}
 
-\docparam{bitmap2}{The second bitmap specifies the on-state bitmap for a toggle
-tool. If this is wxNullBitmap, either an inverted version of the primary bitmap is
-used for the on-state of a toggle tool (monochrome displays) or a black
-border is drawn around the tool (colour displays) or the pixmap is shown
-as a pressed button (GTK). }
+\docparam{bitmap2}{The bitmap used when the tool is disabled. If it is equal to
+wxNullBitmap, the disabled bitmap is automatically generated by greing the
+normal one.}
 
 \docparam{shortHelpString}{This string is used for the tools tooltip}
 
@@ -247,6 +245,7 @@ order to have the tools appear.
 \helpref{wxToolBar::DeleteTool}{wxtoolbardeletetool},\rtfsp
 \helpref{wxToolBar::Realize}{wxtoolbarrealize}
 
+
 \membersection{wxToolBar::AddCheckTool}\label{wxtoolbaraddchecktool}
 
 \func{wxToolBarToolBase*}{AddCheckTool}{\param{int}{ toolId},\rtfsp
@@ -255,7 +254,7 @@ order to have the tools appear.
 \param{const wxBitmap\&}{ bitmap2},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{const wxString\& }{longHelpString = ""},\rtfsp
-\param{wxObject* }{clientData = NULL}}
+\param{wxObject* }{clientData = \NULL}}
 
 Adds a new check (or toggle) tool to the toolbar. The parameters are the same
 as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.
@@ -264,6 +263,7 @@ as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.
 
 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
 
+
 \membersection{wxToolBar::AddRadioTool}\label{wxtoolbaraddradiotool}
 
 \func{wxToolBarToolBase*}{AddRadioTool}{\param{int}{ toolId},\rtfsp
@@ -272,7 +272,7 @@ as in \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}.
 \param{const wxBitmap\&}{ bitmap2},\rtfsp
 \param{const wxString\& }{shortHelpString = ""},\rtfsp
 \param{const wxString\& }{longHelpString = ""},\rtfsp
-\param{wxObject* }{clientData = NULL}}
+\param{wxObject* }{clientData = \NULL}}
 
 Adds a new radio tool to the toolbar. Consecutive radio tools form a radio
 group such that exactly one button in the group is pressed at any moment, in
@@ -287,6 +287,7 @@ others are not.
 
 \helpref{wxToolBar::AddTool}{wxtoolbaraddtool}
 
+
 \membersection{wxToolBar::DeleteTool}\label{wxtoolbardeletetool}
 
 \func{bool}{DeleteTool}{\param{int }{toolId}}
@@ -304,6 +305,7 @@ Returns true if the tool was deleted, false otherwise.
 
 \helpref{DeleteToolByPos}{wxtoolbardeletetoolbypos}
 
+
 \membersection{wxToolBar::DeleteToolByPos}\label{wxtoolbardeletetoolbypos}
 
 \func{bool}{DeleteToolByPos}{\param{size\_t }{pos}}
@@ -311,6 +313,7 @@ Returns true if the tool was deleted, false otherwise.
 This function behaves like \helpref{DeleteTool}{wxtoolbardeletetool} but it
 deletes the tool at the specified position and not the one with the given id.
 
+
 \membersection{wxToolBar::EnableTool}\label{wxtoolbarenabletool}
 
 \func{void}{EnableTool}{\param{int }{toolId}, \param{const bool}{ enable}}
@@ -335,19 +338,22 @@ Some implementations will change the visible state of the tool to indicate that
 \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.
+Returns a pointer to the tool identified by \arg{id} or
+\NULL if no corresponding tool is found.
+
 
 \membersection{wxToolBar::FindControl}\label{wxtoolbarfindcontrol}
 
 \func{wxControl*}{FindControl}{\param{int }{id}}
 
-Returns a pointer to the control identified by {\it id} or
-NULL if no corresponding control is found.
+Returns a pointer to the control identified by \arg{id} or 
+\NULL if no corresponding control is found.
+
 
 \membersection{wxToolBar::FindToolForPosition}\label{wxtoolbarfindtoolforposition}
 
@@ -363,11 +369,12 @@ Finds a tool for the given mouse position.
 
 \wxheading{Return value}
 
-A pointer to a tool if a tool is found, or NULL otherwise.
+A pointer to a tool if a tool is found, or \NULL otherwise.
 
 \wxheading{Remarks}
 
-Used internally, and should not need to be used by the programmer.
+Currently not implemented in wxGTK (always returns \NULL there).
+
 
 \membersection{wxToolBar::GetToolSize}\label{wxtoolbargettoolsize}
 
@@ -381,6 +388,7 @@ of added 3D effects.
 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize}
 
+
 \membersection{wxToolBar::GetToolBitmapSize}\label{wxtoolbargettoolbitmapsize}
 
 \func{wxSize}{GetToolBitmapSize}{\void}
@@ -397,6 +405,7 @@ and not the eventual size of the tool button.
 \helpref{wxToolBar::SetToolBitmapSize}{wxtoolbarsettoolbitmapsize},\rtfsp
 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
 
+
 \membersection{wxToolBar::GetMargins}\label{wxtoolbargetmargins}
 
 \constfunc{wxSize}{GetMargins}{\void}
@@ -407,6 +416,7 @@ Returns the left/right and top/bottom margins, which are also used for inter-too
 
 \helpref{wxToolBar::SetMargins}{wxtoolbarsetmargins}
 
+
 \membersection{wxToolBar::GetToolClientData}\label{wxtoolbargettoolclientdata}
 
 \constfunc{wxObject*}{GetToolClientData}{\param{int }{toolId}}
@@ -419,7 +429,8 @@ Get any client data associated with the tool.
 
 \wxheading{Return value}
 
-Client data, or NULL if there is none.
+Client data, or \NULL if there is none.
+
 
 \membersection{wxToolBar::GetToolEnabled}\label{wxtoolbargettoolenabled}
 
@@ -439,6 +450,7 @@ true if the tool is enabled, false otherwise.
 
 \helpref{wxToolBar::EnableTool}{wxtoolbarenabletool}
 
+
 \membersection{wxToolBar::GetToolLongHelp}\label{wxtoolbargettoollonghelp}
 
 \constfunc{wxString}{GetToolLongHelp}{\param{int }{toolId}}
@@ -454,6 +466,7 @@ Returns the long help for the given tool.
 \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp},\rtfsp
 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
 
+
 \membersection{wxToolBar::GetToolPacking}\label{wxtoolbargettoolpacking}
 
 \constfunc{int}{GetToolPacking}{\void}
@@ -464,12 +477,14 @@ 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 {\tt wxNOT\_FOUND} if the tool is not found.
 
+
 \membersection{wxToolBar::GetToolSeparation}\label{wxtoolbargettoolseparation}
 
 \constfunc{int}{GetToolSeparation}{\void}
@@ -480,6 +495,7 @@ Returns the default separator size.
 
 \helpref{wxToolBar::SetToolSeparation}{wxtoolbarsettoolseparation}
 
+
 \membersection{wxToolBar::GetToolShortHelp}\label{wxtoolbargettoolshorthelp}
 
 \constfunc{wxString}{GetToolShortHelp}{\param{int }{toolId}}
@@ -495,6 +511,7 @@ Returns the short help for the given tool.
 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp}\rtfsp
 
+
 \membersection{wxToolBar::GetToolState}\label{wxtoolbargettoolstate}
 
 \constfunc{bool}{GetToolState}{\param{int }{toolId}}
@@ -513,6 +530,7 @@ true if the tool is toggled on, false otherwise.
 
 \helpref{wxToolBar::ToggleTool}{wxtoolbartoggletool}
 
+
 \membersection{wxToolBar::InsertControl}\label{wxtoolbarinsertcontrol}
 
 \func{wxToolBarToolBase *}{InsertControl}{\param{size\_t }{pos}, \param{wxControl *}{control}}
@@ -526,6 +544,7 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
 \helpref{AddControl}{wxtoolbaraddcontrol},\\
 \helpref{InsertTool}{wxtoolbarinserttool}
 
+
 \membersection{wxToolBar::InsertSeparator}\label{wxtoolbarinsertseparator}
 
 \func{wxToolBarToolBase *}{InsertSeparator}{\param{size\_t }{pos}}
@@ -539,12 +558,13 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
 \helpref{AddSeparator}{wxtoolbaraddseparator},\\
 \helpref{InsertTool}{wxtoolbarinserttool}
 
+
 \membersection{wxToolBar::InsertTool}\label{wxtoolbarinserttool}
 
 \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{wxObject* }{clientData = \NULL}, \param{const wxString\& }{shortHelpString = ""}, \param{const wxString\& }{longHelpString = ""}}
 
 \func{wxToolBarToolBase *}{InsertTool}{\param{size\_t }{pos},\rtfsp
 \param{wxToolBarToolBase* }{tool}}
@@ -560,6 +580,7 @@ You must call \helpref{Realize}{wxtoolbarrealize} for the change to take place.
 \helpref{InsertControl}{wxtoolbarinsertcontrol},\\
 \helpref{InsertSeparator}{wxtoolbarinsertseparator}
 
+
 \membersection{wxToolBar::OnLeftClick}\label{wxtoolbaronleftclick}
 
 \func{bool}{OnLeftClick}{\param{int}{ toolId}, \param{bool}{ toggleDown}}
@@ -586,6 +607,7 @@ specifying that toggle operations are not permitted in some circumstances.
 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
 \helpref{wxToolBar::OnRightClick}{wxtoolbaronrightclick}
 
+
 \membersection{wxToolBar::OnMouseEnter}\label{wxtoolbaronmouseenter}
 
 \func{void}{OnMouseEnter}{\param{int}{ toolId}}
@@ -608,6 +630,7 @@ such as a short description on the status line.}
 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}
 
 \func{void}{OnRightClick}{\param{int}{ toolId}, \param{float}{ x}, \param{float}{ y}}
@@ -635,12 +658,14 @@ A typical use of this member might be to pop up a menu.
 \helpref{wxToolBar::OnMouseEnter}{wxtoolbaronmouseenter},\rtfsp
 \helpref{wxToolBar::OnLeftClick}{wxtoolbaronleftclick}
 
+
 \membersection{wxToolBar::Realize}\label{wxtoolbarrealize}
 
 \func{bool}{Realize}{\void}
 
 This function should be called after you have added tools.
 
+
 \membersection{wxToolBar::RemoveTool}\label{wxtoolbarremovetool}
 
 \func{wxToolBarToolBase *}{RemoveTool}{\param{int }{id}}
@@ -655,6 +680,7 @@ change to take place, it will happen immediately.
 
 \helpref{DeleteTool}{wxtoolbardeletetool}
 
+
 \membersection{wxToolBar::SetBitmapResource}\label{wxtoolbarsetbitmapresource}
 
 \func{void}{SetBitmapResource}{\param{int }{resourceId}}
@@ -662,6 +688,7 @@ change to take place, it will happen immediately.
 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}}
@@ -687,6 +714,7 @@ default (zero-size) margins are to be overridden.
 
 \helpref{wxToolBar::GetMargins}{wxtoolbargetmargins}, \helpref{wxSize}{wxsize}
 
+
 \membersection{wxToolBar::SetToolBitmapSize}\label{wxtoolbarsettoolbitmapsize}
 
 \func{void}{SetToolBitmapSize}{\param{const wxSize\&}{ size}}
@@ -710,12 +738,14 @@ and not the eventual size of the tool button.
 \helpref{wxToolBar::GetToolBitmapSize}{wxtoolbargettoolbitmapsize},\rtfsp
 \helpref{wxToolBar::GetToolSize}{wxtoolbargettoolsize}
 
+
 \membersection{wxToolBar::SetToolClientData}\label{wxtoolbarsettoolclientdata}
 
 \func{void}{SetToolClientData}{\param{int }{id}, \param{wxObject* }{clientData}}
 
 Sets the client data associated with the tool.
 
+
 \membersection{wxToolBar::SetToolLongHelp}\label{wxtoolbarsettoollonghelp}
 
 \func{void}{SetToolLongHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}
@@ -737,6 +767,7 @@ You might use the long help for displaying the tool purpose on the status line.
 \helpref{wxToolBar::GetToolLongHelp}{wxtoolbargettoollonghelp},\rtfsp
 \helpref{wxToolBar::SetToolShortHelp}{wxtoolbarsettoolshorthelp},\rtfsp
 
+
 \membersection{wxToolBar::SetToolPacking}\label{wxtoolbarsettoolpacking}
 
 \func{void}{SetToolPacking}{\param{int}{ packing}}
@@ -756,6 +787,7 @@ and for spacing in the horizontal direction if the toolbar is vertical.
 
 \helpref{wxToolBar::GetToolPacking}{wxtoolbargettoolpacking}
 
+
 \membersection{wxToolBar::SetToolShortHelp}\label{wxtoolbarsettoolshorthelp}
 
 \func{void}{SetToolShortHelp}{\param{int }{toolId}, \param{const wxString\& }{helpString}}
@@ -776,6 +808,7 @@ An application might use short help for identifying the tool purpose in a toolti
 
 \helpref{wxToolBar::GetToolShortHelp}{wxtoolbargettoolshorthelp}, \helpref{wxToolBar::SetToolLongHelp}{wxtoolbarsettoollonghelp}
 
+
 \membersection{wxToolBar::SetToolSeparation}\label{wxtoolbarsettoolseparation}
 
 \func{void}{SetToolSeparation}{\param{int}{ separation}}
@@ -790,6 +823,7 @@ Sets the default separator size. The default value is 5.
 
 \helpref{wxToolBar::AddSeparator}{wxtoolbaraddseparator}
 
+
 \membersection{wxToolBar::ToggleTool}\label{wxtoolbartoggletool}
 
 \func{void}{ToggleTool}{\param{int }{toolId}, \param{const bool}{ toggle}}