projects / wxWidgets.git / blame
| Commit | Line | Data |
|---|---|---|
| 6ff9dc03 RR |
1 | \section{\class{wxPaneInfo}}\label{wxpaneinfo} |
| 2 | ||
| 3 | wxPaneInfo is part of the wxAUI class framework. | |
| 4 | See also \helpref{wxAUI overview}{wxauioverview}. | |
| 5 | ||
| 6 | wxPaneInfo 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{wxFrameManager}{wxframemanager} | |
| 24 | ||
| 25 | \wxheading{Data structures} | |
| 26 | ||
| 27 | \begin{verbatim} | |
| 28 | enum wxPaneDockArtSetting | |
| 29 | { | |
| 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 | |
| 47 | } | |
| 48 | \end{verbatim} | |
| 49 | ||
| 50 | \begin{verbatim} | |
| 51 | enum wxPaneDockArtGradients | |
| 52 | { | |
| 53 | wxAUI_GRADIENT_NONE = 0, | |
| 54 | wxAUI_GRADIENT_VERTICAL = 1, | |
| 55 | wxAUI_GRADIENT_HORIZONTAL = 2 | |
| 56 | } | |
| 57 | \end{verbatim} | |
| 58 | ||
| 59 | \begin{verbatim} | |
| 60 | enum wxPaneButtonState | |
| 61 | { | |
| 62 | wxAUI_BUTTON_STATE_NORMAL = 0, | |
| 63 | wxAUI_BUTTON_STATE_HOVER = 1, | |
| 64 | wxAUI_BUTTON_STATE_PRESSED = 2 | |
| 65 | } | |
| 66 | \end{verbatim} | |
| 67 | ||
| 68 | \begin{verbatim} | |
| 69 | enum wxPaneInsertLevel | |
| 70 | { | |
| 71 | wxAUI_INSERT_PANE = 0, | |
| 72 | wxAUI_INSERT_ROW = 1, | |
| 73 | wxAUI_INSERT_DOCK = 2 | |
| 74 | } | |
| 75 | \end{verbatim} | |
| 76 | ||
| 77 | \latexignore{\rtfignore{\wxheading{Members}}} | |
| 78 | ||
| 79 | ||
| 80 | \membersection{wxPaneInfo::wxPaneInfo}\label{wxpaneinfowxpaneinfo} | |
| 81 | ||
| 82 | \func{}{wxPaneInfo}{\void} | |
| 83 | ||
| 84 | ||
| 85 | \func{}{wxPaneInfo}{\param{const wxPaneInfo\& }{c}} | |
| 86 | ||
| 87 | ||
| 88 | \membersection{wxPaneInfo::\destruct{wxPaneInfo}}\label{wxpaneinfodtor} | |
| 89 | ||
| 90 | \func{}{\destruct{wxPaneInfo}}{\void} | |
| 91 | ||
| 92 | ||
| 93 | \membersection{wxPaneInfo::BestSize}\label{wxpaneinfobestsize} | |
| 94 | ||
| 95 | \func{wxPaneInfo\&}{BestSize}{\param{const wxSize\& }{size}} | |
| 96 | ||
| 97 | ||
| 98 | \func{wxPaneInfo\&}{BestSize}{\param{int }{x}, \param{int }{y}} | |
| 99 | ||
| 100 | ||
| 101 | \membersection{wxPaneInfo::Bottom}\label{wxpaneinfobottom} | |
| 102 | ||
| 103 | \func{wxPaneInfo\&}{Bottom}{\void} | |
| 104 | ||
| 105 | ||
| 106 | \membersection{wxPaneInfo::BottomDockable}\label{wxpaneinfobottomdockable} | |
| 107 | ||
| 108 | \func{wxPaneInfo\&}{BottomDockable}{\param{bool }{b = true}} | |
| 109 | ||
| 110 | ||
| 111 | \membersection{wxPaneInfo::Caption}\label{wxpaneinfocaption} | |
| 112 | ||
| 113 | \func{wxPaneInfo\&}{Caption}{\param{const wxString\& }{c}} | |
| 114 | ||
| 115 | ||
| 116 | \membersection{wxPaneInfo::CaptionVisible}\label{wxpaneinfocaptionvisible} | |
| 117 | ||
| 118 | \func{wxPaneInfo\&}{CaptionVisible}{\param{bool }{visible = true}} | |
| 119 | ||
| 120 | ||
| 121 | \membersection{wxPaneInfo::Center}\label{wxpaneinfocenter} | |
| 122 | ||
| 123 | \func{wxPaneInfo\&}{Center}{\void} | |
| 124 | ||
| 125 | ||
| 126 | \membersection{wxPaneInfo::CenterPane}\label{wxpaneinfocenterpane} | |
| 127 | ||
| 128 | \func{wxPaneInfo\&}{CenterPane}{\void} | |
| 129 | ||
| 130 | ||
| 131 | \membersection{wxPaneInfo::Centre}\label{wxpaneinfocentre} | |
| 132 | ||
| 133 | \func{wxPaneInfo\&}{Centre}{\void} | |
| 134 | ||
| 135 | ||
| 136 | \membersection{wxPaneInfo::CentrePane}\label{wxpaneinfocentrepane} | |
| 137 | ||
| 138 | \func{wxPaneInfo\&}{CentrePane}{\void} | |
| 139 | ||
| 140 | ||
| 141 | \membersection{wxPaneInfo::CloseButton}\label{wxpaneinfoclosebutton} | |
| 142 | ||
| 143 | \func{wxPaneInfo\&}{CloseButton}{\param{bool }{visible = true}} | |
| 144 | ||
| 145 | ||
| 146 | \membersection{wxPaneInfo::DefaultPane}\label{wxpaneinfodefaultpane} | |
| 147 | ||
| 148 | \func{wxPaneInfo\&}{DefaultPane}{\void} | |
| 149 | ||
| 150 | ||
| 151 | \membersection{wxPaneInfo::DestroyOnClose}\label{wxpaneinfodestroyonclose} | |
| 152 | ||
| 153 | \func{wxPaneInfo\&}{DestroyOnClose}{\param{bool }{b = true}} | |
| 154 | ||
| 155 | ||
| 156 | \membersection{wxPaneInfo::Direction}\label{wxpaneinfodirection} | |
| 157 | ||
| 158 | \func{wxPaneInfo\&}{Direction}{\param{int }{direction}} | |
| 159 | ||
| 160 | ||
| 161 | \membersection{wxPaneInfo::Dock}\label{wxpaneinfodock} | |
| 162 | ||
| 163 | \func{wxPaneInfo\&}{Dock}{\void} | |
| 164 | ||
| 165 | ||
| 166 | \membersection{wxPaneInfo::Dockable}\label{wxpaneinfodockable} | |
| 167 | ||
| 168 | \func{wxPaneInfo\&}{Dockable}{\param{bool }{b = true}} | |
| 169 | ||
| 170 | ||
| 171 | \membersection{wxPaneInfo::Fixed}\label{wxpaneinfofixed} | |
| 172 | ||
| 173 | \func{wxPaneInfo\&}{Fixed}{\void} | |
| 174 | ||
| 175 | ||
| 176 | \membersection{wxPaneInfo::Float}\label{wxpaneinfofloat} | |
| 177 | ||
| 178 | \func{wxPaneInfo\&}{Float}{\void} | |
| 179 | ||
| 180 | ||
| 181 | \membersection{wxPaneInfo::Floatable}\label{wxpaneinfofloatable} | |
| 182 | ||
| 183 | \func{wxPaneInfo\&}{Floatable}{\param{bool }{b = true}} | |
| 184 | ||
| 185 | ||
| 186 | \membersection{wxPaneInfo::FloatingPosition}\label{wxpaneinfofloatingposition} | |
| 187 | ||
| 188 | \func{wxPaneInfo\&}{FloatingPosition}{\param{const wxPoint\& }{pos}} | |
| 189 | ||
| 190 | ||
| 191 | \func{wxPaneInfo\&}{FloatingPosition}{\param{int }{x}, \param{int }{y}} | |
| 192 | ||
| 193 | ||
| 194 | \membersection{wxPaneInfo::FloatingSize}\label{wxpaneinfofloatingsize} | |
| 195 | ||
| 196 | \func{wxPaneInfo\&}{FloatingSize}{\param{const wxSize\& }{size}} | |
| 197 | ||
| 198 | ||
| 199 | \func{wxPaneInfo\&}{FloatingSize}{\param{int }{x}, \param{int }{y}} | |
| 200 | ||
| 201 | ||
| 202 | \membersection{wxPaneInfo::Gripper}\label{wxpaneinfogripper} | |
| 203 | ||
| 204 | \func{wxPaneInfo\&}{Gripper}{\param{bool }{visible = true}} | |
| 205 | ||
| 206 | ||
| 207 | \membersection{wxPaneInfo::GripperTop}\label{wxpaneinfogrippertop} | |
| 208 | ||
| 209 | \func{wxPaneInfo\&}{GripperTop}{\param{bool }{attop = true}} | |
| 210 | ||
| 211 | ||
| 212 | \membersection{wxPaneInfo::HasBorder}\label{wxpaneinfohasborder} | |
| 213 | ||
| 214 | \constfunc{bool}{HasBorder}{\void} | |
| 215 | ||
| 216 | ||
| 217 | \membersection{wxPaneInfo::HasCaption}\label{wxpaneinfohascaption} | |
| 218 | ||
| 219 | \constfunc{bool}{HasCaption}{\void} | |
| 220 | ||
| 221 | ||
| 222 | \membersection{wxPaneInfo::HasCloseButton}\label{wxpaneinfohasclosebutton} | |
| 223 | ||
| 224 | \constfunc{bool}{HasCloseButton}{\void} | |
| 225 | ||
| 226 | ||
| 227 | \membersection{wxPaneInfo::HasFlag}\label{wxpaneinfohasflag} | |
| 228 | ||
| 229 | \constfunc{bool}{HasFlag}{\param{unsigned int }{flag}} | |
| 230 | ||
| 231 | ||
| 232 | \membersection{wxPaneInfo::HasGripper}\label{wxpaneinfohasgripper} | |
| 233 | ||
| 234 | \constfunc{bool}{HasGripper}{\void} | |
| 235 | ||
| 236 | ||
| 237 | \membersection{wxPaneInfo::HasGripperTop}\label{wxpaneinfohasgrippertop} | |
| 238 | ||
| 239 | \constfunc{bool}{HasGripperTop}{\void} | |
| 240 | ||
| 241 | ||
| 242 | \membersection{wxPaneInfo::HasMaximizeButton}\label{wxpaneinfohasmaximizebutton} | |
| 243 | ||
| 244 | \constfunc{bool}{HasMaximizeButton}{\void} | |
| 245 | ||
| 246 | ||
| 247 | \membersection{wxPaneInfo::HasMinimizeButton}\label{wxpaneinfohasminimizebutton} | |
| 248 | ||
| 249 | \constfunc{bool}{HasMinimizeButton}{\void} | |
| 250 | ||
| 251 | ||
| 252 | \membersection{wxPaneInfo::HasPinButton}\label{wxpaneinfohaspinbutton} | |
| 253 | ||
| 254 | \constfunc{bool}{HasPinButton}{\void} | |
| 255 | ||
| 256 | ||
| 257 | \membersection{wxPaneInfo::Hide}\label{wxpaneinfohide} | |
| 258 | ||
| 259 | \func{wxPaneInfo\&}{Hide}{\void} | |
| 260 | ||
| 261 | ||
| 262 | \membersection{wxPaneInfo::IsBottomDockable}\label{wxpaneinfoisbottomdockable} | |
| 263 | ||
| 264 | \constfunc{bool}{IsBottomDockable}{\void} | |
| 265 | ||
| 266 | ||
| 267 | \membersection{wxPaneInfo::IsDocked}\label{wxpaneinfoisdocked} | |
| 268 | ||
| 269 | \constfunc{bool}{IsDocked}{\void} | |
| 270 | ||
| 271 | ||
| 272 | \membersection{wxPaneInfo::IsFixed}\label{wxpaneinfoisfixed} | |
| 273 | ||
| 274 | \constfunc{bool}{IsFixed}{\void} | |
| 275 | ||
| 276 | ||
| 277 | \membersection{wxPaneInfo::IsFloatable}\label{wxpaneinfoisfloatable} | |
| 278 | ||
| 279 | \constfunc{bool}{IsFloatable}{\void} | |
| 280 | ||
| 281 | ||
| 282 | \membersection{wxPaneInfo::IsFloating}\label{wxpaneinfoisfloating} | |
| 283 | ||
| 284 | \constfunc{bool}{IsFloating}{\void} | |
| 285 | ||
| 286 | ||
| 287 | \membersection{wxPaneInfo::IsLeftDockable}\label{wxpaneinfoisleftdockable} | |
| 288 | ||
| 289 | \constfunc{bool}{IsLeftDockable}{\void} | |
| 290 | ||
| 291 | ||
| 292 | \membersection{wxPaneInfo::IsMovable}\label{wxpaneinfoismovable} | |
| 293 | ||
| 294 | \constfunc{bool}{IsMovable}{\void} | |
| 295 | ||
| 296 | ||
| 297 | \membersection{wxPaneInfo::IsOk}\label{wxpaneinfoisok} | |
| 298 | ||
| 299 | \constfunc{bool}{IsOk}{\void} | |
| 300 | ||
| 301 | ||
| 302 | \membersection{wxPaneInfo::IsResizable}\label{wxpaneinfoisresizable} | |
| 303 | ||
| 304 | \constfunc{bool}{IsResizable}{\void} | |
| 305 | ||
| 306 | ||
| 307 | \membersection{wxPaneInfo::IsRightDockable}\label{wxpaneinfoisrightdockable} | |
| 308 | ||
| 309 | \constfunc{bool}{IsRightDockable}{\void} | |
| 310 | ||
| 311 | ||
| 312 | \membersection{wxPaneInfo::IsShown}\label{wxpaneinfoisshown} | |
| 313 | ||
| 314 | \constfunc{bool}{IsShown}{\void} | |
| 315 | ||
| 316 | ||
| 317 | \membersection{wxPaneInfo::IsToolbar}\label{wxpaneinfoistoolbar} | |
| 318 | ||
| 319 | \constfunc{bool}{IsToolbar}{\void} | |
| 320 | ||
| 321 | ||
| 322 | \membersection{wxPaneInfo::IsTopDockable}\label{wxpaneinfoistopdockable} | |
| 323 | ||
| 324 | \constfunc{bool}{IsTopDockable}{\void} | |
| 325 | ||
| 326 | ||
| 327 | \membersection{wxPaneInfo::Layer}\label{wxpaneinfolayer} | |
| 328 | ||
| 329 | \func{wxPaneInfo\&}{Layer}{\param{int }{layer}} | |
| 330 | ||
| 331 | ||
| 332 | \membersection{wxPaneInfo::Left}\label{wxpaneinfoleft} | |
| 333 | ||
| 334 | \func{wxPaneInfo\&}{Left}{\void} | |
| 335 | ||
| 336 | ||
| 337 | \membersection{wxPaneInfo::LeftDockable}\label{wxpaneinfoleftdockable} | |
| 338 | ||
| 339 | \func{wxPaneInfo\&}{LeftDockable}{\param{bool }{b = true}} | |
| 340 | ||
| 341 | ||
| 342 | \membersection{wxPaneInfo::MaxSize}\label{wxpaneinfomaxsize} | |
| 343 | ||
| 344 | \func{wxPaneInfo\&}{MaxSize}{\param{const wxSize\& }{size}} | |
| 345 | ||
| 346 | ||
| 347 | \func{wxPaneInfo\&}{MaxSize}{\param{int }{x}, \param{int }{y}} | |
| 348 | ||
| 349 | ||
| 350 | \membersection{wxPaneInfo::MaximizeButton}\label{wxpaneinfomaximizebutton} | |
| 351 | ||
| 352 | \func{wxPaneInfo\&}{MaximizeButton}{\param{bool }{visible = true}} | |
| 353 | ||
| 354 | ||
| 355 | \membersection{wxPaneInfo::MinSize}\label{wxpaneinfominsize} | |
| 356 | ||
| 357 | \func{wxPaneInfo\&}{MinSize}{\param{const wxSize\& }{size}} | |
| 358 | ||
| 359 | ||
| 360 | \func{wxPaneInfo\&}{MinSize}{\param{int }{x}, \param{int }{y}} | |
| 361 | ||
| 362 | ||
| 363 | \membersection{wxPaneInfo::MinimizeButton}\label{wxpaneinfominimizebutton} | |
| 364 | ||
| 365 | \func{wxPaneInfo\&}{MinimizeButton}{\param{bool }{visible = true}} | |
| 366 | ||
| 367 | ||
| 368 | \membersection{wxPaneInfo::Movable}\label{wxpaneinfomovable} | |
| 369 | ||
| 370 | \func{wxPaneInfo\&}{Movable}{\param{bool }{b = true}} | |
| 371 | ||
| 372 | ||
| 373 | \membersection{wxPaneInfo::Name}\label{wxpaneinfoname} | |
| 374 | ||
| 375 | \func{wxPaneInfo\&}{Name}{\param{const wxString\& }{n}} | |
| 376 | ||
| 377 | ||
| 378 | \membersection{wxPaneInfo::PaneBorder}\label{wxpaneinfopaneborder} | |
| 379 | ||
| 380 | \func{wxPaneInfo\&}{PaneBorder}{\param{bool }{visible = true}} | |
| 381 | ||
| 382 | ||
| 383 | \membersection{wxPaneInfo::PinButton}\label{wxpaneinfopinbutton} | |
| 384 | ||
| 385 | \func{wxPaneInfo\&}{PinButton}{\param{bool }{visible = true}} | |
| 386 | ||
| 387 | ||
| 388 | \membersection{wxPaneInfo::Position}\label{wxpaneinfoposition} | |
| 389 | ||
| 390 | \func{wxPaneInfo\&}{Position}{\param{int }{pos}} | |
| 391 | ||
| 392 | ||
| 393 | \membersection{wxPaneInfo::Resizable}\label{wxpaneinforesizable} | |
| 394 | ||
| 395 | \func{wxPaneInfo\&}{Resizable}{\param{bool }{resizable = true}} | |
| 396 | ||
| 397 | ||
| 398 | \membersection{wxPaneInfo::Right}\label{wxpaneinforight} | |
| 399 | ||
| 400 | \func{wxPaneInfo\&}{Right}{\void} | |
| 401 | ||
| 402 | ||
| 403 | \membersection{wxPaneInfo::RightDockable}\label{wxpaneinforightdockable} | |
| 404 | ||
| 405 | \func{wxPaneInfo\&}{RightDockable}{\param{bool }{b = true}} | |
| 406 | ||
| 407 | ||
| 408 | \membersection{wxPaneInfo::Row}\label{wxpaneinforow} | |
| 409 | ||
| 410 | \func{wxPaneInfo\&}{Row}{\param{int }{row}} | |
| 411 | ||
| 412 | ||
| 413 | \membersection{wxPaneInfo::SafeSet}\label{wxpaneinfosafeset} | |
| 414 | ||
| 415 | \func{void}{SafeSet}{\param{wxPaneInfo }{source}} | |
| 416 | ||
| 417 | Write the safe parts of a newly loaded PaneInfo structure "source" into "this" | |
| 418 | used on loading perspectives etc. | |
| 419 | ||
| 420 | ||
| 421 | \membersection{wxPaneInfo::SetFlag}\label{wxpaneinfosetflag} | |
| 422 | ||
| 423 | \func{wxPaneInfo\&}{SetFlag}{\param{unsigned int }{flag}, \param{bool }{option\_state}} | |
| 424 | ||
| 425 | ||
| 426 | \membersection{wxPaneInfo::Show}\label{wxpaneinfoshow} | |
| 427 | ||
| 428 | \func{wxPaneInfo\&}{Show}{\param{bool }{show = true}} | |
| 429 | ||
| 430 | ||
| 431 | \membersection{wxPaneInfo::ToolbarPane}\label{wxpaneinfotoolbarpane} | |
| 432 | ||
| 433 | \func{wxPaneInfo\&}{ToolbarPane}{\void} | |
| 434 | ||
| 435 | ||
| 436 | \membersection{wxPaneInfo::Top}\label{wxpaneinfotop} | |
| 437 | ||
| 438 | \func{wxPaneInfo\&}{Top}{\void} | |
| 439 | ||
| 440 | ||
| 441 | \membersection{wxPaneInfo::TopDockable}\label{wxpaneinfotopdockable} | |
| 442 | ||
| 443 | \func{wxPaneInfo\&}{TopDockable}{\param{bool }{b = true}} | |
| 444 | ||
| 445 | ||
| 446 | \membersection{wxPaneInfo::Window}\label{wxpaneinfowindow} | |
| 447 | ||
| 448 | \func{wxPaneInfo\&}{Window}{\param{wxWindow* }{w}} | |
| 449 | ||
| 450 | ||
| 451 | \membersection{wxPaneInfo::operator=}\label{wxpaneinfooperatorassign} | |
| 452 | ||
| 453 | \func{wxPaneInfo\& operator}{operator=}{\param{const wxPaneInfo\& }{c}} | |
| 454 |