Better markup.

[wxWidgets.git] / include / wx / generic / splitter.h

diff --git a/include/wx/generic/splitter.h b/include/wx/generic/splitter.h
index d74fc68403268044fd2fdecb81bc322298cd4448..2102a1bb51cbbd99ed2dcec9f7f6a336a3ccb5fa 100644 (file)
--- a/include/wx/generic/splitter.h
+++ b/include/wx/generic/splitter.h
@@ -1,22 +1,23 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        splitter.h
+// Name:        wx/splitter.h

 // Purpose:     wxSplitterWindow class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$
 // Purpose:     wxSplitterWindow class
 // Author:      Julian Smart
 // Modified by:
 // Created:     01/02/97
 // RCS-ID:      $Id$

-// Copyright:   (c) Julian Smart and Markus Holzem
-// Licence:     wxWindows license
+// Copyright:   (c) Julian Smart
+// Licence:     wxWindows licence

 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __SPLITTERH_G__
 #define __SPLITTERH_G__
 
 /////////////////////////////////////////////////////////////////////////////
 
 #ifndef __SPLITTERH_G__
 #define __SPLITTERH_G__
 

-#ifdef __GNUG__
+#if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)

     #pragma interface "splitter.h"
 #endif
 
 #include "wx/window.h"                      // base class declaration
     #pragma interface "splitter.h"
 #endif
 
 #include "wx/window.h"                      // base class declaration

+#include "wx/containr.h"                    // wxControlContainer

 
 class WXDLLEXPORT wxSplitterEvent;
 
 
 class WXDLLEXPORT wxSplitterEvent;
 


@@ -24,7 +25,7 @@ class WXDLLEXPORT wxSplitterEvent;
 // splitter constants
 // ---------------------------------------------------------------------------
 
 // splitter constants
 // ---------------------------------------------------------------------------
 

-enum
+enum wxSplitMode

 {
     wxSPLIT_HORIZONTAL = 1,
     wxSPLIT_VERTICAL
 {
     wxSPLIT_HORIZONTAL = 1,
     wxSPLIT_VERTICAL


@@ -48,7 +49,7 @@ enum
 //    The MFC splitter window manages scrollbars as well so is able to
 //    put sash buttons on the scrollbars, but we probably don't want to go down
 //    this path.
 //    The MFC splitter window manages scrollbars as well so is able to
 //    put sash buttons on the scrollbars, but we probably don't want to go down
 //    this path.

-// 2) for wxWindows 2.0, we must find a way to set the WS_CLIPCHILDREN style
+// 2) for wxWidgets 2.0, we must find a way to set the WS_CLIPCHILDREN style

 //    to prevent flickering. (WS_CLIPCHILDREN doesn't work in all cases so can't be
 //    standard).
 
 //    to prevent flickering. (WS_CLIPCHILDREN doesn't work in all cases so can't be
 //    standard).
 


@@ -60,15 +61,29 @@ public:
 // Public API
 
     // Default constructor
 // Public API
 
     // Default constructor

-    wxSplitterWindow();
+    wxSplitterWindow()
+    {
+        Init();
+    }

 
     // Normal constructor
 
     // Normal constructor

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

                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,

-                     long style = wxSP_3D|wxCLIP_CHILDREN,
-                     const wxString& name = "splitter");
-    ~wxSplitterWindow();
+                     long style = wxSP_3D,
+                     const wxString& name = wxT("splitter"))
+    {
+        Init();
+        Create(parent, id, pos, size, style, name);
+    }
+
+    virtual ~wxSplitterWindow();
+
+    bool Create(wxWindow *parent, wxWindowID id = wxID_ANY,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = wxSP_3D,
+                     const wxString& name = wxT("splitter"));

 
     // Gets the only or left/top pane
     wxWindow *GetWindow1() const { return m_windowOne; }
 
     // Gets the only or left/top pane
     wxWindow *GetWindow1() const { return m_windowOne; }


