Mirrors_UI_SDK/wxWidgets
1
0
Fork 0
mirror of https://github.com/wxWidgets/wxWidgets.git synced 2026-09-21 05:15:41 +08:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

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
docs/doxygen/mainpages/cat_functions.h
+1 -1
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}
docs/doxygen/mainpages/const_cpp.h
+34 -34
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
docs/doxygen/mainpages/const_keycode.h
+7 -7
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,
docs/doxygen/mainpages/const_keymod.h
+7 -7
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.
*/
docs/doxygen/mainpages/const_langcodes.h
+4 -4
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 -->
*/
docs/doxygen/mainpages/const_stdevtid.h
+15 -15
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
docs/doxygen/mainpages/const_wxusedef.h
+16 -16
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}
docs/doxygen/mainpages/introduction.h
+1 -1
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
docs/doxygen/mainpages/libs.h
+3 -3
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.
docs/doxygen/mainpages/platdetails.h
+158 -158
View File
File diff suppressed because it is too large Load Diff
docs/doxygen/mainpages/strategies.h
+1 -1
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.
docs/doxygen/mainpages/utilities.h
+158 -158
View File
File diff suppressed because it is too large Load Diff
docs/doxygen/overviews/dataobject.h
+3 -3
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.
docs/doxygen/overviews/datetime.h
+2 -2
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).
docs/doxygen/overviews/dc.h
+3 -3
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.
docs/doxygen/overviews/debugging.h
+7 -7
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.
docs/doxygen/overviews/dialog.h
+23 -23
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.
*/
docs/doxygen/overviews/dnd.h
+7 -7
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
docs/doxygen/overviews/docview.h
+14 -14
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.
docs/doxygen/overviews/eventhandling.h
+8 -8
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
docs/doxygen/overviews/filesystem.h
+1 -1
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.
docs/doxygen/overviews/font.h
+2 -2
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,
docs/doxygen/overviews/fontencoding.h
+2 -2
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
docs/doxygen/overviews/helloworld.h
+1 -1
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
docs/doxygen/overviews/html.h
+25 -25
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
docs/doxygen/overviews/sizer.h
+5 -5
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
}
docs/doxygen/overviews/stream.h
+1 -1
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);
docs/doxygen/overviews/xrc.h
+2 -2
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,
interface/aboutdlg.h
+7 -7
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);
interface/accel.h
+4 -4
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.
*/
interface/access.h
+1 -1
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.
interface/animate.h
+8 -8
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,
interface/app.h
+39 -39
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
interface/archive.h
+6 -6
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:
interface/arrstr.h
+8 -8
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,
interface/artprov.h
+16 -16
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);
interface/base64.h
+2 -2
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,
interface/calctrl.h
+6 -6
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;
interface/caret.h
+10 -10
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);
interface/checkbox.h
+7 -7
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.
*/
interface/checklst.h
+2 -2
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
interface/choice.h
+5 -5
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.
*/
interface/clipbrd.h
+2 -2
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);
interface/clntdata.h
+2 -2
View File
@@ -30,12 +30,12 @@ class wxClientDataContainer
{
public:
/**
*/
wxClientDataContainer();
/**
*/
~wxClientDataContainer();
interface/clrpicker.h
+1 -1
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.
*/
interface/cmdline.h
+4 -4
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;
interface/cmndata.h
+2 -2
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.
interface/collpane.h
+1 -1
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.
*/
interface/colordlg.h
+1 -1
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);
interface/colour.h
+5 -5
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);

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