added missing methods documentation (patch 1466949); also use \arg instead of \it

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

diff --git a/docs/latex/wx/toolbar.tex b/docs/latex/wx/toolbar.tex
index f9ed017eba3f170629c3316c9984194e8b415e5c..feaf15633294f4d468b548a7375c5e12da271f7a 100644 (file)
--- a/docs/latex/wx/toolbar.tex
+++ b/docs/latex/wx/toolbar.tex
@@ -6,15 +6,8 @@ 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 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.
-Not all toolbars support scrolling, but wxToolBarSimple does.
-
 \wxheading{Derived from}
 
 wxToolBarBase\\
@@ -26,20 +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/tbarsmpl.h> (the generic simple 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 {\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
@@ -206,7 +197,7 @@ Adds a separator for spacing groups of tools.
 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}
 
@@ -219,13 +210,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}
 
@@ -332,8 +321,7 @@ Enables or disables the tool.
 
 \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}
 
@@ -660,6 +648,13 @@ change to take place, it will happen immediately.
 
 \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}}