Added event table macros to wxGrid that take window identifiers

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

diff --git a/docs/latex/wx/statusbr.tex b/docs/latex/wx/statusbr.tex
index 6985cc883ecb21dcf2afd47be4f807868f769f79..cb7285ab0ef74429760e7738b3a21abb7952933d 100644 (file)
--- a/docs/latex/wx/statusbr.tex
+++ b/docs/latex/wx/statusbr.tex
@@ -22,7 +22,7 @@ be variable length according to the size of the window.
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt
 
 \twocolwidtha{5cm}
 \begin{twocollist}\itemsep=0pt

-\twocolitem{\windowstyle{wxSB\_SIZEGRIP}}{On Windows 95, displays a gripper at right-hand side of
+\twocolitem{\windowstyle{wxST\_SIZEGRIP}}{On Windows 95, displays a gripper at right-hand side of

 the status bar.}
 \end{twocollist}
 
 the status bar.}
 \end{twocollist}
 


@@ -46,8 +46,7 @@ from an {\bf OnSize} event handler.
 Default constructor.
 
 \func{}{wxStatusBar}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
 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.
 \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{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,
 \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
 \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.
 \param{const wxString\& }{name = ``statusBar"}}
 
 Creates the window, for two-step construction.


@@ -95,7 +87,7 @@ See \helpref{wxStatusBar::wxStatusBar}{wxstatusbarconstr} for details.
 
 \constfunc{virtual bool}{GetFieldRect}{\param{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.
+Returns the size and position of a field's internal bounding rectangle.

 
 \wxheading{Parameters}
 
 
 \wxheading{Parameters}
 


@@ -105,12 +97,15 @@ Returns the size and position of a fields internal bounding rectangle.
 
 \wxheading{Return value}
 
 
 \wxheading{Return value}
 

-TRUE if the field index is valid, FALSE otherwise.
+true if the field index is valid, false otherwise.

 
 \wxheading{See also}
 
 \helpref{wxRect}{wxrect}
 
 
 \wxheading{See also}
 
 \helpref{wxRect}{wxrect}
 

+\perlnote{In wxPerl this function returns a {\tt Wx::Rect} if the field
+  index is valid, {\tt undef} otherwise.}
+

 \membersection{wxStatusBar::GetFieldsCount}\label{wxstatusbargetfieldscount}
 
 \constfunc{int}{GetFieldsCount}{\void}
 \membersection{wxStatusBar::GetFieldsCount}\label{wxstatusbargetfieldscount}
 
 \constfunc{int}{GetFieldsCount}{\void}


@@ -119,7 +114,7 @@ Returns the number of fields in the status bar.
 
 \membersection{wxStatusBar::GetStatusText}\label{wxstatusbargetstatustext}
 
 
 \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.
 
 
 Returns the string associated with a status bar field.
 


@@ -135,71 +130,23 @@ The status field string if the field is valid, otherwise the empty string.
 
 \helpref{wxStatusBar::SetStatusText}{wxstatusbarsetstatustext}
 
 
 \helpref{wxStatusBar::SetStatusText}{wxstatusbarsetstatustext}
 

-%% 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::PopStatusText}\label{wxstatusbarpopstatustext}
+
+\func{void}{PopStatusText}{\param{int}{ field = 0}}
+
+Sets the field text to the top of the stack, and pops the stack of saved
+strings.
+
+\wxheading{See also}
+
+\helpref{wxStatusBar::PushStatusText}{wxstatusbarpushstatustext}
+
+\membersection{wxStatusBar::PushStatusText}\label{wxstatusbarpushstatustext}
+
+\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.

 
 \membersection{wxStatusBar::SetFieldsCount}\label{wxstatusbarsetfieldscount}
 
 
 \membersection{wxStatusBar::SetFieldsCount}\label{wxstatusbarsetfieldscount}
 


@@ -210,22 +157,21 @@ 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.}
 
 \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.}
 
 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}
 
 \func{void}{SetMinHeight}{\param{int}{ height}}
 
 
 \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.
 
 bigger than the height specified here depending on the size of the font used by
 the status bar.