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