1 /////////////////////////////////////////////////////////////////////////////
3 // Purpose: interface of wxControl
4 // Author: wxWidgets team
6 // Licence: wxWindows licence
7 /////////////////////////////////////////////////////////////////////////////
10 Flags used by wxControl::Ellipsize function.
15 wxELLIPSIZE_FLAGS_NONE
= 0,
18 Take mnemonics into account when calculating the text width.
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
28 wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS
= 1,
31 Expand tabs in spaces when calculating the text width.
33 This flag tells wxControl::Ellipsize() to calculate the width of tab
34 characters @c '\\t' as 6 spaces.
36 wxELLIPSIZE_FLAGS_EXPAND_TABS
= 2,
38 /// The default flags for wxControl::Ellipsize.
39 wxELLIPSIZE_FLAGS_DEFAULT
= wxELLIPSIZE_FLAGS_PROCESS_MNEMONICS
|
40 wxELLIPSIZE_FLAGS_EXPAND_TABS
45 The different ellipsization modes supported by the
46 wxControl::Ellipsize function.
50 /// Don't ellipsize the text at all. @since 2.9.1
53 /// Put the ellipsis at the start of the string, if the string needs ellipsization.
56 /// Put the ellipsis in the middle of the string, if the string needs ellipsization.
59 /// Put the ellipsis at the end of the string, if the string needs ellipsization.
66 This is the base class for a control or "widget".
68 A control is generally a small window which processes user input and/or
69 displays one or more item of data.
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
77 @event{EVT_TEXT_PASTE(id, func)}
78 Clipboard content was pasted into the control.
86 class wxControl
: public wxWindow
90 Simulates the effect of the user issuing a command to the item.
94 virtual void Command(wxCommandEvent
& event
);
97 Returns the control's label, as it was passed to SetLabel().
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.
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).
106 wxString
GetLabel() const;
109 Returns the control's label without mnemonics.
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().
115 wxString
GetLabelText() const;
118 Sets the control's label.
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 use "&&". If this behaviour is undesirable, use
125 SetLabelText() instead.
127 void SetLabel(const wxString
& label
);
130 Sets the control's label to exactly the given string.
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.
137 @see EscapeMnemonics()
139 void SetLabelText(const wxString
& text
);
141 // NB: when writing docs for the following function remember that Doxygen
142 // will always expand HTML entities (e.g. ") and thus we need to
143 // write e.g. "&lt;" to have in the output the "<" string.
146 Sets the controls label to a string using markup.
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 (currently only wxStaticText under GTK+ 2). If markup is not supported
151 by the control or platform, it is simply stripped and SetLabel() is
152 used with the resulting string.
158 text->SetLabelMarkup("<b>&Bed</b> &mp; "
159 "<span foreground='red'>breakfast</span> "
160 "available <big>HERE</big>");
162 would show the string using bold, red and big for the corresponding
163 words under wxGTK but will simply show the string "Bed & breakfast
164 available HERE" on the other platforms. In any case, the "B" of "Bed"
165 will be underlined to indicate that it can be used as a mnemonic for
168 The supported tags are:
172 <TD><b>Description</b></TD>
188 <TD>strike-through text</TD>
191 <TD><small></TD>
192 <TD>smaller text</TD>
196 <TD>monospaced text</TD>
200 <TD>underlined text</TD>
203 <TD><span></TD>
204 <TD>generic formatter tag, see the table below for supported
210 Supported @c <span> attributes:
214 <TD><b>Description</b></TD>
217 <TD>foreground, fgcolor, color</TD>
218 <TD>Foreground text colour, can be a name or RGB value.</TD>
221 <TD>background, bgcolor</TD>
222 <TD>Background text colour, can be a name or RGB value.</TD>
225 <TD>font_family, face</TD>
226 <TD>Font face name.</TD>
229 <TD>font_weight, weight</TD>
230 <TD>Numeric value in 0..900 range or one of "ultralight",
231 "light", "normal" (all meaning non-bold), "bold", "ultrabold"
232 and "heavy" (all meaning bold).</TD>
235 <TD>font_style, style</TD>
236 <TD>Either "oblique" or "italic" (both with the same meaning)
241 <TD>The font size can be specified either as "smaller" or
242 "larger" relatively to the current font, as a CSS font size
243 name ("xx-small", "x-small", "small", "medium", "large",
244 "x-large" or "xx-large") or as a number giving font size in
245 1024th parts of a point, i.e. 10240 for a 10pt font.</TD>
249 This markup language is a strict subset of Pango markup (described at
250 http://library.gnome.org/devel/pango/unstable/PangoMarkupFormat.html)
251 and any tags and span attributes not documented above can't be used
252 under non-GTK platforms.
254 Also note that you need to escape the following special characters:
257 <TD><b>Special character</b></TD>
258 <TD><b>Escape as</b></TD>
262 <TD>@c &amp; or as @c &&</TD>
266 <TD>@c &apos;</TD>
270 <TD>@c &quot;</TD>
282 The non-escaped ampersand @c & characters are interpreted as
283 mnemonics as with wxControl::SetLabel.
287 String containing markup for the label. It may contain newline
288 characters and the markup tags described above.
290 @true if the new label was set (even if markup in it was ignored)
291 or @false if we failed to parse the markup. In this case the label
294 Note that the string must be well-formed (e.g. all tags must be correctly
295 closed) and won't be shown at all otherwise.
299 bool SetLabelMarkup(const wxString
& markup
);
302 public: // static functions
305 Returns the given @a label string without mnemonics ("&" characters).
307 static wxString
GetLabelText(const wxString
& label
);
310 Returns the given @a str string without mnemonics ("&" characters).
312 @note This function is identical to GetLabelText() and is provided
313 mostly for symmetry with EscapeMnemonics().
315 static wxString
RemoveMnemonics(const wxString
& str
);
318 Escapes the special mnemonics characters ("&") in the given string.
320 This function can be helpful if you need to set the controls label to a
321 user-provided string. If the string contains ampersands, they wouldn't
322 appear on the display but be used instead to indicate that the
323 character following the first of them can be used as a control mnemonic.
324 While this can sometimes be desirable (e.g. to allow the user to
325 configure mnemonics of the controls), more often you will want to use
326 this function before passing a user-defined string to SetLabel().
327 Alternatively, if the label is entirely user-defined, you can just call
328 SetLabelText() directly -- but this function must be used if the label
329 is a combination of a part defined by program containing the control
330 mnemonics and a user-defined part.
333 The string such as it should appear on the display.
335 The same string with the ampersands in it doubled.
337 static wxString
EscapeMnemonics(const wxString
& text
);
340 Replaces parts of the @a label string with ellipsis, if needed, so
341 that it fits into @a maxWidth pixels if possible.
343 Note that this function does @em not guarantee that the returned string
344 will always be shorter than @a maxWidth; if @a maxWidth is extremely
345 small, ellipsized text may be larger.
348 The string to ellipsize
350 The DC used to retrieve the character widths through the
351 wxDC::GetPartialTextExtents() function.
353 The ellipsization mode. This is the setting which determines
354 which part of the string should be replaced by the ellipsis.
355 See ::wxEllipsizeMode enumeration values for more info.
357 The maximum width of the returned string in pixels.
358 This argument determines how much characters of the string need to
359 be removed (and replaced by ellipsis).
361 One or more of the ::wxEllipsizeFlags enumeration values combined.
363 static wxString
Ellipsize(const wxString
& label
, const wxDC
& dc
,
364 wxEllipsizeMode mode
, int maxWidth
,
365 int flags
= wxELLIPSIZE_FLAGS_DEFAULT
);