interface/wx/stattext.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        stattext.h
   3 // Purpose:     interface of wxStaticText
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     @class wxStaticText
  11
  12     A static text control displays one or more lines of read-only text.
  13     wxStaticText supports the three classic text alignments, label ellipsization
  14     and formatting markup.
  15
  16     @beginStyleTable
  17     @style{wxALIGN_LEFT}
  18            Align the text to the left.
  19     @style{wxALIGN_RIGHT}
  20            Align the text to the right.
  21     @style{wxALIGN_CENTRE}
  22            Center the text (horizontally).
  23     @style{wxST_NO_AUTORESIZE}
  24            By default, the control will adjust its size to exactly fit to the
  25            size of the text when  SetLabel is called. If this style flag is
  26            given, the control will not change its size (this style is
  27            especially useful with controls which also have wxALIGN_RIGHT or
  28            CENTER style because otherwise they won't make sense any longer
  29            after a call to SetLabel).
  30     @style{wxST_ELLIPSIZE_START}
  31            If the labeltext width exceeds the control width, replace the beginning
  32            of the label with an ellipsis; uses wxControl::Ellipsize.
  33     @style{wxST_ELLIPSIZE_MIDDLE}
  34            If the label text width exceeds the control width, replace the middle
  35            of the label with an ellipsis; uses wxControl::Ellipsize.
  36     @style{wxST_ELLIPSIZE_END}
  37            If the label text width exceeds the control width, replace the end
  38            of the label with an ellipsis; uses wxControl::Ellipsize.
  39     @style{wxST_MARKUP}
  40            Support markup in the label; see SetLabel() for more information.
  41     @endStyleTable
  42
  43     @library{wxcore}
  44     @category{ctrl}
  45     @appearance{statictext.png}
  46
  47     @see wxStaticBitmap, wxStaticBox
  48 */
  49 class wxStaticText : public wxControl
  50 {
  51 public:
  52     /**
  53         Default constructor.
  54     */
  55     wxStaticText();
  56
  57     /**
  58         Constructor, creating and showing a text control.
  59
  60         @param parent
  61             Parent window. Should not be @NULL.
  62         @param id
  63             Control identifier. A value of -1 denotes a default value.
  64         @param label
  65             Text label.
  66         @param pos
  67             Window position.
  68         @param size
  69             Window size.
  70         @param style
  71             Window style. See wxStaticText.
  72         @param name
  73             Window name.
  74
  75         @see Create()
  76     */
  77     wxStaticText(wxWindow* parent, wxWindowID id,
  78                  const wxString& label,
  79                  const wxPoint& pos = wxDefaultPosition,
  80                  const wxSize& size = wxDefaultSize,
  81                  long style = 0,
  82                  const wxString& name = wxStaticTextNameStr);
  83
  84     /**
  85         Creation function, for two-step construction. For details see wxStaticText().
  86     */
  87     bool Create(wxWindow* parent, wxWindowID id, const wxString& label,
  88                 const wxPoint& pos = wxDefaultPosition,
  89                 const wxSize& size = wxDefaultSize, long style = 0,
  90                 const wxString& name = wxStaticTextNameStr);
  91
  92     /**
  93         Escapes all the symbols of @a str that have a special meaning (<tt><>"'&</tt>) for
  94         wxStaticText objects with the @c wxST_MARKUP style.
  95         Those symbols are replaced the corresponding entities (&lt; &gt; &quot; &apos; &amp;).
  96     */
  97     static wxString EscapeMarkup(const wxString& str);
  98
  99     /**
 100         Returns the contents of the control.
 101
 102         Note that the returned string contains both the mnemonics (@& characters),
 103         if any, and markup tags, if any.
 104         Use GetLabelText() if only the label text is needed.
 105     */
 106     wxString GetLabel() const;
 107
 108     /**
 109         This method returns the control's label without the mnemonics characters
 110         (if any) and without the markup (if the control has @c wxST_MARKUP style).
 111     */
 112     wxString GetLabelText() const;
 113
 114     /**
 115         This overload returns the given @a label string without the
 116         mnemonics characters (if any) and without the markup.
 117     */
 118     static wxString GetLabelText(const wxString& label);
 119
 120     /**
 121         Returns @true if the window styles for this control contains one of the
 122         @c wxST_ELLIPSIZE_START, @c wxST_ELLIPSIZE_MIDDLE or @c wxST_ELLIPSIZE_END styles.
 123     */
 124     bool IsEllipsized() const;
 125
 126     /**
 127         Removes the markup accepted by wxStaticText when the @c wxST_MARKUP style is used,
 128         and then returns the cleaned string.
 129
 130         See SetLabel() for more info about the markup.
 131     */
 132     static wxString RemoveMarkup(const wxString& str);
 133
 134     /**
 135         Sets the static text label and updates the controls size to exactly fit the
 136         label unless the control has wxST_NO_AUTORESIZE flag.
 137
 138         This function allows to set decorated static label text on platforms which
 139         support it (currently only GTK+ 2). For the other platforms, the markup is
 140         ignored.
 141
 142         The supported tags are:
 143         <TABLE>
 144             <TR>
 145                 <TD>&lt;b&gt;</TD>
 146                 <TD>bold text</TD>
 147             </TR>
 148             <TR>
 149                 <TD>&lt;big&gt;</TD>
 150                 <TD>bigger text</TD>
 151             </TR>
 152             <TR>
 153                 <TD>&lt;i&gt;</TD>
 154                 <TD>italic text</TD>
 155             </TR>
 156             <TR>
 157                 <TD>&lt;s&gt;</TD>
 158                 <TD>strike-through text</TD>
 159             </TR>
 160             <TR>
 161                 <TD>&lt;sub&gt;</TD>
 162                 <TD>subscript text</TD>
 163             </TR>
 164             <TR>
 165                 <TD>&lt;sup&gt;</TD>
 166                 <TD>superscript text</TD>
 167             </TR>
 168             <TR>
 169                 <TD>&lt;small&gt;</TD>
 170                 <TD>smaller text</TD>
 171             </TR>
 172             <TR>
 173                 <TD>&lt;tt&gt;</TD>
 174                 <TD>monospaced text</TD>
 175             </TR>
 176             <TR>
 177                 <TD>&lt;u&gt;</TD>
 178                 <TD>underlined text</TD>
 179             </TR>
 180             <TR>
 181                 <TD>&lt;span&gt;</TD>
 182                 <TD>generic formatter tag; see Pango Markup
 183                     (http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html)
 184                     for more information.</TD>
 185             </TR>
 186         </TABLE>
 187
 188         Note that the string must be well-formed (e.g. all tags must be correctly
 189         closed) otherwise it can be not shown correctly or at all.
 190         Also note that you need to escape the following special characters:
 191
 192         <TABLE>
 193             <TR>
 194                 <TD>@b Special character</TD>
 195                 <TD>@b Escape as</TD>
 196             </TR>
 197             <TR>
 198                 <TD>@c &amp;</TD>
 199                 <TD>@c &amp;amp; or as &amp;&amp;</TD>
 200             </TR>
 201             <TR>
 202                 <TD>@c &apos;</TD>
 203                 <TD>@c &amp;apos;</TD>
 204             </TR>
 205             <TR>
 206                 <TD>@c &quot;</TD>
 207                 <TD>@c &amp;quot;</TD>
 208             </TR>
 209             <TR>
 210                 <TD>@c &lt;</TD>
 211                 <TD>@c &amp;lt;</TD>
 212             </TR>
 213             <TR>
 214                 <TD>@c &gt;</TD>
 215                 <TD>@c &amp;gt;</TD>
 216             </TR>
 217         </TABLE>
 218
 219         The non-escaped ampersand @c &amp; characters are interpreted as
 220         mnemonics; see wxControl::SetLabel.
 221
 222         Example:
 223
 224         @param label
 225             The new label to set.
 226             It may contain newline characters and the markup tags described above.
 227     */
 228     virtual void SetLabel(const wxString& label);
 229
 230     /**
 231         This functions wraps the controls label so that each of its lines becomes at
 232         most @a width pixels wide if possible (the lines are broken at words
 233         boundaries so it might not be the case if words are too long).
 234
 235         If @a width is negative, no wrapping is done. Note that this width is not
 236         necessarily the total width of the control, since a few pixels for the
 237         border (depending on the controls border style) may be added.
 238
 239         @since 2.6.2
 240     */
 241     void Wrap(int width);
 242 };
 243