v2.2.1 TAGGED copy ported over to main trunk of CVS

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

diff --git a/docs/latex/wx/statusbr.tex b/docs/latex/wx/statusbr.tex
index 300038d76896412d55a614254c4d4176490f6b01..172178f3a078b7d2718f35ee93cda312beba0a77 100644 (file)
--- a/docs/latex/wx/statusbr.tex
+++ b/docs/latex/wx/statusbr.tex
@@ -8,9 +8,23 @@ be variable length according to the size of the window.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
+\wxheading{Derived from}
+
+\helpref{wxWindow}{wxwindow}\\
+\helpref{wxEvtHandler}{wxevthandler}\\
+\helpref{wxObject}{wxobject}
+
+\wxheading{Include files}
+
+<wx/statusbr.h>
+
 \wxheading{Window styles}
 
-There are no special styles for this window.
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxSB\_SIZEGRIP}}{On Windows 95, displays a gripper at right-hand side of
+the status bar.}
+\end{twocollist}
 
 See also \helpref{window styles overview}{windowstyles}.
 
@@ -21,7 +35,7 @@ from an {\bf OnSize} event handler.
 
 \wxheading{See also}
 
-\helpref{wxFrame}{wxframe}
+\helpref{wxFrame}{wxframe}, \helpref{Status bar sample}{samplestatbar}
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
@@ -31,7 +45,7 @@ from an {\bf OnSize} event handler.
 
 Default constructor.
 
-\func{}{wxStatusBar}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
+\func{}{wxStatusBar}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
 \param{const wxString\& }{name = ``statusBar"}}
@@ -68,7 +82,7 @@ Destructor.
 
 \membersection{wxStatusBar::Create}\label{wxstatusbarcreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID }{id},\rtfsp
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 \param{const wxPoint\&}{ pos = wxDefaultPosition},\rtfsp
 \param{const wxSize\&}{ size = wxDefaultSize}, \param{long}{ style = 0},\rtfsp
 \param{const wxString\& }{name = ``statusBar"}}
@@ -79,7 +93,7 @@ See \helpref{wxStatusBar::wxStatusBar}{wxstatusbarconstr} for details.
 
 \membersection{wxStatusBar::GetFieldRect}\label{wxstatusbargetfieldrect}
 
-\constfunc{virtual bool}{GetFieldRect}{\param{const int}{ i}, \param{wxRect\&}{ rect}}
+\constfunc{virtual bool}{GetFieldRect}{\param{int}{ i}, \param{wxRect\&}{ rect}}
 
 Returns the size and position of a fields internal bounding rectangle.
 
@@ -105,7 +119,7 @@ Returns the number of fields in the status bar.
 
 \membersection{wxStatusBar::GetStatusText}\label{wxstatusbargetstatustext}
 
-\constfunc{virtual wxString}{GetStatusText}{\param{const int}{ ir = 0}}
+\constfunc{virtual wxString}{GetStatusText}{\param{int}{ ir = 0}}
 
 Returns the string associated with a status bar field.
 
@@ -123,7 +137,7 @@ The status field string if the field is valid, otherwise the empty string.
 
 \membersection{wxStatusBar::DrawField}\label{wxstatusbardrawfield}
 
-\func{virtual void}{DrawField}{\param{wxDC\& }{dc}, \param{const int }{i}}
+\func{virtual void}{DrawField}{\param{wxDC\& }{dc}, \param{int }{i}}
 
 Draws a field, including shaded borders and text.
 
@@ -139,7 +153,7 @@ Draws a field, including shaded borders and text.
 
 \membersection{wxStatusBar::DrawFieldText}\label{wxstatusbardrawfieldtext}
 
-\func{virtual void}{DrawFieldText}{\param{wxDC\& }{dc}, \param{const int }{i}}
+\func{virtual void}{DrawFieldText}{\param{wxDC\& }{dc}, \param{int }{i}}
 
 Draws a field's text.
 
@@ -186,10 +200,13 @@ and refreshes the window.
 
 \membersection{wxStatusBar::SetFieldsCount}\label{wxstatusbarsetfieldscount}
 
-\func{virtual void}{SetFieldsCount}{\param{const int}{ number = 1}, \param{const int* }{widths = NULL}}
+\func{virtual void}{SetFieldsCount}{\param{int}{ number = 1}, \param{int* }{widths = NULL}}
 
 Sets the number of fields, and optionally the field widths.
 
+\pythonnote{Only the first parameter is accepted.  Use SetStatusWidths
+to set the widths of the fields.}
+
 \wxheading{Parameters}
 
 \docparam{number}{The number of fields.}
@@ -198,9 +215,17 @@ Sets the number of fields, and optionally the field widths.
 in pixels. A value of -1 indicates that the field is variable width; at least one
 field must be -1.}
 
+\membersection{wxStatusBar::SetMinHeight}\label{wxstatusbarsetminheight}
+
+\func{void}{SetMinHeight}{\param{int}{ height}}
+
+Sets the minimal possible hight for the status bar. The real height may be
+bigger than the height specified here depending on the size of the font used by
+the status bar.
+
 \membersection{wxStatusBar::SetStatusText}\label{wxstatusbarsetstatustext}
 
-\func{virtual void}{SetStatusText}{\param{const wxString\& }{text}, \param{const int}{ i = 0}}
+\func{virtual void}{SetStatusText}{\param{const wxString\& }{text}, \param{int}{ i = 0}}
 
 Sets the text for one field.
 
@@ -216,7 +241,7 @@ Sets the text for one field.
 
 \membersection{wxStatusBar::SetStatusWidths}\label{wxstatusbarsetstatuswidths}
 
-\func{virtual void}{SetStatusWidths}{\param{const int}{ n}, \param{const int *}{widths}}
+\func{virtual void}{SetStatusWidths}{\param{int}{ n}, \param{int *}{widths}}
 
 Sets the widths of the fields in the status line.
 
@@ -231,11 +256,14 @@ field must be -1. You should delete this array after calling {\bf SetStatusWidth
 \wxheading{Remarks}
 
 The widths of the variable fields are calculated from the total width of all fields,
-minus the sum of widths of the non-variable fields, divided by the number of 
+minus the sum of widths of the non-variable fields, divided by the number of
 variable fields.
 
 \wxheading{See also}
 
 \helpref{wxStatusBar::SetFieldsCount}{wxstatusbarsetfieldscount}, \helpref{wxFrame::SetStatusWidths}{wxframesetstatuswidths}
 
+\pythonnote{Only a single parameter is required, a Python list of
+integers.}
+