]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/statusbr.tex
remove C++ comment
[wxWidgets.git] / docs / latex / wx / statusbr.tex
index cb7285ab0ef74429760e7738b3a21abb7952933d..f191f0d2518ab092e29b8cc3ce6d358597a217db 100644 (file)
@@ -18,6 +18,10 @@ be variable length according to the size of the window.
 
 <wx/statusbr.h>
 
+\wxheading{Library}
+
+\helpref{wxCore}{librarieslist}
+
 \wxheading{Window styles}
 
 \twocolwidtha{5cm}
@@ -39,13 +43,13 @@ from an {\bf OnSize} event handler.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
-\membersection{wxStatusBar::wxStatusBar}\label{wxstatusbarconstr}
+\membersection{wxStatusBar::wxStatusBar}\label{wxstatusbarctor}
 
 \func{}{wxStatusBar}{\void}
 
 Default constructor.
 
-\func{}{wxStatusBar}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
+\func{}{wxStatusBar}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY},\rtfsp
 \param{long}{ style = wxST\_SIZEGRIP},\rtfsp
 \param{const wxString\& }{name = ``statusBar"}}
 
@@ -67,7 +71,7 @@ individual windows.}
 
 \helpref{wxStatusBar::Create}{wxstatusbarcreate}
 
-\membersection{wxStatusBar::\destruct{wxStatusBar}}
+\membersection{wxStatusBar::\destruct{wxStatusBar}}\label{wxstatusbardtor}
 
 \func{void}{\destruct{wxStatusBar}}{\void}
 
@@ -75,13 +79,13 @@ Destructor.
 
 \membersection{wxStatusBar::Create}\label{wxstatusbarcreate}
 
-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id},\rtfsp
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id = wxID\_ANY},\rtfsp
 \param{long}{ style = wxST\_SIZEGRIP},\rtfsp
 \param{const wxString\& }{name = ``statusBar"}}
 
 Creates the window, for two-step construction.
 
-See \helpref{wxStatusBar::wxStatusBar}{wxstatusbarconstr} for details.
+See \helpref{wxStatusBar::wxStatusBar}{wxstatusbarctor} for details.
 
 \membersection{wxStatusBar::GetFieldRect}\label{wxstatusbargetfieldrect}
 
@@ -198,12 +202,12 @@ Sets the text for one field.
 Sets the widths of the fields in the status line. There are two types of
 fields: fixed widths one and variable width fields. For the fixed width fields
 you should specify their (constant) width in pixels. For the variable width
-fields, specify a negative number which indicates how should the field expand:
+fields, specify a negative number which indicates how the field should expand:
 the space left for all variable width fields is divided between them according
 to the absolute value of this number. A variable width field with width of $-2$
 gets twice as much of it as a field with width $-1$ and so on.
 
-For example, to create one fixed width field of width $50$ in the right part of
+For example, to create one fixed width field of width $100$ in the right part of
 the status bar and two more fields which get $66$\% and $33$\% of the remaining
 space correspondingly, you should use an array containing $-2$, $-1$ and $100$.
 
@@ -215,7 +219,7 @@ time it was called.}
 
 \docparam{widths}{Contains an array of {\it n} integers, each of which is
 either an absolute status field width in pixels if positive or indicates a
-variable width field if negative}
+variable width field if negative.}
 
 \wxheading{Remarks}
 
@@ -232,3 +236,28 @@ integers.}
 
 \perlnote{In wxPerl this method takes as parameters the field widths.}
 
+\membersection{wxStatusBar::SetStatusStyles}\label{wxstatusbarsetstatusstyles}
+
+\func{virtual void}{SetStatusStyles}{\param{int}{ n}, \param{int *}{styles}}
+
+Sets the styles of the fields in the status line which can make fields appear flat
+or raised instead of the standard sunken 3D border.
+
+\wxheading{Parameters}
+
+\docparam{n}{The number of fields in the status bar. Must be equal to the
+number passed to \helpref{SetFieldsCount}{wxstatusbarsetfieldscount} the last
+time it was called.}
+
+\docparam{styles}{Contains an array of {\it n} integers with the styles for each field. There 
+are three possible styles:
+
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxSB\_NORMAL}}{(default) The field appears sunken with a standard 3D border.}
+\twocolitem{\windowstyle{wxSB\_FLAT}}{No border is painted around the field so that it appears flat.}
+\twocolitem{\windowstyle{wxSB\_RAISED}}{A raised 3D border is painted around the field.}
+\end{twocollist}
+}
+
+