contrib/include/wx/fl/bardragpl.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        bardragpl.h
   3 // Purpose:     cbBarDragPlugin class
   4 // Author:      Aleksandras Gluchovas
   5 // Modified by:
   6 // Created:     23/09/98
   7 // RCS-ID:      $Id$
   8 // Copyright:   (c) Aleksandras Gluchovas
   9 // Licence:     wxWindows license
  10 /////////////////////////////////////////////////////////////////////////////
  11
  12 #ifndef __BARDRAGPL_G__
  13 #define __BARDRAGPL_G__
  14
  15 #ifdef __GNUG__
  16     #pragma interface "bardragpl.h"
  17 #endif
  18
  19 #include "wx/fl/controlbar.h"
  20 #include "wx/fl/toolwnd.h"
  21
  22 class cbBarDragPlugin : public cbPluginBase
  23 {
  24         DECLARE_DYNAMIC_CLASS( cbBarDragPlugin )
  25 protected:
  26
  27         // plugin is active only in bar-dragging state
  28         bool           mBarDragStarted;
  29         bool           mCanStick;          // flag used to prevent "bouncing" of hint-rectangle
  30         wxScreenDC*    mpScrDc;            // created while tracking hint-rect
  31         wxCursor*      mpCurCursor;
  32
  33         // rectangle shows the position/dimensions of the bar,
  34         // if it would be docked now
  35
  36         wxRect         mPrevHintRect;
  37         wxRect         mHintRect;
  38
  39
  40         int            mMouseInRectX;
  41         int            mMouseInRectY;
  42
  43         cbDockPane*    mpSrcPane;          // pane, from which the bar was originally taken
  44         int            mBarWidthInSrcPane;
  45
  46         cbDockPane*    mpCurPane;
  47
  48         cbBarInfo*     mpDraggedBar;       // bar, which is being dragged
  49         bool           mBarWasFloating;
  50         wxRect         mFloatedBarBounds;
  51
  52 public: /*** public properties ***/
  53
  54         int            mInClientHintBorder; // when hint-rect moves within client window area,
  55                                         // the thicker rectangle is drawn using hatched brush,
  56                                                                                 // the default border width for this rectangle is 8 pix.
  57
  58 protected:
  59
  60     // Internal implementation function.
  61         void AdjustHintRect( wxPoint& mousePos );
  62
  63     // Internal implementation function.
  64         void ClipRectInFrame( wxRect& rect );
  65
  66     // Internal implementation function.
  67         void ClipPosInFrame( wxPoint& pos );
  68
  69     // Internal implementation function. Finds the pane
  70     // under the specified rectangle.
  71         cbDockPane* HitTestPanes( wxRect& rect );
  72
  73     // Internal implementation function. Finds the pane
  74     // under the specified point.
  75         cbDockPane* HitTestPanes( wxPoint& pos );
  76
  77     // Internal implementation function.
  78         bool HitsPane( cbDockPane* pPane, wxRect& rect );
  79
  80     // Internal implementation function.
  81         void CalcOnScreenDims( wxRect& rect );
  82
  83     // Internal implementation function.
  84         int  GetDistanceToPane( cbDockPane* pPane, wxPoint& mousePos );
  85
  86     // Internal implementation function.
  87         bool IsInOtherPane ( wxPoint& mousePos );
  88
  89     // Internal implementation function.
  90         bool IsInClientArea( wxPoint& mousePos );
  91
  92     // Internal implementation function.
  93         bool IsInClientArea( wxRect& rect );
  94
  95     // Internal implementation function.
  96         void StickToPane( cbDockPane* pPane, wxPoint& mousePos );
  97
  98     // Internal implementation function.
  99         void UnstickFromPane( cbDockPane* pPane, wxPoint& mousePos );
 100
 101     // Internal implementation function.
 102         int GetBarWidthInPane( cbDockPane* pPane );
 103
 104     // Internal implementation function.
 105         int GetBarHeightInPane( cbDockPane* pPane );
 106
 107         // on-screen hint-tracking related methods
 108
 109     // Internal implementation function.
 110     // Start showing a visual hint while dragging.
 111         void StartTracking();
 112
 113     // Internal implementation function.
 114     // Draw the visual hint while dragging.
 115         void DrawHintRect ( wxRect& rect, bool isInClientRect);
 116     // Internal implementation function.
 117     // Erase the visual hint while dragging.
 118         void EraseHintRect( wxRect& rect, bool isInClientRect);
 119
 120     // Internal implementation function.
 121     // Stop showing the visual hint while dragging.
 122         void FinishTracking();
 123
 124     // Internal implementation function.
 125     // Draw the hint rectangle.
 126         void DoDrawHintRect( wxRect& rect, bool isInClientRect);
 127
 128     // Internal implementation function.
 129     // Converts the given rectangle from window to screen coordinates.
 130         void RectToScr( wxRect& frameRect, wxRect& scrRect );
 131
 132     // Internal implementation function.
 133     // Show the hint; called within OnMouseMove.
 134         void ShowHint( bool prevWasInClient );
 135
 136 public:
 137     // Default constructor.
 138         cbBarDragPlugin(void);
 139
 140     // Constructor taking a parent frame, and flag. See cbPluginBase.
 141         cbBarDragPlugin( wxFrameLayout* pPanel, int paneMask = wxALL_PANES );
 142
 143     // Destructor.
 144         virtual ~cbBarDragPlugin();
 145
 146         // Handler for plugin event.
 147         void OnMouseMove( cbMotionEvent& event );
 148
 149         // Handler for plugin event.
 150         void OnLButtonUp( cbLeftUpEvent& event );
 151
 152         // Handler for plugin event.
 153         void OnLButtonDown( cbLeftDownEvent& event );
 154
 155         // Handler for plugin event.
 156         void OnLDblClick( cbLeftDClickEvent& event );
 157
 158         // Handles event, which originates from itself.
 159         void OnDrawHintRect( cbDrawHintRectEvent& event );
 160
 161         // Handler for plugin event.
 162         void OnStartBarDragging( cbStartBarDraggingEvent& event );
 163
 164         DECLARE_EVENT_TABLE()
 165 };
 166
 167 #endif /* __BARDRAGPL_G__ */
 168