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 the same thing as calling Direction(wxAUI_DOCK_BOTTOM).
  67
  68 \membersection{wxAuiPaneInfo::BottomDockable}\label{wxauipaneinfobottomdockable}
  69
  70 \func{wxAuiPaneInfo\&}{BottomDockable}{\param{bool }{b = true}}
  71
  72 BottomDockable() indicates whether a pane can be docked at the bottom of the frame.
  73
  74 \membersection{wxAuiPaneInfo::Caption}\label{wxauipaneinfocaption}
  75
  76 \func{wxAuiPaneInfo\&}{Caption}{\param{const wxString\& }{c}}
  77
  78 Caption() sets the caption of the pane.
  79
  80 \membersection{wxAuiPaneInfo::CaptionVisible}\label{wxauipaneinfocaptionvisible}
  81
  82 \func{wxAuiPaneInfo\&}{CaptionVisible}{\param{bool }{visible = true}}
  83
  84 CaptionVisible indicates that a pane caption should be visible.  If false, no pane caption is drawn.
  85
  86 \membersection{wxAuiPaneInfo::Centre}\label{wxauipaneinfocentre}
  87
  88 \func{wxAuiPaneInfo\&}{Centre}{\void}
  89 \func{wxAuiPaneInfo\&}{Center}{\void}
  90
  91 Center() sets the pane dock position to the left side of the frame.  This is the same thing as calling Direction(wxAUI_DOCK_CENTRE).
  92
  93 \membersection{wxAuiPaneInfo::CentrePane}\label{wxauipaneinfocentrepane}
  94
  95 \func{wxAuiPaneInfo\&}{CentrePane}{\void}
  96 \func{wxAuiPaneInfo\&}{CenterPane}{\void}
  97
  98 CentrePane() specifies that the pane should adopt the default centre pane settings.
  99
 100 \membersection{wxAuiPaneInfo::Centre}\label{wxauipaneinfocentre}
 101
 102 \func{wxAuiPaneInfo\&}{Centre}{\void}
 103 \func{wxAuiPaneInfo\&}{Center}{\void}
 104
 105 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.
 106
 107 \membersection{wxAuiPaneInfo::CentrePane}\label{wxauipaneinfocentrepane}
 108
 109 \func{wxAuiPaneInfo\&}{CentrePane}{\void}
 110 \func{wxAuiPaneInfo\&}{CenterPane}{\void}
 111
 112 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.
 113
 114 \membersection{wxAuiPaneInfo::CloseButton}\label{wxauipaneinfoclosebutton}
 115
 116 \func{wxAuiPaneInfo\&}{CloseButton}{\param{bool }{visible = true}}
 117
 118 CloseButton() indicates that a close button should be drawn for the pane.
 119
 120 \membersection{wxAuiPaneInfo::DefaultPane}\label{wxauipaneinfodefaultpane}
 121
 122 \func{wxAuiPaneInfo\&}{DefaultPane}{\void}
 123
 124 DefaultPane() specifies that the pane should adopt the default pane settings.
 125
 126 \membersection{wxAuiPaneInfo::DestroyOnClose}\label{wxauipaneinfodestroyonclose}
 127
 128 \func{wxAuiPaneInfo\&}{DestroyOnClose}{\param{bool }{b = true}}
 129
 130 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.
 131
 132 \membersection{wxAuiPaneInfo::Direction}\label{wxauipaneinfodirection}
 133
 134 \func{wxAuiPaneInfo\&}{Direction}{\param{int }{direction}}
 135
 136 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.
 137
 138 \membersection{wxAuiPaneInfo::Dock}\label{wxauipaneinfodock}
 139
 140 \func{wxAuiPaneInfo\&}{Dock}{\void}
 141
 142
 143 \membersection{wxAuiPaneInfo::Dockable}\label{wxauipaneinfodockable}
 144
 145 \func{wxAuiPaneInfo\&}{Dockable}{\param{bool }{b = true}}
 146
 147 Dockable() 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
 153 Fixed() 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
 159 Float() indicates that a pane should be floated.
 160
 161 \membersection{wxAuiPaneInfo::Floatable}\label{wxauipaneinfofloatable}
 162
 163 \func{wxAuiPaneInfo\&}{Floatable}{\param{bool }{b = true}}
 164
 165 Floatable() 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 \func{wxAuiPaneInfo\&}{FloatingPosition}{\param{int }{x}, \param{int }{y}}
 171
 172 FloatingPosition() sets the position of the floating pane.
 173
 174 \membersection{wxAuiPaneInfo::FloatingSize}\label{wxauipaneinfofloatingsize}
 175
 176 \func{wxAuiPaneInfo\&}{FloatingSize}{\param{const wxSize\& }{size}}
 177 \func{wxAuiPaneInfo\&}{FloatingSize}{\param{int }{x}, \param{int }{y}}
 178
 179 FloatingSize() sets the size of the floating pane.
 180
 181 \membersection{wxAuiPaneInfo::Gripper}\label{wxauipaneinfogripper}
 182
 183 \func{wxAuiPaneInfo\&}{Gripper}{\param{bool }{visible = true}}
 184
 185 Gripper() indicates that a gripper should be drawn for the pane.
 186
 187 \membersection{wxAuiPaneInfo::GripperTop}\label{wxauipaneinfogrippertop}
 188
 189 \func{wxAuiPaneInfo\&}{GripperTop}{\param{bool }{attop = true}}
 190
 191 GripperTop() indicates that a gripper should be drawn at the top of the pane.
 192
 193 \membersection{wxAuiPaneInfo::HasBorder}\label{wxauipaneinfohasborder}
 194
 195 \constfunc{bool}{HasBorder}{\void}
 196
 197 HasBorder() returns true if the pane displays a border.
 198
 199 \membersection{wxAuiPaneInfo::HasCaption}\label{wxauipaneinfohascaption}
 200
 201 \constfunc{bool}{HasCaption}{\void}
 202
 203 HasCaption() returns true if the pane displays a caption.
 204
 205 \membersection{wxAuiPaneInfo::HasCloseButton}\label{wxauipaneinfohasclosebutton}
 206
 207 \constfunc{bool}{HasCloseButton}{\void}
 208
 209 HasCloseButton() returns true if the pane displays a button to close the pane.
 210
 211 \membersection{wxAuiPaneInfo::HasFlag}\label{wxauipaneinfohasflag}
 212
 213 \constfunc{bool}{HasFlag}{\param{unsigned int }{flag}}
 214
 215 HasFlag() returns true if the the property specified by flag is active for the pane.
 216
 217 \membersection{wxAuiPaneInfo::HasGripper}\label{wxauipaneinfohasgripper}
 218
 219 \constfunc{bool}{HasGripper}{\void}
 220
 221 HasGripper() returns true if the pane displays a gripper.
 222
 223 \membersection{wxAuiPaneInfo::HasGripperTop}\label{wxauipaneinfohasgrippertop}
 224
 225 \constfunc{bool}{HasGripperTop}{\void}
 226
 227 HasGripper() returns true if the pane displays a gripper at the top.
 228
 229 \membersection{wxAuiPaneInfo::HasMaximizeButton}\label{wxauipaneinfohasmaximizebutton}
 230
 231 \constfunc{bool}{HasMaximizeButton}{\void}
 232
 233 HasMaximizeButton() returns true if the pane displays a button to maximize the pane.
 234
 235 \membersection{wxAuiPaneInfo::HasMinimizeButton}\label{wxauipaneinfohasminimizebutton}
 236
 237 \constfunc{bool}{HasMinimizeButton}{\void}
 238
 239 HasMinimizeButton() returns true if the pane displays a button to minimize the pane.
 240
 241 \membersection{wxAuiPaneInfo::HasPinButton}\label{wxauipaneinfohaspinbutton}
 242
 243 \constfunc{bool}{HasPinButton}{\void}
 244
 245 HasPinButton() returns true if the pane displays a button to float the pane.
 246
 247 \membersection{wxAuiPaneInfo::Hide}\label{wxauipaneinfohide}
 248
 249 \func{wxAuiPaneInfo\&}{Hide}{\void}
 250
 251 Hide() indicates that a pane should be hidden.
 252
 253 \membersection{wxAuiPaneInfo::IsBottomDockable}\label{wxauipaneinfoisbottomdockable}
 254
 255 \constfunc{bool}{IsBottomDockable}{\void}
 256
 257 IsBottomDockable() returns true if the pane can be docked at the bottom of the managed frame.
 258
 259 \membersection{wxAuiPaneInfo::IsDocked}\label{wxauipaneinfoisdocked}
 260
 261 \constfunc{bool}{IsDocked}{\void}
 262
 263 IsDocked() returns true if the pane is docked.
 264
 265 \membersection{wxAuiPaneInfo::IsFixed}\label{wxauipaneinfoisfixed}
 266
 267 \constfunc{bool}{IsFixed}{\void}
 268
 269 IsFixed() returns true if the pane cannot be resized.
 270
 271 \membersection{wxAuiPaneInfo::IsFloatable}\label{wxauipaneinfoisfloatable}
 272
 273 \constfunc{bool}{IsFloatable}{\void}
 274
 275 IsFloatable() returns true if the pane can be undocked and displayed as a floating window.
 276
 277 \membersection{wxAuiPaneInfo::IsFloating}\label{wxauipaneinfoisfloating}
 278
 279 \constfunc{bool}{IsFloating}{\void}
 280
 281 IsFloating() returns true if the pane is floating.
 282
 283 \membersection{wxAuiPaneInfo::IsLeftDockable}\label{wxauipaneinfoisleftdockable}
 284
 285 \constfunc{bool}{IsLeftDockable}{\void}
 286
 287 IsLeftDockable() returns true if the pane can be docked on the left of the managed frame.
 288
 289 \membersection{wxAuiPaneInfo::IsMovable}\label{wxauipaneinfoismovable}
 290
 291 \constfunc{bool}{IsMovable}{\void}
 292
 293 IsMoveable() returns true if the docked frame can be undocked or moved to another dock position.
 294
 295 \membersection{wxAuiPaneInfo::IsOk}\label{wxauipaneinfoisok}
 296
 297 \constfunc{bool}{IsOk}{\void}
 298
 299 IsOk() returns true if the wxAuiPaneInfo structure is valid.  A pane structure is valid if it has an associated window.
 300
 301 \membersection{wxAuiPaneInfo::IsResizable}\label{wxauipaneinfoisresizable}
 302
 303 \constfunc{bool}{IsResizable}{\void}
 304
 305 IsResizable() returns true if the pane can be resized.
 306
 307 \membersection{wxAuiPaneInfo::IsRightDockable}\label{wxauipaneinfoisrightdockable}
 308
 309 \constfunc{bool}{IsRightDockable}{\void}
 310
 311 IsRightDockable() returns true if the pane can be docked on the right of the managed frame.
 312
 313 \membersection{wxAuiPaneInfo::IsShown}\label{wxauipaneinfoisshown}
 314
 315 \constfunc{bool}{IsShown}{\void}
 316
 317 IsShown() returns true if the pane is currently shown.
 318
 319 \membersection{wxAuiPaneInfo::IsToolbar}\label{wxauipaneinfoistoolbar}
 320
 321 \constfunc{bool}{IsToolbar}{\void}
 322
 323 IsToolbar() returns true if the pane contains a toolbar.
 324
 325 \membersection{wxAuiPaneInfo::IsTopDockable}\label{wxauipaneinfoistopdockable}
 326
 327 \constfunc{bool}{IsTopDockable}{\void}
 328
 329 IsTopDockable() returns true if the pane can be docked at the top of the managed frame.
 330
 331 \membersection{wxAuiPaneInfo::Layer}\label{wxauipaneinfolayer}
 332
 333 \func{wxAuiPaneInfo\&}{Layer}{\param{int }{layer}}
 334
 335 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.
 336
 337 \membersection{wxAuiPaneInfo::Left}\label{wxauipaneinfoleft}
 338
 339 \func{wxAuiPaneInfo\&}{Left}{\void}
 340
 341 Left() sets the pane dock position to the left side of the frame.  This is the same thing as calling Direction(wxAUI_DOCK_LEFT).
 342
 343 \membersection{wxAuiPaneInfo::LeftDockable}\label{wxauipaneinfoleftdockable}
 344
 345 \func{wxAuiPaneInfo\&}{LeftDockable}{\param{bool }{b = true}}
 346
 347 LeftDockable() indicates whether a pane can be docked on the left of the frame.
 348
 349 \membersection{wxAuiPaneInfo::MaxSize}\label{wxauipaneinfomaxsize}
 350
 351 \func{wxAuiPaneInfo\&}{MaxSize}{\param{const wxSize\& }{size}}
 352 \func{wxAuiPaneInfo\&}{MaxSize}{\param{int }{x}, \param{int }{y}}
 353
 354 MaxSize() sets the maximum size of the pane.
 355
 356 \membersection{wxAuiPaneInfo::MaximizeButton}\label{wxauipaneinfomaximizebutton}
 357
 358 \func{wxAuiPaneInfo\&}{MaximizeButton}{\param{bool }{visible = true}}
 359
 360 MaximizeButton() indicates that a maximize button should be drawn for the pane.
 361
 362 \membersection{wxAuiPaneInfo::MinSize}\label{wxauipaneinfominsize}
 363
 364 \func{wxAuiPaneInfo\&}{MinSize}{\param{const wxSize\& }{size}}
 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