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
}}
98 \func{wxAuiPaneInfo\&
}{BestSize
}{\param{int
}{x
},
\param{int
}{y
}}
101 \membersection{wxAuiPaneInfo::Bottom
}\label{wxauipaneinfobottom
}
103 \func{wxAuiPaneInfo\&
}{Bottom
}{\void}
106 \membersection{wxAuiPaneInfo::BottomDockable
}\label{wxauipaneinfobottomdockable
}
108 \func{wxAuiPaneInfo\&
}{BottomDockable
}{\param{bool
}{b = true
}}
111 \membersection{wxAuiPaneInfo::Caption
}\label{wxauipaneinfocaption
}
113 \func{wxAuiPaneInfo\&
}{Caption
}{\param{const wxString\&
}{c
}}
116 \membersection{wxAuiPaneInfo::CaptionVisible
}\label{wxauipaneinfocaptionvisible
}
118 \func{wxAuiPaneInfo\&
}{CaptionVisible
}{\param{bool
}{visible = true
}}
121 \membersection{wxAuiPaneInfo::Center
}\label{wxauipaneinfocenter
}
123 \func{wxAuiPaneInfo\&
}{Center
}{\void}
126 \membersection{wxAuiPaneInfo::CenterPane
}\label{wxauipaneinfocenterpane
}
128 \func{wxAuiPaneInfo\&
}{CenterPane
}{\void}
131 \membersection{wxAuiPaneInfo::Centre
}\label{wxauipaneinfocentre
}
133 \func{wxAuiPaneInfo\&
}{Centre
}{\void}
136 \membersection{wxAuiPaneInfo::CentrePane
}\label{wxauipaneinfocentrepane
}
138 \func{wxAuiPaneInfo\&
}{CentrePane
}{\void}
141 \membersection{wxAuiPaneInfo::CloseButton
}\label{wxauipaneinfoclosebutton
}
143 \func{wxAuiPaneInfo\&
}{CloseButton
}{\param{bool
}{visible = true
}}
146 \membersection{wxAuiPaneInfo::DefaultPane
}\label{wxauipaneinfodefaultpane
}
148 \func{wxAuiPaneInfo\&
}{DefaultPane
}{\void}
151 \membersection{wxAuiPaneInfo::DestroyOnClose
}\label{wxauipaneinfodestroyonclose
}
153 \func{wxAuiPaneInfo\&
}{DestroyOnClose
}{\param{bool
}{b = true
}}
156 \membersection{wxAuiPaneInfo::Direction
}\label{wxauipaneinfodirection
}
158 \func{wxAuiPaneInfo\&
}{Direction
}{\param{int
}{direction
}}
161 \membersection{wxAuiPaneInfo::Dock
}\label{wxauipaneinfodock
}
163 \func{wxAuiPaneInfo\&
}{Dock
}{\void}
166 \membersection{wxAuiPaneInfo::Dockable
}\label{wxauipaneinfodockable
}
168 \func{wxAuiPaneInfo\&
}{Dockable
}{\param{bool
}{b = true
}}
171 \membersection{wxAuiPaneInfo::Fixed
}\label{wxauipaneinfofixed
}
173 \func{wxAuiPaneInfo\&
}{Fixed
}{\void}
176 \membersection{wxAuiPaneInfo::Float
}\label{wxauipaneinfofloat
}
178 \func{wxAuiPaneInfo\&
}{Float
}{\void}
181 \membersection{wxAuiPaneInfo::Floatable
}\label{wxauipaneinfofloatable
}
183 \func{wxAuiPaneInfo\&
}{Floatable
}{\param{bool
}{b = true
}}
186 \membersection{wxAuiPaneInfo::FloatingPosition
}\label{wxauipaneinfofloatingposition
}
188 \func{wxAuiPaneInfo\&
}{FloatingPosition
}{\param{const wxPoint\&
}{pos
}}
191 \func{wxAuiPaneInfo\&
}{FloatingPosition
}{\param{int
}{x
},
\param{int
}{y
}}
194 \membersection{wxAuiPaneInfo::FloatingSize
}\label{wxauipaneinfofloatingsize
}
196 \func{wxAuiPaneInfo\&
}{FloatingSize
}{\param{const wxSize\&
}{size
}}
199 \func{wxAuiPaneInfo\&
}{FloatingSize
}{\param{int
}{x
},
\param{int
}{y
}}
202 \membersection{wxAuiPaneInfo::Gripper
}\label{wxauipaneinfogripper
}
204 \func{wxAuiPaneInfo\&
}{Gripper
}{\param{bool
}{visible = true
}}
207 \membersection{wxAuiPaneInfo::GripperTop
}\label{wxauipaneinfogrippertop
}
209 \func{wxAuiPaneInfo\&
}{GripperTop
}{\param{bool
}{attop = true
}}
212 \membersection{wxAuiPaneInfo::HasBorder
}\label{wxauipaneinfohasborder
}
214 \constfunc{bool
}{HasBorder
}{\void}
217 \membersection{wxAuiPaneInfo::HasCaption
}\label{wxauipaneinfohascaption
}
219 \constfunc{bool
}{HasCaption
}{\void}
222 \membersection{wxAuiPaneInfo::HasCloseButton
}\label{wxauipaneinfohasclosebutton
}
224 \constfunc{bool
}{HasCloseButton
}{\void}
227 \membersection{wxAuiPaneInfo::HasFlag
}\label{wxauipaneinfohasflag
}
229 \constfunc{bool
}{HasFlag
}{\param{unsigned int
}{flag
}}
232 \membersection{wxAuiPaneInfo::HasGripper
}\label{wxauipaneinfohasgripper
}
234 \constfunc{bool
}{HasGripper
}{\void}
237 \membersection{wxAuiPaneInfo::HasGripperTop
}\label{wxauipaneinfohasgrippertop
}
239 \constfunc{bool
}{HasGripperTop
}{\void}
242 \membersection{wxAuiPaneInfo::HasMaximizeButton
}\label{wxauipaneinfohasmaximizebutton
}
244 \constfunc{bool
}{HasMaximizeButton
}{\void}
247 \membersection{wxAuiPaneInfo::HasMinimizeButton
}\label{wxauipaneinfohasminimizebutton
}
249 \constfunc{bool
}{HasMinimizeButton
}{\void}
252 \membersection{wxAuiPaneInfo::HasPinButton
}\label{wxauipaneinfohaspinbutton
}
254 \constfunc{bool
}{HasPinButton
}{\void}
257 \membersection{wxAuiPaneInfo::Hide
}\label{wxauipaneinfohide
}
259 \func{wxAuiPaneInfo\&
}{Hide
}{\void}
262 \membersection{wxAuiPaneInfo::IsBottomDockable
}\label{wxauipaneinfoisbottomdockable
}
264 \constfunc{bool
}{IsBottomDockable
}{\void}
267 \membersection{wxAuiPaneInfo::IsDocked
}\label{wxauipaneinfoisdocked
}
269 \constfunc{bool
}{IsDocked
}{\void}
272 \membersection{wxAuiPaneInfo::IsFixed
}\label{wxauipaneinfoisfixed
}
274 \constfunc{bool
}{IsFixed
}{\void}
277 \membersection{wxAuiPaneInfo::IsFloatable
}\label{wxauipaneinfoisfloatable
}
279 \constfunc{bool
}{IsFloatable
}{\void}
282 \membersection{wxAuiPaneInfo::IsFloating
}\label{wxauipaneinfoisfloating
}
284 \constfunc{bool
}{IsFloating
}{\void}
287 \membersection{wxAuiPaneInfo::IsLeftDockable
}\label{wxauipaneinfoisleftdockable
}
289 \constfunc{bool
}{IsLeftDockable
}{\void}
292 \membersection{wxAuiPaneInfo::IsMovable
}\label{wxauipaneinfoismovable
}
294 \constfunc{bool
}{IsMovable
}{\void}
297 \membersection{wxAuiPaneInfo::IsOk
}\label{wxauipaneinfoisok
}
299 \constfunc{bool
}{IsOk
}{\void}
302 \membersection{wxAuiPaneInfo::IsResizable
}\label{wxauipaneinfoisresizable
}
304 \constfunc{bool
}{IsResizable
}{\void}
307 \membersection{wxAuiPaneInfo::IsRightDockable
}\label{wxauipaneinfoisrightdockable
}
309 \constfunc{bool
}{IsRightDockable
}{\void}
312 \membersection{wxAuiPaneInfo::IsShown
}\label{wxauipaneinfoisshown
}
314 \constfunc{bool
}{IsShown
}{\void}
317 \membersection{wxAuiPaneInfo::IsToolbar
}\label{wxauipaneinfoistoolbar
}
319 \constfunc{bool
}{IsToolbar
}{\void}
322 \membersection{wxAuiPaneInfo::IsTopDockable
}\label{wxauipaneinfoistopdockable
}
324 \constfunc{bool
}{IsTopDockable
}{\void}
327 \membersection{wxAuiPaneInfo::Layer
}\label{wxauipaneinfolayer
}
329 \func{wxAuiPaneInfo\&
}{Layer
}{\param{int
}{layer
}}
332 \membersection{wxAuiPaneInfo::Left
}\label{wxauipaneinfoleft
}
334 \func{wxAuiPaneInfo\&
}{Left
}{\void}
337 \membersection{wxAuiPaneInfo::LeftDockable
}\label{wxauipaneinfoleftdockable
}
339 \func{wxAuiPaneInfo\&
}{LeftDockable
}{\param{bool
}{b = true
}}
342 \membersection{wxAuiPaneInfo::MaxSize
}\label{wxauipaneinfomaxsize
}
344 \func{wxAuiPaneInfo\&
}{MaxSize
}{\param{const wxSize\&
}{size
}}
347 \func{wxAuiPaneInfo\&
}{MaxSize
}{\param{int
}{x
},
\param{int
}{y
}}
350 \membersection{wxAuiPaneInfo::MaximizeButton
}\label{wxauipaneinfomaximizebutton
}
352 \func{wxAuiPaneInfo\&
}{MaximizeButton
}{\param{bool
}{visible = true
}}
355 \membersection{wxAuiPaneInfo::MinSize
}\label{wxauipaneinfominsize
}
357 \func{wxAuiPaneInfo\&
}{MinSize
}{\param{const wxSize\&
}{size
}}
360 \func{wxAuiPaneInfo\&
}{MinSize
}{\param{int
}{x
},
\param{int
}{y
}}
363 \membersection{wxAuiPaneInfo::MinimizeButton
}\label{wxauipaneinfominimizebutton
}
365 \func{wxAuiPaneInfo\&
}{MinimizeButton
}{\param{bool
}{visible = true
}}
368 \membersection{wxAuiPaneInfo::Movable
}\label{wxauipaneinfomovable
}
370 \func{wxAuiPaneInfo\&
}{Movable
}{\param{bool
}{b = true
}}
373 \membersection{wxAuiPaneInfo::Name
}\label{wxauipaneinfoname
}
375 \func{wxAuiPaneInfo\&
}{Name
}{\param{const wxString\&
}{n
}}
378 \membersection{wxAuiPaneInfo::PaneBorder
}\label{wxauipaneinfopaneborder
}
380 \func{wxAuiPaneInfo\&
}{PaneBorder
}{\param{bool
}{visible = true
}}
383 \membersection{wxAuiPaneInfo::PinButton
}\label{wxauipaneinfopinbutton
}
385 \func{wxAuiPaneInfo\&
}{PinButton
}{\param{bool
}{visible = true
}}
388 \membersection{wxAuiPaneInfo::Position
}\label{wxauipaneinfoposition
}
390 \func{wxAuiPaneInfo\&
}{Position
}{\param{int
}{pos
}}
393 \membersection{wxAuiPaneInfo::Resizable
}\label{wxauipaneinforesizable
}
395 \func{wxAuiPaneInfo\&
}{Resizable
}{\param{bool
}{resizable = true
}}
398 \membersection{wxAuiPaneInfo::Right
}\label{wxauipaneinforight
}
400 \func{wxAuiPaneInfo\&
}{Right
}{\void}
403 \membersection{wxAuiPaneInfo::RightDockable
}\label{wxauipaneinforightdockable
}
405 \func{wxAuiPaneInfo\&
}{RightDockable
}{\param{bool
}{b = true
}}
408 \membersection{wxAuiPaneInfo::Row
}\label{wxauipaneinforow
}
410 \func{wxAuiPaneInfo\&
}{Row
}{\param{int
}{row
}}
413 \membersection{wxAuiPaneInfo::SafeSet
}\label{wxauipaneinfosafeset
}
415 \func{void
}{SafeSet
}{\param{wxAuiPaneInfo
}{source
}}
417 Write the safe parts of a newly loaded PaneInfo structure "source" into "this"
418 used on loading perspectives etc.
421 \membersection{wxAuiPaneInfo::SetFlag
}\label{wxauipaneinfosetflag
}
423 \func{wxAuiPaneInfo\&
}{SetFlag
}{\param{unsigned int
}{flag
},
\param{bool
}{option
\_state}}
426 \membersection{wxAuiPaneInfo::Show
}\label{wxauipaneinfoshow
}
428 \func{wxAuiPaneInfo\&
}{Show
}{\param{bool
}{show = true
}}
431 \membersection{wxAuiPaneInfo::ToolbarPane
}\label{wxauipaneinfotoolbarpane
}
433 \func{wxAuiPaneInfo\&
}{ToolbarPane
}{\void}
436 \membersection{wxAuiPaneInfo::Top
}\label{wxauipaneinfotop
}
438 \func{wxAuiPaneInfo\&
}{Top
}{\void}
441 \membersection{wxAuiPaneInfo::TopDockable
}\label{wxauipaneinfotopdockable
}
443 \func{wxAuiPaneInfo\&
}{TopDockable
}{\param{bool
}{b = true
}}
446 \membersection{wxAuiPaneInfo::Window
}\label{wxauipaneinfowindow
}
448 \func{wxAuiPaneInfo\&
}{Window
}{\param{wxWindow*
}{w
}}
451 \membersection{wxAuiPaneInfo::operator=
}\label{wxauipaneinfooperatorassign
}
453 \func{wxAuiPaneInfo\& operator
}{operator=
}{\param{const wxAuiPaneInfo\&
}{c
}}
projects / wxWidgets.git / blob