Contents Up Previous Next

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

wxST_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::PopStatusText
wxStatusBar::PushStatusText
wxStatusBar::SetFieldsCount
wxStatusBar::SetMinHeight
wxStatusBar::SetStatusText
wxStatusBar::SetStatusWidths
wxStatusBar::SetStatusStyles


wxStatusBar::wxStatusBar

wxStatusBar()

Default constructor.

wxStatusBar(wxWindow* parent, wxWindowID id, long style = wxST_SIZEGRIP, const wxString& name = "statusBar")

Constructor, creating the window.

Parameters

parent

id

style

name

See also

wxStatusBar::Create


wxStatusBar::~wxStatusBar

void ~wxStatusBar()

Destructor.


wxStatusBar::Create

bool Create(wxWindow* parent, wxWindowID id, long style = wxST_SIZEGRIP, 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 field's internal bounding rectangle.

Parameters

i

rect

Return value

true if the field index is valid, false otherwise.

See also

wxRect

wxPerl note: In wxPerl this function returns a Wx::Rect if the field index is valid, undef otherwise.


wxStatusBar::GetFieldsCount

int GetFieldsCount() const

Returns the number of fields in the status bar.


wxStatusBar::GetStatusText

virtual wxString GetStatusText(int i = 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

wxStatusBar::SetStatusText


wxStatusBar::PopStatusText

void PopStatusText(int field = 0)

Sets the field text to the top of the stack, and pops the stack of saved strings.

See also

wxStatusBar::PushStatusText


wxStatusBar::PushStatusText

void PushStatusText(const wxString& string, int field = 0)

Saves the current field text in a per field stack, and sets the field text to the string passed as argument.


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.

wxPerl note: In wxPerl this function accepts only the n parameter. Use SetStatusWidths to set the field widths.

Parameters

number

widths


wxStatusBar::SetMinHeight

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.


wxStatusBar::SetStatusText

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

Sets the text for one field.

Parameters

text

i

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. There are two types of fields: fixed widths one and variable width fields. For the fixed width fields you should specify their (constant) width in pixels. For the variable width fields, specify a negative number which indicates how the field should expand: the space left for all variable width fields is divided between them according to the absolute value of this number. A variable width field with width of -2 gets twice as much of it as a field with width -1 and so on.

For example, to create one fixed width field of width 100 in the right part of the status bar and two more fields which get 66% and 33% of the remaining space correspondingly, you should use an array containing -2, -1 and 100.

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.

wxPerl note: In wxPerl this method takes as parameters the field widths.


wxStatusBar::SetStatusStyles

virtual void SetStatusStyles(int n, int *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.

Parameters

n

styles