docs/latex/wx/auimanager.tex

   1 \section{\class{wxAuiManager}}\label{wxauimanager}
   2
   3 wxAuiManager is the central class of the wxAUI class framework.
   4
   5 See also \helpref{wxAUI overview}{wxauioverview}.
   6
   7 wxAuiManager manages the panes associated with it
   8 for a particular wxFrame, using a pane's wxAuiPaneInfo information to
   9 determine each pane's docking and floating behavior. wxAuiManager
  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 application's specific needs.
  14
  15 wxAuiManager 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, wxAuiManager'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 two 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 its 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 row 0, and the second
  62 row 1. Rows can also be used on vertically docked panes.
  63
  64 {\bf Layer:}
  65 A layer is akin to an onion. Layer 0 is the very center of the
  66 managed pane. Thus, if a pane is in layer 0, it will be closest to the
  67 center window (also sometimes known as the "content window").
  68 Increasing layers "swallow up" all layers of a lower value. This can
  69 look very similar to multiple rows, but is different because all panes
  70 in a lower level yield to panes in higher levels. The best way to
  71 understand layers is by running the wxAUI sample.
  72
  73 \wxheading{Derived from}
  74
  75 \helpref{wxEvtHandler}{wxevthandler}
  76
  77 \wxheading{Include files}
  78
  79 <wx/aui/aui.h>
  80
  81 \wxheading{See also}
  82
  83 \helpref{wxAuiPaneInfo}{wxauipaneinfo},
  84 \helpref{wxAuiDockArt}{wxauidockart}
  85
  86 \wxheading{Data structures}
  87
  88 \begin{verbatim}
  89 enum wxAuiManagerDock
  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 wxAuiManagerOption
 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{wxAuiManager::wxAuiManager}\label{wxauimanagerwxauimanager}
 125
 126 \func{}{wxAuiManager}{\param{wxWindow* }{managed\_wnd = NULL}, \param{unsigned int }{flags = wxAUI\_MGR\_DEFAULT}}
 127
 128 Constructor. \arg{managed\_wnd} 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{wxAuiManager::\destruct{wxAuiManager}}\label{wxauimanagerdtor}
 133
 134 \func{}{\destruct{wxAuiManager}}{\void}
 135
 136 \membersection{wxAuiManager::AddPane}\label{wxauimanageraddpane}
 137
 138 \func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxAuiPaneInfo\& }{pane\_info}}
 139
 140 \func{bool}{AddPane}{\param{wxWindow* }{window}, \param{int }{direction = wxLEFT}, \param{const wxString\& }{caption = wxEmptyString}}
 141
 142 \func{bool}{AddPane}{\param{wxWindow* }{window}, \param{const wxAuiPaneInfo\& }{pane\_info}, \param{const wxPoint\& }{drop\_pos}}
 143
 144
 145 AddPane() tells the frame manager to start managing a child window. There are several versions of this function. The first version allows the full spectrum of pane parameter possibilities. The second version is used for simpler user interfaces which do not require as much configuration.  The last version allows a drop position to be specified, which will determine where the pane will be added.
 146
 147 \membersection{wxAuiManager::DetachPane}\label{wxauimanagerdetachpane}
 148
 149 \func{bool}{DetachPane}{\param{wxWindow* }{window}}
 150
 151 Tells the wxAuiManager to stop managing the pane specified by window.
 152 The window, if in a floated frame, is reparented to the frame managed
 153 by wxAuiManager.
 154
 155 \membersection{wxAuiManager::GetAllPanes}\label{wxauimanagergetallpanes}
 156
 157 \func{wxAuiPaneInfoArray\&}{GetAllPanes}{\void}
 158
 159 Returns an array of all panes managed by the frame manager.
 160
 161 \membersection{wxAuiManager::GetArtProvider}\label{wxauimanagergetartprovider}
 162
 163 \constfunc{wxAuiDockArt*}{GetArtProvider}{\void}
 164
 165 Returns the current art provider being used.
 166
 167 See also: \helpref{wxAuiDockArt}{wxauidockart}.
 168
 169 \membersection{wxAuiManager::GetDockSizeConstraint}\label{wxauimanagergetdocksizeconstraint}
 170
 171 \func{void}{GetDockSizeConstraint}{\param{double* }{widthpct}, \param{double* }{heightpct}}
 172
 173 Returns the current dock constraint values.  See \helpref{SetDockSizeConstraint()}{wxauimanagersetdocksizeconstraint} for more information.
 174
 175 \membersection{wxAuiManager::GetFlags}\label{wxauimanagergetflags}
 176
 177 \constfunc{unsigned int}{GetFlags}{\void}
 178
 179 Returns the current manager's flags.
 180
 181 \membersection{wxAuiManager::GetManagedWindow}\label{wxauimanagergetmanagedwindow}
 182
 183 \constfunc{wxWindow*}{GetManagedWindow}{\void}
 184
 185 Returns the frame currently being managed by wxAuiManager.
 186
 187 \membersection{wxAuiManager::GetManager}\label{wxauimanagergetmanager}
 188
 189 \func{static wxAuiManager*}{GetManager}{\param{wxWindow* }{window}}
 190
 191 Calling this method will return the wxAuiManager for a given window.  The \arg{window} parameter should
 192 specify any child window or sub-child window of the frame or window managed by wxAuiManager.
 193 The \arg{window} parameter need not be managed by the manager itself, nor does it even need to be a child
 194 or sub-child of a managed window.  It must however be inside the window hierarchy underneath the managed
 195 window.
 196
 197 \membersection{wxAuiManager::GetPane}\label{wxauimanagergetpane}
 198
 199 \func{wxAuiPaneInfo\&}{GetPane}{\param{wxWindow* }{window}}
 200
 201 \func{wxAuiPaneInfo\&}{GetPane}{\param{const wxString\& }{name}}
 202
 203 {\it GetPane} is used to lookup a wxAuiPaneInfo object
 204 either by window pointer or by pane name, which acts as a unique id for
 205 a window pane. The returned wxAuiPaneInfo object may then be modified to
 206 change a pane's look, state or position. After one or more
 207 modifications to wxAuiPaneInfo, wxAuiManager::Update() should be called
 208 to commit the changes to the user interface. If the lookup failed
 209 (meaning the pane could not be found in the manager), a call to the
 210 returned wxAuiPaneInfo's IsOk() method will return false.
 211
 212 \membersection{wxAuiManager::HideHint}\label{wxauimanagerhidehint}
 213
 214 \func{void}{HideHint}{\void}
 215
 216 HideHint() hides any docking hint that may be visible.
 217
 218 \membersection{wxAuiManager::InsertPane}\label{wxauimanagerinsertpane}
 219
 220 \func{bool}{InsertPane}{\param{wxWindow* }{window}, \param{const wxAuiPaneInfo\& }{insert\_location}, \param{int }{insert\_level = wxAUI\_INSERT\_PANE}}
 221
 222 This method is used to insert either a previously unmanaged pane window
 223 into the frame manager, or to insert a currently managed pane somewhere
 224 else. {\it InsertPane} will push all panes, rows, or docks aside and
 225 insert the window into the position specified by \arg{insert\_location}.
 226 Because \arg{insert\_location} can specify either a pane, dock row, or dock
 227 layer, the \arg{insert\_level} parameter is used to disambiguate this. The
 228 parameter \arg{insert\_level} can take a value of wxAUI\_INSERT\_PANE, wxAUI\_INSERT\_ROW
 229 or wxAUI\_INSERT\_DOCK.
 230
 231 \membersection{wxAuiManager::LoadPaneInfo}\label{wxauimanagerloadpaneinfo}
 232
 233 \func{void}{LoadPaneInfo}{\param{wxString }{pane\_part}, \param{wxAuiPaneInfo\& }{pane}}
 234
 235 LoadPaneInfo() is similar to to LoadPerspective, with the exception that it only loads information about a single pane.  It is used in combination with SavePaneInfo().
 236
 237 \membersection{wxAuiManager::LoadPerspective}\label{wxauimanagerloadperspective}
 238
 239 \func{bool}{LoadPerspective}{\param{const wxString\& }{perspective}, \param{bool }{update = true}}
 240
 241 Loads a saved perspective. If update is true, wxAuiManager::Update()
 242 is automatically invoked, thus realizing the saved perspective on screen.
 243
 244 \membersection{wxAuiManager::ProcessDockResult}\label{wxauimanagerprocessdockresult}
 245
 246 \func{bool}{ProcessDockResult}{\param{wxAuiPaneInfo\& }{target}, \param{const wxAuiPaneInfo\& }{new\_pos}}
 247
 248 ProcessDockResult() is a protected member of the wxAUI layout manager.  It can be overridden by derived classes to provide custom docking calculations.
 249
 250 \membersection{wxAuiManager::SavePaneInfo}\label{wxauimanagersavepaneinfo}
 251
 252 \func{wxString}{SavePaneInfo}{\param{wxAuiPaneInfo\& }{pane}}
 253
 254 SavePaneInfo() is similar to SavePerspective, with the exception that it only saves information about a single pane.  It is used in combination with LoadPaneInfo().
 255
 256 \membersection{wxAuiManager::SavePerspective}\label{wxauimanagersaveperspective}
 257
 258 \func{wxString}{SavePerspective}{\void}
 259
 260 Saves the entire user interface layout into an encoded wxString, which
 261 can then be stored by the application (probably using wxConfig). When
 262 a perspective is restored using LoadPerspective(), the entire user
 263 interface will return to the state it was when the perspective was saved.
 264
 265 \membersection{wxAuiManager::SetArtProvider}\label{wxauimanagersetartprovider}
 266
 267 \func{void}{SetArtProvider}{\param{wxAuiDockArt* }{art\_provider}}
 268
 269 Instructs wxAuiManager to use art provider specified by parameter
 270 \arg{art\_provider} for all drawing calls. This allows plugable
 271 look-and-feel features. The previous art provider object, if any,
 272 will be deleted by wxAuiManager.
 273
 274 See also: \helpref{wxAuiDockArt}{wxauidockart}.
 275
 276 \membersection{wxAuiManager::SetDockSizeConstraint}\label{wxauimanagersetdocksizeconstraint}
 277
 278 \func{void}{SetDockSizeConstraint}{\param{double }{widthpct}, \param{double }{heightpct}}
 279
 280 When a user creates a new dock by dragging a window into a docked position, often times the large size of the
 281 window will create a dock that is unwieldly large.  wxAuiManager by default limits the size of any
 282 new dock to 1/3 of the window size.  For horizontal docks, this would be 1/3 of the window height.  For
 283 vertical docks, 1/3 of the width.  Calling this function will adjust this constraint value.  The numbers
 284 must be between 0.0 and 1.0.  For instance, calling SetDockSizeContraint with 0.5, 0.5 will cause new
 285 docks to be limited to half of the size of the entire managed window.
 286
 287 \membersection{wxAuiManager::SetFlags}\label{wxauimanagersetflags}
 288
 289 \func{void}{SetFlags}{\param{unsigned int }{flags}}
 290
 291 This method is used to specify wxAuiManager's settings flags. \arg{flags}
 292 specifies options which allow the frame management behavior to be modified.
 293
 294 \membersection{wxAuiManager::SetManagedWindow}\label{wxauimanagersetmanagedwindow}
 295
 296 \func{void}{SetManagedWindow}{\param{wxWindow* }{managed\_wnd}}
 297
 298 Called to specify the frame or window which is to be managed by wxAuiManager.  Frame management is not restricted to just frames.  Child windows or custom controls are also allowed.
 299
 300 \membersection{wxAuiManager::ShowHint}\label{wxauimanagershowhint}
 301
 302 \func{void}{ShowHint}{\param{const wxRect\& }{rect}}
 303
 304 This function is used by controls to explicitly show a hint window at the specified rectangle.  It is rarely called, and is mostly used by controls implementing custom pane drag/drop behaviour.  The specified rectangle should be in screen coordinates.
 305
 306 \membersection{wxAuiManager::UnInit}\label{wxauimanageruninit}
 307
 308 \func{void}{UnInit}{\void}
 309
 310 Uninitializes the framework and should be called before a managed frame or window is destroyed. UnInit() is usually called in the managed wxFrame's destructor.  It is necessary to call this function before the managed frame or window is destroyed, otherwise the manager cannot remove its custom event handlers from a window.
 311
 312 \membersection{wxAuiManager::Update}\label{wxauimanagerupdate}
 313
 314 \func{void}{Update}{\void}
 315
 316 This method is called after any number of changes are
 317 made to any of the managed panes. Update() must be invoked after
 318 AddPane() or InsertPane() are called in order to "realize" or "commit"
 319 the changes. In addition, any number of changes may be made to
 320 wxAuiPaneInfo structures (retrieved with wxAuiManager::GetPane), but to
 321 realize the changes, Update() must be called. This construction allows
 322 pane flicker to be avoided by updating the whole layout at one time.
 323