docs/latex/wx/stattext.tex

   1 \section{\class{wxStaticText}}\label{wxstatictext}
   2
   3 A static text control displays one or more lines of read-only text.
   4
   5 TODO: should a static text have a validator? E.g. if you wanted
   6 to use it to initialise the control with some text taken from
   7 the validator.
   8
   9 \wxheading{Derived from}
  10
  11 \helpref{wxControl}{wxcontrol}\\
  12 \helpref{wxWindow}{wxwindow}\\
  13 \helpref{wxEvtHandler}{wxevthandler}\\
  14 \helpref{wxObject}{wxobject}
  15
  16 \wxheading{Window styles}
  17
  18 There are no special styles for this control.
  19
  20 See also \helpref{window styles overview}{windowstyles}.
  21
  22 \wxheading{See also}
  23
  24 \helpref{wxStaticBitmap}{wxstaticbitmap}, \helpref{wxStaticBox}{wxstaticbox}
  25
  26 \latexignore{\rtfignore{\wxheading{Members}}}
  27
  28 \membersection{wxStaticText::wxStaticText}\label{wxstatictextconstr}
  29
  30 \func{}{wxStaticText}{\void}
  31
  32 Default constructor.
  33
  34 \func{}{wxStaticText}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp
  35 \param{const wxString\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  36 \param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}}
  37
  38 Constructor, creating and showing a text control.
  39
  40 \wxheading{Parameters}
  41
  42 \docparam{parent}{Parent window. Should not be NULL.}
  43
  44 \docparam{id}{Control identifier. A value of -1 denotes a default value.}
  45
  46 \docparam{label}{Text label.}
  47
  48 \docparam{pos}{Window position.}
  49
  50 \docparam{size}{Window size.}
  51
  52 \docparam{style}{Window style. See \helpref{wxStaticText}{wxstatictext}.}
  53
  54 \docparam{name}{Window name.}
  55
  56 \wxheading{See also}
  57
  58 \helpref{wxStaticText::Create}{wxstatictextcreate}
  59
  60 \membersection{wxStaticText::Create}\label{wxstatictextcreate}
  61
  62 \func{bool}{Create}{\param{wxWindow* }{parent}, \param{const wxWindowID}{ id},\rtfsp
  63 \param{const wxString\& }{label = ``"}, \param{const wxPosition\& }{pos}, \param{const wxSize\& }{size = wxDefaultSize},\rtfsp
  64 \param{const long}{ style = 0}, \param{const wxString\& }{name = ``staticText"}}
  65
  66 Creation function, for two-step construction. For details see \helpref{wxStaticText::wxStaticText}{wxstatictextconstr}.
  67
  68 \membersection{wxStaticText::GetLabel}\label{wxstatictextgetlabel}
  69
  70 \constfunc{wxString}{GetLabel}{\void}
  71
  72 Returns the contents of the control.
  73
  74 \membersection{wxStaticText::SetLabel}\label{wxstatictextsetlabel}
  75
  76 \func{virtual void}{SetLabel}{\param{const wxString\& }{ label}}
  77
  78 Sets the static text label.
  79
  80 \wxheading{Parameters}
  81
  82 \docparam{label}{The new label to set. It may contain newline characters.}
  83
  84