Correct names of parameters in wxAffineMatrix2D documentation.

[wxWidgets.git] / interface / wx / statusbr.h

diff --git a/interface/wx/statusbr.h b/interface/wx/statusbr.h
index 7fef6ce07944e29c057b5a1f828cb0ef21229f3e..315b674fc7d9ed5b892b3e7afbd1b08291883a4a 100644 (file)
--- a/interface/wx/statusbr.h
+++ b/interface/wx/statusbr.h
@@ -3,12 +3,12 @@
 // Purpose:     interface of wxStatusBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxStatusBar
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxStatusBarPane
 /////////////////////////////////////////////////////////////////////////////
 
 /**
     @class wxStatusBarPane

-    
+

     A status bar pane data container used by wxStatusBar.
 
     @library{wxcore}
     A status bar pane data container used by wxStatusBar.
 
     @library{wxcore}


@@ -33,17 +33,11 @@ public:
         Returns the pane style.
     */
     int GetStyle() const;
         Returns the pane style.
     */
     int GetStyle() const;

-    
+

     /**
     /**

-        Returns the stack of strings pushed on this pane.
-        
-        Note that this stack does include also the string currently displayed in this pane
-        as the version stored in the native status bar control is possibly ellipsized.
-        
-        Also note that GetStack().Last() is the top of the stack (i.e. the string shown 
-        in the status bar).
-    */
-    const wxArrayString& GetStack() const;
+        Returns the text currently shown in this pane.
+     */
+    wxString GetText() const;

 };
 
 /**
 };
 
 /**


@@ -52,7 +46,7 @@ public:
     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.
     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.

-    
+

     wxStatusBar also maintains an independent stack of status texts for each field
     (see PushStatusText() and PopStatusText()).
 
     wxStatusBar also maintains an independent stack of status texts for each field
     (see PushStatusText() and PopStatusText()).
 


@@ -76,20 +70,27 @@ public:
         Replace the end of the status texts with an ellipsis when the status text
         widths exceed the status bar pane's widths (uses wxControl::Ellipsize).
     @style{wxSTB_DEFAULT_STYLE}
         Replace the end of the status texts with an ellipsis when the status text
         widths exceed the status bar pane's widths (uses wxControl::Ellipsize).
     @style{wxSTB_DEFAULT_STYLE}

-        The default style: includes 
-        @c wxSTB_SIZEGRIP|wxSTB_SHOW_TIPS|wxSTB_ELLIPSIZE_END|wxFULL_REPAINT_ON_RESIZE. 
+        The default style: includes
+        @c wxSTB_SIZEGRIP|wxSTB_SHOW_TIPS|wxSTB_ELLIPSIZE_END|wxFULL_REPAINT_ON_RESIZE.

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

+    @remarks
+    Notice that only the first 127 characters of a string will be shown in
+    status bar fields under pre-XP MSW systems (or even under later systems if
+    a proper manifest indicating that the program uses version 6 of common
+    controls library is not used). This is a limitation of the native control
+    on these platforms.
+

     @library{wxcore}
     @category{miscwnd}
 
     @see wxStatusBarPane, wxFrame, @ref page_samples_statbar
 */
     @library{wxcore}
     @category{miscwnd}
 
     @see wxStatusBarPane, wxFrame, @ref page_samples_statbar
 */

