Fix missing documentation for several GDI functions.

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

diff --git a/include/wx/generic/splitter.h b/include/wx/generic/splitter.h
index 26480fe129175a0cf632c6aa78afc1c0ea768638..ad319e44df4f477c81506f6185f320b8b866a1c4 100644 (file)
--- a/include/wx/generic/splitter.h
+++ b/include/wx/generic/splitter.h
@@ -1,25 +1,21 @@
 /////////////////////////////////////////////////////////////////////////////
 /////////////////////////////////////////////////////////////////////////////

-// Name:        wx/splitter.h
+// Name:        wx/generic/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__
-
-#if defined(__GNUG__) && !defined(__APPLE__)
-    #pragma interface "splitter.h"
-#endif
+#ifndef _WX_GENERIC_SPLITTER_H_
+#define _WX_GENERIC_SPLITTER_H_

 
 #include "wx/window.h"                      // base class declaration
 #include "wx/containr.h"                    // wxControlContainer
 
 
 #include "wx/window.h"                      // base class declaration
 #include "wx/containr.h"                    // wxControlContainer
 

-class WXDLLEXPORT wxSplitterEvent;
+class WXDLLIMPEXP_FWD_CORE wxSplitterEvent;

 
 // ---------------------------------------------------------------------------
 // splitter constants
 
 // ---------------------------------------------------------------------------
 // splitter constants


@@ -49,11 +45,11 @@ 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).
 

