added and documented wxDYNLIB_FUNCTION

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

diff --git a/include/wx/generic/splitter.h b/include/wx/generic/splitter.h
index f128338dc7cb94c4f2e3620739b8bf1847b28324..38420cdd652421b00856077f62d6864c31b1d514 100644 (file)
--- a/include/wx/generic/splitter.h
+++ b/include/wx/generic/splitter.h
@@ -1,39 +1,48 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// 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__
-#pragma interface "splitter.h"
+#if defined(__GNUG__) && !defined(__APPLE__)
+    #pragma interface "splitter.h"

 #endif
 
 #endif
 

-#include "wx/defs.h"
-#include "wx/window.h"
-#include "wx/string.h"
+#include "wx/window.h"                      // base class declaration
+#include "wx/containr.h"                    // wxControlContainer

 
 

-#define WXSPLITTER_VERSION      1.0
+class WXDLLEXPORT wxSplitterEvent;

 
 

-#define wxSPLIT_HORIZONTAL      1
-#define wxSPLIT_VERTICAL        2
+// ---------------------------------------------------------------------------
+// splitter constants
+// ---------------------------------------------------------------------------

 
 

-#define wxSPLIT_DRAG_NONE       0
-#define wxSPLIT_DRAG_DRAGGING   1
-#define wxSPLIT_DRAG_LEFT_DOWN  2
+enum wxSplitMode
+{
+    wxSPLIT_HORIZONTAL = 1,
+    wxSPLIT_VERTICAL
+};
+
+enum
+{
+    wxSPLIT_DRAG_NONE,
+    wxSPLIT_DRAG_DRAGGING,
+    wxSPLIT_DRAG_LEFT_DOWN
+};

 
 

-/*
- * wxSplitterWindow maintains one or two panes, with
- * an optional vertical or horizontal split which
- * can be used with the mouse or programmatically.
- */
+// ---------------------------------------------------------------------------
+// wxSplitterWindow maintains one or two panes, with
+// an optional vertical or horizontal split which
+// can be used with the mouse or programmatically.
+// ---------------------------------------------------------------------------

 
 // TODO:
 // 1) Perhaps make the borders sensitive to dragging in order to create a split.
 
 // TODO:
 // 1) Perhaps make the borders sensitive to dragging in order to create a split.


@@ -46,32 +55,53 @@
 
 class WXDLLEXPORT wxSplitterWindow: public wxWindow
 {
 
 class WXDLLEXPORT wxSplitterWindow: public wxWindow
 {

-  DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
-
- public:
+public:

 
 ////////////////////////////////////////////////////////////////////////////
 // Public API
 
     // Default constructor
 
 ////////////////////////////////////////////////////////////////////////////
 // Public API
 
     // Default constructor

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

 
     // Normal constructor
 
     // Normal constructor

-    wxSplitterWindow(wxWindow *parent, wxWindowID id = -1, const wxPoint& pos = wxDefaultPosition,
-        const wxSize& size = wxDefaultSize, long style = wxSP_3D|wxCLIP_CHILDREN, const wxString& name = "splitter");
-    ~wxSplitterWindow(void);
+    wxSplitterWindow(wxWindow *parent, wxWindowID id = -1,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     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 = -1,
+                     const wxPoint& pos = wxDefaultPosition,
+                     const wxSize& size = wxDefaultSize,
+                     long style = wxSP_3D,
+                     const wxString& name = wxT("splitter"));

 
     // Gets the only or left/top pane
 
     // Gets the only or left/top pane

-    inline wxWindow *GetWindow1(void) { return m_windowOne; }
+    wxWindow *GetWindow1() const { return m_windowOne; }

 
     // Gets the right/bottom pane
 
     // Gets the right/bottom pane

-    inline wxWindow *GetWindow2(void) { return m_windowTwo; }
+    wxWindow *GetWindow2() const { return m_windowTwo; }

 
     // Sets the split mode
 
     // Sets the split mode

-    inline 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

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

 
     // Initialize with one window
     void Initialize(wxWindow *window);
 
     // Initialize with one window
     void Initialize(wxWindow *window);


@@ -79,43 +109,68 @@ class WXDLLEXPORT wxSplitterWindow: public wxWindow
     // 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.
     // 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.

-    // A sashPosition of -1 means choose a default sash position.
-    bool SplitVertically(wxWindow *window1, wxWindow *window2, int sashPosition = -1);
-    bool SplitHorizontally(wxWindow *window1, wxWindow *window2, int sashPosition = -1);
+    // 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)
+        { return DoSplit(wxSPLIT_VERTICAL, window1, window2, sashPosition); }
+    virtual bool SplitHorizontally(wxWindow *window1,
+                                   wxWindow *window2,
+                                   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.
     bool Unsplit(wxWindow *toRemove = (wxWindow *) NULL);
 
 
     // Removes the specified (or second) window from the view
     // Doesn't actually delete the window.
     bool Unsplit(wxWindow *toRemove = (wxWindow *) NULL);
 

+    // Replaces one of the windows with another one (neither old nor new
+    // parameter should be NULL)
+    bool ReplaceWindow(wxWindow *winOld, wxWindow *winNew);
+

     // Is the window split?
     // Is the window split?

-    inline bool IsSplit(void) const { return (m_windowTwo != NULL); }
+    bool IsSplit() const { return (m_windowTwo != NULL); }

 
     // Sets the sash size
 
     // Sets the sash size

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

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

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

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

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

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

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

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

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

 
     // Gets the sash position
 
     // Gets the sash position

-    inline int GetSashPosition(void) const { return m_sashPosition; }
+    int GetSashPosition() const { return m_sashPosition; }

 
     // If this is zero, we can remove panes by dragging the sash.
 
     // If this is zero, we can remove panes by dragging the sash.

-    inline void SetMinimumPaneSize(int min) { m_minimumPaneSize = min; }
-    inline int GetMinimumPaneSize(void) const { return m_minimumPaneSize; }
+    void SetMinimumPaneSize(int min);
+    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
+    // 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.
+    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 *removed) { removed->Show(FALSE); }
+    virtual void OnUnsplit(wxWindow *removed);

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


@@ -134,47 +189,217 @@ class WXDLLEXPORT wxSplitterWindow: public wxWindow
     // Adjusts the panes
     void OnSize(wxSizeEvent& event);
 
     // Adjusts the panes
     void OnSize(wxSizeEvent& event);
 

-    // Draws borders
-    void DrawBorders(wxDC& dc);
+    // In live mode, resize child windows in idle time
+    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(void);
+    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
+
+    // send the given event, return FALSE if the event was processed and vetoed
+    // by the user code
+    inline bool DoSendEvent(wxSplitterEvent& event);
+
+protected:
+    // common part of all ctors
+    void Init();
+
+    // common part of SplitVertically() and SplitHorizontally()
+    bool DoSplit(wxSplitMode mode,
+                 wxWindow *window1, wxWindow *window2,
+                 int sashPosition);

 
 

-    // Initialize colours
-    void InitColours(void);
+    // adjusts sash position with respect to min. pane and window sizes
+    int AdjustSashPosition(int sashPos) const;

 
 

- protected:
-    int         m_splitMode;
+    // get either width or height depending on the split mode
+    int GetWindowSize() const;
+
+    // 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;
+
+    // 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;
-DECLARE_EVENT_TABLE()
+    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;
+
+private:
+    WX_DECLARE_CONTROL_CONTAINER();
+
+    DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
+    DECLARE_EVENT_TABLE()
+    DECLARE_NO_COPY_CLASS(wxSplitterWindow)

 };
 
 };
 

