]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/sashwin.h
add handling of wxWrapSizer flags (part of ticket 9468)
[wxWidgets.git] / interface / sashwin.h
index bae169d61e5b9ac84c0b24565e600977524e1dcb..a8fdb750769cd64bb9e21b14e8999c265fd9ee84 100644 (file)
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sashwin.h
-// Purpose:     documentation for wxSashWindow class
+// Purpose:     interface of wxSashWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
     via a wxSashEvent notification.
 
     @beginStyleTable
-    @style{wxSW_3D}:
+    @style{wxSW_3D}
            Draws a 3D effect sash and border.
-    @style{wxSW_3DSASH}:
+    @style{wxSW_3DSASH}
            Draws a 3D effect sash.
-    @style{wxSW_3DBORDER}:
+    @style{wxSW_3DBORDER}
            Draws a 3D effect border.
-    @style{wxSW_BORDER}:
+    @style{wxSW_BORDER}
            Draws a thin black border.
     @endStyleTable
 
-    @beginEventTable
-    @event{EVT_SASH_DRAGGED(id, func)}:
+    @beginEventTable{wxSashEvent}
+    @event{EVT_SASH_DRAGGED(id, func)}
            Process a wxEVT_SASH_DRAGGED event, when the user has finished
            dragging a sash.
-    @event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)}:
+    @event{EVT_SASH_DRAGGED_RANGE(id1, id2, func)}
            Process a wxEVT_SASH_DRAGGED_RANGE event, when the user has
            finished dragging a sash. The event handler is called when windows
            with ids in the given range have their sashes dragged.
@@ -41,8 +41,7 @@
     @library{wxadv}
     @category{miscwnd}
 
-    @seealso
-    wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview
+    @see wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandling
 */
 class wxSashWindow : public wxWindow
 {
@@ -51,7 +50,7 @@ public:
     /**
         Constructs a sash 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
@@ -105,10 +104,10 @@ public:
 
     /**
         Returns @true if a sash is visible on the given edge, @false otherwise.
-        
+
         @param edge
             Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-        
+
         @see SetSashVisible()
     */
     bool GetSashVisible(wxSashEdgePosition edge) const;
@@ -116,10 +115,10 @@ public:
     /**
         Returns @true if the sash has a border, @false otherwise.
         This function is obsolete since the sash border property is unused.
-        
+
         @param edge
             Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-        
+
         @see SetSashBorder()
     */
     bool HasBorder(wxSashEdgePosition edge) const;
@@ -147,7 +146,7 @@ public:
     /**
         Call this function to give the sash a border, or remove the border.
         This function is obsolete since the sash border property is unused.
-        
+
         @param edge
             Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
         @param hasBorder
@@ -157,18 +156,19 @@ public:
 
     /**
         Call this function to make a sash visible or invisible on a particular edge.
-        
+
         @param edge
             Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
         @param visible
             @true to make the sash visible, @false to make it invisible.
-        
+
         @see GetSashVisible()
     */
     void SetSashVisible(wxSashEdgePosition edge, bool visible);
 };
 
 
+
 /**
     @class wxSashEvent
     @wxheader{sashwin.h}
@@ -179,8 +179,7 @@ public:
     @library{wxadv}
     @category{FIXME}
 
-    @seealso
-    wxSashWindow, @ref overview_eventhandlingoverview
+    @see wxSashWindow, @ref overview_eventhandlingoverview
 */
 class wxSashEvent : public wxCommandEvent
 {
@@ -211,3 +210,4 @@ public:
     */
     wxSashEdgePosition GetEdge() const;
 };
+