.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxToggleButton 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxToggleButton \- 
  A button which stays pressed when clicked by user.
 
.SH DESCRIPTION

  


   wxToggleButton is a button that stays pressed when clicked by the user. In
   other words, it is similar to
   wxCheckBox
   in functionality but looks like a
   wxButton
   .
  
  


   You can see wxToggleButton in action in the sixth page of the
   controls
   sample.
  
  


   
    NB:
   
   This class is not available under wxUniversal ports such as wxX11.
  
 
.SH "PARENTS"

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

  
.SS  wxToggleButton ()

     


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

   
  
.SS  ~wxToggleButton ()

     


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

     


      Creates the toggle button for two-step construction. See
      wxToggleButton::wxToggleButton
      for details.
     
    
   
  
.SS bool GetValue ()

     


      Gets the state of the toggle button.
     
    
   
  
.SS void SetValue (const bool state)

     


      Sets the toggle button to the given state. This does not cause a
      EVT_TOGGLEBUTTON
      event to be emitted.
     
    
 
.SH "WINDOW STYLES"

.SH EVENTS

.SS EVT_TOGGLEBUTTON(id, func)

   Handles button click event.
  
.SH "SEE ALSO"

  wxControl
   
  wxWindow
   
  wxEvtHandler
   
  wxObject
 
  wxCheckBox
  wxButton
 
.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.