X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4701dc09838c3da46a8bc2836265a7dffee541ee..d8efd2198ff050ca5a5726bcad0f42692fe872df:/interface/wx/statusbr.h diff --git a/interface/wx/statusbr.h b/interface/wx/statusbr.h index ea9c25058a..339a3e5fc2 100644 --- a/interface/wx/statusbr.h +++ b/interface/wx/statusbr.h @@ -15,14 +15,12 @@ @beginStyleTable @style{wxST_SIZEGRIP} - On Windows 95, displays a gripper at right-hand side of the status bar. + Displays a gripper at the right-hand side of the status bar. @endStyleTable - @todo reference to win95 may be old and wrong - @remarks It is possible to create controls and other windows on the status bar. - Position these windows from an OnSize event handler. + Position these windows from an OnSize() event handler. @library{wxcore} @category{miscwnd} @@ -56,7 +54,7 @@ public: */ wxStatusBar(wxWindow* parent, wxWindowID id = wxID_ANY, long style = wxST_SIZEGRIP, - const wxString& name = "statusBar"); + const wxString& name = wxStatusBarNameStr); /** Destructor. @@ -69,7 +67,7 @@ public: */ bool Create(wxWindow* parent, wxWindowID id = wxID_ANY, long style = wxST_SIZEGRIP, - const wxString& name = "statusBar"); + const wxString& name = wxStatusBarNameStr); /** Returns the size and position of a field's internal bounding rectangle. @@ -114,6 +112,8 @@ public: /** Saves the current field text in a per field stack, and sets the field text to the string passed as argument. + + @see PopStatusText() */ void PushStatusText(const wxString& string, int field = 0); @@ -126,7 +126,7 @@ public: An array of n integers interpreted in the same way as in SetStatusWidths(). */ - virtual void SetFieldsCount(int number = 1, int* widths = NULL); + virtual void SetFieldsCount(int number = 1, const int* widths = NULL); /** Sets the minimal possible height for the status bar. @@ -150,7 +150,7 @@ public: - 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 SetStatusStyles(int n, int* styles); + virtual void SetStatusStyles(int n, const int* styles); /** Sets the text for one field. @@ -166,7 +166,7 @@ public: /** 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 + fields: @b fixed widths and @b 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 @@ -180,10 +180,11 @@ public: @param n The number of fields in the status bar. Must be equal to the number passed to SetFieldsCount() the last time it was called. - @param widths + @param 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. + The special value @NULL means that all fields should get the same width. @remarks The widths of the variable fields are calculated from the total width of all fields, minus the sum of widths of the @@ -191,6 +192,6 @@ public: @see SetFieldsCount(), wxFrame::SetStatusWidths() */ - virtual void SetStatusWidths(int n, int* widths); + virtual void SetStatusWidths(int n, const int* widths_field); };