.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxCheckBox 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxCheckBox \- 
  Checkbox control
 
.SH 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.
  
 
.SH "PARENTS"

  wxControl
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
.SH "INCLUDE FILES"
wx/checkbox.h
.SH MEMBERS

  
.SS  wxCheckBox ()

     


      Default constructor.
     
    
.SS  wxCheckBox (wxWindow* parentwxWindowID idconst wxString& labelconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = 0const wxValidator& valconst wxString& name = ``checkBox")

   
  
.SS  ~wxCheckBox ()

     


      Destructor, destroying the checkbox.
     
    
   
  
.SS bool Create (wxWindow* parentwxWindowID idconst wxString& labelconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = 0const wxValidator& valconst wxString& name = ``checkBox")

     


      Creates the checkbox for two-step construction. See
      wxCheckBox::wxCheckBox
      for details.
     
    
   
  
.SS bool GetValue ()

     


      Gets the state of a 2-state checkbox.
     
    
   
  
.SS wxCheckBoxState Get3StateValue ()

     


      Gets the state of a 3-state checkbox.
     
    
   
  
.SS bool Is3rdStateAllowedForUser ()

     


      Returns whether or not the user can set the checkbox to the third state.
     
    
   
  
.SS bool Is3State ()

     


      Returns whether or not the checkbox is a 3-state checkbox.
     
    
   
  
.SS bool IsChecked ()

     


      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.
     
    
   
  
.SS void SetValue (bool state)

     


      Sets the checkbox to the given state. This does not cause a
      wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
     
    
   
  
.SS void Set3StateValue (const wxCheckBoxState state)

     


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

.SS wxCHK_2STATE

   Create a 2-state checkbox. This is the default.
  
.SS wxCHK_3STATE

   wxCHK_3STATE
  
.SS wxCHK_ALLOW_3RD_STATE_FOR_USER

   wxCHK_ALLOW_3RD_STATE_FOR_USER
  
.SS wxALIGN_RIGHT

   Makes the text appear on the left of the checkbox.
  
.SH EVENTS

.SS EVT_CHECKBOX(id, func)

   Process a wxEVT_COMMAND_CHECKBOX_CLICKED event, when the checkbox is clicked.
  
.SH "SEE ALSO"

  wxControl
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
  wxRadioButton
  wxCommandEvent
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.