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