Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions 8 Packages Projects Releases Wiki Activity

Replaced /*! with /** in remaining Doxygen headers, and removed intentation of overviews [a-c].

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52448 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-03-12 08:50:42 +00:00
parent b890136bc6
commit 880efa2a13
76 changed files with 761 additions and 755 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/doxygen/mainpages/const_cpp.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_cppconst Preprocessor symbols defined by wxWidgets @page page_cppconst Preprocessor symbols defined by wxWidgets

2
docs/doxygen/mainpages/const_keycode.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_keycodes Keycodes @page page_keycodes Keycodes

2
docs/doxygen/mainpages/const_keymod.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_keymodifiers Key Modifiers @page page_keymodifiers Key Modifiers

2
docs/doxygen/mainpages/const_langcodes.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_languagecodes Language identifiers @page page_languagecodes Language identifiers

2
docs/doxygen/mainpages/const_stdevtid.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_stdevtid Standard event identifiers @page page_stdevtid Standard event identifiers

2
docs/doxygen/mainpages/const_stockitems.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_stockitems Stock items @page page_stockitems Stock items

2
docs/doxygen/mainpages/const_wxusedef.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_wxusedef wxUSE preprocessor symbols defined by wxWidgets @page page_wxusedef wxUSE preprocessor symbols defined by wxWidgets

2
docs/doxygen/mainpages/constants.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_constants Constants @page page_constants Constants

6
docs/doxygen/mainpages/copyright.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_copyright Copyright notice @page page_copyright Copyright notice
@@ -29,7 +29,7 @@
*/ */
/*! /**
@page page_copyright_wxlicense wxWindows Library License, Version 3.1 @page page_copyright_wxlicense wxWindows Library License, Version 3.1
@@ -96,7 +96,7 @@
*/ */
/*! /**
@page page_copyright_gnulicense GNU Library General Public License, Version 2 @page page_copyright_gnulicense GNU Library General Public License, Version 2

2
docs/doxygen/mainpages/devtips.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_multiplatform Multi-platform development with wxWidgets @page page_multiplatform Multi-platform development with wxWidgets

2
docs/doxygen/mainpages/introduction.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_introduction Introduction @page page_introduction Introduction

2
docs/doxygen/mainpages/libs.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_libs Library List @page page_libs Library List

2
docs/doxygen/mainpages/manual.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@mainpage wxWidgets 2.9.0: A portable C++ GUI toolkit @mainpage wxWidgets 2.9.0: A portable C++ GUI toolkit
@author Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al @author Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

2
docs/doxygen/mainpages/platdetails.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_port Platform details @page page_port Platform details

2
docs/doxygen/mainpages/strategies.h
View File

@@ -7,7 +7,7 @@
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_strategies Programming strategies @page page_strategies Programming strategies

2
docs/doxygen/mainpages/topics.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_topics Topic Overviews @page page_topics Topic Overviews

2
docs/doxygen/mainpages/utilities.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page page_utils Utilities and samples supplied with wxWidgets @page page_utils Utilities and samples supplied with wxWidgets

2
docs/doxygen/overviews/app.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_app wxApp Overview @page overview_app wxApp Overview

2
docs/doxygen/overviews/archive.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_arc Archive Formats @page overview_arc Archive Formats

90
docs/doxygen/overviews/aui.h
View File

@@ -6,62 +6,68 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_aui wxAUI overview @page overview_aui wxAUI Overview
Class: wxAuiManager, wxAuiPaneInfo Classes:
@li wxAuiManager
@li wxAuiPaneInfo
@li wxAuiNotebook
@li wxAuiDockArt
@li wxAuiTabArt
wxAUI stands for Advanced User Interface and the wxAUI framework wxAUI stands for Advanced User Interface. It aims to give the user a cutting
aims to give its user a cutting edge interface for use with the edge interface with floatable windows, and a user-customizable layout. The
wxWidgets based applications. The original wxAUI sources have original wxAUI sources have kindly been made available under the wxWindows
kindly been made available under the wxWindows licence licence by Kirix Corp. and they have since then been integrated into wxWidgets
by Kirix Corp. and they have since then been integrated into and further improved.
wxWidgets CVS and further improved.
wxAUI attempts to encapsulate the following aspects of the user interface: wxAUI attempts to encapsulate the following aspects of the user interface:
@li @ref overview_aui_frame @li @ref overview_aui_frame
@li @ref overview_aui_toolbar @li @ref overview_aui_toolbar
@li @ref overview_aui_modeless @li @ref overview_aui_modeless
@li @ref overview_aui_lnf @li @ref overview_aui_lnf
<hr>
@section overview_aui_frame Frame Management <hr>
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 @section overview_aui_frame Frame Management
Toolbars are a specialized subset of the frame management system and Frame management provides the means to open, move and hide common controls that
should behave similarly to other docked components. However, they also are needed to interact with the document, and allow these configurations to be
require additional functionality, such as "spring-loaded" rebar support, saved into different perspectives and loaded at a later time.
"chevron" buttons and end-user customizability.
@subsection overview_aui_modeless Modeless Controls
Modeless controls expose a tool palette or set of options that float @section overview_aui_toolbar Toolbars
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 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.
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: @section overview_aui_modeless Modeless Controls
Use native floating frames to obtain a native look and feel for all
platforms. Use existing wxWidgets code where possible, such as sizer Modeless controls expose a tool palette or set of options that float above the
implementation for frame management. Use classes included in wxCore application content while allowing it to be accessed. Usually accessed by the
and wxBase only. Use standard wxWidgets coding conventions. 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
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 @ref page_libs_wxcore and @ref page_libs_wxbase only.
*/ */

256
docs/doxygen/overviews/backwardcompatibility.h
View File

