patch 1306473

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

diff --git a/docs/latex/wx/stattext.tex b/docs/latex/wx/stattext.tex
index a8678e27e55b3fb72d46ff215281f20fcf0d43b3..82ea780b8ee19933a98cdff21e8917762d893741 100644 (file)
--- a/docs/latex/wx/stattext.tex
+++ b/docs/latex/wx/stattext.tex
@@ -2,10 +2,6 @@
 
 A static text control displays one or more lines of read-only text.
 
 
 A static text control displays one or more lines of read-only text.
 

-TODO: should a static text have a validator? E.g. if you wanted
-to use it to initialise the control with some text taken from
-the validator.
-

 \wxheading{Derived from}
 
 \helpref{wxControl}{wxcontrol}\\
 \wxheading{Derived from}
 
 \helpref{wxControl}{wxcontrol}\\


@@ -13,9 +9,24 @@ the validator.
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 
 \helpref{wxEvtHandler}{wxevthandler}\\
 \helpref{wxObject}{wxobject}
 

+\wxheading{Include files}
+
+<wx/stattext.h>
+

 \wxheading{Window styles}
 
 \wxheading{Window styles}
 

-There are no special styles for this control.
+\twocolwidtha{5cm}
+\begin{twocollist}\itemsep=0pt
+\twocolitem{\windowstyle{wxALIGN\_LEFT}}{Align the text to the left}
+\twocolitem{\windowstyle{wxALIGN\_RIGHT}}{Align the text to the right}
+\twocolitem{\windowstyle{wxALIGN\_CENTRE}}{Center the text (horizontally)}
+\twocolitem{\windowstyle{wxST\_NO\_AUTORESIZE}}{By default, the control will
+adjust its size to exactly fit to the size of the text when 
+\helpref{SetLabel}{wxstatictextsetlabel} is called. If this style flag is
+given, the control will not change its size (this style is especially useful
+with controls which also have wxALIGN\_RIGHT or CENTER style because otherwise
+they won't make sense any longer after a call to SetLabel)}
+\end{twocollist}

 
 See also \helpref{window styles overview}{windowstyles}.
 
 
 See also \helpref{window styles overview}{windowstyles}.
 


@@ -25,15 +36,16 @@ See also \helpref{window styles overview}{windowstyles}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 

+

 \membersection{wxStaticText::wxStaticText}\label{wxstatictextconstr}
 
 \func{}{wxStaticText}{\void}
 
 Default constructor.
 
 \membersection{wxStaticText::wxStaticText}\label{wxstatictextconstr}
 
 \func{}{wxStaticText}{\void}
 
 Default constructor.
 

-\func{}{wxStaticText}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp
-\param{const wxString\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}}
+\func{}{wxStaticText}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
+\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}}

 
 Constructor, creating and showing a text control.
 
 
 Constructor, creating and showing a text control.
 


@@ -57,28 +69,43 @@ Constructor, creating and showing a text control.
 
 \helpref{wxStaticText::Create}{wxstatictextcreate}
 
 
 \helpref{wxStaticText::Create}{wxstatictextcreate}
 

+

 \membersection{wxStaticText::Create}\label{wxstatictextcreate}
 
 \membersection{wxStaticText::Create}\label{wxstatictextcreate}
 

-\func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp
-\param{const wxString\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
-\param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}}
+\func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
+\param{const wxString\& }{label}, \param{const wxPoint\& }{pos = wxDefaultPosition}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
+\param{long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}}

 
 Creation function, for two-step construction. For details see \helpref{wxStaticText::wxStaticText}{wxstatictextconstr}.
 
 
 Creation function, for two-step construction. For details see \helpref{wxStaticText::wxStaticText}{wxstatictextconstr}.
 

+

 \membersection{wxStaticText::GetLabel}\label{wxstatictextgetlabel}
 
 \constfunc{wxString}{GetLabel}{\void}
 
 Returns the contents of the control.
 
 \membersection{wxStaticText::GetLabel}\label{wxstatictextgetlabel}
 
 \constfunc{wxString}{GetLabel}{\void}
 
 Returns the contents of the control.
 

+

 \membersection{wxStaticText::SetLabel}\label{wxstatictextsetlabel}
 
 \func{virtual void}{SetLabel}{\param{const wxString\& }{ label}}
 
 \membersection{wxStaticText::SetLabel}\label{wxstatictextsetlabel}
 
 \func{virtual void}{SetLabel}{\param{const wxString\& }{ label}}
 

-Sets the static text label.
+Sets the static text label and updates the controls size to exactly fit the
+label unless the control has wxST\_NO\_AUTORESIZE flag.

 
 \wxheading{Parameters}
 
 \docparam{label}{The new label to set. It may contain newline characters.}
 
 
 
 \wxheading{Parameters}
 
 \docparam{label}{The new label to set. It may contain newline characters.}
 
 

+\membersection{wxStaticText::Wrap}\label{wxstatictextwrpa}
+
+\func{void}{Wrap}{\param{int }{width}}
+
+This functions wraps the controls label so that each of its lines becomes at
+most \arg{width} pixels wide if possible (the lines are broken at words
+boundaries so it might not be the case if words are too long). If \arg{width}
+is negative, no wrapping is done.
+
+\newsince{2.6.2}
+