docs/doxygen/overviews/aui.h

   1 /////////////////////////////////////////////////////////////////////////////
   2 // Name:        aui.h
   3 // Purpose:     topic overview
   4 // Author:      wxWidgets team
   5 // RCS-ID:      $Id$
   6 // Licence:     wxWindows license
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /*!
  10
  11  @page overview_aui wxAUI overview
  12
  13  Class: wxAuiManager, wxAuiPaneInfo
  14
  15  wxAUI stands for Advanced User Interface and the wxAUI framework
  16  aims to give its user a cutting edge interface for use with the
  17  wxWidgets based applications. The original wxAUI sources have
  18  kindly been made available under the wxWindows licence
  19  by Kirix Corp. and they have since then been integrated into
  20  wxWidgets CVS and further improved.
  21
  22  wxAUI attempts to encapsulate the following aspects of the user interface:
  23
  24  @li @ref overview_aui_frame
  25  @li @ref overview_aui_toolbar
  26  @li @ref overview_aui_modeless
  27  @li @ref overview_aui_lnf
  28
  29  <hr>
  30
  31
  32  @section overview_aui_frame Frame Management
  33
  34  Frame management provides the means to open, move and hide common
  35  controls that are needed to interact with the document, and allow these
  36  configurations to be saved into different perspectives and loaded at a
  37  later time.
  38
  39  @subsection overview_aui_toolbar Toolbars
  40
  41  Toolbars are a specialized subset of the frame management system and
  42  should behave similarly to other docked components. However, they also
  43  require additional functionality, such as "spring-loaded" rebar support,
  44  "chevron" buttons and end-user customizability.
  45
  46  @subsection overview_aui_modeless Modeless Controls
  47
  48  Modeless controls expose a tool palette or set of options that float
  49  above the application content while allowing it to be accessed. Usually
  50  accessed by the toolbar, these controls disappear when an option is
  51  selected, but may also be "torn off" the toolbar into a floating frame
  52  of their own.
  53
  54  @subsection overview_aui_lnf Look and Feel
  55
  56  Look and feel encompasses the way controls are drawn, both when shown
  57  statically as well as when they are being moved. This aspect of user
  58  interface design incorporates "special effects" such as transparent
  59  window dragging as well as frame animation.
  60
  61  wxAUI adheres to the following principles:
  62  Use native floating frames to obtain a native look and feel for all
  63  platforms. Use existing wxWidgets code where possible, such as sizer
  64  implementation for frame management. Use classes included in wxCore
  65  and wxBase only. Use standard wxWidgets coding conventions.
  66
  67 */