add handling of wxWrapSizer flags (part of ticket 9468)

[wxWidgets.git] / interface / laywin.h

diff --git a/interface/laywin.h b/interface/laywin.h
index 6bbf2fe9e5606483e829446411290f58719ca132..a09ff3d194b9535f25bf93304370003969eee42f 100644 (file)
--- a/interface/laywin.h
+++ b/interface/laywin.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        laywin.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        laywin.h

-// Purpose:     documentation for wxLayoutAlgorithm class
+// Purpose:     interface of wxLayoutAlgorithm

 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license


@@ -90,9 +90,7 @@
     @library{wxadv}
     @category{winlayout}
 
     @library{wxadv}
     @category{winlayout}
 

-    @seealso
-    wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview "Event
-    handling overview"
+    @see wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview

 */
 class wxLayoutAlgorithm : public wxObject
 {
 */
 class wxLayoutAlgorithm : public wxObject
 {


@@ -108,26 +106,23 @@ public:
     ~wxLayoutAlgorithm();
 
     /**
     ~wxLayoutAlgorithm();
 
     /**

-        Lays out the children of a normal frame. @e mainWindow is set to occupy the
+        Lays out the children of a normal frame. @a mainWindow is set to occupy the

         remaining space.
         remaining space.

-        

         This function simply calls LayoutWindow().
     */
         This function simply calls LayoutWindow().
     */

-    bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = @NULL);
+    bool LayoutFrame(wxFrame* frame, wxWindow* mainWindow = NULL) const;

 
     /**
 
     /**

-        Lays out the children of an MDI parent frame. If @e rect is non-@NULL, the
+        Lays out the children of an MDI parent frame. If @a rect is non-@NULL, the

         given rectangle will be used as a starting point instead of the frame's client
         area.
         given rectangle will be used as a starting point instead of the frame's client
         area.

-        

         The MDI client window is set to occupy the remaining space.
     */
         The MDI client window is set to occupy the remaining space.
     */

-    bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = @NULL);
+    bool LayoutMDIFrame(wxMDIParentFrame* frame, wxRect* rect = NULL) const;

 
     /**
         Lays out the children of a normal frame or other window.
 
     /**
         Lays out the children of a normal frame or other window.

-        
-        @e mainWindow is set to occupy the remaining space. If this is not specified,
+        @a mainWindow is set to occupy the remaining space. If this is not specified,

         then
         the last window that responds to a calculate layout event in query mode will
         get the remaining space
         then
         the last window that responds to a calculate layout event in query mode will
         get the remaining space


@@ -135,10 +130,11 @@ public:
         and the window will be set
         to the remaining size).
     */
         and the window will be set
         to the remaining size).
     */

-    bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = @NULL);
+    bool LayoutWindow(wxWindow* parent, wxWindow* mainWindow = NULL) const;

 };
 
 
 };
 
 

