5c87527c5a
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@57625 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
95 lines
2.6 KiB
Objective-C
95 lines
2.6 KiB
Objective-C
/////////////////////////////////////////////////////////////////////////////
|
|
// Name: control.h
|
|
// Purpose: interface of wxControl
|
|
// Author: wxWidgets team
|
|
// RCS-ID: $Id$
|
|
// Licence: wxWindows license
|
|
/////////////////////////////////////////////////////////////////////////////
|
|
|
|
/**
|
|
The different ellipsization modes supported by the
|
|
wxControl::Ellipsize function.
|
|
*/
|
|
enum wxEllipsizeMode
|
|
{
|
|
wxELLIPSIZE_START,
|
|
wxELLIPSIZE_MIDDLE,
|
|
wxELLIPSIZE_END
|
|
};
|
|
|
|
/**
|
|
@class wxControl
|
|
|
|
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.
|
|
|
|
@library{wxcore}
|
|
@category{ctrl}
|
|
|
|
@see wxValidator
|
|
*/
|
|
class wxControl : public wxWindow
|
|
{
|
|
public:
|
|
/**
|
|
Simulates the effect of the user issuing a command to the item.
|
|
|
|
@see wxCommandEvent
|
|
*/
|
|
virtual void Command(wxCommandEvent& event);
|
|
|
|
/**
|
|
Replaces parts of the @a label string with ellipsis, if needed, so
|
|
that it doesn't exceed @a maxWidth.
|
|
|
|
@param label
|
|
The string to ellipsize
|
|
@param dc
|
|
The DC used to retrieve the character widths through the
|
|
wxDC::GetPartialTextExtents() function.
|
|
@param mode
|
|
The ellipsization modes. See ::wxEllipsizeMode.
|
|
@param maxWidth
|
|
The maximum width of the returned string in pixels.
|
|
*/
|
|
static wxString Ellipsize(const wxString& label, const wxDC& dc,
|
|
wxEllipsizeMode mode, int maxWidth);
|
|
|
|
/**
|
|
Returns the control's text.
|
|
|
|
@note The returned string contains mnemonics ("&" characters) if it has
|
|
any, use GetLabelText() if they are undesired.
|
|
*/
|
|
wxString GetLabel() const;
|
|
|
|
/**
|
|
Returns the control's label without mnemonics.
|
|
*/
|
|
wxString GetLabelText() const;
|
|
|
|
/**
|
|
Returns the given @a label string without mnemonics ("&" characters).
|
|
*/
|
|
static wxString GetLabelText(const wxString& label);
|
|
|
|
/**
|
|
Removes the mnemonics ("&" characters) from the given string.
|
|
*/
|
|
static wxString RemoveMnemonics(const wxString& str);
|
|
|
|
/**
|
|
Sets the item's text.
|
|
|
|
Any "&" characters in the @a label are special and indicate that the
|
|
following character is a @e mnemonic for this control and can be used to
|
|
activate it from the keyboard (typically by using @e Alt key in
|
|
combination with it).
|
|
To insert a literal ampersand character, you need to double it, i.e. use "&&".
|
|
*/
|
|
void SetLabel(const wxString& label);
|
|
};
|
|
|