wxStatusBar Class Reference
[Miscellaneous Windows]

#include <wx/statusbr.h>

Inheritance diagram for wxStatusBar:

List of all members.

---

Detailed 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.

Styles:

• wxST_SIZEGRIP:
  Displays a gripper at the 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.

Library:  wxCore

Category:  Miscellaneous Windows

See also:

wxFrame, Status Bar Sample

Public Member Functions
	wxStatusBar ()
	wxStatusBar (wxWindow *parent, wxWindowID id=wxID_ANY, long style=wxST_SIZEGRIP, const wxString &name=wxStatusBarNameStr)
virtual	~wxStatusBar ()
bool	Create (wxWindow *parent, wxWindowID id=wxID_ANY, long style=wxST_SIZEGRIP, const wxString &name=wxStatusBarNameStr)
virtual bool	GetFieldRect (int i, wxRect &rect) const
int	GetFieldsCount () const
virtual wxString	GetStatusText (int i=0) const
void	PopStatusText (int field=0)
void	PushStatusText (const wxString &string, int field=0)
virtual void	SetFieldsCount (int number=1, const int *widths=NULL)
virtual void	SetMinHeight (int height)
virtual void	SetStatusStyles (int n, const int *styles)
virtual void	SetStatusText (const wxString &text, int i=0)
virtual void	SetStatusWidths (int n, const int *widths_field)

---

Constructor & Destructor Documentation

wxStatusBar::wxStatusBar

(

)

Default ctor.

wxStatusBar::wxStatusBar	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		long	style = wxST_SIZEGRIP,
		const wxString &	name = wxStatusBarNameStr
	)

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

Create()

virtual wxStatusBar::~wxStatusBar

(

)

[virtual]

Destructor.

---

Member Function Documentation

bool wxStatusBar::Create	(	wxWindow *	parent,
		wxWindowID	id = wxID_ANY,
		long	style = wxST_SIZEGRIP,
		const wxString &	name = wxStatusBarNameStr
	)

Creates the window, for two-step construction. See wxStatusBar() for details.

virtual bool wxStatusBar::GetFieldRect	(	int	i,
		wxRect &	rect
	)			const [virtual]

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

Parameters:

	i	The field in question.
	rect	The rectangle values are placed in this variable.

Returns:

true if the field index is valid, false otherwise.

See also:

wxRect

int wxStatusBar::GetFieldsCount

(

)

const

Returns the number of fields in the status bar.

virtual wxString wxStatusBar::GetStatusText

(

int

i = 0

)

const [virtual]

Returns the string associated with a status bar field.

Parameters:

i

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

Returns:

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

See also:

SetStatusText()

void wxStatusBar::PopStatusText

(

int

field = 0

)

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

See also:

PushStatusText()

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

virtual void wxStatusBar::SetFieldsCount	(	int	number = 1,
		const int *	widths = NULL
	)			[virtual]

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

Parameters:

	number	The number of fields.
	widths	An array of n integers interpreted in the same way as in SetStatusWidths().

virtual void wxStatusBar::SetMinHeight

(

int

height

)

[virtual]

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.

virtual void wxStatusBar::SetStatusStyles	(	int	n,
		const int *	styles
	)			[virtual]

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	The number of fields in the status bar. Must be equal to the number passed to SetFieldsCount() the last time it was called.
	styles	Contains an array of n integers with the styles for each field. There are three possible styles: wxSB_NORMAL (default): The field appears sunken with a standard 3D border. wxSB_FLAT: No border is painted around the field so that it appears flat. wxSB_RAISED: A raised 3D border is painted around the field.

virtual void wxStatusBar::SetStatusText	(	const wxString &	text,
		int	i = 0
	)			[virtual]

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:

GetStatusText(), wxFrame::SetStatusText

virtual void wxStatusBar::SetStatusWidths	(	int	n,
		const int *	widths_field
	)			[virtual]

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	The number of fields in the status bar. Must be equal to the number passed to SetFieldsCount() the last time it was called.
	widths_field	Contains an array of n integers, each of which is either an absolute status field width in pixels if positive or indicates a variable width field if negative.

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:

SetFieldsCount(), wxFrame::SetStatusWidths()