@@ -6,178 +6,168 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_backwardcompat Backward compatibility @page overview_backwardcompat Backwards Compatibility
Many of the GUIs and platforms supported by wxWidgets are continuously Many of the GUIs and platforms supported by wxWidgets are continuously
evolving, and some of the new platforms wxWidgets now supports were quite evolving, and some of the new platforms wxWidgets now supports were quite
unimaginable even a few years ago. In this environment wxWidgets must also unimaginable even a few years ago. In this environment wxWidgets must also
evolve in order to support these new features and platforms. evolve in order to support these new features and platforms.
However the goal of wxWidgets is not only to provide a consistent However the goal of wxWidgets is not only to provide a consistent programming
programming interface across many platforms, but also to provide an interface across many platforms, but also to provide an interface that is
interface that is reasonably stable over time, to help protect its users reasonably stable over time, to help protect its users from some of the
from some of the uncertainty of the future. uncertainty of the future.
@li @ref overview_backwardcompat_versionnumbering @li @ref overview_backwardcompat_versionnumbering
@li @ref overview_backwardcompat_sourcecompat @li @ref overview_backwardcompat_sourcecompat
@li @ref overview_backwardcompat_libbincompat @li @ref overview_backwardcompat_libbincompat
@li @ref overview_backwardcompat_appbincompat @li @ref overview_backwardcompat_appbincompat
<hr> <hr>
@section overview_backwardcompat_versionnumbering The version numbering scheme @section overview_backwardcompat_versionnumbering The Version Numbering Scheme
wxWidgets version numbers can have up to four components, with trailing wxWidgets version numbers can have up to four components, with trailing zeros
zeros sometimes omitted: sometimes omitted:
@code @vertatim
major.minor.release.sub-release major.minor.release.sub-release
@endcode @endverbatim
A stable release of wxWidgets will have an even number for @c minor, e.g. @c 2.6.0. A stable release of wxWidgets will have an even number for @e minor, e.g.
Stable, in this context, means that the API is not changing. In truth, some 2.6.0. Stable, in this context, means that the API is not changing. In truth,
changes are permitted, but only those that are backward compatible. For some changes are permitted, but only those that are backward compatible. For
example, you can expect later @c 2.6.x.x releases, such as @c 2.6.1 example, you can expect later 2.6.x releases, such as 2.6.1 and 2.6.2 to be
and @c 2.6.2 to be backward compatible with their predecessor. backward compatible with their predecessor.
When it becomes necessary to make changes which are not wholly backward When it becomes necessary to make changes which are not wholly backward
compatible, the stable branch is forked, creating a new development compatible, the stable branch is forked, creating a new development branch of
branch of wxWidgets. This development branch will have an odd number wxWidgets. This development branch will have an odd number for @e minor, for
for @c minor, for example @c 2.7.x.x. Releases from this branch are example 2.7.x. Releases from this branch are known as development snapshots.
known as development snapshots.
The stable branch and the development branch will then be developed in The stable branch and the development branch will then be developed in parallel
parallel for some time. When it is no longer useful to continue developing for some time. When it is no longer useful to continue developing the stable
the stable branch, the development branch is renamed and becomes a new branch, the development branch is renamed and becomes a new stable branch, for
stable branch, for example @c 2.8.0. And the process begins again. example: 2.8.0. And the process begins again. This is how the tension between
This is how the tension between keeping the interface stable, and allowing keeping the interface stable, and allowing the library to evolve is managed.
the library to evolve is managed.
You can expect the versions with the same major and even minor You can expect the versions with the same major and even minor version number
version number to be compatible, but between minor versions there will be to be compatible, but between minor versions there will be incompatibilities.
incompatibilities. Compatibility is not broken gratuitously however, so Compatibility is not broken gratuitously however, so many applications will
many applications will require no changes or only small changes to work require no changes or only small changes to work with the new version.
with the new version.
@section overview_backwardcompat_sourcecompat Source level compatibility @section overview_backwardcompat_sourcecompat Source Level Compatibility
Later releases from a stable branch are backward compatible with earlier Later releases from a stable branch are backward compatible with earlier
releases from the same branch at the source level. releases from the same branch at the source level. This means that, for
This means that, for example, if you develop your application using example, if you develop your application using wxWidgets 2.8.0 then it should
wxWidgets @c 2.6.0 then it should also compile fine with all later @c 2.6.x versions. also compile fine with all later 2.8.x versions.
The converse is also @true providing you avoid any new The converse is also true providing you avoid any new features not present in
features not present in the earlier version. For example if you develop the earlier version. For example if you develop using 2.6.1 your program will
using @c 2.6.1 your program will compile fine with wxWidgets @c 2.6.0 compile fine with wxWidgets 2.8.0 providing you don't use any 2.8.1 specific
providing you don't use any @c 2.6.1 specific features. features.
For some platforms binary compatibility is also supported, see 'Library For some platforms binary compatibility is also supported, see
binary compatibility' below. @ref overview_backwardcompat_libbincompat below.
Between minor versions, for example between @c 2.2.x, @c 2.4.x and @c 2.6.x, there Between minor versions, for example between 2.4.x, 2.6.x and 2.8.x, there will
will be some incompatibilities. Wherever possible the old way of doing something be some incompatibilities. Wherever possible the old way of doing something is
is kept alongside the new for a time wrapped inside: kept alongside the new for a time wrapped inside:
@code @code
#if WXWIN_COMPATIBILITY_2_4 #if WXWIN_COMPATIBILITY_2_6
// deprecated feature // deprecated feature
... ...
#endif #endif
@endcode @endcode
By default the @c WXWIN_COMPATIBILITY@e _X_X macro is set By default the @c WXWIN_COMPATIBILITY_X_X macro is set to 1 for the previous
to 1 for the previous stable branch, for example stable branch, for example in 2.8.x, @c WXWIN_COMPATIBILITY_2_6 = 1. For the
in @c 2.6.x @c WXWIN_COMPATIBILITY_2_4 = 1. For the next earlier next earlier stable branch the default is 0, so @c WXWIN_COMPATIBILITY_2_4 = 0
stable branch the default is 0, so @c WXWIN_COMPATIBILITY_2_2 = 0 for 2.8.x. Earlier than that, obsolete features are removed.
for @c 2.6.x. Earlier than that, obsolete features are removed.
These macros can be changed in @c setup.h. Or on UNIX-like systems you can These macros can be changed in @c setup.h. Or on UNIX-like systems you can set
set them using the @c --disable-compat24 and @c --enable-compat22 them using the @c --disable-compat26 and @c --enable-compat24 options to
options to @c configure. configure.
They can be useful in two ways: They can be useful in two ways:
@li changing @c WXWIN_COMPATIBILITY_2_4 to 0 can be useful to @li Changing @c WXWIN_COMPATIBILITY_2_6 to 0 can be useful to find uses of
find uses of deprecated features in your program. deprecated features in your program that should eventually be removed.
@li changing @c WXWIN_COMPATIBILITY_2_2 to 1 can be useful to @li Changing @c WXWIN_COMPATIBILITY_2_4 to 1 can be useful to compile a program
compile a program developed using @c 2.2.x that no longer compiles developed using 2.4.x that no longer compiles with 2.8.x.
with @c 2.6.x.
A program requiring one of these macros to be 1 will become incompatible with
A program requiring one of these macros to be 1 will become some future version of wxWidgets, and you should consider updating it.
incompatible with some future version of wxWidgets, and you should consider
updating it.
@section overview_backwardcompat_libbincompat Library Binary Compatibility
@section overview_backwardcompat_libbincompat Library binary compatibility
For some platforms, releases from a stable branch are not only source level
compatible but can also be binary compatible.
Binary compatibility makes it possible to get the maximum benefit from For some platforms, releases from a stable branch are not only source level
using shared libraries, also known as dynamic link libraries (DLLs) on compatible but can also be binary compatible.
Windows or dynamic shared libraries on OS X.
For example, suppose several applications are installed on a system requiring Binary compatibility makes it possible to get the maximum benefit from using
wxWidgets @c 2.6.0, @c 2.6.1 and @c 2.6.2. Since @c 2.6.2 is shared libraries, also known as dynamic link libraries (DLLs) on Windows or
backward compatible with the earlier versions, it should be enough to dynamic shared libraries on OS X.
install just wxWidgets @c 2.6.2 shared libraries, and all the applications
should be able to use them. If binary compatibility is not supported, then all
the required versions @c 2.6.0, @c 2.6.1 and @c 2.6.2 must be
installed side by side.
Achieving this, without the user being required to have the source code For example, suppose several applications are installed on a system requiring
and recompile everything, places many extra constraints on the changes wxWidgets 2.6.0, 2.6.1 and 2.6.2. Since 2.6.2 is backward compatible with the
that can be made within the stable branch. So it is not supported for all earlier versions, it should be enough to install just wxWidgets 2.6.2 shared
platforms, and not for all versions of wxWidgets. To date it has mainly libraries, and all the applications should be able to use them. If binary
been supported by wxGTK for UNIX-like platforms. compatibility is not supported, then all the required versions 2.6.0, 2.6.1 and
2.6.2 must be installed side by side.
Another practical consideration is that for binary compatibility to work, Achieving this, without the user being required to have the source code and
all the applications and libraries must have been compiled with compilers recompile everything, places many extra constraints on the changes that can be
that are capable of producing compatible code; made within the stable branch. So it is not supported for all platforms, and
that is, they must use the not for all versions of wxWidgets. To date it has mainly been supported by
same ABI (Application Binary Interface). Unfortunately most different C++ wxGTK for UNIX-like platforms.
compilers do not produce code compatible with each other, and often even
different versions of the same compiler are not compatible. Another practical consideration is that for binary compatibility to work, all
the applications and libraries must have been compiled with compilers that are
capable of producing compatible code; that is, they must use the same ABI
(Application Binary Interface). Unfortunately most different C++ compilers do
not produce code compatible with each other, and often even different versions
of the same compiler are not compatible.
@section overview_backwardcompat_appbincompat Application Binary Compatibility
@section overview_backwardcompat_appbincompat Application binary compatibility
The most important aspect of binary compatibility is that applications
compiled with one version of wxWidgets, e.g. @c 2.6.1, continue to work
with shared libraries of a later binary compatible version, for example @c 2.6.2.
The converse can also be useful however. That is, it can be useful for a
developer using a later version, e.g. @c 2.6.2 to be able to create binary
application packages that will work with all binary compatible versions of
the shared library starting with, for example @c 2.6.0.
To do this the developer must, of course, avoid any features not available The most important aspect of binary compatibility is that applications compiled
in the earlier versions. However this is not necessarily enough; with one version of wxWidgets, e.g. 2.6.1, continue to work with shared
in some cases an application compiled with a later version may depend on it even libraries of a later binary compatible version, for example 2.6.2. The converse
though the same code would compile fine against an earlier version. can also be useful however. That is, it can be useful for a developer using a
later version, e.g. 2.6.2 to be able to create binary application packages that
will work with all binary compatible versions of the shared library starting
with, for example 2.6.0.
To help with this, a preprocessor symbol @c wxABI_VERSION can be defined To do this the developer must, of course, avoid any features not available in
during the compilation of the application (this would usually be done in the the earlier versions. However this is not necessarily enough; in some cases an
application's makefile or project settings). It should be set to the lowest application compiled with a later version may depend on it even though the same
version that is being targeted, as a number with two decimal digits for each code would compile fine against an earlier version.
component, for example @c wxABI_VERSION=20600 for @c 2.6.0.
Setting @c wxABI_VERSION should prevent the application from implicitly To help with this, a preprocessor symbol @c wxABI_VERSION can be defined during
depending on a later version of wxWidgets, and also disables any new features the compilation of the application (this would usually be done in the
in the API, giving a compile time check that the source is compatible with application's makefile or project settings). It should be set to the lowest
the versions of wxWidgets being targeted. version that is being targeted, as a number with two decimal digits for each
component, for example @c wxABI_VERSION=20600 for 2.6.0.
Uses of @c wxABI_VERSION are stripped out of the wxWidgets sources when Setting @c wxABI_VERSION should prevent the application from implicitly
each new development branch is created. Therefore it is only useful to help depending on a later version of wxWidgets, and also disables any new features
achieve compatibility with earlier versions with the same major in the API, giving a compile time check that the source is compatible with the
and even minor version numbers. It won't, for example, help you write versions of wxWidgets being targeted.
code compatible with @c 2.4.x using wxWidgets @c 2.6.x.
Uses of @c wxABI_VERSION are stripped out of the wxWidgets sources when each
new development branch is created. Therefore it is only useful to help achieve
compatibility with earlier versions with the same major and even minor version
numbers. It won't, for example, help you write code compatible with 2.6.x using
wxWidgets 2.8.x.
*/ */

269
docs/doxygen/overviews/bitmap.h
View File

@@ -6,178 +6,177 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_bitmap Bitmaps and icons overview @page overview_bitmap Bitmaps and Icons
Classes: wxBitmap, wxBitmapHandler, wxIcon, wxCursor. Classes:
@li wxBitmap
@li wxBitmapHandler
@li wxIcon
@li wxCursor
The wxBitmap class encapsulates the concept of a platform-dependent bitmap, The wxBitmap class encapsulates the concept of a platform-dependent bitmap,
either monochrome or colour. Platform-specific methods for creating a either monochrome or colour. Platform-specific methods for creating a wxBitmap
wxBitmap object from an existing file are catered for, and object from an existing file are catered for, and this is an occasion where
this is an occasion where conditional compilation will sometimes be conditional compilation will sometimes be required.
required.
A bitmap created dynamically or loaded from a file can be selected A bitmap created dynamically or loaded from a file can be selected into a
into a memory device context (instance of wxMemoryDC). This memory device context (instance of wxMemoryDC). This enables the bitmap to be
enables the bitmap to be copied to a window or memory device context copied to a window or memory device context using wxDC::Blit(), or to be used
using wxDC::Blit, or to be used as a drawing surface. as a drawing surface.
See wxMemoryDC for an example of drawing onto a bitmap. See wxMemoryDC for an example of drawing onto a bitmap.
All wxWidgets platforms support XPMs for small bitmaps and icons. All wxWidgets platforms support XPMs for small bitmaps and icons. You may
You may include the XPM inline as below, since it's C code, or you include the XPM inline as below, since it's C code, or you can load it at
can load it at run-time. run-time.
@code @code
#include "mondrian.xpm" #include "mondrian.xpm"
@endcode @endcode
Sometimes you wish to use a .ico resource on Windows, and XPMs on Sometimes you wish to use a .ico resource on Windows, and XPMs on other
other platforms (for example to take advantage of Windows' support for platforms (for example to take advantage of Windows' support for multiple icon
multiple icon resolutions). resolutions).
A macro, #wxICON, is available which creates an icon using an XPM A macro, wxICON(), is available which creates an icon using an XPM on the
on the appropriate platform, or an icon resource on Windows. appropriate platform, or an icon resource on Windows:
@code @code
wxIcon icon(wxICON(mondrian)); wxIcon icon(wxICON(mondrian));
// Equivalent to: // The above line is equivalent to this:
#if defined(__WXGTK__) || defined(__WXMOTIF__) #if defined(__WXGTK__) || defined(__WXMOTIF__)
wxIcon icon(mondrian_xpm); wxIcon icon(mondrian_xpm);
#endif #endif
#if defined(__WXMSW__) #if defined(__WXMSW__)
wxIcon icon("mondrian"); wxIcon icon("mondrian");
#endif #endif
@endcode @endcode
There is also a corresponding #wxBITMAP macro which allows There is also a corresponding wxBITMAP() macro which allows to create the
to create the bitmaps in much the same way as #wxICON creates bitmaps in much the same way as wxICON() creates icons. It assumes that bitmaps
icons. It assumes that bitmaps live in resources under Windows or OS2 and XPM live in resources under Windows or OS2 and XPM files under all other platforms
files under all other platforms (for XPMs, the corresponding file must be (for XPMs, the corresponding file must be included before this macro is used,
included before this macro is used, of course, and the name of the bitmap of course, and the name of the bitmap should be the same as the resource name
should be the same as the resource name under Windows with @c _xpm under Windows with @c _xpm suffix). For example:
suffix). For example:
@code @code
// an easy and portable way to create a bitmap // an easy and portable way to create a bitmap
wxBitmap bmp(wxBITMAP(bmpname)); wxBitmap bmp(wxBITMAP(bmpname));
// which is roughly equivalent to the following // which is roughly equivalent to the following
#if defined(__WXMSW__) || defined(__WXPM__) #if defined(__WXMSW__) || defined(__WXPM__)
wxBitmap bmp("bmpname", wxBITMAP_TYPE_RESOURCE); wxBitmap bmp("bmpname", wxBITMAP_TYPE_RESOURCE);
#else // Unix #else // Unix
wxBitmap bmp(bmpname_xpm, wxBITMAP_TYPE_XPM); wxBitmap bmp(bmpname_xpm, wxBITMAP_TYPE_XPM);
#endif #endif
@endcode @endcode
You should always use wxICON and wxBITMAP macros because they work for any You should always use wxICON() and wxBITMAP() macros because they work for any
platform (unlike the code above which doesn't deal with wxMac, wxX11, ...) and platform (unlike the code above which doesn't deal with wxMac, wxX11, ...) and
are shorter and more clear than versions with many @ifdef_ blocks. Even better, are shorter and more clear than versions with many @ifdef_ blocks. Even better,
use the same XPMs on all platforms. use the same XPMs on all platforms.
@li @ref overview_bitmap_supportedformats @li @ref overview_bitmap_supportedformats
@li @ref overview_bitmap_handlers @li @ref overview_bitmap_handlers
<hr> <hr>
@section overview_bitmap_supportedformats Supported bitmap file formats @section overview_bitmap_supportedformats Supported Bitmap File Formats
The following lists the formats handled on different platforms. Note The following lists the formats handled on different platforms. Note that
that missing or partially-implemented formats are automatically supplemented missing or partially-implemented formats are automatically supplemented by
by the wxImage to load the data, and then converting using wxImage to load the data, and then converting it to wxBitmap form. Note
it to wxBitmap form. Note that using wxImage is the preferred way to that using wxImage is the preferred way to load images in wxWidgets, with the
load images in wxWidgets, with the exception of resources (XPM-files or exception of resources (XPM-files or native Windows resources).
native Windows resources).
Writing an image format handler for wxImage is also far easier than writing Writing an image format handler for wxImage is also far easier than writing one
one for wxBitmap, because wxImage has exactly one format on all platforms for wxBitmap, because wxImage has exactly one format on all platforms whereas
whereas wxBitmap can store pixel data very differently, depending on colour wxBitmap can store pixel data very differently, depending on colour depths and
depths and platform. platform.
@subsection overview_bitmap_supportedformats_bmp wxBitmap @subsection overview_bitmap_supportedformats_bmp wxBitmap
Under Windows, wxBitmap may load the following formats: Under Windows, wxBitmap may load the following formats:
@li Windows bitmap resource (wxBITMAP_TYPE_BMP_RESOURCE) @li Windows bitmap resource (wxBITMAP_TYPE_BMP_RESOURCE)
@li Windows bitmap file (wxBITMAP_TYPE_BMP) @li Windows bitmap file (wxBITMAP_TYPE_BMP)
@li XPM data and file (wxBITMAP_TYPE_XPM) @li XPM data and file (wxBITMAP_TYPE_XPM)
@li All formats that are supported by the wxImage class. @li All formats that are supported by the wxImage class.
Under wxGTK, wxBitmap may load the following formats: Under wxGTK, wxBitmap may load the following formats:
@li XPM data and file (wxBITMAP_TYPE_XPM) @li XPM data and file (wxBITMAP_TYPE_XPM)
@li All formats that are supported by the wxImage class. @li All formats that are supported by the wxImage class.
Under wxMotif and wxX11, wxBitmap may load the following formats: Under wxMotif and wxX11, wxBitmap may load the following formats:
@li XBM data and file (wxBITMAP_TYPE_XBM) @li XBM data and file (wxBITMAP_TYPE_XBM)
@li XPM data and file (wxBITMAP_TYPE_XPM) @li XPM data and file (wxBITMAP_TYPE_XPM)
@li All formats that are supported by the wxImage class. @li All formats that are supported by the wxImage class.
@subsection overview_bitmap_supportedformats_icon wxIcon
Under Windows, wxIcon may load the following formats:
@li Windows icon resource (wxBITMAP_TYPE_ICO_RESOURCE)
@li Windows icon file (wxBITMAP_TYPE_ICO)
@li XPM data and file (wxBITMAP_TYPE_XPM)
Under wxGTK, wxIcon may load the following formats:
@li XPM data and file (wxBITMAP_TYPE_XPM)
@li All formats that are supported by the wxImage class.
Under wxMotif and wxX11, wxIcon may load the following formats:
@li XBM data and file (wxBITMAP_TYPE_XBM)
@li XPM data and file (wxBITMAP_TYPE_XPM)
@li All formats that are supported by the wxImage class.
@subsection overview_bitmap_supportedformats_cursor wxCursor
Under Windows, wxCursor may load the following formats:
@li Windows cursor resource (wxBITMAP_TYPE_CUR_RESOURCE)
@li Windows cursor file (wxBITMAP_TYPE_CUR)
@li Windows icon file (wxBITMAP_TYPE_ICO)
@li Windows bitmap file (wxBITMAP_TYPE_BMP)
Under wxGTK, wxCursor may load the following formats (in addition to stock
cursors):
@li None (stock cursors only).
Under wxMotif and wxX11, wxCursor may load the following formats:
@li XBM data and file (wxBITMAP_TYPE_XBM)
@subsection overview_bitmap_supportedformats_icon wxIcon @section overview_bitmap_handlers Bitmap Format Handlers
Under Windows, wxIcon may load the following formats: To provide extensibility, the functionality for loading and saving bitmap
formats is not implemented in the wxBitmap class, but in a number of handler
classes, derived from wxBitmapHandler. There is a static list of handlers which
wxBitmap examines when a file load/save operation is requested.
@li Windows icon resource (wxBITMAP_TYPE_ICO_RESOURCE) Some handlers are provided as standard, but if you have special requirements,
@li Windows icon file (wxBITMAP_TYPE_ICO) you may wish to initialise the wxBitmap class with some extra handlers which
@li XPM data and file (wxBITMAP_TYPE_XPM) you write yourself or receive from a third party.
Under wxGTK, wxIcon may load the following formats: To add a handler object to wxBitmap, your application needs to include the
header which implements it, and then call the static function
wxBitmap::AddHandler().
@li XPM data and file (wxBITMAP_TYPE_XPM) @note Bitmap handlers are not implemented on all platforms, and new ones rarely
@li All formats that are supported by the wxImage class. need to be implemented since wxImage can be used for loading most formats, as
noted earlier.
Under wxMotif and wxX11, wxIcon may load the following formats:
@li XBM data and file (wxBITMAP_TYPE_XBM)
@li XPM data and file (wxBITMAP_TYPE_XPM)
@li All formats that are supported by the wxImage class.
@subsection overview_bitmap_supportedformats_cursor wxCursor
Under Windows, wxCursor may load the following formats:
@li Windows cursor resource (wxBITMAP_TYPE_CUR_RESOURCE)
@li Windows cursor file (wxBITMAP_TYPE_CUR)
@li Windows icon file (wxBITMAP_TYPE_ICO)
@li Windows bitmap file (wxBITMAP_TYPE_BMP)
Under wxGTK, wxCursor may load the following formats (in additional
to stock cursors):
@li None (stock cursors only).
Under wxMotif and wxX11, wxCursor may load the following formats:
@li XBM data and file (wxBITMAP_TYPE_XBM)
@section overview_bitmap_handlers Bitmap format handlers
To provide extensibility, the functionality for loading and saving bitmap formats
is not implemented in the wxBitmap class, but in a number of handler classes,
derived from wxBitmapHandler. There is a static list of handlers which wxBitmap
examines when a file load/save operation is requested.
Some handlers are provided as standard, but if you
have special requirements, you may wish to initialise the wxBitmap class with
some extra handlers which you write yourself or receive from a third party.
To add a handler object to wxBitmap, your application needs to include the header
which implements it, and then call the static function wxBitmap::AddHandler.
@note bitmap handlers are not implemented on all platforms, and new ones rarely need
to be implemented since wxImage can be used for loading most formats, as noted
earlier.
*/ */

86
docs/doxygen/overviews/bookctrl.h
View File

@@ -6,59 +6,71 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_bookctrl wxBookCtrl overview @page overview_bookctrl wxBookCtrl Overview
Classes: wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook Classes:
@li @ref overview_bookctrl_intro @li wxChoicebook
@li @ref overview_bookctrl_bestbookctrl @li wxListbook
@li wxNotebook
@li wxTreebook
@li wxToolbook
Sections:
@li @ref overview_bookctrl_intro
@li @ref overview_bookctrl_bestbookctrl
<hr> <hr>
@section overview_bookctrl_intro Introduction @section overview_bookctrl_intro Introduction
A book control is a convenient way of displaying multiple pages of information, 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: displayed one page at a time. wxWidgets has five variants of this control:
@li wxNotebook: uses a row of tabs @li wxChoicebook: controlled by a wxChoice
@li wxListbook: controlled by a wxListCtrl @li wxListbook: controlled by a wxListCtrl
@li wxChoicebook: controlled by a wxChoice @li wxNotebook: uses a row of tabs
@li wxTreebook: controlled by a wxTreeCtrl @li wxTreebook: controlled by a wxTreeCtrl
@li wxToolbook: controlled by a wxToolBar @li wxToolbook: controlled by a wxToolBar
See @ref page_utils_samples_notebook for an example of wxBookCtrl usage. See the @ref page_utils_samples_notebook for an example of wxBookCtrl usage.
@section overview_bookctrl_bestbookctrl Best book @section overview_bookctrl_bestbookctrl Best Book
wxBookCtrl is mapped to the class best suited for a given platform. wxBookCtrl is mapped to the class best suited for a given platform. Currently
Currently it provides wxChoicebook for smartphones equipped with it provides wxChoicebook for smartphones equipped with WinCE, and wxNotebook
WinCE, and wxNotebook for all other platforms. The mapping consists of: for all other platforms. The mapping consists of:
@beginTable @beginTable
@row2col{wxBookCtrl, wxChoicebook or wxNotebook} @row2col{ wxBookCtrl, wxChoicebook or wxNotebook }
@row2col{wxBookCtrlEvent, wxChoicebookEvent or wxNotebookEvent} @row2col{ wxBookCtrlEvent, wxChoicebookEvent or wxNotebookEvent }
@row2col{wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED, @row2col{ wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGED,
wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED} wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGED or
@row2col{wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING, wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGED }
wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING} @row2col{ wxEVT_COMMAND_BOOKCTRL_PAGE_CHANGING,
@row2col{EVT_BOOKCTRL_PAGE_CHANGED(id\, fn), wxEVT_COMMAND_CHOICEBOOK_PAGE_CHANGING or
EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or EVT_NOTEBOOK_PAGE_CHANGED(id, fn)} wxEVT_COMMAND_NOTEBOOK_PAGE_CHANGING }
@row2col{EVT_BOOKCTRL_PAGE_CHANGING(id\, fn), @row2col{ EVT_BOOKCTRL_PAGE_CHANGED(id\, fn),
EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or EVT_NOTEBOOK_PAGE_CHANGING(id, fn)} EVT_CHOICEBOOK_PAGE_CHANGED(id, fn) or
@endTable EVT_NOTEBOOK_PAGE_CHANGED(id, fn) }
@row2col{ EVT_BOOKCTRL_PAGE_CHANGING(id\, fn),
EVT_CHOICEBOOK_PAGE_CHANGING(id, fn) or
EVT_NOTEBOOK_PAGE_CHANGING(id, fn) }
@endTable
For orientation of the book controller, use following flags in style: For orientation of the book controller, use following flags in style:
@li @b wxBK_TOP: controller above pages @li @b wxBK_TOP: controller above pages
@li @b wxBK_BOTTOM: controller below pages @li @b wxBK_BOTTOM: controller below pages
@li @b wxBK_LEFT: controller on the left @li @b wxBK_LEFT: controller on the left
@li @b wxBK_RIGHT: controller on the right @li @b wxBK_RIGHT: controller on the right
@li @b wxBK_DEFAULT: native controller placement @li @b wxBK_DEFAULT: native controller placement
*/ */

48
docs/doxygen/overviews/bufferclasses.h
View File

@@ -6,44 +6,44 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_bufferclasses Buffer classes overview @page overview_bufferclasses Buffer Classes
wxWidgets uses two classes of classes for dealing with buffers in memory. wxWidgets uses two classes of classes for dealing with buffers in memory.
The first is one for dealing with character buffers, namely wxCharBuffer The first is one for dealing with character buffers, namely wxCharBuffer for
for char pointer or multi-byte c strings and wxWCharBuffer for wchar_t pointer char pointer or multi-byte c strings and wxWCharBuffer for wchar_t pointer or
or wide character c strings. wide character c strings.
Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer for
for dealing with raw buffers in memory. dealing with raw buffers in memory.
@li @ref overview_bufferclasses_xcb @li @ref overview_bufferclasses_xcb
<hr> <hr>
@section overview_bufferclasses_xcb wxXCharBuffer Overview @section overview_bufferclasses_xcb wxXCharBuffer
@subsection overview_bufferclasses_xcb_general General Usage @subsection overview_bufferclasses_xcb_general General Usage
As mentioned, wxCharBuffer and its wide character variant wxWCharBuffer deal As mentioned, wxCharBuffer and its wide character variant wxWCharBuffer deal
with c strings in memory. They have two constructors, one in which you pass with c strings in memory. They have two constructors, one in which you pass
the c string you want them to have a copy of, and another where you specify the c string you want them to have a copy of, and another where you specify the
the size of the buffer in memory in characters you want. size of the buffer in memory in characters you want.
wxCharBuffer and its variant only contain the c string as a member, so they wxCharBuffer and its variant only contain the c string as a member, so they can
can be used safely to c functions with variable arguments such as printf. be used safely to c functions with variable arguments such as printf. They also
They also contain standard assignment, character access operators and a copy constructor. contain standard assignment, character access operators and a copy constructor.
@subsection overview_bufferclasses_xcb_destruct Destruction @subsection overview_bufferclasses_xcb_destruct Destruction
It should be noted that on destruction wxCharBuffer and its wide character It should be noted that on destruction wxCharBuffer and its wide character
variant delete the c string that hold onto. If you want to get the pointer variant delete the c string that hold onto. If you want to get the pointer to
to the buffer and don't want wxCharBuffer to delete it on destruction, the buffer and don't want wxCharBuffer to delete it on destruction, use the
use the member function release to do so. member function release to do so.
*/ */

386
docs/doxygen/overviews/commondialogs.h
View File

@@ -6,252 +6,248 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@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
Common dialog classes and functions encapsulate commonly-needed dialog box
requirements. They are all 'modal', grabbing the flow of control until the user
dismisses the dialog, to make them easy to use within an application.
Some dialogs have both platform-dependent and platform-independent
implementations, so that if underlying windowing systems do not provide the
required functionality, the generic classes and functions can stand in. For
example, under MS Windows, wxColourDialog uses the standard colour selector.
There is also an equivalent called wxGenericColourDialog for other platforms,
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
<hr>
@section overview_cmndlg_colour wxColourDialog Overview
Classes: wxColourDialog, wxColourData
The wxColourDialog presents a colour selector to the user, and returns with
colour information.
@subsection overview_cmndlg_colour_msw The MS Windows Colour Selector
Under Windows, the native colour selector common dialog is used. This presents
a dialog box with three main regions: at the top left, a palette of 48
commonly-used colours is shown. Under this, there is a palette of 16
'custom colours' which can be set by the application if desired. Additionally,
the user may open up the dialog box to show a right-hand panel containing
controls to select a precise colour, and add it to the custom colour palette.
@subsection overview_cmndlg_colour_generic The Generic Colour Selector
@page overview_cmndlg Common dialogs overview Under non-MS Windows platforms, the colour selector is a simulation of most of
the features of the MS Windows selector. Two palettes of 48 standard and 16
Classes: wxColourDialog, wxFontDialog, wxPrintDialog, wxFileDialog, custom colours are presented, with the right-hand area containing three sliders
wxDirDialog, wxTextEntryDialog, wxPasswordEntryDialog, for the user to select a colour from red, green and blue components. This
wxMessageDialog, wxSingleChoiceDialog, wxMultiChoiceDialog colour may be added to the custom colour palette, and will replace either the
currently selected custom colour, or the first one in the palette if none is
selected. The RGB colour sliders are not optional in the generic colour
selector. The generic colour selector is also available under MS Windows; use
the name wxGenericColourDialog.
@subsection overview_cmndlg_colour_example Example
In the samples/dialogs directory, there is an example of using the
wxColourDialog class. Here is an excerpt, which sets various parameters of a
wxColourData object, including a grey scale for the custom colours. If the user
did not cancel the dialog, the application retrieves the selected colour and
uses it to set the background of a window.
@code
wxColourData data;
data.SetChooseFull(true);
for (int i = 0; i < 16; i++)
{
wxColour colour(i*16, i*16, i*16);
data.SetCustomColour(i, colour);
}
wxColourDialog dialog(this, &data);
if (dialog.ShowModal() == wxID_OK)
{
wxColourData retData = dialog.GetColourData();
wxColour col = retData.GetColour();
wxBrush brush(col, wxSOLID);
myWindow->SetBackground(brush);
myWindow->Clear();
myWindow->Refresh();
}
@endcode
Common dialog classes and functions encapsulate commonly-needed dialog box requirements.
They are all 'modal', grabbing the flow of control until the user dismisses the dialog,
to make them easy to use within an application.
Some dialogs have both platform-dependent and platform-independent implementations,
so that if underlying windowing systems do not provide the required functionality,
the generic classes and functions can stand in. For example, under MS Windows, wxColourDialog
uses the standard colour selector. There is also an equivalent called wxGenericColourDialog
for other platforms, 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
<hr>
@section overview_cmndlg_font wxFontDialog Overview
@section overview_cmndlg_colour wxColourDialog overview Classes: wxFontDialog, wxFontData
Classes: wxColourDialog, wxColourData
The wxColourDialog presents a colour selector to the user, and returns
with colour information.
@subsection overview_cmndlg_colour_msw The MS Windows colour selector
Under Windows, the native colour selector common dialog is used. This
presents a dialog box with three main regions: at the top left, a
palette of 48 commonly-used colours is shown. Under this, there is a
palette of 16 'custom colours' which can be set by the application if
desired. Additionally, the user may open up the dialog box to show
a right-hand panel containing controls to select a precise colour, and add
it to the custom colour palette.
@subsection overview_cmndlg_colour_generic The generic colour selector
Under non-MS Windows platforms, the colour selector is a simulation of The wxFontDialog presents a font selector to the user, and returns with font
most of the features of the MS Windows selector. Two palettes of 48 and colour information.
standard and 16 custom colours are presented, with the right-hand area
containing three sliders for the user to select a colour from red,
green and blue components. This colour may be added to the custom colour
palette, and will replace either the currently selected custom colour,
or the first one in the palette if none is selected. The RGB colour sliders
are not optional in the generic colour selector. The generic colour
selector is also available under MS Windows; use the name
wxGenericColourDialog.
@subsection overview_cmndlg_colour_example Example @subsection overview_cmndlg_font_msw The MS Windows Font Selector
In the samples/dialogs directory, there is an example of using Under Windows, the native font selector common dialog is used. This presents a
the wxColourDialog class. Here is an excerpt, which dialog box with controls for font name, point size, style, weight, underlining,
sets various parameters of a wxColourData object, including strikeout and text foreground colour. A sample of the font is shown on a white
a grey scale for the custom colours. If the user did not cancel area of the dialog box. Note that in the translation from full MS Windows fonts
the dialog, the application retrieves the selected colour and to wxWidgets font conventions, strikeout is ignored and a font family (such as
uses it to set the background of a window. Swiss or Modern) is deduced from the actual font name (such as Arial or
Courier).
@code @subsection overview_cmndlg_font_generic The Generic Font Selector
wxColourData data;
data.SetChooseFull(true);
for (int i = 0; i 16; i++)
{
wxColour colour(i*16, i*16, i*16);
data.SetCustomColour(i, colour);
}
wxColourDialog dialog(this, &data); Under non-MS Windows platforms, the font selector is simpler. Controls for font
if (dialog.ShowModal() == wxID_OK) family, point size, style, weight, underlining and text foreground colour are
{ provided, and a sample is shown upon a white background. The generic font
wxColourData retData = dialog.GetColourData(); selector is also available under MS Windows; use the name wxGenericFontDialog.
wxColour col = retData.GetColour();
wxBrush brush(col, wxSOLID);
myWindow->SetBackground(brush);
myWindow->Clear();
myWindow->Refresh();
}
@endcode
@subsection overview_cmndlg_font_example Example
In the samples/dialogs directory, there is an example of using the wxFontDialog
class. The application uses the returned font and colour for drawing text on a
canvas. Here is an excerpt:
@section overview_cmndlg_font wxFontDialog overview @code
wxFontData data;
data.SetInitialFont(canvasFont);
data.SetColour(canvasTextColour);
Classes: wxFontDialog, wxFontData wxFontDialog dialog(this, &data);
if (dialog.ShowModal() == wxID_OK)
{
wxFontData retData = dialog.GetFontData();
canvasFont = retData.GetChosenFont();
canvasTextColour = retData.GetColour();
myWindow->Refresh();
}
@endcode
The wxFontDialog presents a font selector to the user, and returns
with font and colour information.
@subsection overview_cmndlg_font_msw The MS Windows font selector @section overview_cmndlg_print wxPrintDialog Overview
Under Windows, the native font selector common dialog is used. This Classes: wxPrintDialog, wxPrintData
presents a dialog box with controls for font name, point size, style, weight,
underlining, strikeout and text foreground colour. A sample of the
font is shown on a white area of the dialog box. Note that
in the translation from full MS Windows fonts to wxWidgets font
conventions, strikeout is ignored and a font family (such as
Swiss or Modern) is deduced from the actual font name (such as Arial
or Courier).
@subsection overview_cmndlg_font_generic The generic font selector This class represents the print and print setup common dialogs. You may obtain
a wxPrinterDC device context from a successfully dismissed print dialog.
Under non-MS Windows platforms, the font selector is simpler. The samples/printing example shows how to use it: see @ref overview_printing
Controls for font family, point size, style, weight, for an excerpt from this example.
underlining and text foreground colour are provided, and
a sample is shown upon a white background. The generic font selector
is also available under MS Windows; use the name wxGenericFontDialog.
@subsection overview_cmndlg_font_example Example
In the samples/dialogs directory, there is an example of using @section overview_cmndlg_file wxFileDialog Overview
the wxFontDialog class. The application uses the returned font
and colour for drawing text on a canvas. Here is an excerpt:
@code Classes: wxFileDialog
wxFontData data;
data.SetInitialFont(canvasFont);
data.SetColour(canvasTextColour);
wxFontDialog dialog(this, &data); Pops up a file selector box. On Windows and GTK 2.4+, this is the common file
if (dialog.ShowModal() == wxID_OK) selector dialog. In X, this is a file selector box with somewhat less
{ functionality. The path and filename are distinct elements of a full file
wxFontData retData = dialog.GetFontData(); pathname.
canvasFont = retData.GetChosenFont();
canvasTextColour = retData.GetColour();
myWindow->Refresh();
}
@endcode
If path is "", the current directory will be used. If filename is "", no
default filename will be supplied. The wildcard determines what files are
displayed in the file selector, and file extension supplies a type extension
for the required filename. Flags may be a combination of wxFD_OPEN, wxFD_SAVE,
wxFD_OVERWRITE_PROMPT, wxFD_HIDE_READONLY, wxFD_FILE_MUST_EXIST, wxFD_MULTIPLE,
wxFD_CHANGE_DIR or 0.
Both the X and Windows versions implement a wildcard filter. Typing a filename
containing wildcards (*, ?) in the filename text item, and clicking on Ok, will
result in only those files matching the pattern being displayed. In the X
version, supplying no default name will result in the wildcard filter being
inserted in the filename text item; the filter is ignored if a default name is
supplied.
@section overview_cmndlg_print wxPrintDialog overview The wildcard may be a specification for multiple types of file with a
description for each, such as:
Classes: wxPrintDialog, wxPrintData @verbatim
"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
@endverbatim
This class represents the print and print setup common dialogs.
You may obtain a wxPrinterDC device context from
a successfully dismissed print dialog.
The samples/printing example shows how to use it: see @ref overview_printing for @section overview_cmndlg_dir wxDirDialog Overview
an excerpt from this example.
Classes: wxDirDialog
This dialog shows a directory selector dialog, allowing the user to select a
single directory.
@section overview_cmndlg_file wxFileDialog overview
Classes: wxFileDialog @section overview_cmndlg_textentry wxTextEntryDialog Overview
Pops up a file selector box. In Windows and GTK2.4+, this is the common Classes: wxTextEntryDialog
file selector dialog. In X, this is a file selector box with somewhat less
functionality. The path and filename are distinct elements of a full file pathname.
If path is "", the current directory will be used. If filename is "", This is a dialog with a text entry field. The value that the user entered is
no default filename will be supplied. The wildcard determines what files obtained using wxTextEntryDialog::GetValue().
are displayed in the file selector, and file extension supplies a type
extension for the required filename. Flags may be a combination of wxFD_OPEN,
wxFD_SAVE, wxFD_OVERWRITE_PROMPT, wxFD_HIDE_READONLY, wxFD_FILE_MUST_EXIST,
wxFD_MULTIPLE, wxFD_CHANGE_DIR or 0.
Both the X and Windows versions implement a wildcard filter. Typing a
filename containing wildcards (*, ?) in the filename text item, and
clicking on Ok, will result in only those files matching the pattern being
displayed. In the X version, supplying no default name will result in the
wildcard filter being inserted in the filename text item; the filter is
ignored if a default name is supplied.
The wildcard may be a specification for multiple @section overview_cmndlg_password wxPasswordEntryDialog Overview
types of file with a description for each, such as:
@code Classes: wxPasswordEntryDialog
"BMP files (*.bmp)|*.bmp|GIF files (*.gif)|*.gif"
@endcode
This is a dialog with a password entry field. The value that the user entered
is obtained using wxTextEntryDialog::GetValue().
@section overview_cmndlg_dir wxDirDialog overview @section overview_cmndlg_msg wxMessageDialog Overview
Classes: wxDirDialog Classes: wxMessageDialog
This dialog shows a directory selector dialog, allowing the user to select This dialog shows a message, plus buttons that can be chosen from OK, Cancel,
a single directory. Yes, and No. Under Windows, an optional icon can be shown, such as an
exclamation mark or question mark.
The return value of wxMessageDialog::ShowModal() indicates which button the
user pressed.
@section overview_cmndlg_textentry wxTextEntryDialog overview @section overview_cmndlg_singlechoice wxSingleChoiceDialog Overview
Classes: wxTextEntryDialog Classes: wxSingleChoiceDialog
This is a dialog with a text entry field. The value that the user This dialog shows a list of choices, plus OK and (optionally) Cancel. The user
entered is obtained using wxTextEntryDialog::GetValue. 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
@section overview_cmndlg_password wxPasswordEntryDialog overview Classes: wxMultiChoiceDialog
Classes: wxPasswordEntryDialog This dialog shows a list of choices, plus OK and (optionally) Cancel. The user
can select one or more of them.
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
This dialog shows a message, plus buttons that can be chosen from OK, Cancel, Yes, and No.
Under Windows, an optional icon can be shown, such as an exclamation mark or question mark.
The return value of wxMessageDialog::ShowModal indicates
which button the user pressed.
@section overview_cmndlg_singlechoice wxSingleChoiceDialog overview
Classes: wxSingleChoiceDialog
This dialog shows a list of choices, plus OK and (optionally) Cancel. The user 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
This dialog shows a list of choices, plus OK and (optionally) Cancel. The user can
select one or more of them.
*/ */

82
docs/doxygen/overviews/config.h
View File

@@ -6,57 +6,57 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_config wxConfig classes overview @page overview_config wxConfig Overview
Classes: wxConfigBase Classes: wxConfigBase
This overview briefly describes what the config classes are and what they are This overview briefly describes what the config classes are and what they are
for. All the details about how to use them may be found in the description of for. All the details about how to use them may be found in the description of
the wxConfigBase class and the documentation of the the wxConfigBase class and the documentation of the file, registry and INI file
file, registry and INI file based implementations mentions all the based implementations mentions all the features/limitations specific to each
features/limitations specific to each one of these versions. one of these versions.
The config classes provide a way to store some application configuration The config classes provide a way to store some application configuration
information. They were especially designed for this usage and, although may information. They were especially designed for this usage and, although may
probably be used for many other things as well, should be limited to it. It probably be used for many other things as well, should be limited to it. It
means that this information should be: means that this information should be:
@li Typed, i.e. strings or numbers for the moment. @li Typed, i.e. strings or numbers for the moment. You can not store binary
You can not store binary data, for example. data, for example.
@li Small. For instance, it is not recommended to use the Windows @li Small. For instance, it is not recommended to use the Windows registry for
registry for amounts of data more than a couple of kilobytes. amounts of data more than a couple of kilobytes.
@li Not performance critical, neither from speed nor from a memory @li Not performance critical, neither from speed nor from a memory consumption
consumption point of view. point of view.
On the other hand, the features provided make them very useful for storing all On the other hand, the features provided make them very useful for storing all
kinds of small to medium volumes of hierarchically-organized, heterogeneous kinds of small to medium volumes of hierarchically-organized, heterogeneous
data. In short, this is a place where you can conveniently stuff all your data data. In short, this is a place where you can conveniently stuff all your data
(numbers and strings) organizing it in a tree where you use the (numbers and strings) organizing it in a tree where you use the filesystem-like
filesystem-like paths to specify the location of a piece of data. In paths to specify the location of a piece of data. In particular, these classes
particular, these classes were designed to be as easy to use as possible. were designed to be as easy to use as possible.
From another point of view, they provide an interface which hides the From another point of view, they provide an interface which hides the
differences between the Windows registry and the standard Unix text format differences between the Windows registry and the standard Unix text format
configuration files. Other (future) implementations of wxConfigBase might also configuration files. Other (future) implementations of wxConfigBase might also
understand GTK resource files or their analogues on the KDE side. understand GTK resource files or their analogues on the KDE side.
In any case, each implementation of wxConfigBase does its best to In any case, each implementation of wxConfigBase does its best to make the data
make the data look the same way everywhere. Due to limitations of the underlying look the same way everywhere. Due to limitations of the underlying physical
physical storage, it may not implement 100% of the base class functionality. storage, it may not implement 100% of the base class functionality.
There are groups of entries and the entries themselves. Each entry contains either There are groups of entries and the entries themselves. Each entry contains
a string or a number (or a boolean value; support for other types of data such as either a string or a number (or a boolean value; support for other types of
dates or timestamps is planned) and is identified by the full path to it: something data such as dates or timestamps is planned) and is identified by the full path
like @c /MyApp/UserPreferences/Colors/Foreground. to it: something like @c /MyApp/UserPreferences/Colors/Foreground.
The previous elements in the path are the group names, and each name may The previous elements in the path are the group names, and each name may
contain an arbitrary number of entries and subgroups. contain an arbitrary number of entries and subgroups.
The path components are @b always separated with a slash, The path components are @e always separated with a slash, even though some
even though some implementations use the backslash internally. Further implementations use the backslash internally. Further details (including how to
details (including how to read/write these entries) may be found in read/write these entries) may be found in the documentation for wxConfigBase.
the documentation for wxConfigBase.
*/ */

4
docs/doxygen/overviews/constraints.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_constraints Constraints overview @page overview_constraints Window Layout Constraints
Classes: wxLayoutConstraints, wxIndividualLayoutConstraint. Classes: wxLayoutConstraints, wxIndividualLayoutConstraint.

101
docs/doxygen/overviews/container.h
View File

@@ -6,66 +6,69 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_container Container classes overview @page overview_container Container Classes
Classes: wxList<T>, wxArray<T>, wxVector<T> Classes: wxList<T>, wxArray<T>, wxVector<T>
wxWidgets uses itself several container classes including doubly-linked lists wxWidgets uses itself several container classes including doubly-linked lists
and dynamic arrays (i.e. arrays which expand automatically when they become and dynamic arrays (i.e. arrays which expand automatically when they become
full). For both historical and portability reasons wxWidgets does not use STL full). For both historical and portability reasons wxWidgets does not use STL
which provides the standard implementation of many container classes in C++. which provides the standard implementation of many container classes in C++.
First of all, wxWidgets has existed since well before STL was written, and First of all, wxWidgets has existed since well before STL was written, and
secondly we don't believe that today compilers can deal really well with all of secondly we don't believe that today compilers can deal really well with all of
STL classes (this is especially true for some less common platforms). Of STL classes (this is especially true for some less common platforms). Of
course, the compilers are evolving quite rapidly and hopefully their progress course, the compilers are evolving quite rapidly and hopefully their progress
will allow to base future versions of wxWidgets on STL - but this is not yet will allow to base future versions of wxWidgets on STL - but this is not yet
the case. the case.
wxWidgets container classes don't pretend to be as powerful or full as STL wxWidgets container classes don't pretend to be as powerful or full as STL
ones, but they are quite useful and may be compiled with absolutely any C++ ones, but they are quite useful and may be compiled with absolutely any C++
compiler. They're used internally by wxWidgets, but may, of course, be used in compiler. They're used internally by wxWidgets, but may, of course, be used in
your programs as well if you wish. your programs as well if you wish.
The list classes in wxWidgets are doubly-linked lists which may either own the The list classes in wxWidgets are doubly-linked lists which may either own the
objects they contain (meaning that the list deletes the object when it is objects they contain (meaning that the list deletes the object when it is
removed from the list or the list itself is destroyed) or just store the removed from the list or the list itself is destroyed) or just store the
pointers depending on whether you called or not wxList::DeleteContents method. pointers depending on whether or not you called wxList<T>::DeleteContents()
method.
Dynamic arrays resemble C arrays but with two important differences: they Dynamic arrays resemble C arrays but with two important differences: they
provide run-time range checking in debug builds and they automatically expand provide run-time range checking in debug builds and they automatically expand
the allocated memory when there is no more space for new items. They come in the allocated memory when there is no more space for new items. They come in
two sorts: the "plain" arrays which store either built-in types such as "char", two sorts: the "plain" arrays which store either built-in types such as "char",
"int" or "bool" or the pointers to arbitrary objects, or "object arrays" which "int" or "bool" or the pointers to arbitrary objects, or "object arrays" which
own the object pointers to which they store. own the object pointers to which they store.
For the same portability reasons, the container classes implementation in wxWidgets For the same portability reasons, the container classes implementation in
does not use templates, but is rather based on C preprocessor i.e. is done with wxWidgets does not use templates, but is rather based on C preprocessor i.e. is
the macros: @e WX_DECLARE_LIST and @e WX_DEFINE_LIST for the linked done with the macros: WX_DECLARE_LIST() and WX_DEFINE_LIST() for the linked
lists and @e WX_DECLARE_ARRAY, @e WX_DECLARE_OBJARRAY and @e WX_DEFINE_OBJARRAY for lists and WX_DECLARE_ARRAY(), WX_DECLARE_OBJARRAY() and WX_DEFINE_OBJARRAY()
the dynamic arrays. for the dynamic arrays.
The "DECLARE" macro declares a new container class containing the elements of The "DECLARE" macro declares a new container class containing the elements of
given type and is needed for all three types of container classes: lists, given type and is needed for all three types of container classes: lists,
arrays and objarrays. The "DEFINE" classes must be inserted in your program arrays and objarrays. The "DEFINE" classes must be inserted in your program in
in a place where the @b full declaration of container element class is in scope a place where the @e full declaration of container element class is in scope
(i.e. not just forward declaration), otherwise destructors of the container (i.e. not just forward declaration), otherwise destructors of the container
elements will not be called! elements will not be called!
As array classes never delete the items they contain anyhow, there is As array classes never delete the items they contain anyhow, there is no
no WX_DEFINE_ARRAY macro for them. WX_DEFINE_ARRAY() macro for them.
Examples of usage of these macros may be found in wxList and wxArray documentation. Examples of usage of these macros may be found in wxList<T> and wxArray<T>
documentation.
Finally, wxWidgets predefines several commonly used container classes. wxList Finally, wxWidgets predefines several commonly used container classes. wxList
is defined for compatibility with previous versions as a list containing is defined for compatibility with previous versions as a list containing
wxObjects and wxStringList as a list of C-style strings (char *), both of these wxObjects and wxStringList as a list of C-style strings (char *), both of these
classes are deprecated and should not be used in new programs. The following classes are deprecated and should not be used in new programs. The following
array classes are defined: wxArrayInt, wxArrayLong, wxArrayPtrVoid and array classes are defined: wxArrayInt, wxArrayLong, wxArrayPtrVoid and
wxArrayString. The first three store elements of corresponding types, but wxArrayString. The first three store elements of corresponding types, but
wxArrayString is somewhat special: it is an optimized version of wxArray which wxArrayString is somewhat special: it is an optimized version of wxArray which
uses its knowledge about wxString reference counting schema. uses its knowledge about wxString reference counting schema.
*/ */

4
docs/doxygen/overviews/dataobject.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_dataobject wxDataObject overview @page overview_dataobject wxDataObject Overview
Classes: wxDataObject, wxClipboard, wxDataFormat, wxDropSource, wxDropTarget Classes: wxDataObject, wxClipboard, wxDataFormat, wxDropSource, wxDropTarget

4
docs/doxygen/overviews/datetime.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_datetime Date and time classes overview @page overview_datetime Date and Time
Classes: wxDateTime, wxDateSpan, wxTimeSpan, wxCalendarCtrl Classes: wxDateTime, wxDateSpan, wxTimeSpan, wxCalendarCtrl

4
docs/doxygen/overviews/dc.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_dc Device context overview @page overview_dc Device Contexts
Classes: wxBufferedDC, wxBufferedPaintDC, wxDC, wxPostScriptDC, Classes: wxBufferedDC, wxBufferedPaintDC, wxDC, wxPostScriptDC,
wxMetafileDC, wxMemoryDC, wxPrinterDC, wxScreenDC, wxClientDC, wxMetafileDC, wxMemoryDC, wxPrinterDC, wxScreenDC, wxClientDC,

4
docs/doxygen/overviews/debugging.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_debugging Debugging overview @page overview_debugging Debugging
Classes, functions and macros: wxDebugContext, wxObject, wxLog, Classes, functions and macros: wxDebugContext, wxObject, wxLog,
@ref page_func_cat_log, @ref page_macro_cat_debugging @ref page_func_cat_log, @ref page_macro_cat_debugging

4
docs/doxygen/overviews/dialog.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_dialog wxDialog overview @page overview_dialog wxDialog Overview
Classes: wxDialog, wxDialogLayoutAdapter Classes: wxDialog, wxDialogLayoutAdapter

4
docs/doxygen/overviews/dnd.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_dnd Drag and drop overview @page overview_dnd Drag and Drop Overview
Classes: wxDataObject, wxTextDataObject, wxDropSource, wxDropTarget, Classes: wxDataObject, wxTextDataObject, wxDropSource, wxDropTarget,
wxTextDropTarget, wxFileDropTarget wxTextDropTarget, wxFileDropTarget

4
docs/doxygen/overviews/docview.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_docview Document/view overview @page overview_docview Document/View Framework
Classes: wxDocument, wxView, wxDocTemplate, wxDocManager, wxDocParentFrame, Classes: wxDocument, wxView, wxDocTemplate, wxDocManager, wxDocParentFrame,
wxDocChildFrame, wxDocMDIParentFrame, wxDocMDIChildFrame, wxDocChildFrame, wxDocMDIParentFrame, wxDocMDIChildFrame,

4
docs/doxygen/overviews/envvars.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_envvars Environment variables @page overview_envvars Environment Variables
This section describes all environment variables that affect execution of This section describes all environment variables that affect execution of
wxWidgets programs. wxWidgets programs.

4
docs/doxygen/overviews/eventhandling.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_eventhandling Event handling overview @page overview_eventhandling Event Handling
Classes: wxEvtHandler, wxWindow, wxEvent Classes: wxEvtHandler, wxWindow, wxEvent

4
docs/doxygen/overviews/exceptions.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_exceptions C++ exceptions overview @page overview_exceptions C++ Exceptions
@li @ref overview_exceptions_introduction @li @ref overview_exceptions_introduction
@li @ref overview_exceptions_strategies @li @ref overview_exceptions_strategies

4
docs/doxygen/overviews/file.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_file File classes and functions overview @page overview_file File Classes and Functions
Classes: wxFile, wxDir, wxTempFile, wxTextFile Classes: wxFile, wxDir, wxTempFile, wxTextFile

4
docs/doxygen/overviews/filesystem.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_fs wxFileSystem overview @page overview_fs wxFileSystem Overview
The wxHTML library uses a @b virtual file systems mechanism The wxHTML library uses a @b virtual file systems mechanism
similar to the one used in Midnight Commander, Dos Navigator, similar to the one used in Midnight Commander, Dos Navigator,

4
docs/doxygen/overviews/font.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_font wxFont overview @page overview_font wxFont Overview
Class: wxFont, wxFontDialog Class: wxFont, wxFontDialog

4
docs/doxygen/overviews/fontencoding.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_fontencoding Font encoding overview @page overview_fontencoding Font Encodings
wxWidgets has support for multiple font encodings. wxWidgets has support for multiple font encodings.

4
docs/doxygen/overviews/grid.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_grid wxGrid classes overview @page overview_grid wxGrid Overview
Classes: wxGrid Classes: wxGrid

4
docs/doxygen/overviews/helloworld.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_helloworld wxWidgets Hello World sample @page overview_helloworld Hello World Example
Many people have requested a mini-sample to be published here Many people have requested a mini-sample to be published here
so that some quick judgment concerning syntax so that some quick judgment concerning syntax

4
docs/doxygen/overviews/html.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_html wxHTML overview @page overview_html wxHTML Overview
The wxHTML library provides classes for parsing and displaying HTML. The wxHTML library provides classes for parsing and displaying HTML.
It is not intended to be a high-end HTML browser. If you are looking for It is not intended to be a high-end HTML browser. If you are looking for

2
docs/doxygen/overviews/internationalization.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_i18n Internationalization @page overview_i18n Internationalization

4
docs/doxygen/overviews/ipc.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_ipc Interprocess Communication Overview @page overview_ipc Interprocess Communication
Classes: wxServer, wxConnection, wxClient Classes: wxServer, wxConnection, wxClient

2
docs/doxygen/overviews/listctrl.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_listctrl wxListCtrl Overview @page overview_listctrl wxListCtrl Overview

2
docs/doxygen/overviews/log.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_log wxLog Classes Overview @page overview_log wxLog Classes Overview

4
docs/doxygen/overviews/mbconvclasses.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_mbconv wxMBConv Classes Overview @page overview_mbconv wxMBConv Overview
Classes: wxMBConv, wxMBConvLibc, wxMBConvUTF7, wxMBConvUTF8, wxCSConv, Classes: wxMBConv, wxMBConvLibc, wxMBConvUTF7, wxMBConvUTF8, wxCSConv,
wxMBConvUTF16, wxMBConvUTF32 wxMBConvUTF16, wxMBConvUTF32

2
docs/doxygen/overviews/nonenglish.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_nonenglish Writing Non-English Applications @page overview_nonenglish Writing Non-English Applications

4
docs/doxygen/overviews/printing.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_printing Printing Overview @page overview_printing Printing
Classes: Classes:
@li wxPrintout @li wxPrintout

2
docs/doxygen/overviews/python.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_python wxPython Overview @page overview_python wxPython Overview

2
docs/doxygen/overviews/refcount.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_refcount Reference Counting @page overview_refcount Reference Counting

2
docs/doxygen/overviews/referencenotes.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_referencenotes Notes on Using the Reference @page overview_referencenotes Notes on Using the Reference

4
docs/doxygen/overviews/resyntax.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_resyntax Syntax of the Built-in Regular Expression Library @page overview_resyntax Regular Expressions
A <em>regular expression</em> describes strings of characters. It's a pattern A <em>regular expression</em> describes strings of characters. It's a pattern
that matches certain strings and doesn't match others. that matches certain strings and doesn't match others.

2
docs/doxygen/overviews/richtextctrl.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_richtextctrl wxRichTextCtrl Overview @page overview_richtextctrl wxRichTextCtrl Overview

4
docs/doxygen/overviews/roughguide.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_roughguide Writing a wxWidgets Application: A Rough Guide @page overview_roughguide A Quick Guide to Writing Applications
To set a wxWidgets application going, you will need to derive a wxApp class and To set a wxWidgets application going, you will need to derive a wxApp class and
override wxApp::OnInit. override wxApp::OnInit.

2
docs/doxygen/overviews/runtimeclass.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_rtti Runtime Type Information (RTTI) @page overview_rtti Runtime Type Information (RTTI)

4
docs/doxygen/overviews/scrolling.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_scrolling Scrolling Overview @page overview_scrolling Scrolled Windows
Classes: Classes:
@li wxWindow @li wxWindow

4
docs/doxygen/overviews/sizer.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_sizer Sizer Overview @page overview_sizer Sizers
Classes: wxSizer, wxGridSizer, wxFlexGridSizer, wxBoxSizer, wxStaticBoxSizer Classes: wxSizer, wxGridSizer, wxFlexGridSizer, wxBoxSizer, wxStaticBoxSizer

2
docs/doxygen/overviews/splitterwindow.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_splitterwindow wxSplitterWindow Overview @page overview_splitterwindow wxSplitterWindow Overview

2
docs/doxygen/overviews/stream.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_stream wxStreams Overview @page overview_stream wxStreams Overview

2
docs/doxygen/overviews/string.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_string wxString Overview @page overview_string wxString Overview

4
docs/doxygen/overviews/thread.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_thread Multithreading Overview @page overview_thread Multithreading
Classes: wxThread, wxMutex, wxCriticalSection, wxCondition Classes: wxThread, wxMutex, wxCriticalSection, wxCondition

2
docs/doxygen/overviews/tips.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_tips wxTipProvider Overview @page overview_tips wxTipProvider Overview

2
docs/doxygen/overviews/toolbar.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_toolbar Toolbar Overview @page overview_toolbar Toolbar Overview

2
docs/doxygen/overviews/treectrl.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_treectrl wxTreeCtrl Overview @page overview_treectrl wxTreeCtrl Overview

2
docs/doxygen/overviews/unicode.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_unicode Unicode Support in wxWidgets @page overview_unicode Unicode Support in wxWidgets

2
docs/doxygen/overviews/unixprinting.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_unixprinting Printing Under Unix (GTK+) @page overview_unixprinting Printing Under Unix (GTK+)

2
docs/doxygen/overviews/validator.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_validator wxValidator Overview @page overview_validator wxValidator Overview

4
docs/doxygen/overviews/windowdeletion.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_windowdeletion Window Deletion Overview @page overview_windowdeletion Window Deletion
Classes: wxCloseEvent, wxWindow Classes: wxCloseEvent, wxWindow

4
docs/doxygen/overviews/windowids.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_windowids Window IDs Overview @page overview_windowids Window IDs
@li @ref overview_windowids_intro @li @ref overview_windowids_intro
@li @ref overview_windowids_type @li @ref overview_windowids_type

4
docs/doxygen/overviews/windowsizing.h
View File

@@ -6,9 +6,9 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_windowsizing Window Sizing Overview @page overview_windowsizing Window Sizes
It can sometimes be confusing to keep track of the various size-related It can sometimes be confusing to keep track of the various size-related
attributes of a wxWindow, how they relate to each other, and how they interact attributes of a wxWindow, how they relate to each other, and how they interact

2
docs/doxygen/overviews/windowstyles.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_windowstyles Window Styles @page overview_windowstyles Window Styles

2
docs/doxygen/overviews/xrc.h
View File

@@ -6,7 +6,7 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/*! /**
@page overview_xrc XML Based Resource System (XRC) @page overview_xrc XML Based Resource System (XRC)