contrib/docs/latex/fl/cbrowdragplugin.tex

   1 %
   2 % automatically generated by HelpGen $Revision$ from
   3 % rowdragpl.h at 21/Jan/02 21:14:19
   4 %
   5
   6
   7 \section{\class{cbRowDragPlugin}}\label{cbrowdragplugin}
   8
   9
  10 This plugin adds row-dragging functionality to the pane.
  11 It handles mouse movement and pane background-erasing plugin events.
  12 The behaviour and appearance resembles drag and drop positioning
  13 of the toolbar rows in Netscape Communicator 4.xx.
  14
  15 \wxheading{Derived from}
  16
  17 \helpref{cbPluginBase}{cbpluginbase}
  18
  19 \wxheading{Include files}
  20
  21 <wx/fl/rowdragpl.h>
  22
  23 \wxheading{Data structures}
  24
  25 \latexignore{\rtfignore{\wxheading{Members}}}
  26
  27
  28 \membersection{cbRowDragPlugin::cbRowDragPlugin}\label{cbrowdragplugincbrowdragplugin}
  29
  30 \func{}{cbRowDragPlugin}{\param{wxFrameLayout* }{pLayout}, \param{int }{paneMask = wxALL\_PANES}}
  31
  32 Constructor, taking paren layout frame and pane mask.
  33
  34
  35 \func{}{cbRowDragPlugin}{\void}
  36
  37 Default constructor.
  38
  39
  40 \membersection{cbRowDragPlugin::\destruct{cbRowDragPlugin}}\label{cbrowdragplugindtor}
  41
  42 \func{}{\destruct{cbRowDragPlugin}}{\void}
  43
  44 Destructor.
  45
  46
  47 \membersection{cbRowDragPlugin::CaptureDCArea}\label{cbrowdragplugincapturedcarea}
  48
  49 \func{wxBitmap*}{CaptureDCArea}{\param{wxDC\& }{dc}, \param{wxRect\& }{area}}
  50
  51 Helper for drag and drop.
  52
  53
  54 \membersection{cbRowDragPlugin::CheckPrevItemInFocus}\label{cbrowdragplugincheckpreviteminfocus}
  55
  56 \func{void}{CheckPrevItemInFocus}{\param{cbRowInfo* }{pRow}, \param{int }{iconIdx}}
  57
  58 Helper for drag and drop.
  59
  60
  61 \membersection{cbRowDragPlugin::Clone}\label{cbrowdragpluginclone}
  62
  63 \func{cbPluginBase*}{Clone}{\void}
  64
  65 Clone function, returning a new instance of this class.
  66
  67
  68 \membersection{cbRowDragPlugin::CollapseRow}\label{cbrowdragplugincollapserow}
  69
  70 \func{void}{CollapseRow}{\param{cbRowInfo* }{pRow}}
  71
  72 Helper for drag and drop.
  73
  74
  75 \membersection{cbRowDragPlugin::Draw3DPattern}\label{cbrowdragplugindraw3dpattern}
  76
  77 \func{void}{Draw3DPattern}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
  78
  79 Implements 'hard-coded metafile' for Netscape Navigator look.
  80
  81
  82 \membersection{cbRowDragPlugin::Draw3DRect}\label{cbrowdragplugindraw3drect}
  83
  84 \func{void}{Draw3DRect}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{wxBrush\& }{bkBrush}}
  85
  86 Implements 'hard-coded metafile' for Netscape Navigator look.
  87
  88
  89 \membersection{cbRowDragPlugin::DrawCollapsedRowIcon}\label{cbrowdragplugindrawcollapsedrowicon}
  90
  91 \func{void}{DrawCollapsedRowIcon}{\param{int }{index}, \param{wxDC\& }{dc}, \param{bool }{isHighlighted}}
  92
  93 Draws collapsed row icon (appearance-dependent).
  94
  95
  96 \membersection{cbRowDragPlugin::DrawCollapsedRowsBorder}\label{cbrowdragplugindrawcollapsedrowsborder}
  97
  98 \func{void}{DrawCollapsedRowsBorder}{\param{wxDC\& }{dc}}
  99
 100 Draws collapsed rows border (appearance-dependent).
 101
 102
 103 \membersection{cbRowDragPlugin::DrawEmptyRow}\label{cbrowdragplugindrawemptyrow}
 104
 105 \func{void}{DrawEmptyRow}{\param{wxDC\& }{dc}, \param{wxRect\& }{rowBounds}}
 106
 107 Draws empty row (appearance-dependent).
 108
 109
 110 \membersection{cbRowDragPlugin::DrawOrtoRomb}\label{cbrowdragplugindrawortoromb}
 111
 112 \func{void}{DrawOrtoRomb}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{wxBrush\& }{bkBrush}}
 113
 114 Implements 'hard-coded metafile' for Netscape Navigator look.
 115
 116
 117 \membersection{cbRowDragPlugin::DrawRectShade}\label{cbrowdragplugindrawrectshade}
 118
 119 \func{void}{DrawRectShade}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{int }{level}, \param{wxPen\& }{upperPen}, \param{wxPen\& }{lowerPen}}
 120
 121 Implements 'hard-coded metafile' for Netscape Navigator look.
 122
 123
 124 \membersection{cbRowDragPlugin::DrawRomb}\label{cbrowdragplugindrawromb}
 125
 126 \func{void}{DrawRomb}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}, \param{wxBrush\& }{bkBrush}}
 127
 128 Implements 'hard-coded metafile' for Netscape Navigator look.
 129
 130
 131 \membersection{cbRowDragPlugin::DrawRombShades}\label{cbrowdragplugindrawrombshades}
 132
 133 \func{void}{DrawRombShades}{\param{wxPoint\& }{p1}, \param{wxPoint\& }{p2}, \param{wxPoint\& }{p3}, \param{wxPoint\& }{p4}, \param{wxDC\& }{dc}}
 134
 135 Implements 'hard-coded metafile' for Netscape Navigator look.
 136
 137
 138 \membersection{cbRowDragPlugin::DrawRowDragHint}\label{cbrowdragplugindrawrowdraghint}
 139
 140 \func{void}{DrawRowDragHint}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}, \param{bool }{isHighlighted}}
 141
 142 Draws row drag hint (appearance-dependent).
 143
 144
 145 \membersection{cbRowDragPlugin::DrawRowsDragHintsBorder}\label{cbrowdragplugindrawrowsdraghintsborder}
 146
 147 \func{void}{DrawRowsDragHintsBorder}{\param{wxDC\& }{dc}}
 148
 149 Draws rows drag hints border (appearance-dependent).
 150
 151
 152 \membersection{cbRowDragPlugin::DrawTrianDown}\label{cbrowdragplugindrawtriandown}
 153
 154 \func{void}{DrawTrianDown}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
 155
 156 Implements 'hard-coded metafile' for Netscape Navigator look.
 157
 158
 159 \membersection{cbRowDragPlugin::DrawTrianRight}\label{cbrowdragplugindrawtrianright}
 160
 161 \func{void}{DrawTrianRight}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
 162
 163 Implements 'hard-coded metafile' for Netscape Navigator look.
 164
 165
 166 \membersection{cbRowDragPlugin::DrawTrianUp}\label{cbrowdragplugindrawtrianup}
 167
 168 \func{void}{DrawTrianUp}{\param{wxRect\& }{inRect}, \param{wxDC\& }{dc}}
 169
 170 Implements 'hard-coded metafile' for Netscape Navigator look.
 171
 172
 173 \membersection{cbRowDragPlugin::ExpandRow}\label{cbrowdragpluginexpandrow}
 174
 175 \func{void}{ExpandRow}{\param{int }{collapsedIconIdx}}
 176
 177 Helper for drag and drop.
 178
 179
 180 \membersection{cbRowDragPlugin::FinishOnScreenDraw}\label{cbrowdragpluginfinishonscreendraw}
 181
 182 \func{void}{FinishOnScreenDraw}{\void}
 183
 184 Helper for drag and drop.
 185
 186
 187 \membersection{cbRowDragPlugin::GetCollapsedIconsPos}\label{cbrowdragplugingetcollapsediconspos}
 188
 189 \func{int}{GetCollapsedIconsPos}{\void}
 190
 191 Helper for drag and drop.
 192
 193
 194 \membersection{cbRowDragPlugin::GetCollapsedInconRect}\label{cbrowdragplugingetcollapsedinconrect}
 195
 196 \func{void}{GetCollapsedInconRect}{\param{int }{iconIdx}, \param{wxRect\& }{rect}}
 197
 198 Helper for drag and drop.
 199
 200
 201 \membersection{cbRowDragPlugin::GetCollapsedRowIconHeight}\label{cbrowdragplugingetcollapsedrowiconheight}
 202
 203 \func{int}{GetCollapsedRowIconHeight}{\void}
 204
 205 Gets the collapsed row icon height.
 206
 207
 208 \membersection{cbRowDragPlugin::GetFirstRow}\label{cbrowdragplugingetfirstrow}
 209
 210 \func{cbRowInfo*}{GetFirstRow}{\void}
 211
 212 Helper for drag and drop.
 213
 214
 215 \membersection{cbRowDragPlugin::GetHRowsCountForPane}\label{cbrowdragplugingethrowscountforpane}
 216
 217 \func{int}{GetHRowsCountForPane}{\param{cbDockPane* }{pPane}}
 218
 219 Helper for drag and drop.
 220
 221
 222 \membersection{cbRowDragPlugin::GetRowDragHintWidth}\label{cbrowdragplugingetrowdraghintwidth}
 223
 224 \func{int}{GetRowDragHintWidth}{\void}
 225
 226 Gets the row drag hint width.
 227
 228
 229 \membersection{cbRowDragPlugin::GetRowHintRect}\label{cbrowdragplugingetrowhintrect}
 230
 231 \func{void}{GetRowHintRect}{\param{cbRowInfo* }{pRow}, \param{wxRect\& }{rect}}
 232
 233 Helper for drag and drop.
 234
 235
 236 \membersection{cbRowDragPlugin::HitTestCollapsedRowIcon}\label{cbrowdragpluginhittestcollapsedrowicon}
 237
 238 \func{bool}{HitTestCollapsedRowIcon}{\param{int }{iconIdx}, \param{const wxPoint\& }{pos}}
 239
 240 Test for the collapsed row icon position.
 241
 242
 243 \membersection{cbRowDragPlugin::HitTestRowDragHint}\label{cbrowdragpluginhittestrowdraghint}
 244
 245 \func{bool}{HitTestRowDragHint}{\param{cbRowInfo* }{pRow}, \param{const wxPoint\& }{pos}}
 246
 247 Test for the row drag hint position.
 248
 249
 250 \membersection{cbRowDragPlugin::InsertDraggedRowBefore}\label{cbrowdragplugininsertdraggedrowbefore}
 251
 252 \func{void}{InsertDraggedRowBefore}{\param{cbRowInfo* }{pBeforeRow}}
 253
 254 Helper for drag and drop.
 255
 256
 257 \membersection{cbRowDragPlugin::ItemIsInFocus}\label{cbrowdragpluginitemisinfocus}
 258
 259 \func{bool}{ItemIsInFocus}{\void}
 260
 261 Helper for drag and drop.
 262
 263
 264 \membersection{cbRowDragPlugin::OnDrawPaneBackground}\label{cbrowdragpluginondrawpanebackground}
 265
 266 \func{void}{OnDrawPaneBackground}{\param{cbDrawPaneDecorEvent\& }{event}}
 267
 268 Handles pane drawing plugin events (appearance-independent logic).
 269
 270
 271 \membersection{cbRowDragPlugin::OnInitPlugin}\label{cbrowdragpluginoninitplugin}
 272
 273 \func{void}{OnInitPlugin}{\void}
 274
 275 Called to initialize this plugin.
 276
 277
 278 \membersection{cbRowDragPlugin::OnLButtonDown}\label{cbrowdragpluginonlbuttondown}
 279
 280 \func{void}{OnLButtonDown}{\param{cbLeftDownEvent\& }{event}}
 281
 282 Handles left button down plugin events (appearance-independent logic).
 283
 284
 285 \membersection{cbRowDragPlugin::OnLButtonUp}\label{cbrowdragpluginonlbuttonup}
 286
 287 \func{void}{OnLButtonUp}{\param{cbLeftUpEvent\& }{event}}
 288
 289 Handles left button up plugin events (appearance-independent logic).
 290
 291
 292 \membersection{cbRowDragPlugin::OnMouseMove}\label{cbrowdragpluginonmousemove}
 293
 294 \func{void}{OnMouseMove}{\param{cbMotionEvent\& }{event}}
 295
 296 Handles mouse move plugin events (appearance-independent logic).
 297
 298
 299 \membersection{cbRowDragPlugin::PrepareForRowDrag}\label{cbrowdragpluginprepareforrowdrag}
 300
 301 \func{void}{PrepareForRowDrag}{\void}
 302
 303 Helper for drag and drop.
 304
 305
 306 \membersection{cbRowDragPlugin::SetMouseCapture}\label{cbrowdragpluginsetmousecapture}
 307
 308 \func{void}{SetMouseCapture}{\param{bool }{captureOn}}
 309
 310 Helper for drag and drop.
 311
 312
 313 \membersection{cbRowDragPlugin::SetPaneMargins}\label{cbrowdragpluginsetpanemargins}
 314
 315 \func{void}{SetPaneMargins}{\void}
 316
 317 Sets the pane margins.
 318
 319
 320 \membersection{cbRowDragPlugin::ShowDraggedRow}\label{cbrowdragpluginshowdraggedrow}
 321
 322 \func{void}{ShowDraggedRow}{\param{int }{offset}}
 323
 324 Helper for drag and drop.
 325
 326
 327 \membersection{cbRowDragPlugin::ShowPaneImage}\label{cbrowdragpluginshowpaneimage}
 328
 329 \func{void}{ShowPaneImage}{\void}
 330
 331 Helper for drag and drop.
 332
 333
 334 \membersection{cbRowDragPlugin::UnhighlightItemInFocus}\label{cbrowdragpluginunhighlightiteminfocus}
 335
 336 \func{void}{UnhighlightItemInFocus}{\void}
 337
 338 Helper for drag and drop.
 339