@@ -77,26 +92,34 @@ public:
     wxWindow *GetWindow2() const { return m_windowTwo; }
 
     // Sets the split mode
     wxWindow *GetWindow2() const { return m_windowTwo; }
 
     // Sets the split mode

-    void SetSplitMode(int mode) { m_splitMode = mode; }
+    void SetSplitMode(int mode)
+    {
+        wxASSERT_MSG( mode == wxSPLIT_VERTICAL || mode == wxSPLIT_HORIZONTAL,
+                      _T("invalid split mode") );
+
+        m_splitMode = (wxSplitMode)mode;
+    }

 
     // Gets the split mode
 
     // Gets the split mode

-    int GetSplitMode() const { return m_splitMode; };
+    wxSplitMode GetSplitMode() const { return m_splitMode; };

 
     // Initialize with one window
     void Initialize(wxWindow *window);
 
     // Associates the given window with window 2, drawing the appropriate sash
     // and changing the split mode.
 
     // Initialize with one window
     void Initialize(wxWindow *window);
 
     // Associates the given window with window 2, drawing the appropriate sash
     // and changing the split mode.

-    // Does nothing and returns FALSE if the window is already split.
+    // Does nothing and returns false if the window is already split.

     // A sashPosition of 0 means choose a default sash position,
     // negative sashPosition specifies the size of right/lower pane as it's
     // absolute value rather than the size of left/upper pane.
     virtual bool SplitVertically(wxWindow *window1,
                                  wxWindow *window2,
     // A sashPosition of 0 means choose a default sash position,
     // negative sashPosition specifies the size of right/lower pane as it's
     // absolute value rather than the size of left/upper pane.
     virtual bool SplitVertically(wxWindow *window1,
                                  wxWindow *window2,

-                                 int sashPosition = 0);
+                                 int sashPosition = 0)
+        { return DoSplit(wxSPLIT_VERTICAL, window1, window2, sashPosition); }

     virtual bool SplitHorizontally(wxWindow *window1,
                                    wxWindow *window2,
     virtual bool SplitHorizontally(wxWindow *window1,
                                    wxWindow *window2,

-                                   int sashPosition = 0);
+                                   int sashPosition = 0)
+        { return DoSplit(wxSPLIT_HORIZONTAL, window1, window2, sashPosition); }

 
     // Removes the specified (or second) window from the view
     // Doesn't actually delete the window.
 
     // Removes the specified (or second) window from the view
     // Doesn't actually delete the window.


@@ -106,47 +129,58 @@ public:
     // parameter should be NULL)
     bool ReplaceWindow(wxWindow *winOld, wxWindow *winNew);
 
     // parameter should be NULL)
     bool ReplaceWindow(wxWindow *winOld, wxWindow *winNew);
 

+    // Make sure the child window sizes are updated. This is useful
+    // for reducing flicker by updating the sizes before a
+    // window is shown, if you know the overall size is correct.
+    void UpdateSize();
+

     // Is the window split?
     bool IsSplit() const { return (m_windowTwo != NULL); }
 
     // Sets the sash size
     // Is the window split?
     bool IsSplit() const { return (m_windowTwo != NULL); }
 
     // Sets the sash size

-    void SetSashSize(int width) { m_sashSize = width; }
+    void SetSashSize(int WXUNUSED(width)) { }

 
     // Sets the border size
 
     // Sets the border size

-    void SetBorderSize(int width) { m_borderSize = width; }
+    void SetBorderSize(int WXUNUSED(width)) { }

 
     // Gets the sash size
 
     // Gets the sash size

-    int GetSashSize() const { return m_sashSize; }
+    int GetSashSize() const;

 
     // Gets the border size
 
     // Gets the border size

-    int GetBorderSize() const { return m_borderSize; }
+    int GetBorderSize() const;

 
     // Set the sash position
 
     // Set the sash position

-    void SetSashPosition(int position, bool redraw = TRUE);
+    void SetSashPosition(int position, bool redraw = true);

 
     // Gets the sash position
     int GetSashPosition() const { return m_sashPosition; }
 
     // If this is zero, we can remove panes by dragging the sash.
 
     // Gets the sash position
     int GetSashPosition() const { return m_sashPosition; }
 
     // If this is zero, we can remove panes by dragging the sash.

