solemnwarning/wxwidgets
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions 4

removed trailing whitespace in Doxygen files

Browse source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52634 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Václav Slavík 2008-03-20 13:45:17 +00:00
parent 7df4c51f60
commit 3c4f71cc3d
184 changed files with 4902 additions and 4902 deletions
Download patch file Download diff file Expand all files Collapse all files

2
docs/doxygen/mainpages/cat_functions.h
View file

@ -217,7 +217,7 @@ The following are relevant to the GDI (Graphics Device Interface).
@warning These functions are deprecated, use the wxClipboard class instead.
These clipboard functions are implemented for Windows only.
These clipboard functions are implemented for Windows only.
@header{wx/clipbrd.h}

68
docs/doxygen/mainpages/const_cpp.h
View file

@ -29,7 +29,7 @@
@section page_cppconst_guisystem GUI system
@beginDefList
@itemdef{__WINDOWS__, any Windows, you may also use __WXMSW__}
@itemdef{__WIN16__, Win16 API (not supported since wxWidgets 2.6)}
@ -48,7 +48,7 @@
@itemdef{__WXMOTIF20__, Motif 2.0 or higher}
@itemdef{__WXMAC__, Mac OS all targets}
@itemdef{__WXMAC_CLASSIC__, MacOS for Classic}
@itemdef{__WXMAC_CARBON__, MacOS for Carbon CFM (running under Classic or OSX)
@itemdef{__WXMAC_CARBON__, MacOS for Carbon CFM (running under Classic or OSX)
or true OS X Mach-O Builds}
@itemdef{__WXMAC_OSX__, MacOS X Carbon Mach-O Builds}
@itemdef{__WXMGL__, SciTech Soft MGL (__WXUNIVERSAL__ will be also defined)}
@ -64,33 +64,33 @@
to one of the symbols above so this should be tested first.}
@itemdef{__X__, any X11-based GUI toolkit except GTK+}
@endDefList
There are two wxWidgets ports to Mac OS. One of them, wxMac, exists in two versions:
Classic and Carbon. The Classic version is the only one to work on Mac OS version 8.
There are two wxWidgets ports to Mac OS. One of them, wxMac, exists in two versions:
Classic and Carbon. The Classic version is the only one to work on Mac OS version 8.
The Carbon version may be built either as CFM or Mach-O (binary format, like ELF)
and the former may run under OS 9 while the latter only runs under OS X.
Finally, there is a new Cocoa port which can only be used under OS X. To
summarize:
@li If you want to test for all Mac platforms, classic and OS X, you
should test both @c __WXMAC__ and @c __WXCOCOA__.
@li If you want to test for any GUI Mac port under OS X, use
@c __WXOSX__.
@li If you want to test for any port under Mac OS X, including, for
example, wxGTK and also wxBase, use @c __DARWIN__ (see below).
The convention is to use the @c __WX prefix for these
symbols, although this has not always been followed.
@section page_cppconst_os Operating systems
@beginDefList
@itemdef{__APPLE__, any Mac OS version}
@itemdef{__AIX__, AIX}
@itemdef{__BSD__, Any *BSD system}
@itemdef{__CYGWIN__, Cygwin: Unix on Win32}
@itemdef{__DARWIN__, Mac OS X using the BSD Unix C library
@itemdef{__DARWIN__, Mac OS X using the BSD Unix C library
(as opposed to using the Metrowerks MSL C/C++ library)}
@itemdef{__DATA_GENERAL__, DG-UX}
@itemdef{__DOS_GENERAL__, DOS (used with wxMGL only)}
@ -116,12 +116,12 @@
@endDefList
@section page_cppconst_cpu Hardware architectures (CPU)
Note that not all of these symbols are always defined, it depends on the
compiler used.
@beginDefList
@itemdef{__ALPHA__, DEC Alpha architecture}
@itemdef{__INTEL__, Intel i386 or compatible}
@ -130,9 +130,9 @@
@endDefList
@section page_cppconst_hardware Hardware type
@beginDefList
@itemdef{__SMARTPHONE__, Generic mobile devices with phone buttons and a small display}
@itemdef{__PDA__, Personal digital assistant, usually with touch screen}
@ -144,9 +144,9 @@
@endDefList
@section page_cppconst_compiler Compilers
@beginDefList
@itemdef{__BORLANDC__, Borland C++. The value of the macro corresponds
to the compiler version: $500$ is $5.0$.}
@ -159,10 +159,10 @@
@itemdef{__SUNCC__, Sun CC, see also wxCHECK_SUNCC_VERSION}
@itemdef{__SYMANTECC__, Symantec C++}
@itemdef{__VISAGECPP__, IBM Visual Age (OS/2)}
@itemdef{__VISUALC__, Microsoft Visual C++, see also wxCHECK_VISUALC_VERSION.
The value of this macro corresponds to the compiler version:
@c 1020 for @c 4.2 (the first supported version), @c 1100 for
@c 5.0, @c 1200 for @c 6.0 and so on. For convenience, the symbols
@itemdef{__VISUALC__, Microsoft Visual C++, see also wxCHECK_VISUALC_VERSION.
The value of this macro corresponds to the compiler version:
@c 1020 for @c 4.2 (the first supported version), @c 1100 for
@c 5.0, @c 1200 for @c 6.0 and so on. For convenience, the symbols
__VISUALCn__ are also defined for each major compiler version from
5 to 9, i.e. you can use tests such @ifdef_ __VISUALC7__ to test
for compiler version being precisely 7.}
@ -173,17 +173,17 @@
@endDefList
@section page_cppconst_featuretests Feature tests
Some library features may not be always available even if they were selected
Some library features may not be always available even if they were selected
by the user. To make it possible to check if this is the case, the library
predefines the symbols in the form @c wxHAS_FEATURE. Unlike
predefines the symbols in the form @c wxHAS_FEATURE. Unlike
@c wxUSE_FEATURE symbols which are defined by the library user (directly
in @c setup.h or by running configure script) and which must be always
defined as either $0$ or $1$, the @c wxHAS symbols are only defined if
the corresponding feature is available and not defined at all otherwise.
Currently the following symbols exist:
@beginDefList
@ -198,15 +198,15 @@
@endDefList
@section page_cppconst_miscellaneous Miscellaneous
@beginDefList
@itemdef{__WXWINDOWS__,
always defined in wxWidgets applications, see also wxCHECK_VERSION}
@itemdef{__WXDEBUG__, defined in debug mode, undefined in release mode}
@itemdef{wxUSE_XXX,
if defined as $1$, feature XXX is active, see the
if defined as $1$, feature XXX is active, see the
@ref page_wxusedef (the symbols of this form are always defined,
use @if_ and not @ifdef_ to test for them)}
@itemdef{WX_PRECOMP,
@ -227,20 +227,20 @@
building wxBase code, either as a standalone library or as part of the
monolithic wxWidgets library, defined as $0$ when building GUI library only)}
@itemdef{wxNO_RTTI, is defined if the compiler RTTI support has been switched off}
@itemdef{wxNO_EXCEPTIONS,
@itemdef{wxNO_EXCEPTIONS,
is defined if the compiler support for C++ exceptions has been switched off}
@itemdef{wxNO_THREADS,
@itemdef{wxNO_THREADS,
if this macro is defined, the compilation options
don't include compiler flags needed for multithreaded code generation. This
implies that wxUSE_THREADS is $0$ and also that other (non-wx-based) threading
packages cannot be used neither.}
@itemdef{WXMAKINGDLL_XXX,
@itemdef{WXMAKINGDLL_XXX,
used internally and defined when building the
library @c XXX as a DLL; when a monolithic wxWidgets build is used only a
single @c WXMAKINGDLL symbol is defined}
@itemdef{WXUSINGDLL,
@itemdef{WXUSINGDLL,
defined when compiling code which uses wxWidgets as a DLL/shared library}
@itemdef{WXBUILDING,
@itemdef{WXBUILDING,
defined when building wxWidgets itself, whether as a static or shared library}
@endDefList

14
docs/doxygen/mainpages/const_keycode.h
View file

@ -10,12 +10,12 @@
/**
@page page_keycodes Keycodes
@header{wx/defs.h}
Keypresses are represented by an enumerated type, wxKeyCode. The possible
values are the ASCII character codes, plus the following:
@verbatim
WXK_BACK = 8
WXK_TAB = 9
@ -23,7 +23,7 @@
WXK_ESCAPE = 27
WXK_SPACE = 32
WXK_DELETE = 127
// These are by design not compatible with unicode characters.
// If you want to get a unicode character from a key event use
// wxKeyEvent::GetUnicodeKey instead.
@ -95,7 +95,7 @@
WXK_SCROLL
WXK_PAGEUP,
WXK_PAGEDOWN,
WXK_NUMPAD_SPACE,
WXK_NUMPAD_TAB,
WXK_NUMPAD_ENTER,
@ -121,13 +121,13 @@
WXK_NUMPAD_SUBTRACT,
WXK_NUMPAD_DECIMAL,
WXK_NUMPAD_DIVIDE,
// the following key codes are only generated under Windows currently
WXK_WINDOWS_LEFT,
WXK_WINDOWS_RIGHT,
WXK_WINDOWS_MENU,
WXK_COMMAND,
// Hardware-specific buttons
WXK_SPECIAL1 = 193,
WXK_SPECIAL2,

14
docs/doxygen/mainpages/const_keymod.h
View file

@ -10,11 +10,11 @@
/**
@page page_keymodifiers Key Modifiers
@header{wx/defs.h}
The following key modifier constants are defined:
@verbatim
enum wxKeyModifier
{
@ -32,11 +32,11 @@
wxMOD_ALL = 0xffff
};
@endverbatim
Notice that @c wxMOD_CMD should be used instead of @c wxMOD_CONTROL
in portable code to account for the fact that although
Notice that @c wxMOD_CMD should be used instead of @c wxMOD_CONTROL
in portable code to account for the fact that although
@c Control modifier exists under Mac OS, it is not used for the same
purpose as under Windows or Unix there while the special Mac-specific
purpose as under Windows or Unix there while the special Mac-specific
@c Command modifier is used in exactly the same way.
*/

8
docs/doxygen/mainpages/const_langcodes.h
View file

@ -10,15 +10,15 @@
/**
@page page_languagecodes Language identifiers
The following wxLanguage constants may be used to specify the language
in wxLocale::Init and are returned by wxLocale::GetSystemLanguage:
<!-- generated code begins here -->
This enum is generated by misc/languages/genlang.py
When making changes, please put them into misc/languages/langtabl.txt
<!-- generated code ends here -->
*/

30
docs/doxygen/mainpages/const_stdevtid.h
View file

@ -13,26 +13,26 @@
wxWidgets defines a special identifier value @c wxID_ANY which is used in
the following two situations:
@li when creating a new window you may specify @c wxID_ANY to let
wxWidgets assign an unused identifier to it automatically
@li when installing an event handler using either the event table
macros or wxEvtHandler::Connect,
you may use it to indicate that you want to handle the events
coming from any control, regardless of its identifier
Another standard special identifier value is @c wxID_NONE: this is a value
which is not matched by any other id.
wxWidgets also defines a few standard command identifiers which may be used by
the user code and also are sometimes used by wxWidgets itself. These reserved
identifiers are all in the range between @c wxID_LOWEST and
identifiers are all in the range between @c wxID_LOWEST and
@c wxID_HIGHEST and, accordingly, the user code should avoid defining its
own constants in this range.
@verbatim
wxID_LOWEST = 4999,
wxID_OPEN,
wxID_CLOSE,
wxID_NEW,
@ -55,7 +55,7 @@
wxID_HELP_PROCEDURES,
wxID_HELP_CONTEXT,
wxID_CLOSE_ALL,
wxID_EDIT = 5030,
wxID_CUT,
wxID_COPY,
@ -68,7 +68,7 @@
wxID_REPLACE,
wxID_REPLACE_ALL,
wxID_PROPERTIES,
wxID_VIEW_DETAILS,
wxID_VIEW_LARGEICONS,
wxID_VIEW_SMALLICONS,
@ -77,7 +77,7 @@
wxID_VIEW_SORTNAME,
wxID_VIEW_SORTSIZE,
wxID_VIEW_SORTTYPE,
wxID_FILE = 5050,
wxID_FILE1,
wxID_FILE2,
@ -88,7 +88,7 @@
wxID_FILE7,
wxID_FILE8,
wxID_FILE9,
// Standard button IDs
wxID_OK = 5100,
wxID_CANCEL,
@ -108,14 +108,14 @@
wxID_ABORT,
wxID_RETRY,
wxID_IGNORE,
wxID_UP,
wxID_DOWN,
wxID_HOME,
wxID_REFRESH,
wxID_STOP,
wxID_INDEX,
wxID_BOLD,
wxID_ITALIC,
wxID_JUSTIFY_CENTER,
@ -131,7 +131,7 @@
wxID_ZOOM_OUT,
wxID_UNDELETE,
wxID_REVERT_TO_SAVED,
// System menu IDs (used by wxUniv):
wxID_SYSTEM_MENU = 5200,
wxID_CLOSE_FRAME,
@ -140,10 +140,10 @@
wxID_MAXIMIZE_FRAME,
wxID_ICONIZE_FRAME,
wxID_RESTORE_FRAME,
// IDs used by generic file dialog (13 consecutive starting from this value)
wxID_FILEDLGG = 5900,
wxID_HIGHEST = 5999
@endverbatim

32
docs/doxygen/mainpages/const_wxusedef.h
View file

@ -35,7 +35,7 @@
@section page_wxusedef_multi Generic wxUSE preprocessor symbols
@beginDefList
@itemdef{wxUSE_ABOUTDLG, Use wxAboutDialogInfo class.}
@itemdef{wxUSE_ACCEL, Use wxAcceleratorTable/Entry classes and support for them in wxMenu, wxMenuBar.}
@ -238,7 +238,7 @@
@itemdef{wxUSE_XRC, Use XRC XML-based resource system.}
@itemdef{wxUSE_ZIPSTREAM, Enable streams for Zip files.}
@itemdef{wxUSE_ZLIB, Use wxZlibInput and wxZlibOutputStream classes, required by wxUSE_LIBPNG.}
@endDefList
@endDefList
@section page_wxusedef_unix wxUSE preprocessor symbols used only under Unix platforms
@ -259,10 +259,10 @@
@itemdef{wxUSE_NANOX, Use NanoX.}
@itemdef{wxUSE_UNIV_TEXTCTRL, Use wxUniv's implementation of wxTextCtrl class.}
@endDefList
@section page_wxusedef_gtk wxUSE preprocessor symbols used only in wxGTK port
@beginDefList
@itemdef{wxUSE_DETECT_SM, Use code to detect X11 session manager.}
@itemdef{wxUSE_GTKPRINT, Use GTK+ printing support.}
@ -271,9 +271,9 @@
@itemdef{wxUSE_LIBHILDON, Use Hildon framework for Nokia 770. Currently has no effect. }
@endDefList
@section page_wxusedef_mac wxUSE preprocessor symbols used only in wxMac port
@beginDefList
@itemdef{wxUSE_MAC_CRITICAL_REGION_MUTEX, See src/mac/carbon/thread.cpp file.}
@itemdef{wxUSE_MAC_PTHREADS_MUTEX, See src/mac/carbon/thread.cpp file.}
@ -281,24 +281,24 @@
@itemdef{wxUSE_WEBKIT, Use wxWebKitCtrl class.}
@endDefList
@section page_wxusedef_motif wxUSE preprocessor symbols used only in wxMotif port
@beginDefList
@itemdef{wxUSE_GADGETS, Use xmCascadeButtonGadgetClass, xmLabelGadgetClass, xmPushButtonGadgetClass and xmToggleButtonGadgetClass classes.}
@itemdef{wxUSE_INVISIBLE_RESIZE, See src/motif/dialog.cpp file.}
@endDefList
@section page_wxusedef_cocoa wxUSE preprocessor symbols used only in Cocoa port
@beginDefList
@itemdef{wxUSE_OBJC_UNIQUIFYING, Enable Objective-C class name uniquifying.}
@endDefList
@section page_wxusedef_os2 wxUSE preprocessor symbols used only in OS2 port
@beginDefList
@itemdef{wxUSE_CONSOLEDEBUG, See src/os2/app.cpp file.}
@itemdef{wxUSE_DDE, See src/os2/mimetype.cpp file.}
@ -308,9 +308,9 @@
@itemdef{wxUSE_RESOURCE_LOADING_IN_OS2, See src/os2/gdiimage.cpp file.}
@endDefList
@section page_wxusedef_msw wxUSE preprocessor symbols used only in wxMSW port
@beginDefList
@itemdef{wxUSE_ACCESSIBILITY, Enable accessibility support}
@itemdef{wxUSE_ACTIVEX, Use wxActiveXContainer and related classes.}
@ -345,9 +345,9 @@
@itemdef{wxUSE_XPM_IN_MSW, See also wxUSE_XPM}
@endDefList
@section page_wxusedef_univ wxUSE preprocessor symbols used only in wxUniversal
@beginDefList
@itemdef{wxUSE_ALL_THEMES, Use all themes in wxUniversal; See wx/univ/theme.h file.}
@itemdef{wxUSE_THEME_GTK, Use GTK+ 1-like theme in wxUniversal}

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

@ -35,7 +35,7 @@
Julian Smart, Robert Roebling, Vadim Zeitlin, Vaclav Slavik and many others.
This manual contains a class reference and topic overviews.
For a selection of wxWidgets tutorials, please see the documentation page
For a selection of wxWidgets tutorials, please see the documentation page
on the wxWidgets web site: http://www.wxwidgets.org.
Please note that in the following, ``MS Windows" often refers to all

6
docs/doxygen/mainpages/libs.h
View file

@ -82,7 +82,7 @@ Requires @ref page_libs_wxbase.
This contains the Advanced User Interface docking library.
Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
@ref page_libs_wxcore, @ref page_libs_wxbase.
@ -103,7 +103,7 @@ Requires @ref page_libs_wxbase.
This contains generic rich text control functionality.
Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
@ref page_libs_wxcore, @ref page_libs_wxbase.
@ -173,7 +173,7 @@ Requires @ref page_libs_wxxml, @ref page_libs_wxcore, @ref page_libs_wxbase.
This library contains wxXmlResource class that provides access to XML resource
files in XRC format.
Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
Requires @ref page_libs_wxadv, @ref page_libs_wxhtml, @ref page_libs_wxxml,
@ref page_libs_wxcore, @ref page_libs_wxbase.

316
docs/doxygen/mainpages/platdetails.h
View file

@ -31,48 +31,48 @@
@section page_port_wxgtk wxGTK
@section page_port_wxgtk wxGTK
@htmlonly
<img src="gtk_logo.png" alt="GTK logo" title="GTK logo" class="logo">
@endhtmlonly
wxGTK is a port of wxWidgets using the GTK+ library.
It makes use of GTK+'s native widgets wherever possible and uses
wxWidgets' generic controls when needed. GTK+ itself has been
ported to a number of systems, but so far only the original X11
version is supported. Support for other GTK+ backends is planned,
such as the new DirectFB backend.
All work is being done on GTK+ version 2.0 and above. Support for
GTK+ 1.2 will be deprecated in a later release.
You will need GTK+ 2.0 or higher which is available from:
http://www.gtk.org
The newer version of GTK+ you use, the more native widgets and
features will be utilized. We have gone to a great extent to
allow compiling wxWidgets applications with a latest version of
GTK+, with the resulting binary working on systems even with a
much lower version of GTK+. You will have to ensure that the
application is launched with lazy symbol binding for that.
In order to configure wxWidgets to compile wxGTK you will
In order to configure wxWidgets to compile wxGTK you will
need use the @c --with-gtk argument to the @c configure script.
This is the default for many systems.
GTK+ 1.2 can still be used, albeit discouraged. For that you can
pass @c --with-gtk=1 to the @c configure script.
For further information, please see the files in docs/gtk
in the distribution.
@section page_port_wxmac wxMac
@section page_port_wxmac wxMac
@htmlonly
<img src="osxleopard_logo.png" alt="Mac OS X (Leopard) logo"
title="Mac OS X (Leopard) logo" class="logo">
@ -88,15 +88,15 @@
API (and optionally the Classic API under MacOS 8.X). You
will need wxWidgets version 2.3.3 or higher for a stable
version of wxMac.
For further information, please see the files in docs/mac
in the distribution.
@section page_port_wxmgl wxMGL
@section page_port_wxmgl wxMGL
wxMGL is a port of wxWidgets using the MGL library available
from SciTech as the underlying graphics backend. wxMGL draws
its widgets using the wxUniversal widget set which is now
@ -104,35 +104,35 @@
including DOS, Linux hardware (similar to the Linux framebuffer)
and various graphics systems such as Win32, X11 and OS/2.
Note that currently MGL for Linux runs only on x86-based systems.
You will need wxWidgets 2.3.3 or higher and MGL 5.0 or higher.
The latter is available from
http://www.scitechsoft.com/products/product_download.html
In order to configure wxWidgets to compile wxMGL you will
need to type:
@verbatim configure --with-mgl --with-universal @endverbatim
Under DOS, wxMGL uses a dmake based make system.
For further information, please see the files in docs/mgl
in the distribution.
@section page_port_wxos2 wxOS2
@section page_port_wxos2 wxOS2
wxOS2 is a port of wxWidgets for the IBM OS/2 Warp3 and Warp4 platforms.
This port is currently under construction and in beta phase.
For more info about OS2 see:
@section page_port_wxx11 wxX11
@section page_port_wxx11 wxX11
@htmlonly
<img src="x11_logo.png" alt="X.org logo" title="X.org logo" class="logo">
@ -145,21 +145,21 @@
as those running on systems with few resources (PDAs) or for
applications which need to use a special themed look. You will need
wxWidgets 2.3.2 or higher.
In order to configure wxWidgets to compile wxX11 you will
In order to configure wxWidgets to compile wxX11 you will
need to type:
@verbatim configure --with-x11 --with-universal @endverbatim
For further information, please see the files in docs/x11
in the distribution. There is also a page on the use of
wxWidgets for embedded applications on the wxWidgets web site.
@section page_port_wxmsw wxMSW
@section page_port_wxmsw wxMSW
@htmlonly
<img src="win_logo.png" alt="Windows logo" title="Windows logo" class="logo">
@ -174,35 +174,35 @@
including MS VC++, Borland 5.5, MinGW32, Cygwin and
Watcom as well as cross-compilation with a Linux hosted
MinGW32 tool chain.
For further information, please see the files in docs/msw
in the distribution.
@subsection page_port_wxmsw_themedborders Themed borders on Windows
Starting with wxWidgets 2.8.5, you can specify the wxBORDER_THEME style to have wxWidgets
use a themed border. Using the default XP theme, this is a thin 1-pixel blue border,
with an extra 1-pixel border in the window client background colour (usually white) to
separate the client area's scrollbars from the border.
If you don't specify a border style for a wxTextCtrl in rich edit mode, wxWidgets now gives
the control themed borders automatically, where previously they would take the Windows 95-style
sunken border. Other native controls such as wxTextCtrl in non-rich edit mode, and wxComboBox,
already paint themed borders where appropriate. To use themed borders on other windows, such
as wxPanel, pass the wxBORDER_THEME style, or (apart from wxPanel) pass no border style.
In general, specifying wxBORDER_THEME will cause a border of some kind to be used, chosen by the platform
and control class. To leave the border decision entirely to wxWidgets, pass wxBORDER_DEFAULT.
This is not to be confused with specifying wxBORDER_NONE, which says that there should
definitely be @e no border.
@subsubsection page_port_wxmsw_themedborders_details More detail on border implementation
The way that wxMSW decides whether to apply a themed border is as follows.
The theming code calls wxWindow::GetBorder() to obtain a border. If no border style has been
passed to the window constructor, GetBorder() calls GetDefaultBorder() for this window.
If wxBORDER_THEME was passed to the window constructor, GetBorder() calls GetDefaultBorderForControl().
The implementation of wxWindow::GetDefaultBorder() on wxMSW calls wxWindow::CanApplyThemeBorder()
which is a virtual function that tells wxWidgets whether a control can have a theme
applied explicitly (some native controls already paint a theme in which case we should not
@ -210,47 +210,47 @@
we wish to create a window with no border (for example, notebook pages). So wxPanel
overrides GetDefaultBorder() in order to call the generic wxWindowBase::GetDefaultBorder(),
returning wxBORDER_NONE.
@subsection page_port_wxmsw_wince wxWinCE
wxWinCE is the name given to wxMSW when compiled on Windows CE devices;
most of wxMSW is common to Win32 and Windows CE but there are
some simplifications, enhancements, and differences in
behaviour.
For building instructions, see docs/msw/wince in the
distribution, also the section about Visual Studio 2005 project
files below. The rest of this section documents issues you
need to be aware of when programming for Windows CE devices.
@subsubsection page_port_wxmsw_wince_ General issues for wxWinCE programming
Mobile applications generally have fewer features and
simpler user interfaces. Simply omit whole sizers, static
lines and controls in your dialogs, and use comboboxes instead
of listboxes where appropriate. You also need to reduce
the amount of spacing used by sizers, for which you can
use a macro such as this:
@verbatim
#if defined(__WXWINCE__)
#define wxLARGESMALL(large,small) small
#else
#define wxLARGESMALL(large,small) large
#endif
// Usage
topsizer->Add( CreateTextSizer( message ), 0, wxALL, wxLARGESMALL(10,0) );
@endverbatim
There is only ever one instance of a Windows CE application running,
and wxWidgets will take care of showing the current instance and
shutting down the second instance if necessary.
You can test the return value of wxSystemSettings::GetScreenType()
for a qualitative assessment of what kind of display is available,
or use wxGetDisplaySize() if you need more information.
You can also use wxGetOsVersion to test for a version of Windows CE at
run-time (see the next section). However, because different builds
are currently required to target different kinds of device, these
@ -259,19 +259,19 @@
platforms. This would require a different approach to the way
wxWidgets adapts its behaviour (such as for menubars) to suit the
style of device.
See the "Life!" example (demos/life) for an example of
an application that has been tailored for PocketPC and Smartphone use.
@note don't forget to have this line in your .rc file, as for
desktop Windows applications:
@verbatim #include "wx/msw/wx.rc" @endverbatim
@subsubsection page_port_wxmsw_wince_sdk Testing for WinCE SDKs
Use these preprocessor symbols to test for the different types of device or SDK:
@li @b __SMARTPHONE__ Generic mobile devices with phone buttons and a small display
@li @b __PDA__ Generic mobile devices with no phone
@li @b __HANDHELDPC__ Generic mobile device with a keyboard
@ -280,58 +280,58 @@
@li @b __POCKETPC__ Microsoft-powered PocketPC devices with touch-screen
@li @b __WINCE_STANDARDSDK__ Microsoft-powered Windows CE devices, for generic Windows CE applications
@li @b __WINCE_NET__ Microsoft-powered Windows CE .NET devices (_WIN32_WCE is 400 or greater)
wxGetOsVersion will return these values:
@li @b wxWINDOWS_POCKETPC The application is running under PocketPC.
@li @b wxWINDOWS_SMARTPHONE The application is running under Smartphone.
@li @b wxWINDOWS_CE The application is running under Windows CE (built with the Standard SDK).
@subsubsection page_port_wxmsw_wince_sizing Window sizing in wxWinCE
Top level windows (dialogs, frames) are created always full-screen. Fit() of sizers will not rescale top
level windows but instead will scale window content.
If the screen orientation changes, the windows will automatically be resized
so no further action needs to be taken (unless you want to change the layout
according to the orientation, which you could detect in idle time, for example).
When input panel (SIP) is shown, top level windows (frames and dialogs) resize
accordingly (see wxTopLevelWindow::HandleSettingChange).
@subsubsection page_port_wxmsw_wince_toplevel Closing top-level windows in wxWinCE
You won't get a wxCloseEvent when the user clicks on the X in the titlebar
on Smartphone and PocketPC; the window is simply hidden instead. However the system may send the
event to force the application to close down.
@subsubsection page_port_wxmsw_wince_hibernation Hibernation in wxWinCE
Smartphone and PocketPC will send a wxEVT_HIBERNATE to the application object in low
memory conditions. Your application should release memory and close dialogs,
and wake up again when the next wxEVT_ACTIVATE or wxEVT_ACTIVATE_APP message is received.
(wxEVT_ACTIVATE_APP is generated whenever a wxEVT_ACTIVATE event is received
in Smartphone and PocketPC, since these platforms do not support WM_ACTIVATEAPP.)
@subsubsection page_port_wxmsw_wince_hwbutt Hardware buttons in wxWinCE
Special hardware buttons are sent to a window via the wxEVT_HOTKEY event
under Smartphone and PocketPC. You should first register each required button with
under Smartphone and PocketPC. You should first register each required button with
wxWindow::RegisterHotKey, and unregister the button when you're done with it. For example:
@verbatim
win->RegisterHotKey(0, wxMOD_WIN, WXK_SPECIAL1);
win->UnregisterHotKey(0);
@endverbatim
You may have to register the buttons in a wxEVT_ACTIVATE event handler
since other applications will grab the buttons.
There is currently no method of finding out the names of the special
buttons or how many there are.
@subsubsection page_port_wxmsw_wince_dialogs Dialogs in wxWinCE
PocketPC dialogs have an OK button on the caption, and so you should generally
not repeat an OK button on the dialog. You can add a Cancel button if necessary, but some dialogs
simply don't offer you the choice (the guidelines recommend you offer an Undo facility
@ -339,11 +339,11 @@
a wxID_OK event by default. If you wish to change this, call wxDialog::SetAffirmativeId
with the required identifier to be used. Or, override wxDialog::DoOK (return @false to
have wxWidgets simply call Close to dismiss the dialog).
Smartphone dialogs do @e not have an OK button on the caption, and are closed
using one of the two menu buttons. You need to assign these using wxTopLevelWindow::SetLeftMenu
and wxTopLevelWindow::SetRightMenu, for example:
@verbatim
#ifdef __SMARTPHONE__
SetLeftMenu(wxID_OK);
@ -354,30 +354,30 @@
topsizer->Add( CreateButtonSizer( wxOK|wxCANCEL ), 0, wxEXPAND | wxALL, 10 );
#endif
@endverbatim
For implementing property sheets (flat tabs), use a wxNotebook with wxNB_FLAT|wxNB_BOTTOM
and have the notebook left, top and right sides overlap the dialog by about 3 pixels
to eliminate spurious borders. You can do this by using a negative spacing in your
sizer Add() call. The cross-platform property sheet dialog wxPropertySheetDialog is
provided, to show settings in the correct style on PocketPC and on other platforms.
Notifications (bubble HTML text with optional buttons and links) will also be
implemented in the future for PocketPC.
Modeless dialogs probably don't make sense for PocketPC and Smartphone, since
frames and dialogs are normally full-screen, and a modeless dialog is normally
intended to co-exist with the main application frame.
@subsubsection page_port_wxmsw_wince_ppc Menubars and toolbars in PocketPC
On PocketPC, a frame must always have a menubar, even if it's empty.
An empty menubar/toolbar is automatically provided for dialogs, to hide
any existing menubar for the duration of the dialog.
Menubars and toolbars are implemented using a combined control,
but you can use essentially the usual wxWidgets API; wxWidgets will combine the menubar
and toolbar. However, there are some restrictions:
@li You must create the frame's primary toolbar with wxFrame::CreateToolBar,
because this uses the special wxToolMenuBar class (derived from wxToolBar)
to implement the combined toolbar and menubar. Otherwise, you can create and manage toolbars
@ -391,20 +391,20 @@
or with transparency (for example, using XPMs).
@li Adding controls to wxToolMenuBar is not supported. However, wxToolBar supports
controls.
Unlike in all other ports, a wxDialog has a wxToolBar, automatically created
for you. You may either leave it blank, or access it with wxDialog::GetToolBar
and add buttons, then calling wxToolBar::Realize. You cannot set or recreate
the toolbar.
@subsubsection page_port_wxmsw_wince_smart Menubars and toolbars in Smartphone
On Smartphone, there are only two menu buttons, so a menubar is simulated
using a nested menu on the right menu button. Any toolbars are simply ignored on
Smartphone.
@subsubsection page_port_wxmsw_wince_closing Closing windows in wxWinCE
The guidelines state that applications should not have a Quit menu item,
since the user should not have to know whether an application is in memory
or not. The close button on a window does not call the window's
@ -412,141 +412,141 @@
the Ctrl+Q accelerator can be used to quit the application, so wxWidgets
defines this accelerator by default and if your application handles
wxID_EXIT, it will do the right thing.
@subsubsection page_port_wxmsw_wince_ctx Context menus in wxWinCE
To enable context menus in PocketPC, you currently need to call wxWindow::EnableContextMenu,
a wxWinCE-only function. Otherwise the context menu event (wxContextMenuEvent) will
never be sent. This API is subject to change.
Context menus are not supported in Smartphone.
@subsubsection page_port_wxmsw_wince_ctrl Control differences on wxWinCE
These controls and styles are specific to wxWinCE:
@li wxTextCtrl The wxTE_CAPITALIZE style causes a CAPEDIT control to
be created, which capitalizes the first letter.
These controls are missing from wxWinCE:
@li MDI classes MDI is not supported under Windows CE.
@li wxMiniFrame Not supported under Windows CE.
Tooltips are not currently supported for controls, since on PocketPC controls with
tooltips are distinct controls, and it will be hard to add dynamic
tooltip support.
Control borders on PocketPC and Smartphone should normally be specified with
wxBORDER_SIMPLE instead of wxBORDER_SUNKEN. Controls will usually adapt
appropriately by virtue of their GetDefaultBorder() function, but if you
wish to specify a style explicitly you can use wxDEFAULT_CONTROL_BORDER
which will give a simple border on PocketPC and Smartphone, and the sunken border on
other platforms.
@subsubsection page_port_wxmsw_wince_help Online help in wxWinCE
You can use the help controller wxWinceHelpController which controls
simple @c .htm files, usually installed in the Windows directory.
See the Windows CE reference for how to format the HTML files.
@subsubsection page_port_wxmsw_wince_install Installing your PocketPC and Smartphone applications
To install your application, you need to build a CAB file using
the parameters defined in a special .inf file. The CabWiz program
in your SDK will compile the CAB file from the .inf file and
files that it specifies.
For delivery, you can simply ask the user to copy the CAB file to the
device and execute the CAB file using File Explorer. Or, you can
write a program for the desktop PC that will find the ActiveSync
Application Manager and install the CAB file on the device,
which is obviously much easier for the user.
Here are some links that may help.
@li A setup builder that takes CABs and builds a setup program is at
http://www.eskimo.com/~scottlu/win/index.html.
@li Sample installation files can be found in
@li Sample installation files can be found in
<tt>Windows CE Tools/wce420/POCKET PC 2003/Samples/Win32/AppInst</tt>.
@li An installer generator using wxPython can be found at
@li An installer generator using wxPython can be found at
http://ppcquicksoft.iespana.es/ppcquicksoft/myinstall.html.
@li Miscellaneous Windows CE resources can be found at
@li Miscellaneous Windows CE resources can be found at
http://www.orbworks.com/pcce/resources.html.
@li Installer creation instructions with a setup.exe for installing to PPC can be found at
@li Installer creation instructions with a setup.exe for installing to PPC can be found at
http://www.pocketpcdn.com/articles/creatingsetup.html.
@li Microsoft instructions are at
@li Microsoft instructions are at
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dnce30/html/appinstall30.asp?frame=true
@li Troubleshooting WinCE application installations:
@li Troubleshooting WinCE application installations:
http://support.microsoft.com/default.aspx?scid=KB;en-us;q181007
You may also check out <tt>demos/life/setup/wince</tt> which contains
scripts to create a PocketPC installation for ARM-based
devices. In particular, @c build.bat builds the distribution and
copies it to a directory called @c Deliver.
@subsubsection page_port_wxmsw_wince_filedlg wxFileDialog in PocketPC
Allowing the user to access files on memory cards, or on arbitrary
parts of the filesystem, is a pain; the standard file dialog only
shows folders under My Documents or folders on memory cards
(not the system or card root directory, for example). This is
a known problem for PocketPC developers.
If you need a file dialog that allows access to all folders,
you can use wxGenericFileDialog instead. You will need to include
you can use wxGenericFileDialog instead. You will need to include
@c wx/generic/filedlgg.h.
@subsubsection page_port_wxmsw_wince_evc Embedded Visual C++ Issues
<b>Run-time type information</b>
If you wish to use runtime type information (RTTI) with eVC++ 4, you need to download
an extra library, @c ccrtrtti.lib, and link with it. At the time of
writing you can get it from here:
@verbatim
http://support.microsoft.com/kb/830482/en-us
@endverbatim
Otherwise you will get linker errors similar to this:
@verbatim
wxwince26d.lib(control.obj) : error LNK2001: unresolved external symbol "const type_info::`vftable'" (??_7type_info@@6B@)
@endverbatim
<b>Windows Mobile 5.0 emulator</b>
Note that there is no separate emulator configuration for Windows Mobile 5.0: the
emulator runs the ARM code directly.
<b>Visual Studio 2005 project files</b>
Unfortunately, Visual Studio 2005, required to build Windows Mobile 5.0 applications,
doesn't do a perfect job of converting the project files from eVC++ format.
When you have converted the wxWidgets workspace, edit the configuration properties
for each configuration and in the Librarian, add a relative path ..\\..\\lib to
each library path. For example:
each library path. For example:
<tt>..\\$(PlatformName)\\$(ConfigurationName)\\wx_mono.lib</tt>.
Then, for a sample you want to compile, edit the configuration properties
and make sure
<tt>..\\..\\lib\\$(PlatformName)\\$(ConfigurationName)</tt>
is in the Linker/General/Additional Library Directories property.
Also change the Linker/Input/Additional Dependencies property to something like
<tt>coredll.lib wx_mono.lib wx_wxjpeg.lib wx_wxpng.lib wx_wxzlib.lib wx_wxexpat.lib
and make sure
<tt>..\\..\\lib\\$(PlatformName)\\$(ConfigurationName)</tt>
is in the Linker/General/Additional Library Directories property.
Also change the Linker/Input/Additional Dependencies property to something like
<tt>coredll.lib wx_mono.lib wx_wxjpeg.lib wx_wxpng.lib wx_wxzlib.lib wx_wxexpat.lib
commctrl.lib winsock.lib wininet.lib</tt>
(since the library names in the wxWidgets workspace were changed by VS 2005).
Alternately, you could could edit all the names to be identical to the original eVC++
names, but this will probably be more fiddly.
@subsubsection page_port_wxmsw_wince_issues Remaining issues
These are some of the remaining problems to be sorted out, and features
to be supported.
@li <b>Windows Mobile 5 issues.</b> It is not possible to get the HMENU for
the command bar on Mobile 5, so the menubar functions need to be rewritten
to get the individual menus without use of a menubar handle. Also the
@ -567,15 +567,15 @@
missing styles are implemented with WM_PAINT.
@li <b>HTML control.</b> PocketPC has its own HTML control which can be used for showing
local pages or navigating the web. We should create a version of wxHtmlWindow that uses this
control, or have a separately-named control (wxHtmlCtrl), with a syntax as close as possible
control, or have a separately-named control (wxHtmlCtrl), with a syntax as close as possible
to wxHtmlWindow.
@li <b>Tooltip control.</b> PocketPC uses special TTBUTTON and TTSTATIC controls for adding
tooltips, with the tooltip separated from the label with a double tilde. We need to support
this using SetToolTip.(Unfortunately it does not seem possible to dynamically remove the tooltip,
tooltips, with the tooltip separated from the label with a double tilde. We need to support
this using SetToolTip.(Unfortunately it does not seem possible to dynamically remove the tooltip,
so an extra style may be required.)
@li <b>Focus.</b> In the wxPropertySheetDialog demo on Smartphone, it's not possible to navigate
between controls. The focus handling in wxWidgets needs investigation. See in particular
src/common/containr.cpp, and note that the default OnActivate handler in src/msw/toplevel.cpp
between controls. The focus handling in wxWidgets needs investigation. See in particular
src/common/containr.cpp, and note that the default OnActivate handler in src/msw/toplevel.cpp
sets the focus to the first child of the dialog.
@li <b>OK button.</b> We should allow the OK button on a dialog to be optional, perhaps
by using wxCLOSE_BOX to indicate when the OK button should be displayed.

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

@ -117,7 +117,7 @@
specific information about the problem will be logged.
You should also use @ref page_macro_cat_debugging as part of a `defensive programming' strategy,
scattering wxASSERTs liberally to test for problems in your code as early as possible.
scattering wxASSERTs liberally to test for problems in your code as early as possible.
Forward thinking will save a surprising amount of time in the long run.
See the @ref overview_debugging for further information.

316
docs/doxygen/mainpages/utilities.h
View file

@ -36,10 +36,10 @@
@subsection page_utils_utils_tex2rtf Tex2RTF
Supplied with wxWidgets is a utility called Tex2RTF for
Supplied with wxWidgets is a utility called Tex2RTF for
converting @e LaTeX manuals HTML, MS HTML Help, wxHTML Help, RTF, and Windows
Help RTF formats. Tex2RTF was used for the wxWidgets manuals and can be used
independently by authors wishing to create on-line and printed manuals from the
Help RTF formats. Tex2RTF was used for the wxWidgets manuals and can be used
independently by authors wishing to create on-line and printed manuals from the
same @e LaTeX source. Please see the separate documentation for Tex2RTF.
You can find it under @c utils/tex2rtf.
@ -60,7 +60,7 @@
@section page_utils_samples Samples
Probably the best way to learn wxWidgets is by reading the source of some 50+
samples provided with it. Many aspects of wxWidgets programming can be learnt
from them, but sometimes it is not simple to just choose the right sample to
@ -68,82 +68,82 @@
make it easier to find the relevant one if a simple grep through all sources
didn't help. They also provide some notes about using the samples and what
features of wxWidgets are they supposed to test.
There are currently more than 50 different samples as part of wxWidgets and
this list is not complete. You should start your tour of wxWidgets with the
minimal sample which is the wxWidgets version of
"Hello, world!". It shows the basic structure of wxWidgets program and is the
most commented sample of all - looking at its source code is recommended.
The next most useful samples are probably widgets
and controls which show many of wxWidgets native and
generic controls, such as buttons, listboxes, checkboxes, comboboxes etc.
Other, more complicated controls, have their own samples. In this category you
may find the following samples showing the corresponding controls:
@li wxCalendarCtrl: @ref page_utils_samples_calendar
@li wxListCtrl: @ref page_utils_samples_listctrl
@li wxTreeCtrl: @ref page_utils_samples_treectrl
@li wxGrid: @ref page_utils_samples_grid
Finally, it might be helpful to do a search in the entire sample directory if
you can't find the sample showing the control you are interested in by
name. Most classes contained in wxWidgets occur in at least one of the samples.
@subsection page_utils_samples_minimal Minimal sample
The minimal sample is what most people will know under the term Hello World,
i.e. a minimal program that doesn't demonstrate anything apart from what is
needed to write a program that will display a "hello" dialog. This is usually
a good starting point for learning how to use wxWidgets.
@subsection page_utils_samples_animate Animate sample
The @c animate sample shows how you can use wxAnimationCtrl
control and shows concept of a platform-dependent animation encapsulated
in wxAnimation.
@subsection page_utils_samples_artprovider Art provider sample
The @c artprov sample shows how you can customize the look of standard
wxWidgets dialogs by replacing default bitmaps/icons with your own versions.
It also shows how you can use wxArtProvider to
get stock bitmaps for use in your application.
@subsection page_utils_samples_calendar Calendar sample
This font shows the calendar control in action. It
shows how to configure the control (see the different options in the calendar
menu) and also how to process the notifications from it.
@subsection page_utils_samples_config Config sample
This sample demonstrates the wxConfig classes in a platform
independent way, i.e. it uses text based files to store a given configuration under
Unix and uses the Registry under Windows.
See @ref overview_config for the descriptions of all features of this class.
@subsection page_utils_samples_controls Controls sample
The controls sample is the main test program for most simple controls used in
wxWidgets. The sample tests their basic functionality, events, placement,
modification in terms of colour and font as well as the possibility to change
the controls programmatically, such as adding an item to a list box etc. Apart
from that, the sample uses a wxNotebook and tests most
features of this special control (using bitmap in the tabs, using
wxSizer instances and wxLayoutConstraints within notebook pages, advancing pages
wxSizer instances and wxLayoutConstraints within notebook pages, advancing pages
programmatically and vetoing a page change by intercepting the wxNotebookEvent.
The various controls tested are listed here:
@li wxButton
@li wxBitmapButton
@li wxCheckBox
@ -159,10 +159,10 @@
@li wxRadioBox
@li wxRadioButton
@li wxSlider
@subsection page_utils_samples_debugrpt DebugRpt sample
This sample shows how to use wxDebugReport class to
generate a debug report in case of a program crash or otherwise. On start up,
it proposes to either crash itself (by dereferencing a NULL pointer) or
@ -170,54 +170,54 @@
with standard information adding a custom file to it (just a timestamp) and
allows to view the information gathered using
wxDebugReportPreview.
For the report processing part of the sample to work you should make available
a Web server accepting form uploads, otherwise
wxDebugReportUpload will report an error.
@subsection page_utils_samples_dialogs Dialogs sample
This sample shows how to use the common dialogs available from wxWidgets. These
dialogs are described in detail in the @ref overview_cmndlg.
@subsection page_utils_samples_dialup Dialup sample
This sample shows the wxDialUpManager
class. In the status bar, it displays the information gathered through its
interface: in particular, the current connection status (online or offline) and
whether the connection is permanent (in which case a string `LAN' appears in
the third status bar field - but note that you may be on a LAN not
connected to the Internet, in which case you will not see this) or not.
Using the menu entries, you may also dial or hang up the line if you have a
modem attached and (this only makes sense for Windows) list the available
connections.
@subsection page_utils_samples_dnd DnD sample
This sample shows both clipboard and drag and drop in action. It is quite non
trivial and may be safely used as a basis for implementing the clipboard and
drag and drop operations in a real-life program.
When you run the sample, its screen is split in several parts. On the top,
there are two listboxes which show the standard derivations of
wxDropTarget:
wxTextDropTarget and
wxFileDropTarget.
The middle of the sample window is taken by the log window which shows what is
going on (of course, this only works in debug builds) and may be helpful to see
the sequence of steps of data transfer.
Finally, the last part is used for dragging text from it to either one of the
listboxes (only one will accept it) or another application. The last
functionality available from the main frame is to paste a bitmap from the
clipboard (or, in the case of the Windows version, also a metafile) - it will be
shown in a new frame.
So far, everything we mentioned was implemented with minimal amount of code
using standard wxWidgets classes. The more advanced features are demonstrated
if you create a shape frame from the main frame menu. A shape is a geometric
@ -230,93 +230,93 @@
bitmaps which allows them to be pasted/dropped in many other applications
(and, under Windows, also as metafiles which are supported by most of Windows
programs as well - try Write/Wordpad, for example).
Take a look at DnDShapeDataObject class to see how you may use
wxDataObject to achieve this.
@subsection page_utils_samples_event Event sample
The event sample demonstrates various features of the wxWidgets events. It
shows using dynamic events and connecting/disconnecting the event handlers
during run time and also using
PushEventHandler() and
PopEventHandler().
@subsection page_utils_samples_except Except(ions) sample
This very simple sample shows how to use C++ exceptions in wxWidgets programs,
i.e. where to catch the exception which may be thrown by the program code. It
doesn't do anything very exciting by itself, you need to study its code to
understand what goes on.
You need to build the library with @c wxUSE_EXCEPTIONS being set to @c 1
and compile your code with C++ exceptions support to be able to build this
sample.
@subsection page_utils_samples_exec Exec sample
The exec sample demonstrates the wxExecute and
wxShell functions. Both of them are used to execute the
external programs and the sample shows how to do this synchronously (waiting
until the program terminates) or asynchronously (notification will come later).
It also shows how to capture the output of the child process in both
synchronous and asynchronous cases and how to kill the processes with
wxProcess::Kill and test for their existence with
wxProcess::Exists.
@subsection page_utils_samples_font Font sample
The font sample demonstrates wxFont,
wxFontEnumerator and
wxFontMapper classes. It allows you to see the fonts
available (to wxWidgets) on the computer and shows all characters of the
chosen font as well.
@subsection page_utils_samples_grid Grid sample
TODO.
@subsection page_utils_samples_html HTML samples
Eight HTML samples (you can find them in directory @c samples/html)
cover all features of the HTML sub-library.
@li @b Test demonstrates how to create wxHtmlWindow
and also shows most supported HTML tags.
@li @b Widget shows how you can embed ordinary controls or windows within an
HTML page. It also nicely explains how to write new tag handlers and extend
the library to work with unsupported tags.
@li @b About may give you an idea how to write good-looking About boxes.
@li @b Zip demonstrates use of virtual file systems in wxHTML. The zip archives
handler (ships with wxWidgets) allows you to access HTML pages stored
in a compressed archive as if they were ordinary files.
@li @b Virtual is yet another virtual file systems demo. This one generates pages at run-time.
You may find it useful if you need to display some reports in your application.
@li @b Printing explains use of wxHtmlEasyPrinting
class which serves as as-simple-as-possible interface for printing HTML
documents without much work. In fact, only few function calls are sufficient.
@li @b Help and @b Helpview are variations on displaying HTML help
(compatible with MS HTML Help Workshop). @e Help shows how to embed
wxHtmlHelpController in your application
while @e Helpview is a simple tool that only pops up the help window and
displays help books given at command line.
@subsection page_utils_samples_image Image sample
The image sample demonstrates use of the wxImage class
and shows how to download images in a variety of formats, currently PNG, GIF,
TIFF, JPEG, BMP, PNM and PCX. The top of the sample shows two rectangles, one
@ -324,7 +324,7 @@
wxBitmap, converted to a wxImage, saved as a PNG image
and then reloaded from the PNG file again so that conversions between wxImage
and wxBitmap as well as loading and saving PNG files are tested.
At the bottom of the main frame there is a test for using a monochrome bitmap by
drawing into a wxMemoryDC. The bitmap is then drawn
specifying the foreground and background colours with
@ -332,25 +332,25 @@
wxDC::SetTextBackground (on the left). The
bitmap is then converted to a wxImage and the foreground colour (black) is
replaced with red using wxImage::Replace.
This sample also contains the code for testing the image rotation and resizing
and using raw bitmap access, see the corresponding menu commands.
@subsection page_utils_samples_internat Internat(ionalization) sample
The not very clearly named internat sample demonstrates the wxWidgets
internationalization (i18n for short from now on) features. To be more
precise, it only shows localization support, i.e. support for translating the
program messages into another language while true i18n would also involve
changing the other aspects of the programs behaviour.
More information about this sample can be found in the @c readme.txt file in
its directory. Please also see the @ref overview_i18n.
@subsection page_utils_samples_layout Layout sample
The layout sample demonstrates the two different layout systems offered
by wxWidgets. When starting the program, you will see a frame with some
controls and some graphics. The controls will change their size whenever
@ -359,70 +359,70 @@
class. See also the overview and the
wxIndividualLayoutConstraint
class for further information.
The menu in this sample offers two more tests, one showing how to use
a wxBoxSizer in a simple dialog and the other one
showing how to use sizers in connection with a wxNotebook
class. See also wxSizer.
@subsection page_utils_samples_listctrl Listctrl sample
This sample shows the wxListCtrl control. Different modes
supported by the control (list, icons, small icons, report) may be chosen from
the menu.
The sample also provides some timings for adding/deleting/sorting a lot of
(several thousands) items into the control.
@subsection page_utils_samples_mediaplayer Mediaplayer sample
This sample demonstrates how to use all the features of
wxMediaCtrl and play various types of sound, video,
and other files.
It replaces the old dynamic sample.
@subsection page_utils_samples_notebook Notebook sample
This samples shows wxBookCtrl family of controls.
Although initially it was written to demonstrate wxNotebook
only, it can now be also used to see wxListbook,
wxChoicebook and wxTreebook in action.
Test each of the controls, their orientation, images and pages using
Test each of the controls, their orientation, images and pages using
commands through menu.
@subsection page_utils_samples_render Render sample
This sample shows how to replace the default wxWidgets
renderer and also how to write a shared library
(DLL) implementing a renderer and load and unload it during the run-time.
@subsection page_utils_samples_scrollsub Scroll subwindow sample
This sample demonstrates use of the wxScrolledWindow
class including placing subwindows into it and drawing simple graphics. It uses the
SetTargetWindow method and thus the effect
of scrolling does not show in the scrolled window itself, but in one of its subwindows.
Additionally, this samples demonstrates how to optimize drawing operations in wxWidgets,
in particular using the wxWindow::IsExposed method with
the aim to prevent unnecessary drawing in the window and thus reducing or removing
flicker on screen.
@subsection page_utils_samples_sockets Sockets sample
The sockets sample demonstrates how to use the communication facilities
provided by wxSocket. There are two different
applications in this sample: a server, which is implemented using a
wxSocketServer object, and a client, which
is implemented as a wxSocketClient.
The server binds to the local address, using TCP port number 3000,
sets up an event handler to be notified of incoming connection requests
(@b wxSOCKET_CONNECTION events), and sits there, waiting for clients
@ -435,13 +435,13 @@
handler is the same for all connections; to find out which socket the
event is addressed to, the GetSocket function
is used.
Although it might take some time to get used to the event-oriented
system upon which wxSocket is built, the benefits are many. See, for
example, that the server application, while being single-threaded
(and of course without using fork() or ugly select() loops) can handle
an arbitrary number of connections.
The client starts up unconnected, so you can use the Connect... option
to specify the address of the server you are going to connect to (the
TCP port number is hard-coded as 3000). Once connected, a number of
@ -454,70 +454,70 @@
both clients and connection objects in the server set up an event handler
to catch @b wxSOCKET_LOST events, each one is immediately notified
if the other end closes the connection.
There is also a URL test which shows how to use
the wxURL class to fetch data from a given URL.
The sockets sample is work in progress. Some things to do:
@li More tests for basic socket functionality.
@li More tests for protocol classes (wxProtocol and its descendants).
@li Tests for the recently added (and still in alpha stage) datagram sockets.
@li New samples which actually do something useful (suggestions accepted).
@subsection page_utils_samples_sound Sound sample
The @c sound sample shows how to use wxSound for simple
audio output (e.g. notifications).
@subsection page_utils_samples_statbar Statbar sample
This sample shows how to create and use wxStatusBar. Although most of the
samples have a statusbar, they usually only create a default one and only
do it once.
Here you can see how to recreate the statusbar (with possibly different number
of fields) and how to use it to show icons/bitmaps and/or put arbitrary
controls into it.
@subsection page_utils_samples_taborder Tab order sample
This sample allows to test keyboard navigation (mostly done using the
This sample allows to test keyboard navigation (mostly done using the
@c TAB key, hence the sample name) between different controls.
It shows the use of wxWindow::MoveBeforeInTabOrder() and
It shows the use of wxWindow::MoveBeforeInTabOrder() and
MoveAfterInTabOrder() methods to change
the default order of the windows in the navigation chain and of
the default order of the windows in the navigation chain and of
wxWindow::Navigate() for moving focus along this
chain.
@subsection page_utils_samples_text Text sample
This sample demonstrates four features: firstly the use and many variants of
the wxTextCtrl class (single line, multi line, read only,
password, ignoring TAB, ignoring ENTER).
Secondly it shows how to intercept a wxKeyEvent in both
the raw form using the @c EVT_KEY_UP and @c EVT_KEY_DOWN macros and the
higher level from using the @c EVT_CHAR macro. All characters will be logged
in a log window at the bottom of the main window. By pressing some of the function
keys, you can test some actions in the text ctrl as well as get statistics on the
text ctrls, which is useful for testing if these statistics actually are correct.
Thirdly, on platforms which support it, the sample will offer to copy text to the
wxClipboard and to paste text from it. The GTK version will
use the so called PRIMARY SELECTION, which is the pseudo clipboard under X and
best known from pasting text to the XTerm program.
Last not least: some of the text controls have tooltips and the sample also shows
how tooltips can be centrally disabled and their latency controlled.
@subsection page_utils_samples_thread Thread sample
This sample demonstrates use of threads in connection with GUI programs.
There are two fundamentally different ways to use threads in GUI programs and
either way has to take care of the fact that the GUI library itself usually
@ -527,22 +527,22 @@
background. In order to make communication between the main thread and the
worker threads possible, wxWidgets offers the wxPostEvent
function and this sample makes use of this function.
The other way to use a so called Mutex (such as those offered in the wxMutex
class) that prevent threads from accessing the GUI classes as long as any other
thread accesses them. For this, wxWidgets has the wxMutexGuiEnter
and wxMutexGuiLeave functions, both of which are
used and tested in the sample as well.
See also @ref overview_thread and wxThread.
@subsection page_utils_samples_toolbar Toolbar sample
The toolbar sample shows the wxToolBar class in action.
The following things are demonstrated:
@li Creating the toolbar using wxToolBar::AddTool and wxToolBar::AddControl: see
MyApp::InitToolbar in the sample.
@li Using @c EVT_UPDATE_UI handler for automatically enabling/disabling
@ -550,46 +550,46 @@
in MyFrame::OnUpdateCopyAndCut.
@li Using wxToolBar::DeleteTool and wxToolBar::InsertTool to dynamically update the
toolbar.
Some buttons in the main toolbar are check buttons, i.e. they stay checked when
pressed. On the platforms which support it, the sample also adds a combobox
to the toolbar showing how you can use arbitrary controls and not only buttons
in it.
If you toggle another toolbar in the sample (using @c Ctrl-A) you will also
see the radio toolbar buttons in action: the first three buttons form a radio
group, i.e. checking any of them automatically unchecks the previously
checked one.
@subsection page_utils_samples_treectrl Treectrl sample
This sample demonstrates using the wxTreeCtrl class. Here
you may see how to process various notification messages sent by this control
and also when they occur (by looking at the messages in the text control in
the bottom part of the frame).
Adding, inserting and deleting items and branches from the tree as well as
sorting (in default alphabetical order as well as in custom one) is
demonstrated here as well - try the corresponding menu entries.
@subsection page_utils_samples_widgets Widgets sample
The widgets sample is the main presentation program for most simple and advanced
native controls and complex generic widgets provided by wxWidgets.
The sample tests their basic functionality, events, placement, modification
in terms of colour and font as well as the possibility to change
the controls programmatically, such as adding an item to a list box etc.
All widgets are categorized for easy browsing.
@subsection page_utils_samples_wizard Wizard sample
This sample shows the so-called wizard dialog (implemented using
wxWizard and related classes). It shows almost all
features supported:
@li Using bitmaps with the wizard and changing them depending on the page
shown (notice that wxValidationPage in the sample has a different image from
the other ones)

6
docs/doxygen/overviews/dataobject.h
View file

@ -46,7 +46,7 @@
@section overview_dataobject_source The data provider (source) duties
The data provider is responsible for creating a wxDataObject containing the
The data provider is responsible for creating a wxDataObject containing the
data to be transferred. Then it should either pass it to the clipboard using
wxClipboard::SetData function or to wxDropSource and call wxDropSource::DoDragDrop
function.
@ -69,12 +69,12 @@
@section overview_dataobject_target The data receiver (target) duties
To receive (paste in usual terminology) data from the clipboard, you should
create a wxDataObject derived class which supports the data formats you need
create a wxDataObject derived class which supports the data formats you need
and pass it as argument to wxClipboard::GetData. If it returns @false,
no data in (any of) the supported format(s) is available. If it returns @true,
the data has been successfully transferred to wxDataObject.
For drag and drop case, the wxDropTarget::OnData virtual function will be called
For drag and drop case, the wxDropTarget::OnData virtual function will be called
when a data object is dropped, from which the data itself may be requested by calling
wxDropTarget::GetData method which fills the data object.

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

@ -49,12 +49,12 @@
@section overview_datetime_classes All date/time classes at a glance
There are 3 main classes declared in @c wx/datetime.h: except wxDateTime itself
There are 3 main classes declared in @c wx/datetime.h: except wxDateTime itself
which represents an absolute moment in time, there are also two classes -
wxTimeSpan and wxDateSpan - which represent the intervals of time.
There are also helper classes which are used together with wxDateTime:
wxDateTimeHolidayAuthority which is used to determine whether a given date
wxDateTimeHolidayAuthority which is used to determine whether a given date
is a holiday or not and wxDateTimeWorkDays which is a derivation of this
class for which (only) Saturdays and Sundays are the holidays. See more about
these classes in the discussion of the holidays (see @ref overview_datetime_holidays).

6
docs/doxygen/overviews/dc.h
View file

@ -11,16 +11,16 @@
@page overview_dc Device Contexts
Classes: wxBufferedDC, wxBufferedPaintDC, wxDC, wxPostScriptDC,
wxMetafileDC, wxMemoryDC, wxPrinterDC, wxScreenDC, wxClientDC,
wxMetafileDC, wxMemoryDC, wxPrinterDC, wxScreenDC, wxClientDC,
wxPaintDC, wxWindowDC.
A wxDC is a @e device context onto which graphics and text can be drawn.
The device context is intended to represent a number of output devices in a
The device context is intended to represent a number of output devices in a
generic way, with the same API being used throughout.
Some device contexts are created temporarily in order to draw on a window.
This is @true of wxScreenDC, wxClientDC, wxPaintDC, and wxWindowDC.
The following describes the differences between these device contexts and
The following describes the differences between these device contexts and
when you should use them.
@li @b wxScreenDC. Use this to paint on the screen, as opposed to an individual window.

14
docs/doxygen/overviews/debugging.h
View file

@ -22,7 +22,7 @@
@li @ref overview_debugging_dbgctx
@li @ref overview_debugging_dbgmacros
@li @ref overview_debugging_logging
@li @ref overview_debugging_dbgctx2
@li @ref overview_debugging_dbgctx2
<hr>
@ -31,7 +31,7 @@
@section overview_debugging_dbgctx wxDebugContext
wxDebugContext is a class that never gets instantiated, but ties together
various static functions and variables. It allows you to dump all objects to that stream,
various static functions and variables. It allows you to dump all objects to that stream,
write statistics about object allocation, and check memory for errors.
It is good practice to define a wxObject::Dump member function for each class you derive
@ -47,9 +47,9 @@
and compiler -- some systems don't allow all memory logging to be enabled). See the
memcheck sample for example of usage.
For wxDebugContext to do its work, the @e new and @e delete operators for wxObject
have been redefined to store extra information about dynamically allocated objects
(but not statically declared objects).
For wxDebugContext to do its work, the @e new and @e delete operators for wxObject
have been redefined to store extra information about dynamically allocated objects
(but not statically declared objects).
This slows down a debugging version of an application, but can
find difficult-to-detect memory leaks (objects are not
@ -64,7 +64,7 @@
@endcode
All occurrences of 'new' in wxWidgets and your own application will use
the overridden form of the operator with two extra arguments. This means that
the overridden form of the operator with two extra arguments. This means that
the debugging output (and error messages reporting memory problems) will tell you what
file and on what line you allocated the object. Unfortunately not all
compilers allow this definition to work properly, but most do.
@ -98,7 +98,7 @@
@section overview_debugging_logging Logging functions
You can use the wxLogDebug and wxLogTrace functions to output debugging information in
You can use the wxLogDebug and wxLogTrace functions to output debugging information in
debug mode; it will do nothing for non-debugging code.

46
docs/doxygen/overviews/dialog.h
View file

@ -37,29 +37,29 @@
@section overview_dialog_autoscrolling Automatic scrolling dialogs
As an ever greater variety of mobile hardware comes to market, it becomes more
imperative for wxWidgets applications to adapt to these platforms without putting
As an ever greater variety of mobile hardware comes to market, it becomes more
imperative for wxWidgets applications to adapt to these platforms without putting
too much burden on the programmer. One area where wxWidgets can help is in adapting
dialogs for the lower resolution screens that inevitably accompany a smaller form factor.
wxDialog therefore supplies a global wxDialogLayoutAdapter class that implements
wxDialog therefore supplies a global wxDialogLayoutAdapter class that implements
automatic scrolling adaptation for most sizer-based custom dialogs.
Many applications should therefore be able to adapt to small displays with little
Many applications should therefore be able to adapt to small displays with little
or no work, as far as dialogs are concerned.
By default this adaptation is off. To switch scrolling adaptation on globally in
By default this adaptation is off. To switch scrolling adaptation on globally in
your application, call the static function wxDialog::EnableLayoutAdaptation passing @true.
You can also adjust adaptation on a per-dialog basis by calling
wxDialog::SetLayoutAdaptationMode with one of @c wxDIALOG_ADAPTATION_MODE_DEFAULT
wxDialog::SetLayoutAdaptationMode with one of @c wxDIALOG_ADAPTATION_MODE_DEFAULT
(use the global setting), @c wxDIALOG_ADAPTATION_MODE_ENABLED or @c wxDIALOG_ADAPTATION_MODE_DISABLED.
The last two modes override the global adaptation setting.
With adaptation enabled, if the display size is too small for the dialog, wxWidgets (or rather the
standard adapter class wxStandardDialogLayoutAdapter) will make part of the dialog scrolling,
leaving standard buttons in a non-scrolling part at the bottom of the dialog.
This is done as follows, in wxDialogLayoutAdapter::DoLayoutAdaptation called from
This is done as follows, in wxDialogLayoutAdapter::DoLayoutAdaptation called from
within wxDialog::Show or wxDialog::ShowModal:
@li If wxDialog::GetContentWindow returns a window derived from wxBookCtrlBase,
@li If wxDialog::GetContentWindow returns a window derived from wxBookCtrlBase,
the pages are made scrollable and no other adaptation is done.
@li wxWidgets looks for a wxStdDialogButtonSizer and uses it for the non-scrolling part.
@li If that search failed, wxWidgets looks for a horizontal wxBoxSizer with one or more
@ -67,17 +67,17 @@
@li If that search failed too, wxWidgets finds 'loose' standard buttons (in any kind of sizer)
and adds them to a wxStdDialogButtonSizer.
If no standard buttons were found, the whole dialog content will scroll.
@li All the children apart from standard buttons are reparented onto a new wxScrolledWindow
object, using the old top-level sizer for the scrolled window and creating a new top-level
@li All the children apart from standard buttons are reparented onto a new wxScrolledWindow
object, using the old top-level sizer for the scrolled window and creating a new top-level
sizer to lay out the scrolled window and standard button sizer.
@subsection overview_dialog_autoscrolling_custom Customising scrolling adaptation
In addition to switching adaptation on and off globally and per dialog,
In addition to switching adaptation on and off globally and per dialog,
you can choose how aggressively wxWidgets will search for standard buttons by setting
wxDialog::SetLayoutAdaptationLevel. By default, all the steps described above will be
performed but by setting the level to 1, for example, you can choose to only look for
wxDialog::SetLayoutAdaptationLevel. By default, all the steps described above will be
performed but by setting the level to 1, for example, you can choose to only look for
wxStdDialogButtonSizer.
You can use wxDialog::AddMainButtonId to add identifiers for buttons that should also be
@ -88,7 +88,7 @@
the functions CanDoLayoutAdaptation and DoLayoutAdaptation to test for adaptation applicability
and perform the adaptation.
You can also override wxDialog::CanDoLayoutAdaptation and wxDialog::DoLayoutAdaptation
You can also override wxDialog::CanDoLayoutAdaptation and wxDialog::DoLayoutAdaptation
in a class derived from wxDialog.
@ -100,13 +100,13 @@
@li The dialog doesn't use sizers.
@li The dialog implementation makes assumptions about the window hierarchy,
for example getting the parent of a control and casting to the dialog class.
@li The dialog does custom painting and/or event handling not handled by the scrolled window.
@li The dialog does custom painting and/or event handling not handled by the scrolled window.
If this problem can be solved globally, you can derive a new adapter class from
wxStandardDialogLayoutAdapter and override its CreateScrolledWindow function to return
wxStandardDialogLayoutAdapter and override its CreateScrolledWindow function to return
an instance of your own class.
@li The dialog has unusual layout, for example a vertical sizer containing a mixture of
@li The dialog has unusual layout, for example a vertical sizer containing a mixture of
standard buttons and other controls.
@li The dialog makes assumptions about the sizer hierarchy, for example to show or hide
@li The dialog makes assumptions about the sizer hierarchy, for example to show or hide
children of the top-level sizer. However, the original sizer hierarchy will still hold
until Show or ShowModal is called.
@ -115,19 +115,19 @@
@li avoiding the above situations and assumptions;
@li using wxStdDialogButtonSizer;
@li only making assumptions about hierarchy immediately after the dialog is created;
@li using an intermediate sizer under the main sizer, a @false top-level sizer that
@li using an intermediate sizer under the main sizer, a @false top-level sizer that
can be relied on to exist for the purposes of manipulating child sizers and windows;
@li overriding wxDialog::GetContentWindow to return a book control if your dialog implements
@li overriding wxDialog::GetContentWindow to return a book control if your dialog implements
pages: wxWidgets will then only make the pages scrollable.
@subsection overview_dialog_propertysheet wxPropertySheetDialog and wxWizard
Adaptation for wxPropertySheetDialog is always done by simply making the pages
scrollable, since wxDialog::GetContentWindow returns the dialog's book control and
Adaptation for wxPropertySheetDialog is always done by simply making the pages
scrollable, since wxDialog::GetContentWindow returns the dialog's book control and
this is handled by the standard layout adapter.
wxWizard uses its own CanDoLayoutAdaptation and DoLayoutAdaptation functions rather
wxWizard uses its own CanDoLayoutAdaptation and DoLayoutAdaptation functions rather
than the global adapter: again, only the wizard pages are made scrollable.
*/

14
docs/doxygen/overviews/dnd.h
View file

@ -29,22 +29,22 @@
@li @b Preparation: First of all, a data object must be created and
initialized with the data you wish to drag. For example:
@code
wxTextDataObject my_data("This text will be dragged.");
@endcode
@li <b>Drag start</b>: To start the dragging process (typically in response to a
mouse click) you must call wxDropSource::DoDragDrop like this:
@code
wxDropSource dragSource( this );
dragSource.SetData( my_data );
wxDragResult result = dragSource.DoDragDrop( true );
@endcode
@li @b Dragging: The call to DoDragDrop() blocks the program until the user releases
the mouse button (unless you override the wxDropSource::GiveFeedback function to
@li @b Dragging: The call to DoDragDrop() blocks the program until the user releases
the mouse button (unless you override the wxDropSource::GiveFeedback function to
do something special). When the mouse moves in a window of a program which understands
the same drag-and-drop protocol (any program under Windows or any program supporting
the XDnD protocol under X Windows), the corresponding wxDropTarget methods
@ -56,7 +56,7 @@
@code
switch (result)
{
case wxDragCopy:
case wxDragCopy:
// copy the data
break;
case wxDragMove:
@ -73,7 +73,7 @@
follow the instructions below:
@li @b Initialization: For a window to be a drop target, it needs to have
an associated wxDropTarget object. Normally, you will call wxWindow::SetDropTarget
an associated wxDropTarget object. Normally, you will call wxWindow::SetDropTarget
during window creation associating your drop target with it. You must derive a class
from wxDropTarget and override its pure virtual methods. Alternatively, you may
derive from wxTextDropTarget or wxFileDropTarget and override their OnDropText()
@ -83,7 +83,7 @@
asks the associated wxDropTarget object if it accepts the data. For this,
a wxDataObject must be associated with the drop target and this data object will
be responsible for the format negotiation between the drag source and the drop target.
If all goes well, then wxDropTarget::OnData will get called and the wxDataObject belonging
If all goes well, then wxDropTarget::OnData will get called and the wxDataObject belonging
to the drop target can get filled with data.
@li <b>The end</b>: After processing the data, DoDragDrop() returns either

28
docs/doxygen/overviews/docview.h
View file

@ -10,7 +10,7 @@
@page overview_docview Document/View Framework
Classes: wxDocument, wxView, wxDocTemplate, wxDocManager, wxDocParentFrame,
Classes: wxDocument, wxView, wxDocTemplate, wxDocManager, wxDocParentFrame,
wxDocChildFrame, wxDocMDIParentFrame, wxDocMDIChildFrame,
wxCommand, wxCommandProcessor
@ -25,7 +25,7 @@
If a document's data changes, all views should be updated to reflect the change.
The framework can provide many user-interface elements based on this model.
Once you have defined your own classes and the relationships between them, the framework
Once you have defined your own classes and the relationships between them, the framework
takes care of popping up file selectors, opening and closing files, asking the user to save
modifications, routing menu commands to appropriate (possibly default) code, even
some default print/preview functionality and support for command undo/redo.
@ -33,13 +33,13 @@
The framework is highly modular, allowing overriding and replacement of functionality
and objects to achieve more than the default behaviour.
These are the overall steps involved in creating an application based on the
These are the overall steps involved in creating an application based on the
document/view framework:
@li Define your own document and view classes, overriding a minimal set of
member functions e.g. for input/output, drawing and initialization.
@li Define any subwindows (such as a scrolled window) that are needed for the view(s).
You may need to route some events to views or documents, for example OnPaint needs
You may need to route some events to views or documents, for example OnPaint needs
to be routed to wxView::OnDraw.
@li Decide what style of interface you will use: Microsoft's MDI (multiple
document child frames surrounded by an overall frame), SDI (a separate, unconstrained frame
@ -136,7 +136,7 @@
Class: wxView
The wxView class can be used to model the viewing and editing component of
an application's file-based data. It is part of the document/view framework
an application's file-based data. It is part of the document/view framework
supported by wxWidgets, and cooperates with the wxDocument, wxDocTemplate
and wxDocManager classes.
@ -179,7 +179,7 @@
document templates, but each would be passed a different view class. When
the user clicks on the Open menu item, the file selector is displayed
with a list of possible file filters -- one for each wxDocTemplate. Selecting
the filter selects the wxDocTemplate, and when a file is selected, that template
the filter selects the wxDocTemplate, and when a file is selected, that template
will be used for creating a document and view.
For the case where an application has one document type and one view type,
@ -192,7 +192,7 @@
See the example application in @c samples/docview.
To use the wxDocTemplate class, you do not need to derive a new class.
Just pass relevant information to the constructor including CLASSINFO(YourDocumentClass)
Just pass relevant information to the constructor including CLASSINFO(YourDocumentClass)
and CLASSINFO(YourViewClass) to allow dynamic instance creation.
If you do not wish to use the wxWidgets method of creating document
@ -210,10 +210,10 @@
The wxDocManager class is part of the document/view framework supported by wxWidgets,
and cooperates with the wxView, wxDocument and wxDocTemplate classes.
A wxDocManager instance coordinates documents, views and document templates.
It keeps a list of document and template instances, and much functionality is routed
through this object, such as providing selection and file dialogs.
The application can use this class 'as is' or derive a class and override some members
A wxDocManager instance coordinates documents, views and document templates.
It keeps a list of document and template instances, and much functionality is routed
through this object, such as providing selection and file dialogs.
The application can use this class 'as is' or derive a class and override some members
to extend or change the functionality.
Create an instance of this class near the beginning of your application initialization,
@ -271,13 +271,13 @@
to derive from it to allow different behaviour, such as popping up a scrolling
list of files.
By calling wxFileHistory::UseMenu() you can associate a file menu with the file history.
By calling wxFileHistory::UseMenu() you can associate a file menu with the file history.
The menu will then be used for appending filenames that are added to the history.
Please notice that currently if the history already contained filenames when UseMenu()
Please notice that currently if the history already contained filenames when UseMenu()
is called (e.g. when initializing a second MDI child frame), the menu is not automatically
initialized with the existing filenames in the history and so you need to call
wxFileHistory::AddFilesToMenu() after UseMenu() explicitly in order to initialize the menu with
wxFileHistory::AddFilesToMenu() after UseMenu() explicitly in order to initialize the menu with
the existing list of MRU files (otherwise an assertion failure is raised in debug builds).
The filenames are appended using menu identifiers in the range @c wxID_FILE1 to @c wxID_FILE9.

16
docs/doxygen/overviews/eventhandling.h
View file

@ -63,9 +63,9 @@
member function in a derived class will not have any effect. These member
functions take an event argument, and the class of event differs according to
the type of event and the class of the originating window. For size events,
wxSizeEvent is used. For menu commands and most control commands
wxSizeEvent is used. For menu commands and most control commands
(such as button presses), wxCommandEvent is used. When controls get more
complicated, then specific event classes are used, such as wxTreeEvent for
complicated, then specific event classes are used, such as wxTreeEvent for
events from wxTreeCtrl windows.
As well as the event table in the implementation file, there must also be a
@ -152,9 +152,9 @@
@li If the object is a wxWindow, @b ProcessEvent is recursively called on the window's
wxValidator. If this returns @true, the function exits.
@li @b SearchEventTable is called for this event handler. If this fails, the base
class table is tried, and so on until no more tables exist or an appropriate
class table is tried, and so on until no more tables exist or an appropriate
function was found, in which case the function exits.
@li The search is applied down the entire chain of event handlers (usually the chain has
@li The search is applied down the entire chain of event handlers (usually the chain has
a length of one). If this succeeds, the function exits.
@li If the object is a wxWindow and the event is set to set to propagate (in the library only
wxCommandEvent based events are set to propagate), @b ProcessEvent is recursively applied
@ -232,13 +232,13 @@
While generically wxEvents can be generated both by user
actions (e.g. resize of a wxWindow) and by calls to functions
(e.g. wxWindow::SetSize), wxWidgets controls normally send wxCommandEvent-derived
(e.g. wxWindow::SetSize), wxWidgets controls normally send wxCommandEvent-derived
events only for the user-generated events. The only @b exceptions to this rule are:
@li wxNotebook::AddPage: No event-free alternatives
@li wxNotebook::AdvanceSelection: No event-free alternatives
@li wxNotebook::DeletePage: No event-free alternatives
@li wxNotebook::SetSelection: Use wxNotebook::ChangeSelection instead, as
@li wxNotebook::SetSelection: Use wxNotebook::ChangeSelection instead, as
wxNotebook::SetSelection is deprecated
@li wxTreeCtrl::Delete: No event-free alternatives
@li wxTreeCtrl::DeleteAllItems: No event-free alternatives
@ -255,7 +255,7 @@
In fact, you don't have to derive a new class from a window class
if you don't want to. You can derive a new class from wxEvtHandler instead,
defining the appropriate event table, and then call wxWindow::SetEventHandler
defining the appropriate event table, and then call wxWindow::SetEventHandler
(or, preferably, wxWindow::PushEventHandler) to make this
event handler the object that responds to events. This way, you can avoid
a lot of class derivation, and use instances of the same event handler class (but different
@ -461,7 +461,7 @@
@row2col{EVT_CUSTOM_RANGE(event\, id1\, id2\, func),
The same as EVT_CUSTOM, but responds to a range of window identifiers.}
@row2col{EVT_COMMAND(id\, event\, func),
The same as EVT_CUSTOM, but expects a member function with a
The same as EVT_CUSTOM, but expects a member function with a
wxCommandEvent argument.}
@row2col{EVT_COMMAND_RANGE(id1\, id2\, event\, func),
The same as EVT_CUSTOM_RANGE, but

2
docs/doxygen/overviews/filesystem.h
View file

@ -36,7 +36,7 @@
Its main methods are ChangePathTo() and OpenFile(). This class
is most often used by the end user.
@li The wxFileSystemHandler is the core
of virtual file systems mechanism. You can derive your own handler and pass
of virtual file systems mechanism. You can derive your own handler and pass
it to the VFS mechanism. You can derive your own handler and pass it to
wxFileSystem's AddHandler() method. In the new handler you only need to
override the OpenFile() and CanOpen() methods.

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

@ -26,14 +26,14 @@
@beginDefList
@itemdef{Point size, This is the standard way of referring to text size.}
@itemdef{Family,
@itemdef{Family,
Supported families are:
@b wxDEFAULT, @b wxDECORATIVE, @b wxROMAN, @b wxSCRIPT, @b wxSWISS, @b wxMODERN.
@b wxMODERN is a fixed pitch font; the others are either fixed or variable pitch.}
@itemdef{Style, The value can be @b wxNORMAL, @b wxSLANT or @b wxITALIC.}
@itemdef{Weight, The value can be @b wxNORMAL, @b wxLIGHT or @b wxBOLD.}
@itemdef{Underlining, The value can be @true or @false.}
@itemdef{Face name,
@itemdef{Face name,
An optional string specifying the actual typeface to be used. If @NULL,
a default typeface will chosen based on the family.}
@itemdef{Encoding,

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

@ -21,8 +21,8 @@
(see @ref overview_unicode).
Font encoding support is ensured by several classes:
wxFont itself, but also wxFontEnumerator and wxFontMapper. wxFont encoding
support is reflected by a (new) constructor parameter @e encoding which takes
wxFont itself, but also wxFontEnumerator and wxFontMapper. wxFont encoding
support is reflected by a (new) constructor parameter @e encoding which takes
one of the following values (elements of enumeration type @c wxFontEncoding):
@beginDefList

2
docs/doxygen/overviews/helloworld.h
View file

@ -54,7 +54,7 @@
giving it a menu and a status bar in its constructor. Also, any class
that wishes to respond to any "event" (such as mouse clicks or
messages from the menu or a button) must declare an event table
using the macro below.
using the macro below.
Finally, the way to react to such events must be done in "handlers".
In our sample, we react to two menu items, one for "Quit" and one for

50
docs/doxygen/overviews/html.h
View file

@ -16,7 +16,7 @@
wxHTML can be used as a generic rich text viewer - for example to display
a nice About Box (like those of GNOME apps) or to display the result of
database searching. There is a wxFileSystem class which allows you to use
database searching. There is a wxFileSystem class which allows you to use
your own virtual file systems.
wxHtmlWindow supports tag handlers. This means that you can easily
@ -60,7 +60,7 @@
@endcode
@subsection overview_html_quickstart_disphelp Displaying Help
See wxHtmlHelpController.
@subsection overview_html_quickstart_settingup Setting up wxHtmlWindow
@ -113,30 +113,30 @@
wxHtmlPrintout, normal wxWidgets printout class.
And finally there is the low level class wxHtmlDCRenderer which you can use to
render HTML into a rectangular area on any DC.
render HTML into a rectangular area on any DC.
It supports rendering into multiple rectangles with the same
width. (The most common use of this is placing one rectangle on each page or
width. (The most common use of this is placing one rectangle on each page or
printing into two columns.)
@section overview_html_helpformats Help Files Format
wxHTML library uses a reduced version of MS HTML Workshop format.
Tex2RTF can produce these files when generating HTML, if you set
Tex2RTF can produce these files when generating HTML, if you set
@b htmlWorkshopFiles to @true in your tex2rtf.ini file.
(See wxHtmlHelpController for help controller description.)
A @b book consists of three files: the header file, the contents file
A @b book consists of three files: the header file, the contents file
and the index file.
You can make a regular zip archive of these files, plus the HTML and any
image files, for wxHTML (or helpview) to read; and the @c .zip file can
You can make a regular zip archive of these files, plus the HTML and any
image files, for wxHTML (or helpview) to read; and the @c .zip file can
optionally be renamed to @c .htb.
@subsection overview_html_helpformats_hhp Header file (.hhp)
The header file must contain these lines (and may contain additional lines
The header file must contain these lines (and may contain additional lines
which are ignored):
@code
@ -212,8 +212,8 @@
@endcode
@subsection overview_html_helpformats_hhk Index file (.hhk)
Index files have same format as contents file except that ID params are ignored
Index files have same format as contents file except that ID params are ignored
and sublists are @b not allowed.
@ -222,7 +222,7 @@
The wxHTML library provides a mechanism for reading and displaying
files of many different file formats.
wxHtmlWindow::LoadPage can load not only HTML files but any known file.
wxHtmlWindow::LoadPage can load not only HTML files but any known file.
To make a file type known to wxHtmlWindow you must create a wxHtmlFilter filter and
register it using wxHtmlWindow::AddFilter.
@ -251,15 +251,15 @@
@subsection overview_html_cells_conttaghandler Using Containers in Tag Handler
wxHtmlWinParser provides a user-friendly way of managing containers.
wxHtmlWinParser provides a user-friendly way of managing containers.
It is based on the idea of opening and closing containers.
Use wxHtmlWinParser::OpenContainer to open new a container @e within an already
Use wxHtmlWinParser::OpenContainer to open new a container @e within an already
opened container.
This new container is a @e sub-container of the old one. (If you want to create a
This new container is a @e sub-container of the old one. (If you want to create a
new container with the same depth level you can call @c CloseContainer(); OpenContainer();.)
Use wxHtmlWinParser::CloseContainer to close the container.
Use wxHtmlWinParser::CloseContainer to close the container.
This doesn't create a new container with same depth level but it returns "control"
to the parent container. See explanation:
@ -323,7 +323,7 @@
@li Parse text between the tag and paired ending tag (if present)
@li Restore original parser state
See wxHtmlWinParser for methods for modifying parser's state.
See wxHtmlWinParser for methods for modifying parser's state.
In general you can do things like opening/closing containers, changing colors, fonts etc.
@subsection overview_html_handlers_custom Providing own tag handlers
@ -346,7 +346,7 @@
for details). Handler definition must start with @b TAG_HANDLER_BEGIN macro
and end with @b TAG_HANDLER_END macro.
I strongly recommend to have a look at @e include/wxhtml/mod_templ.h file.
I strongly recommend to have a look at @e include/wxhtml/mod_templ.h file.
Otherwise you won't understand the structure of macros.
See macros reference:
@ -360,7 +360,7 @@
@li @b TAG_HANDLER_VARS:
This macro starts block of variables definitions. (Variables are identical
to class attributes.) Example:
@code
TAG_HANDLER_BEGIN(VARS_ONLY, "CRAZYTAG")
TAG_HANDLER_VARS
@ -368,14 +368,14 @@
wxString something_else;
TAG_HANDLER_END(VARS_ONLY)
@endcode
This macro is used only in rare cases.
@li @b TAG_HANDLER_CONSTR(@e name):
This macro supplies object constructor. @e name is same name as the one
from TAG_HANDLER_BEGIN macro. Body of constructor follow after
this macro (you must use { and } ). Example:
@code
TAG_HANDLER_BEGIN(VARS2, "CRAZYTAG")
TAG_HANDLER_VARS
@ -386,7 +386,7 @@
} // !!!!!!
TAG_HANDLER_END(VARS2)
@endcode
Never used in wxHTML :-)
@li @b TAG_HANDLER_PROC(@e varib):
@ -395,7 +395,7 @@
@e tag. Body of method follows after this macro.
Note than you must use { and } !
Example:
@code
TAG_HANDLER_BEGIN(TITLE, "TITLE")
TAG_HANDLER_PROC(tag)
@ -423,7 +423,7 @@
@li @b TAGS_MODULE_END(@e modname):
Ends the definition of module.
Example:
@code
TAGS_MODULE_BEGIN(Examples)
TAGS_MODULE_ADD(VARS_ONLY)
@ -442,7 +442,7 @@
Following tables list all tags known to wxHTML, together with supported parameters.
A tag has general form of @c tagname param_1 param_2 ... param_n where param_i is
either @c paramname="paramvalue" or @c paramname=paramvalue - these two are equivalent.
either @c paramname="paramvalue" or @c paramname=paramvalue - these two are equivalent.
Unless stated otherwise, wxHTML is case-insensitive.
@subsection overview_html_supptags_commonvalues Table of common parameter values

10
docs/doxygen/overviews/sizer.h
View file

@ -295,7 +295,7 @@ MyDialog::MyDialog(wxFrame *parent, wxWindowID id, const wxString &title )
{
wxBoxSizer *topsizer = new wxBoxSizer( wxVERTICAL );
// create text ctrl with minimal size 100x60 that is horizontally and
// create text ctrl with minimal size 100x60 that is horizontally and
// vertically stretchable with a border width of 10
topsizer->Add(
new wxTextCtrl( this, -1, "My text.", wxDefaultPosition, wxSize(100,60), wxTE_MULTILINE),
@ -303,20 +303,20 @@ MyDialog::MyDialog(wxFrame *parent, wxWindowID id, const wxString &title )
wxBoxSizer *button_sizer = new wxBoxSizer( wxHORIZONTAL );
//create two buttons that are horizontally unstretchable,
//create two buttons that are horizontally unstretchable,
// with an all-around border with a width of 10 and implicit top alignment
button_sizer->Add(
new wxButton( this, wxID_OK, "OK" ),
wxSizerFlags(0).Align().Border(wxALL, 10));
wxSizerFlags(0).Align().Border(wxALL, 10));
button_sizer->Add(
new wxButton( this, wxID_CANCEL, "Cancel" ),
wxSizerFlags(0).Align().Border(wxALL, 10));
wxSizerFlags(0).Align().Border(wxALL, 10));
//create a sizer with no border and centered horizontally
topsizer->Add(
button_sizer,
wxSizerFlags(0).Center() );
wxSizerFlags(0).Center() );
SetSizerAndFit(topsizer); // use the sizer for layout and set size and hints
}

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

@ -94,7 +94,7 @@ if (in_stream.Read(data, nb_datas).LastError() != wxSTREAM_NOERROR) {
// You can also get the last number of bytes REALLY put into the buffer.
size_t really_read = in_stream.LastRead();
// Ok, moves to the beginning of the stream. SeekI returns the last position
// Ok, moves to the beginning of the stream. SeekI returns the last position
// in the stream counted from the beginning.
off_t old_position = in_stream.SeekI(0, wxFromBeginning);

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

@ -466,7 +466,7 @@ initialized.
A simple example will help understand how the scheme works. Suppose you have a
XRC file defining a top level window @c TestWnd_Base, which subclasses wxFrame
(any other class like @c wxDialog will do also), and has subwidgets wxTextCtrl A
(any other class like @c wxDialog will do also), and has subwidgets wxTextCtrl A
and wxButton B.
The XRC file and corresponding class definition in the header file will be
@ -624,7 +624,7 @@ wxObject *MyControlXmlHandler::DoCreateResource()
// do most of your work.
// If e.g. the MyControl::Create function looks like:
//
// bool MyControl::Create(wxWindow *parent, int id,
// bool MyControl::Create(wxWindow *parent, int id,
// const wxBitmap &first, const wxPoint &posFirst,
// const wxBitmap &second, const wxPoint &posSecond,
// const wxString &theTitle, const wxFont &titleFont,

14
interface/aboutdlg.h
View file

@ -47,21 +47,21 @@ public:
/**
Adds an artist name to be shown in the program credits.
@see SetArtists()
*/
void AddArtist(const wxString& artist);
/**
Adds a developer name to be shown in the program credits.
@see SetDevelopers()
*/
void AddDeveloper(const wxString& developer);
/**
Adds a documentation writer name to be shown in the program credits.
@see SetDocWriters()
*/
void AddDocWriter(const wxString& docwriter);
@ -72,14 +72,14 @@ public:
translation of the string @c translator-credits from the currently used message
catalog -- this can be used to show just the name of the translator of the
program in the current language.
@see SetTranslators()
*/
void AddTranslator(const wxString& translator);
/**
Sets the the list of artists to be shown in the program credits.
@see AddArtist()
*/
void SetArtists(const wxArrayString& artists);
@ -99,14 +99,14 @@ public:
/**
Set the list of developers of the program.
@see AddDeveloper()
*/
void SetDevelopers(const wxArrayString& developers);
/**
Set the list of documentation writers.
@see AddDocWriter()
*/
void SetDocWriters(const wxArrayString& docwriters);

8
interface/accel.h
View file

@ -77,7 +77,7 @@ public:
/**
Sets the accelerator entry parameters.
@param flags
A combination of the wxAcceleratorEntryFlags values, which
indicates which modifier keys are held down.
@ -138,7 +138,7 @@ public:
/**
Initializes the accelerator table from an array of wxAcceleratorEntry.
@param n
Number of accelerator entries.
@param entries
@ -148,7 +148,7 @@ public:
/**
Loads the accelerator table from a Windows resource (Windows only).
@param resource
Name of a Windows accelerator.
*/
@ -167,7 +167,7 @@ public:
/**
Assignment operator, using @ref overview_refcount "reference counting".
@param accel
Accelerator table to assign.
*/

2
interface/access.h
View file

@ -382,7 +382,7 @@ public:
/**
Returns a status value and object id to indicate whether the given point
was on this or a child object. Can return either a child object, or an
was on this or a child object. Can return either a child object, or an
integer representing the child element, starting from 1.
@a pt is in screen coordinates.

16
interface/animate.h
View file

@ -70,11 +70,11 @@ public:
/**
Creates the control with the given @a anim animation.
After control creation you must explicitely call Play() to start to play
the animation. Until that function won't be called, the first frame
of the animation is displayed.
@param parent
Parent window, must be non-@NULL.
@param id
@ -89,7 +89,7 @@ public:
The window style, see wxAC_* flags.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/
@ -192,7 +192,7 @@ public:
/**
Loads an animation from a file.
@param name
The name of the file to load.
@param type
@ -235,7 +235,7 @@ public:
/**
Loads an animation from the given stream.
@param stream
The stream to use to load the animation.
@param type
@ -243,7 +243,7 @@ public:
@li wxANIMATION_TYPE_GIF: loads an animated GIF file;
@li wxANIMATION_TYPE_ANI: load an ANI file;
@li wxANIMATION_TYPE_ANY: tries to autodetect the filetype.
@returns @true if the operation succeeded, @false otherwise.
*/
bool Load(wxInputStream& stream,
@ -251,13 +251,13 @@ public:
/**
Loads an animation from a file.
@param name
A filename.
@param type
One of the wxAnimationType values; wxANIMATION_TYPE_ANY
means that the function should try to autodetect the filetype.
@returns @true if the operation succeeded, @false otherwise.
*/
bool LoadFile(const wxString& name,

78
interface/app.h
View file

@ -48,14 +48,14 @@ public:
/**
Creates a wxLog class for the application to use for logging errors.
The default implementation returns a new wxLogGui class.
@see wxLog
*/
virtual wxLog* CreateLogTarget();
/**
Creates the wxAppTraits object when GetTraits() needs it for the first time.
@see wxAppTraits
*/
virtual wxAppTraits* CreateTraits();
@ -68,7 +68,7 @@ public:
while (app.Pending())
Dispatch();
@endcode
@see Pending()
*/
virtual void Dispatch();
@ -92,24 +92,24 @@ public:
int FilterEvent(wxEvent& event);
/**
Returns the user-readable application name.
Returns the user-readable application name.
The difference between this string and the one returned by GetAppName() is that
this one is meant to be shown to the user and so should be used for the window
titles, page headers and so on while the other one should be only used internally,
e.g. for the file names or configuration file keys.
By default, returns the same string as GetAppName().
@wxsince{2.9.0}
*/
wxString GetAppDisplayName() const;
/**
Returns the application name.
@remarks wxWidgets sets this to a reasonable default before calling
OnInit(), but the application can reset it at will.
@see GetAppDisplayName()
*/
wxString GetAppName() const;
@ -117,7 +117,7 @@ public:
/**
Gets the class name of the application. The class name may be used in a
platform specific manner to refer to the application.
@see SetClassName()
*/
wxString GetClassName() const;
@ -125,7 +125,7 @@ public:
/**
Returns @true if the application will exit when the top-level window is
deleted, @false otherwise.
@see SetExitOnFrameDelete(), @ref overview_app_shutdown
*/
bool GetExitOnFrameDelete() const;
@ -133,18 +133,18 @@ public:
/**
Returns the one and only global application object.
Usually ::wxTheApp is usead instead.
@see SetInstance()
*/
static wxAppConsole* GetInstance();
/**
Returns a pointer to the top window.
@remarks If the top window hasn't been set using SetTopWindow(),
this function will find the first top-level window
(frame or dialog) and return that.
@see SetTopWindow()
*/
virtual wxWindow* GetTopWindow() const;
@ -159,7 +159,7 @@ public:
/**
Returns @true if the application will use the best visual on systems that support
different visuals, @false otherwise.
@see SetUseBestVisual()
*/
bool GetUseBestVisual() const;
@ -172,7 +172,7 @@ public:
configuration file keys.
By default, returns the same string as GetVendorName().
@wxsince{2.9.0}
*/
wxString GetVendorDisplayName() const;
@ -196,7 +196,7 @@ public:
/**
Returns @true if the application is active, i.e. if one of its windows is
currently in the foreground.
If this function returns @false and you need to attract users attention to
the application, you may use wxTopLevelWindow::RequestUserAttention to do it.
*/
@ -245,7 +245,7 @@ public:
/**
Called by wxWidgets on creation of the application. Override this if you wish
to provide your own (environment-dependent) main loop.
@returns Returns 0 under X, and the wParam of the WM_QUIT message under
Windows.
*/
@ -259,7 +259,7 @@ public:
asserts are not left in the release code at all.
The base class version shows the default assert failure dialog box proposing to
the user to stop the program, continue or ignore all subsequent asserts.
@param file
the name of the source file where the assert occurred
@param line
@ -285,7 +285,7 @@ public:
Return @true to continue normal execution or @false to return
@false from OnInit() thus terminating the program.
@see OnInitCmdLine()
*/
bool OnCmdLineError(wxCmdLineParser& parser);
@ -296,7 +296,7 @@ public:
Return @true to continue normal execution or @false to return
@false from OnInit() thus terminating the program.
@see OnInitCmdLine()
*/
bool OnCmdLineHelp(wxCmdLineParser& parser);
@ -310,7 +310,7 @@ public:
processing of the standard command line options.
Return @true to continue normal execution or @false to return @false from
OnInit() thus terminating the program.
@see OnInitCmdLine()
*/
bool OnCmdLineParsed(wxCmdLineParser& parser);
@ -353,7 +353,7 @@ public:
Generally speaking, this function should only show a message to the user and
return. You may attempt to save unsaved data but this is not guaranteed to
work and, in fact, probably won't.
@see wxHandleFatalExceptions()
*/
void OnFatalException();
@ -408,7 +408,7 @@ public:
/**
Returns @true if unprocessed events are in the window system event queue.
@see Dispatch()
*/
virtual bool Pending();
@ -420,9 +420,9 @@ public:
The function returns @true if the message was processed, @false otherwise.
If you use wxWidgets with another class library with its own message loop,
you should make sure that this function is called to allow wxWidgets to
receive messages. For example, to allow co-existence with the Microsoft
receive messages. For example, to allow co-existence with the Microsoft
Foundation Classes, override the PreTranslateMessage function:
@code
// Provide wxWidgets message loop compatibility
BOOL CTheApp::PreTranslateMessage(MSG *msg)
@ -440,11 +440,11 @@ public:
Sends idle events to a window and its children.
Please note that this function is internal to wxWidgets and shouldn't be used
by user code.
@remarks These functions poll the top-level windows, and their children,
for idle event processing. If @true is returned, more OnIdle
processing is requested by one or more window.
@see wxIdleEvent
*/
bool SendIdleEvents(wxWindow* win, wxIdleEvent& event);
@ -463,7 +463,7 @@ public:
SetAppDisplayName() is used instead.
By default the application name is set to the name of its executable file.
@see GetAppName()
*/
void SetAppName(const wxString& name);
@ -471,7 +471,7 @@ public:
/**
Sets the class name of the application. This may be used in a platform specific
manner to refer to the application.
@see GetClassName()
*/
void SetClassName(const wxString& name);
@ -479,11 +479,11 @@ public:
/**
Allows the programmer to specify whether the application will exit when the
top-level frame is deleted.
@param flag
If @true (the default), the application will exit when the top-level frame
is deleted. If @false, the application will continue to run.
@see GetExitOnFrameDelete(), @ref overview_app_shutdown
*/
void SetExitOnFrameDelete(bool flag);
@ -491,10 +491,10 @@ public:
/**
Allows external code to modify global ::wxTheApp, but you should really
know what you're doing if you call it.
@param app
Replacement for the global application object.
@see GetInstance()
*/
static void SetInstance(wxAppConsole* app);
@ -504,7 +504,7 @@ public:
Currently implemented for wxGTK2-only.
Return @true if theme was successfully changed.
@param theme
The name of the new theme or an absolute path to a gtkrc-theme-file
*/
@ -517,10 +517,10 @@ public:
can use a specific window as the top window. If no top window is specified by the
application, wxWidgets just uses the first frame or dialog in its top-level window
list, when it needs to use the top window.
@param window
The new top window.
@see GetTopWindow(), OnInit()
*/
void SetTopWindow(wxWindow* window);
@ -534,7 +534,7 @@ public:
Note that this function has to be called in the constructor of the wxApp
instance and won't have any effect when called later on.
This function currently only has effect under GTK.
@param flag
If @true, the app will use the best visual.
@param forceTrueColour
@ -553,7 +553,7 @@ public:
/**
Sets the name of application's vendor. The name will be used
in registry access. A default name is set by wxWidgets.
@see GetVendorName()
*/
void SetVendorName(const wxString& name);
@ -783,7 +783,7 @@ int wxEntry(int& argc, wxChar** argv);
// OnExit isn't called by CleanUp so must be called explicitly.
wxTheApp->OnExit();
wxApp::CleanUp();
return CWinApp::ExitInstance();
}
@endcode

12
interface/archive.h
View file

@ -240,7 +240,7 @@ public:
The names of directory entries are returned without any trailing path
separator. This gives a canonical name that can be used in comparisons.
@see @ref overview_archive_byname
*/
wxString GetInternalName() const;
@ -327,7 +327,7 @@ enum wxStreamProtocolType
wxArchiveClassFactory::Find can also search for a factory by MIME type
or wxFileSystem protocol.
The available factories can be enumerated using
The available factories can be enumerated using
wxArchiveClassFactory::GetFirst() and wxArchiveClassFactory::GetNext().
@library{wxbase}
@ -381,13 +381,13 @@ public:
@code
wxString list;
const wxArchiveClassFactory *factory = wxArchiveClassFactory::GetFirst();
while (factory) {
list << factory->GetProtocol() << _T("\n");
factory = factory->GetNext();
}
@endcode
GetFirst() and GetNext() return a pointer to a factory or @NULL if no more
are available. They do not give away ownership of the factory.
*/
@ -418,7 +418,7 @@ public:
@code
wxString list;
const wxChar *const *p;
for (p = factory->GetProtocols(wxSTREAM_FILEEXT); *p; p++)
list << *p << _T("\n");
@encode
@ -529,7 +529,7 @@ public:
The first template parameter should be the type of archive input stream
(e.g. wxArchiveInputStream) and the second can either be a pointer to an entry
(e.g. wxArchiveEntry*), or a string/pointer pair (e.g. std::pairwxString,
(e.g. wxArchiveEntry*), or a string/pointer pair (e.g. std::pairwxString,
wxArchiveEntry*).
The @c wx/archive.h header defines the following typedefs:

16
interface/arrstr.h
View file

@ -116,7 +116,7 @@ public:
/**
Empties the array: after a call to this function GetCount() will return 0.
However, this function does not free the memory used by the array and so
However, this function does not free the memory used by the array and so
should be used when the array is going to be reused for storing other strings.
Otherwise, you should use Clear() to empty the array and free memory.
*/
@ -146,7 +146,7 @@ public:
@code
Insert("foo", 0);
@endcode
If @a nIndex is equal to @e GetCount() this function behaves as Add().
*/
void Insert(const wxString& str, size_t nIndex,
@ -207,7 +207,7 @@ public:
/**
Sorts the array using the specified @a compareFunction for item comparison.
@e CompareFunction is defined as a function taking two @e const wxString
parameters and returning an @e int value less than, equal to or greater
parameters and returning an @e int value less than, equal to or greater
than 0 if the first string is less than, equal to or greater than the
second one.
@ -219,16 +219,16 @@ public:
{
return first.length() - second.length();
}
...
wxArrayString array;
array.Add("one");
array.Add("two");
array.Add("three");
array.Add("four");
array.Sort(CompareStringLen);
@endcode
*/
@ -307,7 +307,7 @@ public:
/**
@copydoc wxArrayString::Index()
This function uses binary search for wxSortedArrayString, but it ignores
This function uses binary search for wxSortedArrayString, but it ignores
the @a bCase and @a bFromEnd parameters.
*/
int Index(const wxString& sz, bool bCase = true,

32
interface/artprov.h
View file

@ -132,14 +132,14 @@
Client is the entity that calls wxArtProvider's GetBitmap or GetIcon function.
It is represented by wxClientID type and can have one of these values:
@li wxART_TOOLBAR
@li wxART_MENU
@li wxART_BUTTON
@li wxART_FRAME_ICON
@li wxART_CMN_DIALOG
@li wxART_HELP_BROWSER
@li wxART_MESSAGE_BOX
@li wxART_OTHER (used for all requests that don't fit into any of the
@li wxART_TOOLBAR
@li wxART_MENU
@li wxART_BUTTON
@li wxART_FRAME_ICON
@li wxART_CMN_DIALOG
@li wxART_HELP_BROWSER
@li wxART_MESSAGE_BOX
@li wxART_OTHER (used for all requests that don't fit into any of the
categories above)
Client ID servers as a hint to wxArtProvider that is supposed to help it to
@ -168,7 +168,7 @@ public:
resource. Note that returned bitmaps are cached by wxArtProvider and it is
therefore not necessary to optimize CreateBitmap() for speed (e.g. you may
create wxBitmap objects from XPMs here).
@param id
wxArtID unique identifier of the bitmap.
@param client
@ -182,7 +182,7 @@ public:
This is not part of wxArtProvider's public API, use wxArtProvider::GetBitmap
or wxArtProvider::GetIconBundle or wxArtProvider::GetIcon to query wxArtProvider
for a resource.
@see CreateIconBundle()
*/
wxBitmap CreateBitmap(const wxArtID& id,
@ -203,14 +203,14 @@ public:
/**
Query registered providers for bitmap with given ID.
@param id
wxArtID unique identifier of the bitmap.
@param client
wxArtClient identifier of the client (i.e. who is asking for the bitmap).
@param size
Size of the returned bitmap or wxDefaultSize if size doesn't matter.
@returns The bitmap if one of registered providers recognizes the ID or
wxNullBitmap otherwise.
*/
@ -238,13 +238,13 @@ public:
/**
Query registered providers for icon bundle with given ID.
@param id
wxArtID unique identifier of the icon bundle.
@param client
wxArtClient identifier of the client (i.e. who is asking for the icon
bundle).
@returns The icon bundle if one of registered providers recognizes the ID
or wxNullIconBundle otherwise.
*/
@ -254,7 +254,7 @@ public:
/**
Register new art provider and add it to the bottom of providers stack
(i.e. it will be queried as the last one).
@see Push()
*/
static void Insert(wxArtProvider* provider);
@ -267,7 +267,7 @@ public:
/**
Register new art provider and add it to the top of providers stack
(i.e. it will be queried as the first provider).
@see Insert()
*/
static void Push(wxArtProvider* provider);

4
interface/base64.h
View file

@ -103,7 +103,7 @@ size_t wxBase64EncodedSize(size_t len);
The length of the input string or special value wxNO_LEN if the string is
NUL-terminated and the length should be computed by this function itself.
@param mode
This parameter specifies the function behaviour when invalid characters
This parameter specifies the function behaviour when invalid characters
are encountered in input. By default, any such character stops the
decoding with error. If the mode is wxBase64DecodeMode_SkipWS, then the
white space characters are silently skipped instead. And if it is
@ -125,7 +125,7 @@ size_t wxBase64Decode(void* dst, size_t dstLen,
This overload allocates memory internally and returns it as wxMemoryBuffer
and is recommended for normal use.
This overload returns a buffer with the base64 decoded binary equivalent
This overload returns a buffer with the base64 decoded binary equivalent
of the input string. In neither case is the buffer @NULL-terminated.
*/
wxMemoryBuffer wxBase64Decode(const char* src,

12
interface/calctrl.h
View file

@ -278,42 +278,42 @@ public:
/**
Gets the background colour of the header part of the calendar window.
@see SetHeaderColours()
*/
const wxColour GetHeaderColourBg() const;
/**
Gets the foreground colour of the header part of the calendar window.
@see SetHeaderColours()
*/
const wxColour GetHeaderColourFg() const;
/**
Gets the background highlight colour.
@see SetHighlightColours()
*/
const wxColour GetHighlightColourBg() const;
/**
Gets the foreground highlight colour.
@see SetHighlightColours()
*/
const wxColour GetHighlightColourFg() const;
/**
Return the background colour currently used for holiday highlighting.
@see SetHolidayColours()
*/
const wxColour GetHolidayColourBg() const;
/**
Return the foreground colour currently used for holiday highlighting.
@see SetHolidayColours()
*/
const wxColour GetHolidayColourFg() const;

20
interface/caret.h
View file

@ -58,13 +58,13 @@ public:
//@{
/**
Get the caret position (in pixels).
@b GetPosition()
Returns a Wx::Point
@b GetPositionXY()
Returns a 2-element list
@c ( x, y )
*/
@ -75,13 +75,13 @@ public:
//@{
/**
Get the caret size.
@b GetSize()
Returns a Wx::Size
@b GetSizeWH()
Returns a 2-element list
@c ( width, height )
*/
@ -121,11 +121,11 @@ public:
/**
Sets the blink time for all the carets.
@remarks Under Windows, this function will change the blink time for all
carets permanently (until the next time it is called),
even for the carets in other applications.
@see GetBlinkTime()
*/
static void SetBlinkTime(int milliseconds);

14
interface/checkbox.h
View file

@ -47,7 +47,7 @@ public:
//@{
/**
Constructor, creating and showing a checkbox.
@param parent
Parent window. Must not be @NULL.
@param id
@ -66,7 +66,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxCheckBox();
@ -98,7 +98,7 @@ public:
/**
Gets the state of a 3-state checkbox.
@returns Returns wxCHK_UNCHECKED when the checkbox is unchecked,
wxCHK_CHECKED when it is checked and
wxCHK_UNDETERMINED when it's in the undetermined state.
@ -109,14 +109,14 @@ public:
/**
Gets the state of a 2-state checkbox.
@returns Returns @true if it is checked, @false otherwise.
*/
bool GetValue() const;
/**
Returns whether or not the checkbox is a 3-state checkbox.
@returns Returns @true if this checkbox is a 3-state checkbox, @false if
it's a 2-state checkbox.
*/
@ -124,7 +124,7 @@ public:
/**
Returns whether or not the user can set the checkbox to the third state.
@returns Returns @true if the user can set the third state of this
checkbox, @false if it can only be set programmatically
or if it's a 2-state checkbox.
@ -141,7 +141,7 @@ public:
/**
Sets the checkbox to the given state. This does not cause a
wxEVT_COMMAND_CHECKBOX_CLICKED event to get emitted.
@param state
If @true, the check is on, otherwise it is off.
*/

4
interface/checklst.h
View file

@ -38,7 +38,7 @@ public:
//@{
/**
Constructor, creating and showing a list box.
@param parent
Parent window. Must not be @NULL.
@param id
@ -86,7 +86,7 @@ public:
/**
Checks the given item. Note that calling this method doesn't result in
wxEVT_COMMAND_CHECKLISTBOX_TOGGLE being emitted.
@param item
Index of item to check.
@param check

10
interface/choice.h
View file

@ -37,7 +37,7 @@ public:
//@{
/**
Constructor, creating and showing a choice.
@param parent
Parent window. Must not be @NULL.
@param id
@ -58,7 +58,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxChoice();
@ -104,7 +104,7 @@ public:
/**
Gets the number of columns in this choice item.
@remarks This is implemented for Motif only and always returns 1 for the
other platforms.
*/
@ -117,7 +117,7 @@ public:
That is, while the dropdown list is shown, it returns the currently selected
item in it. When it is not shown, its result is the same as for the other
function.
@wxsince{2.6.2} (before this version
wxControlWithItems::GetSelection itself behaved like
this).
@ -126,7 +126,7 @@ public:
/**
Sets the number of columns in this choice item.
@param n
Number of columns.
*/

4
interface/clipbrd.h
View file

@ -77,7 +77,7 @@ public:
After this function has been called, the clipboard owns the data, so do not
delete
the data explicitly.
@see SetData()
*/
bool AddData(wxDataObject* data);
@ -141,7 +141,7 @@ public:
After this function has been called, the clipboard owns the data, so do not
delete
the data explicitly.
@see AddData()
*/
bool SetData(wxDataObject* data);

4
interface/clntdata.h
View file

@ -30,12 +30,12 @@ class wxClientDataContainer
{
public:
/**
*/
wxClientDataContainer();
/**
*/
~wxClientDataContainer();

2
interface/clrpicker.h
View file

@ -69,7 +69,7 @@ public:
Validator which can be used for additional date checks.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/

8
interface/cmdline.h
View file

@ -104,7 +104,7 @@ public:
/**
Returns @true if long options are enabled, otherwise @false.
@see EnableLongOptions()
*/
bool AreLongOptionsEnabled() const;
@ -174,7 +174,7 @@ public:
Enable or disable support for the long options.
As long options are not (yet) POSIX-compliant, this option allows to disable
them.
@see Customization() and AreLongOptionsEnabled()
*/
void EnableLongOptions(bool enable = true);
@ -219,7 +219,7 @@ public:
Parse the command line, return 0 if ok, -1 if @c "-h" or @c "--help"
option was encountered and the help message was given or a positive value if a
syntax error occurred.
@param giveUsage
If @true (default), the usage message is given if a
syntax error was encountered while parsing the command line or if help was
@ -273,7 +273,7 @@ public:
Give the standard usage message describing all program options. It will use the
options and parameters descriptions specified earlier, so the resulting message
will not be helpful to the user unless the descriptions were indeed specified.
@see SetLogo()
*/
void Usage() const;

4
interface/cmndata.h
View file

@ -493,7 +493,7 @@ public:
Returns the current print quality. This can be a positive integer, denoting the
number of dots per inch, or
one of the following identifiers:
On input you should pass one of these identifiers, but on return you may get
back a positive integer
indicating the current resolution setting.
@ -557,7 +557,7 @@ public:
Sets the desired print quality. This can be a positive integer, denoting the
number of dots per inch, or
one of the following identifiers:
On input you should pass one of these identifiers, but on return you may get
back a positive integer
indicating the current resolution setting.

2
interface/collpane.h
View file

@ -136,7 +136,7 @@ public:
Validator which can be used for additional date checks.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/

2
interface/colordlg.h
View file

@ -28,7 +28,7 @@ public:
Invalid entries in custom colours list will be ignored on some platforms (GTK)
or replaced with white colour on platforms where custom colours palette has
fixed size (MSW).
@see wxColourData
*/
wxColourDialog(wxWindow* parent, wxColourData* data = NULL);

10
interface/colour.h
View file

@ -35,7 +35,7 @@ public:
//@{
/**
Copy constructor.
@param red
The red value.
@param green
@ -49,7 +49,7 @@ public:
The colour name.
@param colour
The colour to copy.
@see wxColourDatabase
*/
wxColour();
@ -75,7 +75,7 @@ public:
/**
is not
specified in flags.
@wxsince{2.7.0}
*/
wxString GetAsString(long flags);
@ -124,7 +124,7 @@ public:
and the HTML-like syntax (i.e. @c "#" followed by 6 hexadecimal digits
for red, green, blue components).
Returns @true if the conversion was successful, @false otherwise.
@wxsince{2.7.0}
*/
void Set(unsigned char red, unsigned char green,
@ -143,7 +143,7 @@ public:
//@{
/**
Assignment operator, using a colour name to be found in the colour database.
@see wxColourDatabase
*/
wxColour operator =(const wxColour& colour);

60
interface/combo.h
View file

@ -32,7 +32,7 @@ public:
/**
The derived class must implement this to create the popup control.
@returns @true if the call succeeded, @false otherwise.
*/
bool Create(wxWindow* parent);
@ -45,7 +45,7 @@ public:
/**
The derived class may implement this to return adjusted size
for the popup control, according to the variables given.
@param minWidth
Preferred minimum width.
@param prefHeight
@ -54,7 +54,7 @@ public:
@param maxWidth
Max height for window, as limited by
screen size.
@remarks Called each time popup is about to be shown.
*/
wxSize GetAdjustedSize(int minWidth, int prefHeight,
@ -92,7 +92,7 @@ public:
until the popup is shown for the first time. It is more
efficient, but on the other hand it is often more convenient
to have the control created immediately.
@remarks Base implementation returns @false.
*/
bool LazyCreate();
@ -192,7 +192,7 @@ public:
//@{
/**
Constructor, creating and showing a combo control.
@param parent
Parent window. Must not be @NULL.
@param id
@ -211,7 +211,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxComboCtrl();
@ -233,7 +233,7 @@ public:
This member function is not normally called in application code.
Instead, it can be implemented in a derived class to create a
custom popup animation.
@returns @true if animation finishes before the function returns. @false
otherwise. In the latter case you need to manually call
DoShowPopup after the animation ends.
@ -279,7 +279,7 @@ public:
is properly shown after a popup animation has finished (but only
if AnimateShow() did not finish
the animation within it's function scope).
@param rect
Position to show the popup window at, in screen coordinates.
@param flags
@ -296,7 +296,7 @@ public:
/**
Returns disabled button bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the disabled state bitmap.
*/
const wxBitmap GetBitmapDisabled() const;
@ -304,7 +304,7 @@ public:
/**
Returns button mouse hover bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the mouse hover state bitmap.
*/
const wxBitmap GetBitmapHover() const;
@ -312,7 +312,7 @@ public:
/**
Returns default button bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the normal state bitmap.
*/
const wxBitmap GetBitmapNormal() const;
@ -320,7 +320,7 @@ public:
/**
Returns depressed button bitmap that has been set with
SetButtonBitmaps().
@returns A reference to the depressed state bitmap.
*/
const wxBitmap GetBitmapPressed() const;
@ -332,7 +332,7 @@ public:
/**
Returns custom painted area in control.
@see SetCustomPaintWidth().
*/
int GetCustomPaintWidth() const;
@ -341,7 +341,7 @@ public:
Returns features supported by wxComboCtrl. If needed feature is missing,
you need to instead use wxGenericComboCtrl, which however may lack
native look and feel (but otherwise sports identical API).
@returns Value returned is a combination of following flags:
*/
static int GetFeatures();
@ -403,18 +403,18 @@ public:
/**
Returns @true if the popup window is in the given state.
Possible values are:
@c Hidden()
Popup window is hidden.
@c Animating()
Popup window is being shown, but the
popup animation has not yet finished.
@c Visible()
Popup window is fully visible.
*/
bool IsPopupWindowState(int state) const;
@ -437,7 +437,7 @@ public:
/**
Removes the text between the two positions in the combo control text field.
@param from
The first position.
@param to
@ -448,7 +448,7 @@ public:
/**
Replaces the text between two positions with the given text, in the combo
control text field.
@param from
The first position.
@param to
@ -460,7 +460,7 @@ public:
/**
Sets custom dropdown button graphics.
@param bmpNormal
Default button image.
@param pushButtonBg
@ -483,7 +483,7 @@ public:
/**
Sets size and position of dropdown button.
@param width
Button width. Value = 0 specifies default.
@param height
@ -507,7 +507,7 @@ public:
/**
Sets the insertion point in the text field.
@param pos
The new insertion point.
*/
@ -535,21 +535,21 @@ public:
/**
Extends popup size horizontally, relative to the edges of the combo control.
@param extLeft
How many pixel to extend beyond the left edge of the
control. Default is 0.
@param extRight
How many pixel to extend beyond the right edge of the
control. Default is 0.
@remarks Popup minimum width may override arguments.
*/
void SetPopupExtents(int extLeft, int extRight);
/**
Sets preferred maximum height of the popup.
@remarks Value -1 indicates the default.
*/
void SetPopupMaxHeight(int height);
@ -557,14 +557,14 @@ public:
/**
Sets minimum width of the popup. If wider than combo control, it will extend to
the left.
@remarks Value -1 indicates the default.
*/
void SetPopupMinWidth(int width);
/**
Selects the text between the two positions, in the combo control text field.
@param from
The first position.
@param to

14
interface/combobox.h
View file

@ -66,7 +66,7 @@ public:
//@{
/**
Constructor, creating and showing a combobox.
@param parent
Parent window. Must not be @NULL.
@param id
@ -89,7 +89,7 @@ public:
Window validator.
@param name
Window name.
@see Create(), wxValidator
*/
wxComboBox();
@ -229,7 +229,7 @@ public:
/**
Removes the text between the two positions in the combobox text field.
@param from
The first position.
@param to
@ -240,7 +240,7 @@ public:
/**
Replaces the text between two positions with the given text, in the combobox
text field.
@param from
The first position.
@param to
@ -252,7 +252,7 @@ public:
/**
Sets the insertion point in the combobox text field.
@param pos
The new insertion point.
*/
@ -265,7 +265,7 @@ public:
/**
Selects the text between the two positions, in the combobox text field.
@param from
The first position.
@param to
@ -277,7 +277,7 @@ public:
Sets the text for the combobox text field.
@b NB: For a combobox with @c wxCB_READONLY style the string must be in
the combobox choices list, otherwise the call to SetValue() is ignored.
@param text
The text to set.
*/

98
interface/config.h
View file

@ -41,7 +41,7 @@ public:
)
This is the default and only constructor of the wxConfigBase class, and
derived classes.
@param appName
The application name. If this is empty, the class will
normally use wxApp::GetAppName to set it. The
@ -101,7 +101,7 @@ public:
This parameter is only used by wxFileConfig when compiled
in Unicode mode. It specifies the encoding in which the configuration file
is written.
@remarks By default, environment variable expansion is on and recording
defaults is off.
*/
@ -118,7 +118,7 @@ public:
/**
@ref ctor() wxConfigBase
@ref dtor() ~wxConfigBase
*/
@ -136,9 +136,9 @@ public:
config file. @e DeleteAll() is especially useful if you want to erase all
traces of your program presence: for example, when you uninstall it.
DeleteEntry()
DeleteGroup()
DeleteAll()
*/
@ -182,19 +182,19 @@ public:
from running several enumerations simultaneously, that's why you must pass it
explicitly.
Having said all this, enumerating the config entries/groups is very simple:
There are also functions to get the number of entries/subgroups without
actually enumerating them, but you will probably never need them.
GetFirstGroup()
GetNextGroup()
GetFirstEntry()
GetNextEntry()
GetNumberOfEntries()
GetNumberOfGroups()
*/
@ -253,7 +253,7 @@ public:
bool GetNextGroup(wxString& str, long& index) const;
/**
*/
uint GetNumberOfEntries(bool bRecursive = false) const;
@ -309,18 +309,18 @@ public:
Final remark: the @e szKey parameter for all these functions can contain an
arbitrary path (either relative or absolute), not just the key name.
Read()
Write()
Flush()
*/
/**
GetAppName()
GetVendorName()
wxFileConfig::SetUmask
*/
@ -330,7 +330,7 @@ public:
first of them is the expansion of environment variables in the string values
read from the config file: for example, if you have the following in your
config file:
the call to @c config-Read("UserData") will return something like
@c "/home/zeitlin/data" if you're lucky enough to run a Linux system ;-)
Although this feature is very useful, it may be annoying if you read a value
@ -341,11 +341,11 @@ public:
would be to prefix the offending symbols with a backslash.
The following functions control this option:
IsExpandingEnvVars()
SetExpandEnvVars()
SetRecordDefaults()
IsRecordingDefaults()
*/
@ -359,18 +359,18 @@ public:
which makes it possible to use the relative paths. To clarify all this, here
is an example (it is only for the sake of demonstration, it doesn't do anything
sensible!):
@e Warning: it is probably a good idea to always restore the path to its
old value on function exit:
because otherwise the assert in the following example will surely fail
(we suppose here that @e foo() function is the same as above except that it
doesn't save and restore the path):
Finally, the path separator in wxConfigBase and derived classes is always '/',
regardless of the platform (i.e. it is @b not '\\' under Windows).
SetPath()
GetPath()
*/
@ -382,22 +382,22 @@ public:
returning @true if the value was found.
If the value was not found, @a defaultVal is used instead.
bool Read(const wxStringkey, T* value) const;
@b Read(key, default="")
Returns a string
@b ReadInt(key, default=0)
Returns an integer
@b ReadFloat(key, default=0.0)
Returns a floating point number
@b ReadBool(key, default=0)
Returns a boolean
*/
bool Read(const wxString& key, wxString* str) const;
@ -453,7 +453,7 @@ public:
the new name already exists or because the function is not supported in this
wxConfig implementation.
RenameEntry()
RenameGroup()
*/
@ -526,22 +526,22 @@ public:
in it. For example wxFontMapper or Unix version
of wxFileDialog have the ability to use wxConfig class.
Set()
Get()
Create()
DontCreateOnDemand()
*/
/**
HasGroup()
HasEntry()
Exists()
GetEntryType()
*/
@ -551,22 +551,22 @@ public:
These functions write the specified value to the config file and return @true
on success. In the last one, function wxToString() must be
defined for type @e T.
@b Write(key, value)
Writes a string
@b WriteInt(key, value)
Writes an integer
@b WriteFloat(key, value)
Writes a floating point number
@b WriteBool(key, value)
Writes a boolean
*/
bool Write(const wxString& key, const wxString& value);

4
interface/cshelp.h
View file

@ -84,7 +84,7 @@ public:
the latter if the help doesn't depend on the position.
Returns @true if help was shown, or @false if no help was available for this
window.
@param window
Window to show help text for.
@param point
@ -240,7 +240,7 @@ public:
//@{
/**
Constructor, creating and showing a context help button.
@param parent
Parent window. Must not be @NULL.
@param id

58
interface/ctrlsub.h
View file

@ -45,7 +45,7 @@ public:
Appends several items at once to the control. Notice that calling this method
is usually much faster than appending them one by one if you need to add a lot
of items.
@param item
String to add.
@param stringsArray
@ -56,7 +56,7 @@ public:
Number of items in the strings array.
@param clientData
Array of client data pointers of size n to associate with the new items.
@returns When appending a single item, the return value is the index of
the newly added item which may be different from the
last one if the control is sorted (e.g. has wxLB_SORT
@ -86,22 +86,22 @@ public:
Note that it is an error (signalled by an assert failure in debug builds) to
remove an item with the index negative or greater or equal than the number of
items in the control.
@param n
The zero-based item index.
@see Clear()
*/
void Delete(unsigned int n);
/**
Finds an item whose label matches the given string.
@param string
String to find.
@param caseSensitive
Whether search is case sensitive (default is not).
@returns The zero-based position of the item, or wxNOT_FOUND if the
string was not found.
*/
@ -113,10 +113,10 @@ public:
It is an error to call this function for a control which doesn't have untyped
client data at all although it is ok to call it even if the given item doesn't
have any client data associated with it (but other items do).
@param n
The zero-based position of the item.
@returns A pointer to the client data, or @NULL if not present.
*/
void* GetClientData(unsigned int n) const;
@ -126,17 +126,17 @@ public:
It is an error to call this function for a control which doesn't have typed
client data at all although it is ok to call it even if the given item doesn't
have any client data associated with it (but other items do).
@param n
The zero-based position of the item.
@returns A pointer to the client data, or @NULL if not present.
*/
wxClientData* GetClientObject(unsigned int n) const;
/**
Returns the number of items in the control.
@see IsEmpty()
*/
unsigned int GetCount() const;
@ -144,23 +144,23 @@ public:
/**
Returns the index of the selected item or @c wxNOT_FOUND if no item is
selected.
@returns The position of the current selection.
@remarks This method can be used with single selection list boxes only,
you should use wxListBox::GetSelections for the list
boxes with wxLB_MULTIPLE style.
@see SetSelection(), GetStringSelection()
*/
int GetSelection() const;
/**
Returns the label of the item with the given index.
@param n
The zero-based index.
@returns The label of the item or an empty string if the position was
invalid.
*/
@ -169,7 +169,7 @@ public:
/**
Returns the label of the selected item or an empty string if no item is
selected.
@see GetSelection()
*/
wxString GetStringSelection() const;
@ -185,7 +185,7 @@ public:
is usually much faster than inserting them one by one if you need to insert a
lot
of items.
@param item
String to add.
@param pos
@ -198,7 +198,7 @@ public:
Number of items in the strings array.
@param clientData
Array of client data pointers of size n to associate with the new items.
@returns The return value is the index of the newly inserted item. If the
insertion failed for some reason, -1 is returned.
*/
@ -221,7 +221,7 @@ public:
/**
Returns @true if the control is empty or @false if it has some items.
@see GetCount()
*/
bool IsEmpty() const;
@ -238,7 +238,7 @@ public:
Replaces the current control contents with the given items. Notice that calling
this method is much faster than appending the items one by one if you need to
append a lot of them.
@param item
The single item to insert into the control.
@param stringsArray
@ -250,7 +250,7 @@ public:
'strings'.
@param clientData
Client data to associate with the item(s).
@returns When the control is sorted (e.g. has wxLB_SORT or wxCB_SORT
style) the return value could be different from
(GetCount() - 1). When setting a single item to the
@ -274,7 +274,7 @@ public:
Associates the given untyped client data pointer with the given item. Note that
it is an error to call this function if any typed client data pointers had been
associated with the control items before.
@param n
The zero-based item index.
@param data
@ -289,7 +289,7 @@ public:
control itself is destroyed).
Note that it is an error to call this function if any untyped client data
pointers had been associated with the control items before.
@param n
The zero-based item index.
@param data
@ -302,17 +302,17 @@ public:
if @a n == @c wxNOT_FOUND.
Note that this does not cause any command events to be emitted nor does it
deselect any other items in the controls which support multiple selections.
@param n
The string position to select, starting from zero.
@see SetString(), SetStringSelection()
*/
void SetSelection(int n);
/**
Sets the label for the given item.
@param n
The zero-based item index.
@param string
@ -323,10 +323,10 @@ public:
/**
Selects the item with the specified string in the control. This doesn't cause
any command events to be emitted.
@param string
The string to select.
@returns @true if the specified string has been selected, @false if it
wasn't found in the control.
*/

592
interface/cursor.h
View file

@ -39,7 +39,7 @@ public:
//@{
/**
Copy constructor, uses @ref overview_trefcount "reference counting".
@param bits
An array of bits.
@param maskBits
@ -58,370 +58,370 @@ public:
it defaults to wxBITMAP_TYPE_CUR_RESOURCE. Under MacOS, it defaults to
wxBITMAP_TYPE_MACCURSOR_RESOURCE.
Under X, the permitted cursor types are:
wxBITMAP_TYPE_XBM
Load an X bitmap file.
Under Windows, the permitted types are:
wxBITMAP_TYPE_CUR
Load a cursor from a .cur cursor file (only if USE_RESOURCE_LOADING_IN_MSW
is enabled in setup.h).
wxBITMAP_TYPE_CUR_RESOURCE
Load a Windows resource (as specified in the .rc file).
wxBITMAP_TYPE_ICO
Load a cursor from a .ico icon file (only if USE_RESOURCE_LOADING_IN_MSW
is enabled in setup.h). Specify hotSpotX and hotSpotY.
@param cursorId
A stock cursor identifier. May be one of:
wxCURSOR_ARROW
A standard arrow cursor.
wxCURSOR_RIGHT_ARROW
A standard arrow cursor
pointing to the right.
wxCURSOR_BLANK
Transparent cursor.
wxCURSOR_BULLSEYE
Bullseye cursor.
wxCURSOR_CHAR
Rectangular character cursor.
wxCURSOR_CROSS
A cross cursor.
wxCURSOR_HAND
A hand cursor.
wxCURSOR_IBEAM
An I-beam cursor (vertical line).
wxCURSOR_LEFT_BUTTON
Represents a mouse with the left button depressed.
wxCURSOR_MAGNIFIER
A magnifier icon.
wxCURSOR_MIDDLE_BUTTON
Represents a mouse with the middle button depressed.
wxCURSOR_NO_ENTRY
A no-entry sign cursor.
wxCURSOR_PAINT_BRUSH
A paintbrush cursor.
wxCURSOR_PENCIL
A pencil cursor.
wxCURSOR_POINT_LEFT
A cursor that points left.
wxCURSOR_POINT_RIGHT
A cursor that points right.
wxCURSOR_QUESTION_ARROW
An arrow and question mark.
wxCURSOR_RIGHT_BUTTON
Represents a mouse with the right button depressed.
wxCURSOR_SIZENESW
A sizing cursor pointing NE-SW.
wxCURSOR_SIZENS
A sizing cursor pointing N-S.
wxCURSOR_SIZENWSE
A sizing cursor pointing NW-SE.
wxCURSOR_SIZEWE
A sizing cursor pointing W-E.
wxCURSOR_SIZING
A general sizing cursor.
wxCURSOR_SPRAYCAN
A spraycan cursor.
wxCURSOR_WAIT
A wait cursor.
wxCURSOR_WATCH
A watch cursor.
wxCURSOR_ARROWWAIT
A cursor with both an arrow and
an hourglass, (windows.)
Note that not all cursors are available on all platforms.
@param cursor
Pointer or reference to a cursor to copy.

36
interface/dataview.h
View file

@ -67,7 +67,7 @@ class wxDataViewEvent : public wxNotifyEvent
public:
//@{
/**
*/
wxDataViewEvent(wxEventType commandType = wxEVT_NULL,
int winid = 0);
@ -107,7 +107,7 @@ public:
const wxVariant GetValue() const;
/**
*/
void SetColumn(int col);
@ -117,12 +117,12 @@ public:
void SetDataViewColumn(wxDataViewColumn* col);
/**
*/
void SetModel(wxDataViewModel* model);
/**
*/
void SetValue(const wxVariant& value);
};
@ -147,7 +147,7 @@ class wxDataViewIconTextRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewIconTextRenderer(const wxString& varianttype = "wxDataViewIconText",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
@ -584,7 +584,7 @@ public:
*/
virtual bool Activate( wxRect cell,
wxDataViewModel* model,
const wxDataViewItem & item,
const wxDataViewItem & item,
unsigned int col );
/**
@ -626,7 +626,7 @@ public:
virtual bool LeftClick( wxPoint cursor,
wxRect cell,
wxDataViewModel * model,
const wxDataViewItem & item,
const wxDataViewItem & item,
unsigned int col );
/**
@ -651,7 +651,7 @@ public:
virtual bool RightClick(wxPoint cursor,
wxRect cell,
wxDataViewModel* model,
const wxDataViewItem & item,
const wxDataViewItem & item,
unsigned int col);
/**
@ -659,7 +659,7 @@ public:
*/
virtual bool StartDrag(wxPoint cursor, wxRect cell,
wxDataViewModel* model,
const wxDataViewItem & item,
const wxDataViewItem & item,
unsigned int col);
};
@ -678,7 +678,7 @@ class wxDataViewBitmapRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewBitmapRenderer(const wxString& varianttype = "wxBitmap",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
@ -756,7 +756,7 @@ class wxDataViewItem
public:
//@{
/**
*/
wxDataViewItem(void* id = NULL);
wxDataViewItem(const wxDataViewItem& item);
@ -1344,7 +1344,7 @@ class wxDataViewTextRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewTextRenderer(const wxString& varianttype = "string",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
@ -1365,7 +1365,7 @@ class wxDataViewProgressRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewProgressRenderer(const wxString& label = wxEmptyString,
const wxString& varianttype = "long",
@ -1412,7 +1412,7 @@ class wxDataViewToggleRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewToggleRenderer(const wxString& varianttype = "bool",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT);
@ -1456,7 +1456,7 @@ public:
~wxDataViewTreeCtrl();
/**
*/
wxDataViewItem AppendContainer(const wxDataViewItem& parent,
const wxString& text,
@ -1465,7 +1465,7 @@ public:
wxClientData* data = NULL);
/**
*/
wxDataViewItem AppendItem(const wxDataViewItem& parent,
const wxString& text,
@ -1769,7 +1769,7 @@ class wxDataViewDateRenderer : public wxDataViewRenderer
{
public:
/**
*/
wxDataViewDateRenderer(const wxString& varianttype = "datetime",
wxDataViewCellMode mode = wxDATAVIEW_CELL_ACTIVATABLE);
@ -1795,7 +1795,7 @@ class wxDataViewTextRendererAttr : public wxDataViewTextRenderer
{
public:
/**
*/
wxDataViewTextRendererAttr(const wxString& varianttype = "string",
wxDataViewCellMode mode = wxDATAVIEW_CELL_INERT,

10
interface/datectrl.h
View file

@ -90,7 +90,7 @@ public:
Validator which can be used for additional date checks.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/
@ -107,14 +107,14 @@ public:
SetRange(), returns the lower and upper
bounds of this range. If no range is set (or only one of the bounds is set),
@a dt1 and/or @a dt2 are set to be invalid.
@param dt1
Pointer to the object which receives the lower range limit or
becomes invalid if it is not set. May be @NULL if the caller is not
interested in lower limit
@param dt2
Same as above but for the upper limit
@returns @false if no range limits are currently set, @true if at least one
bound is set.
*/
@ -131,7 +131,7 @@ public:
control. The native version always uses the current system locale.
Sets the display format for the date in the control. See wxDateTime for the
meaning of format strings.
@remarks If the format parameter is invalid, the behaviour is undefined.
*/
void SetFormat(const wxChar* format);
@ -140,7 +140,7 @@ public:
Sets the valid range for the date selection. If @a dt1 is valid, it becomes
the earliest date (inclusive) accepted by the control. If @a dt2 is valid,
it becomes the latest possible date.
@remarks If the current value of the control is outside of the newly set
range bounds, the behaviour is undefined.
*/

370
interface/datetime.h
View file

@ -35,39 +35,39 @@ public:
some more complicated calculations to find the answer are under the
@ref overview_datetimecalculations "Calendar calculations" section.
IsValid()
GetTicks()
GetCentury()
GetYear()
GetMonth()
GetDay()
GetWeekDay()
GetHour()
GetMinute()
GetSecond()
GetMillisecond()
GetDayOfYear()
GetWeekOfYear()
GetWeekOfMonth()
GetYearDay()
IsWorkDay()
IsGregorianDate()
GetAsDOS()
*/
@ -88,17 +88,17 @@ public:
@ref getmodifiedjuliandaynumber() MJD or
@ref getratadie() "Rata Die number" from it.
@ref wxdatetimejdn() "wxDateTime(double jdn)"
@ref setjdn() "Set(double jdn)"
GetJulianDayNumber()
GetJDN()
GetModifiedJulianDayNumber()
GetMJD()
GetRataDie()
*/
@ -110,33 +110,33 @@ public:
All (non-const) functions in this section don't modify the time part of the
wxDateTime -- they only work with the date part of it.
SetToWeekDayInSameWeek()
GetWeekDayInSameWeek()
SetToNextWeekDay()
GetNextWeekDay()
SetToPrevWeekDay()
GetPrevWeekDay()
SetToWeekDay()
@ref wxDateTime::getweekday2 GetWeekDay
SetToLastWeekDay()
GetLastWeekDay()
SetToWeekOfYear()
SetToLastMonthDay()
GetLastMonthDay()
SetToYearDay()
GetYearDay()
*/
@ -147,49 +147,49 @@ public:
should use IsValid() method to check that the
values were correct as constructors can not return an error code.
@ref wxdatetimedef() wxDateTime
@ref wxdatetimetimet() wxDateTime(time_t)
@ref wxdatetimetm() "wxDateTime(struct tm)"
@ref wxdatetimejdn() "wxDateTime(double jdn)"
@ref wxdatetimetime() "wxDateTime(h, m, s, ms)"
@ref wxdatetimedate() "wxDateTime(day, mon, year, h, m, s, ms)"
SetToCurrent()
@ref settimet() Set(time_t)
@ref settm() "Set(struct tm)"
@ref setjdn() "Set(double jdn)"
@ref settime() "Set(h, m, s, ms)"
@ref setdate() "Set(day, mon, year, h, m, s, ms)"
@ref setfromdos() "SetFromDOS(unsigned long ddt)"
ResetTime()
SetYear()
SetMonth()
@ref setdate() SetDay
SetHour()
SetMinute()
SetSecond()
SetMillisecond()
@ref operatoreqtimet() operator=(time_t)
@ref operatoreqtm() "operator=(struct tm)"
*/
@ -214,21 +214,21 @@ public:
modifies the object to which it is applied. The operators -= and += are
defined to be equivalent to the second forms of these functions.
@ref addts() Add(wxTimeSpan)
@ref addds() Add(wxDateSpan)
@ref subtractts() Subtract(wxTimeSpan)
@ref subtractds() Subtract(wxDateSpan)
@ref subtractdt() Subtract(wxDateTime)
@ref addts() oparator+=(wxTimeSpan)
@ref addds() oparator+=(wxDateSpan)
@ref subtractts() oparator-=(wxTimeSpan)
@ref subtractds() oparator-=(wxDateSpan)
*/
@ -237,19 +237,19 @@ public:
There are several function to allow date comparison. To supplement them, a few
global operators , etc taking wxDateTime are defined.
IsEqualTo()
IsEarlierThan()
IsLaterThan()
IsStrictlyBetween()
IsBetween()
IsSameDate()
IsSameTime()
IsEqualUpTo()
*/
@ -260,7 +260,7 @@ public:
It also accepts a few wxWidgets-specific extensions: you can optionally specify
the width of the field to follow using @c printf(3)-like syntax and the
format specification @c %l can be used to get the number of milliseconds.
@see ParseFormat()
*/
wxString Format(const wxChar* format = wxDefaultDateTimeFormat,
@ -278,7 +278,7 @@ public:
result exactly corresponding to the ISO standard, but it can also be useful to
use a space as seprator if a more human-readable combined date-time
representation is needed.
@see FormatISODate(), FormatISOTime(),
ParseISOCombined()
*/
@ -328,7 +328,7 @@ public:
Get the beginning of DST for the given country in the given year (current one
by default). This function suffers from limitations described in
@ref overview_tdatedst "DST overview".
@see GetEndDST()
*/
static wxDateTime GetBeginDST(int year = Inv_Year,
@ -342,7 +342,7 @@ public:
/**
Returns the current default country. The default country is used for DST
calculations, for example.
@see SetCountry()
*/
static Country GetCountry();
@ -360,9 +360,9 @@ public:
/**
Returns the object having the same date component as this one but time of
00:00:00.
@wxsince{2.8.2}
@see ResetTime()
*/
wxDateTime GetDateOnly() const;
@ -381,7 +381,7 @@ public:
/**
Returns the end of DST for the given country in the given year (current one by
default).
@see GetBeginDST()
*/
static wxDateTime GetEndDST(int year = Inv_Year,
@ -400,7 +400,7 @@ public:
/**
Returns the @ref setjdn() JDN corresponding to this date. Beware
of rounding errors!
@see GetModifiedJulianDayNumber()
*/
double GetJulianDayNumber() const;
@ -451,7 +451,7 @@ public:
/**
Gets the full (default) or abbreviated (specify @c Name_Abbr name of the
given month.
@see GetWeekDayName()
*/
static wxString GetMonthName(Month month,
@ -540,7 +540,7 @@ public:
/**
Gets the full (default) or abbreviated (specify @c Name_Abbr name of the
given week day.
@see GetMonthName()
*/
static wxString GetWeekDayName(WeekDay weekday,
@ -584,7 +584,7 @@ public:
/**
Returns @true if IsStrictlyBetween()
is @true or if the date is equal to one of the limit values.
@see IsStrictlyBetween()
*/
bool IsBetween(const wxDateTime& t1, const wxDateTime& t2) const;
@ -649,7 +649,7 @@ public:
/**
Returns @true if this date lies strictly between the two others,
@see IsBetween()
*/
bool IsStrictlyBetween(const wxDateTime& t1,
@ -695,11 +695,11 @@ public:
/**
Returns the object corresponding to the current time.
Example:
Note that this function is accurate up to second:
UNow() should be used for better precision
(but it is less efficient and might not be available on all platforms).
@see Today()
*/
static wxDateTime Now();
@ -861,31 +861,31 @@ public:
additional argument of wxString::const_iterator type in which, if it is not
@NULL, an iterator pointing to the end of the scanned string part is returned.
ParseFormat()
ParseDateTime()
ParseDate()
ParseTime()
ParseISODate()
ParseISOTime()
ParseISOCombined()
wxDateTime::ParseRfc822Date
Format()
FormatDate()
FormatTime()
FormatISOCombined()
FormatISODate()
FormatISOTime()
*/
@ -910,7 +910,7 @@ public:
calculations, date formatting and other things.
The possible values for @a country parameter are enumerated in
@ref overview_wxdatetime "wxDateTime constants section".
@see GetCountry()
*/
static void SetCountry(Country country);
@ -1046,43 +1046,43 @@ public:
Please note that although several function accept an extra @e Calendar
parameter, it is currently ignored as only the Gregorian calendar is
supported. Future versions will support other calendars.
SetCountry()
GetCountry()
IsWestEuropeanCountry()
GetCurrentYear()
ConvertYearToBC()
GetCurrentMonth()
IsLeapYear()
@ref getcenturystatic() GetCentury
GetNumberOfDays()
GetNumberOfDays()
GetMonthName()
GetWeekDayName()
GetAmPmStrings()
IsDSTApplicable()
GetBeginDST()
GetEndDST()
Now()
UNow()
Today()
*/
@ -1097,21 +1097,21 @@ public:
Please see the @ref overview_tdatetimezones "time zone overview" for more
information about time zones. Normally, these functions should be rarely used.
FromTimezone()
ToTimezone()
MakeTimezone()
MakeFromTimezone()
ToUTC()
MakeUTC()
GetBeginDST()
GetEndDST()
IsDST()
*/
@ -1132,7 +1132,7 @@ public:
/**
Returns the object corresponding to the midnight of the current day (i.e. the
same as Now(), but the time part is set to 0).
@see Now()
*/
static wxDateTime Today();
@ -1141,7 +1141,7 @@ public:
Returns the object corresponding to the current time including the
milliseconds if a function to get time with such precision is available on the
current platform (supported under most Unices and Win32).
@see Now()
*/
static wxDateTime UNow();
@ -1236,14 +1236,14 @@ public:
/**
Returns a date span object corresponding to one day.
@see Days()
*/
static wxDateSpan Day();
/**
Returns a date span object corresponding to the given number of days.
@see Day()
*/
static wxDateSpan Days(int days);
@ -1251,7 +1251,7 @@ public:
/**
Returns the number of days (only, that it not counting the weeks component!)
in this date span.
@see GetTotalDays()
*/
int GetDays() const;
@ -1264,14 +1264,14 @@ public:
/**
Returns the combined number of days in this date span, counting both weeks and
days. It still doesn't take neither months nor years into the account.
@see GetWeeks(), GetDays()
*/
int GetTotalDays() const;
/**
Returns the number of weeks in this date span.
@see GetTotalDays()
*/
int GetWeeks() const;
@ -1283,14 +1283,14 @@ public:
/**
Returns a date span object corresponding to one month.
@see Months()
*/
static wxDateSpan Month();
/**
Returns a date span object corresponding to the given number of months.
@see Month()
*/
static wxDateSpan Months(int mon);
@ -1310,7 +1310,7 @@ public:
//@{
/**
Changes the sign of this date span.
@see Negate()
*/
wxDateSpan Neg();
@ -1319,7 +1319,7 @@ public:
/**
Returns the date span with the opposite sign.
@see Neg()
*/
wxDateSpan Negate() const;
@ -1360,28 +1360,28 @@ public:
/**
Returns a date span object corresponding to one week.
@see Weeks()
*/
static wxDateSpan Week();
/**
Returns a date span object corresponding to the given number of weeks.
@see Week()
*/
static wxDateSpan Weeks(int weeks);
/**
Returns a date span object corresponding to one year.
@see Years()
*/
static wxDateSpan Year();
/**
Returns a date span object corresponding to the given number of years.
@see Year()
*/
static wxDateSpan Years(int years);
@ -1433,15 +1433,15 @@ public:
/**
GetSeconds()
GetMinutes()
GetHours()
GetDays()
GetWeeks()
GetValue()
*/
@ -1473,35 +1473,35 @@ public:
/**
Returns the string containing the formatted representation of the time span.
The following format specifiers are allowed after %:
H
number of @b Hours
M
number of @b Minutes
S
number of @b Seconds
l
number of mi@b lliseconds
D
number of @b Days
E
number of w@b Eeks
%
the percent character
Note that, for example, the number of hours in the description above is not
well defined: it can be either the total number of hours (for example, for a
time span of 50 hours this would be 50) or just the hour part of the time
@ -1643,15 +1643,15 @@ public:
/**
Add()
Subtract()
Multiply()
Negate()
Neg()
Abs()
*/
@ -1668,27 +1668,27 @@ public:
/**
Milliseconds()
Millisecond()
Seconds()
Second()
Minutes()
Minute()
Hours()
Hour()
Days()
Day()
Weeks()
Week()
*/
@ -1704,15 +1704,15 @@ public:
/**
IsNull()
IsPositive()
IsNegative()
IsEqualTo()
IsLongerThan()
IsShorterThan()
*/

4
interface/datstrm.h
View file

@ -34,7 +34,7 @@ public:
)
Constructs a datastream object from an output stream. Only write methods will
be available. The second form is only available in Unicode build of wxWidgets.
@param stream
The output stream.
@param conv
@ -169,7 +169,7 @@ public:
)
Constructs a datastream object from an input stream. Only read methods will
be available. The second form is only available in Unicode build of wxWidgets.
@param stream
The input stream.
@param conv

86
interface/dc.h
View file

@ -39,7 +39,7 @@ public:
Copy from a source DC to this DC, specifying the destination
coordinates, size of area to copy, source DC, source coordinates,
logical function, whether to use a bitmap mask, and mask source position.
@param xdest
Destination device context x position.
@param ydest
@ -61,8 +61,8 @@ public:
with the bitmap
selected into the source device context. The Windows implementation does
the following if MaskBlt cannot be used:
Creates a temporary bitmap and copies the destination area into it.
Copies the source area into the temporary bitmap using the specified
logical function.
@ -75,8 +75,8 @@ public:
and the background colour set to WHITE.
ORs the temporary bitmap with the destination area.
Deletes the temporary bitmap.
This sequence of operations ensures that the source's transparent area need
not be black,
and logical functions are supported.
@ -97,9 +97,9 @@ public:
and ysrc
will be assumed for the mask source position. Currently only implemented on
Windows.
@remarks There is partial support for Blit in wxPostScriptDC, under X.
@see StretchBlit(), wxMemoryDC, wxBitmap, wxMask
*/
bool Blit(wxCoord xdest, wxCoord ydest, wxCoord width,
@ -114,7 +114,7 @@ public:
Adds the specified point to the bounding box which can be retrieved with
MinX(), MaxX() and
MinY(), MaxY() functions.
@see ResetBoundingBox()
*/
void CalcBoundingBox(wxCoord x, wxCoord y);
@ -207,7 +207,7 @@ public:
//@{
/**
Draws a circle with the given centre and radius.
@see DrawEllipse()
*/
void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
@ -219,7 +219,7 @@ public:
Draws an ellipse contained in the rectangle specified either with the given top
left corner and the given size or directly. The current pen is used for the
outline and the current brush for filling the shape.
@see DrawCircle()
*/
void DrawEllipse(wxCoord x, wxCoord y, wxCoord width,
@ -358,7 +358,7 @@ public:
particular, a font different from @c wxNORMAL_FONT should be used as the
latter is not a TrueType font. @c wxSWISS_FONT is an example of a font
which is.
@see DrawText()
*/
void DrawRotatedText(const wxString& text, wxCoord x, wxCoord y,
@ -438,7 +438,7 @@ public:
/**
Returns the current background mode: @c wxSOLID or @c wxTRANSPARENT.
@see SetBackgroundMode()
*/
int GetBackgroundMode() const;
@ -466,7 +466,7 @@ public:
/**
Returns the depth (number of bits/pixel) of this DC.
@see wxDisplayDepth()
*/
int GetDepth() const;
@ -485,7 +485,7 @@ public:
is supported, the return value will either be @c wxLayout_LeftToRight or
@c wxLayout_RightToLeft. If RTL layout is not supported, the return value will
be @c wxLayout_Default.
@see SetLayoutDirection()
*/
wxLayoutDirection GetLayoutDirection() const;
@ -510,7 +510,7 @@ public:
If the optional parameter @a font is specified and valid, then it is used
for the text extent calculation. Otherwise the currently selected font is.
Note that this function works both with single-line and multi-line strings.
@see wxFont, SetFont(), GetPartialTextExtents(), GetTextExtent()
*/
void GetMultiLineTextExtent(const wxString& string, wxCoord* w,
@ -533,7 +533,7 @@ public:
various platforms have a native API function that is faster or more
accurate than the generic implementation then it should be used
instead.
@see GetMultiLineTextExtent(), GetTextExtent()
*/
bool GetPartialTextExtents(const wxString& text,
@ -559,14 +559,14 @@ public:
represent the maximum horizontal and vertical 'pixel' values used in your
application, the following code will scale the graphic to fit on the
printer page:
@b GetSize()
Returns a Wx::Size
@b GetSizeWH()
Returns a 2-element list
@c ( width, height )
*/
@ -599,7 +599,7 @@ public:
If the optional parameter @a font is specified and valid, then it is used
for the text extent calculation. Otherwise the currently selected font is.
Note that this function only works with single-line strings.
@see wxFont, SetFont(), GetPartialTextExtents(),
GetMultiLineTextExtent()
*/
@ -707,7 +707,7 @@ public:
/**
Resets the bounding box: after a call to this function, the bounding box
doesn't contain anything.
@see CalcBoundingBox()
*/
void ResetBoundingBox();
@ -716,7 +716,7 @@ public:
Sets the x and y axis orientation (i.e., the direction from lowest to
highest values on the axis). The default orientation is
x axis from left to right and y axis from top down.
@param xLeftRight
True to set the x axis orientation to the natural
left to right orientation, @false to invert it.
@ -758,7 +758,7 @@ public:
The clipping region is an area to which drawing is restricted. Possible uses
for the clipping region are for clipping text or for speeding up window redraws
when only a known area of the screen is damaged.
@see DestroyClippingRegion(), wxRegion
*/
void SetClippingRegion(wxCoord x, wxCoord y, wxCoord width,
@ -786,7 +786,7 @@ public:
/**
Sets the current layout direction for the device context. @a dir may be either
@c wxLayout_Default, @c wxLayout_LeftToRight or @c wxLayout_RightToLeft.
@see GetLayoutDirection()
*/
void SetLayoutDirection(wxLayoutDirection dir);
@ -799,7 +799,7 @@ public:
The possible values
and their meaning in terms of source and destination pixel values are
as follows:
The default is wxCOPY, which simply draws with the current colour.
The others combine the current colour and the background using a
logical operation. wxINVERT is commonly used for drawing rubber bands or
@ -819,26 +819,26 @@ public:
Drawing to a Windows printer device context uses the current mapping mode,
but mapping mode is currently ignored for PostScript output.
The mapping mode can be one of the following:
wxMM_TWIPS
Each logical unit is 1/20 of a point, or 1/1440 of
an inch.
wxMM_POINTS
Each logical unit is a point, or 1/72 of an inch.
wxMM_METRIC
Each logical unit is 1 mm.
wxMM_LOMETRIC
Each logical unit is 1/10 of a mm.
wxMM_TEXT
Each logical unit is 1 device pixel.
*/
void SetMapMode(int int);
@ -896,7 +896,7 @@ public:
coordinates, destination size, source DC, source coordinates,
size of source area to copy, logical function, whether to use a bitmap mask,
and mask source position.
@param xdest
Destination device context x position.
@param ydest
@ -922,8 +922,8 @@ public:
with the bitmap
selected into the source device context. The Windows implementation does
the following if MaskBlt cannot be used:
Creates a temporary bitmap and copies the destination area into it.
Copies the source area into the temporary bitmap using the specified
logical function.
@ -936,8 +936,8 @@ public:
and the background colour set to WHITE.
ORs the temporary bitmap with the destination area.
Deletes the temporary bitmap.
This sequence of operations ensures that the source's transparent area need
not be black,
and logical functions are supported.
@ -958,7 +958,7 @@ public:
and ysrc
will be assumed for the mask source position. Currently only implemented on
Windows.
@remarks There is partial support for Blit in wxPostScriptDC, under X.
*/
bool StretchBlit(wxCoord xdest, wxCoord ydest, wxCoord dstWidth,

2
interface/dcbuffer.h
View file

@ -49,7 +49,7 @@ public:
Init() methods later in order to use the object.
The other constructors initialize the object immediately and @c Init()
must not be called after using them.
@param dc
The underlying DC: everything drawn to this object will be
flushed to this DC when this object is destroyed. You may pass @NULL

2
interface/dcmemory.h
View file

@ -47,7 +47,7 @@ public:
Also, before using the updated bitmap data, make sure to select it out of
context first
(for example by selecting wxNullBitmap into the device context).
@see wxDC::DrawBitmap
*/
void SelectObject(wxBitmap& bitmap);

2
interface/dcscreen.h
View file

@ -53,7 +53,7 @@ public:
You might use this pair of functions when implementing a drag feature, for
example
as in the wxSplitterWindow implementation.
@remarks This function is probably obsolete since the X implementations
allow drawing directly on the screen now. However, the
fact that this function allows the screen to be

30
interface/dcsvg.h
View file

@ -162,7 +162,7 @@ public:
//@{
/**
Draws a circle with the given centre and radius.
@see wxDC::DrawEllipse
*/
void DrawCircle(wxCoord x, wxCoord y, wxCoord radius);
@ -174,7 +174,7 @@ public:
Draws an ellipse contained in the rectangle specified either with the given top
left corner and the given size or directly. The current pen is used for the
outline and the current brush for filling the shape.
@see wxDC::DrawCircle
*/
void DrawEllipse(wxCoord x, wxCoord y, wxCoord width,
@ -339,7 +339,7 @@ public:
/**
Returns the current background mode: @c wxSOLID or @c wxTRANSPARENT.
@see wxDC::SetBackgroundMode
*/
int GetBackgroundMode() const;
@ -500,7 +500,7 @@ public:
/**
Resets the bounding box: after a call to this function, the bounding box
doesn't contain anything.
@see wxDC::CalcBoundingBox
*/
void ResetBoundingBox();
@ -509,7 +509,7 @@ public:
Sets the x and y axis orientation (i.e., the direction from lowest to
highest values on the axis). The default orientation is the natural
orientation, e.g. x axis from left to right and y axis from bottom up.
@param xLeftRight
True to set the x axis orientation to the natural
left to right orientation, @false to invert it.
@ -586,26 +586,26 @@ public:
uses the current mapping mode, but mapping mode is currently ignored for
PostScript output.
The mapping mode can be one of the following:
wxMM_TWIPS
Each logical unit is 1/20 of a point, or 1/1440 of
an inch.
wxMM_POINTS
Each logical unit is a point, or 1/72 of an inch.
wxMM_METRIC
Each logical unit is 1 mm.
wxMM_LOMETRIC
Each logical unit is 1/10 of a mm.
wxMM_TEXT
Each logical unit is 1 pixel.
*/
void SetMapMode(int int);

52
interface/dialog.h
View file

@ -69,7 +69,7 @@ public:
//@{
/**
Constructor.
@param parent
Can be @NULL, a frame or another dialog box.
@param id
@ -89,7 +89,7 @@ public:
Used to associate a name with the window,
allowing the application user to set Motif resource values for
individual dialog boxes.
@see Create()
*/
wxDialog();
@ -125,7 +125,7 @@ public:
/**
Centres the dialog box on the display.
@param direction
May be wxHORIZONTAL, wxVERTICAL or wxBOTH.
*/
@ -200,10 +200,10 @@ public:
/**
Ends a modal dialog, passing a value to be returned from the ShowModal()
invocation.
@param retCode
The value that should be returned by ShowModal.
@see ShowModal(), GetReturnCode(), SetReturnCode()
*/
void EndModal(int retCode);
@ -211,7 +211,7 @@ public:
/**
Gets the identifier of the button which works like standard OK button in this
dialog.
@see SetAffirmativeId()
*/
int GetAffirmativeId() const;
@ -229,7 +229,7 @@ public:
/**
Gets the identifier of the button to map presses of @c ESC
button to.
@see SetEscapeId()
*/
int GetEscapeId() const;
@ -276,10 +276,10 @@ public:
/**
Gets the return code for this window.
@remarks A return code is normally associated with a modal dialog, where
ShowModal() returns a code to the application.
@see SetReturnCode(), ShowModal(), EndModal()
*/
int GetReturnCode();
@ -295,10 +295,10 @@ public:
/**
Iconizes or restores the dialog. Windows only.
@param iconize
If @true, iconizes the dialog box; if @false, shows and restores it.
@remarks Note that in Windows, iconization has no effect since dialog
boxes cannot be iconized. However, applications may
need to explicitly restore dialog boxes under Motif
@ -310,7 +310,7 @@ public:
/**
Returns @true if the dialog box is iconized. Windows only.
@remarks Always returns @false under Windows since dialogs cannot be
iconized.
*/
@ -339,10 +339,10 @@ public:
/**
The default handler for wxEVT_SYS_COLOUR_CHANGED.
@param event
The colour change event.
@remarks Changes the dialog's colour to conform to the current settings
(Windows only). Add an event table entry for your
dialog class if you wish the behaviour to be different
@ -350,7 +350,7 @@ public:
you do override this function, call wxEvent::Skip to
propagate the notification to child windows and
controls.
@see wxSysColourChangedEvent
*/
void OnSysColourChanged(wxSysColourChangedEvent& event);
@ -365,7 +365,7 @@ public:
the special OK button in the PocketPC title bar, an event with this id is
generated.
By default, the affirmative id is wxID_OK.
@see GetAffirmativeId(), SetEscapeId()
*/
void SetAffirmativeId(int id);
@ -387,7 +387,7 @@ public:
/**
Sets the icon for this dialog.
@param icon
The icon to associate with this dialog.
*/
@ -395,7 +395,7 @@ public:
/**
Sets the icons for this dialog.
@param icons
The icons to associate with this dialog.
*/
@ -422,7 +422,7 @@ public:
/**
Sets the adaptation mode, overriding the global adaptation flag. @a mode may be
one of the following values:
See also @ref overview_autoscrollingdialogs "Automatic scrolling dialogs" for
more on layout adaptation.
*/
@ -443,7 +443,7 @@ public:
Allows the programmer to specify whether the dialog box is modal (Show() blocks
control
until the dialog is hidden) or modeless (control returns immediately).
@param flag
If @true, the dialog will be modal, otherwise it will be modeless.
*/
@ -451,26 +451,26 @@ public:
/**
Sets the return code for this window.
@param retCode
The integer return code, usually a control identifier.
@remarks A return code is normally associated with a modal dialog, where
ShowModal() returns a code to the application.
The function EndModal() calls SetReturnCode.
@see GetReturnCode(), ShowModal(), EndModal()
*/
void SetReturnCode(int retCode);
/**
Hides or shows the dialog.
@param show
If @true, the dialog box is shown and brought to the front;
otherwise the box is hidden. If @false and the dialog is
modal, control is returned to the calling program.
@remarks The preferred way of dismissing a modal dialog is to use
EndModal().
*/
@ -480,7 +480,7 @@ public:
Shows a modal dialog. Program flow does not return until the dialog has been
dismissed with
EndModal().
@returns The return value is the value set with SetReturnCode().
*/
int ShowModal();

6
interface/dialup.h
View file

@ -43,7 +43,7 @@ public:
Cancel dialing the number initiated with Dial()
with async parameter equal to @true.
Note that this won't result in DISCONNECTED event being sent.
@see IsDialing()
*/
bool CancelDialing();
@ -116,7 +116,7 @@ public:
/**
Returns @true if (async) dialing is in progress.
@see Dial()
*/
bool IsDialing() const;
@ -149,7 +149,7 @@ public:
so, in general, the user should be allowed to override it. This function
allows to forcefully set the online status - whatever our internal
algorithm may think about it.
@see IsOnline()
*/
void SetOnlineStatus(bool isOnline = true);

2
interface/dirctrl.h
View file

@ -26,7 +26,7 @@ public:
//@{
/**
Main constructor.
@param parent
Parent window.
@param id

2
interface/dirdlg.h
View file

@ -37,7 +37,7 @@ public:
/**
Constructor. Use ShowModal() to show
the dialog.
@param parent
Parent window.
@param message

6
interface/display.h
View file

@ -22,7 +22,7 @@ class wxDisplay
public:
/**
Constructor, setting up a wxDisplay instance with the specified display.
@param index
The index of the display to use. This must be non-negative
and lower than the value returned by GetCount().
@ -77,7 +77,7 @@ public:
/**
Returns the index of the display on which the given point lies. Returns
@c wxNOT_FOUND if the point is not on any connected display.
@param pt
The point to locate.
*/
@ -88,7 +88,7 @@ public:
If the window is on more than one display it gets the display that overlaps the
window the most.
Returns @c wxNOT_FOUND if the window is not on any connected display.
@param win
The window to locate.
*/

30
interface/dnd.h
View file

@ -33,7 +33,7 @@ public:
/**
Override this function to receive dropped text.
@param x
The x coordinate of the mouse.
@param y
@ -108,14 +108,14 @@ public:
/**
Called when the mouse is being dragged over the drop target. By default,
this calls functions return the suggested return value @e def.
@param x
The x coordinate of the mouse.
@param y
The y coordinate of the mouse.
@param def
Suggested value for return value. Determined by SHIFT or CONTROL key states.
@returns Returns the desired operation or wxDragNone. This is used for
optical feedback from the side of the drop source,
typically in form of changing the icon.
@ -126,12 +126,12 @@ public:
/**
Called when the user drops a data object on the target. Return @false to veto
the operation.
@param x
The x coordinate of the mouse.
@param y
The y coordinate of the mouse.
@returns Return @true to accept the data, @false to veto the operation.
*/
virtual bool OnDrop(wxCoord x, wxCoord y);
@ -139,7 +139,7 @@ public:
/**
Called when the mouse enters the drop target. By default, this calls
OnDragOver().
@param x
The x coordinate of the mouse.
@param y
@ -147,7 +147,7 @@ public:
@param def
Suggested default for return value. Determined by SHIFT or CONTROL key
states.
@returns Returns the desired operation or wxDragNone. This is used for
optical feedback from the side of the drop source,
typically in form of changing the icon.
@ -195,7 +195,7 @@ public:
between wxMSW and wxGTK: these are cursors under Windows but icons for GTK.
You should use the macro wxDROP_ICON() in portable
programs instead of directly using either of these types.
@param win
The window which initiates the drag and drop operation.
@param iconCopy
@ -216,7 +216,7 @@ public:
//@}
/**
*/
~wxDropSource();
@ -224,13 +224,13 @@ public:
Do it (call this in response to a mouse button press, for example). This starts
the drag-and-drop operation which will terminate when the user releases the
mouse.
@param flags
If wxDrag_AllowMove is included in the flags, data may
be moved and not only copied (default). If wxDrag_DefaultMove is
specified (which includes the previous flag), this is even the default
operation
@returns Returns the operation requested by the user, may be wxDragCopy,
wxDragMove, wxDragLink, wxDragCancel or wxDragNone if
an error occurred.
@ -248,13 +248,13 @@ public:
in this function. It is called on each mouse move, so your implementation must
not be too
slow.
@param effect
The effect to implement. One of wxDragCopy, wxDragMove, wxDragLink and
wxDragNone.
@param scrolling
@true if the window is scrolling. MSW only.
@returns Return @false if you want default feedback, or @true if you
implement your own feedback. The return values is
ignored under GTK.
@ -263,7 +263,7 @@ public:
/**
Set the icon to use for a certain drag result.
@param res
The drag result to set the icon for.
@param cursor
@ -308,7 +308,7 @@ public:
/**
Override this function to receive dropped files.
@param x
The x coordinate of the mouse.
@param y

32
interface/docview.h
View file

@ -52,23 +52,23 @@ public:
wxTEMPLATE_VISIBLE The template may be displayed to the user in dialogs.
wxTEMPLATE_INVISIBLE The template may not be displayed to the user in dialogs.
wxDEFAULT_TEMPLATE_FLAGS Defined as wxTEMPLATE_VISIBLE.
@b Wx::DocTemplate-new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName, docClassInfo, viewClassInfo, flags
)
will construct document and view objects from the class information
@b Wx::DocTemplate-new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName, docClassName, viewClassName, flags
)
will construct document and view objects from perl packages
@b Wx::DocTemplate-new( docmgr, descr, filter, dir,
ext, docTypeName, viewTypeName )
@c Wx::DocTemplate::CreateDocument() and
@c Wx::DocTemplate::CreateView() must be overridden
*/
@ -367,7 +367,7 @@ public:
/**
Loads the file history from a config object.
@see wxConfig()
*/
void FileHistoryLoad(wxConfigBase& config);
@ -381,7 +381,7 @@ public:
/**
Saves the file history into a config object. This must be called
explicitly by the application.
@see wxConfig()
*/
void FileHistorySave(wxConfigBase& resourceFile);
@ -533,7 +533,7 @@ public:
Returns a document template by asking the user (if there is more than one
template).
This function is used in CreateDocument().
@param templates
Pointer to an array of templates from which to choose a desired template.
@param noTemplates
@ -542,7 +542,7 @@ public:
If more than one template is passed in in templates,
then this parameter indicates whether the list of templates that the user
will have to choose from is sorted or not when shown the choice box dialog.
Default is @false.
*/
wxDocTemplate* SelectDocumentType(wxDocTemplate** templates,
@ -556,7 +556,7 @@ public:
The dialog normally will not appear because the array of templates only contains
those relevant to the document in question, and often there will only be one
such.
@param templates
Pointer to an array of templates from which to choose a desired template.
@param noTemplates
@ -565,7 +565,7 @@ public:
If more than one template is passed in in templates,
then this parameter indicates whether the list of templates that the user
will have to choose from is sorted or not when shown the choice box dialog.
Default is @false.
*/
wxDocTemplate* SelectViewType(wxDocTemplate** templates,
@ -1372,7 +1372,7 @@ public:
/**
Returns the list of menus that are managed by this file history object.
@see UseMenu()
*/
const wxList GetMenus() const;
@ -1380,7 +1380,7 @@ public:
/**
Loads the file history from the given config object. This function should be
called explicitly by the application.
@see wxConfig()
*/
void Load(wxConfigBase& config);
@ -1398,7 +1398,7 @@ public:
/**
Saves the file history into the given config object. This must be called
explicitly by the application.
@see wxConfig()
*/
void Save(wxConfigBase& config);

4
interface/dragimag.h
View file

@ -54,7 +54,7 @@ public:
for
wxGenericDragImage, and can be used when the application
supplies DoDrawImage() and GetImageRect().
@param image
Icon or bitmap to be used as the drag image. The bitmap can
have a mask.
@ -93,7 +93,7 @@ public:
and Move() to show the image on the screen.
Call EndDrag() when the drag has finished.
Note that this call automatically calls CaptureMouse.
@param hotspot
The location of the drag position relative to the upper-left corner
of the image.

88
interface/dynarray.h
View file

@ -192,15 +192,15 @@ public:
/**
wxArray::Add
wxArray::AddAt
wxArray::Insert
wxArray::SetCount
WX_APPEND_ARRAY()
WX_PREPEND_ARRAY()
*/
@ -230,9 +230,9 @@ public:
never use wxBaseArray anyhow it shouldn't be a problem) and that you should not
derive your own classes from the array classes.
@ref wxArray::ctordef "wxArray default constructor"
@ref wxArray::ctorcopy "wxArray copy constructors and assignment operators"
@ref wxArray::dtor ~wxArray
*/
@ -349,25 +349,25 @@ public:
WX_DECLARE_OBJARRAY macros and must be fully declared before you use
WX_DEFINE_OBJARRAY macro.
WX_DEFINE_ARRAY()
WX_DEFINE_EXPORTED_ARRAY()
WX_DEFINE_USER_EXPORTED_ARRAY()
WX_DEFINE_SORTED_ARRAY()
WX_DEFINE_SORTED_EXPORTED_ARRAY()
WX_DEFINE_SORTED_USER_EXPORTED_ARRAY()
WX_DECLARE_EXPORTED_OBJARRAY()
WX_DECLARE_USER_EXPORTED_OBJARRAY()
WX_DEFINE_OBJARRAY()
WX_DEFINE_EXPORTED_OBJARRAY()
WX_DEFINE_USER_EXPORTED_OBJARRAY()
To slightly complicate the matters even further, the operator - defined by
default for the array iterators by these macros only makes sense if the array
@ -375,33 +375,33 @@ public:
provokes warnings from some compilers and to avoid them you should use the
@c _PTR versions of the macros above. For example, to define an array of
pointers to @c double you should use:
Note that the above macros are generally only useful for
wxObject types. There are separate macros for declaring an array of a simple
type,
such as an int.
The following simple types are supported:
int
long
size_t
double
To create an array of a simple type, simply append the type you want in CAPS to
the array definition.
For example, for an integer array, you'd use one of the following variants:
WX_DEFINE_ARRAY_INT()
WX_DEFINE_EXPORTED_ARRAY_INT()
WX_DEFINE_USER_EXPORTED_ARRAY_INT()
WX_DEFINE_SORTED_ARRAY_INT()
WX_DEFINE_SORTED_EXPORTED_ARRAY_INT()
WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT()
*/
@ -420,7 +420,7 @@ public:
going to put in the array and will prevent the array code from reallocating the
memory more times than needed.
wxArray::Alloc
wxArray::Shrink
*/
@ -430,11 +430,11 @@ public:
retrieve them - possibly using just the C array indexing [] operator which
does exactly the same as wxArray::Item method.
wxArray::GetCount
wxArray::IsEmpty
wxArray::Item
wxArray::Last
*/
@ -447,7 +447,7 @@ public:
Detach() if you don't want this to happen. On the
other hand, when an object is removed from a wxArray nothing happens - you
should delete it manually if required:
See also WX_CLEAR_ARRAY() macro which deletes all
elements of a wxArray (supposed to contain pointers).
*/
@ -459,7 +459,7 @@ public:
Detach() if you don't want this to happen. On
the other hand, when an object is removed from a wxArray nothing happens -
you should delete it manually if required:
See also WX_CLEAR_ARRAY() macro which deletes all
elements of a wxArray (supposed to contain pointers).
*/
@ -467,22 +467,22 @@ public:
/**
WX_CLEAR_ARRAY()
wxArray::Empty
wxArray::Clear
wxArray::RemoveAt
wxArray::Remove
*/
/**
wxArray::Index
wxArray::IndexForInsert
wxArray::Sort
*/
@ -493,7 +493,7 @@ public:
@e count. If the array has already @a count or more items, nothing is
done. Otherwise, @c count - GetCount() elements are added and initialized to
the value @e defval.
@see wxArray::GetCount
*/
void SetCount(size_t count);
@ -508,7 +508,7 @@ public:
/**
The notation CMPFUNCT should be read as if we had the following declaration:
where @e T is the type of the array elements. I.e. it is a function returning
@e int which is passed two arguments of type @e T *.
Sorts the array using the specified compare function: this function should
@ -538,7 +538,7 @@ public:
a DLL under Windows and array needs to be visible outside the DLL. The third is
needed for exporting an array from a user DLL.
Example:
You must use WX_DEFINE_OBJARRAY() macro to define
the array class - otherwise you would get link errors.
*/
@ -554,7 +554,7 @@ public:
a DLL under Windows and array needs to be visible outside the DLL. The third is
needed for exporting an array from a user DLL.
Example:
Note that wxWidgets predefines the following standard array classes: @b
wxArrayInt,
@b wxArrayLong, @b wxArrayShort, @b wxArrayDouble, @b wxArrayPtrVoid.
@ -589,7 +589,7 @@ public:
a DLL under Windows and array needs to be visible outside the DLL. The third is
needed for exporting an array from a user DLL.
Example:
You will have to initialize the objects of this class by passing a comparison
function to the array object constructor like this:
*/

60
interface/dynlib.h
View file

@ -24,14 +24,14 @@ class wxDynamicLibraryDetails
public:
/**
Retrieves the load address and the size of this module.
@param addr
the pointer to the location to return load address in, may be
@NULL
@param len
pointer to the location to return the size of this module in
memory in, may be @NULL
@returns @true if the load address and module size were retrieved, @false
if this information is not available.
*/
@ -150,7 +150,7 @@ public:
function name.
Returned value will be @NULL if the symbol was not found in the DLL or if
an error occurred.
@param dllHandle
Valid handle previously returned by
LoadLibrary
@ -168,7 +168,7 @@ public:
Returns a handle to the loaded DLL. Use @a success parameter to test if it
is valid. If the handle is valid, the library must be unloaded later with
UnloadLibrary().
@param libname
Name of the shared object to load.
@param success
@ -218,16 +218,16 @@ public:
it adds a @c ".dll" extension under Windows and @c "lib" prefix and
@c ".so", @c ".sl" or maybe @c ".dylib" extension under Unix.
The possible values for @a cat are:
wxDL_LIBRARY
normal library
wxDL_MODULE
a loadable module or plugin
@see CanonicalizePluginName()
*/
static wxString CanonicalizeName(const wxString& name,
@ -240,14 +240,14 @@ public:
to the name to ensure that the plugin which is going to be loaded will be
compatible with the main program.
The possible values for @a cat are:
wxDL_PLUGIN_GUI
plugin which uses GUI classes (default)
wxDL_PLUGIN_BASE
plugin which only uses wxBase
*/
static wxString CanonicalizePluginName(const wxString& name,
@ -269,7 +269,7 @@ public:
/**
Returns pointer to symbol @a name in the library or @NULL if the library
contains no such symbol.
@see wxDYNLIB_FUNCTION()
*/
void* GetSymbol(const wxString& name) const;
@ -289,7 +289,7 @@ public:
Returns @true if the symbol with the given @a name is present in the dynamic
library, @false otherwise. Unlike GetSymbol(),
this function doesn't log an error message if the symbol is not found.
@wxsince{2.5.4}
*/
bool HasSymbol(const wxString& name) const;
@ -312,33 +312,33 @@ public:
/**
Loads DLL with the given @a name into memory. The @a flags argument can
be a combination of the following bits:
wxDL_LAZY
equivalent of RTLD_LAZY under Unix, ignored elsewhere
wxDL_NOW
equivalent of RTLD_NOW under Unix, ignored elsewhere
wxDL_GLOBAL
equivalent of RTLD_GLOBAL under Unix, ignored elsewhere
wxDL_VERBATIM
don't try to append the appropriate extension to
the library name (this is done by default).
wxDL_DEFAULT
default flags, same as wxDL_NOW currently
wxDL_QUIET
don't log an error message if the library couldn't be
loaded.
Returns @true if the library was successfully loaded, @false otherwise.
*/
bool Load(const wxString& name, int flags = wxDL_DEFAULT);

4
interface/editlbox.h
View file

@ -37,7 +37,7 @@ public:
//@{
/**
Constructor, creating and showing a list box.
@param parent
Parent window. Must not be @NULL.
@param id
@ -54,7 +54,7 @@ public:
Window style. See wxEditableListBox.
@param name
Window name.
@see Create()
*/
wxEditableListBox();

12
interface/encconv.h
View file

@ -75,7 +75,7 @@ public:
wxPLATFORM_CURRENT
wxPLATFORM_CURRENT means the platform this binary was compiled for.
Examples:
Equivalence is defined in terms of convertibility:
two encodings are equivalent if you can convert text between
then without losing information (it may - and will - happen
@ -100,19 +100,19 @@ public:
it more than once in order to switch to another conversion.
@e Method affects behaviour of Convert() in case input character
cannot be converted because it does not exist in output encoding:
@b wxCONVERT_STRICT
follow behaviour of GNU Recode -
just copy unconvertible characters to output and don't change them
(its integer value will stay the same)
@b wxCONVERT_SUBSTITUTE
try some (lossy) substitutions
- e.g. replace unconvertible latin capitals with acute by ordinary
capitals, replace en-dash or em-dash by '-' etc.
Both modes guarantee that output string will have same length
as input string.
*/

136
interface/event.h
View file

@ -121,12 +121,12 @@ public:
Notice that this function is easier to use correctly than, for example,
ControlDown() because when using the latter you
also have to remember to test that none of the other modifiers is pressed:
and forgetting to do it can result in serious program bugs (e.g. program not
working with European keyboard layout where ALTGR key which is seen by
the program as combination of CTRL and ALT is used). On the
other hand, you can simply write
with this function.
*/
int GetModifiers() const;
@ -277,7 +277,7 @@ public:
/**
Returns @true if the event was a down event from the specified button (or any
button).
@param button
Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
indicate any button down event.
@ -286,7 +286,7 @@ public:
/**
Returns @true if the specified button (or any button) was in a down state.
@param button
Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
indicate any button down event.
@ -296,7 +296,7 @@ public:
/**
Returns @true if the event was an up event from the specified button (or any
button).
@param button
Can be wxJOY_BUTTONn where n is 1, 2, 3 or 4; or wxJOY_BUTTON_ANY to
indicate any button down event.
@ -523,7 +523,7 @@ public:
the interval is set to 0; so update events will be sent as
often as possible. You can reduce the frequency that events
are sent by changing the mode and/or setting an update interval.
@see ResetUpdateTime(), SetUpdateInterval(),
SetMode()
*/
@ -604,7 +604,7 @@ public:
current time. It is assumed that update events are
normally sent in idle time, so this is called at the end of
idle processing.
@see CanUpdate(), SetUpdateInterval(),
SetMode()
*/
@ -748,7 +748,7 @@ class wxMouseEvent : public wxEvent
public:
/**
Constructor. Valid event types are:
@b wxEVT_ENTER_WINDOW
@b wxEVT_LEAVE_WINDOW
@b wxEVT_LEFT_DOWN
@ -823,29 +823,29 @@ public:
/**
Returns @true if the identified mouse button is changing state. Valid
values of @a button are:
@c wxMOUSE_BTN_LEFT
check if left button was pressed
@c wxMOUSE_BTN_MIDDLE
check if middle button was pressed
@c wxMOUSE_BTN_RIGHT
check if right button was pressed
@c wxMOUSE_BTN_AUX1
check if the first extra button was pressed
@c wxMOUSE_BTN_AUX2
check if the second extra button was pressed
@c wxMOUSE_BTN_ANY
check if any button was pressed
*/
bool Button(int button);
@ -877,7 +877,7 @@ public:
/**
Same as MetaDown() under Mac, same as
ControlDown() elsewhere.
@see wxKeyEvent::CmdDown
*/
bool CmdDown() const;
@ -889,7 +889,7 @@ public:
/**
Returns @true if this was a dragging event (motion while a button is depressed).
@see Moving()
*/
bool Dragging();
@ -915,7 +915,7 @@ public:
Currently this function is implemented only in wxMac and returns -1 for the
other platforms (you can still distinguish simple clicks from double-clicks as
they generate different kinds of events however).
@wxsince{2.9.0}
*/
int GetClickCount() const;
@ -1512,7 +1512,7 @@ class wxChildFocusEvent : public wxCommandEvent
public:
/**
Constructor.
@param win
The direct child which is (or which contains the window which is) receiving
the focus.
@ -1650,25 +1650,25 @@ public:
/**
Returns the origin of the help event which is one of the following values:
@b Origin_Unknown
Unrecognized event source.
@b Origin_Keyboard
Event generated by @c F1 key press.
@b Origin_HelpButton
Event generated by
wxContextHelp or using the "?" title bur button under
MS Windows.
The application may handle events generated using the keyboard or mouse
differently, e.g. by using wxGetMousePosition()
for the mouse events.
@see SetOrigin()
*/
wxHelpEvent::Origin GetOrigin() const;
@ -1681,7 +1681,7 @@ public:
/**
Set the help event origin, only used internally by wxWidgets normally.
@see GetOrigin()
*/
void SetOrigin(wxHelpEvent::Origin origin);
@ -1780,7 +1780,7 @@ public:
the update mode is initially wxIDLE_PROCESS_ALL. You can change the mode
to only send idle events to windows with the wxWS_EX_PROCESS_IDLE extra window
style set.
@see SetMode()
*/
static bool CanSend(wxWindow* window);
@ -1796,7 +1796,7 @@ public:
/**
Returns @true if the OnIdle function processing this event requested more
processing time.
@see RequestMore()
*/
bool MoreRequested() const;
@ -1811,7 +1811,7 @@ public:
during OnIdle, then the application will remain in a passive event loop (not
calling OnIdle) until a
new event is posted to the application by the windowing system.
@see MoreRequested()
*/
void RequestMore(bool needMore = true);
@ -2221,10 +2221,10 @@ public:
/**
This function posts an event to be processed later.
@param event
Event to add to process queue.
@remarks The difference between sending an event (using the ProcessEvent
method) and posting it is that in the first case the
event is processed before the function returns, while
@ -2240,7 +2240,7 @@ public:
type. This
is an alternative to the use of static event tables. See the 'event' or the old
'dynamic' sample for usage.
@param id
The identifier (or first of the identifier range) to be
associated with the event handler function. For the version not taking this
@ -2283,7 +2283,7 @@ public:
added
using the Connect() method. There is no way
to disconnect functions connected using the (static) event tables.
@param id
The identifier (or first of the identifier range) associated with the event
handler function.
@ -2317,32 +2317,32 @@ public:
/**
Gets user-supplied client data.
@remarks Normally, any extra data the programmer wishes to associate with
the object should be made available by deriving a new
class with new data members.
@see SetClientData()
*/
void* GetClientData();
/**
Get a pointer to the user-supplied client data object.
@see SetClientObject(), wxClientData
*/
wxClientData* GetClientObject() const;
/**
Returns @true if the event handler is enabled, @false otherwise.
@see SetEvtHandlerEnabled()
*/
bool GetEvtHandlerEnabled();
/**
Gets the pointer to the next handler in the chain.
@see SetNextHandler(), GetPreviousHandler(),
SetPreviousHandler(), wxWindow::PushEventHandler,
wxWindow::PopEventHandler
@ -2351,7 +2351,7 @@ public:
/**
Gets the pointer to the previous handler in the chain.
@see SetPreviousHandler(), GetNextHandler(),
SetNextHandler(), wxWindow::PushEventHandler,
wxWindow::PopEventHandler
@ -2361,18 +2361,18 @@ public:
/**
Processes an event, searching event tables and calling zero or more suitable
event handler function(s).
@param event
Event to process.
@returns @true if a suitable event handler function was found and
executed, and the function did not call wxEvent::Skip.
@remarks Normally, your application would not call this function: it is
called in the wxWidgets implementation to dispatch
incoming user interface events to the framework (and
application).
@see SearchEventTable()
*/
virtual bool ProcessEvent(wxEvent& event);
@ -2382,13 +2382,13 @@ public:
and handles any exceptions that occur in the process. If an exception is
thrown in event handler, wxApp::OnExceptionInMainLoop
is called.
@param event
Event to process.
@returns @true if the event was processed, @false if no handler was found
or an exception was thrown.
@see wxWindow::HandleWindowEvent
*/
bool SafelyProcessEvent(wxEvent& event);
@ -2397,18 +2397,18 @@ public:
Searches the event table, executing an event handler function if an appropriate
one
is found.
@param table
Event table to be searched.
@param event
Event to be matched against an event table entry.
@returns @true if a suitable event handler function was found and
executed, and the function did not call wxEvent::Skip.
@remarks This function looks through the object's event table and tries
to find an entry that will match the event.
@see ProcessEvent()
*/
virtual bool SearchEventTable(wxEventTable& table,
@ -2416,47 +2416,47 @@ public:
/**
Sets user-supplied client data.
@param data
Data to be associated with the event handler.
@remarks Normally, any extra data the programmer wishes to associate with
the object should be made available by deriving a new
class with new data members. You must not call this
method and SetClientObject on the same class - only one
of them.
@see GetClientData()
*/
void SetClientData(void* data);
/**
Set the client data object. Any previous object will be deleted.
@see GetClientObject(), wxClientData
*/
void SetClientObject(wxClientData* data);
/**
Enables or disables the event handler.
@param enabled
@true if the event handler is to be enabled, @false if it is to be disabled.
@remarks You can use this function to avoid having to remove the event
handler from the chain, for example when implementing a
dialog editor and changing from edit to test mode.
@see GetEvtHandlerEnabled()
*/
void SetEvtHandlerEnabled(bool enabled);
/**
Sets the pointer to the next handler.
@param handler
Event handler to be set as the next handler.
@see GetNextHandler(), SetPreviousHandler(),
GetPreviousHandler(), wxWindow::PushEventHandler,
wxWindow::PopEventHandler
@ -2465,7 +2465,7 @@ public:
/**
Sets the pointer to the previous handler.
@param handler
Event handler to be set as the previous handler.
*/
@ -2767,7 +2767,7 @@ public:
/**
Returns @true if the cursor specified by this event is a valid cursor.
@remarks You cannot specify wxNullCursor with this event, as it is not
considered a valid cursor.
*/

20
interface/ffile.h
View file

@ -27,7 +27,7 @@ public:
//@{
/**
Opens a file with the given file pointer, which has already been opened.
@param filename
The filename.
@param mode
@ -77,7 +77,7 @@ public:
read.
Also note that this method may only be called for opened files and may crash if
the file is not opened.
@see IsOpened()
*/
bool Eof() const;
@ -87,7 +87,7 @@ public:
@c ferror() function.
Please note that this method may only be called for opened files and may crash
if the file is not opened.
@see IsOpened()
*/
@ -116,7 +116,7 @@ public:
/**
Opens the file, returning @true if successful.
@param filename
The filename.
@param mode
@ -127,12 +127,12 @@ public:
/**
Reads the specified number of bytes into a buffer, returning the actual number
read.
@param buffer
A buffer to receive the data.
@param count
The number of bytes to read.
@returns The number of bytes read.
*/
size_t Read(void* buffer, size_t count);
@ -140,20 +140,20 @@ public:
/**
)
Reads the entire contents of the file into a string.
@param str
String to read data into.
@param conv
Conversion object to use in Unicode build; by default supposes
that file contents is encoded in UTF-8.
@returns @true if file was read successfully, @false otherwise.
*/
bool ReadAll(wxString* str);
/**
Seeks to the specified position and returns @true on success.
@param ofs
Offset to seek to.
@param mode
@ -165,7 +165,7 @@ public:
Moves the file pointer to the specified number of bytes before the end of the
file
and returns @true on success.
@param ofs
Number of bytes before the end of the file.
*/

12
interface/file.h
View file

@ -147,7 +147,7 @@ public:
/**
Associates the file with the given file descriptor, which has already been
opened.
@param filename
The filename.
@param mode
@ -254,7 +254,7 @@ public:
/**
Opens the file, returning @true if successful.
@param filename
The filename.
@param mode
@ -275,12 +275,12 @@ public:
/**
Seeks to the specified position.
@param ofs
Offset to seek to.
@param mode
One of wxFromStart, wxFromEnd, wxFromCurrent.
@returns The actual offset position achieved, or wxInvalidOffset on
failure.
*/
@ -291,10 +291,10 @@ public:
Moves the file pointer to the specified number of bytes relative to the end of
the file. For example, @c SeekEnd(-5) would position the pointer 5
bytes before the end.
@param ofs
Number of bytes before the end of the file.
@returns The actual offset position achieved, or wxInvalidOffset on
failure.
*/

6
interface/fileconf.h
View file

@ -32,7 +32,7 @@ public:
)
Read the config data from the specified stream instead of the associated file,
as usual.
@see Save()
*/
wxFileConfig(wxInputStream& is);
@ -67,7 +67,7 @@ public:
after saving it successfully, the dirty flag is reset so no changes will be
written back to the file this object is associated with until you change its
contents again.
@see wxConfigBase::Flush
*/
bool Save(wxOutputStream& os);
@ -78,7 +78,7 @@ public:
some sensitive information, such as passwords), you could use
@c SetUmask(0077).
This function doesn't do anything on non-Unix platforms.
@see wxCHANGE_UMASK()
*/
void SetUmask(int mode);

10
interface/filectrl.h
View file

@ -61,7 +61,7 @@ public:
Initial size.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/
@ -106,7 +106,7 @@ public:
function should only be used with the controls having the @c wxFC_MULTIPLE
style,
use GetFilename() for the others.
@remarks filenames is emptied first.
*/
void GetFilenames(wxArrayString& filenames) const;
@ -127,7 +127,7 @@ public:
Fills the array @a paths with the full paths of the files chosen. This
function should be used with the controls having the @c wxFC_MULTIPLE style,
use GetPath() otherwise.
@remarks paths is emptied first.
*/
void GetPaths(wxArrayString& paths) const;
@ -139,14 +139,14 @@ public:
/**
Sets(changes) the current directory displayed in the control.
@returns Returns @true on success, @false otherwise.
*/
bool SetDirectory(const wxString& directory);
/**
Selects a certain file.
@returns Returns @true on success, @false otherwise
*/
bool SetFilename(const wxString& filename);

2
interface/filedlg.h
View file

@ -49,7 +49,7 @@ class wxFileDialog : public wxDialog
public:
/**
Constructor. Use ShowModal() to show the dialog.
@param parent
Parent window.
@param message

262
interface/filename.h
View file

@ -120,7 +120,7 @@ public:
/**
Makes this object refer to the current working directory on the specified
volume (or current volume if @a volume is empty).
@see GetCwd()
*/
static void AssignCwd(const wxString& volume = wxEmptyString);
@ -154,7 +154,7 @@ public:
/**
Removes the extension from the file name resulting in a
file name with no trailing dot.
@see SetExt(), SetEmptyExt()
*/
void SetClearExt();
@ -172,12 +172,12 @@ public:
If @a fileTemp is @NULL, the file is only created, but not opened.
Under Unix, the temporary file will have read and write permissions for the
owner only to minimize the security problems.
@param prefix
Prefix to use for the temporary file name construction
@param fileTemp
The file to open or @NULL to just get the name
@returns The full temporary file name or an empty string on error.
*/
static wxString CreateTempFileName(const wxString& prefix,
@ -202,37 +202,37 @@ public:
These functions allow to examine and modify the individual directories of the
path:
AppendDir()
InsertDir()
GetDirCount()
PrependDir()
RemoveDir()
RemoveLastDir()
To change the components of the file name individually you can use the
following functions:
GetExt()
GetName()
GetVolume()
HasExt()
HasName()
HasVolume()
SetExt()
ClearExt()
SetEmptyExt()
SetName()
SetVolume()
*/
@ -240,21 +240,21 @@ public:
/**
You can initialize a wxFileName instance using one of the following functions:
@ref wxfilename() "wxFileName constructors"
Assign()
AssignCwd()
AssignDir()
AssignHomeDir()
@ref assigntempfilename() AssignHomeTempFileName
DirName()
FileName()
@ref operatorassign() "operator ="
*/
@ -300,13 +300,13 @@ public:
or @ref operatorequal() "operator ==".
For testing basic access modes, you can use:
IsDirWritable()
IsDirReadable()
IsFileWritable()
IsFileReadable()
IsFileExecutable()
*/
@ -314,7 +314,7 @@ public:
//@{
/**
Returns @true if the file with this name exists.
@see DirExists()
*/
bool FileExists();
@ -332,10 +332,10 @@ public:
Retrieves the value of the current working directory on the specified volume. If
the volume is empty, the program's current working directory is returned for the
current volume.
@returns The string containing the current working directory or an empty
string on error.
@see AssignCwd()
*/
static wxString GetCwd(const wxString& volume = "");
@ -414,7 +414,7 @@ public:
/**
Returns the name part of the filename (without extension).
@see GetFullName()
*/
wxString GetName() const;
@ -422,15 +422,15 @@ public:
/**
Returns the path part of the filename (without the name or extension). The
possible flags values are:
@b wxPATH_GET_VOLUME
Return the path with the volume (does
nothing for the filename formats without volumes), otherwise the path without
volume part is returned.
@b wxPATH_GET_SEPARATOR
Return the path with the trailing
separator, if this flag is not given there will be no separator at the end of
the path.
@ -443,7 +443,7 @@ public:
@c wxPATH_DOS there is only one path separator anyhow, but for DOS there
are two of them and the native one, i.e. the backslash is returned by this
method.
@see GetPathSeparators()
*/
static wxChar GetPathSeparator(wxPathFormat format = wxPATH_NATIVE);
@ -453,7 +453,7 @@ public:
formats but @c wxPATH_DOS this string contains only one character but for
DOS and Windows both @c '/' and @c '\' may be used as
separators.
@see GetPathSeparator()
*/
static wxString GetPathSeparators(wxPathFormat format = wxPATH_NATIVE);
@ -510,7 +510,7 @@ public:
file specified by GetFullPath().
Any of the pointers may be @NULL if the corresponding time is not
needed.
@returns @true on success, @false if we failed to retrieve the times.
*/
bool GetTimes(wxDateTime* dtAccess, wxDateTime* dtMod,
@ -662,7 +662,7 @@ public:
Make the file name absolute. This is a shortcut for
@c wxFileName::Normalize(wxPATH_NORM_DOTS | wxPATH_NORM_ABSOLUTE |
wxPATH_NORM_TILDE, cwd, format).
@see MakeRelativeTo(), Normalize(), IsAbsolute()
*/
bool MakeAbsolute(const wxString& cwd = wxEmptyString,
@ -670,22 +670,22 @@ public:
/**
This function tries to put this file name in a form relative to
@param pathBase.
In other words, it returns the file name which should be used to access this
file if the current directory were pathBase.
pathBase
the directory to use as root, current directory is used by
default
@param format
the file name format, native by default
@returns @true if the file name has been changed, @false if we failed to do
anything with it (currently this only happens if the
file name is on a volume different from the volume
specified by pathBase).
@see Normalize()
*/
bool MakeRelativeTo(const wxString& pathBase = wxEmptyString,
@ -701,7 +701,7 @@ public:
if the flags contain wxPATH_MKDIR_FULL flag,
try to create each directory in the path and also don't return an error
if the target directory already exists.
@returns Returns @true if the directory was successfully created, @false
otherwise.
*/
@ -714,106 +714,106 @@ public:
Normalize the path. With the default flags value, the path will be
made absolute, without any ".." and "." and all environment
variables will be expanded in it.
@param flags
The kind of normalization to do with the file name. It can be
any or-combination of the following constants:
wxPATH_NORM_ENV_VARS
replace env vars with their values
wxPATH_NORM_DOTS
squeeze all .. and . when possible; if there are too many .. and thus they
cannot be all removed, @false will be returned
wxPATH_NORM_CASE
if filesystem is case insensitive, transform to lower case
wxPATH_NORM_ABSOLUTE
make the path absolute prepending cwd
wxPATH_NORM_LONG
make the path the long form
wxPATH_NORM_SHORTCUT
resolve if it is a shortcut (Windows only)
wxPATH_NORM_TILDE
replace ~ and ~user (Unix only)
wxPATH_NORM_ALL
all of previous flags except wxPATH_NORM_CASE
@param cwd
If not empty, this directory will be used instead of current
working directory in normalization (see wxPATH_NORM_ABSOLUTE).
@param format
The file name format to use when processing the paths, native by default.
@returns @true if normalization was successfully or @false otherwise.
*/
bool Normalize(int flags = wxPATH_NORM_ALL,
@ -827,15 +827,15 @@ public:
one day (so it is really the access date and not time). The access time may be
updated when the file is executed or not depending on the platform.
GetModificationTime()
GetTimes()
SetTimes()
Touch()
Other file system operations functions are:
Mkdir()
Rmdir()
*/
@ -848,7 +848,7 @@ public:
/**
Removes the specified directory component from the path.
@see GetDirCount()
*/
void RemoveDir(size_t pos);
@ -884,7 +884,7 @@ public:
Sets the extension of the file name to be an empty extension.
This is different from having no extension at all as the file
name will have a trailing dot after a call to this method.
@see SetExt(), ClearExt()
*/
void SetEmptyExt();
@ -894,7 +894,7 @@ public:
as the extension will remove the extension resulting in a file
name without a trailing dot, unlike a call to
SetEmptyExt().
@see SetEmptyExt(), ClearExt()
*/
void SetExt(const wxString& ext);
@ -906,7 +906,7 @@ public:
/**
Sets the name part (without extension).
@see SetFullName()
*/
void SetName(const wxString& name);
@ -962,7 +962,7 @@ public:
/**
Splits the given @a fullpath into the volume part (which may be empty) and
the pure path part, not containing any volume.
@see SplitPath()
*/
static void SplitVolume(const wxString& fullpath,

4
interface/filepicker.h
View file

@ -87,7 +87,7 @@ public:
Validator which can be used for additional date checks.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/
@ -201,7 +201,7 @@ public:
Validator which can be used for additional date checks.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/

16
interface/filesys.h
View file

@ -42,7 +42,7 @@ public:
@b Caution! Unless @a is_dir is @true the @a location parameter
is not the directory name but the name of the file in this directory. All these
commands change the path to "dir/subdir/":
@param location
the new location. Its meaning depends on the value of is_dir
@param is_dir
@ -53,7 +53,7 @@ public:
/**
Converts filename into URL.
@see URLToFileName(), wxFileName
*/
static wxString FileNameToURL(wxFileName filename);
@ -64,7 +64,7 @@ public:
@e path. If the file is found in any directory, returns @true and the full
path of the file in @e str, otherwise returns @false and doesn't modify
@e str.
@param str
Receives the full path of the file, must not be @NULL
@param path
@ -107,7 +107,7 @@ public:
absolute path. Note that the user is responsible for deleting the returned
wxFSFile.
@a flags can be one or more of the following bit values ored together:
A stream opened with just the default @e wxFS_READ flag may
or may not be seekable depending on the underlying source.
Passing @e wxFS_READ | wxFS_SEEKABLE for @a flags will
@ -150,7 +150,7 @@ class wxFSFile : public wxObject
public:
/**
Constructor. You probably won't use it. See Notes for details.
@param stream
The input stream that will be used to access data
@param location
@ -177,7 +177,7 @@ public:
/**
Returns anchor (if present). The term of @b anchor can be easily
explained using few examples:
Usually an anchor is presented only if the MIME type is 'text/html'.
But it may have some meaning with other files;
for example myanim.avi#200 may refer to position in animation
@ -253,7 +253,7 @@ public:
Returns @true if the handler is able to open this file. This function doesn't
check whether the file exists or not, it only checks if it knows the protocol.
Example:
Must be overridden in derived handlers.
*/
virtual bool CanOpen(const wxString& location);
@ -313,7 +313,7 @@ public:
/**
Opens the file and returns wxFSFile pointer or @NULL if failed.
Must be overridden in derived handlers.
@param fs
Parent FS (the FS from that OpenFile was called). See ZIP handler
for details of how to use it.

554
interface/font.h
View file

@ -41,7 +41,7 @@ public:
//@{
/**
Creates a font object with the specified attributes.
@param pointSize
Size in points.
@param pixelSize
@ -53,123 +53,123 @@ public:
@param family
Font family, a generic way of referring to fonts without specifying actual
facename. One of:
wxFONTFAMILY_DEFAULT
Chooses a default font.
wxFONTFAMILY_DECORATIVE
A decorative font.
wxFONTFAMILY_ROMAN
A formal, serif font.
wxFONTFAMILY_SCRIPT
A handwriting font.
wxFONTFAMILY_SWISS
A sans-serif font.
wxFONTFAMILY_MODERN
A fixed pitch font.
wxFONTFAMILY_TELETYPE
A teletype font.
@param style
One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
@param weight
Font weight, sometimes also referred to as font boldness. One of:
wxFONTWEIGHT_NORMAL
Normal font.
wxFONTWEIGHT_LIGHT
Light font.
wxFONTWEIGHT_BOLD
Bold font.
@param underline
The value can be @true or @false. At present this has an effect on Windows
@ -180,75 +180,75 @@ public:
a default typeface will be chosen based on the family.
@param encoding
An encoding which may be one of
wxFONTENCODING_SYSTEM
Default system encoding.
wxFONTENCODING_DEFAULT
Default application encoding: this
is the encoding set by calls to
SetDefaultEncoding and which may be set to,
say, KOI8 to create all fonts by default with KOI8 encoding. Initially, the
default application encoding is the same as default system encoding.
wxFONTENCODING_ISO8859_1...15
ISO8859 encodings.
wxFONTENCODING_KOI8
The standard Russian encoding for Internet.
wxFONTENCODING_CP1250...1252
Windows encodings similar to ISO8859 (but not identical).
If the specified encoding isn't available, no font is created
(see also font encoding overview).
@remarks If the desired font does not exist, the closest match will be
chosen. Under Windows, only scalable TrueType fonts are
used.
@ -271,7 +271,7 @@ public:
Destructor.
See @ref overview_refcountdestruct "reference-counted object destruction" for
more info.
@remarks Although all remaining fonts are deleted when the application
exits, the application should try to clean up all fonts
itself. This is because wxWidgets cannot know if a
@ -282,7 +282,7 @@ public:
/**
Returns the current application's default encoding.
@see @ref overview_wxfontencodingoverview, SetDefaultEncoding()
*/
static wxFontEncoding GetDefaultEncoding();
@ -291,7 +291,7 @@ public:
Returns the typeface name associated with the font, or the empty string if
there is no
typeface information.
@see SetFaceName()
*/
wxString GetFaceName() const;
@ -299,7 +299,7 @@ public:
/**
Gets the font family. See SetFamily() for a list of valid
family identifiers.
@see SetFamily()
*/
wxFontFamily GetFamily() const;
@ -310,7 +310,7 @@ public:
Note that the returned string is not meant to be shown or edited by the user: a
typical
use of this function is for serializing in string-form a wxFont object.
@see SetNativeFontInfo(),GetNativeFontInfoUserDesc()
*/
wxString GetNativeFontInfoDesc() const;
@ -320,14 +320,14 @@ public:
non-empty.
Some examples of the formats of returned strings (which are platform-dependent)
are in SetNativeFontInfoUserDesc().
@see GetNativeFontInfoDesc()
*/
wxString GetNativeFontInfoUserDesc();
/**
Gets the point size.
@see SetPointSize()
*/
int GetPointSize() const;
@ -335,14 +335,14 @@ public:
/**
Gets the font style. See wxFont() for a list of valid
styles.
@see SetStyle()
*/
int GetStyle() const;
/**
Returns @true if the font is underlined, @false otherwise.
@see SetUnderlined()
*/
bool GetUnderlined() const;
@ -350,7 +350,7 @@ public:
/**
Gets the font weight. See wxFont() for a list of valid
weight identifiers.
@see SetWeight()
*/
wxFontWeight GetWeight() const;
@ -398,7 +398,7 @@ public:
/**
Sets the default font encoding.
@see @ref overview_wxfontencodingoverview, GetDefaultEncoding()
*/
static void SetDefaultEncoding(wxFontEncoding encoding);
@ -406,106 +406,106 @@ public:
/**
Sets the facename for the font.
Returns @true if the given face name exists; @false otherwise.
@param faceName
A valid facename, which should be on the end-user's system.
@remarks To avoid portability problems, don't rely on a specific face,
but specify the font family instead or as well. A
suitable font will be found on the end-user's system.
If both the family and the facename are specified,
wxWidgets will first search for the specific face, and
then for a font belonging to the same family.
@see GetFaceName(), SetFamily()
*/
bool SetFaceName(const wxString& faceName);
/**
Sets the font family.
@param family
One of:
wxFONTFAMILY_DEFAULT
Chooses a default font.
wxFONTFAMILY_DECORATIVE
A decorative font.
wxFONTFAMILY_ROMAN
A formal, serif font.
wxFONTFAMILY_SCRIPT
A handwriting font.
wxFONTFAMILY_SWISS
A sans-serif font.
wxFONTFAMILY_MODERN
A fixed pitch font.
wxFONTFAMILY_TELETYPE
A teletype font.
@see GetFamily(), SetFaceName()
*/
void SetFamily(wxFontFamily family);
@ -519,7 +519,7 @@ public:
invalid, font is unchanged. This function is typically used for de-serializing
a wxFont
object previously saved in a string-form.
@see SetNativeFontInfoUserDesc()
*/
bool SetNativeFontInfo(const wxString& info);
@ -531,101 +531,101 @@ public:
Unlike SetNativeFontInfo(), this function accepts
strings which are user-friendly.
Examples of accepted string formats are:
Generic syntax
Example
on @b wxGTK2: @c [FACE-NAME] [bold] [oblique|italic] [POINTSIZE]
Monospace bold 10
on @b wxMSW: @c [light|bold] [italic] [FACE-NAME] [POINTSIZE] [ENCODING]
Tahoma 10 WINDOWS-1252
on @b wxMac: FIXME
FIXME
For more detailed information about the allowed syntaxes you can look at the
documentation of the native API used for font-rendering (e.g. pango_font_description_from_string).
@see SetNativeFontInfo()
*/
bool SetNativeFontInfoUserDesc(const wxString& info);
/**
Sets the point size.
@param pointSize
Size in points.
@see GetPointSize()
*/
void SetPointSize(int pointSize);
/**
Sets the font style.
@param style
One of wxFONTSTYLE_NORMAL, wxFONTSTYLE_SLANT and wxFONTSTYLE_ITALIC.
@see GetStyle()
*/
void SetStyle(int style);
/**
Sets underlining.
@param underlining
@true to underline, @false otherwise.
@see GetUnderlined()
*/
void SetUnderlined(const bool underlined);
/**
Sets the font weight.
@param weight
One of:
wxFONTWEIGHT_NORMAL
Normal font.
wxFONTWEIGHT_LIGHT
Light font.
wxFONTWEIGHT_BOLD
Bold font.
@see GetWeight()
*/
void SetWeight(wxFontWeight weight);

6
interface/fontmap.h
View file

@ -63,7 +63,7 @@ public:
/**
Get the current font mapper object. If there is no current object, creates
one.
@see Set()
*/
static wxFontMapper* Get();
@ -122,7 +122,7 @@ public:
/**
Return internal string identifier for the encoding (see also
wxFontMapper::GetEncodingDescription)
@see GetEncodingFromName()
*/
static wxString GetEncodingName(wxFontEncoding encoding);
@ -145,7 +145,7 @@ public:
Set the current font mapper object and return previous one (may be @NULL).
This method is only useful if you want to plug-in an alternative font mapper
into wxWidgets.
@see Get()
*/
static wxFontMapper* Set(wxFontMapper* mapper);

2
interface/fontpicker.h
View file

@ -75,7 +75,7 @@ public:
Validator which can be used for additional date checks.
@param name
Control name.
@returns @true if the control was successfully created or @false if
creation failed.
*/

68
interface/frame.h
View file

@ -90,7 +90,7 @@ public:
//@{
/**
Constructor, creating the window.
@param parent
The window parent. This may be @NULL. If it is non-@NULL, the frame will
always be displayed on top of the parent window on Windows.
@ -113,11 +113,11 @@ public:
item,
allowing the application user to set Motif resource values for
individual windows.
@remarks For Motif, MWM (the Motif Window Manager) should be running for
any window styles to work (otherwise all styles take
effect).
@see Create()
*/
wxFrame();
@ -136,7 +136,7 @@ public:
/**
Centres the frame on the display.
@param direction
The parameter may be wxHORIZONTAL, wxVERTICAL or wxBOTH.
*/
@ -155,7 +155,7 @@ public:
/**
Creates a status bar at the bottom of the frame.
@param number
The number of fields to create. Specify a
value greater than 1 to create a multi-field status bar.
@ -167,14 +167,14 @@ public:
wxWidgets.
@param name
The status bar window name.
@returns A pointer to the status bar if it was created successfully, @NULL
otherwise.
@remarks The width of the status bar is the whole width of the frame
(adjusted automatically when resizing), and the height
and text size are chosen by the host windowing system.
@see SetStatusText(), OnCreateStatusBar(), GetStatusBar()
*/
virtual wxStatusBar* CreateStatusBar(int number = 1,
@ -184,7 +184,7 @@ public:
/**
Creates a toolbar at the top or left of the frame.
@param style
The toolbar style. See wxToolBar for a list
of valid styles.
@ -193,15 +193,15 @@ public:
wxWidgets.
@param name
The toolbar window name.
@returns A pointer to the toolbar if it was created successfully, @NULL
otherwise.
@remarks By default, the toolbar is an instance of wxToolBar (which is
defined to be a suitable toolbar class on each
platform, such as wxToolBar95). To use a different
class, override OnCreateToolBar().
@see CreateStatusBar(), OnCreateToolBar(), SetToolBar(),
GetToolBar()
*/
@ -217,7 +217,7 @@ public:
/**
Returns a pointer to the menubar currently associated with the frame (if any).
@see SetMenuBar(), wxMenuBar, wxMenu
*/
wxMenuBar* GetMenuBar() const;
@ -225,28 +225,28 @@ public:
/**
Returns a pointer to the status bar currently associated with the frame (if
any).
@see CreateStatusBar(), wxStatusBar
*/
wxStatusBar* GetStatusBar() const;
/**
Returns the status bar pane used to display menu and toolbar help.
@see SetStatusBarPane()
*/
int GetStatusBarPane();
/**
Returns a pointer to the toolbar currently associated with the frame (if any).
@see CreateToolBar(), wxToolBar, SetToolBar()
*/
wxToolBar* GetToolBar() const;
/**
Virtual function called when a status bar is requested by CreateStatusBar().
@param number
The number of fields to create.
@param style
@ -257,13 +257,13 @@ public:
wxWidgets.
@param name
The window name.
@returns A status bar object.
@remarks An application can override this function to return a different
kind of status bar. The default implementation returns
an instance of wxStatusBar.
@see CreateStatusBar(), wxStatusBar.
*/
virtual wxStatusBar* OnCreateStatusBar(int number, long style,
@ -272,7 +272,7 @@ public:
/**
Virtual function called when a toolbar is requested by CreateToolBar().
@param style
The toolbar style. See wxToolBar for a list
of valid styles.
@ -281,13 +281,13 @@ public:
wxWidgets.
@param name
The toolbar window name.
@returns A toolbar object.
@remarks An application can override this function to return a different
kind of toolbar. The default implementation returns an
instance of wxToolBar.
@see CreateToolBar(), wxToolBar.
*/
virtual wxToolBar* OnCreateToolBar(long style, wxWindowID id,
@ -295,7 +295,7 @@ public:
/**
Simulate a menu command.
@param id
The identifier for a menu item.
*/
@ -314,22 +314,22 @@ public:
/**
Tells the frame to show the given menu bar.
@param menuBar
The menu bar to associate with the frame.
@remarks If the frame is destroyed, the menu bar and its menus will be
destroyed also, so do not delete the menu bar
explicitly (except by resetting the frame's menu bar to
another frame or @NULL).
@see GetMenuBar(), wxMenuBar, wxMenu.
*/
void SetMenuBar(wxMenuBar* menuBar);
/**
Associates a status bar with the frame.
@see CreateStatusBar(), wxStatusBar, GetStatusBar()
*/
void SetStatusBar(wxStatusBar* statusBar);
@ -342,21 +342,21 @@ public:
/**
Sets the status bar text and redraws the status bar.
@param text
The text for the status field.
@param number
The status field (starting from zero).
@remarks Use an empty string to clear the status bar.
@see CreateStatusBar(), wxStatusBar
*/
virtual void SetStatusText(const wxString& text, int number = 0);
/**
Sets the widths of the fields in the status bar.
@param n
The number of fields in the status bar. It must be the
same used in CreateStatusBar.
@ -366,7 +366,7 @@ public:
least one
field must be -1. You should delete this array after calling
SetStatusWidths.
@remarks The widths of the variable fields are calculated from the total
width of all fields, minus the sum of widths of the
non-variable fields, divided by the number of variable

6
interface/fs_mem.h
View file

@ -81,7 +81,7 @@ public:
Note that you must use a @a type value (aka image format)
that wxWidgets can save (e.g. JPG, PNG, see wxImage
documentation())!
@see AddFileWithMimeType()
*/
static void AddFile(const wxString& filename, wxImage& image,
@ -96,9 +96,9 @@ public:
Like AddFile(), but lets you explicitly
specify added file's MIME type. This version should be used whenever you know
the MIME type, because it makes accessing the files faster.
@wxsince{2.8.5}
@see AddFile()
*/
static void AddFileWithMimeType(const wxString& filename,

28
interface/gauge.h
View file

@ -48,7 +48,7 @@ public:
//@{
/**
Constructor, creating and showing a gauge.
@param parent
Window parent.
@param id
@ -64,7 +64,7 @@ public:
Gauge style. See wxGauge.
@param name
Window name.
@see Create()
*/
wxGauge();
@ -94,32 +94,32 @@ public:
/**
Returns the width of the 3D bezel face.
@remarks This method is not implemented (returns 0) for most platforms.
@see SetBezelFace()
*/
int GetBezelFace() const;
/**
Returns the maximum position of the gauge.
@see SetRange()
*/
int GetRange() const;
/**
Returns the 3D shadow margin width.
@remarks This method is not implemented (returns 0) for most platforms.
@see SetShadowWidth()
*/
int GetShadowWidth() const;
/**
Returns the current position of the gauge.
@see SetValue()
*/
int GetValue() const;
@ -141,10 +141,10 @@ public:
/**
Sets the 3D bezel face width.
@remarks This method is not implemented (doesn't do anything) for most
platforms.
@see GetBezelFace()
*/
void SetBezelFace(int width);
@ -152,14 +152,14 @@ public:
/**
Sets the range (maximum value) of the gauge.
This function makes the gauge switch to determinate mode, if it's not already.
@see GetRange()
*/
void SetRange(int range);
/**
Sets the 3D shadow width.
@remarks This method is not implemented (doesn't do anything) for most
platforms.
*/
@ -170,10 +170,10 @@ public:
range as returned by GetRange(), inclusive.
This function makes the gauge switch to determinate mode, if it was in
indeterminate mode before.
@param pos
Position for the gauge level.
@see GetValue()
*/
void SetValue(int pos);

8
interface/glcanvas.h
View file

@ -45,7 +45,7 @@ class wxGLContext : public wxObject
public:
/**
Constructor.
@param win
The canvas that is used to initialize this context. This parameter is
needed only temporarily,
@ -121,9 +121,9 @@ public:
Creates a window with the given parameters. Notice that you need to create and
use a wxGLContext to output to this window.
If
@param attribList is not specified, double buffered RGBA mode is used.
parent
Pointer to a parent window.
@param id
@ -165,7 +165,7 @@ public:
/**
Determines if a canvas having the specified attributes is available.
Returns @true if attributes are supported.
@param attribList
See attribList for wxGLCanvas().
*/

14
interface/graphics.h
View file

@ -23,7 +23,7 @@ class wxGraphicsPath : public wxGraphicsObject
public:
//@{
/**
*/
void AddArc(wxDouble x, wxDouble y, wxDouble r,
wxDouble startAngle,
@ -49,7 +49,7 @@ public:
//@{
/**
*/
void AddCurveToPoint(wxDouble cx1, wxDouble cy1, wxDouble cx2,
wxDouble cy2,
@ -67,7 +67,7 @@ public:
//@{
/**
*/
void AddLineToPoint(wxDouble x, wxDouble y);
void AddLineToPoint(const wxPoint2DDouble& p);
@ -220,7 +220,7 @@ public:
//@{
/**
Creates a wxGraphicsContext from a wxWindow.
@see wxGraphicsRenderer:: CreateContext
*/
wxGraphicsContext* Create(const wxWindowDC& dc);
@ -242,9 +242,9 @@ public:
Creates a wxGraphicsContext from a native context. This native context must be
eg a CGContextRef for Core Graphics, a Graphics pointer for GDIPlus or a
cairo_t pointer for cairo.
Creates a wxGraphicsContext from a native window.
@see wxGraphicsRenderer:: CreateContextFromNativeContext
*/
wxGraphicsContext* CreateFromNative(void* context);
@ -617,7 +617,7 @@ class wxGraphicsMatrix : public wxGraphicsObject
public:
//@{
/**
*/
void Concat(const wxGraphicsMatrix* t);
void Concat(const wxGraphicsMatrix& t);

296
interface/grid.h
View file

@ -70,27 +70,27 @@ class wxGridTableBase : public wxObject
{
public:
/**
*/
wxGridTableBase();
/**
*/
~wxGridTableBase();
/**
*/
bool AppendCols(size_t numCols = 1);
/**
*/
bool AppendRows(size_t numRows = 1);
/**
*/
bool CanGetValueAs(int row, int col, const wxString& typeName);
@ -101,22 +101,22 @@ public:
bool CanHaveAttributes();
/**
*/
bool CanSetValueAs(int row, int col, const wxString& typeName);
/**
*/
void Clear();
/**
*/
bool DeleteCols(size_t pos = 0, size_t numCols = 1);
/**
*/
bool DeleteRows(size_t pos = 0, size_t numRows = 1);
@ -132,12 +132,12 @@ public:
wxGridCellAttrProvider* GetAttrProvider() const;
/**
*/
wxString GetColLabelValue(int col);
/**
*/
int GetNumberCols();
@ -147,7 +147,7 @@ public:
int GetNumberRows();
/**
*/
wxString GetRowLabelValue(int row);
@ -157,12 +157,12 @@ public:
wxString GetTypeName(int row, int col);
/**
*/
wxString GetValue(int row, int col);
/**
*/
bool GetValueAsBool(int row, int col);
@ -173,32 +173,32 @@ public:
const wxString& typeName);
/**
*/
double GetValueAsDouble(int row, int col);
/**
*/
long GetValueAsLong(int row, int col);
/**
*/
wxGrid* GetView() const;
/**
*/
bool InsertCols(size_t pos = 0, size_t numCols = 1);
/**
*/
bool InsertRows(size_t pos = 0, size_t numRows = 1);
/**
*/
bool IsEmptyCell(int row, int col);
@ -214,7 +214,7 @@ public:
void SetAttrProvider(wxGridCellAttrProvider* attrProvider);
/**
*/
void SetColAttr(wxGridCellAttr* attr, int col);
@ -224,7 +224,7 @@ public:
void SetColLabelValue() const;
/**
*/
void SetRowAttr(wxGridCellAttr* attr, int row);
@ -234,28 +234,28 @@ public:
void SetRowLabelValue() const;
/**
*/
void SetValue(int row, int col, const wxString& value);
/**
*/
void SetValueAsBool(int row, int col, bool value);
/**
*/
void SetValueAsCustom(int row, int col, const wxString& typeName,
void* value);
/**
*/
void SetValueAsDouble(int row, int col, double value);
/**
*/
void SetValueAsLong(int row, int col, long value);
@ -265,7 +265,7 @@ public:
void SetView(wxGrid* grid);
/**
*/
void UpdateAttrCols(size_t pos, int numCols);
@ -297,7 +297,7 @@ class wxGridCellEditor
{
public:
/**
*/
wxGridCellEditor();
@ -341,7 +341,7 @@ public:
void HandleReturn(wxKeyEvent& event);
/**
*/
bool IsCreated();
@ -489,7 +489,7 @@ class wxGridEditorCreatedEvent : public wxCommandEvent
public:
//@{
/**
*/
wxGridEditorCreatedEvent();
wxGridEditorCreatedEvent(int id, wxEventType type,
@ -545,7 +545,7 @@ class wxGridRangeSelectEvent : public wxNotifyEvent
public:
//@{
/**
*/
wxGridRangeSelectEvent();
wxGridRangeSelectEvent(int id, wxEventType type,
@ -638,7 +638,7 @@ class wxGridCellRenderer
{
public:
/**
*/
wxGridCellRenderer* Clone() const;
@ -717,7 +717,7 @@ class wxGridSizeEvent : public wxNotifyEvent
public:
//@{
/**
*/
wxGridSizeEvent();
wxGridSizeEvent(int id, wxEventType type, wxObject* obj,
@ -817,7 +817,7 @@ public:
wxGridCellAttr* Clone() const;
/**
*/
void DecRef();
@ -827,52 +827,52 @@ public:
void GetAlignment(int* hAlign, int* vAlign) const;
/**
*/
const wxColour GetBackgroundColour() const;
/**
*/
wxGridCellEditor* GetEditor(wxGrid* grid, int row, int col) const;
/**
*/
const wxFont GetFont() const;
/**
*/
wxGridCellRenderer* GetRenderer(wxGrid* grid, int row, int col) const;
/**
*/
const wxColour GetTextColour() const;
/**
*/
bool HasAlignment() const;
/**
*/
bool HasBackgroundColour() const;
/**
*/
bool HasEditor() const;
/**
*/
bool HasFont() const;
/**
*/
bool HasRenderer() const;
@ -889,7 +889,7 @@ public:
void IncRef();
/**
*/
bool IsReadOnly() const;
@ -906,12 +906,12 @@ public:
void SetBackgroundColour(const wxColour& colBack);
/**
*/
void SetDefAttr(wxGridCellAttr* defAttr);
/**
*/
void SetEditor(wxGridCellEditor* editor);
@ -921,7 +921,7 @@ public:
void SetFont(const wxFont& font);
/**
*/
void SetReadOnly(bool isReadOnly = true);
@ -976,7 +976,7 @@ class wxGridEvent : public wxNotifyEvent
public:
//@{
/**
*/
wxGridEvent();
wxGridEvent(int id, wxEventType type, wxObject* obj,
@ -1205,25 +1205,25 @@ public:
/**
AutoSizeColumn()
AutoSizeRow()
AutoSizeColumns()
AutoSizeRows()
AutoSize()
SetColMinimalWidth()
SetRowMinimalHeight()
SetColMinimalAcceptableWidth()
SetRowMinimalAcceptableHeight()
GetColMinimalAcceptableWidth()
GetRowMinimalAcceptableHeight()
*/
@ -1236,7 +1236,7 @@ public:
EndBatch(). Code that does a lot of grid
modification can be enclosed between BeginBatch and EndBatch calls to avoid
screen flicker. The final EndBatch will cause the grid to be repainted.
@see wxGridUpdateLocker
*/
void BeginBatch();
@ -1296,29 +1296,29 @@ public:
/**
EnableDragRowSize()
EnableDragColSize()
CanDragRowSize()
CanDragColSize()
EnableDragColMove()
CanDragColMove()
EnableDragGridSize()
CanDragGridSize()
GetColAt()
SetColPos()
GetColPos()
EnableDragCell()
CanDragCell()
*/
@ -1348,11 +1348,11 @@ public:
/**
@ref ctor() wxGrid
@ref dtor() ~wxGrid
CreateGrid()
SetTable()
*/
@ -1371,23 +1371,23 @@ public:
/**
MoveCursorUp()
MoveCursorDown()
MoveCursorLeft()
MoveCursorRight()
MoveCursorPageUp()
MoveCursorPageDown()
MoveCursorUpBlock()
MoveCursorDownBlock()
MoveCursorLeftBlock()
MoveCursorRightBlock()
*/
@ -1505,7 +1505,7 @@ public:
EndBatch. Code that does a lot of grid modification can be enclosed between
BeginBatch and EndBatch calls to avoid screen flicker. The final EndBatch will
cause the grid to be repainted.
@see wxGridUpdateLocker
*/
void EndBatch();
@ -1533,7 +1533,7 @@ public:
grid cell at the specified location.
Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetCellAlignment(int row, int col, int* horiz, int* vert) const;
@ -1605,7 +1605,7 @@ public:
Sets the arguments to the current column label alignment values.
Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetColLabelAlignment(int* horiz, int* vert) const;
@ -1626,7 +1626,7 @@ public:
wxString GetColLabelValue(int col) const;
/**
*/
int GetColLeft(int col) const;
@ -1648,7 +1648,7 @@ public:
int GetColPos(int colID) const;
/**
*/
int GetColRight(int col) const;
@ -1662,7 +1662,7 @@ public:
values.
Horizontal alignment will be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
Vertical alignment will be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.
*/
void GetDefaultCellAlignment(int* horiz, int* vert) const;
@ -1702,14 +1702,14 @@ public:
//@{
/**
*/
wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
const wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const;
//@}
/**
*/
wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
@ -1717,7 +1717,7 @@ public:
Returns the pen used for grid lines. This virtual function may be overridden in
derived classes in order to change the appearance of grid lines. Note that
currently the pen width must be 1.
@see GetColGridLinePen(), GetRowGridLinePen()
*/
wxPen GetDefaultGridLinePen();
@ -1731,12 +1731,12 @@ public:
wxGridCellRenderer* GetDefaultRenderer() const;
/**
*/
wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
/**
*/
wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
@ -1762,7 +1762,7 @@ public:
/**
Returns the colour used for grid lines.
@see GetDefaultGridLinePen()
*/
wxColour GetGridLineColour() const;
@ -1796,7 +1796,7 @@ public:
int GetNumberRows() const;
/**
*/
wxGridCellAttr* GetOrCreateCellAttr(int row, int col) const;
@ -1811,7 +1811,7 @@ public:
/**
Sets the arguments to the current row label alignment values.
Horizontal alignment will be one of wxLEFT, wxCENTRE or wxRIGHT.
Vertical alignment will be one of wxTOP, wxCENTRE or wxBOTTOM.
*/
void GetRowLabelAlignment(int* horiz, int* vert) const;
@ -1838,7 +1838,7 @@ public:
int GetRowMinimalAcceptableHeight() const;
/**
*/
int GetRowMinimalHeight(int col) const;
@ -1849,14 +1849,14 @@ public:
/**
Returns the number of pixels per horizontal scroll increment. The default is 15.
@see GetScrollLineY(), SetScrollLineX(), SetScrollLineY()
*/
int GetScrollLineX() const;
/**
Returns the number of pixels per vertical scroll increment. The default is 15.
@see GetScrollLineX(), SetScrollLineX(), SetScrollLineY()
*/
int GetScrollLineY() const;
@ -1894,7 +1894,7 @@ public:
wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
/**
*/
wxColour GetSelectionForeground() const;
@ -1915,17 +1915,17 @@ public:
/**
EnableGridLines()
GridLinesEnabled()
SetGridLineColour()
GetGridLineColour()
GetDefaultGridLinePen()
GetRowGridLinePen()
GetColGridLinePen()
*/
@ -2149,57 +2149,57 @@ public:
/**
SetRowLabelValue()
SetColLabelValue()
GetRowLabelValue()
GetColLabelValue()
SetUseNativeColLabels()
HideColLabels()
HideRowLabels()
SetRowLabelSize()
SetColLabelSize()
GetRowLabelSize()
GetColLabelSize()
AutoSizeRowLabelSize()
AutoSizeColLabelSize()
GetDefaultRowLabelSize()
GetDefaultColLabelSize()
SetRowLabelAlignment()
SetColLabelAlignment()
GetRowLabelAlignment()
GetColLabelAlignment()
SetLabelFont()
SetLabelTextColour()
SetLabelBackgroundColour()
GetLabelFont()
GetLabelBackgroundColour()
GetLabelTextColour()
SetColLabelTextOrientation()
GetColLabelTextOrientation()
*/
@ -2249,15 +2249,15 @@ public:
/**
ClearSelection()
IsSelection()
SelectAll()
SelectBlock()
SelectCol()
SelectRow()
*/
@ -2274,7 +2274,7 @@ public:
location.
Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CENTRE or
wxALIGN_RIGHT.
Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE or
wxALIGN_BOTTOM.
*/
@ -2283,7 +2283,7 @@ public:
//@}
/**
*/
void SetCellBackgroundColour(int row, int col,
const wxColour& colour);
@ -2539,7 +2539,7 @@ public:
int SetOrCalcColumnSizes(bool calcOnly, bool setAsMin = true);
/**
*/
int SetOrCalcRowSizes(bool calcOnly, bool setAsMin = true);
@ -2619,7 +2619,7 @@ public:
Sets the number of pixels per horizontal scroll increment. The default is 15.
Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
errors: setting this to 1 can help.
@see GetScrollLineX(), GetScrollLineY(), SetScrollLineY()
*/
void SetScrollLineX(int x);
@ -2628,24 +2628,24 @@ public:
Sets the number of pixels per vertical scroll increment. The default is 15.
Sometimes wxGrid has trouble setting the scrollbars correctly due to rounding
errors: setting this to 1 can help.
@see GetScrollLineX(), GetScrollLineY(), SetScrollLineX()
*/
void SetScrollLineY(int y);
/**
*/
void SetSelectionBackground(const wxColour& c);
/**
*/
void SetSelectionForeground(const wxColour& c);
/**
Set the selection behaviour of the grid.
@param wxGridSelectCells()
The default mode where individual cells are selected.
@param wxGridSelectRows()

4
interface/help.h
View file

@ -124,7 +124,7 @@ public:
@e WinHelp, MS HTML Help @a sectionNo is a context id.
@e External HTML help: wxExtHelpController implements @a sectionNo as an id in
a map file, which is of the form:
@e wxHtmlHelpController: @a sectionNo is an identifier as specified in the @c
.hhc file. See @ref overview_helpformat "Help files format".
See also the help sample for notes on how to specify section numbers for
@ -145,7 +145,7 @@ public:
wxHtmlHelpController returns the frame, size and position.
For all other help controllers, this function does nothing
and just returns @NULL.
@param viewer
This defaults to "netscape" for wxExtHelpController.
@param flags

8
interface/htmllbox.h
View file

@ -77,7 +77,7 @@ public:
wxVListBox::SetSelectionBackground allows to
change the selection background for all cells at once and doing anything more
fancy is probably going to look strangely.
@see GetSelectedTextColour()
*/
wxColour GetSelectedTextBgColour(const wxColour& colBg) const;
@ -88,7 +88,7 @@ public:
look inside selection. By default all original colours are completely ignored
and the standard, system-dependent, selection colour is used but the program
may wish to override this to achieve some custom appearance.
@see GetSelectedTextBgColour(),
wxVListBox::SetSelectionBackground, wxSystemSettings::GetColour
*/
@ -117,12 +117,12 @@ public:
/**
Called when the user clicks on hypertext link. Does nothing by default.
Overloading this method is deprecated; intercept the event instead.
@param n
Index of the item containing the link.
@param link
Description of the link.
@see See also wxHtmlLinkInfo.
*/
virtual void OnLinkClicked(size_t n, const wxHtmlLinkInfo& link);

2
interface/hyperlink.h
View file

@ -81,7 +81,7 @@ class wxHyperlinkCtrl : public wxControl
public:
/**
Creates the hyperlink control.
@param parent
Parent window. Must not be @NULL.
@param id

232
interface/icon.h
View file

@ -36,7 +36,7 @@ public:
//@{
/**
Loads an icon from the specified location().
@param bits
Specifies an array of pixel values.
@param width
@ -66,68 +66,68 @@ public:
wxIconLocation.
@param type
May be one of the following:
wxBITMAP_TYPE_ICO
Load a Windows icon file.
wxBITMAP_TYPE_ICO_RESOURCE
Load a Windows icon from the resource database.
wxBITMAP_TYPE_GIF
Load a GIF bitmap file.
wxBITMAP_TYPE_XBM
Load an X bitmap file.
wxBITMAP_TYPE_XPM
Load an XPM bitmap file.
The validity of these flags depends on the platform and wxWidgets
configuration.
If all possible wxWidgets settings are used, the Windows platform supports
@ -136,7 +136,7 @@ public:
XPM data, XPM file, and PNG file.
Under wxMotif, the available formats are XBM data, XBM file, XPM data, XPM
file.
@remarks The first form constructs an icon object with no data; an
assignment or another member function such as Create or
LoadFile must be called subsequently.
@ -168,9 +168,9 @@ public:
/**
Copies @a bmp bitmap to this icon. Under MS Windows the bitmap
must have mask colour set.
LoadFile()
Wx::Icon-new( width, height, depth = -1 )
Wx::Icon-new( name, type, desiredWidth = -1, desiredHeight = -1 )
Wx::Icon-newFromBits( bits, width, height, depth = 1 )
@ -191,7 +191,7 @@ public:
/**
Gets the width of the icon in pixels.
@see GetHeight()
*/
int GetWidth() const;
@ -203,86 +203,86 @@ public:
/**
Loads an icon from a file or resource.
@param name
Either a filename or a Windows resource name.
The meaning of name is determined by the type parameter.
@param type
One of the following values:
wxBITMAP_TYPE_ICO
Load a Windows icon file.
wxBITMAP_TYPE_ICO_RESOURCE
Load a Windows icon from the resource database.
wxBITMAP_TYPE_GIF
Load a GIF bitmap file.
wxBITMAP_TYPE_XBM
Load an X bitmap file.
wxBITMAP_TYPE_XPM
Load an XPM bitmap file.
The validity of these flags depends on the platform and wxWidgets
configuration.
@returns @true if the operation succeeded, @false otherwise.
@see wxIcon()
*/
bool LoadFile(const wxString& name, wxBitmapType type);
/**
Sets the depth member (does not affect the icon data).
@param depth
Icon depth.
*/
@ -290,7 +290,7 @@ public:
/**
Sets the height member (does not affect the icon data).
@param height
Icon height in pixels.
*/
@ -298,7 +298,7 @@ public:
/**
Sets the width member (does not affect the icon data).
@param width
Icon width in pixels.
*/
@ -306,7 +306,7 @@ public:
/**
Assignment operator, using @ref overview_trefcount "reference counting".
@param icon
Icon to assign.
*/

1012
interface/image.h
View file

File diff suppressed because it is too large Load diff

Some files were not shown because too many files have changed in this diff Show more