contrib/docs/latex/fl/cbbardragplugin.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % bardragpl.h at 05/Jan/02 22:50:56
   4 %
   5
   6
   7 \section{\class{cbBarDragPlugin}}\label{cbbardragplugin}
   8
   9 \wxheading{Derived from}
  10
  11 \helpref{cbPluginBase}{cbpluginbase}
  12
  13 \wxheading{Data structures}
  14
  15 \latexignore{\rtfignore{\wxheading{Members}}}
  16
  17
  18 \membersection{cbBarDragPlugin::cbBarDragPlugin}\label{cbbardragplugincbbardragplugin}
  19
  20 \func{}{cbBarDragPlugin}{\void}
  21
  22
  23 \func{}{cbBarDragPlugin}{\param{wxFrameLayout* }{pPanel}, \param{int }{paneMask = wxALL\_PANES}}
  24
  25
  26 \membersection{cbBarDragPlugin::\destruct{cbBarDragPlugin}}\label{cbbardragplugindtor}
  27
  28 \func{}{\destruct{cbBarDragPlugin}}{\void}
  29
  30
  31 \membersection{cbBarDragPlugin::AdjustHintRect}\label{cbbardragpluginadjusthintrect}
  32
  33 \func{void}{AdjustHintRect}{\param{wxPoint\& }{mousePos}}
  34
  35 the thicker rectangle is drawn using hatched brush,
  36 the default border width for this rectangle is 8 pix.
  37
  38
  39 \membersection{cbBarDragPlugin::CalcOnScreenDims}\label{cbbardragplugincalconscreendims}
  40
  41 \func{void}{CalcOnScreenDims}{\param{wxRect\& }{rect}}
  42
  43
  44 \membersection{cbBarDragPlugin::ClipPosInFrame}\label{cbbardragpluginclipposinframe}
  45
  46 \func{void}{ClipPosInFrame}{\param{wxPoint\& }{pos}}
  47
  48
  49 \membersection{cbBarDragPlugin::ClipRectInFrame}\label{cbbardragplugincliprectinframe}
  50
  51 \func{void}{ClipRectInFrame}{\param{wxRect\& }{rect}}
  52
  53
  54 \membersection{cbBarDragPlugin::DoDrawHintRect}\label{cbbardragplugindodrawhintrect}
  55
  56 \func{void}{DoDrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
  57
  58
  59 \membersection{cbBarDragPlugin::DrawHintRect}\label{cbbardragplugindrawhintrect}
  60
  61 \func{void}{DrawHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
  62
  63
  64 \membersection{cbBarDragPlugin::EraseHintRect}\label{cbbardragpluginerasehintrect}
  65
  66 \func{void}{EraseHintRect}{\param{wxRect\& }{rect}, \param{bool }{isInClientRect}}
  67
  68
  69 \membersection{cbBarDragPlugin::FinishTracking}\label{cbbardragpluginfinishtracking}
  70
  71 \func{void}{FinishTracking}{\void}
  72
  73
  74 \membersection{cbBarDragPlugin::GetBarHeightInPane}\label{cbbardragplugingetbarheightinpane}
  75
  76 \func{int}{GetBarHeightInPane}{\param{cbDockPane* }{pPane}}
  77
  78
  79 \membersection{cbBarDragPlugin::GetBarWidthInPane}\label{cbbardragplugingetbarwidthinpane}
  80
  81 \func{int}{GetBarWidthInPane}{\param{cbDockPane* }{pPane}}
  82
  83
  84 \membersection{cbBarDragPlugin::GetDistanceToPane}\label{cbbardragplugingetdistancetopane}
  85
  86 \func{int}{GetDistanceToPane}{\param{cbDockPane* }{pPane}, \param{wxPoint\& }{mousePos}}
  87
  88
  89 \membersection{cbBarDragPlugin::HitTestPanes}\label{cbbardragpluginhittestpanes}
  90
  91 \func{cbDockPane*}{HitTestPanes}{\param{wxRect\& }{rect}}
  92
  93
  94 \func{cbDockPane*}{HitTestPanes}{\param{wxPoint\& }{pos}}
  95
  96
  97 \membersection{cbBarDragPlugin::HitsPane}\label{cbbardragpluginhitspane}
  98
  99 \func{bool}{HitsPane}{\param{cbDockPane* }{pPane}, \param{wxRect\& }{rect}}
 100
 101
 102 \membersection{cbBarDragPlugin::IsInClientArea}\label{cbbardragpluginisinclientarea}
 103
 104 \func{bool}{IsInClientArea}{\param{wxPoint\& }{mousePos}}
 105
 106
 107 \func{bool}{IsInClientArea}{\param{wxRect\& }{rect}}
 108
 109
 110 \membersection{cbBarDragPlugin::IsInOtherPane}\label{cbbardragpluginisinotherpane}
 111
 112 \func{bool}{IsInOtherPane}{\param{wxPoint\& }{mousePos}}
 113
 114
 115 \membersection{cbBarDragPlugin::OnDrawHintRect}\label{cbbardragpluginondrawhintrect}
 116
 117 \func{void}{OnDrawHintRect}{\param{cbDrawHintRectEvent\& }{event}}
 118
 119 handles event, which oriniates from itself
 120
 121
 122 \membersection{cbBarDragPlugin::OnLButtonDown}\label{cbbardragpluginonlbuttondown}
 123
 124 \func{void}{OnLButtonDown}{\param{cbLeftDownEvent\& }{event}}
 125
 126
 127 \membersection{cbBarDragPlugin::OnLButtonUp}\label{cbbardragpluginonlbuttonup}
 128
 129 \func{void}{OnLButtonUp}{\param{cbLeftUpEvent\& }{event}}
 130
 131
 132 \membersection{cbBarDragPlugin::OnLDblClick}\label{cbbardragpluginonldblclick}
 133
 134 \func{void}{OnLDblClick}{\param{cbLeftDClickEvent\& }{event}}
 135
 136
 137 \membersection{cbBarDragPlugin::OnMouseMove}\label{cbbardragpluginonmousemove}
 138
 139 \func{void}{OnMouseMove}{\param{cbMotionEvent\& }{event}}
 140
 141 handlers for plugin events
 142
 143
 144 \membersection{cbBarDragPlugin::OnStartBarDragging}\label{cbbardragpluginonstartbardragging}
 145
 146 \func{void}{OnStartBarDragging}{\param{cbStartBarDraggingEvent\& }{event}}
 147
 148
 149 \membersection{cbBarDragPlugin::RectToScr}\label{cbbardragpluginrecttoscr}
 150
 151 \func{void}{RectToScr}{\param{wxRect\& }{frameRect}, \param{wxRect\& }{scrRect}}
 152
 153
 154 \membersection{cbBarDragPlugin::ShowHint}\label{cbbardragpluginshowhint}
 155
 156 \func{void}{ShowHint}{\param{bool }{prevWasInClient}}
 157
 158
 159 \membersection{cbBarDragPlugin::StartTracking}\label{cbbardragpluginstarttracking}
 160
 161 \func{void}{StartTracking}{\void}
 162
 163 on-screen hint-tracking related methods
 164
 165
 166 \membersection{cbBarDragPlugin::StickToPane}\label{cbbardragpluginsticktopane}
 167
 168 \func{void}{StickToPane}{\param{cbDockPane* }{pPane}, \param{wxPoint\& }{mousePos}}
 169
 170
 171 \membersection{cbBarDragPlugin::UnstickFromPane}\label{cbbardragpluginunstickfrompane}
 172
 173 \func{void}{UnstickFromPane}{\param{cbDockPane* }{pPane}, \param{wxPoint\& }{mousePos}}
 174