-class WXDLLEXPORT wxSplitterWindow: public wxWindow
+class WXDLLIMPEXP_CORE wxSplitterWindow: public wxNavigationEnabled<wxWindow>

 {
 public:
 
 {
 public:
 


@@ -67,7 +63,7 @@ public:
     }
 
     // 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,
                      long style = wxSP_3D,
                      const wxPoint& pos = wxDefaultPosition,
                      const wxSize& size = wxDefaultSize,
                      long style = wxSP_3D,


@@ -79,7 +75,7 @@ public:
 
     virtual ~wxSplitterWindow();
 
 
     virtual ~wxSplitterWindow();
 

-    bool Create(wxWindow *parent, wxWindowID id = -1,
+    bool Create(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,


@@ -95,20 +91,20 @@ public:
     void SetSplitMode(int mode)
     {
         wxASSERT_MSG( mode == wxSPLIT_VERTICAL || mode == wxSPLIT_HORIZONTAL,
     void SetSplitMode(int mode)
     {
         wxASSERT_MSG( mode == wxSPLIT_VERTICAL || mode == wxSPLIT_HORIZONTAL,

-                      _T("invalid split mode") );
+                      wxT("invalid split mode") );

 
         m_splitMode = (wxSplitMode)mode;
     }
 
     // Gets the split mode
 
         m_splitMode = (wxSplitMode)mode;
     }
 
     // Gets the split mode

-    wxSplitMode 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.
     // 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.


@@ -123,33 +119,47 @@ public:
 
     // 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.

-    bool Unsplit(wxWindow *toRemove = (wxWindow *) NULL);
+    bool Unsplit(wxWindow *toRemove = NULL);

 
     // Replaces one of the windows with another one (neither old nor new
     // parameter should be NULL)
     bool ReplaceWindow(wxWindow *winOld, wxWindow *winNew);
 
 
     // Replaces one of the windows with another one (neither old nor new
     // 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); }
 
     // Is the window split?
     bool IsSplit() const { return (m_windowTwo != NULL); }
 

-    // Sets the sash size
-    void SetSashSize(int width) { m_sashSize = 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
-    int GetSashSize() const { return m_sashSize; }
+    // Hide or show the sash and test whether it's currently hidden.
+    void SetSashInvisible(bool invisible = true);
+    bool IsSashInvisible() const { return HasFlag(wxSP_NOSASH); }
+
+    // Gets the current sash size which may be 0 if it's hidden and the default
+    // sash size.
+    int GetSashSize() const;
+    int GetDefaultSashSize() 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; }
 
 
     // Gets the sash position
     int GetSashPosition() const { return m_sashPosition; }
 

+    // Set the sash gravity
+    void SetSashGravity(double gravity);
+
+    // Gets the sash gravity
+    double GetSashGravity() const { return m_sashGravity; }
+

     // If this is zero, we can remove panes by dragging the sash.
     void SetMinimumPaneSize(int min);
     int GetMinimumPaneSize() const { return m_minimumPaneSize; }
     // If this is zero, we can remove panes by dragging the sash.
     void SetMinimumPaneSize(int min);
     int GetMinimumPaneSize() const { return m_minimumPaneSize; }


@@ -162,7 +172,7 @@ public:
     virtual int OnSashPositionChanging(int newSashPosition);
 
     // Called when the sash position is about to be changed, return
     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.
+    // 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);
     // Repositions sash to minimum position if pane would be too small.
     // newSashPosition here is always positive or zero.
     virtual bool OnSashPositionChange(int newSashPosition);


@@ -186,14 +196,14 @@ public:
     // Handles mouse events
     void OnMouseEvent(wxMouseEvent& ev);
 
     // Handles mouse events
     void OnMouseEvent(wxMouseEvent& ev);
 

+    // Aborts dragging mode
+    void OnMouseCaptureLost(wxMouseCaptureLostEvent& event);
+

     // Adjusts the panes
     void OnSize(wxSizeEvent& event);
 
     // In live mode, resize child windows in idle time
     // Adjusts the panes
     void OnSize(wxSizeEvent& event);
 
     // In live mode, resize child windows in idle time

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

 
     // Draws the sash
     virtual void DrawSash(wxDC& dc);
 
     // Draws the sash
     virtual void DrawSash(wxDC& dc);


@@ -202,28 +212,29 @@ public:
     virtual void DrawSashTracker(int x, int y);
 
     // Tests for x, y over sash
     virtual void DrawSashTracker(int x, int y);
 
     // Tests for x, y over sash

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

 
     // Resizes subwindows
     virtual void SizeWindows();
 
 
     // Resizes subwindows
     virtual void SizeWindows();
 

-    // Initialize colours
-    void InitColours();
+#ifdef __WXMAC__
+    virtual bool MacClipGrandChildren() const { return true ; }
+#endif

 
 

-    void SetNeedUpdating(bool needUpdating) { m_needUpdating = needUpdating; }
-    bool GetNeedUpdating() const { return m_needUpdating ; }
+    // Sets the sash size: this doesn't do anything and shouldn't be used at
+    // all any more.
+    wxDEPRECATED_INLINE( void SetSashSize(int WXUNUSED(width)), return; )

 
 protected:
     // event handlers
 
 protected:
     // event handlers

-#ifdef __WXMSW__
+#if defined(__WXMSW__) || defined(__WXMAC__)

     void OnSetCursor(wxSetCursorEvent& event);
 #endif // wxMSW
 
     void OnSetCursor(wxSetCursorEvent& event);
 #endif // wxMSW
 

-    // send the given event, return FALSE if the event was processed and vetoed
+    // send the given event, return false if the event was processed and vetoed

     // by the user code
     // by the user code

-    inline bool DoSendEvent(wxSplitterEvent& event);
+    bool DoSendEvent(wxSplitterEvent& event);

 
 

-protected:

     // common part of all ctors
     void Init();
 
     // common part of all ctors
     void Init();
 


@@ -245,46 +256,55 @@ protected:
 
     // set the real sash position, sashPos here must be positive
     //
 
     // set the real sash position, sashPos here must be positive
     //

-    // returns TRUE if the sash position has been changed, FALSE otherwise
+    // 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);
 
     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();
 
     // set the cursor appropriate for the current split mode
     void SetResizeCursor();
 

+    // redraw the splitter if its "hotness" changed if necessary
+    void RedrawIfHotSensitive(bool isHot);
+
+    // return the best size of the splitter equal to best sizes of its
+    // subwindows
+    virtual wxSize DoGetBestSize() const;
+
+

     wxSplitMode m_splitMode;
     wxSplitMode m_splitMode;

-    bool        m_permitUnsplitAlways;
-    bool        m_needUpdating; // when in live mode, set this to TRUE to resize children in idle

     wxWindow*   m_windowOne;
     wxWindow*   m_windowTwo;
     int         m_dragMode;
     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_oldX;         // current tracker position if not live mode
+    int         m_oldY;         // current tracker position if not live mode

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

+    double      m_sashGravity;
+    wxSize      m_lastSize;

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

-    int         m_firstX;
-    int         m_firstY;
+    wxPoint     m_ptStart;      // mouse position when dragging started
+    int         m_sashStart;    // sash position when dragging started

     int         m_minimumPaneSize;
     wxCursor    m_sashCursorWE;
     wxCursor    m_sashCursorNS;
     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;
+    wxPen      *m_sashTrackerPen;

 
 

-private:
-    WX_DECLARE_CONTROL_CONTAINER();
+    // 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:

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

+    wxDECLARE_NO_COPY_CLASS(wxSplitterWindow);

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


@@ -295,16 +315,18 @@ 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 wxNotifyEvent
+class WXDLLIMPEXP_CORE wxSplitterEvent : public wxNotifyEvent

 {
 public:
     wxSplitterEvent(wxEventType type = wxEVT_NULL,
 {
 public:
     wxSplitterEvent(wxEventType type = wxEVT_NULL,

-                    wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)
+                    wxSplitterWindow *splitter = NULL)

         : wxNotifyEvent(type)
     {
         SetEventObject(splitter);
         if (splitter) m_id = splitter->GetId();
     }
         : wxNotifyEvent(type)
     {
         SetEventObject(splitter);
         if (splitter) m_id = splitter->GetId();
     }

+    wxSplitterEvent(const wxSplitterEvent& event)
+        : wxNotifyEvent(event), m_data(event.m_data) { }

 
     // SASH_POS_CHANGED methods
 
 
     // SASH_POS_CHANGED methods
 


@@ -312,16 +334,16 @@ public:
     // all
     void SetSashPosition(int pos)
     {
     // all
     void SetSashPosition(int pos)
     {

-        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
-                || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
+        wxASSERT( GetEventType() == wxEVT_SPLITTER_SASH_POS_CHANGED
+                || GetEventType() == wxEVT_SPLITTER_SASH_POS_CHANGING);

 
         m_data.pos = pos;
     }
 
     int GetSashPosition() const
     {
 
         m_data.pos = pos;
     }
 
     int GetSashPosition() const
     {

-        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
-                || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
+        wxASSERT( GetEventType() == wxEVT_SPLITTER_SASH_POS_CHANGED
+                || GetEventType() == wxEVT_SPLITTER_SASH_POS_CHANGING);

 
         return m_data.pos;
     }
 
         return m_data.pos;
     }


@@ -329,7 +351,7 @@ public:
     // UNSPLIT event methods
     wxWindow *GetWindowBeingRemoved() const
     {
     // UNSPLIT event methods
     wxWindow *GetWindowBeingRemoved() const
     {

-        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_UNSPLIT );
+        wxASSERT( GetEventType() == wxEVT_SPLITTER_UNSPLIT );

 
         return m_data.win;
     }
 
         return m_data.win;
     }


@@ -337,20 +359,22 @@ public:
     // DCLICK event methods
     int GetX() const
     {
     // DCLICK event methods
     int GetX() const
     {

-        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
+        wxASSERT( GetEventType() == wxEVT_SPLITTER_DOUBLECLICKED );

 
         return m_data.pt.x;
     }
 
     int GetY() const
     {
 
         return m_data.pt.x;
     }
 
     int GetY() const
     {

-        wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
+        wxASSERT( GetEventType() == wxEVT_SPLITTER_DOUBLECLICKED );

 
         return m_data.pt.y;
     }
 
 
         return m_data.pt.y;
     }
 

+    virtual wxEvent *Clone() const { return new wxSplitterEvent(*this); }
+

 private:
 private:

-    friend class WXDLLEXPORT wxSplitterWindow;
+    friend class WXDLLIMPEXP_FWD_CORE wxSplitterWindow;

 
     // data for the different types of event
     union
 
     // data for the different types of event
     union


@@ -363,45 +387,34 @@ 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_ASSIGN(wxSplitterEvent)

 };
 
 typedef void (wxEvtHandler::*wxSplitterEventFunction)(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__
+#define wxSplitterEventHandler(func) \
+    wxEVENT_HANDLER_CAST(wxSplitterEventFunction, func)
+
+#define wx__DECLARE_SPLITTEREVT(evt, id, fn) \
+    wx__DECLARE_EVT1(wxEVT_SPLITTER_ ## evt, id, wxSplitterEventHandler(fn))
+
+#define EVT_SPLITTER_SASH_POS_CHANGED(id, fn) \
+    wx__DECLARE_SPLITTEREVT(SASH_POS_CHANGED, id, fn)
+
+#define EVT_SPLITTER_SASH_POS_CHANGING(id, fn) \
+    wx__DECLARE_SPLITTEREVT(SASH_POS_CHANGING, id, fn)
+
+#define EVT_SPLITTER_DCLICK(id, fn) \
+    wx__DECLARE_SPLITTEREVT(DOUBLECLICKED, id, fn)
+
+#define EVT_SPLITTER_UNSPLIT(id, fn) \
+    wx__DECLARE_SPLITTEREVT(UNSPLIT, id, fn)
+
+
+// old wxEVT_COMMAND_* constants
+#define wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED    wxEVT_SPLITTER_SASH_POS_CHANGED
+#define wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING   wxEVT_SPLITTER_SASH_POS_CHANGING
+#define wxEVT_COMMAND_SPLITTER_DOUBLECLICKED       wxEVT_SPLITTER_DOUBLECLICKED
+#define wxEVT_COMMAND_SPLITTER_UNSPLIT             wxEVT_SPLITTER_UNSPLIT
+
+#endif // _WX_GENERIC_SPLITTER_H_