Cleanup of wxDataViewCtrl cell activation code.

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

diff --git a/interface/wx/splitter.h b/interface/wx/splitter.h
index 3561831d42326a8e355813f2a8c59150086cf5f6..3a7dbee2a3d9a18ea96a3dbc037693a5fbf586cd 100644 (file)
--- a/interface/wx/splitter.h
+++ b/interface/wx/splitter.h
@@ -3,9 +3,23 @@
 // Purpose:     interface of wxSplitterWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Purpose:     interface of wxSplitterWindow
 // Author:      wxWidgets team
 // RCS-ID:      $Id$

-// Licence:     wxWindows license
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 /////////////////////////////////////////////////////////////////////////////
 

+
+enum wxSplitMode
+{
+    wxSPLIT_HORIZONTAL = 1,
+    wxSPLIT_VERTICAL
+};
+
+enum
+{
+    wxSPLIT_DRAG_NONE,
+    wxSPLIT_DRAG_DRAGGING,
+    wxSPLIT_DRAG_LEFT_DOWN
+};
+

 /**
     @class wxSplitterWindow
 
 /**
     @class wxSplitterWindow
 


@@ -37,22 +51,22 @@
     @endStyleTable
 
 
     @endStyleTable
 
 

-    @beginEventTable{wxSplitterEvent}
+    @beginEventEmissionTable{wxSplitterEvent}

     @event{EVT_SPLITTER_SASH_POS_CHANGING(id, func)}
         The sash position is in the process of being changed.
         May be used to modify the position of the tracking bar to properly
         reflect the position that would be set if the drag were to be completed
     @event{EVT_SPLITTER_SASH_POS_CHANGING(id, func)}
         The sash position is in the process of being changed.
         May be used to modify the position of the tracking bar to properly
         reflect the position that would be set if the drag were to be completed

-        at this point. Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
+        at this point. Processes a @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.

     @event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
         The sash position was changed. May be used to modify the sash position
         before it is set, or to prevent the change from taking place.
     @event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
         The sash position was changed. May be used to modify the sash position
         before it is set, or to prevent the change from taking place.

-        Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
+        Processes a @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.

     @event{EVT_SPLITTER_UNSPLIT(id, func)}
     @event{EVT_SPLITTER_UNSPLIT(id, func)}

-        The splitter has been just unsplit. Processes a wxEVT_COMMAND_SPLITTER_UNSPLIT event.
+        The splitter has been just unsplit. Processes a @c wxEVT_COMMAND_SPLITTER_UNSPLIT event.

     @event{EVT_SPLITTER_DCLICK(id, func)}
         The sash was double clicked. The default behaviour is to unsplit the
         window when this happens (unless the minimum pane size has been set
     @event{EVT_SPLITTER_DCLICK(id, func)}
         The sash was double clicked. The default behaviour is to unsplit the
         window when this happens (unless the minimum pane size has been set

-        to a value greater than zero). Processes a wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.
+        to a value greater than zero). Processes a @c wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.

     @endEventTable
 
 
     @endEventTable
 
 


@@ -95,7 +109,7 @@ public:
 
         @see Initialize(), SplitVertically(), SplitHorizontally(), Create()
     */
 
         @see Initialize(), SplitVertically(), SplitHorizontally(), Create()
     */