-    void SetMinimumPaneSize(int min) { m_minimumPaneSize = min; }
+    void SetMinimumPaneSize(int min);

     int GetMinimumPaneSize() const { return m_minimumPaneSize; }
 
     int GetMinimumPaneSize() const { return m_minimumPaneSize; }
 

+    // NB: the OnXXX() functions below are for backwards compatibility only,
+    //     don't use them in new code but handle the events instead!
+
+    // called when the sash position is about to change, may return a new value
+    // for the sash or -1 to prevent the change from happening at all
+    virtual int OnSashPositionChanging(int newSashPosition);
+

     // Called when the sash position is about to be changed, return
     // Called when the sash position is about to be changed, return

-    // FALSE from here to prevent the change from taking place.
+    // false from here to prevent the change from taking place.

     // Repositions sash to minimum position if pane would be too small.
     // newSashPosition here is always positive or zero.
     // Repositions sash to minimum position if pane would be too small.
     // newSashPosition here is always positive or zero.

-    virtual bool OnSashPositionChange(int WXUNUSED(newSashPosition))
-        { return TRUE; }
+    virtual bool OnSashPositionChange(int newSashPosition);

 
     // If the sash is moved to an extreme position, a subwindow
     // is removed from the splitter window, and the app is
     // notified. The app should delete or hide the window.
 
     // If the sash is moved to an extreme position, a subwindow
     // is removed from the splitter window, and the app is
     // notified. The app should delete or hide the window.

-    virtual void OnUnsplit(wxWindow *WXUNUSED(removed)) { }
+    virtual void OnUnsplit(wxWindow *removed);

 
     // Called when the sash is double-clicked.
     // The default behaviour is to remove the sash if the
     // minimum pane size is zero.
 
     // Called when the sash is double-clicked.
     // The default behaviour is to remove the sash if the
     // minimum pane size is zero.

-    virtual void OnDoubleClickSash(int WXUNUSED(x), int WXUNUSED(y)) { }
+    virtual void OnDoubleClickSash(int x, int y);

 
 ////////////////////////////////////////////////////////////////////////////
 // Implementation
 
 ////////////////////////////////////////////////////////////////////////////
 // Implementation


@@ -161,62 +195,100 @@ public:
     void OnSize(wxSizeEvent& event);
 
     // In live mode, resize child windows in idle time
     void OnSize(wxSizeEvent& event);
 
     // In live mode, resize child windows in idle time

-    void OnIdle(wxIdleEvent& event);
-
-    // Draws borders
-    void DrawBorders(wxDC& dc);
+    void OnInternalIdle();

 
     // Draws the sash
 
     // Draws the sash

-    void DrawSash(wxDC& dc);
+    virtual void DrawSash(wxDC& dc);

 
     // Draws the sash tracker (for whilst moving the sash)
 
     // Draws the sash tracker (for whilst moving the sash)

-    void DrawSashTracker(int x, int y);
+    virtual void DrawSashTracker(int x, int y);

 
     // Tests for x, y over sash
 
     // Tests for x, y over sash

-    bool SashHitTest(int x, int y, int tolerance = 2);
+    virtual bool SashHitTest(int x, int y, int tolerance = 5);

 
     // Resizes subwindows
 
     // Resizes subwindows

-    void SizeWindows();
+    virtual void SizeWindows();
+
+    void SetNeedUpdating(bool needUpdating) { m_needUpdating = needUpdating; }
+    bool GetNeedUpdating() const { return m_needUpdating ; }
+
+protected:
+    // event handlers
+#if defined(__WXMSW__) || defined(__WXMAC__)
+    void OnSetCursor(wxSetCursorEvent& event);
+#endif // wxMSW

 
 

-    // Initialize colours
-    void InitColours();
+    // send the given event, return false if the event was processed and vetoed
+    // by the user code
+    inline bool DoSendEvent(wxSplitterEvent& event);

 
 protected:
 
 protected:

