Make wxPGValidationInfo class instead of struct, re-document it (used at least by...

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

diff --git a/interface/wx/sizer.h b/interface/wx/sizer.h
index 66c5d207faf3851a9bcf99bc557481512d44075a..47f4d875c2d229ce9dd0e6f3c03727eb3447cf5f 100644 (file)
--- a/interface/wx/sizer.h
+++ b/interface/wx/sizer.h
@@ -47,7 +47,7 @@ public:
     wxStdDialogButtonSizer();
 
     /**
     wxStdDialogButtonSizer();
 
     /**

-        Adds a button to the wxStdDialogButtonSizer. The @a button must have 
+        Adds a button to the wxStdDialogButtonSizer. The @a button must have

         one of the following identifiers:
          wxID_OK
          wxID_YES
         one of the following identifiers:
          wxID_OK
          wxID_YES


@@ -122,19 +122,19 @@ public:
     /**
         Deletes the user data and subsizer, if any.
     */
     /**
         Deletes the user data and subsizer, if any.
     */

-    ~wxSizerItem();
+    virtual ~wxSizerItem();

 
     /**
         Calculates the minimum desired size for the item, including any space
         needed by borders.
     */
 
     /**
         Calculates the minimum desired size for the item, including any space
         needed by borders.
     */

-    wxSize CalcMin();
+    virtual wxSize CalcMin();

 
     /**
         Destroy the window or the windows in a subsizer, depending on the type
         of item.
     */
 
     /**
         Destroy the window or the windows in a subsizer, depending on the type
         of item.
     */

-    void DeleteWindows();
+    virtual void DeleteWindows();

 
     /**
         Enable deleting the SizerItem without destroying the contained sizer.
 
     /**
         Enable deleting the SizerItem without destroying the contained sizer.


@@ -195,12 +195,12 @@ public:
     /**
         Get the rectangle of the item on the parent window, excluding borders.
     */
     /**
         Get the rectangle of the item on the parent window, excluding borders.
     */

-    wxRect GetRect();
+    virtual wxRect GetRect();

 
     /**
         Get the current size of the item, as set in the last Layout.
     */
 
     /**
         Get the current size of the item, as set in the last Layout.
     */

-    wxSize GetSize() const;
+    virtual wxSize GetSize() const;

 
     /**
         If this item is tracking a sizer, return it.  @NULL otherwise.
 
     /**
         If this item is tracking a sizer, return it.  @NULL otherwise.


@@ -260,7 +260,7 @@ public:
         adjust the position and size of the item to be within that space
         taking alignment and borders into account.
     */
         adjust the position and size of the item to be within that space
         taking alignment and borders into account.
     */

-    void SetDimension(const wxPoint& pos, const wxSize& size);
+    virtual void SetDimension(const wxPoint& pos, const wxSize& size);

 
     /**
         Set the flag  item attribute.
 
     /**
         Set the flag  item attribute.


@@ -293,16 +293,19 @@ public:
 
     /**
         Set the sizer tracked by this item.
 
     /**
         Set the sizer tracked by this item.

+        @deprecated @todo provide deprecation description

     */
     void SetSizer(wxSizer* sizer);
 
     /**
         Set the size of the spacer tracked by this item.
     */
     void SetSizer(wxSizer* sizer);
 
     /**
         Set the size of the spacer tracked by this item.

+        @deprecated @todo provide deprecation description

     */
     void SetSpacer(const wxSize& size);
 
     /**
     */
     void SetSpacer(const wxSize& size);
 
     /**

-        Set the window to be tracked by thsi item.
+        Set the window to be tracked by this item.
+        @deprecated @todo provide deprecation description

     */
     void SetWindow(wxWindow* window);
 
     */
     void SetWindow(wxWindow* window);
 


@@ -571,17 +574,24 @@ public:
     /**
         Specifies that column @a idx (starting from zero) should be grown if
         there is extra space available to the sizer.
     /**
         Specifies that column @a idx (starting from zero) should be grown if
         there is extra space available to the sizer.

-        The @a proportion parameter has the same meaning as the stretch factor for
-        the sizers() except that if all proportions are 0,
-        then all columns are resized equally (instead of not being resized at all).
+
+        The @a proportion parameter has the same meaning as the stretch factor
+        for the sizers() except that if all proportions are 0, then all columns
+        are resized equally (instead of not being resized at all).
+
+        Notice that the row must not be already growable, if you need to change
+        the proportion you must call RemoveGrowableCol() first and then make it
+        growable (with a different proportion) again. You can use IsColGrowable()
+        to check whether a column is already growable.

     */
     void AddGrowableCol(size_t idx, int proportion = 0);
 
     /**
         Specifies that row idx (starting from zero) should be grown if there
         is extra space available to the sizer.
     */
     void AddGrowableCol(size_t idx, int proportion = 0);
 
     /**
         Specifies that row idx (starting from zero) should be grown if there
         is extra space available to the sizer.

-        See AddGrowableCol() for the description
-        of @a proportion parameter.
+
+        This is identical to AddGrowableCol() except that it works with rows
+        and not columns.

     */
     void AddGrowableRow(size_t idx, int proportion = 0);
 
     */
     void AddGrowableRow(size_t idx, int proportion = 0);
 


@@ -606,6 +616,20 @@ public:
     */
     int GetNonFlexibleGrowMode() const;
 
     */
     int GetNonFlexibleGrowMode() const;
 

+    /**
+        Returns @true if column @a idx is growable.
+
+        @since 2.9.0
+    */
+    bool IsColGrowable(size_t idx);
+
+    /**
+        Returns @true if row @a idx is growable.
+
+        @since 2.9.0
+    */
+    bool IsRowGrowable(size_t idx);
+

     /**
         Specifies that column idx is no longer growable.
     */
     /**
         Specifies that column idx is no longer growable.
     */


@@ -768,7 +792,7 @@ public:
     /**
         The destructor.
     */
     /**
         The destructor.
     */

-    ~wxSizer();
+    virtual ~wxSizer();

 
     /**
         Appends a child to the sizer.
 
     /**
         Appends a child to the sizer.


@@ -947,13 +971,13 @@ public:
         This method is abstract and has to be overwritten by any derived class.
         Here, the sizer will do the actual calculation of its children's minimal sizes.
     */
         This method is abstract and has to be overwritten by any derived class.
         Here, the sizer will do the actual calculation of its children's minimal sizes.
     */

-    wxSize CalcMin();
+    virtual wxSize CalcMin();

 
     /**
         Detaches all children from the sizer. If @a delete_windows is @true then
         child windows will also be deleted.
     */
 
     /**
         Detaches all children from the sizer. If @a delete_windows is @true then
         child windows will also be deleted.
     */

-    void Clear(bool delete_windows = false);
+    virtual void Clear(bool delete_windows = false);

 
     /**
         Computes client area size for @a window so that it matches the sizer's
 
     /**
         Computes client area size for @a window so that it matches the sizer's


@@ -983,31 +1007,31 @@ public:
 
     /**
         Detach the child @a window from the sizer without destroying it.
 
     /**
         Detach the child @a window from the sizer without destroying it.

-        
+

         This method does not cause any layout or resizing to take place, call Layout()
         to update the layout "on screen" after detaching a child from the sizer.
         This method does not cause any layout or resizing to take place, call Layout()
         to update the layout "on screen" after detaching a child from the sizer.

-        
+

         Returns @true if the child item was found and detached, @false otherwise.
 
         @see Remove()
     */
         Returns @true if the child item was found and detached, @false otherwise.
 
         @see Remove()
     */

-    bool Detach(wxWindow* window);
+    virtual bool Detach(wxWindow* window);

 
     /**
         Detach the child @a sizer from the sizer without destroying it.
 
     /**
         Detach the child @a sizer from the sizer without destroying it.

-        
+

         This method does not cause any layout or resizing to take place, call Layout()
         to update the layout "on screen" after detaching a child from the sizer.
         This method does not cause any layout or resizing to take place, call Layout()
         to update the layout "on screen" after detaching a child from the sizer.

-        
+

         Returns @true if the child item was found and detached, @false otherwise.
         Returns @true if the child item was found and detached, @false otherwise.

-        
+

         @see Remove()
     */
         @see Remove()
     */

-    bool Detach(wxSizer* sizer);
+    virtual bool Detach(wxSizer* sizer);

 
     /**
         Detach a item at position @a index from the sizer without destroying it.
 
     /**
         Detach a item at position @a index from the sizer without destroying it.

-        
+

         This method does not cause any layout or resizing to take place, call Layout()
         to update the layout "on screen" after detaching a child from the sizer.
         Returns @true if the child item was found and detached, @false otherwise.
         This method does not cause any layout or resizing to take place, call Layout()
         to update the layout "on screen" after detaching a child from the sizer.
         Returns @true if the child item was found and detached, @false otherwise.


@@ -1045,7 +1069,7 @@ public:
         @ref wxSizerItem "wxSizerItem".
     */
     wxSizerItemList& GetChildren();
         @ref wxSizerItem "wxSizerItem".
     */
     wxSizerItemList& GetChildren();

-    
+

     /**
         Returns the list of the items in this sizer. The elements of type-safe
         wxList @a wxSizerItemList are pointers to objects of type
     /**
         Returns the list of the items in this sizer. The elements of type-safe
         wxList @a wxSizerItemList are pointers to objects of type


@@ -1064,13 +1088,13 @@ public:
         Returns pointer to item or @NULL.
     */
     wxSizerItem* GetItem(wxWindow* window, bool recursive = false);
         Returns pointer to item or @NULL.
     */
     wxSizerItem* GetItem(wxWindow* window, bool recursive = false);

-    
+

     /**
         Finds wxSizerItem which holds the given @a sizer
         Use parameter @a recursive to search in subsizers too.
         Returns pointer to item or @NULL.
     */
     /**
         Finds wxSizerItem which holds the given @a sizer
         Use parameter @a recursive to search in subsizers too.
         Returns pointer to item or @NULL.
     */

-    
+

     wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);
     /**
         Finds wxSizerItem which is located in the sizer at position
     wxSizerItem* GetItem(wxSizer* sizer, bool recursive = false);
     /**
         Finds wxSizerItem which is located in the sizer at position


@@ -1105,18 +1129,18 @@ public:
     /**
         Returns the current position of the sizer.
     */
     /**
         Returns the current position of the sizer.
     */

