/////////////////////////////////////////////////////////////////////////////
// Name: checkbox.h
-// Purpose: documentation for wxCheckBox class
+// Purpose: interface of wxCheckBox
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
@category{ctrl}
@appearance{checkbox.png}
- @seealso
- wxRadioButton, wxCommandEvent
+ @see wxRadioButton, wxCommandEvent
*/
class wxCheckBox : public wxControl
{
//@{
/**
Constructor, creating and showing a checkbox.
-
+
@param parent
Parent window. Must not be @NULL.
@param id
Window validator.
@param name
Window name.
-
+
@see Create(), wxValidator
*/
wxCheckBox();
/**
Gets the state of a 3-state checkbox.
-
+
@returns Returns wxCHK_UNCHECKED when the checkbox is unchecked,
wxCHK_CHECKED when it is checked and
wxCHK_UNDETERMINED when it's in the undetermined state.
Asserts when the function is used with a 2-state
checkbox.
*/
- wxCheckBoxState Get3StateValue();
+ wxCheckBoxState Get3StateValue() const;
/**
Gets the state of a 2-state checkbox.
-
+
@returns Returns @true if it is checked, @false otherwise.
*/
- bool GetValue();
+ bool GetValue() const;
/**
Returns whether or not the checkbox is a 3-state checkbox.
-
+
@returns Returns @true if this checkbox is a 3-state checkbox, @false if
it's a 2-state checkbox.
*/
- bool Is3State();
+ bool Is3State() const;
/**
Returns whether or not the user can set the checkbox to the third state.
-
+
@returns 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 Is3rdStateAllowedForUser();
+ bool Is3rdStateAllowedForUser() 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.
*/
- bool IsChecked();
+ bool IsChecked() const;
/**
Sets the checkbox to the given state. This does not cause a
wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
-
+
@param state
If @true, the check is on, otherwise it is off.
*/
void SetValue(bool state);
};
+