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