-    wxPoint GetPosition();
+    wxPoint GetPosition() const;

 
     /**
         Returns the current size of the sizer.
     */
 
     /**
         Returns the current size of the sizer.
     */

-    wxSize GetSize();
+    wxSize GetSize() const;

 
     /**
         Hides the child @a window.
 
     /**
         Hides the child @a window.

-        
+

         To make a sizer item disappear, use Hide() followed by Layout().
         To make a sizer item disappear, use Hide() followed by Layout().

-        
+

         Use parameter @a recursive to hide elements found in subsizers.
         Returns @true if the child item was found, @false otherwise.
 
         Use parameter @a recursive to hide elements found in subsizers.
         Returns @true if the child item was found, @false otherwise.
 


@@ -1126,9 +1150,9 @@ public:
 
     /**
         Hides the child @a sizer.
 
     /**
         Hides the child @a sizer.

-        
+

         To make a sizer item disappear, use Hide() followed by Layout().
         To make a sizer item disappear, use Hide() followed by Layout().

-        
+

         Use parameter @a recursive to hide elements found in subsizers.
         Returns @true if the child item was found, @false otherwise.
 
         Use parameter @a recursive to hide elements found in subsizers.
         Returns @true if the child item was found, @false otherwise.
 


@@ -1138,9 +1162,9 @@ public:
 
     /**
         Hides the item at position @a index.
 
     /**
         Hides the item at position @a index.

-        
+

         To make a sizer item disappear, use Hide() followed by Layout().
         To make a sizer item disappear, use Hide() followed by Layout().

-        
+

         Use parameter @a recursive to hide elements found in subsizers.
         Returns @true if the child item was found, @false otherwise.
 
         Use parameter @a recursive to hide elements found in subsizers.
         Returns @true if the child item was found, @false otherwise.
 


@@ -1236,7 +1260,7 @@ public:
         keeping
         the current dimension.
     */
         keeping
         the current dimension.
     */

