]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/latex/wx/stattext.tex
[ 1573138 ] small docs corrections
[wxWidgets.git] / docs / latex / wx / stattext.tex
index 2802fe6ff8b1773157cce5f11dd34e1edca62958..82ea780b8ee19933a98cdff21e8917762d893741 100644 (file)
@@ -19,7 +19,7 @@ A static text control displays one or more lines of read-only text.
 \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 (horisontally)}
+\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
@@ -36,6 +36,7 @@ See also \helpref{window styles overview}{windowstyles}.
 
 \latexignore{\rtfignore{\wxheading{Members}}}
 
+
 \membersection{wxStaticText::wxStaticText}\label{wxstatictextconstr}
 
 \func{}{wxStaticText}{\void}
@@ -43,7 +44,7 @@ See also \helpref{window styles overview}{windowstyles}.
 Default constructor.
 
 \func{}{wxStaticText}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
-\param{const wxString\& }{label = ``"}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\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.
@@ -68,20 +69,23 @@ Constructor, creating and showing a text control.
 
 \helpref{wxStaticText::Create}{wxstatictextcreate}
 
+
 \membersection{wxStaticText::Create}\label{wxstatictextcreate}
 
 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID}{ id},\rtfsp
-\param{const wxString\& }{label = ``"}, \param{const wxPoint\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\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}.
 
+
 \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}}
@@ -93,3 +97,15 @@ label unless the control has wxST\_NO\_AUTORESIZE flag.
 
 \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}
+