]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/overviews/aui.h
For wxGTK2, link with X11 explicitly, since we use many X11 functions directly.
[wxWidgets.git] / docs / doxygen / overviews / aui.h
CommitLineData
15b6757b 1/////////////////////////////////////////////////////////////////////////////
e0a47918 2// Name: aui.h
15b6757b
FM
3// Purpose: topic overview
4// Author: wxWidgets team
5// RCS-ID: $Id$
526954c5 6// Licence: wxWindows licence
15b6757b
FM
7/////////////////////////////////////////////////////////////////////////////
8
880efa2a 9/**
36c9828f 10
880efa2a 11@page overview_aui wxAUI Overview
36c9828f 12
880efa2a
BP
13Classes:
14@li wxAuiManager
15@li wxAuiPaneInfo
16@li wxAuiNotebook
17@li wxAuiDockArt
18@li wxAuiTabArt
f8ecadbf
VZ
19@li wxAuiToolBar
20@li wxAuiToolBarArt
e0a47918 21
880efa2a
BP
22wxAUI stands for Advanced User Interface. It aims to give the user a cutting
23edge interface with floatable windows, and a user-customizable layout. The
24original wxAUI sources have kindly been made available under the wxWindows
25licence by Kirix Corp. and they have since then been integrated into wxWidgets
26and further improved.
e0a47918 27
880efa2a 28wxAUI attempts to encapsulate the following aspects of the user interface:
e0a47918 29
880efa2a
BP
30@li @ref overview_aui_frame
31@li @ref overview_aui_toolbar
32@li @ref overview_aui_modeless
33@li @ref overview_aui_lnf
98ba1eee 34
98ba1eee 35
880efa2a 36<hr>
98ba1eee 37
98ba1eee 38
880efa2a 39@section overview_aui_frame Frame Management
e0a47918 40
880efa2a
BP
41Frame management provides the means to open, move and hide common controls that
42are needed to interact with the document, and allow these configurations to be
43saved into different perspectives and loaded at a later time.
98ba1eee 44
e0a47918 45
880efa2a 46@section overview_aui_toolbar Toolbars
98ba1eee 47
880efa2a
BP
48Toolbars are a specialized subset of the frame management system and should
49behave similarly to other docked components. However, they also require
50additional functionality, such as "spring-loaded" rebar support, "chevron"
51buttons and end-user customizability.
e0a47918 52
98ba1eee 53
880efa2a 54@section overview_aui_modeless Modeless Controls
e0a47918 55
880efa2a
BP
56Modeless controls expose a tool palette or set of options that float above the
57application content while allowing it to be accessed. Usually accessed by the
58toolbar, 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
64Look and feel encompasses the way controls are drawn, both when shown
65statically as well as when they are being moved. This aspect of user interface
66design incorporates "special effects" such as transparent window dragging as
67well as frame animation.
68
69wxAUI adheres to the following principles: Use native floating frames to obtain
70a native look and feel for all platforms. Use existing wxWidgets code where
71possible, such as sizer implementation for frame management. Use classes
72included in @ref page_libs_wxcore and @ref page_libs_wxbase only.
36c9828f 73
e0a47918 74*/
880efa2a 75