-    // our event handlers
-    void OnSashPosChanged(wxSplitterEvent& event);
-    void OnSashPosChanging(wxSplitterEvent& event);
-    void OnDoubleClick(wxSplitterEvent& event);
-    void OnUnsplitEvent(wxSplitterEvent& event);
+    // common part of all ctors
+    void Init();
+
+    // common part of SplitVertically() and SplitHorizontally()
+    bool DoSplit(wxSplitMode mode,
+                 wxWindow *window1, wxWindow *window2,
+                 int sashPosition);
+
+    // adjusts sash position with respect to min. pane and window sizes
+    int AdjustSashPosition(int sashPos) const;
+
+    // get either width or height depending on the split mode
+    int GetWindowSize() const;

 
 

-    void SendUnsplitEvent(wxWindow *winRemoved);
+    // convert the user specified sash position which may be > 0 (as is), < 0
+    // (specifying the size of the right pane) or 0 (use default) to the real
+    // position to be passed to DoSetSashPosition()
+    int ConvertSashPosition(int sashPos) const;

 
 

-    int         m_splitMode;
-    bool        m_permitUnsplitAlways;
-    bool        m_needUpdating; // when in live mode, set the to TRUE to resize children in idle
+    // set the real sash position, sashPos here must be positive
+    //
+    // returns true if the sash position has been changed, false otherwise
+    bool DoSetSashPosition(int sashPos);
+
+    // set the sash position and send an event about it having been changed
+    void SetSashPositionAndNotify(int sashPos);
+
+    // callbacks executed when we detect that the mouse has entered or left
+    // the sash
+    virtual void OnEnterSash();
+    virtual void OnLeaveSash();
+
+    // set the cursor appropriate for the current split mode
+    void SetResizeCursor();
+
+    // redraw the splitter if its "hotness" changed if necessary
+    void RedrawIfHotSensitive(bool isHot);
+
+    wxSplitMode m_splitMode;

     wxWindow*   m_windowOne;
     wxWindow*   m_windowTwo;
     int         m_dragMode;
     int         m_oldX;
     int         m_oldY;
     wxWindow*   m_windowOne;
     wxWindow*   m_windowTwo;
     int         m_dragMode;
     int         m_oldX;
     int         m_oldY;

-    int         m_borderSize;
-    int         m_sashSize;     // Sash width or height

     int         m_sashPosition; // Number of pixels from left or top
     int         m_sashPosition; // Number of pixels from left or top

+    int         m_requestedSashPosition;
+    int         m_sashPositionCurrent; // while dragging

     int         m_firstX;
     int         m_firstY;
     int         m_minimumPaneSize;
     int         m_firstX;
     int         m_firstY;
     int         m_minimumPaneSize;

-    wxCursor*   m_sashCursorWE;
-    wxCursor*   m_sashCursorNS;
-    wxPen*      m_sashTrackerPen;
-    wxPen*      m_lightShadowPen;
-    wxPen*      m_mediumShadowPen;
-    wxPen*      m_darkShadowPen;
-    wxPen*      m_hilightPen;
-    wxBrush*    m_faceBrush;
-    wxPen*      m_facePen;
+    wxCursor    m_sashCursorWE;
+    wxCursor    m_sashCursorNS;
+    wxPen      *m_sashTrackerPen;
+
+    // when in live mode, set this to true to resize children in idle
+    bool        m_needUpdating:1;
+    bool        m_permitUnsplitAlways:1;
+    bool        m_isHot:1;
+    bool        m_checkRequestedSashPosition:1;

 
 private:
 
 private:

+    WX_DECLARE_CONTROL_CONTAINER();
+

     DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
     DECLARE_EVENT_TABLE()
     DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
     DECLARE_EVENT_TABLE()

+    DECLARE_NO_COPY_CLASS(wxSplitterWindow)

 };
 
 // ----------------------------------------------------------------------------
 };
 
 // ----------------------------------------------------------------------------