-#endif
+// ----------------------------------------------------------------------------
+// event class and macros
+// ----------------------------------------------------------------------------
+
+// we reuse the same class for all splitter event types because this is the
+// 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 wxNotifyEvent
+{
+public:
+    wxSplitterEvent(wxEventType type = wxEVT_NULL,
+                    wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)
+        : wxNotifyEvent(type)
+    {
+        SetEventObject(splitter);
+        if (splitter) m_id = splitter->GetId();
+    }
+
+    // SASH_POS_CHANGED methods
+
+    // setting the sash position to -1 prevents the change from taking place at
+    // all
+    void SetSashPosition(int pos)
+    {
+        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
+                || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
+
+        m_data.pos = pos;
+    }
+
+    int GetSashPosition() const
+    {
+        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
+                || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
+
+        return m_data.pos;
+    }
+
+    // UNSPLIT event methods
+    wxWindow *GetWindowBeingRemoved() const
+    {
+        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_UNSPLIT );
+
+        return m_data.win;
+    }
+
+    // DCLICK event methods
+    int GetX() const
+    {
+        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
+
+        return m_data.pt.x;
+    }
+
+    int GetY() const
+    {
+        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
+
+        return m_data.pt.y;
+    }
+
+private:
+    friend class WXDLLEXPORT wxSplitterWindow;
+
+    // data for the different types of event
+    union
+    {
+        int pos;            // position for SASH_POS_CHANGED event
+        wxWindow *win;      // window being removed for UNSPLIT event
+        struct
+        {
+            int x, y;
+        } pt;               // position of double click for DCLICK event
+    } m_data;
+
+    DECLARE_DYNAMIC_CLASS_NO_COPY(wxSplitterEvent)
+};
+
+typedef void (wxEvtHandler::*wxSplitterEventFunction)(wxSplitterEvent&);
+
+#define EVT_SPLITTER_SASH_POS_CHANGED(id, fn)                               \
+  DECLARE_EVENT_TABLE_ENTRY(                                                \
+    wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED,                                \
+    id,                                                                     \
+    -1,                                                                     \
+    (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn,  \
+    NULL                                                                    \
+  ),
+
+#define EVT_SPLITTER_SASH_POS_CHANGING(id, fn)                              \
+  DECLARE_EVENT_TABLE_ENTRY(                                                \
+    wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING,                               \
+    id,                                                                     \
+    -1,                                                                     \
+    (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn,  \
+    NULL                                                                    \
+  ),
+
+#define EVT_SPLITTER_DCLICK(id, fn)                                         \
+  DECLARE_EVENT_TABLE_ENTRY(                                                \
+    wxEVT_COMMAND_SPLITTER_DOUBLECLICKED,                                   \
+    id,                                                                     \
+    -1,                                                                     \
+    (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn,  \
+    NULL                                                                    \
+  ),
+
+#define EVT_SPLITTER_UNSPLIT(id, fn)                                        \
+  DECLARE_EVENT_TABLE_ENTRY(                                                \
+    wxEVT_COMMAND_SPLITTER_UNSPLIT,                                         \
+    id,                                                                     \
+    -1,                                                                     \
+    (wxObjectEventFunction)(wxEventFunction)(wxSplitterEventFunction) &fn,  \
+    NULL                                                                    \
+  ),
+
+#endif // __SPLITTERH_G__