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