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