Fixed docs footer to bottom, and fixed up TOC on all main pages, and some overviews.
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@72870 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
@@ -10,13 +10,8 @@
|
||||
|
||||
@page overview_app wxApp Overview
|
||||
|
||||
Classes: wxApp
|
||||
@tableofcontents
|
||||
|
||||
@li @ref overview_app_intro
|
||||
@li @ref overview_app_shutdown
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
@section overview_app_intro Introduction
|
||||
@@ -75,6 +70,7 @@ function which returns a reference to the application object. Otherwise you can
|
||||
only use the global @c wxTheApp pointer which is of type @c wxApp*.
|
||||
|
||||
|
||||
|
||||
@section overview_app_shutdown Application Shutdown
|
||||
|
||||
The application normally shuts down when the last of its top level windows is
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
|
||||
@page overview_archive Archive Formats
|
||||
|
||||
@tableofcontents
|
||||
|
||||
The archive classes handle archive formats such as zip, tar, rar and cab.
|
||||
Currently wxZip, wxTar and wxZlib classes are included.
|
||||
|
||||
@@ -30,17 +32,6 @@ The classes are designed to handle archives on both seekable streams such as
|
||||
disk files, or non-seekable streams such as pipes and sockets (see
|
||||
@ref overview_archive_noseek).
|
||||
|
||||
See also wxFileSystem.
|
||||
|
||||
@li @ref overview_archive_create
|
||||
@li @ref overview_archive_extract
|
||||
@li @ref overview_archive_modify
|
||||
@li @ref overview_archive_byname
|
||||
@li @ref overview_archive_generic
|
||||
@li @ref overview_archive_noseek
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
@section overview_archive_create Creating an Archive
|
||||
|
||||
@@ -10,17 +10,7 @@
|
||||
|
||||
@page overview_aui wxAUI Overview
|
||||
|
||||
Classes:
|
||||
@li wxAuiManager
|
||||
@li wxAuiPaneInfo
|
||||
@li wxAuiNotebook
|
||||
@li wxAuiDockArt
|
||||
@li wxAuiTabArt
|
||||
@li wxAuiDefaultTabArt
|
||||
@li wxAuiToolBar
|
||||
@li wxAuiToolBarArt
|
||||
@li wxAuiTabContainer
|
||||
@li wxAuiTabContainerButton
|
||||
@tableofcontents
|
||||
|
||||
wxAUI stands for Advanced User Interface. It aims to give the user a cutting
|
||||
edge interface with floatable windows, and a user-customizable layout. The
|
||||
@@ -28,15 +18,8 @@ original wxAUI sources have kindly been made available under the wxWindows
|
||||
licence by Kirix Corp. and they have since then been integrated into wxWidgets
|
||||
and further improved.
|
||||
|
||||
wxAUI attempts to encapsulate the following aspects of the user interface:
|
||||
@see @ref group_class_aui
|
||||
|
||||
@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
|
||||
@@ -46,6 +29,7 @@ are needed to interact with the document, and allow these configurations to be
|
||||
saved into different perspectives and loaded at a later time.
|
||||
|
||||
|
||||
|
||||
@section overview_aui_toolbar Toolbars
|
||||
|
||||
Toolbars are a specialized subset of the frame management system and should
|
||||
@@ -54,6 +38,7 @@ additional functionality, such as "spring-loaded" rebar support, "chevron"
|
||||
buttons and end-user customizability.
|
||||
|
||||
|
||||
|
||||
@section overview_aui_modeless Modeless Controls
|
||||
|
||||
Modeless controls expose a tool palette or set of options that float above the
|
||||
@@ -62,6 +47,7 @@ toolbar, these controls disappear when an option is selected, but may also be
|
||||
"torn off" the toolbar into a floating frame of their own.
|
||||
|
||||
|
||||
|
||||
@section overview_aui_lnf Look and Feel
|
||||
|
||||
Look and feel encompasses the way controls are drawn, both when shown
|
||||
@@ -75,4 +61,3 @@ possible, such as sizer implementation for frame management. Use classes
|
||||
included in @ref page_libs_wxcore and @ref page_libs_wxbase only.
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
|
||||
@page overview_backwardcompat Backwards Compatibility
|
||||
|
||||
@tableofcontents
|
||||
|
||||
Many of the GUIs and platforms supported by wxWidgets are continuously
|
||||
evolving, and some of the new platforms wxWidgets now supports were quite
|
||||
unimaginable even a few years ago. In this environment wxWidgets must also
|
||||
@@ -20,13 +22,6 @@ interface across many platforms, but also to provide an interface that is
|
||||
reasonably stable over time, to help protect its users from some of the
|
||||
uncertainty of the future.
|
||||
|
||||
@li @ref overview_backwardcompat_versionnumbering
|
||||
@li @ref overview_backwardcompat_sourcecompat
|
||||
@li @ref overview_backwardcompat_libbincompat
|
||||
@li @ref overview_backwardcompat_appbincompat
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
@section overview_backwardcompat_versionnumbering The Version Numbering Scheme
|
||||
@@ -170,4 +165,3 @@ numbers. It won't, for example, help you write code compatible with 2.6.x using
|
||||
wxWidgets 2.8.x.
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -10,11 +10,7 @@
|
||||
|
||||
@page overview_bitmap Bitmaps and Icons
|
||||
|
||||
Classes:
|
||||
@li wxBitmap
|
||||
@li wxBitmapHandler
|
||||
@li wxIcon
|
||||
@li wxCursor
|
||||
@tableofcontents
|
||||
|
||||
The wxBitmap class encapsulates the concept of a platform-dependent bitmap,
|
||||
either monochrome or colour. Platform-specific methods for creating a wxBitmap
|
||||
@@ -90,12 +86,9 @@ PNG files embedded in resources (meaning either Windows resource section of the
|
||||
executable file or OS X "Resource" subdirectory of the application bundle) or
|
||||
arrays containing PNG data included into the program code itself.
|
||||
|
||||
@li @ref overview_bitmap_supportedformats
|
||||
@li @ref overview_bitmap_handlers
|
||||
@see @ref group_class_gdi
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
@section overview_bitmap_supportedformats Supported Bitmap File Formats
|
||||
|
||||
|
||||
@@ -10,25 +10,7 @@
|
||||
|
||||
@page overview_bookctrl wxBookCtrl Overview
|
||||
|
||||
Classes:
|
||||
|
||||
@li wxChoicebook
|
||||
@li wxListbook
|
||||
@li wxNotebook
|
||||
@li wxSimplebook
|
||||
@li wxTreebook
|
||||
@li wxToolbook
|
||||
|
||||
Sections:
|
||||
|
||||
@li @ref overview_bookctrl_intro
|
||||
@li @ref overview_bookctrl_bestbookctrl
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
@section overview_bookctrl_intro Introduction
|
||||
@tableofcontents
|
||||
|
||||
A book control is a convenient way of displaying multiple pages of information,
|
||||
displayed one page at a time. wxWidgets has five variants of this control:
|
||||
@@ -46,6 +28,10 @@ Notice that wxSimplebook is special in that it only allows the program to
|
||||
change the selection, thus it's usually used in slightly different
|
||||
circumstances than the other variants.
|
||||
|
||||
@see @ref group_class_bookctrl
|
||||
|
||||
|
||||
|
||||
@section overview_bookctrl_bestbookctrl Best Book
|
||||
|
||||
::wxBookCtrl is mapped to the class best suited for a given platform. Currently
|
||||
|
||||
@@ -10,6 +10,8 @@
|
||||
|
||||
@page overview_bufferclasses Buffer Classes
|
||||
|
||||
@tableofcontents
|
||||
|
||||
wxWidgets uses two classes of classes for dealing with buffers in memory.
|
||||
|
||||
The first is one for dealing with character buffers, namely wxCharBuffer for
|
||||
@@ -19,10 +21,6 @@ wide character c strings.
|
||||
Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer for
|
||||
dealing with raw buffers in memory.
|
||||
|
||||
@li @ref overview_bufferclasses_xcb
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
@section overview_bufferclasses_xcb wxXCharBuffer
|
||||
@@ -46,4 +44,3 @@ the buffer and don't want wxCharBuffer to delete it on destruction, use the
|
||||
member function release to do so.
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -10,18 +10,7 @@
|
||||
|
||||
@page overview_cmndlg Common Dialogs
|
||||
|
||||
Classes:
|
||||
|
||||
@li wxColourDialog
|
||||
@li wxFontDialog
|
||||
@li wxPrintDialog
|
||||
@li wxFileDialog
|
||||
@li wxDirDialog
|
||||
@li wxTextEntryDialog
|
||||
@li wxPasswordEntryDialog
|
||||
@li wxMessageDialog
|
||||
@li wxSingleChoiceDialog
|
||||
@li wxMultiChoiceDialog
|
||||
@tableofcontents
|
||||
|
||||
Common dialog classes and functions encapsulate commonly-needed dialog box
|
||||
requirements. They are all 'modal', grabbing the flow of control until the user
|
||||
@@ -36,20 +25,9 @@ and a macro defines wxColourDialog to be the same as wxGenericColourDialog on
|
||||
non-MS Windows platforms. However, under MS Windows, the generic dialog can
|
||||
also be used, for testing or other purposes.
|
||||
|
||||
@li @ref overview_cmndlg_colour
|
||||
@li @ref overview_cmndlg_font
|
||||
@li @ref overview_cmndlg_print
|
||||
@li @ref overview_cmndlg_file
|
||||
@li @ref overview_cmndlg_dir
|
||||
@li @ref overview_cmndlg_textentry
|
||||
@li @ref overview_cmndlg_password
|
||||
@li @ref overview_cmndlg_msg
|
||||
@li @ref overview_cmndlg_singlechoice
|
||||
@li @ref overview_cmndlg_multichoice
|
||||
@see @ref group_class_cmndlg
|
||||
|
||||
|
||||
<hr>
|
||||
|
||||
|
||||
@section overview_cmndlg_colour wxColourDialog Overview
|
||||
|
||||
@@ -109,6 +87,7 @@ if (dialog.ShowModal() == wxID_OK)
|
||||
@endcode
|
||||
|
||||
|
||||
|
||||
@section overview_cmndlg_font wxFontDialog Overview
|
||||
|
||||
Classes: wxFontDialog, wxFontData
|
||||
@@ -155,6 +134,7 @@ if (dialog.ShowModal() == wxID_OK)
|
||||
@endcode
|
||||
|
||||
|
||||
|
||||
@section overview_cmndlg_print wxPrintDialog Overview
|
||||
|
||||
Classes: wxPrintDialog, wxPrintData
|
||||
@@ -166,6 +146,7 @@ The samples/printing example shows how to use it: see @ref overview_printing
|
||||
for an excerpt from this example.
|
||||
|
||||
|
||||
|
||||
@section overview_cmndlg_file wxFileDialog Overview
|
||||
|
||||
Classes: wxFileDialog
|
||||
@@ -197,6 +178,7 @@ description for each, such as:
|
||||
@endverbatim
|
||||
|
||||
|
||||
|
||||
@section overview_cmndlg_dir wxDirDialog Overview
|
||||
|
||||
Classes: wxDirDialog
|
||||
@@ -205,6 +187,7 @@ This dialog shows a directory selector dialog, allowing the user to select a
|
||||
single directory.
|
||||
|
||||
|
||||
|
||||
@section overview_cmndlg_textentry wxTextEntryDialog Overview
|
||||
|
||||
Classes: wxTextEntryDialog
|
||||
@@ -213,6 +196,7 @@ This is a dialog with a text entry field. The value that the user entered is
|
||||
obtained using wxTextEntryDialog::GetValue().
|
||||
|
||||
|
||||
|
||||
@section overview_cmndlg_password wxPasswordEntryDialog Overview
|
||||
|
||||
Classes: wxPasswordEntryDialog
|
||||
@@ -221,6 +205,7 @@ This is a dialog with a password entry field. The value that the user entered
|
||||
is obtained using wxTextEntryDialog::GetValue().
|
||||
|
||||
|
||||
|
||||
@section overview_cmndlg_msg wxMessageDialog Overview
|
||||
|
||||
Classes: wxMessageDialog
|
||||
@@ -233,6 +218,7 @@ The return value of wxMessageDialog::ShowModal() indicates which button the
|
||||
user pressed.
|
||||
|
||||
|
||||
|
||||
@section overview_cmndlg_singlechoice wxSingleChoiceDialog Overview
|
||||
|
||||
Classes: wxSingleChoiceDialog
|
||||
@@ -242,6 +228,7 @@ can select one of them. The selection can be obtained from the dialog as an
|
||||
index, a string or client data.
|
||||
|
||||
|
||||
|
||||
@section overview_cmndlg_multichoice wxMultiChoiceDialog Overview
|
||||
|
||||
Classes: wxMultiChoiceDialog
|
||||
@@ -250,4 +237,3 @@ This dialog shows a list of choices, plus OK and (optionally) Cancel. The user
|
||||
can select one or more of them.
|
||||
|
||||
*/
|
||||
|
||||
|
||||
@@ -10,7 +10,11 @@
|
||||
|
||||
@page overview_container Container Classes
|
||||
|
||||
Classes: wxList<T>, wxArray<T>, wxVector<T>, wxStack<T>, wxHashMap, wxHashSet
|
||||
@tableofcontents
|
||||
|
||||
@see @ref group_class_containers
|
||||
|
||||
|
||||
|
||||
@section overview_container_intro Overview
|
||||
|
||||
@@ -47,6 +51,7 @@ wxList<T> when you must, i.e. when you use a wxWidgets function taking or
|
||||
returning a container of such type.
|
||||
|
||||
|
||||
|
||||
@section overview_container_legacy Legacy Classes
|
||||
|
||||
The list classes in wxWidgets are doubly-linked lists which may either own the
|
||||
@@ -91,6 +96,7 @@ wxArrayString is somewhat special: it is an optimized version of wxArray which
|
||||
uses its knowledge about wxString reference counting schema.
|
||||
|
||||
|
||||
|
||||
@section overview_container_std STL Build
|
||||
|
||||
To build wxWidgets with the standard containers you need to set
|
||||
@@ -125,6 +131,4 @@ default one. Here are the most important differences:
|
||||
class. Please either use std::vector<bool> directly or use an integer array
|
||||
instead.
|
||||
|
||||
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user