update by Paco Riviere

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

diff --git a/docs/latex/wx/statusbr.tex b/docs/latex/wx/statusbr.tex
index 777b6764784a956c1cf4c6d6c9b623c9ff06b711..648019282d99fb3e5b0dfabcdd51d8158652c1cd 100644 (file)
--- a/docs/latex/wx/statusbr.tex
+++ b/docs/latex/wx/statusbr.tex
@@ -46,8 +46,7 @@ from an {\bf OnSize} event handler.
 Default constructor.
 
 \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{long}{ style = wxST\_SIZEGRIP},\rtfsp
 \param{const wxString\& }{name = ``statusBar"}}
 
 Constructor, creating the window.
@@ -58,12 +57,6 @@ Constructor, creating the window.
 
 \docparam{id}{The window identifier. It may take a value of -1 to indicate a default value.}
 
-\docparam{pos}{The window position. A value of (-1, -1) indicates a default position, chosen by
-either the windowing system or wxWindows, depending on platform.}
-
-\docparam{size}{The window size. A value of (-1, -1) indicates a default size, chosen by
-either the windowing system or wxWindows, depending on platform.}
-
 \docparam{style}{The window style. See \helpref{wxStatusBar}{wxstatusbar}.}
 
 \docparam{name}{The name of the window. This parameter is used to associate a name with the item,
@@ -83,8 +76,7 @@ Destructor.
 \membersection{wxStatusBar::Create}\label{wxstatusbarcreate}
 
 \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{long}{ style = wxST\_SIZEGRIP},\rtfsp
 \param{const wxString\& }{name = ``statusBar"}}
 
 Creates the window, for two-step construction.
@@ -105,7 +97,7 @@ Returns the size and position of a fields internal bounding rectangle.
 
 \wxheading{Return value}
 
-TRUE if the field index is valid, FALSE otherwise.
+true if the field index is valid, false otherwise.
 
 \wxheading{See also}
 
@@ -138,7 +130,7 @@ The status field string if the field is valid, otherwise the empty string.
 
 \helpref{wxStatusBar::SetStatusText}{wxstatusbarsetstatustext}
 
-\membersection{wxStatusBar::PopStatusText}\label{wxstatusbarpushstatustext}
+\membersection{wxStatusBar::PopStatusText}\label{wxstatusbarpopstatustext}
 
 \func{void}{PopStatusText}{\param{int}{ field = 0}}
 
@@ -151,77 +143,11 @@ strings.
 
 \membersection{wxStatusBar::PushStatusText}\label{wxstatusbarpushstatustext}
 
-\func{void}{PushStatusText}{\param{const wxString&}{ string}, \param{int}{ field = 0}}
+\func{void}{PushStatusText}{\param{const wxString\&}{ string}, \param{int}{ field = 0}}
 
 Saves the current field text in a per field stack, and sets the field text
 to the string passed as argument.
 
-%% VZ: these functions are not in wxStatusBar API, these are just
-%%     implementation details of wxStatusBarGeneric
-%%
-%% \membersection{wxStatusBar::DrawField}\label{wxstatusbardrawfield}
-%% 
-%% \func{virtual void}{DrawField}{\param{wxDC\& }{dc}, \param{int }{i}}
-%% 
-%% Draws a field, including shaded borders and text.
-%% 
-%% \wxheading{Parameters}
-%% 
-%% \docparam{dc}{The device context to draw onto.}
-%% 
-%% \docparam{i}{The field to be drawn.}
-%% 
-%% \wxheading{See also}
-%% 
-%% \helpref{wxStatusBar::DrawFieldText}{wxstatusbardrawfieldtext}
-%% 
-%% \membersection{wxStatusBar::DrawFieldText}\label{wxstatusbardrawfieldtext}
-%% 
-%% \func{virtual void}{DrawFieldText}{\param{wxDC\& }{dc}, \param{int }{i}}
-%% 
-%% Draws a field's text.
-%% 
-%% \wxheading{Parameters}
-%% 
-%% \docparam{dc}{The device context to draw onto.}
-%% 
-%% \docparam{i}{The field whose text is to be drawn.}
-%% 
-%% \wxheading{See also}
-%% 
-%% \helpref{wxStatusBar::DrawField}{wxstatusbardrawfield}
-%% 
-%% \membersection{wxStatusBar::InitColours}\label{wxstatusbarinitcolours}
-%% 
-%% \func{virtual void}{InitColours}{\void}
-%% 
-%% Sets up the background colour and shading pens using suitable system colours (Windows) or tasteful shades
-%% of grey (other platforms).
-%% 
-%% \wxheading{Remarks}
-%% 
-%% This function is called when the window is created, and also
-%% from \helpref{wxStatusBar::OnSysColourChanged}{wxstatusbaronsyscolourchanged} on Windows.
-%% 
-%% \wxheading{See also}
-%% 
-%% \helpref{wxStatusBar::OnSysColourChanged}{wxstatusbaronsyscolourchanged}
-%% 
-%% \membersection{wxStatusBar::OnSysColourChanged}\label{wxstatusbaronsyscolourchanged}
-%% 
-%% \func{void}{OnSysColourChanged}{\param{wxSysColourChangedEvent\& }{event}}
-%% 
-%% Handles a system colour change by calling \helpref{wxStatusBar::InitColours}{wxstatusbarinitcolours},
-%% and refreshes the window.
-%% 
-%% \wxheading{Parameters}
-%% 
-%% \docparam{event}{The colour change event.}
-%% 
-%% \wxheading{See also}
-%% 
-%% \helpref{wxStatusBar::InitColours}{wxstatusbarinitcolours}
-
 \membersection{wxStatusBar::SetFieldsCount}\label{wxstatusbarsetfieldscount}
 
 \func{virtual void}{SetFieldsCount}{\param{int}{ number = 1}, \param{int* }{widths = NULL}}
@@ -231,16 +157,15 @@ 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.}
 
-\perlnote{In wxPerl this function acceps only the {\tt n} parameter.
+\perlnote{In wxPerl this function accepts only the {\tt n} parameter.
 Use SetStatusWidths to set the field widths.}
 
 \wxheading{Parameters}
 
 \docparam{number}{The number of fields.}
 
-\docparam{widths}{An array of {\it n} integers, each of which is a status field width
-in pixels. A value of -1 indicates that the field is variable width; at least one
-field must be -1.}
+\docparam{widths}{An array of {\it n} integers interpreted in the same way as
+in \helpref{SetStatusWidths}{wxstatusbarsetstatuswidths}}
 
 \membersection{wxStatusBar::SetMinHeight}\label{wxstatusbarsetminheight}