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 licence
   7 /////////////////////////////////////////////////////////////////////////////
   8
   9 /**
  10
  11 @page overview_aui wxAUI Overview
  12
  13 Classes:
  14 @li wxAuiManager
  15 @li wxAuiPaneInfo
  16 @li wxAuiNotebook
  17 @li wxAuiDockArt
  18 @li wxAuiTabArt
  19 @li wxAuiDefaultTabArt
  20 @li wxAuiToolBar
  21 @li wxAuiToolBarArt
  22 @li wxAuiTabContainer
  23 @li wxAuiTabContainerButton
  24
  25 wxAUI stands for Advanced User Interface. It aims to give the user a cutting
  26 edge interface with floatable windows, and a user-customizable layout. The
  27 original wxAUI sources have kindly been made available under the wxWindows
  28 licence by Kirix Corp. and they have since then been integrated into wxWidgets
  29 and further improved.
  30
  31 wxAUI attempts to encapsulate the following aspects of the user interface:
  32
  33 @li @ref overview_aui_frame
  34 @li @ref overview_aui_toolbar
  35 @li @ref overview_aui_modeless
  36 @li @ref overview_aui_lnf
  37
  38
  39 <hr>
  40
  41
  42 @section overview_aui_frame Frame Management
  43
  44 Frame management provides the means to open, move and hide common controls that
  45 are needed to interact with the document, and allow these configurations to be
  46 saved into different perspectives and loaded at a later time.
  47
  48
  49 @section overview_aui_toolbar Toolbars
  50
  51 Toolbars are a specialized subset of the frame management system and should
  52 behave similarly to other docked components. However, they also require
  53 additional functionality, such as "spring-loaded" rebar support, "chevron"
  54 buttons and end-user customizability.
  55
  56
  57 @section overview_aui_modeless Modeless Controls
  58
  59 Modeless controls expose a tool palette or set of options that float above the
  60 application content while allowing it to be accessed. Usually accessed by the
  61 toolbar, these controls disappear when an option is selected, but may also be
  62 "torn off" the toolbar into a floating frame of their own.
  63
  64
  65 @section overview_aui_lnf Look and Feel
  66
  67 Look and feel encompasses the way controls are drawn, both when shown
  68 statically as well as when they are being moved. This aspect of user interface
  69 design incorporates "special effects" such as transparent window dragging as
  70 well as frame animation.
  71
  72 wxAUI adheres to the following principles: Use native floating frames to obtain
  73 a native look and feel for all platforms. Use existing wxWidgets code where
  74 possible, such as sizer implementation for frame management. Use classes
  75 included in @ref page_libs_wxcore and @ref page_libs_wxbase only.
  76
  77 */
  78