[wxWidgets.git] / interface / control.h

/////////////////////////////////////////////////////////////////////////////
// Name:        control.h
// Purpose:     documentation for wxControl class
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/**
    @class wxControl
    @wxheader{control.h}

    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}
    @appearance{control.png}

    @seealso
    wxValidator
*/
class wxControl : public wxWindow
{
public:
    /**
        Simulates the effect of the user issuing a command to the item. See
        wxCommandEvent.
    */
    void Command(wxCommandEvent& event);

    /**
        Returns the control's text.
        
        Note that the returned string contains the mnemonics (@c  characters) if
        any, use GetLabelText() if they are
        undesired.
    */
    wxString GetLabel();

    //@{
    /**
        Returns the control's label, or the given @e label string for the static
        version, without the mnemonics characters.
    */
    const wxString GetLabelText();
    static wxString GetLabelText(const wxString& label);
    //@}

    /**
        Sets the item's text.
        
        The @c  characters in the @e 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 @e Alt key in combination with
        it). To insert a literal ampersand character, you need to double it, i.e. use
        @c "".
    */
    void SetLabel(const wxString& label);
};
Commit	Line	Data
23324ae1 FM	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: control.h
	3	// Purpose: documentation for wxControl class
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/**
	10	@class wxControl
	11	@wxheader{control.h}
7c913512	12
23324ae1	13	This is the base class for a control or "widget''.
7c913512	14
23324ae1 FM	15	A control is generally a small window which processes user input and/or
23324ae1 FM	16	displays one or more item of data.
7c913512	17
23324ae1 FM	18	@library{wxcore}
	19	@category{ctrl}
	20	@appearance{control.png}
7c913512	21
23324ae1 FM	22	@seealso
	23	wxValidator
	24	*/
	25	class wxControl : public wxWindow
	26	{
	27	public:
	28	/**
	29	Simulates the effect of the user issuing a command to the item. See
	30	wxCommandEvent.
	31	*/
	32	void Command(wxCommandEvent& event);
	33
	34	/**
	35	Returns the control's text.
	36
	37	Note that the returned string contains the mnemonics (@c characters) if
	38	any, use GetLabelText() if they are
	39	undesired.
	40	*/
	41	wxString GetLabel();
	42
	43	//@{
	44	/**
	45	Returns the control's label, or the given @e label string for the static
	46	version, without the mnemonics characters.
	47	*/
	48	const wxString GetLabelText();
7c913512	49	static wxString GetLabelText(const wxString& label);
23324ae1 FM	50	//@}
	51
	52	/**
	53	Sets the item's text.
	54
	55	The @c characters in the @e label are special and indicate that the
	56	following character is a mnemonic for this control and can be used to activate
	57	it from the keyboard (typically by using @e Alt key in combination with
7c913512	58	it). To insert a literal ampersand character, you need to double it, i.e. use
23324ae1 FM	59	@c "".
	60	*/
	61	void SetLabel(const wxString& label);
	62	};