-    void Layout();
+    virtual void Layout();

 
     /**
         Same as Add(), but prepends the items to the beginning of the
 
     /**
         Same as Add(), but prepends the items to the beginning of the


@@ -1296,7 +1320,7 @@ public:
         Here, the sizer will do the actual calculation of its children's
         positions and sizes.
     */
         Here, the sizer will do the actual calculation of its children's
         positions and sizes.
     */

-    void RecalcSizes();
+    virtual void RecalcSizes();

 
     /**
         Removes a child window from the sizer, but does @b not destroy it
 
     /**
         Removes a child window from the sizer, but does @b not destroy it


@@ -1328,7 +1352,7 @@ public:
 
         @return @true if the child item was found and removed, @false otherwise.
     */
 
         @return @true if the child item was found and removed, @false otherwise.
     */

-    bool Remove(wxSizer* sizer);
+    virtual bool Remove(wxSizer* sizer);

 
     /**
         Removes a child from the sizer and destroys it if it is a sizer or a
 
     /**
         Removes a child from the sizer and destroys it if it is a sizer or a


@@ -1351,49 +1375,49 @@ public:
         replaces it with the given @a newwin. The detached
         child window is @b not deleted (because windows are
         owned by their parent window, not the sizer).
         replaces it with the given @a newwin. The detached
         child window is @b not deleted (because windows are
         owned by their parent window, not the sizer).

-        
+

         Use parameter @a recursive to search the given element recursively in subsizers.
 
         This method does not cause any layout or resizing to take place,
         call Layout() to update the layout "on screen" after replacing a
         child from the sizer.
         Use parameter @a recursive to search the given element recursively in subsizers.
 
         This method does not cause any layout or resizing to take place,
         call Layout() to update the layout "on screen" after replacing a
         child from the sizer.

-        
+

         Returns @true if the child item was found and removed, @false otherwise.
     */
     bool Replace(wxWindow* oldwin, wxWindow* newwin,
                  bool recursive = false);
         Returns @true if the child item was found and removed, @false otherwise.
     */
     bool Replace(wxWindow* oldwin, wxWindow* newwin,
                  bool recursive = false);

