docs/latex/wx/framemanager.tex

   1 \section{\class{wxFrameManager}}\label{wxframemanager}
   2
   3 wxFrameManager is the central class of the wxAUI class framework.
   4
   5 See also \helpref{wxAUI overview}{wxauioverview}.
   6
   7 wxFrameManager manages the panes associated with it
   8 for a particular wxFrame, using a pane's wxPaneInfo information to
   9 determine each pane's docking and floating behavior. wxFrameManager
  10 uses wxWidgets' sizer mechanism to plan the layout of each frame. It
  11 uses a replaceable dock art class to do all drawing, so all drawing is
  12 localized in one area, and may be customized depending on an
  13 applications' specific needs.
  14
  15 wxFrameManager works as follows: The programmer adds panes to the class,
  16 or makes changes to existing pane properties (dock position, floating
  17 state, show state, etc.). To apply these changes, wxFrameManager's
  18 Update() function is called. This batch processing can be used to avoid
  19 flicker, by modifying more than one pane at a time, and then "committing"
  20 all of the changes at once by calling Update().
  21
  22 Panes can be added quite easily:
  23
  24 \begin{verbatim}
  25 wxTextCtrl* text1 = new wxTextCtrl(this, -1);
  26 wxTextCtrl* text2 = new wxTextCtrl(this, -1);
  27 m_mgr.AddPane(text1, wxLEFT, wxT("Pane Caption"));
  28 m_mgr.AddPane(text2, wxBOTTOM, wxT("Pane Caption"));
  29 m_mgr.Update();
  30 \end{verbatim}
  31
  32 Later on, the positions can be modified easily. The following will float
  33 an existing pane in a tool window:
  34
  35 \begin{verbatim}
  36 m_mgr.GetPane(text1).Float();
  37 \end{verbatim}
  38
  39 \wxheading{Layers, Rows and Directions, Positions}
  40
  41 Inside wxAUI, the docking layout is figured out by checking several
  42 pane parameters. Four of these are important for determining where a
  43 pane will end up:
  44
  45 {\bf Direction:}
  46 Each docked pane has a direction, Top, Bottom, Left, Right, or
  47 Center. This is fairly self-explanatory. The pane will be placed in the
  48 location specified by this variable.
  49
  50 {\bf Position:}
  51 More than one pane can be placed inside of a dock. Imagine to panes
  52 being docked on the left side of a window. One pane can be placed over
  53 another. In proportionally managed docks, the pane position indicates
  54 it's sequential position, starting with zero. So, in our scenario with
  55 two panes docked on the left side, the top pane in the dock would have
  56 position 0, and the second one would occupy position 1.
  57
  58 {\bf Row:}
  59 A row can allow for two docks to be placed next to each other. One of
  60 the most common places for this to happen is in the toolbar. Multiple
  61 toolbar rows are allowed, the first row being in row 0, and the second
  62 in row 1. Rows can also be used on vertically docked panes.
  63
  64
  65 {\bf Layer:}
  66 A layer is akin to an onion. Layer 0 is the very center of the
  67 managed pane. Thus, if a pane is in layer 0, it will be closest to the
  68 center window (also sometimes known as the "content window").
  69 Increasing layers "swallow up" all layers of a lower value. This can
  70 look very similar to multiple rows, but is different because all panes
  71 in a lower level yield to panes in higher levels. The best way to
  72 understand layers is by running the wxAUI sample.
  73
  74 \wxheading{Derived from}
  75
  76 \helpref{wxEvent}{wxevent}
  77
  78 \wxheading{Include files}
  79
  80 <wx/aui/aui.h>
  81
  82 \wxheading{See also}
  83
  84 \helpref{wxPaneInfo}{wxpaneinfo}
  85
  86 \wxheading{Data structures}
  87
  88 \begin{verbatim}
  89 enum wxFrameManagerDock
  90 {
  91     wxAUI_DOCK_NONE = 0,
  92     wxAUI_DOCK_TOP = 1,
  93     wxAUI_DOCK_RIGHT = 2,
  94     wxAUI_DOCK_BOTTOM = 3,
  95     wxAUI_DOCK_LEFT = 4,
  96     wxAUI_DOCK_CENTER = 5,
  97     wxAUI_DOCK_CENTRE = wxAUI_DOCK_CENTER
  98 }
  99 \end{verbatim}
 100
 101 \begin{verbatim}
 102 enum wxFrameManagerOption
 103 {
 104     wxAUI_MGR_ALLOW_FLOATING           = 1 << 0,
 105     wxAUI_MGR_ALLOW_ACTIVE_PANE        = 1 << 1,
 106     wxAUI_MGR_TRANSPARENT_DRAG         = 1 << 2,
 107     wxAUI_MGR_TRANSPARENT_HINT         = 1 << 3,
 108     wxAUI_MGR_VENETIAN_BLINDS_HINT     = 1 << 4,
 109     wxAUI_MGR_RECTANGLE_HINT           = 1 << 5,
 110     wxAUI_MGR_HINT_FADE                = 1 << 6,
 111     wxAUI_MGR_NO_VENETIAN_BLINDS_FADE  = 1 << 7,
 112
 113     wxAUI_MGR_DEFAULT = wxAUI_MGR_ALLOW_FLOATING |
 114                         wxAUI_MGR_TRANSPARENT_HINT |
 115                         wxAUI_MGR_HINT_FADE |
 116                         wxAUI_MGR_NO_VENETIAN_BLINDS_FADE
 117 }
 118 \end{verbatim}
 119
 120
 121 \latexignore{\rtfignore{\wxheading{Members}}}
 122
 123
 124 \membersection{wxFrameManager::wxFrameManager}\label{wxframemanagerwxframemanager}
 125
 126 \func{}{wxFrameManager}{\param{wxWindow* }{managed\_wnd = NULL}, \param{unsigned int }{flags = wxAUI\_MGR\_DEFAULT}}
 127
 128 Constructor. \arg{frame} specifies the wxFrame which should be managed.
 129 \arg{flags}  specifies options which allow the frame management behavior
 130 to be modified.
 131
 132 \membersection{wxFrameManager::\destruct{wxFrameManager}}\label{wxframemanagerdtor}
 133
 134 \func{}{\destruct{wxFrameManager}}{\void}
 135
 136
 137 \membersection{wxFrameManager::AddPane}\label{wxframemanageraddpane}
 138
 139 \func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{pane\_info}}
 140
 141
 142 \func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{pane\_info}, \param{const wxPoint\& }{drop\_pos}}
 143
 144
 145 \func{bool}{AddPane}{\param{wxWindow* }{window}, \param{int }{direction = wxLEFT}, \param{const wxString\& }{caption = wxEmptyString}}
 146
 147 Tells the frame manager to start managing a child window.
 148
 149 \membersection{wxFrameManager::DetachPane}\label{wxframemanagerdetachpane}
 150
 151 \func{bool}{DetachPane}{\param{wxWindow* }{window}}
 152
 153 Tells the wxFrameManager to stop managing the pane specified by window.
 154 The window, if in a floated frame, is reparented to the frame managed
 155 by wxFrameManager.
 156
 157 \membersection{wxFrameManager::DoDrop}\label{wxframemanagerdodrop}
 158
 159 \func{bool}{DoDrop}{\param{wxDockInfoArray\& }{docks}, \param{wxPaneInfoArray\& }{panes}, \param{wxPaneInfo\& }{drop}, \param{const wxPoint\& }{pt}, \param{const wxPoint\& }{action\_offset = wxPoint(0,0)}}
 160
 161
 162 \membersection{wxFrameManager::DoFrameLayout}\label{wxframemanagerdoframelayout}
 163
 164 \func{void}{DoFrameLayout}{\void}
 165
 166
 167 \membersection{wxFrameManager::DrawHintRect}\label{wxframemanagerdrawhintrect}
 168
 169 \func{void}{DrawHintRect}{\param{wxWindow* }{pane\_window}, \param{const wxPoint\& }{pt}, \param{const wxPoint\& }{offset}}
 170
 171
 172 \membersection{wxFrameManager::GetAllPanes}\label{wxframemanagergetallpanes}
 173
 174 \func{wxPaneInfoArray\&}{GetAllPanes}{\void}
 175
 176 Returns an array of all panes managed by the frame manager.
 177
 178 \membersection{wxFrameManager::GetArtProvider}\label{wxframemanagergetartprovider}
 179
 180 \constfunc{wxDockArt*}{GetArtProvider}{\void}
 181
 182 Returns the current art provider being used.
 183
 184 \membersection{wxFrameManager::GetDockPixelOffset}\label{wxframemanagergetdockpixeloffset}
 185
 186 \func{int}{GetDockPixelOffset}{\param{wxPaneInfo\& }{test}}
 187
 188
 189 \membersection{wxFrameManager::GetFlags}\label{wxframemanagergetflags}
 190
 191 \constfunc{unsigned int}{GetFlags}{\void}
 192
 193 Returns the current manager's flags.
 194
 195 \membersection{wxFrameManager::GetManagedWindow}\label{wxframemanagergetmanagedwindow}
 196
 197 \constfunc{wxWindow*}{GetManagedWindow}{\void}
 198
 199 Returns the frame currently being managed by wxFrameManager.
 200
 201 \membersection{wxFrameManager::GetPane}\label{wxframemanagergetpane}
 202
 203 \func{wxPaneInfo\&}{GetPane}{\param{wxWindow* }{window}}
 204
 205 {\it GetPanel} is used to lookup a wxPaneInfo object
 206 either by window pointer or by pane name, which acts as a unique id for
 207 a window pane. The returned wxPaneInfo object may then be modified to
 208 change a pane's look, state or position. After one or more
 209 modifications to wxPaneInfo, wxFrameManager::Update() should be called
 210 to commit the changes to the user interface. If the lookup failed
 211 (meaning the pane could not be found in the manager), a call to the
 212 returned wxPaneInfo's IsOk() method will return false.
 213
 214 \func{wxPaneInfo\&}{GetPane}{\param{const wxString\& }{name}}
 215
 216
 217 \membersection{wxFrameManager::GetPanePart}\label{wxframemanagergetpanepart}
 218
 219 \func{wxDockUIPart*}{GetPanePart}{\param{wxWindow* }{pane}}
 220
 221
 222 \membersection{wxFrameManager::GetPanePositionsAndSizes}\label{wxframemanagergetpanepositionsandsizes}
 223
 224 \func{void}{GetPanePositionsAndSizes}{\param{wxDockInfo\& }{dock}, \param{wxArrayInt\& }{positions}, \param{wxArrayInt\& }{sizes}}
 225
 226
 227 \membersection{wxFrameManager::HideHint}\label{wxframemanagerhidehint}
 228
 229 \func{void}{HideHint}{\void}
 230
 231
 232 \membersection{wxFrameManager::HitTest}\label{wxframemanagerhittest}
 233
 234 \func{wxDockUIPart*}{HitTest}{\param{int }{x}, \param{int }{y}}
 235
 236
 237 \membersection{wxFrameManager::InsertPane}\label{wxframemanagerinsertpane}
 238
 239 \func{bool}{InsertPane}{\param{wxWindow* }{window}, \param{const wxPaneInfo\& }{insert\_location}, \param{int }{insert\_level = wxAUI\_INSERT\_PANE}}
 240
 241 This method is used to insert either a previously unmanaged pane window
 242 into the frame manager, or to insert a currently managed pane somewhere
 243 else. {\it InsertPane} will push all panes, rows, or docks aside and
 244 insert the window into the position specified by \arg{insert\_location}.
 245 Because \arg{insert\_location} can specify either a pane, dock row, or dock
 246 layer, the \arg{insert\_level} parameter is used to disambiguate this. The
 247 parameter \arg{insert\_level} can take a value of wxAUI\_INSERT\_PANE, wxAUI\_INSERT\_ROW
 248 or wxAUI\_INSERT\_DOCK.
 249
 250 \membersection{wxFrameManager::LayoutAddDock}\label{wxframemanagerlayoutadddock}
 251
 252 \func{void}{LayoutAddDock}{\param{wxSizer* }{container}, \param{wxDockInfo\& }{dock}, \param{wxDockUIPartArray\& }{uiparts}, \param{bool }{spacer\_only}}
 253
 254
 255 \membersection{wxFrameManager::LayoutAddPane}\label{wxframemanagerlayoutaddpane}
 256
 257 \func{void}{LayoutAddPane}{\param{wxSizer* }{container}, \param{wxDockInfo\& }{dock}, \param{wxPaneInfo\& }{pane}, \param{wxDockUIPartArray\& }{uiparts}, \param{bool }{spacer\_only}}
 258
 259
 260 \membersection{wxFrameManager::LayoutAll}\label{wxframemanagerlayoutall}
 261
 262 \func{wxSizer*}{LayoutAll}{\param{wxPaneInfoArray\& }{panes}, \param{wxDockInfoArray\& }{docks}, \param{wxDockUIPartArray\& }{uiparts}, \param{bool }{spacer\_only = false}}
 263
 264
 265 \membersection{wxFrameManager::LoadPaneInfo}\label{wxframemanagerloadpaneinfo}
 266
 267 \func{void}{LoadPaneInfo}{\param{wxString }{pane\_part}, \param{wxPaneInfo\& }{pane}}
 268
 269
 270 \membersection{wxFrameManager::LoadPerspective}\label{wxframemanagerloadperspective}
 271
 272 \func{bool}{LoadPerspective}{\param{const wxString\& }{perspective}, \param{bool }{update = true}}
 273
 274 Loads a saved perspective. If update is true, wxFrameManager::Update()
 275 is automatically invoked, thus realizing the saved perspective on screen.
 276
 277 \membersection{wxFrameManager::LookupPane}\label{wxframemanagerlookuppane}
 278
 279 \func{wxPaneInfo\&}{LookupPane}{\param{wxWindow* }{window}}
 280
 281
 282 \func{wxPaneInfo\&}{LookupPane}{\param{const wxString\& }{name}}
 283
 284
 285 \membersection{wxFrameManager::ProcessDockResult}\label{wxframemanagerprocessdockresult}
 286
 287 \func{bool}{ProcessDockResult}{\param{wxPaneInfo\& }{target}, \param{const wxPaneInfo\& }{new\_pos}}
 288
 289
 290 \membersection{wxFrameManager::ProcessMgrEvent}\label{wxframemanagerprocessmgrevent}
 291
 292 \func{void}{ProcessMgrEvent}{\param{wxFrameManagerEvent\& }{event}}
 293
 294
 295 \membersection{wxFrameManager::Render}\label{wxframemanagerrender}
 296
 297 \func{void}{Render}{\param{wxDC* }{dc}}
 298
 299
 300 \membersection{wxFrameManager::Repaint}\label{wxframemanagerrepaint}
 301
 302 \func{void}{Repaint}{\param{wxDC* }{dc = NULL}}
 303
 304
 305 \membersection{wxFrameManager::SavePaneInfo}\label{wxframemanagersavepaneinfo}
 306
 307 \func{wxString}{SavePaneInfo}{\param{wxPaneInfo\& }{pane}}
 308
 309
 310 \membersection{wxFrameManager::SavePerspective}\label{wxframemanagersaveperspective}
 311
 312 \func{wxString}{SavePerspective}{\void}
 313
 314 Saves the entire user interface layout into an encoded wxString, which
 315 can then be stored by the application (probably using wxConfig). When
 316 a perspective is restored using LoadPerspective(), the entire user
 317 interface will return to the state it was when the perspective was saved.
 318
 319 \membersection{wxFrameManager::SetArtProvider}\label{wxframemanagersetartprovider}
 320
 321 \func{void}{SetArtProvider}{\param{wxDockArt* }{art\_provider}}
 322
 323 Instructs wxFrameManager to use art provider specified by parameter
 324 \arg{art\_provider} for all drawing calls. This allows plugable
 325 look-and-feel features. The previous art provider object, if any,
 326 will be deleted by wxFrameManager.
 327
 328 \membersection{wxFrameManager::SetFlags}\label{wxframemanagersetflags}
 329
 330 \func{void}{SetFlags}{\param{unsigned int }{flags}}
 331
 332 This method is used to specify wxFrameManager's settings flags. \arg{flags}
 333 specifies options which allow the frame management behavior to be modified.
 334
 335 \membersection{wxFrameManager::SetManagedWindow}\label{wxframemanagersetmanagedwindow}
 336
 337 \func{void}{SetManagedWindow}{\param{wxWindow* }{managed\_wnd}}
 338
 339 Called to specify the frame which is to be managed by wxFrameManager.
 340
 341 \membersection{wxFrameManager::ShowHint}\label{wxframemanagershowhint}
 342
 343 \func{void}{ShowHint}{\param{const wxRect\& }{rect}}
 344
 345
 346 \membersection{wxFrameManager::UnInit}\label{wxframemanageruninit}
 347
 348 \func{void}{UnInit}{\void}
 349
 350 Uninitializes the framework and should be called before a frame is
 351 destroyed. UnInit() is usually called in the managed wxFrame's destructor.
 352
 353 \membersection{wxFrameManager::Update}\label{wxframemanagerupdate}
 354
 355 \func{void}{Update}{\void}
 356
 357 This method is called after any number of changes are
 358 made to any of the managed panes. Update() must be invoked after
 359 AddPane() or InsertPane() are called in order to "realize" or "commit"
 360 the changes. In addition, any number of changes may be made to
 361 wxPaneInfo structures (retrieved with wxFrameManager::GetPane), but to
 362 realize the changes, Update() must be called. This construction allows
 363 pane flicker to be avoided by updating the whole layout at one time.
 364
 365 \membersection{wxFrameManager::UpdateButtonOnScreen}\label{wxframemanagerupdatebuttononscreen}
 366
 367 \func{void}{UpdateButtonOnScreen}{\param{wxDockUIPart* }{button\_ui\_part}, \param{const wxMouseEvent\& }{event}}
 368
 369
 370 \membersection{wxFrameManager::wxDEPRECATED}\label{wxframemanagerwxdeprecated}
 371
 372 \func{}{wxDEPRECATED}{\param{void }{SetFrame(wxFrame* frame)}}
 373
 374 deprecated -- please use SetManagedWindow() and
 375 and GetManagedWindow() instead
 376
 377
 378 \func{}{wxDEPRECATED}{\param{wxFrame* GetFrame() }{const}}
 379