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