-                 
+

     /**
         Detaches the given @a oldsz from the sizer and
         replaces it with the given @a newsz. The detached
     /**
         Detaches the given @a oldsz from the sizer and
         replaces it with the given @a newsz. The detached

-        child sizer is deleted. 
-        
+        child sizer is deleted.
+

         Use parameter @a recursive to search the given element recursively in subsizers.
 
         This method does not cause any layout or resizing to take place,
         call Layout() to update the layout "on screen" after replacing a
         child from the sizer.
         Use parameter @a recursive to search the given element recursively in subsizers.
 
         This method does not cause any layout or resizing to take place,
         call Layout() to update the layout "on screen" after replacing a
         child from the sizer.

-        
+

         Returns @true if the child item was found and removed, @false otherwise.
     */
     bool Replace(wxSizer* oldsz, wxSizer* newsz,
                  bool recursive = false);
         Returns @true if the child item was found and removed, @false otherwise.
     */
     bool Replace(wxSizer* oldsz, wxSizer* newsz,
                  bool recursive = false);

-                 
+

     /**
         Detaches the given item at position @a index from the sizer and
         replaces it with the given wxSizerItem @a newitem.
     /**
         Detaches the given item at position @a index from the sizer and
         replaces it with the given wxSizerItem @a newitem.

-        
+

         The detached child is deleted @b only if it is a sizer or a spacer
         (but not if it is a wxWindow because windows are owned by their
         parent window, not the sizer).
         The detached child is deleted @b only if it is a sizer or a spacer
         (but not if it is a wxWindow because windows are owned by their
         parent window, not the sizer).

-        
+

         This method does not cause any layout or resizing to take place,
         call Layout() to update the layout "on screen" after replacing a
         child from the sizer.
         This method does not cause any layout or resizing to take place,
         call Layout() to update the layout "on screen" after replacing a
         child from the sizer.

-        
+

         Returns @true if the child item was found and removed, @false otherwise.
     */
         Returns @true if the child item was found and removed, @false otherwise.
     */

-    bool Replace(size_t index, wxSizerItem* newitem);
+    virtual bool Replace(size_t index, wxSizerItem* newitem);

 
     /**
         Call this to force the sizer to take the given dimension and thus force
 
     /**
         Call this to force the sizer to take the given dimension and thus force


@@ -1401,7 +1425,7 @@ public:
         rules defined by the parameter in the Add() and Prepend() methods.
     */
     void SetDimension(int x, int y, int width, int height);
         rules defined by the parameter in the Add() and Prepend() methods.
     */
     void SetDimension(int x, int y, int width, int height);

-    
+

     /**
         @overload
      */
     /**
         @overload
      */


@@ -1475,15 +1499,16 @@ public:
         appropriately.
 
         @see wxScrolled::SetScrollbars()
         appropriately.
 
         @see wxScrolled::SetScrollbars()

