]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/statusbr.tex
Added event table macros to wxGrid that take window identifiers
[wxWidgets.git] / docs / latex / wx / statusbr.tex
index 5cb6f47a867efba69243633eb9cec77ad8d254f3..cb7285ab0ef74429760e7738b3a21abb7952933d 100644 (file)
@@ -87,7 +87,7 @@ See \helpref{wxStatusBar::wxStatusBar}{wxstatusbarconstr} for details.
 
 \constfunc{virtual bool}{GetFieldRect}{\param{int}{ i}, \param{wxRect\&}{ rect}}
 
-Returns the size and position of a fields internal bounding rectangle.
+Returns the size and position of a field's internal bounding rectangle.
 
 \wxheading{Parameters}
 
@@ -97,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}
 
@@ -114,7 +114,7 @@ Returns the number of fields in the status bar.
 
 \membersection{wxStatusBar::GetStatusText}\label{wxstatusbargetstatustext}
 
-\constfunc{virtual wxString}{GetStatusText}{\param{int}{ ir = 0}}
+\constfunc{virtual wxString}{GetStatusText}{\param{int}{ i = 0}}
 
 Returns the string associated with a status bar field.
 
@@ -130,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}}
 
@@ -143,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}}
@@ -230,15 +164,14 @@ Use SetStatusWidths to set the field widths.}
 
 \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}
 
 \func{void}{SetMinHeight}{\param{int}{ height}}
 
-Sets the minimal possible hight for the status bar. The real height may be
+Sets the minimal possible height 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.