.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxStatusBar 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxStatusBar \- 
  Implements the status bar on a frame
 
.SH DESCRIPTION

  


   A status bar is a narrow window that can be placed along the bottom of a
   frame to give small amounts of status information. It can contain one or more
   fields, one or more of which can be variable length according to the size of
   the window.
  
  


   wxWindow
   

   wxEvtHandler
   

   wxObject
  
 
.SH REMARKS

  
   It is possible to create controls and other windows on the status bar.
   Position these windows from an
   
    OnSize
   
   event handler.
  
 
.SH "PARENTS"

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

  
.SS  wxStatusBar ()

     


      Default constructor.
     
    
.SS  wxStatusBar (wxWindow* parentwxWindowID idlong style = wxST_SIZEGRIPconst wxString& name = ``statusBar")

     


      Constructor, creating the window.
     
    
   
  
.SS void ~wxStatusBar ()

     


      Destructor.
     
    
   
  
.SS bool Create (wxWindow* parentwxWindowID idlong style = wxST_SIZEGRIPconst wxString& name = ``statusBar")

     


      Creates the window, for two-step construction.
     
     


      See
      wxStatusBar::wxStatusBar
      for details.
     
    
   
  
.SS virtual bool GetFieldRect (int iwxRect& rect)

     


      Returns the size and position of a field's internal bounding rectangle.
     
    
   
  
.SS int GetFieldsCount ()

     


      Returns the number of fields in the status bar.
     
    
   
  
.SS virtual wxString GetStatusText (int i = 0)

     


      Returns the string associated with a status bar field.
     
    
   
  
.SS void PopStatusText (int field = 0)

     


      Sets the field text to the top of the stack, and pops the stack of saved
      strings.
     
    
   
  
.SS void PushStatusText (const wxString& stringint field = 0)

     


      Saves the current field text in a per field stack, and sets the field text
      to the string passed as argument.
     
    
   
  
.SS virtual void SetFieldsCount (int number = 1int* widths = NULL)

     


      Sets the number of fields, and optionally the field widths.
     
    
   
  
.SS void SetMinHeight (int height)

     


      Sets the minimal possible height for the status bar. The real height may
      be bigger than the height specified here depending on the size of the font
      used by the status bar.
     
    
   
  
.SS virtual void SetStatusText (const wxString& textint i = 0)

   
  
.SS virtual void SetStatusWidths (int nint *widths)

   
  
.SS virtual void SetStatusStyles (int nint *styles)

     


      Sets the styles of the fields in the status line which can make fields
      appear flat or raised instead of the standard sunken 3D border.
     
    
 
.SH "WINDOW STYLES"

.SS wxST_SIZEGRIP

   wxST_SIZEGRIP
  
.SH "SEE ALSO"

  wxWindow
   
  wxEvtHandler
   
  wxObject
 
  wxFrame
  Status bar sample
 
.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.