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 wxWidgets 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 = wxID_ANY,
  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 = wxID_ANY,
  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     // Make sure the child window sizes are updated. This is useful
 133     // for reducing flicker by updating the sizes before a
 134     // window is shown, if you know the overall size is correct.
 135     void UpdateSize();
 136
 137     // Is the window split?
 138     bool IsSplit() const { return (m_windowTwo != NULL); }
 139
 140     // Sets the sash size
 141     void SetSashSize(int WXUNUSED(width)) { }
 142
 143     // Sets the border size
 144     void SetBorderSize(int WXUNUSED(width)) { }
 145
 146     // Gets the sash size
 147     int GetSashSize() const;
 148
 149     // Gets the border size
 150     int GetBorderSize() const;
 151
 152     // Set the sash position
 153     void SetSashPosition(int position, bool redraw = true);
 154
 155     // Gets the sash position
 156     int GetSashPosition() const { return m_sashPosition; }
 157
 158     // Set the sash gravity
 159     void SetSashGravity(double gravity);
 160
 161     // Gets the sash gravity
 162     double GetSashGravity() const { return m_sashGravity; }
 163
 164     // If this is zero, we can remove panes by dragging the sash.
 165     void SetMinimumPaneSize(int min);
 166     int GetMinimumPaneSize() const { return m_minimumPaneSize; }
 167
 168     // NB: the OnXXX() functions below are for backwards compatibility only,
 169     //     don't use them in new code but handle the events instead!
 170
 171     // called when the sash position is about to change, may return a new value
 172     // for the sash or -1 to prevent the change from happening at all
 173     virtual int OnSashPositionChanging(int newSashPosition);
 174
 175     // Called when the sash position is about to be changed, return
 176     // false from here to prevent the change from taking place.
 177     // Repositions sash to minimum position if pane would be too small.
 178     // newSashPosition here is always positive or zero.
 179     virtual bool OnSashPositionChange(int newSashPosition);
 180
 181     // If the sash is moved to an extreme position, a subwindow
 182     // is removed from the splitter window, and the app is
 183     // notified. The app should delete or hide the window.
 184     virtual void OnUnsplit(wxWindow *removed);
 185
 186     // Called when the sash is double-clicked.
 187     // The default behaviour is to remove the sash if the
 188     // minimum pane size is zero.
 189     virtual void OnDoubleClickSash(int x, int y);
 190
 191 ////////////////////////////////////////////////////////////////////////////
 192 // Implementation
 193
 194     // Paints the border and sash
 195     void OnPaint(wxPaintEvent& event);
 196
 197     // Handles mouse events
 198     void OnMouseEvent(wxMouseEvent& ev);
 199
 200     // Adjusts the panes
 201     void OnSize(wxSizeEvent& event);
 202
 203     // In live mode, resize child windows in idle time
 204     void OnInternalIdle();
 205
 206     // Draws the sash
 207     virtual void DrawSash(wxDC& dc);
 208
 209     // Draws the sash tracker (for whilst moving the sash)
 210     virtual void DrawSashTracker(int x, int y);
 211
 212     // Tests for x, y over sash
 213     virtual bool SashHitTest(int x, int y, int tolerance = 5);
 214
 215     // Resizes subwindows
 216     virtual void SizeWindows();
 217
 218     void SetNeedUpdating(bool needUpdating) { m_needUpdating = needUpdating; }
 219     bool GetNeedUpdating() const { return m_needUpdating ; }
 220
 221 #ifdef __WXMAC__
 222     virtual bool MacClipGrandChildren() const { return true ; }
 223 #endif
 224
 225 protected:
 226     // event handlers
 227 #if defined(__WXMSW__) || defined(__WXMAC__)
 228     void OnSetCursor(wxSetCursorEvent& event);
 229 #endif // wxMSW
 230
 231     // send the given event, return false if the event was processed and vetoed
 232     // by the user code
 233     inline bool DoSendEvent(wxSplitterEvent& event);
 234
 235     // common part of all ctors
 236     void Init();
 237
 238     // common part of SplitVertically() and SplitHorizontally()
 239     bool DoSplit(wxSplitMode mode,
 240                  wxWindow *window1, wxWindow *window2,
 241                  int sashPosition);
 242
 243     // adjusts sash position with respect to min. pane and window sizes
 244     int AdjustSashPosition(int sashPos) const;
 245
 246     // get either width or height depending on the split mode
 247     int GetWindowSize() const;
 248
 249     // convert the user specified sash position which may be > 0 (as is), < 0
 250     // (specifying the size of the right pane) or 0 (use default) to the real
 251     // position to be passed to DoSetSashPosition()
 252     int ConvertSashPosition(int sashPos) const;
 253
 254     // set the real sash position, sashPos here must be positive
 255     //
 256     // returns true if the sash position has been changed, false otherwise
 257     bool DoSetSashPosition(int sashPos);
 258
 259     // set the sash position and send an event about it having been changed
 260     void SetSashPositionAndNotify(int sashPos);
 261
 262     // callbacks executed when we detect that the mouse has entered or left
 263     // the sash
 264     virtual void OnEnterSash();
 265     virtual void OnLeaveSash();
 266
 267     // set the cursor appropriate for the current split mode
 268     void SetResizeCursor();
 269
 270     // redraw the splitter if its "hotness" changed if necessary
 271     void RedrawIfHotSensitive(bool isHot);
 272
 273     // return the best size of the splitter equal to best sizes of its
 274     // subwindows
 275     virtual wxSize DoGetBestSize() const;
 276
 277
 278     wxSplitMode m_splitMode;
 279     wxWindow*   m_windowOne;
 280     wxWindow*   m_windowTwo;
 281     int         m_dragMode;
 282     int         m_oldX;
 283     int         m_oldY;
 284     int         m_sashPosition; // Number of pixels from left or top
 285     double      m_sashGravity;
 286     wxSize      m_lastSize;
 287     int         m_requestedSashPosition;
 288     int         m_sashPositionCurrent; // while dragging
 289     int         m_firstX;
 290     int         m_firstY;
 291     int         m_minimumPaneSize;
 292     wxCursor    m_sashCursorWE;
 293     wxCursor    m_sashCursorNS;
 294     wxPen      *m_sashTrackerPen;
 295
 296     // when in live mode, set this to true to resize children in idle
 297     bool        m_needUpdating:1;
 298     bool        m_permitUnsplitAlways:1;
 299     bool        m_isHot:1;
 300     bool        m_checkRequestedSashPosition:1;
 301
 302 private:
 303     WX_DECLARE_CONTROL_CONTAINER();
 304
 305     DECLARE_DYNAMIC_CLASS(wxSplitterWindow)
 306     DECLARE_EVENT_TABLE()
 307     DECLARE_NO_COPY_CLASS(wxSplitterWindow)
 308 };
 309
 310 // ----------------------------------------------------------------------------
 311 // event class and macros
 312 // ----------------------------------------------------------------------------
 313
 314 // we reuse the same class for all splitter event types because this is the
 315 // usual wxWin convention, but the three event types have different kind of
 316 // data associated with them, so the accessors can be only used if the real
 317 // event type matches with the one for which the accessors make sense
 318 class WXDLLEXPORT wxSplitterEvent : public wxNotifyEvent
 319 {
 320 public:
 321     wxSplitterEvent(wxEventType type = wxEVT_NULL,
 322                     wxSplitterWindow *splitter = (wxSplitterWindow *)NULL)
 323         : wxNotifyEvent(type)
 324     {
 325         SetEventObject(splitter);
 326         if (splitter) m_id = splitter->GetId();
 327     }
 328
 329     // SASH_POS_CHANGED methods
 330
 331     // setting the sash position to -1 prevents the change from taking place at
 332     // all
 333     void SetSashPosition(int pos)
 334     {
 335         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
 336                 || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
 337
 338         m_data.pos = pos;
 339     }
 340
 341     int GetSashPosition() const
 342     {
 343         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED
 344                 || GetEventType() == wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING);
 345
 346         return m_data.pos;
 347     }
 348
 349     // UNSPLIT event methods
 350     wxWindow *GetWindowBeingRemoved() const
 351     {
 352         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_UNSPLIT );
 353
 354         return m_data.win;
 355     }
 356
 357     // DCLICK event methods
 358     int GetX() const
 359     {
 360         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
 361
 362         return m_data.pt.x;
 363     }
 364
 365     int GetY() const
 366     {
 367         wxASSERT( GetEventType() == wxEVT_COMMAND_SPLITTER_DOUBLECLICKED );
 368
 369         return m_data.pt.y;
 370     }
 371
 372 private:
 373     friend class WXDLLEXPORT wxSplitterWindow;
 374
 375     // data for the different types of event
 376     union
 377     {
 378         int pos;            // position for SASH_POS_CHANGED event
 379         wxWindow *win;      // window being removed for UNSPLIT event
 380         struct
 381         {
 382             int x, y;
 383         } pt;               // position of double click for DCLICK event
 384     } m_data;
 385
 386     DECLARE_DYNAMIC_CLASS_NO_COPY(wxSplitterEvent)
 387 };
 388
 389 typedef void (wxEvtHandler::*wxSplitterEventFunction)(wxSplitterEvent&);
 390
 391 #define EVT_SPLITTER_SASH_POS_CHANGED(id, fn)                               \
 392   DECLARE_EVENT_TABLE_ENTRY(                                                \
 393     wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGED,                                \
 394     id,                                                                     \
 395     wxID_ANY,                                                               \
 396     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \
 397     NULL                                                                    \
 398   ),
 399
 400 #define EVT_SPLITTER_SASH_POS_CHANGING(id, fn)                              \
 401   DECLARE_EVENT_TABLE_ENTRY(                                                \
 402     wxEVT_COMMAND_SPLITTER_SASH_POS_CHANGING,                               \
 403     id,                                                                     \
 404     wxID_ANY,                                                               \
 405     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \
 406     NULL                                                                    \
 407   ),
 408
 409 #define EVT_SPLITTER_DCLICK(id, fn)                                         \
 410   DECLARE_EVENT_TABLE_ENTRY(                                                \
 411     wxEVT_COMMAND_SPLITTER_DOUBLECLICKED,                                   \
 412     id,                                                                     \
 413     wxID_ANY,                                                               \
 414     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \
 415     NULL                                                                    \
 416   ),
 417
 418 #define EVT_SPLITTER_UNSPLIT(id, fn)                                        \
 419   DECLARE_EVENT_TABLE_ENTRY(                                                \
 420     wxEVT_COMMAND_SPLITTER_UNSPLIT,                                         \
 421     id,                                                                     \
 422     wxID_ANY,                                                               \
 423     (wxObjectEventFunction)(wxEventFunction) wxStaticCastEvent( wxSplitterEventFunction, &fn ),  \
 424     NULL                                                                    \
 425   ),
 426
 427 #endif // __SPLITTERH_G__