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
Derived from
wxWindow
wxEvtHandler
wxObject
Include files
<wx/statusbr.h>
Window styles
wxSB_SIZEGRIP | On Windows 95, displays a gripper at right-hand side of the status bar. |
See also window styles overview.
Remarks
It is possible to create controls and other windows on the status bar. Position these windows from an OnSize event handler.
See also
Members
wxStatusBar::wxStatusBar
wxStatusBar::~wxStatusBar
wxStatusBar::Create
wxStatusBar::GetFieldRect
wxStatusBar::GetFieldsCount
wxStatusBar::GetStatusText
wxStatusBar::DrawField
wxStatusBar::DrawFieldText
wxStatusBar::InitColours
wxStatusBar::OnSysColourChanged
wxStatusBar::SetFieldsCount
wxStatusBar::SetMinHeight
wxStatusBar::SetStatusText
wxStatusBar::SetStatusWidths
wxStatusBar()
Default constructor.
wxStatusBar(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, const wxString& name = "statusBar")
Constructor, creating the window.
Parameters
parent
id
pos
size
style
name
See also
void ~wxStatusBar()
Destructor.
bool Create(wxWindow* parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, const wxString& name = "statusBar")
Creates the window, for two-step construction.
See wxStatusBar::wxStatusBar for details.
virtual bool GetFieldRect(int i, wxRect& rect) const
Returns the size and position of a fields internal bounding rectangle.
Parameters
i
rect
Return value
TRUE if the field index is valid, FALSE otherwise.
See also
int GetFieldsCount() const
Returns the number of fields in the status bar.
virtual wxString GetStatusText(int ir = 0) const
Returns the string associated with a status bar field.
Parameters
i
Return value
The status field string if the field is valid, otherwise the empty string.
See also
virtual void DrawField(wxDC& dc, int i)
Draws a field, including shaded borders and text.
Parameters
dc
i
See also
virtual void DrawFieldText(wxDC& dc, int i)
Draws a field's text.
Parameters
dc
i
See also
virtual void InitColours()
Sets up the background colour and shading pens using suitable system colours (Windows) or tasteful shades of grey (other platforms).
Remarks
This function is called when the window is created, and also from wxStatusBar::OnSysColourChanged on Windows.
See also
wxStatusBar::OnSysColourChanged
void OnSysColourChanged(wxSysColourChangedEvent& event)
Handles a system colour change by calling wxStatusBar::InitColours, and refreshes the window.
Parameters
event
See also
virtual void SetFieldsCount(int number = 1, int* widths = NULL)
Sets the number of fields, and optionally the field widths.
wxPython note: Only the first parameter is accepted. Use SetStatusWidths to set the widths of the fields.
Parameters
number
widths
void SetMinHeight(int height)
Sets the minimal possible hight 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.
virtual void SetStatusText(const wxString& text, int i = 0)
Sets the text for one field.
Parameters
text
i
See also
wxStatusBar::GetStatusText, wxFrame::SetStatusText
virtual void SetStatusWidths(int n, int *widths)
Sets the widths of the fields in the status line.
Parameters
n
widths
Remarks
The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the non-variable fields, divided by the number of variable fields.
See also
wxStatusBar::SetFieldsCount, wxFrame::SetStatusWidths
wxPython note: Only a single parameter is required, a Python list of integers.