correct the REDIRECT_COMMAND definition for Unix

[wxWidgets.git] / interface / sashwin.h

diff --git a/interface/sashwin.h b/interface/sashwin.h
index b567d0688b871bd7b0d827203741661c674fc552..5ad783ad876ecefe381ef388ea88d457ffb5a483 100644 (file)
--- a/interface/sashwin.h
+++ b/interface/sashwin.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sashwin.h
 /////////////////////////////////////////////////////////////////////////////
 // Name:        sashwin.h

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

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


@@ -29,10 +29,10 @@
     @endStyleTable
 
     @beginEventTable
     @endStyleTable
 
     @beginEventTable

-    @event{EVT_SASH_DRAGGED(id\, func)}:
+    @event{EVT_SASH_DRAGGED(id, func)}:

            Process a wxEVT_SASH_DRAGGED event, when the user has finished
            dragging a sash.
            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.
            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,9 +41,7 @@
     @library{wxadv}
     @category{miscwnd}
 
     @library{wxadv}
     @category{miscwnd}
 

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

 */
 class wxSashWindow : public wxWindow
 {
 */
 class wxSashWindow : public wxWindow
 {


@@ -52,35 +50,30 @@ public:
     /**
         Constructs a sash window, which can be a child of a frame, dialog or any other
         non-control window.
     /**
         Constructs a sash 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

         wxSashWindows
         wxSashWindows

-        should generate a default position for the window. If using the wxSashWindow
-        class directly, supply
-        an actual position.
-        
+            should generate a default position for the window. If using the
+        wxSashWindow class directly, supply
+            an actual position.

         @param size
         @param size

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

         @param style
         @param style

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

         @param name
         @param name

-        Window name.
+            Window name.

     */
     wxSashWindow();
     wxSashWindow(wxWindow* parent, wxWindowID id,
                  const wxPoint& pos = wxDefaultPosition,
                  const wxSize& size = wxDefaultSize,
     */
     wxSashWindow();
     wxSashWindow(wxWindow* 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 = "sashWindow");
     //@}
 
                  const wxString& name = "sashWindow");
     //@}
 


@@ -92,12 +85,12 @@ public:
     /**
         Gets the maximum window size in the x direction.
     */
     /**
         Gets the maximum window size in the x direction.
     */

-    int GetMaximumSizeX();
+    int GetMaximumSizeX() const;

 
     /**
         Gets the maximum window size in the y direction.
     */
 
     /**
         Gets the maximum window size in the y direction.
     */

-    int GetMaximumSizeY();
+    int GetMaximumSizeY() const;

 
     /**
         Gets the minimum window size in the x direction.
 
     /**
         Gets the minimum window size in the x direction.


@@ -107,28 +100,28 @@ public:
     /**
         Gets the minimum window size in the y direction.
     */
     /**
         Gets the minimum window size in the y direction.
     */

-    int GetMinimumSizeY();
+    int GetMinimumSizeY() const;

 
     /**
         Returns @true if a sash is visible on the given edge, @false otherwise.
 
     /**
         Returns @true if a sash is visible on the given edge, @false otherwise.

-        
+

         @param edge
         @param edge

-        Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-        
-        @sa SetSashVisible()
+            Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
+
+        @see SetSashVisible()

     */
     */

-    bool GetSashVisible(wxSashEdgePosition edge);
+    bool GetSashVisible(wxSashEdgePosition edge) const;

 
     /**
         Returns @true if the sash has a border, @false otherwise.
         This function is obsolete since the sash border property is unused.
 
     /**
         Returns @true if the sash has a border, @false otherwise.
         This function is obsolete since the sash border property is unused.

-        
+

         @param edge
         @param edge

-        Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-        
-        @sa SetSashBorder()
+            Edge. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
+
+        @see SetSashBorder()

     */
     */

-    bool HasBorder(wxSashEdgePosition edge);
+    bool HasBorder(wxSashEdgePosition edge) const;

 
     /**
         Sets the maximum window size in the x direction.
 
     /**
         Sets the maximum window size in the x direction.


@@ -153,30 +146,29 @@ 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.
     /**
         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
         @param edge

-        Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-        
+            Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.

         @param hasBorder
         @param hasBorder

-        @true to give the sash a border visible, @false to remove it.
+            @true to give the sash a border visible, @false to remove it.

     */
     void SetSashBorder(wxSashEdgePosition edge, bool hasBorder);
 
     /**
         Call this function to make a sash visible or invisible on a particular edge.
     */
     void SetSashBorder(wxSashEdgePosition edge, bool hasBorder);
 
     /**
         Call this function to make a sash visible or invisible on a particular edge.

-        
+

         @param edge
         @param edge

-        Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.
-        
+            Edge to change. One of wxSASH_TOP, wxSASH_RIGHT, wxSASH_BOTTOM, wxSASH_LEFT.

         @param visible
         @param visible

-        @true to make the sash visible, @false to make it invisible.
-        
-        @sa GetSashVisible()
+            @true to make the sash visible, @false to make it invisible.
+
+        @see GetSashVisible()

     */
     void SetSashVisible(wxSashEdgePosition edge, bool visible);
 };
 
 
     */
     void SetSashVisible(wxSashEdgePosition edge, bool visible);
 };
 
 

+

 /**
     @class wxSashEvent
     @wxheader{sashwin.h}
 /**
     @class wxSashEvent
     @wxheader{sashwin.h}


@@ -187,8 +179,7 @@ public:
     @library{wxadv}
     @category{FIXME}
 
     @library{wxadv}
     @category{FIXME}
 

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

 */
 class wxSashEvent : public wxCommandEvent
 {
 */
 class wxSashEvent : public wxCommandEvent
 {


@@ -203,7 +194,7 @@ public:
         resize was applied. It is
         up to the application to set the window size if required.
     */
         resize was applied. It is
         up to the application to set the window size if required.
     */

-    wxRect GetDragRect();
+    wxRect GetDragRect() const;

 
     /**
         Returns the status of the sash: one of wxSASH_STATUS_OK,
 
     /**
         Returns the status of the sash: one of wxSASH_STATUS_OK,


@@ -211,11 +202,12 @@ public:
         If the drag caused the notional bounding box of the window to flip over, for
         example, the drag will be out of rage.
     */
         If the drag caused the notional bounding box of the window to flip over, for
         example, the drag will be out of rage.
     */

-    wxSashDragStatus GetDragStatus();
+    wxSashDragStatus GetDragStatus() const;

 
     /**
         Returns the dragged edge. The return value is one of wxSASH_TOP, wxSASH_RIGHT,
         wxSASH_BOTTOM, wxSASH_LEFT.
     */
 
     /**
         Returns the dragged edge. The return value is one of wxSASH_TOP, wxSASH_RIGHT,
         wxSASH_BOTTOM, wxSASH_LEFT.
     */

-    wxSashEdgePosition GetEdge();
+    wxSashEdgePosition GetEdge() const;

 };
 };

+