1 \section{\class{wxAuiPaneInfo
}}\label{wxauipaneinfo
}
3 wxAuiPaneInfo is part of the wxAUI class framework.
4 See also
\helpref{wxAUI overview
}{wxauioverview
}.
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.
13 \wxheading{Derived from
}
17 \wxheading{Include files
}
23 \helpref{wxAuiManager
}{wxauimanager
}
25 \wxheading{Data structures
}
28 enum wxPaneDockArtSetting
30 wxAUI_ART_SASH_SIZE =
0,
31 wxAUI_ART_CAPTION_SIZE =
1,
32 wxAUI_ART_GRIPPER_SIZE =
2,
33 wxAUI_ART_PANE_BORDER_SIZE =
3,
34 wxAUI_ART_PANE_BUTTON_SIZE =
4,
35 wxAUI_ART_BACKGROUND_COLOUR =
5,
36 wxAUI_ART_SASH_COLOUR =
6,
37 wxAUI_ART_ACTIVE_CAPTION_COLOUR =
7,
38 wxAUI_ART_ACTIVE_CAPTION_GRADIENT_COLOUR =
8,
39 wxAUI_ART_INACTIVE_CAPTION_COLOUR =
9,
40 wxAUI_ART_INACTIVE_CAPTION_GRADIENT_COLOUR =
10,
41 wxAUI_ART_ACTIVE_CAPTION_TEXT_COLOUR =
11,
42 wxAUI_ART_INACTIVE_CAPTION_TEXT_COLOUR =
12,
43 wxAUI_ART_BORDER_COLOUR =
13,
44 wxAUI_ART_GRIPPER_COLOUR =
14,
45 wxAUI_ART_CAPTION_FONT =
15,
46 wxAUI_ART_GRADIENT_TYPE =
16
51 enum wxPaneDockArtGradients
53 wxAUI_GRADIENT_NONE =
0,
54 wxAUI_GRADIENT_VERTICAL =
1,
55 wxAUI_GRADIENT_HORIZONTAL =
2
60 enum wxPaneButtonState
62 wxAUI_BUTTON_STATE_NORMAL =
0,
63 wxAUI_BUTTON_STATE_HOVER =
1,
64 wxAUI_BUTTON_STATE_PRESSED =
2
69 enum wxPaneInsertLevel
71 wxAUI_INSERT_PANE =
0,
77 \latexignore{\rtfignore{\wxheading{Members
}}}
80 \membersection{wxAuiPaneInfo::wxAuiPaneInfo
}\label{wxauipaneinfowxauipaneinfo
}
82 \func{}{wxAuiPaneInfo
}{\void}
85 \func{}{wxAuiPaneInfo
}{\param{const wxAuiPaneInfo\&
}{c
}}
88 \membersection{wxAuiPaneInfo::
\destruct{wxAuiPaneInfo
}}\label{wxauipaneinfodtor
}
90 \func{}{\destruct{wxAuiPaneInfo
}}{\void}
93 \membersection{wxAuiPaneInfo::BestSize
}\label{wxauipaneinfobestsize
}
95 \func{wxAuiPaneInfo\&
}{BestSize
}{\param{const wxSize\&
}{size
}}
96 \func{wxAuiPaneInfo\&
}{BestSize
}{\param{int
}{x
},
\param{int
}{y
}}
98 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.
100 \membersection{wxAuiPaneInfo::Bottom
}\label{wxauipaneinfobottom
}
102 \func{wxAuiPaneInfo\&
}{Bottom
}{\void}
104 Bottom() sets the pane dock position to the bottom side of the frame. This is the same thing as calling Direction(wxAUI_DOCK_BOTTOM).
106 \membersection{wxAuiPaneInfo::BottomDockable
}\label{wxauipaneinfobottomdockable
}
108 \func{wxAuiPaneInfo\&
}{BottomDockable
}{\param{bool
}{b = true
}}
110 BottomDockable() indicates whether a pane can be docked at the bottom of the frame.
112 \membersection{wxAuiPaneInfo::Caption
}\label{wxauipaneinfocaption
}
114 \func{wxAuiPaneInfo\&
}{Caption
}{\param{const wxString\&
}{c
}}
116 Caption() sets the caption of the pane.
118 \membersection{wxAuiPaneInfo::CaptionVisible
}\label{wxauipaneinfocaptionvisible
}
120 \func{wxAuiPaneInfo\&
}{CaptionVisible
}{\param{bool
}{visible = true
}}
122 CaptionVisible indicates that a pane caption should be visible. If false, no pane caption is drawn.
124 \membersection{wxAuiPaneInfo::Centre
}\label{wxauipaneinfocentre
}
126 \func{wxAuiPaneInfo\&
}{Centre
}{\void}
127 \func{wxAuiPaneInfo\&
}{Center
}{\void}
129 Center() sets the pane dock position to the left side of the frame. This is the same thing as calling Direction(wxAUI_DOCK_CENTRE).
131 \membersection{wxAuiPaneInfo::CentrePane
}\label{wxauipaneinfocentrepane
}
133 \func{wxAuiPaneInfo\&
}{CentrePane
}{\void}
134 \func{wxAuiPaneInfo\&
}{CenterPane
}{\void}
136 CentrePane() specifies that the pane should adopt the default centre pane settings.
138 \membersection{wxAuiPaneInfo::Centre
}\label{wxauipaneinfocentre
}
140 \func{wxAuiPaneInfo\&
}{Centre
}{\void}
141 \func{wxAuiPaneInfo\&
}{Center
}{\void}
143 Centre() sets the pane to the center position of the frame. The centre pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout.
145 \membersection{wxAuiPaneInfo::CentrePane
}\label{wxauipaneinfocentrepane
}
147 \func{wxAuiPaneInfo\&
}{CentrePane
}{\void}
148 \func{wxAuiPaneInfo\&
}{CenterPane
}{\void}
150 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.
152 \membersection{wxAuiPaneInfo::CloseButton
}\label{wxauipaneinfoclosebutton
}
154 \func{wxAuiPaneInfo\&
}{CloseButton
}{\param{bool
}{visible = true
}}
156 CloseButton() indicates that a close button should be drawn for the pane.
158 \membersection{wxAuiPaneInfo::DefaultPane
}\label{wxauipaneinfodefaultpane
}
160 \func{wxAuiPaneInfo\&
}{DefaultPane
}{\void}
162 DefaultPane() specifies that the pane should adopt the default pane settings.
164 \membersection{wxAuiPaneInfo::DestroyOnClose
}\label{wxauipaneinfodestroyonclose
}
166 \func{wxAuiPaneInfo\&
}{DestroyOnClose
}{\param{bool
}{b = true
}}
168 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.
170 \membersection{wxAuiPaneInfo::Direction
}\label{wxauipaneinfodirection
}
172 \func{wxAuiPaneInfo\&
}{Direction
}{\param{int
}{direction
}}
174 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.
176 \membersection{wxAuiPaneInfo::Dock
}\label{wxauipaneinfodock
}
178 \func{wxAuiPaneInfo\&
}{Dock
}{\void}
181 \membersection{wxAuiPaneInfo::Dockable
}\label{wxauipaneinfodockable
}
183 \func{wxAuiPaneInfo\&
}{Dockable
}{\param{bool
}{b = true
}}
185 Dockable() specifies whether a frame can be docked or not. It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b).
187 \membersection{wxAuiPaneInfo::Fixed
}\label{wxauipaneinfofixed
}
189 \func{wxAuiPaneInfo\&
}{Fixed
}{\void}
191 Fixed() forces a pane to be fixed size so that it cannot be resized. After calling Fixed(), IsFixed() will return true.
193 \membersection{wxAuiPaneInfo::Float
}\label{wxauipaneinfofloat
}
195 \func{wxAuiPaneInfo\&
}{Float
}{\void}
197 Float() indicates that a pane should be floated.
199 \membersection{wxAuiPaneInfo::Floatable
}\label{wxauipaneinfofloatable
}
201 \func{wxAuiPaneInfo\&
}{Floatable
}{\param{bool
}{b = true
}}
203 Floatable() sets whether the user will be able to undock a pane and turn it into a floating window.
205 \membersection{wxAuiPaneInfo::FloatingPosition
}\label{wxauipaneinfofloatingposition
}
207 \func{wxAuiPaneInfo\&
}{FloatingPosition
}{\param{const wxPoint\&
}{pos
}}
208 \func{wxAuiPaneInfo\&
}{FloatingPosition
}{\param{int
}{x
},
\param{int
}{y
}}
210 FloatingPosition() sets the position of the floating pane.
212 \membersection{wxAuiPaneInfo::FloatingSize
}\label{wxauipaneinfofloatingsize
}
214 \func{wxAuiPaneInfo\&
}{FloatingSize
}{\param{const wxSize\&
}{size
}}
215 \func{wxAuiPaneInfo\&
}{FloatingSize
}{\param{int
}{x
},
\param{int
}{y
}}
217 FloatingSize() sets the size of the floating pane.
219 \membersection{wxAuiPaneInfo::Gripper
}\label{wxauipaneinfogripper
}
221 \func{wxAuiPaneInfo\&
}{Gripper
}{\param{bool
}{visible = true
}}
223 Gripper() indicates that a gripper should be drawn for the pane.
225 \membersection{wxAuiPaneInfo::GripperTop
}\label{wxauipaneinfogrippertop
}
227 \func{wxAuiPaneInfo\&
}{GripperTop
}{\param{bool
}{attop = true
}}
229 GripperTop() indicates that a gripper should be drawn at the top of the pane.
231 \membersection{wxAuiPaneInfo::HasBorder
}\label{wxauipaneinfohasborder
}
233 \constfunc{bool
}{HasBorder
}{\void}
235 HasBorder() returns true if the pane displays a border.
237 \membersection{wxAuiPaneInfo::HasCaption
}\label{wxauipaneinfohascaption
}
239 \constfunc{bool
}{HasCaption
}{\void}
241 HasCaption() returns true if the pane displays a caption.
243 \membersection{wxAuiPaneInfo::HasCloseButton
}\label{wxauipaneinfohasclosebutton
}
245 \constfunc{bool
}{HasCloseButton
}{\void}
247 HasCloseButton() returns true if the pane displays a button to close the pane.
249 \membersection{wxAuiPaneInfo::HasFlag
}\label{wxauipaneinfohasflag
}
251 \constfunc{bool
}{HasFlag
}{\param{unsigned int
}{flag
}}
253 HasFlag() returns true if the the property specified by flag is active for the pane.
255 \membersection{wxAuiPaneInfo::HasGripper
}\label{wxauipaneinfohasgripper
}
257 \constfunc{bool
}{HasGripper
}{\void}
259 HasGripper() returns true if the pane displays a gripper.
261 \membersection{wxAuiPaneInfo::HasGripperTop
}\label{wxauipaneinfohasgrippertop
}
263 \constfunc{bool
}{HasGripperTop
}{\void}
265 HasGripper() returns true if the pane displays a gripper at the top.
267 \membersection{wxAuiPaneInfo::HasMaximizeButton
}\label{wxauipaneinfohasmaximizebutton
}
269 \constfunc{bool
}{HasMaximizeButton
}{\void}
271 HasMaximizeButton() returns true if the pane displays a button to maximize the pane.
273 \membersection{wxAuiPaneInfo::HasMinimizeButton
}\label{wxauipaneinfohasminimizebutton
}
275 \constfunc{bool
}{HasMinimizeButton
}{\void}
277 HasMinimizeButton() returns true if the pane displays a button to minimize the pane.
279 \membersection{wxAuiPaneInfo::HasPinButton
}\label{wxauipaneinfohaspinbutton
}
281 \constfunc{bool
}{HasPinButton
}{\void}
283 HasPinButton() returns true if the pane displays a button to float the pane.
285 \membersection{wxAuiPaneInfo::Hide
}\label{wxauipaneinfohide
}
287 \func{wxAuiPaneInfo\&
}{Hide
}{\void}
289 Hide() indicates that a pane should be hidden.
291 \membersection{wxAuiPaneInfo::IsBottomDockable
}\label{wxauipaneinfoisbottomdockable
}
293 \constfunc{bool
}{IsBottomDockable
}{\void}
295 IsBottomDockable() returns true if the pane can be docked at the bottom of the managed frame.
297 \membersection{wxAuiPaneInfo::IsDocked
}\label{wxauipaneinfoisdocked
}
299 \constfunc{bool
}{IsDocked
}{\void}
301 IsDocked() returns true if the pane is docked.
303 \membersection{wxAuiPaneInfo::IsFixed
}\label{wxauipaneinfoisfixed
}
305 \constfunc{bool
}{IsFixed
}{\void}
307 IsFixed() returns true if the pane cannot be resized.
309 \membersection{wxAuiPaneInfo::IsFloatable
}\label{wxauipaneinfoisfloatable
}
311 \constfunc{bool
}{IsFloatable
}{\void}
313 IsFloatable() returns true if the pane can be undocked and displayed as a floating window.
315 \membersection{wxAuiPaneInfo::IsFloating
}\label{wxauipaneinfoisfloating
}
317 \constfunc{bool
}{IsFloating
}{\void}
319 IsFloating() returns true if the pane is floating.
321 \membersection{wxAuiPaneInfo::IsLeftDockable
}\label{wxauipaneinfoisleftdockable
}
323 \constfunc{bool
}{IsLeftDockable
}{\void}
325 IsLeftDockable() returns true if the pane can be docked on the left of the managed frame.
327 \membersection{wxAuiPaneInfo::IsMovable
}\label{wxauipaneinfoismovable
}
329 \constfunc{bool
}{IsMovable
}{\void}
331 IsMoveable() returns true if the docked frame can be undocked or moved to another dock position.
333 \membersection{wxAuiPaneInfo::IsOk
}\label{wxauipaneinfoisok
}
335 \constfunc{bool
}{IsOk
}{\void}
337 IsOk() returns true if the wxAuiPaneInfo structure is valid. A pane structure is valid if it has an associated window.
339 \membersection{wxAuiPaneInfo::IsResizable
}\label{wxauipaneinfoisresizable
}
341 \constfunc{bool
}{IsResizable
}{\void}
343 IsResizable() returns true if the pane can be resized.
345 \membersection{wxAuiPaneInfo::IsRightDockable
}\label{wxauipaneinfoisrightdockable
}
347 \constfunc{bool
}{IsRightDockable
}{\void}
349 IsRightDockable() returns true if the pane can be docked on the right of the managed frame.
351 \membersection{wxAuiPaneInfo::IsShown
}\label{wxauipaneinfoisshown
}
353 \constfunc{bool
}{IsShown
}{\void}
355 IsShown() returns true if the pane is currently shown.
357 \membersection{wxAuiPaneInfo::IsToolbar
}\label{wxauipaneinfoistoolbar
}
359 \constfunc{bool
}{IsToolbar
}{\void}
361 IsToolbar() returns true if the pane contains a toolbar.
363 \membersection{wxAuiPaneInfo::IsTopDockable
}\label{wxauipaneinfoistopdockable
}
365 \constfunc{bool
}{IsTopDockable
}{\void}
367 IsTopDockable() returns true if the pane can be docked at the top of the managed frame.
369 \membersection{wxAuiPaneInfo::Layer
}\label{wxauipaneinfolayer
}
371 \func{wxAuiPaneInfo\&
}{Layer
}{\param{int
}{layer
}}
373 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.
375 \membersection{wxAuiPaneInfo::Left
}\label{wxauipaneinfoleft
}
377 \func{wxAuiPaneInfo\&
}{Left
}{\void}
379 Left() sets the pane dock position to the left side of the frame. This is the same thing as calling Direction(wxAUI_DOCK_LEFT).
381 \membersection{wxAuiPaneInfo::LeftDockable
}\label{wxauipaneinfoleftdockable
}
383 \func{wxAuiPaneInfo\&
}{LeftDockable
}{\param{bool
}{b = true
}}
385 LeftDockable() indicates whether a pane can be docked on the left of the frame.
387 \membersection{wxAuiPaneInfo::MaxSize
}\label{wxauipaneinfomaxsize
}
389 \func{wxAuiPaneInfo\&
}{MaxSize
}{\param{const wxSize\&
}{size
}}
390 \func{wxAuiPaneInfo\&
}{MaxSize
}{\param{int
}{x
},
\param{int
}{y
}}
392 MaxSize() sets the maximum size of the pane.
394 \membersection{wxAuiPaneInfo::MaximizeButton
}\label{wxauipaneinfomaximizebutton
}
396 \func{wxAuiPaneInfo\&
}{MaximizeButton
}{\param{bool
}{visible = true
}}
398 MaximizeButton() indicates that a maximize button should be drawn for the pane.
400 \membersection{wxAuiPaneInfo::MinSize
}\label{wxauipaneinfominsize
}
402 \func{wxAuiPaneInfo\&
}{MinSize
}{\param{const wxSize\&
}{size
}}
403 \func{wxAuiPaneInfo\&
}{MinSize
}{\param{int
}{x
},
\param{int
}{y
}}
405 MinSize() sets the minimum size of the pane. Please note that this is only partially supported as of this writing.
407 \membersection{wxAuiPaneInfo::MinimizeButton
}\label{wxauipaneinfominimizebutton
}
409 \func{wxAuiPaneInfo\&
}{MinimizeButton
}{\param{bool
}{visible = true
}}
411 MinimizeButton() indicates that a minimize button should be drawn for the pane.
413 \membersection{wxAuiPaneInfo::Movable
}\label{wxauipaneinfomovable
}
415 \func{wxAuiPaneInfo\&
}{Movable
}{\param{bool
}{b = true
}}
417 Movable indicates whether a frame can be moved.
419 \membersection{wxAuiPaneInfo::Name
}\label{wxauipaneinfoname
}
421 \func{wxAuiPaneInfo\&
}{Name
}{\param{const wxString\&
}{n
}}
423 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.
425 \membersection{wxAuiPaneInfo::PaneBorder
}\label{wxauipaneinfopaneborder
}
427 \func{wxAuiPaneInfo\&
}{PaneBorder
}{\param{bool
}{visible = true
}}
429 PaneBorder indicates that a border should be drawn for the pane.
431 \membersection{wxAuiPaneInfo::PinButton
}\label{wxauipaneinfopinbutton
}
433 \func{wxAuiPaneInfo\&
}{PinButton
}{\param{bool
}{visible = true
}}
435 PinButton() indicates that a pin button should be drawn for the pane.
437 \membersection{wxAuiPaneInfo::Position
}\label{wxauipaneinfoposition
}
439 \func{wxAuiPaneInfo\&
}{Position
}{\param{int
}{pos
}}
441 Position() determines the position of the docked pane.
443 \membersection{wxAuiPaneInfo::Resizable
}\label{wxauipaneinforesizable
}
445 \func{wxAuiPaneInfo\&
}{Resizable
}{\param{bool
}{resizable = true
}}
447 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().
449 \membersection{wxAuiPaneInfo::Right
}\label{wxauipaneinforight
}
451 \func{wxAuiPaneInfo\&
}{Right
}{\void}
453 Right() sets the pane dock position to the right side of the frame.
455 \membersection{wxAuiPaneInfo::RightDockable
}\label{wxauipaneinforightdockable
}
457 \func{wxAuiPaneInfo\&
}{RightDockable
}{\param{bool
}{b = true
}}
459 RightDockable() indicates whether a pane can be docked on the right of the frame.
461 \membersection{wxAuiPaneInfo::Row
}\label{wxauipaneinforow
}
463 \func{wxAuiPaneInfo\&
}{Row
}{\param{int
}{row
}}
465 Row() determines the row of the docked pane.
467 \membersection{wxAuiPaneInfo::SafeSet
}\label{wxauipaneinfosafeset
}
469 \func{void
}{SafeSet
}{\param{wxAuiPaneInfo
}{source
}}
471 Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
472 used on loading perspectives etc.
474 \membersection{wxAuiPaneInfo::SetFlag
}\label{wxauipaneinfosetflag
}
476 \func{wxAuiPaneInfo\&
}{SetFlag
}{\param{unsigned int
}{flag
},
\param{bool
}{option
\_state}}
478 SetFlag() turns the property given by flag on or off with the option_state parameter.
480 \membersection{wxAuiPaneInfo::Show
}\label{wxauipaneinfoshow
}
482 \func{wxAuiPaneInfo\&
}{Show
}{\param{bool
}{show = true
}}
484 Show() indicates that a pane should be shown.
486 \membersection{wxAuiPaneInfo::ToolbarPane
}\label{wxauipaneinfotoolbarpane
}
488 \func{wxAuiPaneInfo\&
}{ToolbarPane
}{\void}
490 ToolbarPane() specifies that the pane should adopt the default toolbar pane settings.
492 \membersection{wxAuiPaneInfo::Top
}\label{wxauipaneinfotop
}
494 \func{wxAuiPaneInfo\&
}{Top
}{\void}
496 Top() sets the pane dock position to the top of the frame.
498 \membersection{wxAuiPaneInfo::TopDockable
}\label{wxauipaneinfotopdockable
}
500 \func{wxAuiPaneInfo\&
}{TopDockable
}{\param{bool
}{b = true
}}
502 TopDockable() indicates whether a pane can be docked at the top of the frame.
504 \membersection{wxAuiPaneInfo::Window
}\label{wxauipaneinfowindow
}
506 \func{wxAuiPaneInfo\&
}{Window
}{\param{wxWindow*
}{w
}}
508 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.
510 \membersection{wxAuiPaneInfo::operator=
}\label{wxauipaneinfooperatorassign
}
512 \func{wxAuiPaneInfo\& operator
}{operator=
}{\param{const wxAuiPaneInfo\&
}{c
}}
514 Makes a copy of the wxAuiPaneInfo object.