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 the @c wxALIGN_RIGHT or
  28            the @c wxALIGN_CENTRE style because otherwise they won't make sense any
  29            longer 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         Returns the contents of the control.
  94
  95         Note that the returned string may contain both the mnemonics (@& characters),
  96         if any, and markup tags, if any.
  97
  98         Use GetLabelText() if only the label text is needed.
  99     */
 100     wxString GetLabel() const;
 101
 102     /**
 103         This method returns the control's label without the mnemonics characters
 104         (if any) and without the markup (if the control has @c wxST_MARKUP style).
 105     */
 106     wxString GetLabelText() const;
 107
 108     /**
 109         Returns @true if the window styles for this control contains one of the
 110         @c wxST_ELLIPSIZE_START, @c wxST_ELLIPSIZE_MIDDLE or @c wxST_ELLIPSIZE_END styles.
 111     */
 112     bool IsEllipsized() const;
 113
 114     // NB: when writing docs for the following function remember that Doxygen
 115     //     will always expand HTML entities (e.g. &quot;) and thus we need to
 116     //     write e.g. "&amp;lt;" to have in the output the "&lt;" string.
 117
 118     /**
 119         Sets the static text label and updates the controls size to exactly fit the
 120         label unless the control has @c wxST_NO_AUTORESIZE flag.
 121
 122         This function allows to set decorated static label text on platforms which
 123         support it (currently only GTK+ 2). For the other platforms, the markup is
 124         ignored.
 125
 126         The supported tags are:
 127         <TABLE>
 128             <TR>
 129                 <TD><b>Tag</b></TD>
 130                 <TD><b>Description</b></TD>
 131             </TR>
 132             <TR>
 133                 <TD>&lt;b&gt;</TD>
 134                 <TD>bold text</TD>
 135             </TR>
 136             <TR>
 137                 <TD>&lt;big&gt;</TD>
 138                 <TD>bigger text</TD>
 139             </TR>
 140             <TR>
 141                 <TD>&lt;i&gt;</TD>
 142                 <TD>italic text</TD>
 143             </TR>
 144             <TR>
 145                 <TD>&lt;s&gt;</TD>
 146                 <TD>strike-through text</TD>
 147             </TR>
 148             <TR>
 149                 <TD>&lt;sub&gt;</TD>
 150                 <TD>subscript text</TD>
 151             </TR>
 152             <TR>
 153                 <TD>&lt;sup&gt;</TD>
 154                 <TD>superscript text</TD>
 155             </TR>
 156             <TR>
 157                 <TD>&lt;small&gt;</TD>
 158                 <TD>smaller text</TD>
 159             </TR>
 160             <TR>
 161                 <TD>&lt;tt&gt;</TD>
 162                 <TD>monospaced text</TD>
 163             </TR>
 164             <TR>
 165                 <TD>&lt;u&gt;</TD>
 166                 <TD>underlined text</TD>
 167             </TR>
 168             <TR>
 169                 <TD>&lt;span&gt;</TD>
 170                 <TD>generic formatter tag; see Pango Markup
 171                     (http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html)
 172                     for more information.</TD>
 173             </TR>
 174         </TABLE>
 175
 176         Note that the string must be well-formed (e.g. all tags must be correctly
 177         closed) otherwise it can be not shown correctly or at all.
 178         Also note that you need to escape the following special characters:
 179
 180         <TABLE>
 181             <TR>
 182                 <TD><b>Special character</b></TD>
 183                 <TD><b>Escape as</b></TD>
 184             </TR>
 185             <TR>
 186                 <TD>@c &amp;</TD>
 187                 <TD>@c &amp;amp; or as @c &amp;&amp;</TD>
 188             </TR>
 189             <TR>
 190                 <TD>@c &apos;</TD>
 191                 <TD>@c &amp;apos;</TD>
 192             </TR>
 193             <TR>
 194                 <TD>@c &quot;</TD>
 195                 <TD>@c &amp;quot;</TD>
 196             </TR>
 197             <TR>
 198                 <TD>@c &lt;</TD>
 199                 <TD>@c &amp;lt;</TD>
 200             </TR>
 201             <TR>
 202                 <TD>@c &gt;</TD>
 203                 <TD>@c &amp;gt;</TD>
 204             </TR>
 205         </TABLE>
 206
 207         The non-escaped ampersand @c &amp; characters are interpreted as
 208         mnemonics; see wxControl::SetLabel.
 209
 210         Example:
 211
 212         @param label
 213             The new label to set.
 214             It may contain newline characters and the markup tags described above.
 215     */
 216     virtual void SetLabel(const wxString& label);
 217
 218     /**
 219                 Sets the control's label to exactly the given string.
 220
 221         Unlike SetLabel(), this function shows exactly the @a text passed to it
 222         in the control, without interpreting ampersands in it in any way.
 223         Notice that it means that the control can't have any mnemonic defined
 224         for it using this function.
 225
 226     */
 227     virtual void SetLabelText(const wxString& text);
 228
 229     /**
 230         This functions wraps the controls label so that each of its lines becomes at
 231         most @a width pixels wide if possible (the lines are broken at words
 232         boundaries so it might not be the case if words are too long).
 233
 234         If @a width is negative, no wrapping is done. Note that this width is not
 235         necessarily the total width of the control, since a few pixels for the
 236         border (depending on the controls border style) may be added.
 237
 238         @since 2.6.2
 239     */
 240     void Wrap(int width);
 241
 242
 243 public:     // static functions
 244
 245     /**
 246         Returns the given @a label string without the mnemonics characters (if any)
 247         and without the markup.
 248
 249         Note that since this function is static it will always remove markup
 250         (since it cannot check @c wxST_MARKUP presence/absence!).
 251     */
 252     static wxString GetLabelText(const wxString& label);
 253
 254     /**
 255         Escapes all the symbols of @a str that have a special meaning (<tt><>&quot;'&</tt>) for
 256         wxStaticText objects with the @c wxST_MARKUP style.
 257
 258         Those symbols are replaced the corresponding entities
 259         (&amp;lt; &amp;gt; &amp;quot; &amp;apos; &amp;amp;).
 260     */
 261     static wxString EscapeMarkup(const wxString& str);
 262
 263     /**
 264         Removes the markup accepted by wxStaticText when the @c wxST_MARKUP style is used,
 265         and then returns the cleaned string.
 266
 267         See SetLabel() for more info about the markup.
 268     */
 269     static wxString RemoveMarkup(const wxString& str);
 270 };
 271