wx.StatusBar

Inheritance diagram for wx.StatusBar:

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.

See also

wx.Frame

Derived From

• wx.Window
• wx.EvtHandler
• wx.Object

Window Styles

Window Style	Description
wx.ST_SIZEGRIP	On Windows 95, displays a gripper at right-hand side of the status bar.

Remarks

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

Methods Summary

• __init__
• GetBorderX
• GetBorderY
• GetFieldRect
• GetFields
• GetFieldsCount
• GetStatusText
• PopStatusText
• PushStatusText
• SetFields
• SetFieldsCount
• SetMinHeight
• SetStatusStyles
• SetStatusText
• SetStatusWidths

Properties Summary

• BorderX
• BorderY
• FieldRect
• Fields
• FieldsCount
• StatusText

Class API

Methods

__init__(parent, id=-1, style=wx.ST_SIZEGRIP, name=wx.StatusLineNameStr)

Constructor.

Parameters:

• parent (wx.Window)
• id (int)
• style (long)
• name (string)

Returns:

wx.StatusBar

---

GetBorderX()

No docstrings available for this method.

---

GetBorderY()

No docstrings available for this method.

---

GetFieldRect(i)

Returns the size and position of a field’s internal bounding rectangle.

Parameters:

• i (int): The field in question.

Returns:

wx.Rect

See also

wx.Rect

---

GetFields()

Return a list of field values in the status bar.

Returns:

list of strings

---

GetFieldsCount()

Returns the number of fields in the status bar.

Returns:

int

---

GetStatusText(number)

Returns the string associated with a status bar field.

Parameters:

• number (int)

Returns:

string

See also

SetStatusText

---

PopStatusText(field=0)

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

Parameters:

• field (int)

See also

PushStatusText

---

PushStatusText(string, field=0)

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

Parameters:

• string (string)
• field (int)

---

SetFields(items)

Set the values of the statusbar fields from a list of strings.

Parameters:

• items (list of strings)

---

SetFieldsCount(number=1)

Sets the number of fields, and optionally the field widths.

Parameters:

• number (int): The number of fields.

---

SetMinHeight(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.

Parameters:

• height (int)

---

SetStatusStyles(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:

• styles (int): Contains an array of integers with the styles for each field. There are three possible styles:

  Status Style	Description
  wx.SB_NORMAL	(default) The field appears sunken with a standard 3D border.
  wx.SB_FLAT	No border is painted around the field so that it appears flat.
  wx.SB_RAISED	A raised 3D border is painted around the field.

---

SetStatusText(text, number=0)

Sets the text for one field.

Parameters:

• text (string): The text to be set. Use an empty string (“”) to clear the field.
• number (int): The index of the field.

See also

GetStatusText, wx.Frame.SetStatusText

---

SetStatusWidths(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:

• widths (int): Contains an array of integers, each of which is either an absolute status field width in pixels if positive or indicates a variable width field if negative.

Note

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

SetFieldsCount, wx.Frame.SetStatusWidths

---

Properties

BorderX

See GetBorderX

BorderY

See GetBorderY

FieldRect

See GetFieldRect

Fields

See GetFields and SetFields

FieldsCount

See GetFieldsCount and SetFieldsCount

StatusText

See GetStatusText and SetStatusText