+        @deprecated @todo provide deprecation description

     */
     void SetVirtualSizeHints(wxWindow* window);
 
     /**
         Shows or hides the @a window.
         To make a sizer item disappear or reappear, use Show() followed by Layout().
     */
     void SetVirtualSizeHints(wxWindow* window);
 
     /**
         Shows or hides the @a window.
         To make a sizer item disappear or reappear, use Show() followed by Layout().

-        
+

         Use parameter @a recursive to show or hide elements found in subsizers.
         Use parameter @a recursive to show or hide elements found in subsizers.

-        
+

         Returns @true if the child item was found, @false otherwise.
 
         @see Hide(), IsShown()
         Returns @true if the child item was found, @false otherwise.
 
         @see Hide(), IsShown()


@@ -1494,9 +1519,9 @@ public:
     /**
         Shows or hides @a sizer.
         To make a sizer item disappear or reappear, use Show() followed by Layout().
     /**
         Shows or hides @a sizer.
         To make a sizer item disappear or reappear, use Show() followed by Layout().

-        
+

         Use parameter @a recursive to show or hide elements found in subsizers.
         Use parameter @a recursive to show or hide elements found in subsizers.

-        
+

         Returns @true if the child item was found, @false otherwise.
 
         @see Hide(), IsShown()
         Returns @true if the child item was found, @false otherwise.
 
         @see Hide(), IsShown()


@@ -1507,7 +1532,7 @@ public:
     /**
         Shows the item at @a index.
         To make a sizer item disappear or reappear, use Show() followed by Layout().
     /**
         Shows the item at @a index.
         To make a sizer item disappear or reappear, use Show() followed by Layout().

-        
+

         Returns @true if the child item was found, @false otherwise.
 
         @see Hide(), IsShown()
         Returns @true if the child item was found, @false otherwise.
 
         @see Hide(), IsShown()


@@ -1548,22 +1573,22 @@ public:
     /**
         Returns the number of columns in the sizer.
     */
     /**
         Returns the number of columns in the sizer.
     */

-    int GetCols();
+    int GetCols() const;

 
     /**
         Returns the horizontal gap (in pixels) between cells in the sizer.
     */
 
     /**
         Returns the horizontal gap (in pixels) between cells in the sizer.
     */

-    int GetHGap();
+    int GetHGap() const;

 
     /**
         Returns the number of rows in the sizer.
     */
 
     /**
         Returns the number of rows in the sizer.
     */

-    int GetRows();
+    int GetRows() const;

 
     /**
         Returns the vertical gap (in pixels) between the cells in the sizer.
     */
 
     /**
         Returns the vertical gap (in pixels) between the cells in the sizer.
     */

-    int GetVGap();
+    int GetVGap() const;

 
     /**
         Sets the number of columns in the sizer.
 
     /**
         Sets the number of columns in the sizer.


@@ -1600,7 +1625,7 @@ public:
     @library{wxcore}
     @category{winlayout}
 
     @library{wxcore}
     @category{winlayout}
 

-    @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer 
+    @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizer

     "Sizer Overview"
 */
 class wxStaticBoxSizer : public wxBoxSizer
     "Sizer Overview"
 */
 class wxStaticBoxSizer : public wxBoxSizer


@@ -1621,7 +1646,7 @@ public:
     /**
         Returns the static box associated with the sizer.
     */
     /**
         Returns the static box associated with the sizer.
     */

-    wxStaticBox* GetStaticBox();
+    wxStaticBox* GetStaticBox() const;

 };
 
 
 };
 
 


@@ -1634,7 +1659,7 @@ public:
     simple basic geometry, typically in a row or a column or several hierarchies of
     either.
 
     simple basic geometry, typically in a row or a column or several hierarchies of
     either.
 

-    For more information, please see @ref overview_sizer_box 
+    For more information, please see @ref overview_sizer_box

     "Programming with wxBoxSizer".
 
     @library{wxcore}
     "Programming with wxBoxSizer".
 
     @library{wxcore}


@@ -1655,13 +1680,13 @@ public:
         Implements the calculation of a box sizer's minimal. It is used internally
         only and must not be called by the user. Documented for information.
     */
         Implements the calculation of a box sizer's minimal. It is used internally
         only and must not be called by the user. Documented for information.
     */

-    wxSize CalcMin();
+    virtual wxSize CalcMin();

 
     /**
         Returns the orientation of the box sizer, either wxVERTICAL
         or wxHORIZONTAL.
     */
 
     /**
         Returns the orientation of the box sizer, either wxVERTICAL
         or wxHORIZONTAL.
     */

-    int GetOrientation();
+    int GetOrientation() const;

 
     /**
         Implements the calculation of a box sizer's dimensions and then sets
 
     /**
         Implements the calculation of a box sizer's dimensions and then sets