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     /**
  91         Constructs a control.
  92
  93         @param parent
  94             Pointer to a parent window.
  95         @param id
  96             Control identifier. If wxID_ANY, will automatically create an identifier.
  97         @param pos
  98             Control position. wxDefaultPosition indicates that wxWidgets
  99             should generate a default position for the control.
 100         @param size
 101             Control size. wxDefaultSize indicates that wxWidgets should generate
 102             a default size for the window. If no suitable size can  be found, the
 103             window will be sized to 20x20 pixels so that the window is visible but
 104             obviously not correctly sized.
 105         @param style
 106             Control style. For generic window styles, please see wxWindow.
 107         @param name
 108             Control name.
 109     */
 110    wxControl(wxWindow *parent, wxWindowID id,
 111              const wxPoint& pos = wxDefaultPosition,
 112              const wxSize& size = wxDefaultSize, long style = 0,
 113              const wxValidator& validator = wxDefaultValidator,
 114              const wxString& name = wxControlNameStr);
 115
 116     /**
 117        Default constructor to allow 2-phase creation.
 118     */
 119     wxControl();
 120
 121     bool Create(wxWindow *parent, wxWindowID id,
 122             const wxPoint& pos = wxDefaultPosition,
 123             const wxSize& size = wxDefaultSize, long style = 0,
 124             const wxValidator& validator = wxDefaultValidator,
 125             const wxString& name = wxControlNameStr);
 126
 127     /**
 128         Simulates the effect of the user issuing a command to the item.
 129
 130         @see wxCommandEvent
 131     */
 132     virtual void Command(wxCommandEvent& event);
 133
 134     /**
 135         Returns the control's label, as it was passed to SetLabel().
 136
 137         Note that the returned string may contains mnemonics ("&" characters) if they were
 138         passed to the SetLabel() function; use GetLabelText() if they are undesired.
 139
 140         Also note that the returned string is always the string which was passed to
 141         SetLabel() but may be different from the string passed to SetLabelText()
 142         (since this last one escapes mnemonic characters).
 143     */
 144     wxString GetLabel() const;
 145
 146     /**
 147         Returns the control's label without mnemonics.
 148
 149         Note that because of the stripping of the mnemonics the returned string may differ
 150         from the string which was passed to SetLabel() but should always be the same which
 151         was passed to SetLabelText().
 152     */
 153     wxString GetLabelText() const;
 154
 155     /**
 156         Sets the control's label.
 157
 158         All "&" characters in the @a label are special and indicate that the
 159         following character is a @e mnemonic for this control and can be used to
 160         activate it from the keyboard (typically by using @e Alt key in
 161         combination with it). To insert a literal ampersand character, you need
 162         to double it, i.e. use "&&". If this behaviour is undesirable, use
 163         SetLabelText() instead.
 164     */
 165     void SetLabel(const wxString& label);
 166
 167     /**
 168         Sets the control's label to exactly the given string.
 169
 170         Unlike SetLabel(), this function shows exactly the @a text passed to it
 171         in the control, without interpreting ampersands in it in any way.
 172         Notice that it means that the control can't have any mnemonic defined
 173         for it using this function.
 174
 175         @see EscapeMnemonics()
 176      */
 177     void SetLabelText(const wxString& text);
 178
 179     // NB: when writing docs for the following function remember that Doxygen
 180     //     will always expand HTML entities (e.g. &quot;) and thus we need to
 181     //     write e.g. "&amp;lt;" to have in the output the "&lt;" string.
 182
 183     /**
 184         Sets the controls label to a string using markup.
 185
 186         Simple markup supported by this function can be used to apply different
 187         fonts or colours to different parts of the control label when supported.
 188         If markup is not supported by the control or platform, it is simply
 189         stripped and SetLabel() is used with the resulting string.
 190
 191         For example,
 192         @code
 193             wxStaticText *text;
 194             ...
 195             text->SetLabelMarkup("<b>&amp;Bed</b> &amp;mp; "
 196                                  "<span foreground='red'>breakfast</span> "
 197                                  "available <big>HERE</big>");
 198         @endcode
 199         would show the string using bold, red and big for the corresponding
 200         words under wxGTK but will simply show the string "Bed &amp; breakfast
 201         available HERE" on the other platforms. In any case, the "B" of "Bed"
 202         will be underlined to indicate that it can be used as a mnemonic for
 203         this control.
 204
 205         The supported tags are:
 206         <TABLE>
 207             <TR>
 208                 <TD><b>Tag</b></TD>
 209                 <TD><b>Description</b></TD>
 210             </TR>
 211             <TR>
 212                 <TD>&lt;b&gt;</TD>
 213                 <TD>bold text</TD>
 214             </TR>
 215             <TR>
 216                 <TD>&lt;big&gt;</TD>
 217                 <TD>bigger text</TD>
 218             </TR>
 219             <TR>
 220                 <TD>&lt;i&gt;</TD>
 221                 <TD>italic text</TD>
 222             </TR>
 223             <TR>
 224                 <TD>&lt;s&gt;</TD>
 225                 <TD>strike-through text</TD>
 226             </TR>
 227             <TR>
 228                 <TD>&lt;small&gt;</TD>
 229                 <TD>smaller text</TD>
 230             </TR>
 231             <TR>
 232                 <TD>&lt;tt&gt;</TD>
 233                 <TD>monospaced text</TD>
 234             </TR>
 235             <TR>
 236                 <TD>&lt;u&gt;</TD>
 237                 <TD>underlined text</TD>
 238             </TR>
 239             <TR>
 240                 <TD>&lt;span&gt;</TD>
 241                 <TD>generic formatter tag, see the table below for supported
 242                 attributes.
 243                 </TD>
 244             </TR>
 245         </TABLE>
 246
 247         Supported @c &lt;span&gt; attributes:
 248         <TABLE>
 249             <TR>
 250                 <TD><b>Name</b></TD>
 251                 <TD><b>Description</b></TD>
 252             </TR>
 253             <TR>
 254                 <TD>foreground, fgcolor, color</TD>
 255                 <TD>Foreground text colour, can be a name or RGB value.</TD>
 256             </TR>
 257             <TR>
 258                 <TD>background, bgcolor</TD>
 259                 <TD>Background text colour, can be a name or RGB value.</TD>
 260             </TR>
 261             <TR>
 262                 <TD>font_family, face</TD>
 263                 <TD>Font face name.</TD>
 264             </TR>
 265             <TR>
 266                 <TD>font_weight, weight</TD>
 267                 <TD>Numeric value in 0..900 range or one of "ultralight",
 268                 "light", "normal" (all meaning non-bold), "bold", "ultrabold"
 269                 and "heavy" (all meaning bold).</TD>
 270             </TR>
 271             <TR>
 272                 <TD>font_style, style</TD>
 273                 <TD>Either "oblique" or "italic" (both with the same meaning)
 274                 or "normal".</TD>
 275             </TR>
 276             <TR>
 277                 <TD>size</TD>
 278                 <TD>The font size can be specified either as "smaller" or
 279                 "larger" relatively to the current font, as a CSS font size
 280                 name ("xx-small", "x-small", "small", "medium", "large",
 281                 "x-large" or "xx-large") or as a number giving font size in
 282                 1024th parts of a point, i.e. 10240 for a 10pt font.</TD>
 283             </TR>
 284         </TABLE>
 285
 286         This markup language is a strict subset of Pango markup (described at
 287         http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html)
 288         and any tags and span attributes not documented above can't be used
 289         under non-GTK platforms.
 290
 291         Also note that you need to escape the following special characters:
 292         <TABLE>
 293             <TR>
 294                 <TD><b>Special character</b></TD>
 295                 <TD><b>Escape as</b></TD>
 296             </TR>
 297             <TR>
 298                 <TD>@c &amp;</TD>
 299                 <TD>@c &amp;amp; or as @c &amp;&amp;</TD>
 300             </TR>
 301             <TR>
 302                 <TD>@c &apos;</TD>
 303                 <TD>@c &amp;apos;</TD>
 304             </TR>
 305             <TR>
 306                 <TD>@c &quot;</TD>
 307                 <TD>@c &amp;quot;</TD>
 308             </TR>
 309             <TR>
 310                 <TD>@c &lt;</TD>
 311                 <TD>@c &amp;lt;</TD>
 312             </TR>
 313             <TR>
 314                 <TD>@c &gt;</TD>
 315                 <TD>@c &amp;gt;</TD>
 316             </TR>
 317         </TABLE>
 318
 319         The non-escaped ampersand @c &amp; characters are interpreted as
 320         mnemonics as with wxControl::SetLabel.
 321
 322
 323         @param markup
 324             String containing markup for the label. It may contain markup tags
 325             described above and newline characters but currently only wxGTK and
 326             wxOSX support multiline labels with markup, the generic
 327             implementation (also used in wxMSW) only handles single line markup
 328             labels. Notice that the string must be well-formed (e.g. all tags
 329             must be correctly closed) and won't be shown at all otherwise.
 330         @return
 331             @true if the new label was set (even if markup in it was ignored)
 332             or @false if we failed to parse the markup. In this case the label
 333             remains unchanged.
 334
 335
 336         Currently wxButton supports markup in all major ports (wxMSW, wxGTK and
 337         wxOSX/Cocoa) while wxStaticText supports it in wxGTK and wxOSX and its
 338         generic version (which can be used under MSW if markup support is
 339         required). Extending support to more controls is planned in the future.
 340
 341         @since 2.9.2
 342     */
 343     bool SetLabelMarkup(const wxString& markup);
 344
 345
 346 public:     // static functions
 347
 348     /**
 349         Returns the given @a label string without mnemonics ("&" characters).
 350     */
 351     static wxString GetLabelText(const wxString& label);
 352
 353     /**
 354         Returns the given @a str string without mnemonics ("&" characters).
 355
 356         @note This function is identical to GetLabelText() and is provided
 357               mostly for symmetry with EscapeMnemonics().
 358     */
 359     static wxString RemoveMnemonics(const wxString& str);
 360
 361     /**
 362         Escapes the special mnemonics characters ("&") in the given string.
 363
 364         This function can be helpful if you need to set the controls label to a
 365         user-provided string. If the string contains ampersands, they wouldn't
 366         appear on the display but be used instead to indicate that the
 367         character following the first of them can be used as a control mnemonic.
 368         While this can sometimes be desirable (e.g. to allow the user to
 369         configure mnemonics of the controls), more often you will want to use
 370         this function before passing a user-defined string to SetLabel().
 371         Alternatively, if the label is entirely user-defined, you can just call
 372         SetLabelText() directly -- but this function must be used if the label
 373         is a combination of a part defined by program containing the control
 374         mnemonics and a user-defined part.
 375
 376         @param text
 377             The string such as it should appear on the display.
 378         @return
 379             The same string with the ampersands in it doubled.
 380      */
 381     static wxString EscapeMnemonics(const wxString& text);
 382
 383     /**
 384         Replaces parts of the @a label string with ellipsis, if needed, so
 385         that it fits into @a maxWidth pixels if possible.
 386
 387         Note that this function does @em not guarantee that the returned string
 388         will always be shorter than @a maxWidth; if @a maxWidth is extremely
 389         small, ellipsized text may be larger.
 390
 391         @param label
 392             The string to ellipsize
 393         @param dc
 394             The DC used to retrieve the character widths through the
 395             wxDC::GetPartialTextExtents() function.
 396         @param mode
 397             The ellipsization mode. This is the setting which determines
 398             which part of the string should be replaced by the ellipsis.
 399             See ::wxEllipsizeMode enumeration values for more info.
 400         @param maxWidth
 401             The maximum width of the returned string in pixels.
 402             This argument determines how much characters of the string need to
 403             be removed (and replaced by ellipsis).
 404         @param flags
 405             One or more of the ::wxEllipsizeFlags enumeration values combined.
 406     */
 407     static wxString Ellipsize(const wxString& label, const wxDC& dc,
 408                               wxEllipsizeMode mode, int maxWidth,
 409                               int flags = wxELLIPSIZE_FLAGS_DEFAULT);
 410 };
 411