X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..5377e4e707a7c25c3ff7fcd071a1f799b8d8c56c:/interface/statusbr.h

diff --git a/interface/statusbr.h b/interface/statusbr.h
index 7519844439..2d4ca10da5 100644
--- a/interface/statusbr.h
+++ b/interface/statusbr.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        statusbr.h
-// Purpose:     documentation for wxStatusBar class
+// Purpose:     interface of wxStatusBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -23,7 +23,7 @@
     wxObject
 
     @beginStyleTable
-    @style{wxST_SIZEGRIP}:
+    @style{wxST_SIZEGRIP}
            On Windows 95, displays a gripper at right-hand side of the status
            bar.
     @endStyleTable
@@ -31,8 +31,7 @@
     @library{wxcore}
     @category{miscwnd}
 
-    @seealso
-    wxFrame, @ref overview_samplestatbar "Status bar sample"
+    @see wxFrame, @ref overview_samplestatbar "Status bar sample"
 */
 class wxStatusBar : public wxWindow
 {
@@ -40,7 +39,7 @@ public:
     //@{
     /**
         Constructor, creating the window.
-        
+
         @param parent
             The window parent, usually a frame.
         @param id
@@ -53,7 +52,7 @@ public:
         item,
             allowing the application user to set Motif resource values for
             individual windows.
-        
+
         @see Create()
     */
     wxStatusBar();
@@ -77,40 +76,40 @@ public:
 
     /**
         Returns the size and position of a field's internal bounding rectangle.
-        
+
         @param i
             The field in question.
         @param rect
             The rectangle values are placed in this variable.
-        
-        @returns @true if the field index is valid, @false otherwise.
-        
+
+        @return @true if the field index is valid, @false otherwise.
+
         @see wxRect
     */
-    virtual bool GetFieldRect(int i, wxRect& rect);
+    virtual bool GetFieldRect(int i, wxRect& rect) const;
 
     /**
         Returns the number of fields in the status bar.
     */
-    int GetFieldsCount();
+    int GetFieldsCount() const;
 
     /**
         Returns the string associated with a status bar field.
-        
+
         @param i
             The number of the status field to retrieve, starting from zero.
-        
-        @returns The status field string if the field is valid, otherwise the
+
+        @return The status field string if the field is valid, otherwise the
                  empty string.
-        
+
         @see SetStatusText()
     */
-    virtual wxString GetStatusText(int i = 0);
+    virtual wxString GetStatusText(int i = 0) const;
 
     /**
         Sets the field text to the top of the stack, and pops the stack of saved
         strings.
-        
+
         @see PushStatusText()
     */
     void PopStatusText(int field = 0);
@@ -123,7 +122,7 @@ public:
 
     /**
         Sets the number of fields, and optionally the field widths.
-        
+
         @param number
             The number of fields.
         @param widths
@@ -143,7 +142,7 @@ public:
         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.
-        
+
         @param n
             The number of fields in the status bar. Must be equal to the
             number passed to SetFieldsCount the last
@@ -151,52 +150,52 @@ public:
         @param 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 SetStatusStyles(int n, int* styles);
 
     /**
         Sets the text for one field.
-        
+
         @param text
             The text to be set. Use an empty string ("") to clear the field.
         @param i
             The field to set, starting from zero.
-        
+
         @see GetStatusText(), wxFrame::SetStatusText
     */
     virtual void SetStatusText(const wxString& text, int i = 0);
@@ -212,7 +211,7 @@ public:
         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.
-        
+
         @param n
             The number of fields in the status bar. Must be equal to the
             number passed to SetFieldsCount the last
@@ -221,13 +220,14 @@ public:
             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 SetFieldsCount(), wxFrame::SetStatusWidths
     */
     virtual void SetStatusWidths(int n, int* widths);
 };
+