wxControl Class Reference
[Controls]

#include <wx/control.h>

Inheritance diagram for wxControl:
Inheritance graph
[legend]

Detailed Description

This is the base class for a control or "widget".

A control is generally a small window which processes user input and/or displays one or more item of data.

Events emitted by this class

The following event handler macros redirect the events to member function handlers 'func' with prototypes like:

void handlerFuncName(wxClipboardTextEvent& event)

Event macros for events emitted by this class:

Library:  wxCore
Category:  Controls
See also:
wxValidator

Public Member Functions

virtual void Command (wxCommandEvent &event)
 Simulates the effect of the user issuing a command to the item.
wxString GetLabel () const
 Returns the control's label, as it was passed to SetLabel().
wxString GetLabelText () const
 Returns the control's label without mnemonics.
void SetLabel (const wxString &label)
 Sets the control's label.
void SetLabelText (const wxString &text)
 Sets the control's label to exactly the given string.

Static Public Member Functions

static wxString GetLabelText (const wxString &label)
 Returns the given label string without mnemonics ("&" characters).
static wxString RemoveMnemonics (const wxString &str)
 Returns the given str string without mnemonics ("&" characters).
static wxString EscapeMnemonics (const wxString &text)
 Escapes the special mnemonics characters ("&") in the given string.
static wxString Ellipsize (const wxString &label, const wxDC &dc, wxEllipsizeMode mode, int maxWidth, int flags=wxELLIPSIZE_FLAGS_DEFAULT)
 Replaces parts of the label string with ellipsis, if needed, so that it doesn't exceed maxWidth.

List of all members.


Member Function Documentation

virtual void wxControl::Command ( wxCommandEvent event  )  [virtual]

Simulates the effect of the user issuing a command to the item.

See also:
wxCommandEvent
static wxString wxControl::Ellipsize ( const wxString label,
const wxDC dc,
wxEllipsizeMode  mode,
int  maxWidth,
int  flags = wxELLIPSIZE_FLAGS_DEFAULT 
) [static]

Replaces parts of the label string with ellipsis, if needed, so that it doesn't exceed maxWidth.

Note that this functions is guaranteed to always returns a string whose rendering on the given DC takes less than maxWidth pixels in horizontal.

Parameters:
label The string to ellipsize
dc The DC used to retrieve the character widths through the wxDC::GetPartialTextExtents() function.
mode The ellipsization mode. This is the setting which determines which part of the string should be replaced by the ellipsis. See wxEllipsizeMode enumeration values for more info.
maxWidth The maximum width of the returned string in pixels. This argument determines how much characters of the string need to be removed (and replaced by ellipsis).
flags One or more of the wxEllipsizeFlags enumeration values combined.
static wxString wxControl::EscapeMnemonics ( const wxString text  )  [static]

Escapes the special mnemonics characters ("&") in the given string.

This function can be helpful if you need to set the controls label to a user-provided string. If the string contains ampersands, they wouldn't appear on the display but be used instead to indicate that the character following the first of them can be used as a control mnemonic. While this can sometimes be desirable (e.g. to allow the user to configure mnemonics of the controls), more often you will want to use this function before passing a user-defined string to SetLabel(). Alternatively, if the label is entirely user-defined, you can just call SetLabelText() directly -- but this function must be used if the label is a combination of a part defined by program containing the control mnemonics and a user-defined part.

Parameters:
text The string such as it should appear on the display.
Returns:
The same string with the ampersands in it doubled.
wxString wxControl::GetLabel (  )  const [virtual]

Returns the control's label, as it was passed to SetLabel().

Note that the returned string may contains mnemonics ("&" characters) if they were passed to the SetLabel() function; use GetLabelText() if they are undesired.

Also note that the returned string is always the string which was passed to SetLabel() but may be different from the string passed to SetLabelText() (since this last one escapes mnemonic characters).

Reimplemented from wxWindow.

Reimplemented in wxButton, and wxStaticText.

static wxString wxControl::GetLabelText ( const wxString label  )  [static]

Returns the given label string without mnemonics ("&" characters).

Reimplemented in wxStaticText.

wxString wxControl::GetLabelText (  )  const

Returns the control's label without mnemonics.

Note that because of the stripping of the mnemonics the returned string may differ from the string which was passed to SetLabel() but should always be the same which was passed to SetLabelText().

Reimplemented in wxStaticText.

static wxString wxControl::RemoveMnemonics ( const wxString str  )  [static]

Returns the given str string without mnemonics ("&" characters).

Note:
This function is identic to GetLabelText() and is provided both for symmetry with the wxStaticText::RemoveMarkup() function and to allow to write more readable code (since this function has a more descriptive name respect GetLabelText()).
void wxControl::SetLabel ( const wxString label  )  [virtual]

Sets the control's label.

All "&" characters in the label are special and indicate that the following character is a mnemonic for this control and can be used to activate it from the keyboard (typically by using Alt key in combination with it). To insert a literal ampersand character, you need to double it, i.e. use use "&&". If this behaviour is undesirable, use SetLabelText() instead.

Reimplemented from wxWindow.

Reimplemented in wxButton, and wxStaticText.

void wxControl::SetLabelText ( const wxString text  ) 

Sets the control's label to exactly the given string.

Unlike SetLabel(), this function shows exactly the text passed to it in the control, without interpreting ampersands in it in any way. Notice that it means that the control can't have any mnemonic defined for it using this function.

See also:
EscapeMnemonics()

Reimplemented in wxStaticText.

 All Classes Files Functions Variables Typedefs Enumerations Enumerator Friends Defines



wxWidgets logo

[ top ]