-class wxStatusBar : public wxWindow
+class wxStatusBar : public wxControl

 {
 public:
     /**
 {
 public:
     /**


@@ -141,29 +142,34 @@ public:
 
         @return @true if the field index is valid, @false otherwise.
 
 
         @return @true if the field index is valid, @false otherwise.
 

+        @beginWxPerlOnly
+        In wxPerl this function returns a @c Wx::Rect if the field
+        index is valid, @c undef otherwise.
+        @endWxPerlOnly
+

         @see wxRect
     */
     virtual bool GetFieldRect(int i, wxRect& rect) const;
         @see wxRect
     */
     virtual bool GetFieldRect(int i, wxRect& rect) const;

-    
+

     /**
     /**

-        Returns the number of fields in the status bar. 
+        Returns the number of fields in the status bar.

     */
     int GetFieldsCount() const;
     */
     int GetFieldsCount() const;

-    
+

     /**
         Returns the wxStatusBarPane representing the @a n-th field.
     */
     const wxStatusBarPane& GetField(int n) const;
     /**
         Returns the wxStatusBarPane representing the @a n-th field.
     */
     const wxStatusBarPane& GetField(int n) const;

-    
+

     /**
         Returns the horizontal and vertical borders used when rendering the field
         text inside the field area.
     /**
         Returns the horizontal and vertical borders used when rendering the field
         text inside the field area.

-        
+

         Note that the rect returned by GetFieldRect() already accounts for the
         presence of horizontal and vertical border returned by this function.
     */
     wxSize GetBorders() const;
         Note that the rect returned by GetFieldRect() already accounts for the
         presence of horizontal and vertical border returned by this function.
     */
     wxSize GetBorders() const;

-    
+

     /**
         Returns the string associated with a status bar field.
 
     /**
         Returns the string associated with a status bar field.
 


@@ -177,39 +183,36 @@ public:
     */
     virtual wxString GetStatusText(int i = 0) const;
 
     */
     virtual wxString GetStatusText(int i = 0) const;
 

-    /**
-        Returns the stack of strings pushed (see PushStatusText()) on the
-        @a n-th field.
-        
-        See wxStatusBarPane::GetStack() for more info.
-    */
-    const wxArrayString& GetStatusStack(int n) const;
-

     /**
         Returns the width of the @a n-th field.
     /**
         Returns the width of the @a n-th field.

-        
+

         See wxStatusBarPane::GetWidth() for more info.
     */
     int GetStatusWidth(int n) const;
 
     /**
         Returns the style of the @a n-th field.
         See wxStatusBarPane::GetWidth() for more info.
     */
     int GetStatusWidth(int n) const;
 
     /**
         Returns the style of the @a n-th field.

-        
+

         See wxStatusBarPane::GetStyle() for more info.
     */
     int GetStatusStyle(int n) const;
         See wxStatusBarPane::GetStyle() for more info.
     */
     int GetStatusStyle(int n) const;

-        
+

     /**
     /**

-        Sets the field text to the top of the stack, and pops the stack of saved
-        strings.
+        Restores the text to the value it had before the last call to
+        PushStatusText().
+
+        Notice that if SetStatusText() had been called in the meanwhile,
+        PopStatusText() will not change the text, i.e. it does not override
+        explicit changes to status text but only restores the saved text if it
+        hadn't been changed since.

 
         @see PushStatusText()
     */
     void PopStatusText(int field = 0);
 
     /**
 
         @see PushStatusText()
     */
     void PopStatusText(int field = 0);
 
     /**

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

 
         @see PopStatusText()
     */
 
         @see PopStatusText()
     */


@@ -224,6 +227,11 @@ public:
         @param widths
             An array of n integers interpreted in the same way as
             in SetStatusWidths().
         @param widths
             An array of n integers interpreted in the same way as
             in SetStatusWidths().

+
+        @beginWxPerlOnly
+        In wxPerl this function accepts only the @a number parameter.
+        Use SetStatusWidths to set the field widths.
+        @endWxPerlOnly

     */
     virtual void SetFieldsCount(int number = 1, const int* widths = NULL);
 
     */
     virtual void SetFieldsCount(int number = 1, const int* widths = NULL);
 


@@ -243,7 +251,7 @@ public:
             The number of fields in the status bar. Must be equal to the
             number passed to SetFieldsCount() the last time it was called.
         @param styles
             The number of fields in the status bar. Must be equal to the
             number passed to SetFieldsCount() the last time it was called.
         @param styles

-            Contains an array of @a n integers with the styles for each field. 
+            Contains an array of @a n integers with the styles for each field.

             There are three possible styles:
             - @c wxSB_NORMAL (default): The field appears sunken with a standard 3D border.
             - @c wxSB_FLAT: No border is painted around the field so that it appears flat.
             There are three possible styles:
             - @c wxSB_NORMAL (default): The field appears sunken with a standard 3D border.
             - @c wxSB_FLAT: No border is painted around the field so that it appears flat.


@@ -253,10 +261,13 @@ public:
 
     /**
         Sets the status text for the @a i-th field.
 
     /**
         Sets the status text for the @a i-th field.

-        
-        The given text will replace the current text. Note that unlike PushStatusText()
-        this function won't save the current text (and calling PopStatusText() won't
-        restore it!).
+
+        The given text will replace the current text.
+
+        Note that if PushStatusText() had been called before the new text will
+        also replace the last saved value to make sure that the next call to
+        PopStatusText() doesn't restore the old value, which was overwritten by
+        the call to this function.

 
         @param text
             The text to be set. Use an empty string ("") to clear the field.
 
         @param text
             The text to be set. Use an empty string ("") to clear the field.


@@ -293,6 +304,10 @@ public:
                  width of all fields, minus the sum of widths of the
                  non-variable fields, divided by the number of variable fields.
 
                  width of all fields, minus the sum of widths of the
                  non-variable fields, divided by the number of variable fields.
 

+        @beginWxPerlOnly
+        In wxPerl this method takes as parameters the field widths.
+        @endWxPerlOnly
+

         @see SetFieldsCount(), wxFrame::SetStatusWidths()
     */
     virtual void SetStatusWidths(int n, const int* widths_field);
         @see SetFieldsCount(), wxFrame::SetStatusWidths()
     */
     virtual void SetStatusWidths(int n, const int* widths_field);