-    wxSplitterWindow(wxWindow* parent, wxWindowID id,
+    wxSplitterWindow(wxWindow* parent, wxWindowID id = wxID_ANY,

                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxSP_3D,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxSP_3D,


@@ -110,11 +124,10 @@ public:
         Creation function, for two-step construction.
         See wxSplitterWindow() for details.
     */
         Creation function, for two-step construction.
         See wxSplitterWindow() for details.
     */

-    bool Create(wxWindow* parent, wxWindowID id,
+    bool Create(wxWindow* parent, wxWindowID id = wxID_ANY,

                 const wxPoint& point = wxDefaultPosition,
                 const wxPoint& point = wxDefaultPosition,

-                const wxSize& size = wxDefaultSize,
-                long style = wxSP_3D,
-                const wxString& name = "splitterWindow");
+                const wxSize& size = wxDefaultSize, long style = wxSP_3D,
+                const wxString& name = "splitter");

 
     /**
         Returns the current minimum pane size (defaults to zero).
 
     /**
         Returns the current minimum pane size (defaults to zero).


@@ -137,12 +150,24 @@ public:
     */
     int GetSashPosition() const;
 
     */
     int GetSashPosition() const;
 

+    /**
+        Returns the sash size in pixels.
+
+        The size of the sash is its width for a vertically split window and its
+        height for a horizontally split one. Its other direction is the same as
+        the client size of the window in the corresponding direction.
+
+        The sash size is platform-dependent because it conforms to the current
+        platform look-and-feel and cannot be changed.
+     */
+    int GetSashSize() const;
+

     /**
         Gets the split mode.
 
         @see SetSplitMode(), SplitVertically(), SplitHorizontally().
     */
     /**
         Gets the split mode.
 
         @see SetSplitMode(), SplitVertically(), SplitHorizontally().
     */

-    int GetSplitMode() const;
+    wxSplitMode GetSplitMode() const;

 
     /**
         Returns the left/top or only pane.
 
     /**
         Returns the left/top or only pane.


@@ -284,16 +309,7 @@ public:
 
         @see GetSashPosition()
     */
 
         @see GetSashPosition()
     */

-    void SetSashPosition(int position, const bool redraw = true);
-
-    /**
-        Sets the sash size. Normally, the sash size is determined according to the
-        metrics
-        of each platform, but the application can override this, for example to show
-        a thin sash that the user is not expected to drag. If @a size is more -1,
-        the custom sash size will be used.
-    */
-    void SetSashSize(int size);
+    void SetSashPosition(int position, bool redraw = true);

 
     /**
         Sets the split mode.
 
     /**
         Sets the split mode.


@@ -408,23 +424,23 @@ public:
         The sash position is in the process of being changed.
         May be used to modify the position of the tracking bar to properly
         reflect the position that would be set if the drag were to be completed
         The sash position is in the process of being changed.
         May be used to modify the position of the tracking bar to properly
         reflect the position that would be set if the drag were to be completed

-        at this point. Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.
+        at this point. Processes a @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING event.

     @event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
         The sash position was changed. May be used to modify the sash position
         before it is set, or to prevent the change from taking place.
     @event{EVT_SPLITTER_SASH_POS_CHANGED(id, func)}
         The sash position was changed. May be used to modify the sash position
         before it is set, or to prevent the change from taking place.

-        Processes a wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.
+        Processes a @c wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED event.

     @event{EVT_SPLITTER_UNSPLIT(id, func)}
     @event{EVT_SPLITTER_UNSPLIT(id, func)}

-        The splitter has been just unsplit. Processes a wxEVT_COMMAND_SPLITTER_UNSPLIT event.
+        The splitter has been just unsplit. Processes a @c wxEVT_COMMAND_SPLITTER_UNSPLIT event.

     @event{EVT_SPLITTER_DCLICK(id, func)}
         The sash was double clicked. The default behaviour is to unsplit the
         window when this happens (unless the minimum pane size has been set
     @event{EVT_SPLITTER_DCLICK(id, func)}
         The sash was double clicked. The default behaviour is to unsplit the
         window when this happens (unless the minimum pane size has been set

-        to a value greater than zero). Processes a wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.
+        to a value greater than zero). Processes a @c wxEVT_COMMAND_SPLITTER_DOUBLECLICKED event.

     @endEventTable
 
     @library{wxcore}
     @category{events}
 
     @endEventTable
 
     @library{wxcore}
     @category{events}
 

-    @see wxSplitterWindow, @ref overview_eventhandling
+    @see wxSplitterWindow, @ref overview_events

 */
 class wxSplitterEvent : public wxNotifyEvent
 {
 */
 class wxSplitterEvent : public wxNotifyEvent
 {