## wxStatusBar

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

wxFrame, Status bar sample

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::wxStatusBar

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

The window parent, usually a frame.

id

The window identifier. It may take a value of -1 to indicate a default value.

pos

The window position. A value of (-1, -1) indicates a default position, chosen by either the windowing system or wxWindows, depending on platform.

size

The window size. A value of (-1, -1) indicates a default size, chosen by either the windowing system or wxWindows, depending on platform.

style

The window style. See wxStatusBar.

name

The name of the window. This parameter is used to associate a name with the item, allowing the application user to set Motif resource values for individual windows.

See also

wxStatusBar::Create

### wxStatusBar::~wxStatusBar

void ~wxStatusBar()

Destructor.

### wxStatusBar::Create

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.

### wxStatusBar::GetFieldRect

virtual bool GetFieldRect(int i, wxRect& rect) const

Returns the size and position of a fields internal bounding rectangle.

Parameters

i

The field in question.

rect

The rectangle values are placed in this variable.

Return value

TRUE if the field index is valid, FALSE otherwise.

See also

wxRect

### wxStatusBar::GetFieldsCount

int GetFieldsCount() const

Returns the number of fields in the status bar.

### wxStatusBar::GetStatusText

virtual wxString GetStatusText(int ir = 0) const

Returns the string associated with a status bar field.

Parameters

i

The number of the status field to retrieve, starting from zero.

Return value

The status field string if the field is valid, otherwise the empty string.

See also

wxStatusBar::SetStatusText

### wxStatusBar::DrawField

virtual void DrawField(wxDC& dc, int i)

Draws a field, including shaded borders and text.

Parameters

dc

The device context to draw onto.

i

The field to be drawn.

See also

wxStatusBar::DrawFieldText

### wxStatusBar::DrawFieldText

virtual void DrawFieldText(wxDC& dc, int i)

Draws a field's text.

Parameters

dc

The device context to draw onto.

i

The field whose text is to be drawn.

See also

wxStatusBar::DrawField

### wxStatusBar::InitColours

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

### wxStatusBar::OnSysColourChanged

void OnSysColourChanged(wxSysColourChangedEvent& event)

Handles a system colour change by calling wxStatusBar::InitColours, and refreshes the window.

Parameters

event

The colour change event.

See also

wxStatusBar::InitColours

### wxStatusBar::SetFieldsCount

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

The number of fields.

widths

An array of n integers, each of which is a status field width in pixels. A value of -1 indicates that the field is variable width; at least one field must be -1.

### wxStatusBar::SetMinHeight

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.

### wxStatusBar::SetStatusText

virtual void SetStatusText(const wxString& text, int i = 0)

Sets the text for one field.

Parameters

text

The text to be set. Use an empty string ("") to clear the field.

i

The field to set, starting from zero.

See also

wxStatusBar::GetStatusText, wxFrame::SetStatusText

### wxStatusBar::SetStatusWidths

virtual void SetStatusWidths(int n, int *widths)

Sets the widths of the fields in the status line.

Parameters

n

The number of fields in the status bar.

widths

Must contain an array of n integers, each of which is a status field width in pixels. A value of -1 indicates that the field is variable width; at least one field must be -1. You should delete this array after calling SetStatusWidths.

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.