[wxWidgets.git] / docs / doxygen / overviews / aui.h

/////////////////////////////////////////////////////////////////////////////
// Name:        aui.h
// Purpose:     topic overview
// Author:      wxWidgets team
// RCS-ID:      $Id$
// Licence:     wxWindows license
/////////////////////////////////////////////////////////////////////////////

/*!

 @page overview_aui wxAUI overview

 Class: wxAuiManager, wxAuiPaneInfo

 wxAUI stands for Advanced User Interface and the wxAUI framework
 aims to give its user a cutting edge interface for use with the
 wxWidgets based applications. The original wxAUI sources have
 kindly been made available under the wxWindows licence
 by Kirix Corp. and they have since then been integrated into
 wxWidgets CVS and further improved.

 wxAUI attempts to encapsulate the following aspects of the user interface:

 @li @ref overview_aui_frame
 @li @ref overview_aui_toolbar
 @li @ref overview_aui_modeless
 @li @ref overview_aui_lnf

 <hr>


 @section overview_aui_frame Frame Management

 Frame management provides the means to open, move and hide common
 controls that are needed to interact with the document, and allow these
 configurations to be saved into different perspectives and loaded at a
 later time.

 @subsection overview_aui_toolbar Toolbars

 Toolbars are a specialized subset of the frame management system and
 should behave similarly to other docked components. However, they also
 require additional functionality, such as "spring-loaded" rebar support,
 "chevron" buttons and end-user customizability.

 @subsection overview_aui_modeless Modeless Controls

 Modeless controls expose a tool palette or set of options that float
 above the application content while allowing it to be accessed. Usually
 accessed by the toolbar, these controls disappear when an option is
 selected, but may also be "torn off" the toolbar into a floating frame
 of their own.

 @subsection overview_aui_lnf Look and Feel

 Look and feel encompasses the way controls are drawn, both when shown
 statically as well as when they are being moved. This aspect of user
 interface design incorporates "special effects" such as transparent
 window dragging as well as frame animation.

 wxAUI adheres to the following principles:
 Use native floating frames to obtain a native look and feel for all
 platforms. Use existing wxWidgets code where possible, such as sizer
 implementation for frame management. Use classes included in wxCore
 and wxBase only. Use standard wxWidgets coding conventions.

*/
Commit	Line	Data
15b6757b	1	/////////////////////////////////////////////////////////////////////////////
e0a47918	2	// Name: aui.h
15b6757b FM	3	// Purpose: topic overview
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/*!
36c9828f	10
e0a47918	11	@page overview_aui wxAUI overview
36c9828f	12
98ba1eee	13	Class: wxAuiManager, wxAuiPaneInfo
e0a47918	14
15b6757b FM	15	wxAUI stands for Advanced User Interface and the wxAUI framework
	16	aims to give its user a cutting edge interface for use with the
	17	wxWidgets based applications. The original wxAUI sources have
	18	kindly been made available under the wxWindows licence
	19	by Kirix Corp. and they have since then been integrated into
	20	wxWidgets CVS and further improved.
e0a47918	21
15b6757b	22	wxAUI attempts to encapsulate the following aspects of the user interface:
e0a47918	23
98ba1eee FM	24	@li @ref overview_aui_frame
	25	@li @ref overview_aui_toolbar
	26	@li @ref overview_aui_modeless
	27	@li @ref overview_aui_lnf
	28
	29	<hr>
	30
	31
	32	@section overview_aui_frame Frame Management
	33
15b6757b FM	34	Frame management provides the means to open, move and hide common
	35	controls that are needed to interact with the document, and allow these
	36	configurations to be saved into different perspectives and loaded at a
	37	later time.
e0a47918	38
98ba1eee FM	39	@subsection overview_aui_toolbar Toolbars
98ba1eee FM	40
15b6757b FM	41	Toolbars are a specialized subset of the frame management system and
	42	should behave similarly to other docked components. However, they also
	43	require additional functionality, such as "spring-loaded" rebar support,
	44	"chevron" buttons and end-user customizability.
e0a47918	45
98ba1eee FM	46	@subsection overview_aui_modeless Modeless Controls
98ba1eee FM	47
15b6757b FM	48	Modeless controls expose a tool palette or set of options that float
	49	above the application content while allowing it to be accessed. Usually
	50	accessed by the toolbar, these controls disappear when an option is
	51	selected, but may also be "torn off" the toolbar into a floating frame
	52	of their own.
e0a47918	53
98ba1eee FM	54	@subsection overview_aui_lnf Look and Feel
98ba1eee FM	55
15b6757b FM	56	Look and feel encompasses the way controls are drawn, both when shown
	57	statically as well as when they are being moved. This aspect of user
	58	interface design incorporates "special effects" such as transparent
	59	window dragging as well as frame animation.
e0a47918	60
15b6757b FM	61	wxAUI adheres to the following principles:
	62	Use native floating frames to obtain a native look and feel for all
	63	platforms. Use existing wxWidgets code where possible, such as sizer
	64	implementation for frame management. Use classes included in wxCore
	65	and wxBase only. Use standard wxWidgets coding conventions.
36c9828f	66
e0a47918	67	*/