interface/wx/control.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        control.h
   3 // Purpose:     interface of wxControl
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10     Flags used by wxControl::Ellipsize function.
  11 */
  12 enum wxEllipsizeFlags
  13 {
  14     /// No special flags.
  15     wxELLIPSIZE_FLAGS_NONE = 0,
  16
  17     /**
  18         Take mnemonics into account when calculating the text width.
  19
  20         With this flag when calculating the size of the passed string,
  21         mnemonics characters (see wxControl::SetLabel) will be automatically
  22         reduced to a single character. This leads to correct calculations only
  23         if the string passed to Ellipsize() will be used with
  24         wxControl::SetLabel. If you don't want ampersand to be interpreted as
  25         mnemonics (e.g. because you use wxControl::SetLabelText) then don't use
  26         this flag.
  27      */
  28     wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS = 1,
  29
  30     /**
  31         Expand tabs in spaces when calculating the text width.
  32
  33         This flag tells wxControl::Ellipsize() to calculate the width of tab
  34         characters @c '\\t' as 6 spaces.
  35      */
  36     wxELLIPSIZE_FLAGS_EXPAND_TABS = 2,
  37
  38     /// The default flags for wxControl::Ellipsize.
  39     wxELLIPSIZE_FLAGS_DEFAULT = wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS|
  40                                 wxELLIPSIZE_FLAGS_EXPAND_TABS
  41 };
  42
  43
  44 /**
  45     The different ellipsization modes supported by the
  46     wxControl::Ellipsize function.
  47 */
  48 enum wxEllipsizeMode
  49 {
  50     /// Don't ellipsize the text at all. @since 2.9.1
  51     wxELLIPSIZE_NONE,
  52
  53     /// Put the ellipsis at the start of the string, if the string needs ellipsization.
  54     wxELLIPSIZE_START,
  55
  56     /// Put the ellipsis in the middle of the string, if the string needs ellipsization.
  57     wxELLIPSIZE_MIDDLE,
  58
  59     /// Put the ellipsis at the end of the string, if the string needs ellipsization.
  60     wxELLIPSIZE_END
  61 };
  62
  63 /**
  64     @class wxControl
  65
  66     This is the base class for a control or "widget".
  67
  68     A control is generally a small window which processes user input and/or
  69     displays one or more item of data.
  70
  71     @beginEventEmissionTable{wxClipboardTextEvent}
  72     @event{EVT_TEXT_COPY(id, func)}
  73            Some or all of the controls content was copied to the clipboard.
  74     @event{EVT_TEXT_CUT(id, func)}
  75            Some or all of the controls content was cut (i.e. copied and
  76            deleted).
  77     @event{EVT_TEXT_PASTE(id, func)}
  78            Clipboard content was pasted into the control.
  79     @endEventTable
  80
  81     @library{wxcore}
  82     @category{ctrl}
  83
  84     @see wxValidator
  85 */
  86 class wxControl : public wxWindow
  87 {
  88 public:
  89     /**
  90         Simulates the effect of the user issuing a command to the item.
  91
  92         @see wxCommandEvent
  93     */
  94     virtual void Command(wxCommandEvent& event);
  95
  96     /**
  97         Returns the control's label, as it was passed to SetLabel().
  98
  99         Note that the returned string may contains mnemonics ("&" characters) if they were
 100         passed to the SetLabel() function; use GetLabelText() if they are undesired.
 101
 102         Also note that the returned string is always the string which was passed to
 103         SetLabel() but may be different from the string passed to SetLabelText()
 104         (since this last one escapes mnemonic characters).
 105     */
 106     wxString GetLabel() const;
 107
 108     /**
 109         Returns the control's label without mnemonics.
 110
 111         Note that because of the stripping of the mnemonics the returned string may differ
 112         from the string which was passed to SetLabel() but should always be the same which
 113         was passed to SetLabelText().
 114     */
 115     wxString GetLabelText() const;
 116
 117     /**
 118         Sets the control's label.
 119
 120         All "&" characters in the @a label are special and indicate that the
 121         following character is a @e mnemonic for this control and can be used to
 122         activate it from the keyboard (typically by using @e Alt key in
 123         combination with it). To insert a literal ampersand character, you need
 124         to double it, i.e. use "&&". If this behaviour is undesirable, use
 125         SetLabelText() instead.
 126     */
 127     void SetLabel(const wxString& label);
 128
 129     /**
 130         Sets the control's label to exactly the given string.
 131
 132         Unlike SetLabel(), this function shows exactly the @a text passed to it
 133         in the control, without interpreting ampersands in it in any way.
 134         Notice that it means that the control can't have any mnemonic defined
 135         for it using this function.
 136
 137         @see EscapeMnemonics()
 138      */
 139     void SetLabelText(const wxString& text);
 140
 141     // NB: when writing docs for the following function remember that Doxygen
 142     //     will always expand HTML entities (e.g. &quot;) and thus we need to
 143     //     write e.g. "&amp;lt;" to have in the output the "&lt;" string.
 144
 145     /**
 146         Sets the controls label to a string using markup.
 147
 148         Simple markup supported by this function can be used to apply different
 149         fonts or colours to different parts of the control label when supported.
 150         If markup is not supported by the control or platform, it is simply
 151         stripped and SetLabel() is used with the resulting string.
 152
 153         For example,
 154         @code
 155             wxStaticText *text;
 156             ...
 157             text->SetLabelMarkup("<b>&amp;Bed</b> &amp;mp; "
 158                                  "<span foreground='red'>breakfast</span> "
 159                                  "available <big>HERE</big>");
 160         @endcode
 161         would show the string using bold, red and big for the corresponding
 162         words under wxGTK but will simply show the string "Bed &amp; breakfast
 163         available HERE" on the other platforms. In any case, the "B" of "Bed"
 164         will be underlined to indicate that it can be used as a mnemonic for
 165         this control.
 166
 167         The supported tags are:
 168         <TABLE>
 169             <TR>
 170                 <TD><b>Tag</b></TD>
 171                 <TD><b>Description</b></TD>
 172             </TR>
 173             <TR>
 174                 <TD>&lt;b&gt;</TD>
 175                 <TD>bold text</TD>
 176             </TR>
 177             <TR>
 178                 <TD>&lt;big&gt;</TD>
 179                 <TD>bigger text</TD>
 180             </TR>
 181             <TR>
 182                 <TD>&lt;i&gt;</TD>
 183                 <TD>italic text</TD>
 184             </TR>
 185             <TR>
 186                 <TD>&lt;s&gt;</TD>
 187                 <TD>strike-through text</TD>
 188             </TR>
 189             <TR>
 190                 <TD>&lt;small&gt;</TD>
 191                 <TD>smaller text</TD>
 192             </TR>
 193             <TR>
 194                 <TD>&lt;tt&gt;</TD>
 195                 <TD>monospaced text</TD>
 196             </TR>
 197             <TR>
 198                 <TD>&lt;u&gt;</TD>
 199                 <TD>underlined text</TD>
 200             </TR>
 201             <TR>
 202                 <TD>&lt;span&gt;</TD>
 203                 <TD>generic formatter tag, see the table below for supported
 204                 attributes.
 205                 </TD>
 206             </TR>
 207         </TABLE>
 208
 209         Supported @c &lt;span&gt; attributes:
 210         <TABLE>
 211             <TR>
 212                 <TD><b>Name</b></TD>
 213                 <TD><b>Description</b></TD>
 214             </TR>
 215             <TR>
 216                 <TD>foreground, fgcolor, color</TD>
 217                 <TD>Foreground text colour, can be a name or RGB value.</TD>
 218             </TR>
 219             <TR>
 220                 <TD>background, bgcolor</TD>
 221                 <TD>Background text colour, can be a name or RGB value.</TD>
 222             </TR>
 223             <TR>
 224                 <TD>font_family, face</TD>
 225                 <TD>Font face name.</TD>
 226             </TR>
 227             <TR>
 228                 <TD>font_weight, weight</TD>
 229                 <TD>Numeric value in 0..900 range or one of "ultralight",
 230                 "light", "normal" (all meaning non-bold), "bold", "ultrabold"
 231                 and "heavy" (all meaning bold).</TD>
 232             </TR>
 233             <TR>
 234                 <TD>font_style, style</TD>
 235                 <TD>Either "oblique" or "italic" (both with the same meaning)
 236                 or "normal".</TD>
 237             </TR>
 238             <TR>
 239                 <TD>size</TD>
 240                 <TD>The font size can be specified either as "smaller" or
 241                 "larger" relatively to the current font, as a CSS font size
 242                 name ("xx-small", "x-small", "small", "medium", "large",
 243                 "x-large" or "xx-large") or as a number giving font size in
 244                 1024th parts of a point, i.e. 10240 for a 10pt font.</TD>
 245             </TR>
 246         </TABLE>
 247
 248         This markup language is a strict subset of Pango markup (described at
 249         http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html)
 250         and any tags and span attributes not documented above can't be used
 251         under non-GTK platforms.
 252
 253         Also note that you need to escape the following special characters:
 254         <TABLE>
 255             <TR>
 256                 <TD><b>Special character</b></TD>
 257                 <TD><b>Escape as</b></TD>
 258             </TR>
 259             <TR>
 260                 <TD>@c &amp;</TD>
 261                 <TD>@c &amp;amp; or as @c &amp;&amp;</TD>
 262             </TR>
 263             <TR>
 264                 <TD>@c &apos;</TD>
 265                 <TD>@c &amp;apos;</TD>
 266             </TR>
 267             <TR>
 268                 <TD>@c &quot;</TD>
 269                 <TD>@c &amp;quot;</TD>
 270             </TR>
 271             <TR>
 272                 <TD>@c &lt;</TD>
 273                 <TD>@c &amp;lt;</TD>
 274             </TR>
 275             <TR>
 276                 <TD>@c &gt;</TD>
 277                 <TD>@c &amp;gt;</TD>
 278             </TR>
 279         </TABLE>
 280
 281         The non-escaped ampersand @c &amp; characters are interpreted as
 282         mnemonics as with wxControl::SetLabel.
 283
 284
 285         @param markup
 286             String containing markup for the label. It may contain markup tags
 287             described above and newline characters but currently only wxGTK and
 288             wxOSX support multiline labels with markup, the generic
 289             implementation (also used in wxMSW) only handles single line markup
 290             labels. Notice that the string must be well-formed (e.g. all tags
 291             must be correctly closed) and won't be shown at all otherwise.
 292         @return
 293             @true if the new label was set (even if markup in it was ignored)
 294             or @false if we failed to parse the markup. In this case the label
 295             remains unchanged.
 296
 297
 298         Currently wxButton supports markup in all major ports (wxMSW, wxGTK and
 299         wxOSX/Cocoa) while wxStaticText supports it in wxGTK and wxOSX and its
 300         generic version (which can be used under MSW if markup support is
 301         required). Extending support to more controls is planned in the future.
 302
 303         @since 2.9.2
 304     */
 305     bool SetLabelMarkup(const wxString& markup);
 306
 307
 308 public:     // static functions
 309
 310     /**
 311         Returns the given @a label string without mnemonics ("&" characters).
 312     */
 313     static wxString GetLabelText(const wxString& label);
 314
 315     /**
 316         Returns the given @a str string without mnemonics ("&" characters).
 317
 318         @note This function is identical to GetLabelText() and is provided
 319               mostly for symmetry with EscapeMnemonics().
 320     */
 321     static wxString RemoveMnemonics(const wxString& str);
 322
 323     /**
 324         Escapes the special mnemonics characters ("&") in the given string.
 325
 326         This function can be helpful if you need to set the controls label to a
 327         user-provided string. If the string contains ampersands, they wouldn't
 328         appear on the display but be used instead to indicate that the
 329         character following the first of them can be used as a control mnemonic.
 330         While this can sometimes be desirable (e.g. to allow the user to
 331         configure mnemonics of the controls), more often you will want to use
 332         this function before passing a user-defined string to SetLabel().
 333         Alternatively, if the label is entirely user-defined, you can just call
 334         SetLabelText() directly -- but this function must be used if the label
 335         is a combination of a part defined by program containing the control
 336         mnemonics and a user-defined part.
 337
 338         @param text
 339             The string such as it should appear on the display.
 340         @return
 341             The same string with the ampersands in it doubled.
 342      */
 343     static wxString EscapeMnemonics(const wxString& text);
 344
 345     /**
 346         Replaces parts of the @a label string with ellipsis, if needed, so
 347         that it fits into @a maxWidth pixels if possible.
 348
 349         Note that this function does @em not guarantee that the returned string
 350         will always be shorter than @a maxWidth; if @a maxWidth is extremely
 351         small, ellipsized text may be larger.
 352
 353         @param label
 354             The string to ellipsize
 355         @param dc
 356             The DC used to retrieve the character widths through the
 357             wxDC::GetPartialTextExtents() function.
 358         @param mode
 359             The ellipsization mode. This is the setting which determines
 360             which part of the string should be replaced by the ellipsis.
 361             See ::wxEllipsizeMode enumeration values for more info.
 362         @param maxWidth
 363             The maximum width of the returned string in pixels.
 364             This argument determines how much characters of the string need to
 365             be removed (and replaced by ellipsis).
 366         @param flags
 367             One or more of the ::wxEllipsizeFlags enumeration values combined.
 368     */
 369     static wxString Ellipsize(const wxString& label, const wxDC& dc,
 370                               wxEllipsizeMode mode, int maxWidth,
 371                               int flags = wxELLIPSIZE_FLAGS_DEFAULT);
 372 };
 373