include/wx/generic/splitter.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        wx/splitter.h
   3 // Purpose:     wxSplitterWindow class
   4 // Author:      Julian Smart
   5 // Modified by:
   6 // Created:     01/02/97
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Julian Smart
   9 // Licence:     wxWindows licence
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef __SPLITTERH_G__
  13 #define __SPLITTERH_G__
  14
  15 #if defined(__GNUG__) && !defined(NO_GCC_PRAGMA)
  16     #pragma interface "splitter.h"
  17 #endif
  18
  19 #include "wx/window.h"                      // base class declaration
  20 #include "wx/containr.h"                    // wxControlContainer
  21
  22 class WXDLLEXPORT wxSplitterEvent;
  23
  24 // ---------------------------------------------------------------------------
  25 // splitter constants
  26 // ---------------------------------------------------------------------------
  27
  28 enum wxSplitMode
  29 {
  30     wxSPLIT_HORIZONTAL = 1,
  31     wxSPLIT_VERTICAL
  32 };
  33
  34 enum
  35 {
  36     wxSPLIT_DRAG_NONE,
  37     wxSPLIT_DRAG_DRAGGING,
  38     wxSPLIT_DRAG_LEFT_DOWN
  39 };
  40
  41 // ---------------------------------------------------------------------------
  42 // wxSplitterWindow maintains one or two panes, with
  43 // an optional vertical or horizontal split which
  44 // can be used with the mouse or programmatically.
  45 // ---------------------------------------------------------------------------
  46
  47 // TODO:
  48 // 1) Perhaps make the borders sensitive to dragging in order to create a split.
  49 //    The MFC splitter window manages scrollbars as well so is able to
  50 //    put sash buttons on the scrollbars, but we probably don't want to go down
  51 //    this path.
  52 // 2) for wxWindows 2.0, we must find a way to set the WS_CLIPCHILDREN style
  53 //    to prevent flickering. (WS_CLIPCHILDREN doesn't work in all cases so can't be
  54 //    standard).
  55
  56 class WXDLLEXPORT wxSplitterWindow: public wxWindow
  57 {
  58 public:
  59
  60 ////////////////////////////////////////////////////////////////////////////
  61 // Public API
  62
  63     // Default constructor
  64     wxSplitterWindow()
  65     {
  66         Init();
  67     }
  68
  69     // Normal constructor
  70     wxSplitterWindow(wxWindow *parent, wxWindowID id = -1,
  71                      const wxPoint& pos = wxDefaultPosition,
  72                      const wxSize& size = wxDefaultSize,
  73                      long style = wxSP_3D,
  74                      const wxString& name = wxT("splitter"))
  75     {
  76         Init();
  77         Create(parent, id, pos, size, style, name);
  78     }
  79
  80     virtual ~wxSplitterWindow();
  81
  82     bool Create(wxWindow *parent, wxWindowID id = -1,
  83                      const wxPoint& pos = wxDefaultPosition,
  84                      const wxSize& size = wxDefaultSize,
  85                      long style = wxSP_3D,
  86                      const wxString& name = wxT("splitter"));
  87
  88     // Gets the only or left/top pane
  89     wxWindow *GetWindow1() const { return m_windowOne; }
  90
  91     // Gets the right/bottom pane
  92     wxWindow *GetWindow2() const { return m_windowTwo; }
  93
  94     // Sets the split mode
  95     void SetSplitMode(int mode)
  96     {
  97         wxASSERT_MSG( mode == wxSPLIT_VERTICAL || mode == wxSPLIT_HORIZONTAL,
  98                       _T("invalid split mode") );
  99
 100         m_splitMode = (wxSplitMode)mode;
 101     }
 102
 103     // Gets the split mode
 104     wxSplitMode GetSplitMode() const { return m_splitMode; };
 105
 106     // Initialize with one window
 107     void Initialize(wxWindow *window);
 108
 109     // Associates the given window with window 2, drawing the appropriate sash
 110     // and changing the split mode.
 111     // Does nothing and returns false if the window is already split.
 112     // A sashPosition of 0 means choose a default sash position,
 113     // negative sashPosition specifies the size of right/lower pane as it's
 114     // absolute value rather than the size of left/upper pane.
 115     virtual bool SplitVertically(wxWindow *window1,
 116                                  wxWindow *window2,
 117                                  int sashPosition = 0)
 118         { return DoSplit(wxSPLIT_VERTICAL, window1, window2, sashPosition); }
 119     virtual bool SplitHorizontally(wxWindow *window1,
 120                                    wxWindow *window2,
 121                                    int sashPosition = 0)
 122         { return DoSplit(wxSPLIT_HORIZONTAL, window1, window2, sashPosition); }
 123
 124     // Removes the specified (or second) window from the view
 125     // Doesn't actually delete the window.
 126     bool Unsplit(wxWindow *toRemove = (wxWindow *) NULL);
 127
 128     // Replaces one of the windows with another one (neither old nor new
 129     // parameter should be NULL)
 130     bool ReplaceWindow(wxWindow *winOld, wxWindow *winNew);
 131
 132     // Is the window split?
 133     bool IsSplit() const { return (m_windowTwo != NULL); }
 134
 135     // Sets the sash size
 136     void SetSashSize(int WXUNUSED(width)) { }
 137
 138     // Sets the border size
 139     void SetBorderSize(int WXUNUSED(width)) { }
 140
 141     // Gets the sash size
 142     int GetSashSize() const;
 143
 144     // Gets the border size
 145     int GetBorderSize() const;
 146
 147     // Set the sash position
 148     void SetSashPosition(int position, bool redraw = true);
 149
 150     // Gets the sash position
 151     int GetSashPosition() const { return m_sashPosition; }
 152
 153     // If this is zero, we can remove panes by dragging the sash.
 154     void SetMinimumPaneSize(int min);
 155     int GetMinimumPaneSize() const { return m_minimumPaneSize; }
 156
 157     // NB: the OnXXX() functions below are for backwards compatibility only,
 158     //     don't use them in new code but handle the events instead!
 159
 160     // called when the sash position is about to change, may return a new value
 161     // for the sash or -1 to prevent the change from happening at all
 162     virtual int OnSashPositionChanging(int newSashPosition);
 163
 164     // Called when the sash position is about to be changed, return
 165     // false from here to prevent the change from taking place.
 166     // Repositions sash to minimum position if pane would be too small.
 167     // newSashPosition here is always positive or zero.
 168     virtual bool OnSashPositionChange(int newSashPosition);
 169
 170     // If the sash is moved to an extreme position, a subwindow
 171     // is removed from the splitter window, and the app is
 172     // notified. The app should delete or hide the window.
 173     virtual void OnUnsplit(wxWindow *removed);
 174
 175     // Called when the sash is double-clicked.
 176     // The default behaviour is to remove the sash if the
 177     // minimum pane size is zero.
 178     virtual void OnDoubleClickSash(int x, int y);
 179
 180 ////////////////////////////////////////////////////////////////////////////
 181 // Implementation
 182
 183     // Paints the border and sash
 184     void OnPaint(wxPaintEvent& event);
 185
 186     // Handles mouse events
 187     void OnMouseEvent(wxMouseEvent& ev);
 188
 189     // Adjusts the panes
 190     void OnSize(wxSizeEvent& event);
 191
 192     // In live mode, resize child windows in idle time
 193     void OnInternalIdle();
 194
 195     // Draws the sash
 196     virtual void DrawSash(wxDC& dc);
 197
 198     // Draws the sash tracker (for whilst moving the sash)
 199     virtual void DrawSashTracker(int x, int y);
 200
 201     // Tests for x, y over sash
 202     virtual bool SashHitTest(int x, int y, int tolerance = 5);
 203
 204     // Resizes subwindows
 205     virtual void SizeWindows();
 206
 207     void SetNeedUpdating(bool needUpdating) { m_needUpdating = needUpdating; }
 208     bool GetNeedUpdating() const { return m_needUpdating ; }
 209
 210 protected:
 211     // event handlers
 212 #if defined(__WXMSW__) || defined(__WXMAC__)
 213     void OnSetCursor(wxSetCursorEvent& event);
 214 #endif // wxMSW
 215
 216     // send the given event, return false if the event was processed and vetoed
 217     // by the user code
 218     inline bool DoSendEvent(wxSplitterEvent& event);
 219
 220 protected:
 221     // common part of all ctors
 222     void Init();
 223
 224     // common part of SplitVertically() and SplitHorizontally()
 225     bool DoSplit(wxSplitMode mode,
 226                  wxWindow *window1, wxWindow *window2,
 227                  int sashPosition);
 228
 229     // adjusts sash position with respect to min. pane and window sizes
 230     int AdjustSashPosition(int sashPos) const;
 231
 232     // get either width or height depending on the split mode
 233     int GetWindowSize() const;
 234
 235     // convert the user specified sash position which may be > 0 (as is), < 0
 236     // (specifying the size of the right pane) or 0 (use default) to the real
 237     // position to be passed to DoSetSashPosition()
 238     int ConvertSashPosition(int sashPos) const;
 239
 240     // set the real sash position, sashPos here must be positive
 241     //
 242     // returns true if the sash position has been changed, false otherwise
 243     bool DoSetSashPosition(int sashPos);
 244
 245     // set the sash position and send an event about it having been changed
 246     void SetSashPositionAndNotify(int sashPos);
 247
 248     // callbacks executed when we detect that the mouse has entered or left
 249     // the sash
 250     virtual void OnEnterSash();
 251     virtual void OnLeaveSash();
 252
 253     // set the cursor appropriate for the current split mode
 254     void SetResizeCursor();
 255
 256     // redraw the splitter if its "hotness" changed if necessary
 257     void RedrawIfHotSensitive(bool isHot);
 258
 259     wxSplitMode m_splitMode;
 260     wxWindow*   m_windowOne;
 261     wxWindow*   m_windowTwo;
 262     int         m_dragMode;
 263     int         m_oldX;
 264     int         m_oldY;
 265     int         m_sashPosition; // Number of pixels from left or top
 266     int         m_requestedSashPosition;
 267     int         m_sashPositionCurrent; // while dragging
 268     int         m_firstX;
 269     int         m_firstY;
 270     int         m_minimumPaneSize;
 271     wxCursor    m_sashCursorWE;
 272     wxCursor    m_sashCursorNS;
 273     wxPen      *m_sashTrackerPen;
 274
 275     // when in live mode, set this to true to resize children in idle
 276     bool        m_needUpdating:1;
 277     bool        m_permitUnsplitAlways:1;
 278     bool        m_isHot:1;
 279     bool        m_checkRequestedSashPosition:1;
 280
 281 private:
 282     WX_DECLARE_CONTROL_CONTAINER();
 283
 284     DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
 285     DECLARE_EVENT_TABLE()
 286     DECLARE_NO_COPY_CLASS(wxSplitterWindow)
 287 };
 288
 289 // ----------------------------------------------------------------------------
 290 // event class and macros
 291 // ----------------------------------------------------------------------------
 292
 293 // we reuse the same class for all splitter event types because this is the
 294 // usual wxWin convention, but the three event types have different kind of
 295 // data associated with them, so the accessors can be only used if the real
 296 // event type matches with the one for which the accessors make sense
 297 class WXDLLEXPORT wxSplitterEvent : public wxNotifyEvent
 298 {
 299 public:
 300     wxSplitterEvent(wxEventType type = wxEVT_NULL,
 301                     wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)
 302         : wxNotifyEvent(type)
 303     {
 304         SetEventObject(splitter);
 305         if (splitter) m_id = splitter->GetId();
 306     }
 307
 308     // SASH_POS_CHANGED methods
 309
 310     // setting the sash position to -1 prevents the change from taking place at
 311     // all
 312     void SetSashPosition(int pos)
 313     {
 314         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
 315                 || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
 316
 317         m_data.pos = pos;
 318     }
 319
 320     int GetSashPosition() const
 321     {
 322         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
 323                 || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
 324
 325         return m_data.pos;
 326     }
 327
 328     // UNSPLIT event methods
 329     wxWindow *GetWindowBeingRemoved() const
 330     {
 331         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_UNSPLIT );
 332
 333         return m_data.win;
 334     }
 335
 336     // DCLICK event methods
 337     int GetX() const
 338     {
 339         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
 340
 341         return m_data.pt.x;
 342     }
 343
 344     int GetY() const
 345     {
 346         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
 347
 348         return m_data.pt.y;
 349     }
 350
 351 private:
 352     friend class WXDLLEXPORT wxSplitterWindow;
 353
 354     // data for the different types of event
 355     union
 356     {
 357         int pos;            // position for SASH_POS_CHANGED event
 358         wxWindow *win;      // window being removed for UNSPLIT event
 359         struct
 360         {
 361             int x, y;
 362         } pt;               // position of double click for DCLICK event
 363     } m_data;
 364
 365     DECLARE_DYNAMIC_CLASS_NO_COPY(wxSplitterEvent)
 366 };
 367
 368 typedef void (wxEvtHandler::*wxSplitterEventFunction)(wxSplitterEvent&);
 369
 370 #define EVT_SPLITTER_SASH_POS_CHANGED(id, fn)                               \
 371   DECLARE_EVENT_TABLE_ENTRY(                                                \
 372     wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED,                                \
 373     id,                                                                     \
 374     -1,                                                                     \
 375     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \
 376     NULL                                                                    \
 377   ),
 378
 379 #define EVT_SPLITTER_SASH_POS_CHANGING(id, fn)                              \
 380   DECLARE_EVENT_TABLE_ENTRY(                                                \
 381     wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING,                               \
 382     id,                                                                     \
 383     -1,                                                                     \
 384     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \
 385     NULL                                                                    \
 386   ),
 387
 388 #define EVT_SPLITTER_DCLICK(id, fn)                                         \
 389   DECLARE_EVENT_TABLE_ENTRY(                                                \
 390     wxEVT_COMMAND_SPLITTER_DOUBLECLICKED,                                   \
 391     id,                                                                     \
 392     -1,                                                                     \
 393     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \
 394     NULL                                                                    \
 395   ),
 396
 397 #define EVT_SPLITTER_UNSPLIT(id, fn)                                        \
 398   DECLARE_EVENT_TABLE_ENTRY(                                                \
 399     wxEVT_COMMAND_SPLITTER_UNSPLIT,                                         \
 400     id,                                                                     \
 401     -1,                                                                     \
 402     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \
 403     NULL                                                                    \
 404   ),
 405
 406 #endif // __SPLITTERH_G__