wxCheckBox Class Reference
[Controls]

#include <wx/checkbox.h>

Inheritance diagram for wxCheckBox:

List of all members.

---

Detailed Description

A checkbox is a labelled box which by default is either on (checkmark is visible) or off (no checkmark). Optionally (when the wxCHK_3STATE style flag is set) it can have a third state, called the mixed or undetermined state. Often this is used as a "Does Not Apply" state.

Styles:

• wxCHK_2STATE:
  Create a 2-state checkbox. This is the default.
• wxCHK_3STATE:
  Create a 3-state checkbox. Not implemented in wxMGL, wxOS2 and wxGTK built against GTK+ 1.2.
• wxCHK_ALLOW_3RD_STATE_FOR_USER:
  By default a user can't set a 3-state checkbox to the third state. It can only be done from code. Using this flags allows the user to set the checkbox to the third state by clicking.
• wxALIGN_RIGHT:
  Makes the text appear on the left of the checkbox.

Events:

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

void handlerFuncName(wxCommandEvent& event)

Event macros:

• EVT_CHECKBOX(id, func):
  Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox is clicked.

Library:  wxCore

Category:  Controls

See also:

wxRadioButton, wxCommandEvent

Public Member Functions
	wxCheckBox ()
	wxCheckBox (wxWindow *parent, wxWindowID id, const wxString &label, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &name=wxCheckBoxNameStr)
virtual	~wxCheckBox ()
bool	Create (wxWindow *parent, wxWindowID id, const wxString &label, const wxPoint &pos=wxDefaultPosition, const wxSize &size=wxDefaultSize, long style=0, const wxValidator &validator=wxDefaultValidator, const wxString &=wxCheckBoxNameStr)
virtual bool	GetValue () const
wxCheckBoxState	Get3StateValue () const
bool	Is3State () const
bool	Is3rdStateAllowedForUser () const
bool	IsChecked () const
virtual void	SetValue (bool state)
void	Set3StateValue (wxCheckBoxState state)

---

Constructor & Destructor Documentation

wxCheckBox::wxCheckBox

(

)

Default constructor.

See also:

Create(), wxValidator

wxCheckBox::wxCheckBox	(	wxWindow *	parent,
		wxWindowID	id,
		const wxString &	label,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = 0,
		const wxValidator &	validator = wxDefaultValidator,
		const wxString &	name = wxCheckBoxNameStr
	)

Constructor, creating and showing a checkbox.

Parameters:

	parent	Parent window. Must not be NULL.
	id	Checkbox identifier. The value wxID_ANY indicates a default value.
	label	Text to be displayed next to the checkbox.
	pos	Checkbox position. If wxDefaultPosition is specified then a default position is chosen.
	size	Checkbox size. If wxDefaultSize is specified then a default size is chosen.
	style	Window style. See wxCheckBox.
	validator	Window validator.
	name	Window name.

See also:

Create(), wxValidator

virtual wxCheckBox::~wxCheckBox

(

)

[virtual]

Destructor, destroying the checkbox.

---

Member Function Documentation

bool wxCheckBox::Create	(	wxWindow *	parent,
		wxWindowID	id,
		const wxString &	label,
		const wxPoint &	pos = wxDefaultPosition,
		const wxSize &	size = wxDefaultSize,
		long	style = 0,
		const wxValidator &	validator = wxDefaultValidator,
		const wxString &	= wxCheckBoxNameStr
	)

Creates the checkbox for two-step construction. See wxCheckBox() for details.

virtual bool wxCheckBox::GetValue

(

)

const [virtual]

Gets the state of a 2-state checkbox.

Returns:

Returns true if it is checked, false otherwise.

wxCheckBoxState wxCheckBox::Get3StateValue

(

)

const

Gets the state of a 3-state checkbox. Asserts when the function is used with a 2-state checkbox.

bool wxCheckBox::Is3State

(

)

const

Returns whether or not the checkbox is a 3-state checkbox.

Returns:

true if this checkbox is a 3-state checkbox, false if it's a 2-state checkbox.

bool wxCheckBox::Is3rdStateAllowedForUser

(

)

const

Returns whether or not the user can set the checkbox to the third state.

Returns:

true if the user can set the third state of this checkbox, false if it can only be set programmatically or if it's a 2-state checkbox.

bool wxCheckBox::IsChecked

(

)

const

This is just a maybe more readable synonym for GetValue(): just as the latter, it returns true if the checkbox is checked and false otherwise.

virtual void wxCheckBox::SetValue

(

bool

state

)

[virtual]

Sets the checkbox to the given state. This does not cause a wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.

Parameters:

state

If true, the check is on, otherwise it is off.

void wxCheckBox::Set3StateValue

(

wxCheckBoxState

state

)

Sets the checkbox to the given state. This does not cause a wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.

Asserts when the checkbox is a 2-state checkbox and setting the state to wxCHK_UNDETERMINED.