.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxGauge 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxGauge \- 
  A control to represent a varying quantity, such as time remaining
 
.SH DESCRIPTION

  


   A gauge is a horizontal or vertical bar which shows a quantity (often time).
   There are no user commands for the gauge.
  
 
.SH "PARENTS"

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

  
.SS  wxGauge ()

     


      Default constructor.
     
    
.SS  wxGauge (wxWindow* parentwxWindowID idint rangeconst wxPoint&  pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxGA_HORIZONTALconst wxValidator& validator = wxDefaultValidatorconst wxString& name = ``gauge")

     


      Constructor, creating and showing a gauge.
     
    
   
  
.SS  ~wxGauge ()

     


      Destructor, destroying the gauge.
     
    
   
  
.SS bool Create (wxWindow* parentwxWindowID idint rangeconst wxPoint&  pos = wxDefaultPositionconst wxSize& size = wxDefaultSizelong style = wxGA_HORIZONTALconst wxValidator& validator = wxDefaultValidatorconst wxString& name = ``gauge")

     


      Creates the gauge for two-step construction. See
      wxGauge::wxGauge
      for further details.
     
    
   
  
.SS int GetBezelFace ()

     


      Returns the width of the 3D bezel face.
     
    
   
  
.SS int GetRange ()

     


      Returns the maximum position of the gauge.
     
    
   
  
.SS int GetShadowWidth ()

     


      Returns the 3D shadow margin width.
     
    
   
  
.SS int GetValue ()

     


      Returns the current position of the gauge.
     
    
   
  
.SS bool IsVertical ()

     


      Returns true if the gauge is vertical (has
      wxGA_VERTICAL
      style) and false otherwise.
     
    
   
  
.SS void SetBezelFace (int width)

     


      Sets the 3D bezel face width.
     
    
   
  
.SS void SetRange (int range)

     


      Sets the range (maximum value) of the gauge.
     
    
   
  
.SS void SetShadowWidth (int width)

     


      Sets the 3D shadow width.
     
    
   
  
.SS void SetValue (int pos)

     


      Sets the position of the gauge.
     
    
 
.SH "WINDOW STYLES"

.SS wxGA_HORIZONTAL

   Creates a horizontal gauge.
  
.SS wxGA_VERTICAL

   Creates a vertical gauge.
  
.SS wxGA_SMOOTH

   Creates smooth progress bar with one pixel wide update step (not supported by
   all platforms).
  
.SH EVENTS

.SH "SEE ALSO"

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