]> git.saurik.com Git - wxWidgets.git/blob - contrib/docs/latex/fl/cbdockpane.tex
corrected version number extraction
[wxWidgets.git] / contrib / docs / latex / fl / cbdockpane.tex
1 %
2 % automatically generated by HelpGen $Revision$ from
3 % controlbar.h at 21/Jan/02 21:14:14
4 %
5
6
7 \section{\class{cbDockPane}}\label{cbdockpane}
8
9
10 This class manages containment and control of control bars
11 along one of the four edges of the parent frame.
12
13 \wxheading{Derived from}
14
15 \helpref{wxObject}{wxobject}
16
17 \wxheading{Include files}
18
19 <wx/fl/controlbar.h>
20
21 \wxheading{Data structures}
22
23 \latexignore{\rtfignore{\wxheading{Members}}}
24
25
26 \membersection{cbDockPane::cbDockPane}\label{cbdockpanecbdockpane}
27
28 \func{}{cbDockPane}{\param{int }{alignment}, \param{wxFrameLayout* }{pPanel}}
29
30 Constructor, taking alignment and layout panel.
31
32
33 \func{}{cbDockPane}{\void}
34
35 public members Default constructor.
36
37
38 \membersection{cbDockPane::\destruct{cbDockPane}}\label{cbdockpanedtor}
39
40 \func{}{\destruct{cbDockPane}}{\void}
41
42 Destructor.
43
44
45 \membersection{cbDockPane::BarPresent}\label{cbdockpanebarpresent}
46
47 \func{bool}{BarPresent}{\param{cbBarInfo* }{pBar}}
48
49 Returns TRUE if the given bar is present in this pane.
50
51
52 \membersection{cbDockPane::CalcLengthRatios}\label{cbdockpanecalclengthratios}
53
54 \func{void}{CalcLengthRatios}{\param{cbRowInfo* }{pInRow}}
55
56 Calculate lengths.
57 Internal function called by plugins.
58
59
60 \membersection{cbDockPane::ContractBar}\label{cbdockpanecontractbar}
61
62 \func{void}{ContractBar}{\param{cbBarInfo* }{pBar}}
63
64 Contracts the bar.
65 Internal function called by plugins.
66
67
68 \membersection{cbDockPane::DoInsertBar}\label{cbdockpanedoinsertbar}
69
70 \func{void}{DoInsertBar}{\param{cbBarInfo* }{pBar}, \param{int }{rowNo}}
71
72 Inserts the bar at the given row number.
73 Internal function called by plugins.
74
75
76 \membersection{cbDockPane::DrawHorizHandle}\label{cbdockpanedrawhorizhandle}
77
78 \func{void}{DrawHorizHandle}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{width}}
79
80 Row/bar resizing related helper-method.
81
82
83 \membersection{cbDockPane::DrawVertHandle}\label{cbdockpanedrawverthandle}
84
85 \func{void}{DrawVertHandle}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{height}}
86
87 protected really (accessed only by plugins) Row/bar resizing related helper-method.
88
89
90 \membersection{cbDockPane::ExpandBar}\label{cbdockpaneexpandbar}
91
92 \func{void}{ExpandBar}{\param{cbBarInfo* }{pBar}}
93
94 Expands the bar.
95 Internal function called by plugins.
96
97
98 \membersection{cbDockPane::FinishDrawInArea}\label{cbdockpanefinishdrawinarea}
99
100 \func{void}{FinishDrawInArea}{\param{const wxRect\& }{area}}
101
102 Generates cbFinishDrawInAreaEvent and sends it to the layout.
103 Internal function called by plugins.
104
105
106 \membersection{cbDockPane::FrameToPane}\label{cbdockpaneframetopane}
107
108 \func{void}{FrameToPane}{\param{int* }{x}, \param{int* }{y}}
109
110 Coordinate translation between parent's frame and this pane.
111 Internal function called by plugins.
112
113
114 \func{void}{FrameToPane}{\param{wxRect* }{pRect}}
115
116 Coordinate translation between parent's frame and this pane.
117 Internal function called by plugins.
118
119
120 \membersection{cbDockPane::GetAlignment}\label{cbdockpanegetalignment}
121
122 \func{int}{GetAlignment}{\void}
123
124 Returns the alignment for this pane. The value is one of
125 FL\_ALIGN\_TOP, FL\_ALIGN\_BOTTOM, FL\_ALIGN\_LEFT, FL\_ALIGN\_RIGHT.
126
127
128 \membersection{cbDockPane::GetBarInfoByWindow}\label{cbdockpanegetbarinfobywindow}
129
130 \func{cbBarInfo*}{GetBarInfoByWindow}{\param{wxWindow* }{pBarWnd}}
131
132 Finds the bar information by corresponding window.
133
134
135 \membersection{cbDockPane::GetBarResizeRange}\label{cbdockpanegetbarresizerange}
136
137 \func{void}{GetBarResizeRange}{\param{cbBarInfo* }{pBar}, \param{int* }{from}, \param{int* }{till}, \param{bool }{forLeftHandle}}
138
139 Returns the bar's resize range.
140
141
142 \membersection{cbDockPane::GetDockingState}\label{cbdockpanegetdockingstate}
143
144 \func{int}{GetDockingState}{\void}
145
146 Returns wxCBAR\_DOCKED\_HORIZONTALLY if the alignment is top or bottom,
147 or wxCBAR\_DOCKED\_VERTICALLY otherwise.
148
149
150 \membersection{cbDockPane::GetFirstRow}\label{cbdockpanegetfirstrow}
151
152 \func{cbRowInfo*}{GetFirstRow}{\void}
153
154 Returns the first row.
155
156
157 \membersection{cbDockPane::GetMinimalRowHeight}\label{cbdockpanegetminimalrowheight}
158
159 \func{int}{GetMinimalRowHeight}{\param{cbRowInfo* }{pRow}}
160
161 Returns the minimal row height for the given row.
162 Internal function called by plugins.
163
164
165 \membersection{cbDockPane::GetNotFixedBarsCount}\label{cbdockpanegetnotfixedbarscount}
166
167 \func{int}{GetNotFixedBarsCount}{\param{cbRowInfo* }{pRow}}
168
169 Returns the number of bars whose size is not fixed.
170 Internal function called by plugins.
171
172
173 \membersection{cbDockPane::GetPaneHeight}\label{cbdockpanegetpaneheight}
174
175 \func{int}{GetPaneHeight}{\void}
176
177 Returns the height in the pane's coordinates.
178
179
180 \membersection{cbDockPane::GetRealRect}\label{cbdockpanegetrealrect}
181
182 \func{wxRect\&}{GetRealRect}{\void}
183
184 Returns the bounds of the pane, in parent coordinates.
185
186
187 \membersection{cbDockPane::GetRow}\label{cbdockpanegetrow}
188
189 \func{cbRowInfo*}{GetRow}{\param{int }{row}}
190
191 protected really (accessed only by plugins) Returns the row info for a row index. Internal function called by plugins.
192
193
194 \membersection{cbDockPane::GetRowAt}\label{cbdockpanegetrowat}
195
196 \func{int}{GetRowAt}{\param{int }{paneY}}
197
198 Returns the row at the given vertical position.
199 Returns -1 if the row is not present at given vertical position.
200 Internal function called by plugins.
201
202
203 \func{int}{GetRowAt}{\param{int }{upperY}, \param{int }{lowerY}}
204
205 Returns the row between the given vertical positions.
206 Returns -1 if the row is not present.
207 Internal function called by plugins.
208
209
210 \membersection{cbDockPane::GetRowIndex}\label{cbdockpanegetrowindex}
211
212 \func{int}{GetRowIndex}{\param{cbRowInfo* }{pRow}}
213
214 Returns the row index for the given row info. Internal function called by plugins.
215
216
217 \membersection{cbDockPane::GetRowList}\label{cbdockpanegetrowlist}
218
219 \func{RowArrayT\&}{GetRowList}{\void}
220
221 Returns an array of rows. Used by updates-managers.
222
223
224 \membersection{cbDockPane::GetRowResizeRange}\label{cbdockpanegetrowresizerange}
225
226 \func{void}{GetRowResizeRange}{\param{cbRowInfo* }{pRow}, \param{int* }{from}, \param{int* }{till}, \param{bool }{forUpperHandle}}
227
228 Returns the row's resize range.
229
230
231 \membersection{cbDockPane::GetRowShapeData}\label{cbdockpanegetrowshapedata}
232
233 \func{void}{GetRowShapeData}{\param{cbRowInfo* }{pRow}, \param{wxList* }{pLst}}
234
235 Returns row shape data.
236 cbBarShapeData objects will be added to the given pLst.
237 cbBarShapeData is used for storing the original bar's positions in the row,
238 when the 'non-destructive-friction' option is turned on.
239
240
241 \membersection{cbDockPane::GetRowY}\label{cbdockpanegetrowy}
242
243 \func{int}{GetRowY}{\param{cbRowInfo* }{pRow}}
244
245 Gets the vertical position at the given row.
246 Internal function called by plugins.
247
248
249 \membersection{cbDockPane::HasNotFixedBarsLeft}\label{cbdockpanehasnotfixedbarsleft}
250
251 \func{bool}{HasNotFixedBarsLeft}{\param{cbBarInfo* }{pBar}}
252
253 Returns TRUE if there are any variable-sized rows to the left of this one.
254 Internal function called by plugins.
255
256
257 \membersection{cbDockPane::HasNotFixedBarsRight}\label{cbdockpanehasnotfixedbarsright}
258
259 \func{bool}{HasNotFixedBarsRight}{\param{cbBarInfo* }{pBar}}
260
261 Returns TRUE if there are any variable-sized rows to the right of this one.
262 Internal function called by plugins.
263
264
265 \membersection{cbDockPane::HasNotFixedRowsAbove}\label{cbdockpanehasnotfixedrowsabove}
266
267 \func{bool}{HasNotFixedRowsAbove}{\param{cbRowInfo* }{pRow}}
268
269 Returns TRUE if there are any variable-sized rows above this one.
270 Internal function called by plugins.
271
272
273 \membersection{cbDockPane::HasNotFixedRowsBelow}\label{cbdockpanehasnotfixedrowsbelow}
274
275 \func{bool}{HasNotFixedRowsBelow}{\param{cbRowInfo* }{pRow}}
276
277 Returns TRUE if there are any variable-sized rows below this one.
278 Internal function called by plugins.
279
280
281 \membersection{cbDockPane::HasPoint}\label{cbdockpanehaspoint}
282
283 \func{bool}{HasPoint}{\param{const wxPoint\& }{pos}, \param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
284
285 Returns TRUE if pos is within the given rectangle.
286 Internal function called by plugins.
287
288
289 \membersection{cbDockPane::HitTestPaneItems}\label{cbdockpanehittestpaneitems}
290
291 \func{int}{HitTestPaneItems}{\param{const wxPoint\& }{pos}, \param{cbRowInfo** }{ppRow}, \param{cbBarInfo** }{ppBar}}
292
293 Returns the result of hit-testing items in the pane.
294 See CB\_HITTEST\_RESULT enumerated type.
295 pos is the position in this pane's coordinates.
296
297
298 \membersection{cbDockPane::InitLinksForRow}\label{cbdockpaneinitlinksforrow}
299
300 \func{void}{InitLinksForRow}{\param{cbRowInfo* }{pRow}}
301
302 Sets up links between bars.
303 Internal function called by plugins.
304
305
306 \membersection{cbDockPane::InitLinksForRows}\label{cbdockpaneinitlinksforrows}
307
308 \func{void}{InitLinksForRows}{\void}
309
310 Sets up links between bars.
311 Internal function called by plugins.
312
313
314 \membersection{cbDockPane::InsertBar}\label{cbdockpaneinsertbar}
315
316 \func{void}{InsertBar}{\param{cbBarInfo* }{pBarInfo}}
317
318 Inserts bar and sets its position according to the preferred settings
319 given in pBarInfo.
320
321
322 \func{void}{InsertBar}{\param{cbBarInfo* }{pBar}, \param{const wxRect\& }{rect}}
323
324 Inserts the bar into this pane. rect is given in the parent frame's coordinates.
325
326
327 \func{void}{InsertBar}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pIntoRow}}
328
329 Inserts the bar into the given row, with dimensions and position
330 stored in pBarInfo->mBounds. Returns the node of inserted bar.
331
332
333 \membersection{cbDockPane::InsertRow}\label{cbdockpaneinsertrow}
334
335 \func{void}{InsertRow}{\param{cbRowInfo* }{pRow}, \param{cbRowInfo* }{pBeforeRow}}
336
337 Inserts a row. Does not refresh the inserted row immediately.
338 If pBeforeRowNode is NULL, the row is appended to the end of pane's row list.
339
340
341 \membersection{cbDockPane::IsFixedSize}\label{cbdockpaneisfixedsize}
342
343 \func{bool}{IsFixedSize}{\param{cbBarInfo* }{pInfo}}
344
345 Returns TRUE if the bar's dimension information indicates a fixed size.
346 Internal function called by plugins.
347
348
349 \membersection{cbDockPane::IsHorizontal}\label{cbdockpaneishorizontal}
350
351 \func{bool}{IsHorizontal}{\void}
352
353 Returns TRUE if the pane is aligned to the top or bottom.
354
355
356 \membersection{cbDockPane::MatchesMask}\label{cbdockpanematchesmask}
357
358 \func{bool}{MatchesMask}{\param{int }{paneMask}}
359
360 Returns TRUE if the given mask matches the pane's mask.
361
362
363 \membersection{cbDockPane::PaintBar}\label{cbdockpanepaintbar}
364
365 \func{void}{PaintBar}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
366
367 Calls PaintBarDecorations and PaintBarHandles.
368 Internal function called by plugins.
369
370
371 \membersection{cbDockPane::PaintBarDecorations}\label{cbdockpanepaintbardecorations}
372
373 \func{void}{PaintBarDecorations}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
374
375 protected really (accessed only by plugins) Generates a cbDrawBarDecorEvent and sends it to the layout to paint the bar decorations.
376 Internal function called by plugins.
377
378
379 \membersection{cbDockPane::PaintBarHandles}\label{cbdockpanepaintbarhandles}
380
381 \func{void}{PaintBarHandles}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
382
383 Generates a cbDrawBarHandlesEvent and sends it to the layout to paint the bar handles.
384 Internal function called by plugins.
385
386
387 \membersection{cbDockPane::PaintPane}\label{cbdockpanepaintpane}
388
389 \func{void}{PaintPane}{\param{wxDC\& }{dc}}
390
391 Paints the pane background, the row background and decorations,
392 and finally the pane decorations.
393 Internal function called by plugins.
394
395
396 \membersection{cbDockPane::PaintPaneBackground}\label{cbdockpanepaintpanebackground}
397
398 \func{void}{PaintPaneBackground}{\param{wxDC\& }{dc}}
399
400 Generates cbDrawPaneBkGroundEvent and sends it to the layout.
401 Internal function called by plugins.
402
403
404 \membersection{cbDockPane::PaintPaneDecorations}\label{cbdockpanepaintpanedecorations}
405
406 \func{void}{PaintPaneDecorations}{\param{wxDC\& }{dc}}
407
408 Generates cbDrawPaneDecorEvent and sends it to the layout.
409 Internal function called by plugins.
410
411
412 \membersection{cbDockPane::PaintRow}\label{cbdockpanepaintrow}
413
414 \func{void}{PaintRow}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
415
416 Calls PaintRowBackground, PaintRowDecorations, PaintRowHandles.
417 Internal function called by plugins.
418
419
420 \membersection{cbDockPane::PaintRowBackground}\label{cbdockpanepaintrowbackground}
421
422 \func{void}{PaintRowBackground}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
423
424 Generates cbDrawRowBkGroundEvent and sends it to the layout.
425 Internal function called by plugins.
426
427
428 \membersection{cbDockPane::PaintRowDecorations}\label{cbdockpanepaintrowdecorations}
429
430 \func{void}{PaintRowDecorations}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
431
432 Calls PaintBarDecorations for each row.
433 Internal function called by plugins.
434
435
436 \membersection{cbDockPane::PaintRowHandles}\label{cbdockpanepaintrowhandles}
437
438 \func{void}{PaintRowHandles}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
439
440 Generates cbDrawRowHandlesEvent and cbDrawRowDecorEvent and sends them to the layout.
441 Internal function called by plugins.
442
443
444 \membersection{cbDockPane::PaneToFrame}\label{cbdockpanepanetoframe}
445
446 \func{void}{PaneToFrame}{\param{wxRect* }{pRect}}
447
448 Coordinate translation between parent's frame and this pane.
449 Internal function called by plugins.
450
451
452 \func{void}{PaneToFrame}{\param{int* }{x}, \param{int* }{y}}
453
454 Coordinate translation between parent's frame and this pane.
455 Internal function called by plugins.
456
457
458 \membersection{cbDockPane::RecalcLayout}\label{cbdockpanerecalclayout}
459
460 \func{void}{RecalcLayout}{\void}
461
462 Generates events to perform layout calculations.
463
464
465 \membersection{cbDockPane::RecalcRowLayout}\label{cbdockpanerecalcrowlayout}
466
467 \func{void}{RecalcRowLayout}{\param{cbRowInfo* }{pRow}}
468
469 Generates a cbLayoutRowEvent event to recalculate row layouts.
470 Internal function called by plugins.
471
472
473 \membersection{cbDockPane::RemoveBar}\label{cbdockpaneremovebar}
474
475 \func{void}{RemoveBar}{\param{cbBarInfo* }{pBar}}
476
477 Removes the bar from this pane. Does not destroy the bar.
478
479
480 \membersection{cbDockPane::RemoveRow}\label{cbdockpaneremoverow}
481
482 \func{void}{RemoveRow}{\param{cbRowInfo* }{pRow}}
483
484 Removes the row from this pane. Does not destroy the row object.
485
486
487 \membersection{cbDockPane::ResizeBar}\label{cbdockpaneresizebar}
488
489 \func{void}{ResizeBar}{\param{cbBarInfo* }{pBar}, \param{int }{ofs}, \param{bool }{forLeftHandle}}
490
491 Row/bar resizing related helper-method.
492
493
494 \membersection{cbDockPane::ResizeRow}\label{cbdockpaneresizerow}
495
496 \func{void}{ResizeRow}{\param{cbRowInfo* }{pRow}, \param{int }{ofs}, \param{bool }{forUpperHandle}}
497
498 Row/bar resizing related helper-method.
499
500
501 \membersection{cbDockPane::SetBoundsInParent}\label{cbdockpanesetboundsinparent}
502
503 \func{void}{SetBoundsInParent}{\param{const wxRect\& }{rect}}
504
505 Set the position and dimensions of the pane in the parent frame's coordinates.
506
507
508 \membersection{cbDockPane::SetMargins}\label{cbdockpanesetmargins}
509
510 \func{void}{SetMargins}{\param{int }{top}, \param{int }{bottom}, \param{int }{left}, \param{int }{right}}
511
512 Sets pane's margins in frame's coordinate orientations.
513
514
515 \membersection{cbDockPane::SetPaneWidth}\label{cbdockpanesetpanewidth}
516
517 \func{void}{SetPaneWidth}{\param{int }{width}}
518
519 Sets pane's width in the pane's coordinates (including margins).
520
521
522 \membersection{cbDockPane::SetRowHeight}\label{cbdockpanesetrowheight}
523
524 \func{void}{SetRowHeight}{\param{cbRowInfo* }{pRow}, \param{int }{newHeight}}
525
526 Sets the row height for the given height. newHeight includes the height of row handles, if present.
527 Internal function called by plugins.
528
529
530 \membersection{cbDockPane::SetRowShapeData}\label{cbdockpanesetrowshapedata}
531
532 \func{void}{SetRowShapeData}{\param{cbRowInfo* }{pRowNode}, \param{wxList* }{pLst}}
533
534 Sets the shape data for the given row, using the data provided in pLst.
535 cbBarShapeData is used for storing the original bar's positions in the row,
536 when the 'non-destructive-friction' option is turned on.
537
538
539 \membersection{cbDockPane::SizeBar}\label{cbdockpanesizebar}
540
541 \func{void}{SizeBar}{\param{cbBarInfo* }{pBar}}
542
543 Generates a cbSizeBarWndEvent and sends it to the layout.
544 Internal function called by plugins.
545
546
547 \membersection{cbDockPane::SizePaneObjects}\label{cbdockpanesizepaneobjects}
548
549 \func{void}{SizePaneObjects}{\void}
550
551 Calls SizeRowObjects for each row.
552 Internal function called by plugins.
553
554
555 \membersection{cbDockPane::SizeRowObjects}\label{cbdockpanesizerowobjects}
556
557 \func{void}{SizeRowObjects}{\param{cbRowInfo* }{pRow}}
558
559 Calls SizeBar for each bar in the row.
560 Internal function called by plugins.
561
562
563 \membersection{cbDockPane::StartDrawInArea}\label{cbdockpanestartdrawinarea}
564
565 \func{wxDC*}{StartDrawInArea}{\param{const wxRect\& }{area}}
566
567 Generates cbStartDrawInAreaEvent and sends it to the layout.
568 Internal function called by plugins.
569
570
571 \membersection{cbDockPane::SyncRowFlags}\label{cbdockpanesyncrowflags}
572
573 \func{void}{SyncRowFlags}{\param{cbRowInfo* }{pRow}}
574
575 Sets up flags in the row information structure, so that
576 they match the changed state of row items correctly.
577 Internal function called by plugins.
578