]> git.saurik.com Git - wxWidgets.git/blame_incremental - contrib/docs/latex/fl/cbdockpane.tex
Fixed a typemap.
[wxWidgets.git] / contrib / docs / latex / fl / cbdockpane.tex
... / ...
CommitLineData
1%
2% automatically generated by HelpGen $Revision$ from
3% controlbar.h at 05/Jan/02 22:50:59
4%
5
6
7\section{\class{cbDockPane}}\label{cbdockpane}
8
9
10class 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{Data structures}
18
19\latexignore{\rtfignore{\wxheading{Members}}}
20
21
22\membersection{cbDockPane::cbDockPane}\label{cbdockpanecbdockpane}
23
24\func{}{cbDockPane}{\param{int }{alignment}, \param{wxFrameLayout* }{pPanel}}
25
26
27\func{}{cbDockPane}{\void}
28
29public members
30
31\membersection{cbDockPane::\destruct{cbDockPane}}\label{cbdockpanedtor}
32
33\func{}{\destruct{cbDockPane}}{\void}
34
35
36\membersection{cbDockPane::BarPresent}\label{cbdockpanebarpresent}
37
38\func{bool}{BarPresent}{\param{cbBarInfo* }{pBar}}
39
40TRUE, if the given bar node presents in this pane
41
42
43\membersection{cbDockPane::CalcLengthRatios}\label{cbdockpanecalclengthratios}
44
45\func{void}{CalcLengthRatios}{\param{cbRowInfo* }{pInRow}}
46
47
48\membersection{cbDockPane::ContractBar}\label{cbdockpanecontractbar}
49
50\func{void}{ContractBar}{\param{cbBarInfo* }{pBar}}
51
52
53\membersection{cbDockPane::DoInsertBar}\label{cbdockpanedoinsertbar}
54
55\func{void}{DoInsertBar}{\param{cbBarInfo* }{pBar}, \param{int }{rowNo}}
56
57
58\membersection{cbDockPane::DrawHorizHandle}\label{cbdockpanedrawhorizhandle}
59
60\func{void}{DrawHorizHandle}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{width}}
61
62
63\membersection{cbDockPane::DrawVertHandle}\label{cbdockpanedrawverthandle}
64
65\func{void}{DrawVertHandle}{\param{wxDC\& }{dc}, \param{int }{x}, \param{int }{y}, \param{int }{height}}
66
67protected really (accessed only by plugins) row/bar resizing related helper-methods
68
69
70\membersection{cbDockPane::ExpandBar}\label{cbdockpaneexpandbar}
71
72\func{void}{ExpandBar}{\param{cbBarInfo* }{pBar}}
73
74
75\membersection{cbDockPane::FinishDrawInArea}\label{cbdockpanefinishdrawinarea}
76
77\func{void}{FinishDrawInArea}{\param{const wxRect\& }{area}}
78
79
80\membersection{cbDockPane::FrameToPane}\label{cbdockpaneframetopane}
81
82\func{void}{FrameToPane}{\param{wxRect* }{pRect}}
83
84
85\func{void}{FrameToPane}{\param{int* }{x}, \param{int* }{y}}
86
87coordinate translation between parent's frame and this pane
88
89
90\membersection{cbDockPane::GetAlignment}\label{cbdockpanegetalignment}
91
92\func{int}{GetAlignment}{\void}
93
94
95\membersection{cbDockPane::GetBarInfoByWindow}\label{cbdockpanegetbarinfobywindow}
96
97\func{cbBarInfo*}{GetBarInfoByWindow}{\param{wxWindow* }{pBarWnd}}
98
99
100\membersection{cbDockPane::GetBarResizeRange}\label{cbdockpanegetbarresizerange}
101
102\func{void}{GetBarResizeRange}{\param{cbBarInfo* }{pBar}, \param{int* }{from}, \param{int* }{till}, \param{bool }{forLeftHandle}}
103
104
105\membersection{cbDockPane::GetDockingState}\label{cbdockpanegetdockingstate}
106
107\func{int}{GetDockingState}{\void}
108
109
110\membersection{cbDockPane::GetFirstRow}\label{cbdockpanegetfirstrow}
111
112\func{cbRowInfo*}{GetFirstRow}{\void}
113
114convenience method
115
116
117\membersection{cbDockPane::GetMinimalRowHeight}\label{cbdockpanegetminimalrowheight}
118
119\func{int}{GetMinimalRowHeight}{\param{cbRowInfo* }{pRow}}
120
121
122\membersection{cbDockPane::GetNotFixedBarsCount}\label{cbdockpanegetnotfixedbarscount}
123
124\func{int}{GetNotFixedBarsCount}{\param{cbRowInfo* }{pRow}}
125
126
127\membersection{cbDockPane::GetPaneHeight}\label{cbdockpanegetpaneheight}
128
129\func{int}{GetPaneHeight}{\void}
130
131retuns height, in pane's coordinates
132
133
134\membersection{cbDockPane::GetRealRect}\label{cbdockpanegetrealrect}
135
136\func{wxRect\&}{GetRealRect}{\void}
137
138
139\membersection{cbDockPane::GetRow}\label{cbdockpanegetrow}
140
141\func{cbRowInfo*}{GetRow}{\param{int }{row}}
142
143protected really (accessed only by plugins)
144
145\membersection{cbDockPane::GetRowAt}\label{cbdockpanegetrowat}
146
147\func{int}{GetRowAt}{\param{int }{upperY}, \param{int }{lowerY}}
148
149
150\func{int}{GetRowAt}{\param{int }{paneY}}
151
152return -1, if row is not present at given vertical position
153
154
155\membersection{cbDockPane::GetRowIndex}\label{cbdockpanegetrowindex}
156
157\func{int}{GetRowIndex}{\param{cbRowInfo* }{pRow}}
158
159
160\membersection{cbDockPane::GetRowList}\label{cbdockpanegetrowlist}
161
162\func{RowArrayT\&}{GetRowList}{\void}
163
164used by updates-managers
165
166
167\membersection{cbDockPane::GetRowResizeRange}\label{cbdockpanegetrowresizerange}
168
169\func{void}{GetRowResizeRange}{\param{cbRowInfo* }{pRow}, \param{int* }{from}, \param{int* }{till}, \param{bool }{forUpperHandle}}
170
171
172\membersection{cbDockPane::GetRowShapeData}\label{cbdockpanegetrowshapedata}
173
174\func{void}{GetRowShapeData}{\param{cbRowInfo* }{pRow}, \param{wxList* }{pLst}}
175
176cbBarShapeData objects will be placed to given pLst (see comments on cbBarShapeData)
177
178
179\membersection{cbDockPane::GetRowWidth}\label{cbdockpanegetrowwidth}
180
181\func{int}{GetRowWidth}{\param{wxList* }{pRow}}
182
183
184\membersection{cbDockPane::GetRowY}\label{cbdockpanegetrowy}
185
186\func{int}{GetRowY}{\param{cbRowInfo* }{pRow}}
187
188
189\membersection{cbDockPane::HasNotFixedBarsLeft}\label{cbdockpanehasnotfixedbarsleft}
190
191\func{bool}{HasNotFixedBarsLeft}{\param{cbBarInfo* }{pBar}}
192
193
194\membersection{cbDockPane::HasNotFixedBarsRight}\label{cbdockpanehasnotfixedbarsright}
195
196\func{bool}{HasNotFixedBarsRight}{\param{cbBarInfo* }{pBar}}
197
198
199\membersection{cbDockPane::HasNotFixedRowsAbove}\label{cbdockpanehasnotfixedrowsabove}
200
201\func{bool}{HasNotFixedRowsAbove}{\param{cbRowInfo* }{pRow}}
202
203
204\membersection{cbDockPane::HasNotFixedRowsBelow}\label{cbdockpanehasnotfixedrowsbelow}
205
206\func{bool}{HasNotFixedRowsBelow}{\param{cbRowInfo* }{pRow}}
207
208
209\membersection{cbDockPane::HasPoint}\label{cbdockpanehaspoint}
210
211\func{bool}{HasPoint}{\param{const wxPoint\& }{pos}, \param{int }{x}, \param{int }{y}, \param{int }{width}, \param{int }{height}}
212
213
214\membersection{cbDockPane::HitTestPaneItems}\label{cbdockpanehittestpaneitems}
215
216\func{int}{HitTestPaneItems}{\param{const wxPoint\& }{pos}, \param{cbRowInfo** }{ppRow}, \param{cbBarInfo** }{ppBar}}
217
218returns result of hit-testing items in the pane,
219see CB\_HITTEST\_RESULTS enumeration
220position in pane's coordinates
221
222
223\membersection{cbDockPane::InitLinksForRow}\label{cbdockpaneinitlinksforrow}
224
225\func{void}{InitLinksForRow}{\param{cbRowInfo* }{pRow}}
226
227
228\membersection{cbDockPane::InitLinksForRows}\label{cbdockpaneinitlinksforrows}
229
230\func{void}{InitLinksForRows}{\void}
231
232
233\membersection{cbDockPane::InsertBar}\label{cbdockpaneinsertbar}
234
235\func{void}{InsertBar}{\param{cbBarInfo* }{pBar}, \param{const wxRect\& }{atRect}}
236
237rect given in the parent frame's coordinates
238
239
240\func{void}{InsertBar}{\param{cbBarInfo* }{pBar}, \param{cbRowInfo* }{pIntoRow}}
241
242inserts bar into the given row, with dimensions and position
243stored in pBarInfo->mBounds. Returns the node of inserted bar
244
245
246\func{void}{InsertBar}{\param{cbBarInfo* }{pBarInfo}}
247
248inserts bar, sets its position according to the preferred settings
249given in (*pBarInfo) structure
250
251
252\membersection{cbDockPane::InsertRow}\label{cbdockpaneinsertrow}
253
254\func{void}{InsertRow}{\param{cbRowInfo* }{pRow}, \param{cbRowInfo* }{pBeforeRow}}
255
256does not refresh the inserted row immediately,
257if pBeforeRowNode arg. is NULL, row is appended to the end of pane's row list
258
259
260\membersection{cbDockPane::IsFixedSize}\label{cbdockpaneisfixedsize}
261
262\func{bool}{IsFixedSize}{\param{cbBarInfo* }{pInfo}}
263
264layout "AI" helpers:
265
266
267\membersection{cbDockPane::IsHorizontal}\label{cbdockpaneishorizontal}
268
269\func{bool}{IsHorizontal}{\void}
270
271
272\membersection{cbDockPane::MatchesMask}\label{cbdockpanematchesmask}
273
274\func{bool}{MatchesMask}{\param{int }{paneMask}}
275
276
277\membersection{cbDockPane::PaintBar}\label{cbdockpanepaintbar}
278
279\func{void}{PaintBar}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
280
281
282\membersection{cbDockPane::PaintBarDecorations}\label{cbdockpanepaintbardecorations}
283
284\func{void}{PaintBarDecorations}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
285
286protected really (accessed only by plugins) methods for incramental on-screen refreshing of the pane
287(simply, they are wrappers around corresponding plugin-events)
288
289
290\membersection{cbDockPane::PaintBarHandles}\label{cbdockpanepaintbarhandles}
291
292\func{void}{PaintBarHandles}{\param{cbBarInfo* }{pBar}, \param{wxDC\& }{dc}}
293
294
295\membersection{cbDockPane::PaintPane}\label{cbdockpanepaintpane}
296
297\func{void}{PaintPane}{\param{wxDC\& }{dc}}
298
299
300\membersection{cbDockPane::PaintPaneBackground}\label{cbdockpanepaintpanebackground}
301
302\func{void}{PaintPaneBackground}{\param{wxDC\& }{dc}}
303
304
305\membersection{cbDockPane::PaintPaneDecorations}\label{cbdockpanepaintpanedecorations}
306
307\func{void}{PaintPaneDecorations}{\param{wxDC\& }{dc}}
308
309
310\membersection{cbDockPane::PaintRow}\label{cbdockpanepaintrow}
311
312\func{void}{PaintRow}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
313
314
315\membersection{cbDockPane::PaintRowBackground}\label{cbdockpanepaintrowbackground}
316
317\func{void}{PaintRowBackground}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
318
319
320\membersection{cbDockPane::PaintRowDecorations}\label{cbdockpanepaintrowdecorations}
321
322\func{void}{PaintRowDecorations}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
323
324
325\membersection{cbDockPane::PaintRowHandles}\label{cbdockpanepaintrowhandles}
326
327\func{void}{PaintRowHandles}{\param{cbRowInfo* }{pRow}, \param{wxDC\& }{dc}}
328
329
330\membersection{cbDockPane::PaneToFrame}\label{cbdockpanepanetoframe}
331
332\func{void}{PaneToFrame}{\param{wxRect* }{pRect}}
333
334
335\func{void}{PaneToFrame}{\param{int* }{x}, \param{int* }{y}}
336
337
338\membersection{cbDockPane::RecalcLayout}\label{cbdockpanerecalclayout}
339
340\func{void}{RecalcLayout}{\void}
341
342
343\membersection{cbDockPane::RecalcRowLayout}\label{cbdockpanerecalcrowlayout}
344
345\func{void}{RecalcRowLayout}{\param{cbRowInfo* }{pRow}}
346
347
348\membersection{cbDockPane::RemoveBar}\label{cbdockpaneremovebar}
349
350\func{void}{RemoveBar}{\param{cbBarInfo* }{pBar}}
351
352does not destroys the info bar , only removes it's reference
353from this pane
354
355
356\membersection{cbDockPane::RemoveRow}\label{cbdockpaneremoverow}
357
358\func{void}{RemoveRow}{\param{cbRowInfo* }{pRow}}
359
360does not destroy the row object, only removes the corresponding
361node from this pane
362
363
364\membersection{cbDockPane::ResizeBar}\label{cbdockpaneresizebar}
365
366\func{void}{ResizeBar}{\param{cbBarInfo* }{pBar}, \param{int }{ofs}, \param{bool }{forLeftHandle}}
367
368
369\membersection{cbDockPane::ResizeRow}\label{cbdockpaneresizerow}
370
371\func{void}{ResizeRow}{\param{cbRowInfo* }{pRow}, \param{int }{ofs}, \param{bool }{forUpperHandle}}
372
373
374\membersection{cbDockPane::SetBoundsInParent}\label{cbdockpanesetboundsinparent}
375
376\func{void}{SetBoundsInParent}{\param{const wxRect\& }{rect}}
377
378set the position and dims. of the pane in parent frame's coordinates
379
380
381\membersection{cbDockPane::SetMargins}\label{cbdockpanesetmargins}
382
383\func{void}{SetMargins}{\param{int }{top}, \param{int }{bottom}, \param{int }{left}, \param{int }{right}}
384
385sets pane's margins in frame's coordinate orientations
386
387
388\membersection{cbDockPane::SetPaneWidth}\label{cbdockpanesetpanewidth}
389
390\func{void}{SetPaneWidth}{\param{int }{width}}
391
392sets pane's width in pane's coordinates (including margins)
393
394
395\membersection{cbDockPane::SetRowHeight}\label{cbdockpanesetrowheight}
396
397\func{void}{SetRowHeight}{\param{cbRowInfo* }{pRow}, \param{int }{newHeight}}
398
399given row height includes height of row handles, if present
400
401
402\membersection{cbDockPane::SetRowShapeData}\label{cbdockpanesetrowshapedata}
403
404\func{void}{SetRowShapeData}{\param{cbRowInfo* }{pRowNode}, \param{wxList* }{pLst}}
405
406sets the shape to the given row, using the data provided in pLst
407
408
409\membersection{cbDockPane::SizeBar}\label{cbdockpanesizebar}
410
411\func{void}{SizeBar}{\param{cbBarInfo* }{pBar}}
412
413
414\membersection{cbDockPane::SizePaneObjects}\label{cbdockpanesizepaneobjects}
415
416\func{void}{SizePaneObjects}{\void}
417
418
419\membersection{cbDockPane::SizeRowObjects}\label{cbdockpanesizerowobjects}
420
421\func{void}{SizeRowObjects}{\param{cbRowInfo* }{pRow}}
422
423
424\membersection{cbDockPane::StartDrawInArea}\label{cbdockpanestartdrawinarea}
425
426\func{wxDC*}{StartDrawInArea}{\param{const wxRect\& }{area}}
427
428
429\membersection{cbDockPane::SyncRowFlags}\label{cbdockpanesyncrowflags}
430
431\func{void}{SyncRowFlags}{\param{cbRowInfo* }{pRow}}
432
433re-setups flags in the row-information structure, so that
434the would match the changed state of row-items correctly
435