]> git.saurik.com Git - wxWidgets.git/blob - docs/latex/wx/auipaneinfo.tex
Typo fix
[wxWidgets.git] / docs / latex / wx / auipaneinfo.tex
1 \section{\class{wxAuiPaneInfo}}\label{wxauipaneinfo}
2
3 wxAuiPaneInfo is part of the wxAUI class framework.
4 See also \helpref{wxAUI overview}{wxauioverview}.
5
6 wxAuiPaneInfo specifies all the parameters for a pane.
7 These parameters specify where the pane is on the
8 screen, whether it is docked or floating, or hidden.
9 In addition, these parameters specify the pane's
10 docked position, floating position, preferred size,
11 minimum size, caption text among many other parameters.
12
13 \wxheading{Derived from}
14
15 No base class
16
17 \wxheading{Include files}
18
19 <wx/aui/aui.h>
20
21 \wxheading{See also}
22
23 \helpref{wxAuiManager}{wxauimanager},
24 \helpref{wxAuiDockArt}{wxauidockart}
25
26 \wxheading{Data structures}
27
28 \begin{verbatim}
29 enum wxAuiPaneInsertLevel
30 {
31 wxAUI_INSERT_PANE = 0,
32 wxAUI_INSERT_ROW = 1,
33 wxAUI_INSERT_DOCK = 2
34 }
35 \end{verbatim}
36
37 \latexignore{\rtfignore{\wxheading{Members}}}
38
39
40 \membersection{wxAuiPaneInfo::wxAuiPaneInfo}\label{wxauipaneinfowxauipaneinfo}
41
42 \func{}{wxAuiPaneInfo}{\void}
43
44 Default constructor.
45
46 \func{}{wxAuiPaneInfo}{\param{const wxAuiPaneInfo\& }{c}}
47
48 Copy constructor.
49
50 \membersection{wxAuiPaneInfo::\destruct{wxAuiPaneInfo}}\label{wxauipaneinfodtor}
51
52 \func{}{\destruct{wxAuiPaneInfo}}{\void}
53
54
55 \membersection{wxAuiPaneInfo::BestSize}\label{wxauipaneinfobestsize}
56
57 \func{wxAuiPaneInfo\&}{BestSize}{\param{const wxSize\& }{size}}
58
59 \func{wxAuiPaneInfo\&}{BestSize}{\param{int }{x}, \param{int }{y}}
60
61 BestSize() sets the ideal size for the pane. The docking manager will attempt to use this size as much as possible when docking or floating the pane.
62
63 \membersection{wxAuiPaneInfo::Bottom}\label{wxauipaneinfobottom}
64
65 \func{wxAuiPaneInfo\&}{Bottom}{\void}
66
67 Bottom() sets the pane dock position to the bottom side of the frame. This is
68 the same thing as calling Direction(wxAUI\_DOCK\_BOTTOM).
69
70 \membersection{wxAuiPaneInfo::BottomDockable}\label{wxauipaneinfobottomdockable}
71
72 \func{wxAuiPaneInfo\&}{BottomDockable}{\param{bool }{b = true}}
73
74 BottomDockable() indicates whether a pane can be docked at the bottom of the frame.
75
76 \membersection{wxAuiPaneInfo::Caption}\label{wxauipaneinfocaption}
77
78 \func{wxAuiPaneInfo\&}{Caption}{\param{const wxString\& }{c}}
79
80 Caption() sets the caption of the pane.
81
82 \membersection{wxAuiPaneInfo::CaptionVisible}\label{wxauipaneinfocaptionvisible}
83
84 \func{wxAuiPaneInfo\&}{CaptionVisible}{\param{bool }{visible = true}}
85
86 CaptionVisible indicates that a pane caption should be visible. If false, no pane caption is drawn.
87
88 \membersection{wxAuiPaneInfo::Centre}\label{wxauipaneinfocentre}
89
90 \func{wxAuiPaneInfo\&}{Centre}{\void}
91
92 \func{wxAuiPaneInfo\&}{Center}{\void}
93
94 Center() sets the pane dock position to the left side of the frame.
95 The centre pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout.
96
97 This is the same thing as calling Direction(wxAUI\_DOCK\_CENTRE).
98
99 \membersection{wxAuiPaneInfo::CentrePane}\label{wxauipaneinfocentrepane}
100
101 \func{wxAuiPaneInfo\&}{CentrePane}{\void}
102
103 \func{wxAuiPaneInfo\&}{CenterPane}{\void}
104
105 CentrePane() specifies that the pane should adopt the default center pane settings. Centre panes usually do not have caption bars. This function provides an easy way of preparing a pane to be displayed in the center dock position.
106
107 \membersection{wxAuiPaneInfo::CloseButton}\label{wxauipaneinfoclosebutton}
108
109 \func{wxAuiPaneInfo\&}{CloseButton}{\param{bool }{visible = true}}
110
111 CloseButton() indicates that a close button should be drawn for the pane.
112
113 \membersection{wxAuiPaneInfo::DefaultPane}\label{wxauipaneinfodefaultpane}
114
115 \func{wxAuiPaneInfo\&}{DefaultPane}{\void}
116
117 DefaultPane() specifies that the pane should adopt the default pane settings.
118
119 \membersection{wxAuiPaneInfo::DestroyOnClose}\label{wxauipaneinfodestroyonclose}
120
121 \func{wxAuiPaneInfo\&}{DestroyOnClose}{\param{bool }{b = true}}
122
123 DestroyOnClose() indicates whether a pane should be detroyed when it is closed. Normally a pane is simply hidden when the close button is clicked. Setting DestroyOnClose to true will cause the window to be destroyed when the user clicks the pane's close button.
124
125 \membersection{wxAuiPaneInfo::Direction}\label{wxauipaneinfodirection}
126
127 \func{wxAuiPaneInfo\&}{Direction}{\param{int }{direction}}
128
129 Direction() determines the direction of the docked pane. It is functionally the same as calling Left(), Right(), Top() or Bottom(), except that docking direction may be specified programmatically via the parameter.
130
131 \membersection{wxAuiPaneInfo::Dock}\label{wxauipaneinfodock}
132
133 \func{wxAuiPaneInfo\&}{Dock}{\void}
134
135
136 \membersection{wxAuiPaneInfo::Dockable}\label{wxauipaneinfodockable}
137
138 \func{wxAuiPaneInfo\&}{Dockable}{\param{bool }{b = true}}
139
140 Dockable() specifies whether a frame can be docked or not. It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b).
141
142 \membersection{wxAuiPaneInfo::Fixed}\label{wxauipaneinfofixed}
143
144 \func{wxAuiPaneInfo\&}{Fixed}{\void}
145
146 Fixed() forces a pane to be fixed size so that it cannot be resized. After calling Fixed(), IsFixed() will return true.
147
148 \membersection{wxAuiPaneInfo::Float}\label{wxauipaneinfofloat}
149
150 \func{wxAuiPaneInfo\&}{Float}{\void}
151
152 Float() indicates that a pane should be floated.
153
154 \membersection{wxAuiPaneInfo::Floatable}\label{wxauipaneinfofloatable}
155
156 \func{wxAuiPaneInfo\&}{Floatable}{\param{bool }{b = true}}
157
158 Floatable() sets whether the user will be able to undock a pane and turn it into a floating window.
159
160 \membersection{wxAuiPaneInfo::FloatingPosition}\label{wxauipaneinfofloatingposition}
161
162 \func{wxAuiPaneInfo\&}{FloatingPosition}{\param{const wxPoint\& }{pos}}
163
164 \func{wxAuiPaneInfo\&}{FloatingPosition}{\param{int }{x}, \param{int }{y}}
165
166 FloatingPosition() sets the position of the floating pane.
167
168 \membersection{wxAuiPaneInfo::FloatingSize}\label{wxauipaneinfofloatingsize}
169
170 \func{wxAuiPaneInfo\&}{FloatingSize}{\param{const wxSize\& }{size}}
171
172 \func{wxAuiPaneInfo\&}{FloatingSize}{\param{int }{x}, \param{int }{y}}
173
174 FloatingSize() sets the size of the floating pane.
175
176 \membersection{wxAuiPaneInfo::Gripper}\label{wxauipaneinfogripper}
177
178 \func{wxAuiPaneInfo\&}{Gripper}{\param{bool }{visible = true}}
179
180 Gripper() indicates that a gripper should be drawn for the pane.
181
182 \membersection{wxAuiPaneInfo::GripperTop}\label{wxauipaneinfogrippertop}
183
184 \func{wxAuiPaneInfo\&}{GripperTop}{\param{bool }{attop = true}}
185
186 GripperTop() indicates that a gripper should be drawn at the top of the pane.
187
188 \membersection{wxAuiPaneInfo::HasBorder}\label{wxauipaneinfohasborder}
189
190 \constfunc{bool}{HasBorder}{\void}
191
192 HasBorder() returns true if the pane displays a border.
193
194 \membersection{wxAuiPaneInfo::HasCaption}\label{wxauipaneinfohascaption}
195
196 \constfunc{bool}{HasCaption}{\void}
197
198 HasCaption() returns true if the pane displays a caption.
199
200 \membersection{wxAuiPaneInfo::HasCloseButton}\label{wxauipaneinfohasclosebutton}
201
202 \constfunc{bool}{HasCloseButton}{\void}
203
204 HasCloseButton() returns true if the pane displays a button to close the pane.
205
206 \membersection{wxAuiPaneInfo::HasFlag}\label{wxauipaneinfohasflag}
207
208 \constfunc{bool}{HasFlag}{\param{unsigned int }{flag}}
209
210 HasFlag() returns true if the the property specified by flag is active for the pane.
211
212 \membersection{wxAuiPaneInfo::HasGripper}\label{wxauipaneinfohasgripper}
213
214 \constfunc{bool}{HasGripper}{\void}
215
216 HasGripper() returns true if the pane displays a gripper.
217
218 \membersection{wxAuiPaneInfo::HasGripperTop}\label{wxauipaneinfohasgrippertop}
219
220 \constfunc{bool}{HasGripperTop}{\void}
221
222 HasGripper() returns true if the pane displays a gripper at the top.
223
224 \membersection{wxAuiPaneInfo::HasMaximizeButton}\label{wxauipaneinfohasmaximizebutton}
225
226 \constfunc{bool}{HasMaximizeButton}{\void}
227
228 HasMaximizeButton() returns true if the pane displays a button to maximize the pane.
229
230 \membersection{wxAuiPaneInfo::HasMinimizeButton}\label{wxauipaneinfohasminimizebutton}
231
232 \constfunc{bool}{HasMinimizeButton}{\void}
233
234 HasMinimizeButton() returns true if the pane displays a button to minimize the pane.
235
236 \membersection{wxAuiPaneInfo::HasPinButton}\label{wxauipaneinfohaspinbutton}
237
238 \constfunc{bool}{HasPinButton}{\void}
239
240 HasPinButton() returns true if the pane displays a button to float the pane.
241
242 \membersection{wxAuiPaneInfo::Hide}\label{wxauipaneinfohide}
243
244 \func{wxAuiPaneInfo\&}{Hide}{\void}
245
246 Hide() indicates that a pane should be hidden.
247
248 \membersection{wxAuiPaneInfo::IsBottomDockable}\label{wxauipaneinfoisbottomdockable}
249
250 \constfunc{bool}{IsBottomDockable}{\void}
251
252 IsBottomDockable() returns true if the pane can be docked at the bottom of the managed frame.
253
254 \membersection{wxAuiPaneInfo::IsDocked}\label{wxauipaneinfoisdocked}
255
256 \constfunc{bool}{IsDocked}{\void}
257
258 IsDocked() returns true if the pane is docked.
259
260 \membersection{wxAuiPaneInfo::IsFixed}\label{wxauipaneinfoisfixed}
261
262 \constfunc{bool}{IsFixed}{\void}
263
264 IsFixed() returns true if the pane cannot be resized.
265
266 \membersection{wxAuiPaneInfo::IsFloatable}\label{wxauipaneinfoisfloatable}
267
268 \constfunc{bool}{IsFloatable}{\void}
269
270 IsFloatable() returns true if the pane can be undocked and displayed as a floating window.
271
272 \membersection{wxAuiPaneInfo::IsFloating}\label{wxauipaneinfoisfloating}
273
274 \constfunc{bool}{IsFloating}{\void}
275
276 IsFloating() returns true if the pane is floating.
277
278 \membersection{wxAuiPaneInfo::IsLeftDockable}\label{wxauipaneinfoisleftdockable}
279
280 \constfunc{bool}{IsLeftDockable}{\void}
281
282 IsLeftDockable() returns true if the pane can be docked on the left of the managed frame.
283
284 \membersection{wxAuiPaneInfo::IsMovable}\label{wxauipaneinfoismovable}
285
286 \constfunc{bool}{IsMovable}{\void}
287
288 IsMoveable() returns true if the docked frame can be undocked or moved to another dock position.
289
290 \membersection{wxAuiPaneInfo::IsOk}\label{wxauipaneinfoisok}
291
292 \constfunc{bool}{IsOk}{\void}
293
294 IsOk() returns true if the wxAuiPaneInfo structure is valid. A pane structure is valid if it has an associated window.
295
296 \membersection{wxAuiPaneInfo::IsResizable}\label{wxauipaneinfoisresizable}
297
298 \constfunc{bool}{IsResizable}{\void}
299
300 IsResizable() returns true if the pane can be resized.
301
302 \membersection{wxAuiPaneInfo::IsRightDockable}\label{wxauipaneinfoisrightdockable}
303
304 \constfunc{bool}{IsRightDockable}{\void}
305
306 IsRightDockable() returns true if the pane can be docked on the right of the managed frame.
307
308 \membersection{wxAuiPaneInfo::IsShown}\label{wxauipaneinfoisshown}
309
310 \constfunc{bool}{IsShown}{\void}
311
312 IsShown() returns true if the pane is currently shown.
313
314 \membersection{wxAuiPaneInfo::IsToolbar}\label{wxauipaneinfoistoolbar}
315
316 \constfunc{bool}{IsToolbar}{\void}
317
318 IsToolbar() returns true if the pane contains a toolbar.
319
320 \membersection{wxAuiPaneInfo::IsTopDockable}\label{wxauipaneinfoistopdockable}
321
322 \constfunc{bool}{IsTopDockable}{\void}
323
324 IsTopDockable() returns true if the pane can be docked at the top of the managed frame.
325
326 \membersection{wxAuiPaneInfo::Layer}\label{wxauipaneinfolayer}
327
328 \func{wxAuiPaneInfo\&}{Layer}{\param{int }{layer}}
329
330 Layer() determines the layer of the docked pane. The dock layer is similar to an onion, the inner-most layer being layer 0. Each shell moving in the outward direction has a higher layer number. This allows for more complex docking layout formation.
331
332 \membersection{wxAuiPaneInfo::Left}\label{wxauipaneinfoleft}
333
334 \func{wxAuiPaneInfo\&}{Left}{\void}
335
336 Left() sets the pane dock position to the left side of the frame. This is the
337 same thing as calling Direction(wxAUI\_DOCK\_LEFT).
338
339 \membersection{wxAuiPaneInfo::LeftDockable}\label{wxauipaneinfoleftdockable}
340
341 \func{wxAuiPaneInfo\&}{LeftDockable}{\param{bool }{b = true}}
342
343 LeftDockable() indicates whether a pane can be docked on the left of the frame.
344
345 \membersection{wxAuiPaneInfo::MaxSize}\label{wxauipaneinfomaxsize}
346
347 \func{wxAuiPaneInfo\&}{MaxSize}{\param{const wxSize\& }{size}}
348
349 \func{wxAuiPaneInfo\&}{MaxSize}{\param{int }{x}, \param{int }{y}}
350
351 MaxSize() sets the maximum size of the pane.
352
353 \membersection{wxAuiPaneInfo::MaximizeButton}\label{wxauipaneinfomaximizebutton}
354
355 \func{wxAuiPaneInfo\&}{MaximizeButton}{\param{bool }{visible = true}}
356
357 MaximizeButton() indicates that a maximize button should be drawn for the pane.
358
359 \membersection{wxAuiPaneInfo::MinSize}\label{wxauipaneinfominsize}
360
361 \func{wxAuiPaneInfo\&}{MinSize}{\param{const wxSize\& }{size}}
362
363 \func{wxAuiPaneInfo\&}{MinSize}{\param{int }{x}, \param{int }{y}}
364
365 MinSize() sets the minimum size of the pane. Please note that this is only partially supported as of this writing.
366
367 \membersection{wxAuiPaneInfo::MinimizeButton}\label{wxauipaneinfominimizebutton}
368
369 \func{wxAuiPaneInfo\&}{MinimizeButton}{\param{bool }{visible = true}}
370
371 MinimizeButton() indicates that a minimize button should be drawn for the pane.
372
373 \membersection{wxAuiPaneInfo::Movable}\label{wxauipaneinfomovable}
374
375 \func{wxAuiPaneInfo\&}{Movable}{\param{bool }{b = true}}
376
377 Movable indicates whether a frame can be moved.
378
379 \membersection{wxAuiPaneInfo::Name}\label{wxauipaneinfoname}
380
381 \func{wxAuiPaneInfo\&}{Name}{\param{const wxString\& }{n}}
382
383 Name() sets the name of the pane so it can be referenced in lookup functions. If a name is not specified by the user, a random name is assigned to the pane when it is added to the manager.
384
385 \membersection{wxAuiPaneInfo::PaneBorder}\label{wxauipaneinfopaneborder}
386
387 \func{wxAuiPaneInfo\&}{PaneBorder}{\param{bool }{visible = true}}
388
389 PaneBorder indicates that a border should be drawn for the pane.
390
391 \membersection{wxAuiPaneInfo::PinButton}\label{wxauipaneinfopinbutton}
392
393 \func{wxAuiPaneInfo\&}{PinButton}{\param{bool }{visible = true}}
394
395 PinButton() indicates that a pin button should be drawn for the pane.
396
397 \membersection{wxAuiPaneInfo::Position}\label{wxauipaneinfoposition}
398
399 \func{wxAuiPaneInfo\&}{Position}{\param{int }{pos}}
400
401 Position() determines the position of the docked pane.
402
403 \membersection{wxAuiPaneInfo::Resizable}\label{wxauipaneinforesizable}
404
405 \func{wxAuiPaneInfo\&}{Resizable}{\param{bool }{resizable = true}}
406
407 Resizable() allows a pane to be resized if the parameter is true, and forces it to be a fixed size if the parameter is false. This is simply an antonym for Fixed().
408
409 \membersection{wxAuiPaneInfo::Right}\label{wxauipaneinforight}
410
411 \func{wxAuiPaneInfo\&}{Right}{\void}
412
413 Right() sets the pane dock position to the right side of the frame.
414
415 \membersection{wxAuiPaneInfo::RightDockable}\label{wxauipaneinforightdockable}
416
417 \func{wxAuiPaneInfo\&}{RightDockable}{\param{bool }{b = true}}
418
419 RightDockable() indicates whether a pane can be docked on the right of the frame.
420
421 \membersection{wxAuiPaneInfo::Row}\label{wxauipaneinforow}
422
423 \func{wxAuiPaneInfo\&}{Row}{\param{int }{row}}
424
425 Row() determines the row of the docked pane.
426
427 \membersection{wxAuiPaneInfo::SafeSet}\label{wxauipaneinfosafeset}
428
429 \func{void}{SafeSet}{\param{wxAuiPaneInfo }{source}}
430
431 Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
432 used on loading perspectives etc.
433
434 \membersection{wxAuiPaneInfo::SetFlag}\label{wxauipaneinfosetflag}
435
436 \func{wxAuiPaneInfo\&}{SetFlag}{\param{unsigned int }{flag}, \param{bool }{option\_state}}
437
438 SetFlag() turns the property given by flag on or off with the option\_state parameter.
439
440 \membersection{wxAuiPaneInfo::Show}\label{wxauipaneinfoshow}
441
442 \func{wxAuiPaneInfo\&}{Show}{\param{bool }{show = true}}
443
444 Show() indicates that a pane should be shown.
445
446 \membersection{wxAuiPaneInfo::ToolbarPane}\label{wxauipaneinfotoolbarpane}
447
448 \func{wxAuiPaneInfo\&}{ToolbarPane}{\void}
449
450 ToolbarPane() specifies that the pane should adopt the default toolbar pane settings.
451
452 \membersection{wxAuiPaneInfo::Top}\label{wxauipaneinfotop}
453
454 \func{wxAuiPaneInfo\&}{Top}{\void}
455
456 Top() sets the pane dock position to the top of the frame.
457
458 \membersection{wxAuiPaneInfo::TopDockable}\label{wxauipaneinfotopdockable}
459
460 \func{wxAuiPaneInfo\&}{TopDockable}{\param{bool }{b = true}}
461
462 TopDockable() indicates whether a pane can be docked at the top of the frame.
463
464 \membersection{wxAuiPaneInfo::Window}\label{wxauipaneinfowindow}
465
466 \func{wxAuiPaneInfo\&}{Window}{\param{wxWindow* }{w}}
467
468 Window() assigns the window pointer that the wxAuiPaneInfo should use. This normally does not need to be specified, as the window pointer is automatically assigned to the wxAuiPaneInfo structure as soon as it is added to the manager.
469
470 \membersection{wxAuiPaneInfo::operator=}\label{wxauipaneinfooperatorassign}
471
472 \func{wxAuiPaneInfo\& operator}{operator=}{\param{const wxAuiPaneInfo\& }{c}}
473
474 Makes a copy of the wxAuiPaneInfo object.
475