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