1\section{\class{wxAuiPaneInfo}}\label{wxauipaneinfo} 2 3wxAuiPaneInfo is part of the wxAUI class framework. 4See also \helpref{wxAUI overview}{wxauioverview}. 5 6wxAuiPaneInfo specifies all the parameters for a pane. 7These parameters specify where the pane is on the 8screen, whether it is docked or floating, or hidden. 9In addition, these parameters specify the pane's 10docked position, floating position, preferred size, 11minimum size, caption text among many other parameters. 12 13\wxheading{Derived from} 14 15No 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} 29enum 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 44Default constructor. 45 46\func{}{wxAuiPaneInfo}{\param{const wxAuiPaneInfo\& }{c}} 47 48Copy 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 61BestSize() 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 67Bottom() sets the pane dock position to the bottom side of the frame. This is 68the 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 74BottomDockable() 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 80Caption() sets the caption of the pane. 81 82\membersection{wxAuiPaneInfo::CaptionVisible}\label{wxauipaneinfocaptionvisible} 83 84\func{wxAuiPaneInfo\&}{CaptionVisible}{\param{bool }{visible = true}} 85 86CaptionVisible 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 94Center() sets the pane dock position to the left side of the frame. 95The centre pane is the space in the middle after all border panes (left, top, right, bottom) are subtracted from the layout. 96 97This 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 105CentrePane() 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 111CloseButton() 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 117DefaultPane() 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 123DestroyOnClose() 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 129Direction() 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 135Dock() indicates that a pane should be docked. It is the opposite of Float(). 136 137\membersection{wxAuiPaneInfo::DockFixed}\label{wxauipaneinfodockfixed} 138 139\func{wxAuiPaneInfo\&}{DockFixed}{\param{bool }{b = true}} 140 141DockFixed() causes the containing dock to have no resize sash. This is useful for creating panes that span the entire width or height of a dock, but should not be resizable in the other direction. 142 143\membersection{wxAuiPaneInfo::Dockable}\label{wxauipaneinfodockable} 144 145\func{wxAuiPaneInfo\&}{Dockable}{\param{bool }{b = true}} 146 147Dockable() specifies whether a frame can be docked or not. It is the same as specifying TopDockable(b).BottomDockable(b).LeftDockable(b).RightDockable(b). 148 149\membersection{wxAuiPaneInfo::Fixed}\label{wxauipaneinfofixed} 150 151\func{wxAuiPaneInfo\&}{Fixed}{\void} 152 153Fixed() forces a pane to be fixed size so that it cannot be resized. After calling Fixed(), IsFixed() will return true. 154 155\membersection{wxAuiPaneInfo::Float}\label{wxauipaneinfofloat} 156 157\func{wxAuiPaneInfo\&}{Float}{\void} 158 159Float() indicates that a pane should be floated. It is the opposite of Dock(). 160 161\membersection{wxAuiPaneInfo::Floatable}\label{wxauipaneinfofloatable} 162 163\func{wxAuiPaneInfo\&}{Floatable}{\param{bool }{b = true}} 164 165Floatable() sets whether the user will be able to undock a pane and turn it into a floating window. 166 167\membersection{wxAuiPaneInfo::FloatingPosition}\label{wxauipaneinfofloatingposition} 168 169\func{wxAuiPaneInfo\&}{FloatingPosition}{\param{const wxPoint\& }{pos}} 170 171\func{wxAuiPaneInfo\&}{FloatingPosition}{\param{int }{x}, \param{int }{y}} 172 173FloatingPosition() sets the position of the floating pane. 174 175\membersection{wxAuiPaneInfo::FloatingSize}\label{wxauipaneinfofloatingsize} 176 177\func{wxAuiPaneInfo\&}{FloatingSize}{\param{const wxSize\& }{size}} 178 179\func{wxAuiPaneInfo\&}{FloatingSize}{\param{int }{x}, \param{int }{y}} 180 181FloatingSize() sets the size of the floating pane. 182 183\membersection{wxAuiPaneInfo::Gripper}\label{wxauipaneinfogripper} 184 185\func{wxAuiPaneInfo\&}{Gripper}{\param{bool }{visible = true}} 186 187Gripper() indicates that a gripper should be drawn for the pane. 188 189\membersection{wxAuiPaneInfo::GripperTop}\label{wxauipaneinfogrippertop} 190 191\func{wxAuiPaneInfo\&}{GripperTop}{\param{bool }{attop = true}} 192 193GripperTop() indicates that a gripper should be drawn at the top of the pane. 194 195\membersection{wxAuiPaneInfo::HasBorder}\label{wxauipaneinfohasborder} 196 197\constfunc{bool}{HasBorder}{\void} 198 199HasBorder() returns true if the pane displays a border. 200 201\membersection{wxAuiPaneInfo::HasCaption}\label{wxauipaneinfohascaption} 202 203\constfunc{bool}{HasCaption}{\void} 204 205HasCaption() returns true if the pane displays a caption. 206 207\membersection{wxAuiPaneInfo::HasCloseButton}\label{wxauipaneinfohasclosebutton} 208 209\constfunc{bool}{HasCloseButton}{\void} 210 211HasCloseButton() returns true if the pane displays a button to close the pane. 212 213\membersection{wxAuiPaneInfo::HasFlag}\label{wxauipaneinfohasflag} 214 215\constfunc{bool}{HasFlag}{\param{unsigned int }{flag}} 216 217HasFlag() returns true if the the property specified by flag is active for the pane. 218 219\membersection{wxAuiPaneInfo::HasGripper}\label{wxauipaneinfohasgripper} 220 221\constfunc{bool}{HasGripper}{\void} 222 223HasGripper() returns true if the pane displays a gripper. 224 225\membersection{wxAuiPaneInfo::HasGripperTop}\label{wxauipaneinfohasgrippertop} 226 227\constfunc{bool}{HasGripperTop}{\void} 228 229HasGripper() returns true if the pane displays a gripper at the top. 230 231\membersection{wxAuiPaneInfo::HasMaximizeButton}\label{wxauipaneinfohasmaximizebutton} 232 233\constfunc{bool}{HasMaximizeButton}{\void} 234 235HasMaximizeButton() returns true if the pane displays a button to maximize the pane. 236 237\membersection{wxAuiPaneInfo::HasMinimizeButton}\label{wxauipaneinfohasminimizebutton} 238 239\constfunc{bool}{HasMinimizeButton}{\void} 240 241HasMinimizeButton() returns true if the pane displays a button to minimize the pane. 242 243\membersection{wxAuiPaneInfo::HasPinButton}\label{wxauipaneinfohaspinbutton} 244 245\constfunc{bool}{HasPinButton}{\void} 246 247HasPinButton() returns true if the pane displays a button to float the pane. 248 249\membersection{wxAuiPaneInfo::Hide}\label{wxauipaneinfohide} 250 251\func{wxAuiPaneInfo\&}{Hide}{\void} 252 253Hide() indicates that a pane should be hidden. 254 255\membersection{wxAuiPaneInfo::IsBottomDockable}\label{wxauipaneinfoisbottomdockable} 256 257\constfunc{bool}{IsBottomDockable}{\void} 258 259IsBottomDockable() returns true if the pane can be docked at the bottom of the managed frame. 260 261\membersection{wxAuiPaneInfo::IsDocked}\label{wxauipaneinfoisdocked} 262 263\constfunc{bool}{IsDocked}{\void} 264 265IsDocked() returns true if the pane is docked. 266 267\membersection{wxAuiPaneInfo::IsFixed}\label{wxauipaneinfoisfixed} 268 269\constfunc{bool}{IsFixed}{\void} 270 271IsFixed() returns true if the pane cannot be resized. 272 273\membersection{wxAuiPaneInfo::IsFloatable}\label{wxauipaneinfoisfloatable} 274 275\constfunc{bool}{IsFloatable}{\void} 276 277IsFloatable() returns true if the pane can be undocked and displayed as a floating window. 278 279\membersection{wxAuiPaneInfo::IsFloating}\label{wxauipaneinfoisfloating} 280 281\constfunc{bool}{IsFloating}{\void} 282 283IsFloating() returns true if the pane is floating. 284 285\membersection{wxAuiPaneInfo::IsLeftDockable}\label{wxauipaneinfoisleftdockable} 286 287\constfunc{bool}{IsLeftDockable}{\void} 288 289IsLeftDockable() returns true if the pane can be docked on the left of the managed frame. 290 291\membersection{wxAuiPaneInfo::IsMovable}\label{wxauipaneinfoismovable} 292 293\constfunc{bool}{IsMovable}{\void} 294 295IsMoveable() returns true if the docked frame can be undocked or moved to another dock position. 296 297\membersection{wxAuiPaneInfo::IsOk}\label{wxauipaneinfoisok} 298 299\constfunc{bool}{IsOk}{\void} 300 301IsOk() returns true if the wxAuiPaneInfo structure is valid. A pane structure is valid if it has an associated window. 302 303\membersection{wxAuiPaneInfo::IsResizable}\label{wxauipaneinfoisresizable} 304 305\constfunc{bool}{IsResizable}{\void} 306 307IsResizable() returns true if the pane can be resized. 308 309\membersection{wxAuiPaneInfo::IsRightDockable}\label{wxauipaneinfoisrightdockable} 310 311\constfunc{bool}{IsRightDockable}{\void} 312 313IsRightDockable() returns true if the pane can be docked on the right of the managed frame. 314 315\membersection{wxAuiPaneInfo::IsShown}\label{wxauipaneinfoisshown} 316 317\constfunc{bool}{IsShown}{\void} 318 319IsShown() returns true if the pane is currently shown. 320 321\membersection{wxAuiPaneInfo::IsToolbar}\label{wxauipaneinfoistoolbar} 322 323\constfunc{bool}{IsToolbar}{\void} 324 325IsToolbar() returns true if the pane contains a toolbar. 326 327\membersection{wxAuiPaneInfo::IsTopDockable}\label{wxauipaneinfoistopdockable} 328 329\constfunc{bool}{IsTopDockable}{\void} 330 331IsTopDockable() returns true if the pane can be docked at the top of the managed frame. 332 333\membersection{wxAuiPaneInfo::Layer}\label{wxauipaneinfolayer} 334 335\func{wxAuiPaneInfo\&}{Layer}{\param{int }{layer}} 336 337Layer() 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. 338 339\membersection{wxAuiPaneInfo::Left}\label{wxauipaneinfoleft} 340 341\func{wxAuiPaneInfo\&}{Left}{\void} 342 343Left() sets the pane dock position to the left side of the frame. This is the 344same thing as calling Direction(wxAUI\_DOCK\_LEFT). 345 346\membersection{wxAuiPaneInfo::LeftDockable}\label{wxauipaneinfoleftdockable} 347 348\func{wxAuiPaneInfo\&}{LeftDockable}{\param{bool }{b = true}} 349 350LeftDockable() indicates whether a pane can be docked on the left of the frame. 351 352\membersection{wxAuiPaneInfo::MaxSize}\label{wxauipaneinfomaxsize} 353 354\func{wxAuiPaneInfo\&}{MaxSize}{\param{const wxSize\& }{size}} 355 356\func{wxAuiPaneInfo\&}{MaxSize}{\param{int }{x}, \param{int }{y}} 357 358MaxSize() sets the maximum size of the pane. 359 360\membersection{wxAuiPaneInfo::MaximizeButton}\label{wxauipaneinfomaximizebutton} 361 362\func{wxAuiPaneInfo\&}{MaximizeButton}{\param{bool }{visible = true}} 363 364MaximizeButton() indicates that a maximize button should be drawn for the pane. 365 366\membersection{wxAuiPaneInfo::MinSize}\label{wxauipaneinfominsize} 367 368\func{wxAuiPaneInfo\&}{MinSize}{\param{const wxSize\& }{size}} 369 370\func{wxAuiPaneInfo\&}{MinSize}{\param{int }{x}, \param{int }{y}} 371 372MinSize() sets the minimum size of the pane. Please note that this is only partially supported as of this writing. 373 374\membersection{wxAuiPaneInfo::MinimizeButton}\label{wxauipaneinfominimizebutton} 375 376\func{wxAuiPaneInfo\&}{MinimizeButton}{\param{bool }{visible = true}} 377 378MinimizeButton() indicates that a minimize button should be drawn for the pane. 379 380\membersection{wxAuiPaneInfo::Movable}\label{wxauipaneinfomovable} 381 382\func{wxAuiPaneInfo\&}{Movable}{\param{bool }{b = true}} 383 384Movable indicates whether a frame can be moved. 385 386\membersection{wxAuiPaneInfo::Name}\label{wxauipaneinfoname} 387 388\func{wxAuiPaneInfo\&}{Name}{\param{const wxString\& }{n}} 389 390Name() 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. 391 392\membersection{wxAuiPaneInfo::PaneBorder}\label{wxauipaneinfopaneborder} 393 394\func{wxAuiPaneInfo\&}{PaneBorder}{\param{bool }{visible = true}} 395 396PaneBorder indicates that a border should be drawn for the pane. 397 398\membersection{wxAuiPaneInfo::PinButton}\label{wxauipaneinfopinbutton} 399 400\func{wxAuiPaneInfo\&}{PinButton}{\param{bool }{visible = true}} 401 402PinButton() indicates that a pin button should be drawn for the pane. 403 404\membersection{wxAuiPaneInfo::Position}\label{wxauipaneinfoposition} 405 406\func{wxAuiPaneInfo\&}{Position}{\param{int }{pos}} 407 408Position() determines the position of the docked pane. 409 410\membersection{wxAuiPaneInfo::Resizable}\label{wxauipaneinforesizable} 411 412\func{wxAuiPaneInfo\&}{Resizable}{\param{bool }{resizable = true}} 413 414Resizable() 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(). 415 416\membersection{wxAuiPaneInfo::Right}\label{wxauipaneinforight} 417 418\func{wxAuiPaneInfo\&}{Right}{\void} 419 420Right() sets the pane dock position to the right side of the frame. 421 422\membersection{wxAuiPaneInfo::RightDockable}\label{wxauipaneinforightdockable} 423 424\func{wxAuiPaneInfo\&}{RightDockable}{\param{bool }{b = true}} 425 426RightDockable() indicates whether a pane can be docked on the right of the frame. 427 428\membersection{wxAuiPaneInfo::Row}\label{wxauipaneinforow} 429 430\func{wxAuiPaneInfo\&}{Row}{\param{int }{row}} 431 432Row() determines the row of the docked pane. 433 434\membersection{wxAuiPaneInfo::SafeSet}\label{wxauipaneinfosafeset} 435 436\func{void}{SafeSet}{\param{wxAuiPaneInfo }{source}} 437 438Write the safe parts of a newly loaded PaneInfo structure "source" into "this" 439used on loading perspectives etc. 440 441\membersection{wxAuiPaneInfo::SetFlag}\label{wxauipaneinfosetflag} 442 443\func{wxAuiPaneInfo\&}{SetFlag}{\param{unsigned int }{flag}, \param{bool }{option\_state}} 444 445SetFlag() turns the property given by flag on or off with the option\_state parameter. 446 447\membersection{wxAuiPaneInfo::Show}\label{wxauipaneinfoshow} 448 449\func{wxAuiPaneInfo\&}{Show}{\param{bool }{show = true}} 450 451Show() indicates that a pane should be shown. 452 453\membersection{wxAuiPaneInfo::ToolbarPane}\label{wxauipaneinfotoolbarpane} 454 455\func{wxAuiPaneInfo\&}{ToolbarPane}{\void} 456 457ToolbarPane() specifies that the pane should adopt the default toolbar pane settings. 458 459\membersection{wxAuiPaneInfo::Top}\label{wxauipaneinfotop} 460 461\func{wxAuiPaneInfo\&}{Top}{\void} 462 463Top() sets the pane dock position to the top of the frame. 464 465\membersection{wxAuiPaneInfo::TopDockable}\label{wxauipaneinfotopdockable} 466 467\func{wxAuiPaneInfo\&}{TopDockable}{\param{bool }{b = true}} 468 469TopDockable() indicates whether a pane can be docked at the top of the frame. 470 471\membersection{wxAuiPaneInfo::Window}\label{wxauipaneinfowindow} 472 473\func{wxAuiPaneInfo\&}{Window}{\param{wxWindow* }{w}} 474 475Window() 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. 476 477\membersection{wxAuiPaneInfo::operator=}\label{wxauipaneinfooperatorassign} 478 479\func{wxAuiPaneInfo\& operator}{operator=}{\param{const wxAuiPaneInfo\& }{c}} 480 481Makes a copy of the wxAuiPaneInfo object. 482 483