contrib/docs/latex/fl/cbrowdragplugin.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % rowdragpl.h at 05/Jan/02 22:50:57
   4 %
   5
   6
   7 \section{\class{cbRowDragPlugin}}\label{cbrowdragplugin}
   8
   9
  10 Plugin adds row-dragging fuctionality to the pane.
  11    Handles mouse/movement and pane-background erasing plugin-events.
  12    Behaviour and appearence resembles drag \& drop posotioning
  13    of the toolbar-rows int Netscape Comunicator 4.xx.
  14
  15 \wxheading{Derived from}
  16
  17 \helpref{cbPluginBase}{cbpluginbase}
  18
  19 \wxheading{Data structures}
  20
  21 \latexignore{\rtfignore{\wxheading{Members}}}
  22
  23
  24 \membersection{cbRowDragPlugin::cbRowDragPlugin}\label{cbrowdragplugincbrowdragplugin}
  25
  26 \func{}{cbRowDragPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}
  27
  28
  29 \func{}{cbRowDragPlugin}{\void}
  30
  31
  32 \membersection{cbRowDragPlugin::\destruct{cbRowDragPlugin}}\label{cbrowdragplugindtor}
  33
  34 \func{}{\destruct{cbRowDragPlugin}}{\void}
  35
  36
  37 \membersection{cbRowDragPlugin::CaptureDCArea}\label{cbrowdragplugincapturedcarea}
  38
  39 \func{wxBitmap*}{CaptureDCArea}{\param{wxDC\& }{dc}, \param{wxRect\& }{area}}
  40
  41
  42 \membersection{cbRowDragPlugin::CheckPrevItemInFocus}\label{cbrowdragplugincheckpreviteminfocus}
  43
  44 \func{void}{CheckPrevItemInFocus}{\param{cbRowInfo* }{pRow}, \param{int }{iconIdx}}
  45
  46
  47 \membersection{cbRowDragPlugin::Clone}\label{cbrowdragpluginclone}
  48
  49 \func{cbPluginBase*}{Clone}{\void}
  50
  51
  52 \membersection{cbRowDragPlugin::CollapseRow}\label{cbrowdragplugincollapserow}
  53
  54 \func{void}{CollapseRow}{\param{cbRowInfo* }{pRow}}
  55
  56
  57 \membersection{cbRowDragPlugin::Draw3DPattern}\label{cbrowdragplugindraw3dpattern}
  58
  59 \func{void}{Draw3DPattern}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
  60
  61
  62 \membersection{cbRowDragPlugin::Draw3DRect}\label{cbrowdragplugindraw3drect}
  63
  64 \func{void}{Draw3DRect}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{wxBrush\& }{bkBrush}}
  65
  66
  67 \membersection{cbRowDragPlugin::DrawCollapsedRowIcon}\label{cbrowdragplugindrawcollapsedrowicon}
  68
  69 \func{void}{DrawCollapsedRowIcon}{\param{int }{index}, \param{wxDC\& }{dc}, \param{bool }{isHighlighted}}
  70
  71 overridables (appearence-depedent)
  72
  73
  74 \membersection{cbRowDragPlugin::DrawCollapsedRowsBorder}\label{cbrowdragplugindrawcollapsedrowsborder}
  75
  76 \func{void}{DrawCollapsedRowsBorder}{\param{wxDC\& }{dc}}
  77
  78
  79 \membersection{cbRowDragPlugin::DrawEmptyRow}\label{cbrowdragplugindrawemptyrow}
  80
  81 \func{void}{DrawEmptyRow}{\param{wxDC\& }{dc}, \param{wxRect\& }{rowBounds}}
  82
  83
  84 \membersection{cbRowDragPlugin::DrawOrtoRomb}\label{cbrowdragplugindrawortoromb}
  85
  86 \func{void}{DrawOrtoRomb}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{wxBrush\& }{bkBrush}}
  87
  88
  89 \membersection{cbRowDragPlugin::DrawRectShade}\label{cbrowdragplugindrawrectshade}
  90
  91 \func{void}{DrawRectShade}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{int }{level}, \param{wxPen\& }{upperPen}, \param{wxPen\& }{lowerPen}}
  92
  93
  94 \membersection{cbRowDragPlugin::DrawRomb}\label{cbrowdragplugindrawromb}
  95
  96 \func{void}{DrawRomb}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{wxBrush\& }{bkBrush}}
  97
  98
  99 \membersection{cbRowDragPlugin::DrawRombShades}\label{cbrowdragplugindrawrombshades}
 100
 101 \func{void}{DrawRombShades}{\param{wxPoint\& }{p1}, \param{wxPoint\& }{p2}, \param{wxPoint\& }{p3}, \param{wxPoint\& }{p4}, \param{wxDC\& }{dc}}
 102
 103
 104 \membersection{cbRowDragPlugin::DrawRowDragHint}\label{cbrowdragplugindrawrowdraghint}
 105
 106 \func{void}{DrawRowDragHint}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{bool }{isHighlighted}}
 107
 108
 109 \membersection{cbRowDragPlugin::DrawRowsDragHintsBorder}\label{cbrowdragplugindrawrowsdraghintsborder}
 110
 111 \func{void}{DrawRowsDragHintsBorder}{\param{wxDC\& }{dc}}
 112
 113
 114 \membersection{cbRowDragPlugin::DrawTrianDown}\label{cbrowdragplugindrawtriandown}
 115
 116 \func{void}{DrawTrianDown}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
 117
 118
 119 \membersection{cbRowDragPlugin::DrawTrianRight}\label{cbrowdragplugindrawtrianright}
 120
 121 \func{void}{DrawTrianRight}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
 122
 123
 124 \membersection{cbRowDragPlugin::DrawTrianUp}\label{cbrowdragplugindrawtrianup}
 125
 126 \func{void}{DrawTrianUp}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
 127
 128 "hard-coded metafile" for NN-look
 129
 130
 131 \membersection{cbRowDragPlugin::ExpandRow}\label{cbrowdragpluginexpandrow}
 132
 133 \func{void}{ExpandRow}{\param{int }{collapsedIconIdx}}
 134
 135
 136 \membersection{cbRowDragPlugin::FinishOnScreenDraw}\label{cbrowdragpluginfinishonscreendraw}
 137
 138 \func{void}{FinishOnScreenDraw}{\void}
 139
 140
 141 \membersection{cbRowDragPlugin::GetCollapsedIconsPos}\label{cbrowdragplugingetcollapsediconspos}
 142
 143 \func{int}{GetCollapsedIconsPos}{\void}
 144
 145
 146 \membersection{cbRowDragPlugin::GetCollapsedInconRect}\label{cbrowdragplugingetcollapsedinconrect}
 147
 148 \func{void}{GetCollapsedInconRect}{\param{int }{iconIdx}, \param{wxRect\& }{rect}}
 149
 150
 151 \membersection{cbRowDragPlugin::GetCollapsedRowIconHeight}\label{cbrowdragplugingetcollapsedrowiconheight}
 152
 153 \func{int}{GetCollapsedRowIconHeight}{\void}
 154
 155
 156 \membersection{cbRowDragPlugin::GetFirstRow}\label{cbrowdragplugingetfirstrow}
 157
 158 \func{cbRowInfo*}{GetFirstRow}{\void}
 159
 160
 161 \membersection{cbRowDragPlugin::GetHRowsCountForPane}\label{cbrowdragplugingethrowscountforpane}
 162
 163 \func{int}{GetHRowsCountForPane}{\param{cbDockPane* }{pPane}}
 164
 165 helpers for drag\&drop
 166
 167
 168 \membersection{cbRowDragPlugin::GetRowDragHintWidth}\label{cbrowdragplugingetrowdraghintwidth}
 169
 170 \func{int}{GetRowDragHintWidth}{\void}
 171
 172
 173 \membersection{cbRowDragPlugin::GetRowHintRect}\label{cbrowdragplugingetrowhintrect}
 174
 175 \func{void}{GetRowHintRect}{\param{cbRowInfo* }{pRow}, \param{wxRect\& }{rect}}
 176
 177
 178 \membersection{cbRowDragPlugin::HitTestCollapsedRowIcon}\label{cbrowdragpluginhittestcollapsedrowicon}
 179
 180 \func{bool}{HitTestCollapsedRowIcon}{\param{int }{iconIdx}, \param{const wxPoint\& }{pos}}
 181
 182
 183 \membersection{cbRowDragPlugin::HitTestRowDragHint}\label{cbrowdragpluginhittestrowdraghint}
 184
 185 \func{bool}{HitTestRowDragHint}{\param{cbRowInfo* }{pRow}, \param{const wxPoint\& }{pos}}
 186
 187
 188 \membersection{cbRowDragPlugin::InsertDraggedRowBefore}\label{cbrowdragplugininsertdraggedrowbefore}
 189
 190 \func{void}{InsertDraggedRowBefore}{\param{cbRowInfo* }{pBeforeRow}}
 191
 192
 193 \membersection{cbRowDragPlugin::ItemIsInFocus}\label{cbrowdragpluginitemisinfocus}
 194
 195 \func{bool}{ItemIsInFocus}{\void}
 196
 197
 198 \membersection{cbRowDragPlugin::OnDrawPaneBackground}\label{cbrowdragpluginondrawpanebackground}
 199
 200 \func{void}{OnDrawPaneBackground}{\param{cbDrawPaneDecorEvent\& }{event}}
 201
 202
 203 \membersection{cbRowDragPlugin::OnInitPlugin}\label{cbrowdragpluginoninitplugin}
 204
 205 \func{void}{OnInitPlugin}{\void}
 206
 207
 208 \membersection{cbRowDragPlugin::OnLButtonDown}\label{cbrowdragpluginonlbuttondown}
 209
 210 \func{void}{OnLButtonDown}{\param{cbLeftDownEvent\& }{event}}
 211
 212
 213 \membersection{cbRowDragPlugin::OnLButtonUp}\label{cbrowdragpluginonlbuttonup}
 214
 215 \func{void}{OnLButtonUp}{\param{cbLeftUpEvent\& }{event}}
 216
 217
 218 \membersection{cbRowDragPlugin::OnMouseMove}\label{cbrowdragpluginonmousemove}
 219
 220 \func{void}{OnMouseMove}{\param{cbMotionEvent\& }{event}}
 221
 222 handlers for plugin events (appearence-independent logic)
 223
 224
 225 \membersection{cbRowDragPlugin::PrepareForRowDrag}\label{cbrowdragpluginprepareforrowdrag}
 226
 227 \func{void}{PrepareForRowDrag}{\void}
 228
 229
 230 \membersection{cbRowDragPlugin::SetMouseCapture}\label{cbrowdragpluginsetmousecapture}
 231
 232 \func{void}{SetMouseCapture}{\param{bool }{captureOn}}
 233
 234
 235 \membersection{cbRowDragPlugin::SetPaneMargins}\label{cbrowdragpluginsetpanemargins}
 236
 237 \func{void}{SetPaneMargins}{\void}
 238
 239
 240 \membersection{cbRowDragPlugin::ShowDraggedRow}\label{cbrowdragpluginshowdraggedrow}
 241
 242 \func{void}{ShowDraggedRow}{\param{int }{offset}}
 243
 244
 245 \membersection{cbRowDragPlugin::ShowPaneImage}\label{cbrowdragpluginshowpaneimage}
 246
 247 \func{void}{ShowPaneImage}{\void}
 248
 249
 250 \membersection{cbRowDragPlugin::UnhiglightItemInFocus}\label{cbrowdragpluginunhiglightiteminfocus}
 251
 252 \func{void}{UnhiglightItemInFocus}{\void}
 253