.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxBitmapButton 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxBitmapButton \- 
  Push button control, displaying a bitmap
 
.SH DESCRIPTION

  


   A bitmap button is a control that contains a bitmap. It may be placed on a
   dialog box
   or
   panel
   , or indeed almost any other window.
  
 
.SH REMARKS

  
   A bitmap button can be supplied with a single bitmap, and wxWidgets will draw
   all button states using this bitmap. If the application needs more control,
   additional bitmaps for the selected state, unpressed focused state, and
   greyed-out state may be supplied.
  
 
.SH "PARENTS"

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

  
.SS  wxBitmapButton ()

     


      Default constructor.
     
    
.SS  wxBitmapButton (wxWindow* parentwxWindowID idconst wxBitmap& bitmapconst wxPoint& pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxBU_AUTODRAWconst wxValidator& validator = wxDefaultValidatorconst wxString& name = ``button")

   
  
.SS  ~wxBitmapButton ()

     


      Destructor, destroying the button.
     
    
   
  
.SS bool Create (wxWindow* parentwxWindowID idconst wxBitmap& bitmapconst wxPoint& posconst wxSize& size = wxDefaultSizelong style = 0const wxValidator& validatorconst wxString& name = ``button")

     


      Button creation function for two-step creation. For more details, see
      wxBitmapButton::wxBitmapButton
      .
     
    
   
  
.SS wxBitmap& GetBitmapDisabled ()

     


      Returns the bitmap for the disabled state.
     
    
   
  
.SS wxBitmap& GetBitmapFocus ()

     


      Returns the bitmap for the focused state.
     
    
   
  
.SS wxBitmap& GetBitmapLabel ()

     


      Returns the label bitmap (the one passed to the constructor).
     
    
   
  
.SS wxBitmap& GetBitmapSelected ()

     


      Returns the bitmap for the selected state.
     
    
   
  
.SS void SetBitmapDisabled (const wxBitmap& bitmap)

     


      Sets the bitmap for the disabled button appearance.
     
    
   
  
.SS void SetBitmapFocus (const wxBitmap& bitmap)

     


      Sets the bitmap for the button appearance when it has the keyboard focus.
     
    
   
  
.SS void SetBitmapLabel (const wxBitmap& bitmap)

     


      Sets the bitmap label for the button.
     
    
   
  
.SS void SetBitmapSelected (const wxBitmap& bitmap)

     


      Sets the bitmap for the selected (depressed) button appearance.
     
    
 
.SH "WINDOW STYLES"

.SS wxBU_AUTODRAW

   wxBU_AUTODRAW
  
.SS wxBU_LEFT

   Left-justifies the bitmap label.
  
.SS wxBU_TOP

   Aligns the bitmap label to the top of the button.
  
.SS wxBU_RIGHT

   Right-justifies the bitmap label.
  
.SS wxBU_BOTTOM

   Aligns the bitmap label to the bottom of the button.
  
.SH EVENTS

.SS EVT_BUTTON(id, func)

   Process a wxEVT_COMMAND_BUTTON_CLICKED event, when the button is clicked.
  
.SH "SEE ALSO"

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