@@ -227,12 +299,12 @@ private:
 // usual wxWin convention, but the three event types have different kind of
 // data associated with them, so the accessors can be only used if the real
 // event type matches with the one for which the accessors make sense
 // usual wxWin convention, but the three event types have different kind of
 // data associated with them, so the accessors can be only used if the real
 // event type matches with the one for which the accessors make sense

-class WXDLLEXPORT wxSplitterEvent : public wxCommandEvent
+class WXDLLEXPORT wxSplitterEvent : public wxNotifyEvent

 {
 public:
     wxSplitterEvent(wxEventType type = wxEVT_NULL,
                     wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)
 {
 public:
     wxSplitterEvent(wxEventType type = wxEVT_NULL,
                     wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)

-        : wxCommandEvent(type)
+        : wxNotifyEvent(type)

     {
         SetEventObject(splitter);
         if (splitter) m_id = splitter->GetId();
     {
         SetEventObject(splitter);
         if (splitter) m_id = splitter->GetId();


@@ -295,45 +367,45 @@ private:
         } pt;               // position of double click for DCLICK event
     } m_data;
 
         } pt;               // position of double click for DCLICK event
     } m_data;
 

-    DECLARE_DYNAMIC_CLASS(wxSplitterEvent)
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxSplitterEvent)

 };
 
 typedef void (wxEvtHandler::*wxSplitterEventFunction)(wxSplitterEvent&);
 
 #define EVT_SPLITTER_SASH_POS_CHANGED(id, fn)                               \
 };
 
 typedef void (wxEvtHandler::*wxSplitterEventFunction)(wxSplitterEvent&);
 
 #define EVT_SPLITTER_SASH_POS_CHANGED(id, fn)                               \

-  {                                                                         \
+  DECLARE_EVENT_TABLE_ENTRY(                                                \

     wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED,                                \
     id,                                                                     \
     wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED,                                \
     id,                                                                     \

-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn,  \
+    wxID_ANY,                                                               \
+    (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \

     NULL                                                                    \
     NULL                                                                    \

-  },
+  ),

 
 #define EVT_SPLITTER_SASH_POS_CHANGING(id, fn)                              \
 
 #define EVT_SPLITTER_SASH_POS_CHANGING(id, fn)                              \

-  {                                                                         \
+  DECLARE_EVENT_TABLE_ENTRY(                                                \

     wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING,                               \
     id,                                                                     \
     wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING,                               \
     id,                                                                     \

-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn,  \
+    wxID_ANY,                                                               \
+    (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \

     NULL                                                                    \
     NULL                                                                    \

-  },
+  ),

 
 #define EVT_SPLITTER_DCLICK(id, fn)                                         \
 
 #define EVT_SPLITTER_DCLICK(id, fn)                                         \

-  {                                                                         \
+  DECLARE_EVENT_TABLE_ENTRY(                                                \

     wxEVT_COMMAND_SPLITTER_DOUBLECLICKED,                                   \
     id,                                                                     \
     wxEVT_COMMAND_SPLITTER_DOUBLECLICKED,                                   \
     id,                                                                     \

-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn,  \
+    wxID_ANY,                                                               \
+    (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \

     NULL                                                                    \
     NULL                                                                    \

-  },
+  ),

 
 #define EVT_SPLITTER_UNSPLIT(id, fn)                                        \
 
 #define EVT_SPLITTER_UNSPLIT(id, fn)                                        \

-  {                                                                         \
+  DECLARE_EVENT_TABLE_ENTRY(                                                \

     wxEVT_COMMAND_SPLITTER_UNSPLIT,                                         \
     id,                                                                     \
     wxEVT_COMMAND_SPLITTER_UNSPLIT,                                         \
     id,                                                                     \

-    -1,                                                                     \
-    (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn,  \
+    wxID_ANY,                                                               \
+    (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \

     NULL                                                                    \
     NULL                                                                    \

-  },
+  ),

 
 #endif // __SPLITTERH_G__
 
 #endif // __SPLITTERH_G__