+

 /**
     @class wxSashLayoutWindow
     @wxheader{laywin.h}
 /**
     @class wxSashLayoutWindow
     @wxheader{laywin.h}


@@ -156,9 +152,7 @@ public:
     @library{wxadv}
     @category{miscwnd}
 
     @library{wxadv}
     @category{miscwnd}
 

-    @seealso
-    wxLayoutAlgorithm, wxSashWindow, @ref overview_eventhandlingoverview "Event
-    handling overview"
+    @see wxLayoutAlgorithm, wxSashWindow, @ref overview_eventhandlingoverview

 */
 class wxSashLayoutWindow : public wxSashWindow
 {
 */
 class wxSashLayoutWindow : public wxSashWindow
 {


@@ -167,82 +161,74 @@ public:
     /**
         Constructs a sash layout window, which can be a child of a frame, dialog or any
         other non-control window.
     /**
         Constructs a sash layout window, which can be a child of a frame, dialog or any
         other non-control window.

-        
+

         @param parent
         @param parent

-        Pointer to a parent window.
-        
+            Pointer to a parent window.

         @param id
         @param id

-        Window identifier. If -1, will automatically create an identifier.
-        
+            Window identifier. If -1, will automatically create an identifier.

         @param pos
         @param pos

-        Window position. wxDefaultPosition is (-1, -1) which indicates that
+            Window position. wxDefaultPosition is (-1, -1) which indicates that

         wxSashLayoutWindows
         wxSashLayoutWindows

-        should generate a default position for the window. If using the
+            should generate a default position for the window. If using the

         wxSashLayoutWindow class directly, supply
         wxSashLayoutWindow class directly, supply

-        an actual position.
-        
+            an actual position.

         @param size
         @param size

-        Window size. wxDefaultSize is (-1, -1) which indicates that wxSashLayoutWindows
-        should generate a default size for the window.
-        
+            Window size. wxDefaultSize is (-1, -1) which indicates that
+        wxSashLayoutWindows
+            should generate a default size for the window.

         @param style
         @param style

-        Window style. For window styles, please see wxSashLayoutWindow.
-        
+            Window style. For window styles, please see wxSashLayoutWindow.

         @param name
         @param name

-        Window name.
+            Window name.

     */
     wxSashLayoutWindow();
     wxSashLayoutWindow(wxSashLayoutWindow* parent, wxWindowID id,
                        const wxPoint& pos = wxDefaultPosition,
                        const wxSize& size = wxDefaultSize,
     */
     wxSashLayoutWindow();
     wxSashLayoutWindow(wxSashLayoutWindow* parent, wxWindowID id,
                        const wxPoint& pos = wxDefaultPosition,
                        const wxSize& size = wxDefaultSize,

-                       long style = wxCLIP_CHILDREN |  wxSW_3D,
+                       long style = wxCLIP_CHILDREN | wxSW_3D,

                        const wxString& name = "layoutWindow");
     //@}
 
     /**
         Initializes a sash layout window, which can be a child of a frame, dialog or
         any other non-control window.
                        const wxString& name = "layoutWindow");
     //@}
 
     /**
         Initializes a sash layout window, which can be a child of a frame, dialog or
         any other non-control window.

-        
+

         @param parent
         @param parent

-        Pointer to a parent window.
-        
+            Pointer to a parent window.

         @param id
         @param id

-        Window identifier. If -1, will automatically create an identifier.
-        
+            Window identifier. If -1, will automatically create an identifier.

         @param pos
         @param pos

-        Window position. wxDefaultPosition is (-1, -1) which indicates that
+            Window position. wxDefaultPosition is (-1, -1) which indicates that

         wxSashLayoutWindows
         wxSashLayoutWindows

-        should generate a default position for the window. If using the
+            should generate a default position for the window. If using the

         wxSashLayoutWindow class directly, supply
         wxSashLayoutWindow class directly, supply

-        an actual position.
-        
+            an actual position.

         @param size
         @param size

-        Window size. wxDefaultSize is (-1, -1) which indicates that wxSashLayoutWindows
-        should generate a default size for the window.
-        
+            Window size. wxDefaultSize is (-1, -1) which indicates that
+        wxSashLayoutWindows
+            should generate a default size for the window.

         @param style
         @param style

-        Window style. For window styles, please see wxSashLayoutWindow.
-        
+            Window style. For window styles, please see wxSashLayoutWindow.

         @param name
         @param name

-        Window name.
+            Window name.

     */
     bool Create(wxSashLayoutWindow* parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,
     */
     bool Create(wxSashLayoutWindow* parent, wxWindowID id,
                 const wxPoint& pos = wxDefaultPosition,
                 const wxSize& size = wxDefaultSize,

-                long style = wxCLIP_CHILDREN |  wxSW_3D,
+                long style = wxCLIP_CHILDREN | wxSW_3D,

                 const wxString& name = "layoutWindow");
 
     /**
         Returns the alignment of the window: one of wxLAYOUT_TOP, wxLAYOUT_LEFT,
         wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
     */
                 const wxString& name = "layoutWindow");
 
     /**
         Returns the alignment of the window: one of wxLAYOUT_TOP, wxLAYOUT_LEFT,
         wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
     */

-    wxLayoutAlignment GetAlignment();
+    wxLayoutAlignment GetAlignment() const;

 
     /**
         Returns the orientation of the window: one of wxLAYOUT_HORIZONTAL,
         wxLAYOUT_VERTICAL.
     */
 
     /**
         Returns the orientation of the window: one of wxLAYOUT_HORIZONTAL,
         wxLAYOUT_VERTICAL.
     */

-    wxLayoutOrientation GetOrientation();
+    wxLayoutOrientation GetOrientation() const;

 
     /**
         The default handler for the event that is generated by wxLayoutAlgorithm. The
 
     /**
         The default handler for the event that is generated by wxLayoutAlgorithm. The


@@ -266,7 +252,7 @@ public:
     /**
         Sets the alignment of the window (which edge of the available parent client
         area the window
     /**
         Sets the alignment of the window (which edge of the available parent client
         area the window

-        is attached to). @e alignment is one of wxLAYOUT_TOP, wxLAYOUT_LEFT,
+        is attached to). @a alignment is one of wxLAYOUT_TOP, wxLAYOUT_LEFT,

         wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
     */
     void SetAlignment(wxLayoutAlignment alignment);
         wxLAYOUT_RIGHT, wxLAYOUT_BOTTOM.
     */
     void SetAlignment(wxLayoutAlignment alignment);


@@ -282,13 +268,14 @@ public:
     /**
         Sets the orientation of the window (the direction the window will stretch in,
         to fill the available
     /**
         Sets the orientation of the window (the direction the window will stretch in,
         to fill the available

-        parent client area). @e orientation is one of wxLAYOUT_HORIZONTAL,
+        parent client area). @a orientation is one of wxLAYOUT_HORIZONTAL,

         wxLAYOUT_VERTICAL.
     */
     void SetOrientation(wxLayoutOrientation orientation);
 };
 
 
         wxLAYOUT_VERTICAL.
     */
     void SetOrientation(wxLayoutOrientation orientation);
 };
 
 

+

 /**
     @class wxQueryLayoutInfoEvent
     @wxheader{laywin.h}
 /**
     @class wxQueryLayoutInfoEvent
     @wxheader{laywin.h}


@@ -301,8 +288,7 @@ public:
     @library{wxadv}
     @category{events}
 
     @library{wxadv}
     @category{events}
 

-    @seealso
-    wxCalculateLayoutEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
+    @see wxCalculateLayoutEvent, wxSashLayoutWindow, wxLayoutAlgorithm.

 */
 class wxQueryLayoutInfoEvent : public wxEvent
 {
 */
 class wxQueryLayoutInfoEvent : public wxEvent
 {


@@ -318,32 +304,32 @@ public:
         the window sticks to). One of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT,
         wxLAYOUT_BOTTOM.
     */
         the window sticks to). One of wxLAYOUT_TOP, wxLAYOUT_LEFT, wxLAYOUT_RIGHT,
         wxLAYOUT_BOTTOM.
     */

-    void GetAlignment();
+    void GetAlignment() const;

 
     /**
         Returns the flags associated with this event. Not currently used.
     */
 
     /**
         Returns the flags associated with this event. Not currently used.
     */

-    int GetFlags();
+    int GetFlags() const;

 
     /**
         Returns the orientation that the event handler specified to the event object.
         May be one of wxLAYOUT_HORIZONTAL,
         wxLAYOUT_VERTICAL.
     */
 
     /**
         Returns the orientation that the event handler specified to the event object.
         May be one of wxLAYOUT_HORIZONTAL,
         wxLAYOUT_VERTICAL.
     */

-    wxLayoutOrientation GetOrientation();
+    wxLayoutOrientation GetOrientation() const;

 
     /**
         Returns the requested length of the window in the direction of the window
         orientation. This information
         is not yet used.
     */
 
     /**
         Returns the requested length of the window in the direction of the window
         orientation. This information
         is not yet used.
     */

-    int GetRequestedLength();
+    int GetRequestedLength() const;

 
     /**
         Returns the size that the event handler specified to the event object as being
         the requested size of the window.
     */
 
     /**
         Returns the size that the event handler specified to the event object as being
         the requested size of the window.
     */

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

 
     /**
         Call this to specify the alignment of the window (which side of the remaining
 
     /**
         Call this to specify the alignment of the window (which side of the remaining


@@ -379,6 +365,7 @@ public:
 };
 
 
 };
 
 

+

 /**
     @class wxCalculateLayoutEvent
     @wxheader{laywin.h}
 /**
     @class wxCalculateLayoutEvent
     @wxheader{laywin.h}


@@ -390,8 +377,7 @@ public:
     @library{wxadv}
     @category{events}
 
     @library{wxadv}
     @category{events}
 

-    @seealso
-    wxQueryLayoutInfoEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
+    @see wxQueryLayoutInfoEvent, wxSashLayoutWindow, wxLayoutAlgorithm.

 */
 class wxCalculateLayoutEvent : public wxEvent
 {
 */
 class wxCalculateLayoutEvent : public wxEvent
 {


@@ -404,7 +390,7 @@ public:
     /**
         Returns the flags associated with this event. Not currently used.
     */
     /**
         Returns the flags associated with this event. Not currently used.
     */

-    int GetFlags();
+    int GetFlags() const;

 
     /**
         Before the event handler is entered, returns the remaining parent client area
 
     /**
         Before the event handler is entered, returns the remaining parent client area


@@ -413,7 +399,7 @@ public:
         parent client rectangle,
         after the event handler has subtracted the area that its window occupies.
     */
         parent client rectangle,
         after the event handler has subtracted the area that its window occupies.
     */

-    wxRect GetRect();
+    wxRect GetRect() const;

 
     /**
         Sets the flags associated with this event. Not currently used.
 
     /**
         Sets the flags associated with this event. Not currently used.


@@ -427,3 +413,4 @@ public:
     */
     void SetRect(const wxRect& rect);
 };
     */
     void SetRect(const wxRect& rect);
 };

+