X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/4cc4bfafe5a31cb96f35b3ec9b19fa2b0b3a4eef..bfb6fde371c9b5296c3b1c2764a1062db383c6ad:/interface/laywin.h

diff --git a/interface/laywin.h b/interface/laywin.h
index badf50f30d..a09ff3d194 100644
--- a/interface/laywin.h
+++ b/interface/laywin.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        laywin.h
-// Purpose:     documentation for wxLayoutAlgorithm class
+// Purpose:     interface of wxLayoutAlgorithm
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -90,8 +90,7 @@
     @library{wxadv}
     @category{winlayout}
 
-    @seealso
-    wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview
+    @see wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview
 */
 class wxLayoutAlgorithm : public wxObject
 {
@@ -111,7 +110,7 @@ public:
         remaining space.
         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 @a rect is non-@NULL, the
@@ -119,7 +118,7 @@ public:
         area.
         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.
@@ -131,10 +130,11 @@ public:
         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}
@@ -152,8 +152,7 @@ public:
     @library{wxadv}
     @category{miscwnd}
 
-    @seealso
-    wxLayoutAlgorithm, wxSashWindow, @ref overview_eventhandlingoverview
+    @see wxLayoutAlgorithm, wxSashWindow, @ref overview_eventhandlingoverview
 */
 class wxSashLayoutWindow : public wxSashWindow
 {
@@ -162,7 +161,7 @@ public:
     /**
         Constructs a sash layout window, which can be a child of a frame, dialog or any
         other non-control window.
-        
+
         @param parent
             Pointer to a parent window.
         @param id
@@ -193,7 +192,7 @@ public:
     /**
         Initializes a sash layout window, which can be a child of a frame, dialog or
         any other non-control window.
-        
+
         @param parent
             Pointer to a parent window.
         @param id
@@ -223,13 +222,13 @@ public:
         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.
     */
-    wxLayoutOrientation GetOrientation();
+    wxLayoutOrientation GetOrientation() const;
 
     /**
         The default handler for the event that is generated by wxLayoutAlgorithm. The
@@ -276,6 +275,7 @@ public:
 };
 
 
+
 /**
     @class wxQueryLayoutInfoEvent
     @wxheader{laywin.h}
@@ -288,8 +288,7 @@ public:
     @library{wxadv}
     @category{events}
 
-    @seealso
-    wxCalculateLayoutEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
+    @see wxCalculateLayoutEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
 */
 class wxQueryLayoutInfoEvent : public wxEvent
 {
@@ -305,32 +304,32 @@ public:
         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.
     */
-    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.
     */
-    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.
     */
-    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.
     */
-    wxSize GetSize();
+    wxSize GetSize() const;
 
     /**
         Call this to specify the alignment of the window (which side of the remaining
@@ -366,6 +365,7 @@ public:
 };
 
 
+
 /**
     @class wxCalculateLayoutEvent
     @wxheader{laywin.h}
@@ -377,8 +377,7 @@ public:
     @library{wxadv}
     @category{events}
 
-    @seealso
-    wxQueryLayoutInfoEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
+    @see wxQueryLayoutInfoEvent, wxSashLayoutWindow, wxLayoutAlgorithm.
 */
 class wxCalculateLayoutEvent : public wxEvent
 {
@@ -391,7 +390,7 @@ public:
     /**
         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
@@ -400,7 +399,7 @@ public:
         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.
@@ -414,3 +413,4 @@ public:
     */
     void SetRect(const wxRect& rect);
 };
+