]> git.saurik.com Git - wxWidgets.git/blame_incremental - contrib/docs/latex/fl/cbdockpane.tex
corrected version number extraction
[wxWidgets.git] / contrib / docs / latex / fl / cbdockpane.tex
... / ...
CommitLineData
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
10This class manages containment and control of control bars
11along 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
30Constructor, taking alignment and layout panel.
31
32
33\func{}{cbDockPane}{\void}
34
35public members Default constructor.
36
37
38\membersection{cbDockPane::\destruct{cbDockPane}}\label{cbdockpanedtor}
39
40\func{}{\destruct{cbDockPane}}{\void}
41
42Destructor.
43
44
45\membersection{cbDockPane::BarPresent}\label{cbdockpanebarpresent}
46
47\func{bool}{BarPresent}{\param{cbBarInfo* }{pBar}}
48
49Returns 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
56Calculate lengths.
57Internal function called by plugins.
58
59
60\membersection{cbDockPane::ContractBar}\label{cbdockpanecontractbar}
61
62\func{void}{ContractBar}{\param{cbBarInfo* }{pBar}}
63
64Contracts the bar.
65Internal function called by plugins.
66
67
68\membersection{cbDockPane::DoInsertBar}\label{cbdockpanedoinsertbar}
69
70\func{void}{DoInsertBar}{\param{cbBarInfo* }{pBar}, \param{int }{rowNo}}
71
72Inserts the bar at the given row number.
73Internal 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
80Row/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
87protected 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
94Expands the bar.
95Internal function called by plugins.
96
97
98\membersection{cbDockPane::FinishDrawInArea}\label{cbdockpanefinishdrawinarea}
99
100\func{void}{FinishDrawInArea}{\param{const wxRect\& }{area}}
101
102Generates cbFinishDrawInAreaEvent and sends it to the layout.
103Internal function called by plugins.
104
105
106\membersection{cbDockPane::FrameToPane}\label{cbdockpaneframetopane}
107
108\func{void}{FrameToPane}{\param{int* }{x}, \param{int* }{y}}
109
110Coordinate translation between parent's frame and this pane.
111Internal function called by plugins.
112
113
114\func{void}{FrameToPane}{\param{wxRect* }{pRect}}
115
116Coordinate translation between parent's frame and this pane.
117Internal function called by plugins.
118
119
120\membersection{cbDockPane::GetAlignment}\label{cbdockpanegetalignment}
121
122\func{int}{GetAlignment}{\void}
123
124Returns the alignment for this pane. The value is one of
125FL\_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
132Finds 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
139Returns the bar's resize range.
140
141
142\membersection{cbDockPane::GetDockingState}\label{cbdockpanegetdockingstate}
143
144\func{int}{GetDockingState}{\void}
145
146Returns wxCBAR\_DOCKED\_HORIZONTALLY if the alignment is top or bottom,
147or wxCBAR\_DOCKED\_VERTICALLY otherwise.
148
149
150\membersection{cbDockPane::GetFirstRow}\label{cbdockpanegetfirstrow}
151
152\func{cbRowInfo*}{GetFirstRow}{\void}
153
154Returns the first row.
155
156
157\membersection{cbDockPane::GetMinimalRowHeight}\label{cbdockpanegetminimalrowheight}
158
159\func{int}{GetMinimalRowHeight}{\param{cbRowInfo* }{pRow}}
160
161Returns the minimal row height for the given row.
162Internal function called by plugins.
163
164
165\membersection{cbDockPane::GetNotFixedBarsCount}\label{cbdockpanegetnotfixedbarscount}
166
167\func{int}{GetNotFixedBarsCount}{\param{cbRowInfo* }{pRow}}
168
169Returns the number of bars whose size is not fixed.
170Internal function called by plugins.
171
172
173\membersection{cbDockPane::GetPaneHeight}\label{cbdockpanegetpaneheight}
174
175\func{int}{GetPaneHeight}{\void}
176
177Returns the height in the pane's coordinates.
178
179
180\membersection{cbDockPane::GetRealRect}\label{cbdockpanegetrealrect}
181
182\func{wxRect\&}{GetRealRect}{\void}
183
184Returns 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
191protected 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
198Returns the row at the given vertical position.
199Returns -1 if the row is not present at given vertical position.
200Internal function called by plugins.
201
202
203\func{int}{GetRowAt}{\param{int }{upperY}, \param{int }{lowerY}}
204
205Returns the row between the given vertical positions.
206Returns -1 if the row is not present.
207Internal function called by plugins.
208
209
210\membersection{cbDockPane::GetRowIndex}\label{cbdockpanegetrowindex}
211
212\func{int}{GetRowIndex}{\param{cbRowInfo* }{pRow}}
213
214Returns 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
221Returns 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
228Returns 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
235Returns row shape data.
236cbBarShapeData objects will be added to the given pLst.
237cbBarShapeData is used for storing the original bar's positions in the row,
238when 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
245Gets the vertical position at the given row.
246Internal function called by plugins.
247
248
249\membersection{cbDockPane::HasNotFixedBarsLeft}\label{cbdockpanehasnotfixedbarsleft}
250
251\func{bool}{HasNotFixedBarsLeft}{\param{cbBarInfo* }{pBar}}
252
253Returns TRUE if there are any variable-sized rows to the left of this one.
254Internal function called by plugins.
255
256
257\membersection{cbDockPane::HasNotFixedBarsRight}\label{cbdockpanehasnotfixedbarsright}
258
259\func{bool}{HasNotFixedBarsRight}{\param{cbBarInfo* }{pBar}}
260
261Returns TRUE if there are any variable-sized rows to the right of this one.
262Internal function called by plugins.
263
264
265\membersection{cbDockPane::HasNotFixedRowsAbove}\label{cbdockpanehasnotfixedrowsabove}
266
267\func{bool}{HasNotFixedRowsAbove}{\param{cbRowInfo* }{pRow}}
268
269Returns TRUE if there are any variable-sized rows above this one.
270Internal function called by plugins.
271
272
273\membersection{cbDockPane::HasNotFixedRowsBelow}\label{cbdockpanehasnotfixedrowsbelow}
274
275\func{bool}{HasNotFixedRowsBelow}{\param{cbRowInfo* }{pRow}}
276
277Returns TRUE if there are any variable-sized rows below this one.
278Internal 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
285Returns TRUE if pos is within the given rectangle.
286Internal 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
293Returns the result of hit-testing items in the pane.
294See CB\_HITTEST\_RESULT enumerated type.
295pos 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
302Sets up links between bars.
303Internal function called by plugins.
304
305
306\membersection{cbDockPane::InitLinksForRows}\label{cbdockpaneinitlinksforrows}
307
308\func{void}{InitLinksForRows}{\void}
309
310Sets up links between bars.
311Internal function called by plugins.
312
313
314\membersection{cbDockPane::InsertBar}\label{cbdockpaneinsertbar}
315
316\func{void}{InsertBar}{\param{cbBarInfo* }{pBarInfo}}
317
318Inserts bar and sets its position according to the preferred settings
319given in pBarInfo.
320
321
322\func{void}{InsertBar}{\param{cbBarInfo* }{pBar}, \param{const wxRect\& }{rect}}
323
324Inserts 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
329Inserts the bar into the given row, with dimensions and position
330stored 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
337Inserts a row. Does not refresh the inserted row immediately.
338If 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
345Returns TRUE if the bar's dimension information indicates a fixed size.
346Internal function called by plugins.
347
348
349\membersection{cbDockPane::IsHorizontal}\label{cbdockpaneishorizontal}
350
351\func{bool}{IsHorizontal}{\void}
352
353Returns 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
360Returns 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
367Calls PaintBarDecorations and PaintBarHandles.
368Internal function called by plugins.
369
370
371\membersection{cbDockPane::PaintBarDecorations}\label{cbdockpanepaintbardecorations}
372
373\func{void}{PaintBarDecorations}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
374
375protected really (accessed only by plugins) Generates a cbDrawBarDecorEvent and sends it to the layout to paint the bar decorations.
376Internal function called by plugins.
377
378
379\membersection{cbDockPane::PaintBarHandles}\label{cbdockpanepaintbarhandles}
380
381\func{void}{PaintBarHandles}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
382
383Generates a cbDrawBarHandlesEvent and sends it to the layout to paint the bar handles.
384Internal function called by plugins.
385
386
387\membersection{cbDockPane::PaintPane}\label{cbdockpanepaintpane}
388
389\func{void}{PaintPane}{\param{wxDC\& }{dc}}
390
391Paints the pane background, the row background and decorations,
392and finally the pane decorations.
393Internal function called by plugins.
394
395
396\membersection{cbDockPane::PaintPaneBackground}\label{cbdockpanepaintpanebackground}
397
398\func{void}{PaintPaneBackground}{\param{wxDC\& }{dc}}
399
400Generates cbDrawPaneBkGroundEvent and sends it to the layout.
401Internal function called by plugins.
402
403
404\membersection{cbDockPane::PaintPaneDecorations}\label{cbdockpanepaintpanedecorations}
405
406\func{void}{PaintPaneDecorations}{\param{wxDC\& }{dc}}
407
408Generates cbDrawPaneDecorEvent and sends it to the layout.
409Internal function called by plugins.
410
411
412\membersection{cbDockPane::PaintRow}\label{cbdockpanepaintrow}
413
414\func{void}{PaintRow}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
415
416Calls PaintRowBackground, PaintRowDecorations, PaintRowHandles.
417Internal function called by plugins.
418
419
420\membersection{cbDockPane::PaintRowBackground}\label{cbdockpanepaintrowbackground}
421
422\func{void}{PaintRowBackground}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
423
424Generates cbDrawRowBkGroundEvent and sends it to the layout.
425Internal function called by plugins.
426
427
428\membersection{cbDockPane::PaintRowDecorations}\label{cbdockpanepaintrowdecorations}
429
430\func{void}{PaintRowDecorations}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
431
432Calls PaintBarDecorations for each row.
433Internal function called by plugins.
434
435
436\membersection{cbDockPane::PaintRowHandles}\label{cbdockpanepaintrowhandles}
437
438\func{void}{PaintRowHandles}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
439
440Generates cbDrawRowHandlesEvent and cbDrawRowDecorEvent and sends them to the layout.
441Internal function called by plugins.
442
443
444\membersection{cbDockPane::PaneToFrame}\label{cbdockpanepanetoframe}
445
446\func{void}{PaneToFrame}{\param{wxRect* }{pRect}}
447
448Coordinate translation between parent's frame and this pane.
449Internal function called by plugins.
450
451
452\func{void}{PaneToFrame}{\param{int* }{x}, \param{int* }{y}}
453
454Coordinate translation between parent's frame and this pane.
455Internal function called by plugins.
456
457
458\membersection{cbDockPane::RecalcLayout}\label{cbdockpanerecalclayout}
459
460\func{void}{RecalcLayout}{\void}
461
462Generates events to perform layout calculations.
463
464
465\membersection{cbDockPane::RecalcRowLayout}\label{cbdockpanerecalcrowlayout}
466
467\func{void}{RecalcRowLayout}{\param{cbRowInfo* }{pRow}}
468
469Generates a cbLayoutRowEvent event to recalculate row layouts.
470Internal function called by plugins.
471
472
473\membersection{cbDockPane::RemoveBar}\label{cbdockpaneremovebar}
474
475\func{void}{RemoveBar}{\param{cbBarInfo* }{pBar}}
476
477Removes 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
484Removes 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
491Row/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
498Row/bar resizing related helper-method.
499
500
501\membersection{cbDockPane::SetBoundsInParent}\label{cbdockpanesetboundsinparent}
502
503\func{void}{SetBoundsInParent}{\param{const wxRect\& }{rect}}
504
505Set 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
512Sets 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
519Sets 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
526Sets the row height for the given height. newHeight includes the height of row handles, if present.
527Internal function called by plugins.
528
529
530\membersection{cbDockPane::SetRowShapeData}\label{cbdockpanesetrowshapedata}
531
532\func{void}{SetRowShapeData}{\param{cbRowInfo* }{pRowNode}, \param{wxList* }{pLst}}
533
534Sets the shape data for the given row, using the data provided in pLst.
535cbBarShapeData is used for storing the original bar's positions in the row,
536when 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
543Generates a cbSizeBarWndEvent and sends it to the layout.
544Internal function called by plugins.
545
546
547\membersection{cbDockPane::SizePaneObjects}\label{cbdockpanesizepaneobjects}
548
549\func{void}{SizePaneObjects}{\void}
550
551Calls SizeRowObjects for each row.
552Internal function called by plugins.
553
554
555\membersection{cbDockPane::SizeRowObjects}\label{cbdockpanesizerowobjects}
556
557\func{void}{SizeRowObjects}{\param{cbRowInfo* }{pRow}}
558
559Calls SizeBar for each bar in the row.
560Internal function called by plugins.
561
562
563\membersection{cbDockPane::StartDrawInArea}\label{cbdockpanestartdrawinarea}
564
565\func{wxDC*}{StartDrawInArea}{\param{const wxRect\& }{area}}
566
567Generates cbStartDrawInAreaEvent and sends it to the layout.
568Internal function called by plugins.
569
570
571\membersection{cbDockPane::SyncRowFlags}\label{cbdockpanesyncrowflags}
572
573\func{void}{SyncRowFlags}{\param{cbRowInfo* }{pRow}}
574
575Sets up flags in the row information structure, so that
576they match the changed state of row items correctly.
577Internal function called by plugins.
578