From 8fbca5cb70c8b647d5bd2cacb1e0a2a00358f351 Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Wed, 30 Jan 2019 17:28:08 +0100 Subject: [PATCH] Remove all trailing spaces No real changes, just clean up sources by removing trailing spaces from all the non-generated files. This should hopefully avoid future commits mixing significant changes with insignificant whitespace ones. --- docs/changes_30.txt | 4 +- docs/doxygen/groups/class_webview.h | 2 +- docs/doxygen/groups/funcmacro_locale.h | 2 +- docs/doxygen/mainpages/const_stdevtid.h | 2 +- docs/doxygen/mainpages/copyright.h | 2 +- docs/doxygen/mainpages/samples.h | 2 +- docs/doxygen/overviews/debugging.h | 2 +- docs/doxygen/overviews/docview.h | 2 +- docs/doxygen/overviews/eventhandling.h | 2 +- docs/doxygen/overviews/log.h | 12 +- docs/doxygen/overviews/propgrid.h | 4 +- docs/doxygen/overviews/sizer.h | 20 +-- docs/doxygen/scripts/c_tools.py | 12 +- docs/doxygen/scripts/common.py | 4 +- docs/doxygen/scripts/doxymlparser.py | 56 ++++---- docs/doxygen/scripts/make_bindings.py | 20 +-- docs/doxygen/scripts/sip_tools.py | 22 +-- docs/doxygen/scripts/swig_tools.py | 18 +-- docs/gtk/nonnative.txt | 2 +- docs/lgpl.txt | 14 +- docs/licence.txt | 6 +- docs/licendoc.txt | 4 +- docs/publicity/WoWoW30.html | 6 +- docs/publicity/slogans.txt | 16 +-- docs/vms/readme.txt | 10 +- docs/wine/COPYING.LIB | 2 +- docs/wine/changes.txt | 2 +- docs/wine/install.txt | 134 +++++++++--------- docs/wine/readme.txt | 8 +- docs/xserver.txt | 8 +- include/msvc/wx/setup.h | 6 +- include/wx/accel.h | 2 +- include/wx/app.h | 2 +- include/wx/aui/auibook.h | 2 +- include/wx/colour.h | 2 +- include/wx/dataobj.h | 4 +- include/wx/dc.h | 6 +- include/wx/dcbuffer.h | 2 +- include/wx/dcgraph.h | 2 +- include/wx/fontutil.h | 10 +- include/wx/generic/headerctrlg.h | 2 +- include/wx/graphics.h | 16 +-- include/wx/gtk/dc.h | 2 +- include/wx/gtk/dcmemory.h | 2 +- include/wx/gtk/print.h | 2 +- include/wx/html/helpctrl.h | 4 +- include/wx/html/webkit.h | 4 +- include/wx/kbdstate.h | 14 +- include/wx/menu.h | 22 +-- include/wx/msw/dc.h | 2 +- include/wx/msw/headerctrl.h | 2 +- include/wx/msw/missing.h | 2 +- include/wx/osx/app.h | 8 +- include/wx/osx/bitmap.h | 8 +- include/wx/osx/cocoa/chkconf.h | 2 +- include/wx/osx/cocoa/dataview.h | 2 +- include/wx/osx/cocoa/evtloop.h | 16 +-- include/wx/osx/cocoa/private.h | 12 +- include/wx/osx/cocoa/private/textimpl.h | 2 +- include/wx/osx/core/cfdictionary.h | 2 +- include/wx/osx/core/cfref.h | 4 +- include/wx/osx/core/colour.h | 14 +- include/wx/osx/core/evtloop.h | 2 +- include/wx/osx/core/private.h | 18 +-- include/wx/osx/dataobj.h | 2 +- include/wx/osx/dataview.h | 2 +- include/wx/osx/dialog.h | 4 +- include/wx/osx/evtloop.h | 2 +- include/wx/osx/filedlg.h | 10 +- include/wx/osx/iphone/private.h | 4 +- include/wx/osx/iphone/private/textimpl.h | 6 +- include/wx/osx/menu.h | 2 +- include/wx/osx/msgdlg.h | 2 +- include/wx/osx/nonownedwnd.h | 4 +- include/wx/osx/popupwin.h | 2 +- include/wx/osx/toolbar.h | 4 +- include/wx/osx/toplevel.h | 2 +- include/wx/osx/webview_webkit.h | 6 +- include/wx/osx/window.h | 20 +-- include/wx/private/notifmsg.h | 2 +- include/wx/qt/accel.h | 4 +- include/wx/qt/app.h | 6 +- include/wx/qt/bitmap.h | 2 +- include/wx/qt/brush.h | 2 +- include/wx/qt/choice.h | 8 +- include/wx/qt/cursor.h | 2 +- include/wx/qt/dataform.h | 2 +- include/wx/qt/dataobj.h | 2 +- include/wx/qt/dc.h | 4 +- include/wx/qt/dcprint.h | 8 +- include/wx/qt/defs.h | 2 +- include/wx/qt/dialog.h | 2 +- include/wx/qt/dnd.h | 4 +- include/wx/qt/font.h | 4 +- include/wx/qt/fontdlg.h | 4 +- include/wx/qt/frame.h | 2 +- include/wx/qt/listbox.h | 10 +- include/wx/qt/mdi.h | 2 +- include/wx/qt/minifram.h | 2 +- include/wx/qt/notebook.h | 2 +- include/wx/qt/palette.h | 4 +- include/wx/qt/pen.h | 2 +- include/wx/qt/printdlg.h | 4 +- include/wx/qt/printqt.h | 2 +- include/wx/qt/private/timer.h | 2 +- include/wx/qt/private/winevent.h | 6 +- include/wx/qt/region.h | 4 +- include/wx/qt/statbox.h | 2 +- include/wx/qt/statusbar.h | 2 +- include/wx/qt/textctrl.h | 2 +- include/wx/qt/textentry.h | 6 +- include/wx/qt/tooltip.h | 2 +- include/wx/qt/toplevel.h | 6 +- include/wx/qt/treectrl.h | 10 +- include/wx/rawbmp.h | 2 +- include/wx/richtext/richtextbuffer.h | 6 +- include/wx/richtext/richtextfontpage.h | 2 +- include/wx/richtext/richtextimagedlg.h | 2 +- include/wx/richtext/richtextmarginspage.h | 6 +- include/wx/richtext/richtextuicustomization.h | 8 +- include/wx/richtext/richtextxml.h | 4 +- include/wx/variantbase.h | 24 ++-- include/wx/xti.h | 50 +++---- include/wx/xti2.h | 12 +- include/wx/xtiprop.h | 64 ++++----- include/wx/xtistrm.h | 122 ++++++++-------- include/wx/xtitypes.h | 78 +++++----- include/wx/xtixml.h | 10 +- interface/wx/aboutdlg.h | 12 +- interface/wx/affinematrix2dbase.h | 4 +- interface/wx/animate.h | 2 +- interface/wx/anybutton.h | 4 +- interface/wx/app.h | 2 +- interface/wx/artprov.h | 108 +++++++------- interface/wx/aui/auibar.h | 4 +- interface/wx/aui/framemanager.h | 26 ++-- interface/wx/aui/tabmdi.h | 2 +- interface/wx/base64.h | 2 +- interface/wx/bitmap.h | 12 +- interface/wx/bmpbuttn.h | 4 +- interface/wx/button.h | 2 +- interface/wx/checkbox.h | 4 +- interface/wx/checklst.h | 2 +- interface/wx/choice.h | 4 +- interface/wx/choicebk.h | 2 +- interface/wx/clrpicker.h | 2 +- interface/wx/colour.h | 12 +- interface/wx/combo.h | 10 +- interface/wx/combobox.h | 2 +- interface/wx/config.h | 34 ++--- interface/wx/control.h | 8 +- interface/wx/cshelp.h | 4 +- interface/wx/cursor.h | 6 +- interface/wx/dataobj.h | 4 +- interface/wx/dataview.h | 12 +- interface/wx/datectrl.h | 2 +- interface/wx/datetime.h | 4 +- interface/wx/dc.h | 44 +++--- interface/wx/dcbuffer.h | 2 +- interface/wx/dcgraph.h | 2 +- interface/wx/debugrpt.h | 4 +- interface/wx/defs.h | 10 +- interface/wx/dir.h | 8 +- interface/wx/dirctrl.h | 2 +- interface/wx/editlbox.h | 2 +- interface/wx/event.h | 16 +-- interface/wx/evtloop.h | 2 +- interface/wx/fileconf.h | 2 +- interface/wx/filedlg.h | 20 +-- interface/wx/filepicker.h | 4 +- interface/wx/filesys.h | 2 +- interface/wx/fontpicker.h | 2 +- interface/wx/fontutil.h | 2 +- interface/wx/gbsizer.h | 4 +- interface/wx/gdicmn.h | 2 +- interface/wx/generic/helpext.h | 6 +- interface/wx/geometry.h | 2 +- interface/wx/headerctrl.h | 4 +- interface/wx/help.h | 2 +- interface/wx/html/helpctrl.h | 2 +- interface/wx/html/helpdata.h | 2 +- interface/wx/html/htmlcell.h | 2 +- interface/wx/html/htmprint.h | 14 +- interface/wx/html/webkit.h | 2 +- interface/wx/htmllbox.h | 2 +- interface/wx/hyperlink.h | 2 +- interface/wx/iconbndl.h | 4 +- interface/wx/image.h | 8 +- interface/wx/imaggif.h | 16 +-- interface/wx/imagiff.h | 14 +- interface/wx/imagjpeg.h | 16 +-- interface/wx/imagpcx.h | 14 +- interface/wx/imagpng.h | 12 +- interface/wx/imagpnm.h | 14 +- interface/wx/imagtga.h | 14 +- interface/wx/imagtiff.h | 12 +- interface/wx/imagxpm.h | 14 +- interface/wx/intl.h | 6 +- interface/wx/kbdstate.h | 8 +- interface/wx/listbox.h | 10 +- interface/wx/listctrl.h | 6 +- interface/wx/log.h | 6 +- interface/wx/math.h | 2 +- interface/wx/menu.h | 24 ++-- interface/wx/menuitem.h | 68 ++++----- interface/wx/mimetype.h | 20 +-- interface/wx/mousestate.h | 4 +- interface/wx/msw/ole/automtn.h | 10 +- interface/wx/msw/regconf.h | 2 +- interface/wx/notifmsg.h | 48 +++---- interface/wx/object.h | 4 +- interface/wx/overlay.h | 6 +- interface/wx/pickerbase.h | 2 +- interface/wx/platinfo.h | 78 +++++----- interface/wx/popupwin.h | 4 +- interface/wx/power.h | 2 +- interface/wx/process.h | 24 ++-- interface/wx/progdlg.h | 2 +- interface/wx/propdlg.h | 8 +- interface/wx/propgrid/editors.h | 2 +- interface/wx/propgrid/property.h | 2 +- interface/wx/propgrid/propgridpagestate.h | 4 +- interface/wx/propgrid/props.h | 2 +- interface/wx/protocol/protocol.h | 2 +- interface/wx/rearrangectrl.h | 2 +- interface/wx/renderer.h | 2 +- interface/wx/ribbon/art.h | 126 ++++++++-------- interface/wx/ribbon/bar.h | 38 ++--- interface/wx/ribbon/buttonbar.h | 66 ++++----- interface/wx/ribbon/gallery.h | 2 +- interface/wx/ribbon/page.h | 48 +++---- interface/wx/ribbon/toolbar.h | 24 ++-- interface/wx/richmsgdlg.h | 2 +- interface/wx/richtext/richtextbuffer.h | 32 ++--- interface/wx/richtext/richtextctrl.h | 12 +- interface/wx/sashwin.h | 2 +- interface/wx/scopedptr.h | 4 +- interface/wx/scrolbar.h | 4 +- interface/wx/scrolwin.h | 6 +- interface/wx/settings.h | 10 +- interface/wx/sizer.h | 18 +-- interface/wx/slider.h | 8 +- interface/wx/srchctrl.h | 4 +- interface/wx/statbmp.h | 30 ++-- interface/wx/stc/stc.h | 4 +- interface/wx/stream.h | 2 +- interface/wx/sysopt.h | 2 +- interface/wx/textwrapper.h | 2 +- interface/wx/thread.h | 2 +- interface/wx/timectrl.h | 2 +- interface/wx/timer.h | 2 +- interface/wx/tokenzr.h | 12 +- interface/wx/toplevel.h | 14 +- interface/wx/treectrl.h | 6 +- interface/wx/treelist.h | 4 +- interface/wx/utils.h | 16 +-- interface/wx/validate.h | 2 +- interface/wx/webview.h | 10 +- interface/wx/window.h | 12 +- interface/wx/withimages.h | 4 +- interface/wx/wrapsizer.h | 2 +- interface/wx/xlocale.h | 4 +- samples/dataview/dataview.cpp | 2 +- samples/html/html_samples.bkl | 2 +- samples/ownerdrw/ownerdrw.bkl | 2 +- samples/render/render.bkl | 2 +- samples/ribbon/ribbondemo.cpp | 26 ++-- samples/richtext/richtext.bkl | 2 +- samples/richtext/richtext.cpp | 10 +- samples/taskbar/tbtest.cpp | 2 +- samples/xrc/rc/artprov.xrc | 2 +- samples/xrc/rc/menu.xrc | 14 +- samples/xrc/rc/platform.xrc | 10 +- samples/xrc/rc/toolbar.xrc | 10 +- samples/xti/classlist.cpp | 24 ++-- samples/xti/classlist.h | 20 +-- samples/xti/codereadercallback.cpp | 18 +-- samples/xti/codereadercallback.h | 14 +- samples/xti/xti.bkl | 2 +- samples/xti/xti.cpp | 64 ++++----- src/aui/auibook.cpp | 10 +- src/aui/descrip.mms | 2 +- src/common/containr.cpp | 2 +- src/common/event.cpp | 2 +- src/common/graphcmn.cpp | 8 +- src/common/memory.cpp | 2 +- src/common/menucmn.cpp | 10 +- src/common/notifmsgcmn.cpp | 2 +- src/common/uiactioncmn.cpp | 2 +- src/common/xtistrm.cpp | 52 +++---- src/qt/accel.cpp | 16 +-- src/qt/app.cpp | 2 +- src/qt/apptraits.cpp | 2 +- src/qt/bitmap.cpp | 38 ++--- src/qt/brush.cpp | 14 +- src/qt/button.cpp | 2 +- src/qt/calctrl.cpp | 2 +- src/qt/checkbox.cpp | 2 +- src/qt/clipbrd.cpp | 4 +- src/qt/colordlg.cpp | 4 +- src/qt/cursor.cpp | 6 +- src/qt/dataobj.cpp | 2 +- src/qt/filedlg.cpp | 2 +- src/qt/fontutil.cpp | 2 +- src/qt/listbox.cpp | 2 +- src/qt/listctrl.cpp | 2 +- src/qt/menu.cpp | 2 +- src/qt/menuitem.cpp | 2 +- src/qt/msgdlg.cpp | 10 +- src/qt/pen.cpp | 18 +-- src/qt/region.cpp | 28 ++-- src/qt/scrolbar.cpp | 6 +- src/qt/spinctrl.cpp | 2 +- src/qt/statusbar.cpp | 2 +- src/qt/timer.cpp | 2 +- src/qt/toplevel.cpp | 14 +- src/qt/utils.cpp | 4 +- src/qt/window.cpp | 4 +- tests/test.bkl | 4 +- utils/wxrc/wxrc.bkl | 8 +- 320 files changed, 1611 insertions(+), 1611 deletions(-) diff --git a/docs/changes_30.txt b/docs/changes_30.txt index dfc04bb928..4571e73c77 100644 --- a/docs/changes_30.txt +++ b/docs/changes_30.txt @@ -733,10 +733,10 @@ All (GUI): - Support hexadecimal numbers in wxSpinCtrl. - Respect window max size in wxBoxSizer (Nathan Ridge). - Add support for searching in wxWebView for MSW and GTK (Allonii). -- Add generic wxFileSystem support to wxWebView with +- Add generic wxFileSystem support to wxWebView with wxWebViewFSHandler (Nick Matthews). - Add possibility to disable context menu in wxWebView. -- Add ability to register custom wxWebView backends using +- Add ability to register custom wxWebView backends using wxWebView::RegisterFactory and a wxWebViewFactory derived class. - Add possibility to hide and show again wxRibbonBar pages (wxBen). - Add wxRibbonBar pages highlighting (wxBen). diff --git a/docs/doxygen/groups/class_webview.h b/docs/doxygen/groups/class_webview.h index 15cc934526..56f45c68d5 100644 --- a/docs/doxygen/groups/class_webview.h +++ b/docs/doxygen/groups/class_webview.h @@ -10,7 +10,7 @@ @defgroup group_class_webview WebView @ingroup group_class -The wxWebView library is a set of classes for viewing complex web documents and +The wxWebView library is a set of classes for viewing complex web documents and for internet browsing. It is built around a series of backends, and exposes common functions for them. diff --git a/docs/doxygen/groups/funcmacro_locale.h b/docs/doxygen/groups/funcmacro_locale.h index 4ae5987514..8c646cc90d 100644 --- a/docs/doxygen/groups/funcmacro_locale.h +++ b/docs/doxygen/groups/funcmacro_locale.h @@ -19,7 +19,7 @@ and keep in mind that the wxWidgets function takes as last parameter the locale which should be internally used for locale-dependent operations. Last, note that when the @c wxHAS_XLOCALE_SUPPORT symbol is not defined, -then wxWidgets will provide implementations of these functions itself +then wxWidgets will provide implementations of these functions itself and that they are not granted to be thread-safe (and they will work only with the C locale; see @ref xlocale_avail). diff --git a/docs/doxygen/mainpages/const_stdevtid.h b/docs/doxygen/mainpages/const_stdevtid.h index 50e6a68c79..b3b2fd9bd3 100644 --- a/docs/doxygen/mainpages/const_stdevtid.h +++ b/docs/doxygen/mainpages/const_stdevtid.h @@ -29,7 +29,7 @@ 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 (e.g. by using wxNewId()). -Refer to @ref page_stockitems "the list of stock items" for the subset of standard IDs +Refer to @ref page_stockitems "the list of stock items" for the subset of standard IDs which are stock IDs as well. */ diff --git a/docs/doxygen/mainpages/copyright.h b/docs/doxygen/mainpages/copyright.h index 88eadadd8d..d9c39afcf3 100644 --- a/docs/doxygen/mainpages/copyright.h +++ b/docs/doxygen/mainpages/copyright.h @@ -103,7 +103,7 @@ without express or implied warranty. @verbinclude "lgpl.txt" @page page_copyright_xserver The Open Group and DEC License - + @verbinclude "xserver.txt" */ diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h index db03c9942f..1d783a90e9 100644 --- a/docs/doxygen/mainpages/samples.h +++ b/docs/doxygen/mainpages/samples.h @@ -914,7 +914,7 @@ control. The wxWebView sample demonstarates the various capabilities of the wxWebView control. It is set up as a simple single window web browser, but with support -for many of the more complex wxWebView features, including browsing through +for many of the more complex wxWebView features, including browsing through archives. @sampledir{webview} diff --git a/docs/doxygen/overviews/debugging.h b/docs/doxygen/overviews/debugging.h index 7abb682830..7c1520ea46 100644 --- a/docs/doxygen/overviews/debugging.h +++ b/docs/doxygen/overviews/debugging.h @@ -21,7 +21,7 @@ debugging. Both assertions and debug logging are also used by wxWidgets itself so you may encounter them even if you don't use either of these features yourself. -@see wxLog, @ref group_funcmacro_log, @ref group_funcmacro_debug +@see wxLog, @ref group_funcmacro_log, @ref group_funcmacro_debug diff --git a/docs/doxygen/overviews/docview.h b/docs/doxygen/overviews/docview.h index f213de1095..8f5da29682 100644 --- a/docs/doxygen/overviews/docview.h +++ b/docs/doxygen/overviews/docview.h @@ -86,7 +86,7 @@ use Wx ':docview'; # import constants (optional) @endcode @endWxPerlOnly -@see @ref group_class_docview, +@see @ref group_class_docview, diff --git a/docs/doxygen/overviews/eventhandling.h b/docs/doxygen/overviews/eventhandling.h index c38d1b8af5..b3195d5ebe 100644 --- a/docs/doxygen/overviews/eventhandling.h +++ b/docs/doxygen/overviews/eventhandling.h @@ -614,7 +614,7 @@ custom event types. Finally, you will need to generate and post your custom events. Generation is as simple as instancing your custom event class and initializing its internal fields. -For posting events to a certain event handler there are two possibilities: +For posting events to a certain event handler there are two possibilities: using wxEvtHandler::AddPendingEvent or using wxEvtHandler::QueueEvent. Basically you will need to use the latter when doing inter-thread communication; when you use only the main thread you can also safely use the former. diff --git a/docs/doxygen/overviews/log.h b/docs/doxygen/overviews/log.h index ad66ae2df1..948d1fe1b0 100644 --- a/docs/doxygen/overviews/log.h +++ b/docs/doxygen/overviews/log.h @@ -19,9 +19,9 @@ as well as several standard implementations of it and a family of functions to use with them. First of all, no knowledge of wxLog classes is needed to use them. For this, -you should only know about @ref group_funcmacro_log "wxLogXXX() functions". -All of them have the same syntax as @e printf() or @e vprintf() , i.e. they -take the format string as the first argument and respectively a variable number +you should only know about @ref group_funcmacro_log "wxLogXXX() functions". +All of them have the same syntax as @e printf() or @e vprintf() , i.e. they +take the format string as the first argument and respectively a variable number of arguments or a variable argument list pointer. Here are all of them: @li wxLogFatalError() which is like wxLogError(), but also terminates the program @@ -161,8 +161,8 @@ works. wxWidgets has the notion of a log target: it is just a class deriving from wxLog. As such, it implements the virtual functions of the base class which are called when a message is logged. Only one log target is @e active at -any moment, this is the one used by @ref group_funcmacro_log "wxLogXXX() functions". -The normal usage of a log object (i.e. object of a class derived from wxLog) is +any moment, this is the one used by @ref group_funcmacro_log "wxLogXXX() functions". +The normal usage of a log object (i.e. object of a class derived from wxLog) is to install it as the active target with a call to @e SetActiveTarget() and it will be used automatically by all subsequent calls to @ref group_funcmacro_log "wxLogXXX() functions". @@ -263,7 +263,7 @@ GUI is (already/still) available when your log target as used as wxWidgets automatically switches to using wxLogStderr if it isn't. There are several methods which may be overridden in the derived class to -customize log messages handling: wxLog::DoLogRecord(), wxLog::DoLogTextAtLevel() +customize log messages handling: wxLog::DoLogRecord(), wxLog::DoLogTextAtLevel() and wxLog::DoLogText(). The last method is the simplest one: you should override it if you simply diff --git a/docs/doxygen/overviews/propgrid.h b/docs/doxygen/overviews/propgrid.h index fbca6a2edd..f6bc3d3d66 100644 --- a/docs/doxygen/overviews/propgrid.h +++ b/docs/doxygen/overviews/propgrid.h @@ -733,10 +733,10 @@ accomplish the task: @code // Have property editor focus on Enter propgrid->AddActionTrigger( wxPG_ACTION_EDIT, WXK_RETURN ); - + // Have Enter work as action trigger even when editor is focused propgrid->DedicateKey( WXK_RETURN ); - + // Let Enter also navigate to the next property propgrid->AddActionTrigger( wxPG_ACTION_NEXT_PROPERTY, WXK_RETURN ); diff --git a/docs/doxygen/overviews/sizer.h b/docs/doxygen/overviews/sizer.h index 4ab49f1d16..3d80689da0 100644 --- a/docs/doxygen/overviews/sizer.h +++ b/docs/doxygen/overviews/sizer.h @@ -15,7 +15,7 @@ Sizers, as represented by the wxSizer class and its descendants in the wxWidgets class hierarchy, have become the method of choice to define the layout of controls in dialogs in wxWidgets because of their ability to create visually appealing dialogs independent of the platform, taking into account -the differences in size and style of the individual controls. +the differences in size and style of the individual controls. The next section describes and shows what can be done with sizers. The following sections briefly describe how to program with individual sizer @@ -211,7 +211,7 @@ window will preserve it is original size, @c wxGROW flag (same as @c wxEXPAND) f the window to grow with the sizer, and @c wxSHAPED flag tells the window to change it is size proportionally, preserving original aspect ratio. When @c wxGROW flag is not used, the item can be aligned within available space. @c wxALIGN_LEFT, -@c wxALIGN_TOP, @c wxALIGN_RIGHT, @c wxALIGN_BOTTOM, @c wxALIGN_CENTER_HORIZONTAL +@c wxALIGN_TOP, @c wxALIGN_RIGHT, @c wxALIGN_BOTTOM, @c wxALIGN_CENTER_HORIZONTAL and @c wxALIGN_CENTER_VERTICAL do what they say. @c wxALIGN_CENTRE (same as @c wxALIGN_CENTER) is defined as (wxALIGN_CENTER_HORIZONTAL | wxALIGN_CENTER_VERTICAL). Default alignment is wxALIGN_LEFT | wxALIGN_TOP. @@ -267,7 +267,7 @@ MyDialog::MyDialog(wxFrame *parent, wxWindowID id, const wxString &title ) } @endcode -Note that the recommended way of specifying flags to wxSizer is via wxSizerFlags. +Note that the recommended way of specifying flags to wxSizer is via wxSizerFlags. This class greatly eases the burden of passing flags to a wxSizer. Here's how you'd do the previous example with wxSizerFlags: @@ -313,18 +313,18 @@ MyDialog::MyDialog(wxFrame *parent, wxWindowID id, const wxString &title ) @section overview_sizer_types Other Types of Sizers -wxStdDialogButtonSizer is a sizer that creates button layouts in dialogs -which conform to the standard button spacing and ordering defined by +wxStdDialogButtonSizer is a sizer that creates button layouts in dialogs +which conform to the standard button spacing and ordering defined by the platform or toolkit's user interface guidelines (if such things exist). As a convenience, wxDialog::CreateButtonSizer() can be used to create this sizer. -wxWrapSizer is a sizer that lays out its items in a single line, like a box -sizer -- as long as there is space available in that direction. Once all available -space in the primary direction has been used, a new line is added and items -are added there. +wxWrapSizer is a sizer that lays out its items in a single line, like a box +sizer -- as long as there is space available in that direction. Once all available +space in the primary direction has been used, a new line is added and items +are added there. wxGridBagSizer is a rather special kind of sizer which, unlike the other classes, allows to directly put the elements at the given position in the -sizer. +sizer. */ diff --git a/docs/doxygen/scripts/c_tools.py b/docs/doxygen/scripts/c_tools.py index 8bf0dd5aa9..914839512e 100644 --- a/docs/doxygen/scripts/c_tools.py +++ b/docs/doxygen/scripts/c_tools.py @@ -16,14 +16,14 @@ class CBuilder: output_dir = os.path.abspath(os.path.join(self.output_dir, "c")) if not os.path.exists(output_dir): os.makedirs(output_dir) - + for aclass in self.doxyparser.classes: # This bit doesn't work, because the aclass.name is not the same as # those listed in common if aclass.name in excluded_classes: #print "Skipping %s" % aclass.name continue - + self.make_c_header(output_dir, aclass) @@ -46,7 +46,7 @@ class CBuilder: def make_c_methods(self, aclass): retval = "" - + wxc_classname = 'wxC' + aclass.name[2:].capitalize() for amethod in aclass.constructors: @@ -59,13 +59,13 @@ class CBuilder: if amethod.name.startswith('m_'): # for some reason, public members are listed as methods continue - + args = '(' + wxc_classname + '* obj' if amethod.argsstring.find('()') != -1: args += ')' - else: + else: args += ', ' + amethod.argsstring[1:].strip() - + retval += """ // %s %s %s%s;\n diff --git a/docs/doxygen/scripts/common.py b/docs/doxygen/scripts/common.py index 5285e0e3c5..e9952cbeb7 100644 --- a/docs/doxygen/scripts/common.py +++ b/docs/doxygen/scripts/common.py @@ -15,7 +15,7 @@ excluded_classes = [ "wxArchiveIterator", "wxArchiveNotifier", "wxArchiveOutputStream", - "wxArray< T >", + "wxArray< T >", "wxArrayString", "wxAutomationObject", "wxBufferedInputStream", @@ -160,5 +160,5 @@ def make_enums(aclass): retval += ", " retval += "\n" retval += "};\n\n" - + return retval diff --git a/docs/doxygen/scripts/doxymlparser.py b/docs/doxygen/scripts/doxymlparser.py index a880524fc8..306aef9185 100755 --- a/docs/doxygen/scripts/doxymlparser.py +++ b/docs/doxygen/scripts/doxymlparser.py @@ -38,23 +38,23 @@ class ClassDefinition: self.includes = [] self.bases = [] self.enums = {} - + def __str__(self): str_repr = """ Class: %s Bases: %s Includes: %s -Brief Description: +Brief Description: %s Detailed Description: %s """ % (self.name, string.join(self.bases, ", "), self.includes, self.brief_description, self.detailed_description) str_repr += "Methods:\n" - + for method in self.methods: str_repr += str(method) - + return str_repr class MethodDefinition: @@ -66,20 +66,20 @@ class MethodDefinition: self.params = [] self.brief_description = "" self.detailed_description = "" - + def __str__(self): str_repr = """ Method: %s Return Type: %s Params: %r Prototype: %s -Brief Description: +Brief Description: %s Detailed Description: %s """ % (self.name, self.return_type, self.params, self.definition + self.argsstring, self.brief_description, self.detailed_description) - return str_repr + return str_repr def getTextValue(node, recursive=False): text = "" @@ -89,7 +89,7 @@ def getTextValue(node, recursive=False): if child.nodeType == child.TEXT_NODE: # Add a space to ensure we have a space between qualifiers and parameter names text += child.nodeValue.strip() + " " - + return text.strip() def doxyMLToText(node): @@ -104,7 +104,7 @@ class DoxyMLParser: for aclass in self.classes: if aclass.name == name: return aclass - + return None def get_enums_and_functions(self, filename, aclass): @@ -119,17 +119,17 @@ class DoxyMLParser: def is_derived_from_base(self, aclass, abase): base = get_first_value(aclass.bases) while base and base != "": - + if base == abase: return True - + parentclass = self.find_class(base) - + if parentclass: base = get_first_value(parentclass.bases) else: base = None - + return False def parse(self, filename): @@ -138,7 +138,7 @@ class DoxyMLParser: new_class = self.parse_class(node) self.classes.append(new_class) self.get_enums_and_functions(filename, new_class) - + def parse_class(self, class_node): new_class = ClassDefinition() new_class.name = getTextValue(class_node.getElementsByTagName("compoundname")[0]) @@ -156,21 +156,21 @@ class DoxyMLParser: self.parse_methods(new_class, class_node) return new_class - + def parse_enum(self, new_class, enum, root): enum_name = "" enum_values = [] - + for node in enum.childNodes: if node.nodeName == "name": enum_name = getTextValue(node) elif node.nodeName == "enumvalue": enum_values.append(getTextValue(node.getElementsByTagName("name")[0])) - + new_class.enums[enum_name] = enum_values - + def parse_methods(self, new_class, root): - for method in root.getElementsByTagName("memberdef"): + for method in root.getElementsByTagName("memberdef"): new_method = MethodDefinition() for node in method.childNodes: if node.nodeName == "name": @@ -187,10 +187,10 @@ class DoxyMLParser: if child.nodeType == child.ELEMENT_NODE: param[child.nodeName] = getTextValue(child) new_method.params.append(param) - + if self.verbose: print "Adding %s" % (new_method.name + new_method.argsstring) - + if new_method.name == new_class.name: new_class.constructors.append(new_method) elif new_method.name == "~" + new_class.name: @@ -199,30 +199,30 @@ class DoxyMLParser: new_class.methods.append(new_method) if __name__ == "__main__": - option_dict = { + option_dict = { "report" : (False, "Print out the classes and methods found by this script."), "verbose" : (False, "Provide status updates and other information."), } - + parser = optparse.OptionParser(usage="usage: %prog [options] \n" + __description__, version="%prog 1.0") - + for opt in option_dict: default = option_dict[opt][0] - + action = "store" if type(default) == types.BooleanType: action = "store_true" parser.add_option("--" + opt, default=default, action=action, dest=opt, help=option_dict[opt][1]) - + options, arguments = parser.parse_args() if len(arguments) < 1: parser.print_usage() sys.exit(1) - + doxyparse = DoxyMLParser(verbose = options.verbose) for arg in arguments: - doxyparse.parse(arg) + doxyparse.parse(arg) if options.report: for aclass in doxyparse.classes: diff --git a/docs/doxygen/scripts/make_bindings.py b/docs/doxygen/scripts/make_bindings.py index 5411d07b56..6b9f9da8f4 100644 --- a/docs/doxygen/scripts/make_bindings.py +++ b/docs/doxygen/scripts/make_bindings.py @@ -12,42 +12,42 @@ import swig_tools from common import * if __name__ == "__main__": - option_dict = { + option_dict = { "output_dir" : ("output", "Directory to output bindings to"), "sip" : (True, "Produce SIP bindings"), "swig" : (True, "Produce SWIG bindings."), "c" : (True, "Produce C wrappers."), - + } - + parser = optparse.OptionParser(usage="usage: %prog \n" , version="%prog 1.0") - + for opt in option_dict: default = option_dict[opt][0] - + action = "store" if type(default) == types.BooleanType: action = "store_true" parser.add_option("--" + opt, default=default, action=action, dest=opt, help=option_dict[opt][1]) - + options, arguments = parser.parse_args() if len(arguments) < 1: parser.print_usage() sys.exit(1) - + doxyparse = doxymlparser.DoxyMLParser() for arg in arguments: doxyparse.parse(arg) - + if options.sip: builder = sip_tools.SIPBuilder(doxyparse, options.output_dir) builder.make_bindings() - + if options.swig: builder = swig_tools.SWIGBuilder(doxyparse, options.output_dir) builder.make_bindings() - + if options.c: builder = c_tools.CBuilder(doxyparse, options.output_dir) builder.make_bindings() diff --git a/docs/doxygen/scripts/sip_tools.py b/docs/doxygen/scripts/sip_tools.py index f48d875765..ac8d2fb20b 100644 --- a/docs/doxygen/scripts/sip_tools.py +++ b/docs/doxygen/scripts/sip_tools.py @@ -11,12 +11,12 @@ class SIPBuilder: output_dir = os.path.abspath(os.path.join(self.output_dir, "sip")) if not os.path.exists(output_dir): os.makedirs(output_dir) - + for aclass in self.doxyparser.classes: if aclass.name in excluded_classes: print "Skipping %s" % aclass.name continue - + header_name = aclass.name[2:].lower() filename = os.path.join(output_dir, "_" + header_name + ".sip") enums_text = make_enums(aclass) @@ -24,7 +24,7 @@ class SIPBuilder: base_class = get_first_value(aclass.bases) if base_class != "": base_class = ": %s" % base_class - + text = """ %s class %s %s @@ -45,12 +45,12 @@ public: def make_sip_methods(self, aclass): retval = "" - + for amethod in aclass.constructors + aclass.methods: transfer = "" - + # FIXME: we need to come up with a way of filtering the methods out by various criteria - # including parameters and method name, and how to deal with overloads + # including parameters and method name, and how to deal with overloads if aclass.name in ignored_methods: should_ignore = False for method in ignored_methods[aclass.name]: @@ -66,19 +66,19 @@ public: print "param type = %s, amethod.param type = %s" % (params[i], amethod.params[i]["type"]) should_ignore = False break - + if should_ignore: continue - + # We need to let SIP know when wx is responsible for deleting the object. # We do this if the class is derived from wxWindow, since wxTLW manages child windows # and wxApp deletes all wxTLWs on shutdown if amethod in aclass.constructors and self.doxyparser.is_derived_from_base(aclass, "wxWindow"): transfer = "/Transfer/" - + if amethod.name.startswith("operator"): continue - + retval += " %s %s%s%s;\n\n" % (amethod.return_type.replace("virtual ", ""), amethod.name, amethod.argsstring, transfer) - + return retval diff --git a/docs/doxygen/scripts/swig_tools.py b/docs/doxygen/scripts/swig_tools.py index 2a3e6e3fc6..bc1f5ebe7b 100644 --- a/docs/doxygen/scripts/swig_tools.py +++ b/docs/doxygen/scripts/swig_tools.py @@ -11,13 +11,13 @@ class SWIGBuilder: output_dir = os.path.abspath(os.path.join(self.output_dir, "swig")) if not os.path.exists(output_dir): os.makedirs(output_dir) - + for aclass in self.doxyparser.classes: header_name = aclass.name[2:].lower() if aclass.name in excluded_classes: #print "Skipping %s" % aclass.name continue - + filename = os.path.join(output_dir, "_" + header_name + ".i") enums_text = make_enums(aclass) method_text = self.make_swig_methods(aclass) @@ -37,25 +37,25 @@ public: afile.write(text) afile.close() - + def make_swig_methods(self, aclass): retval = "" - + retval += """ %%pythonAppend %s "self._setOORInfo(self)" %%pythonAppend %s() "" %%typemap(out) %s*; // turn off this typemap """ % (aclass.name, aclass.name, aclass.name) - + for amethod in aclass.constructors: retval += " %s%s;\n\n" % (amethod.name, amethod.argsstring) - + retval += """ // Turn it back on again - %%typemap(out) %s* { $result = wxPyMake_wxObject($1, $owner); } + %%typemap(out) %s* { $result = wxPyMake_wxObject($1, $owner); } """ % aclass.name - + for amethod in aclass.methods: retval += " %s %s%s;\n\n" % (amethod.return_type, amethod.name, amethod.argsstring) - + return retval diff --git a/docs/gtk/nonnative.txt b/docs/gtk/nonnative.txt index 92756c7789..704a1b663c 100644 --- a/docs/gtk/nonnative.txt +++ b/docs/gtk/nonnative.txt @@ -8,7 +8,7 @@ List of classes which should use their native GTK+ equivalents but don't: - wxTreeCtrl Ryan Norton has implemented this - + - wxListCtrl Could be reimplemeted in terms of wxDataViewCtrl? diff --git a/docs/lgpl.txt b/docs/lgpl.txt index d43cdf091b..12e440211e 100644 --- a/docs/lgpl.txt +++ b/docs/lgpl.txt @@ -58,7 +58,7 @@ free library. If the library is modified by someone else and passed on, we want its recipients to know that what they have is not the original version, so that any problems introduced by others will not reflect on the original authors' reputations. - + Finally, any free program is threatened constantly by software patents. We wish to avoid the danger that companies distributing free software will individually obtain patent @@ -148,7 +148,7 @@ constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. - + 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an @@ -160,7 +160,7 @@ along with the Library. You may charge a fee for the physical act of transferring a copy, and you may at your option offer warranty protection in exchange for a fee. - + 2. You may modify your copy or copies of the Library or any portion of it, thus forming a work based on the Library, and copy and distribute such modifications or work under the terms @@ -220,7 +220,7 @@ Public License, version 2, instead of to this License. (If a newer version than version 2 of the ordinary GNU General Public License has appeared, then you can specify that version instead if you wish.) Do not make any other change in these notices. - + Once this change is made in a given copy, it is irreversible for that copy, so the ordinary GNU General Public License applies to all subsequent copies and derivative works made from that copy. @@ -278,7 +278,7 @@ distribute the object code for the work under the terms of Section 6. Any executables containing that work also fall under Section 6, whether or not they are linked directly with the Library itself. - + 6. As an exception to the Sections above, you may also compile or link a "work that uses the Library" with the Library to produce a work containing portions of the Library, and @@ -332,7 +332,7 @@ restrictions of other proprietary libraries that do not normally accompany the operating system. Such a contradiction means you cannot use both them and the Library together in an executable that you distribute. - + 7. You may place library facilities that are a work based on the Library side-by-side in a single library together with other library facilities not covered by this License, and distribute @@ -376,7 +376,7 @@ modify the Library subject to these terms and conditions. You may not impose any further restrictions on the recipients' exercise of the rights granted herein. You are not responsible for enforcing compliance by third parties to this License. - + 11. If, as a consequence of a court judgment or allegation of patent infringement or for any other reason (not limited to patent issues), conditions are imposed on you (whether by court diff --git a/docs/licence.txt b/docs/licence.txt index 5bfc0e7954..0a25857e6c 100644 --- a/docs/licence.txt +++ b/docs/licence.txt @@ -8,12 +8,12 @@ WXWINDOWS LIBRARY LICENCE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION - + This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public Licence as published by the Free Software Foundation; either version 2 of the Licence, or (at your option) any later version. - + This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library @@ -46,7 +46,7 @@ accordingly. 4. If you write modifications of your own for this library, it is your - choice whether to permit this exception to apply to your modifications. + choice whether to permit this exception to apply to your modifications. If you do not wish that, you must delete the exception notice from such code and/or adjust the licensing conditions notice accordingly. diff --git a/docs/licendoc.txt b/docs/licendoc.txt index 5bfa143812..0772d7f4cf 100644 --- a/docs/licendoc.txt +++ b/docs/licendoc.txt @@ -5,7 +5,7 @@ Everyone is permitted to copy and distribute verbatim copies of this licence document, but changing it is not allowed. - + WXWINDOWS FREE DOCUMENTATION LICENCE TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION @@ -37,7 +37,7 @@ WARRANTY DISCLAIMER 5. BECAUSE THIS MANUAL OR PIECE OF DOCUMENTATION IS LICENSED FREE OF CHARGE, - THERE IS NO WARRANTY FOR IT, TO THE EXTENT PERMITTED BY APPLICABLE LAW. + THERE IS NO WARRANTY FOR IT, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THIS MANUAL OR PIECE OF DOCUMENTATION "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT diff --git a/docs/publicity/WoWoW30.html b/docs/publicity/WoWoW30.html index 60288dc16a..e547cafeec 100644 --- a/docs/publicity/WoWoW30.html +++ b/docs/publicity/WoWoW30.html @@ -170,7 +170,7 @@ class, container classes, as well as classes for threading, networking, XML parsing, path and configuration management, logging, debugging etc. These functions and classes have been separated into their own library both for being able to write non-GUI apps as well -as to make maintainance easier through reduced interdependence. +as to make maintainance easier through reduced interdependence.

Many of the changes to wxString and the container classes are located in wxBase, but on top of that support to wxBase @@ -186,7 +186,7 @@ change. Rather, this paragraph summarizes the most relevant changes to the GUI classes of wxWidgets. Given wxWidgets' nature as a GUI library, these changes are also most likely to be visible to the user and may thus be the most important changes from a user's perspective -(although not necessarily from a developer's perspective): +(although not necessarily from a developer's perspective):

  • wxDataViewCtrl and wxDataViewTreeCtrl: this @@ -310,7 +310,7 @@ cases, supporting an old version of GTK+ hinders development so we decided to declare GTK+ 2.6 the minimum toolkit version that is supported. As an example, this made it possible to always use the GTK+ file dialog instead of the old generic file dialog which had to -be used when GTK+ didn't have a usable file dialog. +be used when GTK+ didn't have a usable file dialog.

    Other parts of wxGTK that were rewritten or which underwent a major update include, but are not diff --git a/docs/publicity/slogans.txt b/docs/publicity/slogans.txt index 19c7263c24..a7eef61e6a 100644 --- a/docs/publicity/slogans.txt +++ b/docs/publicity/slogans.txt @@ -73,7 +73,7 @@ maybe stripped down to "Specialization is for insects." ============================ -The Open-Source, Cross-Platform GUI Framework +The Open-Source, Cross-Platform GUI Framework with Ten Years of Evolution Behind It I saw this changed to 'native UI' on the website, which is slightly more @@ -81,17 +81,17 @@ accurate but sounds less 'catchy' imho. .. and templates. -Hmm. I might buy a mug that had, say, a wxLogo and "wxWidgets" (and -maybe the website URL underneath in smaller type) on one side and +Hmm. I might buy a mug that had, say, a wxLogo and "wxWidgets" (and +maybe the website URL underneath in smaller type) on one side and "Specialization is for insects ... and templates" on the other. -.. only if it held at leat a full half (imperial) pint, mind. Not +.. only if it held at leat a full half (imperial) pint, mind. Not one of those wussy 8.5 fl.oz. jobbies. -That'd be a nice ice-breaker when working at a new client's site - +That'd be a nice ice-breaker when working at a new client's site - people would be bound to stop and ask what it was all about! -.. and how about a nice silk tie (US: necktie) with the logo on ... +.. and how about a nice silk tie (US: necktie) with the logo on ... Oh, I forgot, we programmers don't wear ties. ============================ @@ -149,7 +149,7 @@ One API to bridge them all and in the compiler bind them. wxWidgets -How about "and in the linker bind them"? That's where the local libraries +How about "and in the linker bind them"? That's where the local libraries get bound to the wxWidgets code anyway. ============================ @@ -162,7 +162,7 @@ Hugh Gibson wrote: > window control in different operating systems to emphasise the > native look and feel. -Nice idea. But I wonder where you'll find some volunteer willing to +Nice idea. But I wonder where you'll find some volunteer willing to have his face tattooed with win32 common controls ;-) ============================ diff --git a/docs/vms/readme.txt b/docs/vms/readme.txt index 8aeb8c9d0b..e403857dc7 100644 --- a/docs/vms/readme.txt +++ b/docs/vms/readme.txt @@ -7,7 +7,7 @@ The compilation was tested with -Compaq C++ 6.2 -DECWindows 1.2-5 -GTK1.2.8 (for wxGTK) - + To get everything compiled you'll need to have installed prior to compiling wxWidgets: -Bison @@ -19,7 +19,7 @@ wxWidgets: #define alloca malloc before #endif /* __hpux */ - + -Flex get it from http://www.openvms.digital.com/freeware/ @@ -119,7 +119,7 @@ $ ass $disk2:[joukj.public.gtk.gtk.glib],- -I think in general wxGTK is better maintained, so that version is my first choice. - + -Note that only a few people have used wxWidgets on VMS so many problems are to be expected. @@ -147,7 +147,7 @@ $ ass $disk2:[joukj.public.gtk.gtk.glib],- again. -image sample: after clicking "about" the colourmap is permanently changed resulting in strange images - + Finally : I like the idea of Robert Roebling that CD's with classical music should be send to the authors. @@ -156,7 +156,7 @@ send to the authors. >-----------------------------------------------------------------------------< Jouk Jansen - + joukj@hrem.stm.tudelft.nl diff --git a/docs/wine/COPYING.LIB b/docs/wine/COPYING.LIB index eb685a5ec9..bbe3fe1987 100644 --- a/docs/wine/COPYING.LIB +++ b/docs/wine/COPYING.LIB @@ -133,7 +133,7 @@ such a program is covered only if its contents constitute a work based on the Library (independent of the use of the Library in a tool for writing it). Whether that is true depends on what the Library does and what the program that uses the Library does. - + 1. You may copy and distribute verbatim copies of the Library's complete source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an diff --git a/docs/wine/changes.txt b/docs/wine/changes.txt index c9d3429da5..1be099a744 100644 --- a/docs/wine/changes.txt +++ b/docs/wine/changes.txt @@ -9,4 +9,4 @@ for wxWINE is in place and that all that has to be done to get wxWINE running is to make WINE work as Win32. No joke intended. Robert Roebling - + diff --git a/docs/wine/install.txt b/docs/wine/install.txt index 9a5cd5da1a..e6e3d3311b 100644 --- a/docs/wine/install.txt +++ b/docs/wine/install.txt @@ -2,7 +2,7 @@ * The most simple case ----------------------- -If you compile wxWidgets on Linux for the first time and don't like to read +If you compile wxWidgets on Linux for the first time and don't like to read install instructions just do (in the base dir): > ./configure --with-wine @@ -12,8 +12,8 @@ install instructions just do (in the base dir): > ldconfig > exit -On all variants of Unix except Linux (and maybe except *BSD), shared libraries -are not supported out of the box due to the utter stupidity of libtool, so you'll +On all variants of Unix except Linux (and maybe except *BSD), shared libraries +are not supported out of the box due to the utter stupidity of libtool, so you'll have to do this to get shared library support: > ./configure --with-wine --disable-unicode --disable-static --enable-shared @@ -23,12 +23,12 @@ important entries with respect to shared library creation, which are archive_cmds="\$LD -shared .... archive_expsym_cmds="\$LD -shared .... - + which should be something like archive_cmds="\$CC -shared .... archive_expsym_cmds="\$CC -shared .... - + Afterwards you can continue with > make @@ -47,14 +47,14 @@ If you want to remove wxWidgets on Unix you can do this: * The expert case ----------------- -If you want to do some more serious cross-platform programming with wxWidgets, -such as for GTK and Motif, you can now build two complete libraries and use -them concurrently. For this end, you have to create a directory for each build +If you want to do some more serious cross-platform programming with wxWidgets, +such as for GTK and Motif, you can now build two complete libraries and use +them concurrently. For this end, you have to create a directory for each build of wxWidgets - you may also want to create different versions of wxWidgets -and test them concurrently. Most typically, this would be a version configured -with --enable-debug_flag and one without. Note, that only one build can currently +and test them concurrently. Most typically, this would be a version configured +with --enable-debug_flag and one without. Note, that only one build can currently be installed, so you'd have to use local version of the library for that purpose. -For building three versions (one GTK, one WINE and a debug version of the WINE +For building three versions (one GTK, one WINE and a debug version of the WINE source) you'd do this: md buildmotif @@ -78,18 +78,18 @@ cd .. * The most simple errors ------------------------ -wxWINE doesn't work yet as WINE isn't really up to the task yet. +wxWINE doesn't work yet as WINE isn't really up to the task yet. -You get errors during compilation: The reason is that you probably have a broken -compiler, which includes almost everything that is called gcc. If you use gcc 2.8 -you have to disable optimisation as the compiler will give up with an internal +You get errors during compilation: The reason is that you probably have a broken +compiler, which includes almost everything that is called gcc. If you use gcc 2.8 +you have to disable optimisation as the compiler will give up with an internal compiler error. If there is just any way for you to use egcs, use egcs. We cannot fix gcc. -You get immediate segfault when starting any sample or application: This is either -due to having compiled the library with different flags or options than your program - -typically you might have the __WXDEBUG__ option set for the library but not for your +You get immediate segfault when starting any sample or application: This is either +due to having compiled the library with different flags or options than your program - +typically you might have the __WXDEBUG__ option set for the library but not for your program - or due to using a broken compiler (and its optimisation) such as GCC 2.8. * The most simple program @@ -102,27 +102,27 @@ g++ myfoo.cpp `wx-config --libs --cflags` -o myfoo * General ----------------------- -The Unix variants of wxWidgets use GNU configure. If you have problems with your +The Unix variants of wxWidgets use GNU configure. If you have problems with your make use GNU make instead. -If you have general problems with installation, read my homepage at +If you have general problems with installation, read my homepage at http://wesley.informatik.uni-freiburg.de/~wxxt - -for newest information. If you still don't have any success, please send a bug -report to one of our mailing lists (see my homepage) INCLUDING A DESCRIPTION OF -YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF WINE, WXWINE, WHAT DISTRIBUTION + +for newest information. If you still don't have any success, please send a bug +report to one of our mailing lists (see my homepage) INCLUDING A DESCRIPTION OF +YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF WINE, WXWINE, WHAT DISTRIBUTION YOU USE AND WHAT ERROR WAS REPORTED. I know this has no effect, but I tried... * GUI libraries ----------------------- -wxWidgets/WINE requires the WINE library to be installed on your system. +wxWidgets/WINE requires the WINE library to be installed on your system. You can get the newest version of the WINE from the WINE homepage at: http://www.winehq.com - + * Create your configuration ----------------------------- @@ -141,16 +141,16 @@ to see all the options please use: ./configure --help The basic philosophy is that if you want to use different -configurations, like a debug and a release version, +configurations, like a debug and a release version, or use the same source tree on different systems, you have only to change the environment variable OSTYPE. (Sadly this variable is not set by default on some systems -in some shells - on SGI's for example). So you will have to -set it there. This variable HAS to be set before starting -configure, so that it knows which system it tries to +in some shells - on SGI's for example). So you will have to +set it there. This variable HAS to be set before starting +configure, so that it knows which system it tries to configure for. -Configure will complain if the system variable OSTYPE has +Configure will complain if the system variable OSTYPE has not been defined. And Make in some circumstances as well... @@ -167,7 +167,7 @@ in wxWidgets snapshot 6, but not yet all (ODBC not). You must do this by running configure with either of: --with-wine Use the WINE library - + The following options handle the kind of library you want to build. --enable-threads Compile with thread support. Threads @@ -182,25 +182,25 @@ The following options handle the kind of library you want to build. such as Sun with gcc 2.8.X which would otherwise produce segvs. - --enable-profile Add profiling info to the object + --enable-profile Add profiling info to the object files. Currently broken, I think. - + --enable-no_rtti Enable compilation without creation of - C++ RTTI information in object files. - This will speed-up compilation and reduce + C++ RTTI information in object files. + This will speed-up compilation and reduce binary size. - + --enable-no_exceptions Enable compilation without creation of - C++ exception information in object files. - This will speed-up compilation and reduce + C++ exception information in object files. + This will speed-up compilation and reduce binary size. Also fewer crashes during the actual compilation... - - --enable-mem_tracing Add built-in memory tracing. - + + --enable-mem_tracing Add built-in memory tracing. + --enable-dmalloc Use the dmalloc memory debugger. Read more at www.letters.com/dmalloc/ - + --enable-debug_info Add debug info to object files and executables for use with debuggers such as gdb (or its many frontends). @@ -210,7 +210,7 @@ The following options handle the kind of library you want to build. useful internal debugging tricks (such as automatically reporting illegal calls) to work. Note that program and library - must be compiled with the same debug + must be compiled with the same debug options. * Feature Options @@ -221,42 +221,42 @@ in wxWidgets snapshot 6, but not yet all (ODBC not). When producing an executable that is linked statically with wxGTK you'll be surprised at its immense size. This can sometimes be -drastically reduced by removing features from wxWidgets that +drastically reduced by removing features from wxWidgets that are not used in your program. The most relevant such features are --without-libpng Disables PNG image format code. - + --without-libjpeg Disables JPEG image format code. - + { --without-odbc Disables ODBC code. Not yet. } - + --disable-resources Disables the use of *.wxr type resources. - + --disable-threads Disables threads. Will also disable sockets. --disable-sockets Disables sockets. --disable-dnd Disables Drag'n'Drop. - + --disable-clipboard Disables Clipboard. - + --disable-serial Disables object instance serialisation. - + --disable-streams Disables the wxStream classes. - + --disable-file Disables the wxFile class. - + --disable-textfile Disables the wxTextFile class. - + --disable-intl Disables the internationalisation. - + --disable-validators Disables validators. - + --disable-accel Disables accel. - + Apart from disabling certain features you can very often "strip" the program of its debugging information resulting in a significant reduction in size. @@ -267,13 +267,13 @@ reduction in size. The following must be done in the base directory (e.g. ~/wxGTK or ~/wxWin or whatever) -Now the makefiles are created (by configure) and you can compile +Now the makefiles are created (by configure) and you can compile the library by typing: make make yourself some coffee, as it will take some time. On an old -386SX possibly two weeks. During compilation, you'll get a few +386SX possibly two weeks. During compilation, you'll get a few warning messages depending in your compiler. If you want to be more selective, you can change into a specific @@ -284,12 +284,12 @@ Then you may install the library and its header files under have to log in as root (i.e. run "su" and enter the root password) and type - make install + make install You can remove any traces of wxWidgets by typing make uninstall - + If you want to save disk space by removing unnecessary object-files: @@ -316,13 +316,13 @@ minimal: minimal.o minimal.o: minimal.cpp $(CXX) `wx-config --cflags` -c minimal.cpp -o minimal.o -clean: +clean: rm -f *.o minimal This is certain to become the standard way unless we decide to stick to tmake. -2) The other way creates a project within the source code +2) The other way creates a project within the source code directories of wxWidgets. For this endeavour, you'll need the usual number of GNU tools, at least @@ -331,7 +331,7 @@ GNU autoheader version 2.14 GNU autoconf version 2.14 GNU libtool version 1.3 -and quite possibly +and quite possibly GNU make GNU C++ @@ -344,10 +344,10 @@ go ahead yourself :-) In the hope that it will be useful, Robert Roebling - + Addition notes by Julian Smart, August 2002 -=========================================== +=========================================== I've fixed some compile errors, and got as far as compiling wxWINE, but actually linking a sample will take diff --git a/docs/wine/readme.txt b/docs/wine/readme.txt index 7d3d8a867d..00a719a36f 100644 --- a/docs/wine/readme.txt +++ b/docs/wine/readme.txt @@ -9,15 +9,15 @@ install.txt. When you run into problems, please read the install.txt and follow those instructions. If you still don't have any success, please send a bug report to one of our mailing lists (see -my homepage) INCLUDING A DESCRIPTION OF YOUR SYSTEM AND +my homepage) INCLUDING A DESCRIPTION OF YOUR SYSTEM AND YOUR PROBLEM, SUCH AS YOUR VERSION OF THE WINE SOURCES, WHAT DISTRIBUTION YOU USE AND WHAT ERROR WAS REPORTED. -Please send problems concerning installation, feature requests, -bug reports or comments to the wxWidgets users list. Information +Please send problems concerning installation, feature requests, +bug reports or comments to the wxWidgets users list. Information on how to subscribe is available from my homepage. -wxWidgets/Wine doesn't come with any guarantee whatsoever. It might +wxWidgets/Wine doesn't come with any guarantee whatsoever. It might crash your harddisk or destroy your monitor. It doesn't claim to be suitable for any special or general purpose. diff --git a/docs/xserver.txt b/docs/xserver.txt index c29ee4fbde..3758388f12 100644 --- a/docs/xserver.txt +++ b/docs/xserver.txt @@ -26,13 +26,13 @@ Copyright 1987 by Digital Equipment Corporation, Maynard, Massachusetts. All Rights Reserved -Permission to use, copy, modify, and distribute this software and its -documentation for any purpose and without fee is hereby granted, +Permission to use, copy, modify, and distribute this software and its +documentation for any purpose and without fee is hereby granted, provided that the above copyright notice appear in all copies and that -both that copyright notice and this permission notice appear in +both that copyright notice and this permission notice appear in supporting documentation, and that the name of Digital not be used in advertising or publicity pertaining to distribution of the -software without specific, written prior permission. +software without specific, written prior permission. DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL diff --git a/include/msvc/wx/setup.h b/include/msvc/wx/setup.h index 122b67a3c0..e0b9ed4d6f 100644 --- a/include/msvc/wx/setup.h +++ b/include/msvc/wx/setup.h @@ -160,7 +160,7 @@ #pragma comment(lib, wxBASE_LIB_NAME("net")) #endif #if wxUSE_XML && !defined(wxNO_XML_LIB) - #pragma comment(lib, wxBASE_LIB_NAME("xml")) + #pragma comment(lib, wxBASE_LIB_NAME("xml")) #endif #endif // defined(wxMONOLITHIC) && wxMONOLITHIC == 1 @@ -204,7 +204,7 @@ #if wxUSE_HTML && !defined(wxNO_HTML_LIB) #pragma comment(lib, wxTOOLKIT_LIB_NAME("html")) - #endif + #endif #if wxUSE_DEBUGREPORT && !defined(wxNO_QA_LIB) #pragma comment(lib, wxTOOLKIT_LIB_NAME("qa")) #endif @@ -227,7 +227,7 @@ #pragma comment(lib, wxTOOLKIT_LIB_NAME("media")) #endif #if wxUSE_STC && !defined(wxNO_STC_LIB) - #pragma comment(lib, wxTOOLKIT_LIB_NAME("stc")) + #pragma comment(lib, wxTOOLKIT_LIB_NAME("stc")) #endif #if wxUSE_WEBVIEW && !defined(wxNO_WEBVIEW_LIB) #pragma comment(lib, wxTOOLKIT_LIB_NAME("webview")) diff --git a/include/wx/accel.h b/include/wx/accel.h index 604039561f..98fc2460f7 100644 --- a/include/wx/accel.h +++ b/include/wx/accel.h @@ -33,7 +33,7 @@ enum wxAcceleratorEntryFlags wxACCEL_CTRL = 0x0002, // hold Ctrl key down wxACCEL_SHIFT = 0x0004, // hold Shift key down #if defined(__WXMAC__) - wxACCEL_RAW_CTRL= 0x0008, // + wxACCEL_RAW_CTRL= 0x0008, // #else wxACCEL_RAW_CTRL= wxACCEL_CTRL, #endif diff --git a/include/wx/app.h b/include/wx/app.h index d16f209732..33810ef719 100644 --- a/include/wx/app.h +++ b/include/wx/app.h @@ -104,7 +104,7 @@ public: // Called before the first events are handled, called from within MainLoop() virtual void OnLaunched(); - + // This is called by wxEventLoopBase::SetActive(): you should put the code // which needs an active event loop here. // Note that this function is called whenever an event loop is activated; diff --git a/include/wx/aui/auibook.h b/include/wx/aui/auibook.h index f7fdd1559c..578b381874 100644 --- a/include/wx/aui/auibook.h +++ b/include/wx/aui/auibook.h @@ -350,7 +350,7 @@ public: virtual int ChangeSelection(size_t n) wxOVERRIDE; - virtual bool AddPage(wxWindow *page, const wxString &text, bool select, + virtual bool AddPage(wxWindow *page, const wxString &text, bool select, int imageId) wxOVERRIDE; virtual bool DeleteAllPages() wxOVERRIDE; virtual bool InsertPage(size_t index, wxWindow *page, const wxString &text, diff --git a/include/wx/colour.h b/include/wx/colour.h index 7565f09162..e9a13ef95e 100644 --- a/include/wx/colour.h +++ b/include/wx/colour.h @@ -118,7 +118,7 @@ public: virtual ChannelType Blue() const = 0; virtual ChannelType Alpha() const { return wxALPHA_OPAQUE ; } - + virtual bool IsSolid() const { return true; } diff --git a/include/wx/dataobj.h b/include/wx/dataobj.h index 348ad20286..1785016500 100644 --- a/include/wx/dataobj.h +++ b/include/wx/dataobj.h @@ -345,11 +345,11 @@ public: virtual size_t GetLength() const { return m_html.Len() + 1; } virtual wxString GetHTML() const { return m_html; } virtual void SetHTML(const wxString& html) { m_html = html; } - + virtual size_t GetDataSize() const wxOVERRIDE; virtual bool GetDataHere(void *buf) const wxOVERRIDE; virtual bool SetData(size_t len, const void *buf) wxOVERRIDE; - + // Must provide overloads to avoid hiding them (and warnings about it) virtual size_t GetDataSize(const wxDataFormat&) const wxOVERRIDE { diff --git a/include/wx/dc.h b/include/wx/dc.h index 8d445e9f6b..dd5eb2251d 100644 --- a/include/wx/dc.h +++ b/include/wx/dc.h @@ -283,7 +283,7 @@ public: } virtual void* GetHandle() const { return NULL; } - + // query dimension, colour deps, resolution virtual void DoGetSize(int *width, int *height) const = 0; @@ -528,7 +528,7 @@ public: // this needs to overidden if the axis is inverted virtual void SetAxisOrientation(bool xLeftRight, bool yBottomUp); - + virtual double GetContentScaleFactor() const { return m_contentScaleFactor; } #ifdef __WXMSW__ @@ -722,7 +722,7 @@ protected: double m_scaleX, m_scaleY; // calculated from logical scale and user scale int m_signX, m_signY; // Used by SetAxisOrientation() to invert the axes - + double m_contentScaleFactor; // used by high resolution displays (retina) // Pixel per mm in horizontal and vertical directions. diff --git a/include/wx/dcbuffer.h b/include/wx/dcbuffer.h index fb912f6e24..4a29fda820 100644 --- a/include/wx/dcbuffer.h +++ b/include/wx/dcbuffer.h @@ -134,7 +134,7 @@ private: int m_style; wxSize m_area; - + wxDECLARE_DYNAMIC_CLASS(wxBufferedDC); wxDECLARE_NO_COPY_CLASS(wxBufferedDC); }; diff --git a/include/wx/dcgraph.h b/include/wx/dcgraph.h index b75d715c7b..c2482d78c3 100644 --- a/include/wx/dcgraph.h +++ b/include/wx/dcgraph.h @@ -32,7 +32,7 @@ public: wxGCDC( const wxEnhMetaFileDC& dc ); #endif wxGCDC(wxGraphicsContext* context); - + wxGCDC(); virtual ~wxGCDC(); diff --git a/include/wx/fontutil.h b/include/wx/fontutil.h index aee4cf4fd5..35bd9508a6 100644 --- a/include/wx/fontutil.h +++ b/include/wx/fontutil.h @@ -129,7 +129,7 @@ public: #elif defined(__WXOSX__) public: wxNativeFontInfo(const wxNativeFontInfo& info) { Init(info); } - + ~wxNativeFontInfo() { Free(); } wxNativeFontInfo& operator=(const wxNativeFontInfo& info) @@ -147,7 +147,7 @@ public: void Init(const wxNativeFontInfo& info); void Free(); - + wxString GetFamilyName() const; wxString GetStyleName() const; @@ -157,8 +157,8 @@ public: static CGFloat GetCTWeight( CTFontRef font ); static CGFloat GetCTWeight( CTFontDescriptorRef font ); static CGFloat GetCTSlant( CTFontDescriptorRef font ); - - + + CTFontDescriptorRef GetCTFontDescriptor() const; private: // attributes for regenerating a CTFontDescriptor, stay close to native values @@ -167,7 +167,7 @@ private: wxFontStyle m_style; CGFloat m_ctSize; wxFontFamily m_family; - + wxString m_styleName; wxString m_familyName; diff --git a/include/wx/generic/headerctrlg.h b/include/wx/generic/headerctrlg.h index b145f1cbe2..f2ca427b8d 100644 --- a/include/wx/generic/headerctrlg.h +++ b/include/wx/generic/headerctrlg.h @@ -50,7 +50,7 @@ public: protected: virtual wxSize DoGetBestSize() const wxOVERRIDE; - + private: // implement base class pure virtuals virtual void DoSetCount(unsigned int count) wxOVERRIDE; diff --git a/include/wx/graphics.h b/include/wx/graphics.h index a35667491f..51c3e22150 100644 --- a/include/wx/graphics.h +++ b/include/wx/graphics.h @@ -35,7 +35,7 @@ enum wxInterpolationQuality // default interpolation wxINTERPOLATION_DEFAULT, // no interpolation - wxINTERPOLATION_NONE, + wxINTERPOLATION_NONE, // fast interpolation, suited for interactivity wxINTERPOLATION_FAST, // better quality @@ -206,7 +206,7 @@ public: #if wxUSE_IMAGE wxImage ConvertToImage() const; #endif // wxUSE_IMAGE - + void* GetNativeBitmap() const; const wxGraphicsBitmapData* GetBitmapData() const @@ -601,10 +601,10 @@ public: // returns the current interpolation quality virtual wxInterpolationQuality GetInterpolationQuality() const { return m_interpolation; } - + // sets the interpolation quality, returns true if it supported virtual bool SetInterpolationQuality(wxInterpolationQuality interpolation) = 0; - + // returns the current compositing operator virtual wxCompositionMode GetCompositionMode() const { return m_composition; } @@ -754,14 +754,14 @@ public: // helper to determine if a 0.5 offset should be applied for the drawing operation virtual bool ShouldOffset() const { return false; } - - // indicates whether the context should try to offset for pixel boundaries, this only makes sense on + + // indicates whether the context should try to offset for pixel boundaries, this only makes sense on // bitmap devices like screen, by default this is turned off virtual void EnableOffset(bool enable = true); - + void DisableOffset() { EnableOffset(false); } bool OffsetEnabled() { return m_enableOffset; } - + protected: // These fields must be initialized in the derived class ctors. wxDouble m_width, diff --git a/include/wx/gtk/dc.h b/include/wx/gtk/dc.h index 88e46392f6..d88a1487b0 100644 --- a/include/wx/gtk/dc.h +++ b/include/wx/gtk/dc.h @@ -136,7 +136,7 @@ public: virtual GdkWindow* GetGDKWindow() const { return NULL; } virtual void* GetHandle() const wxOVERRIDE { return GetGDKWindow(); } - + // base class pure virtuals implemented here virtual void DoSetClippingRegion(wxCoord x, wxCoord y, wxCoord width, wxCoord height) wxOVERRIDE; virtual void DoGetSizeMM(int* width, int* height) const wxOVERRIDE; diff --git a/include/wx/gtk/dcmemory.h b/include/wx/gtk/dcmemory.h index 3f7e7c057a..8371d721e3 100644 --- a/include/wx/gtk/dcmemory.h +++ b/include/wx/gtk/dcmemory.h @@ -39,7 +39,7 @@ public: virtual void DoGetSize( int *width, int *height ) const wxOVERRIDE; virtual wxBitmap DoGetAsBitmap(const wxRect *subrect) const wxOVERRIDE; virtual void* GetHandle() const wxOVERRIDE; - + // overridden for wxMemoryDC Impl virtual void DoSelect(const wxBitmap& bitmap) wxOVERRIDE; diff --git a/include/wx/gtk/print.h b/include/wx/gtk/print.h index 5c54286eb3..9458ce7643 100644 --- a/include/wx/gtk/print.h +++ b/include/wx/gtk/print.h @@ -226,7 +226,7 @@ public: virtual void* GetCairoContext() const wxOVERRIDE; virtual void* GetHandle() const wxOVERRIDE; - + bool CanDrawBitmap() const wxOVERRIDE { return true; } void Clear() wxOVERRIDE; void SetFont( const wxFont& font ) wxOVERRIDE; diff --git a/include/wx/html/helpctrl.h b/include/wx/html/helpctrl.h index 54c27afbe0..cad8d6458e 100644 --- a/include/wx/html/helpctrl.h +++ b/include/wx/html/helpctrl.h @@ -46,7 +46,7 @@ class WXDLLIMPEXP_HTML wxHtmlHelpController : public wxHelpControllerBase // wxE public: wxHtmlHelpController(int style = wxHF_DEFAULT_STYLE, wxWindow* parentWindow = NULL); wxHtmlHelpController(wxWindow* parentWindow, int style = wxHF_DEFAULT_STYLE); - + virtual ~wxHtmlHelpController(); void SetShouldPreventAppExit(bool enable); @@ -117,7 +117,7 @@ public: protected: void Init(int style); - + virtual wxWindow* CreateHelpWindow(); virtual wxHtmlHelpFrame* CreateHelpFrame(wxHtmlHelpData *data); virtual wxHtmlHelpDialog* CreateHelpDialog(wxHtmlHelpData *data); diff --git a/include/wx/html/webkit.h b/include/wx/html/webkit.h index 30179440f4..f8558a3141 100644 --- a/include/wx/html/webkit.h +++ b/include/wx/html/webkit.h @@ -107,11 +107,11 @@ private: wxString m_pageTitle; OSXWebViewPtr m_webView; - + WX_NSObject m_frameLoadMonitor; WX_NSObject m_policyDelegate; WX_NSObject m_UIDelegate; - + // we may use this later to setup our own mouse events, // so leave it in for now. void* m_webKitCtrlEventHandler; diff --git a/include/wx/kbdstate.h b/include/wx/kbdstate.h index ab0df32d1c..8945c6b2ba 100644 --- a/include/wx/kbdstate.h +++ b/include/wx/kbdstate.h @@ -65,10 +65,10 @@ public: // accessors for individual modifier keys bool ControlDown() const { return m_controlDown; } - bool RawControlDown() const - { + bool RawControlDown() const + { #ifdef __WXOSX__ - return m_rawControlDown; + return m_rawControlDown; #else return m_controlDown; #endif @@ -91,12 +91,12 @@ public: // --------------------------------------------------- void SetControlDown(bool down) { m_controlDown = down; } - void SetRawControlDown(bool down) - { + void SetRawControlDown(bool down) + { #ifdef __WXOSX__ - m_rawControlDown = down; + m_rawControlDown = down; #else - m_controlDown = down; + m_controlDown = down; #endif } void SetShiftDown(bool down) { m_shiftDown = down; } diff --git a/include/wx/menu.h b/include/wx/menu.h index b733467604..eb262bc2da 100644 --- a/include/wx/menu.h +++ b/include/wx/menu.h @@ -406,7 +406,7 @@ private: wxDECLARE_NO_COPY_CLASS(wxMenuBase); }; -#if wxUSE_EXTENDED_RTTI +#if wxUSE_EXTENDED_RTTI // ---------------------------------------------------------------------------- // XTI accessor @@ -417,17 +417,17 @@ class WXDLLEXPORT wxMenuInfoHelper : public wxObject public: wxMenuInfoHelper() { m_menu = NULL; } virtual ~wxMenuInfoHelper() { } - + bool Create( wxMenu *menu, const wxString &title ) - { - m_menu = menu; - m_title = title; + { + m_menu = menu; + m_title = title; return true; } - + wxMenu* GetMenu() const { return m_menu; } wxString GetTitle() const { return m_title; } - + private: wxMenu *m_menu; wxString m_title; @@ -555,13 +555,13 @@ public: virtual bool CanBeOutsideClientArea() const wxOVERRIDE { return true; } -#if wxUSE_EXTENDED_RTTI +#if wxUSE_EXTENDED_RTTI // XTI helpers: bool AppendMenuInfo( const wxMenuInfoHelper *info ) { return Append( info->GetMenu(), info->GetTitle() ); } const wxMenuInfoHelperList& GetMenuInfos() const; #endif - + #if WXWIN_COMPATIBILITY_2_8 // get or change the label of the menu at given position // Deprecated in favour of SetMenuLabel @@ -574,11 +574,11 @@ protected: // the list of all our menus wxMenuList m_menus; -#if wxUSE_EXTENDED_RTTI +#if wxUSE_EXTENDED_RTTI // used by XTI wxMenuInfoHelperList m_menuInfos; #endif - + // the frame we are attached to (may be NULL) wxFrame *m_menuBarFrame; diff --git a/include/wx/msw/dc.h b/include/wx/msw/dc.h index 83bd3b9e40..e541499f9a 100644 --- a/include/wx/msw/dc.h +++ b/include/wx/msw/dc.h @@ -125,7 +125,7 @@ public: } void* GetHandle() const wxOVERRIDE { return (void*)GetHDC(); } - + const wxBitmap& GetSelectedBitmap() const wxOVERRIDE { return m_selectedBitmap; } wxBitmap& GetSelectedBitmap() wxOVERRIDE { return m_selectedBitmap; } diff --git a/include/wx/msw/headerctrl.h b/include/wx/msw/headerctrl.h index c261ee1ac7..aaaecd942f 100644 --- a/include/wx/msw/headerctrl.h +++ b/include/wx/msw/headerctrl.h @@ -58,7 +58,7 @@ protected: virtual void DoSetSize(int x, int y, int width, int height, int sizeFlags = wxSIZE_AUTO) wxOVERRIDE; - + private: // implement base class pure virtuals virtual void DoSetCount(unsigned int count) wxOVERRIDE; diff --git a/include/wx/msw/missing.h b/include/wx/msw/missing.h index 1443a1069e..ec6b93efc8 100644 --- a/include/wx/msw/missing.h +++ b/include/wx/msw/missing.h @@ -262,7 +262,7 @@ #define TVM_GETEXTENDEDSTYLE (TV_FIRST + 45) #endif -// Various defines used by the webview library that are needed by mingw +// Various defines used by the webview library that are needed by mingw #ifndef DISPID_COMMANDSTATECHANGE #define DISPID_COMMANDSTATECHANGE 105 diff --git a/include/wx/osx/app.h b/include/wx/osx/app.h index a16b112f1f..08632e4477 100644 --- a/include/wx/osx/app.h +++ b/include/wx/osx/app.h @@ -82,7 +82,7 @@ public: // TODO change semantics to be in line with cocoa (make autrelease NOT increase the count) void MacAddToAutorelease( void* cfrefobj ); void MacReleaseAutoreleasePool(); - + public: static wxWindow* s_captureWindow ; static long s_lastModifiers ; @@ -95,7 +95,7 @@ protected: // override for support of custom app controllers virtual WX_NSObject OSXCreateAppController(); #endif - + private: virtual bool DoInitGui(); virtual void DoCleanUp(); @@ -155,14 +155,14 @@ private: wxArrayString m_openFiles; wxArrayString m_printFiles; wxString m_getURL; - + public: bool OSXInitWasCalled() { return m_inited; } void OSXStoreOpenFiles(const wxArrayString &files ) { m_openFiles = files ; } void OSXStorePrintFiles(const wxArrayString &files ) { m_printFiles = files ; } void OSXStoreOpenURL(const wxString &url ) { m_getURL = url ; } #endif - + // Hide the application windows the same as the system hide command would do it. void MacHideApp(); diff --git a/include/wx/osx/bitmap.h b/include/wx/osx/bitmap.h index 65255198e9..04d0c867d1 100644 --- a/include/wx/osx/bitmap.h +++ b/include/wx/osx/bitmap.h @@ -107,7 +107,7 @@ public: // Constructor for generalised creation from data wxBitmap(const void* data, wxBitmapType type, int width, int height, int depth = 1); - + // creates an bitmap from the native image format wxBitmap(CGImageRef image, double scale = 1.0); wxBitmap(WXImage image); @@ -115,7 +115,7 @@ public: // Create a bitmap compatible with the given DC wxBitmap(int width, int height, const wxDC& dc); - + // If depth is omitted, will create a bitmap compatible with the display wxBitmap(int width, int height, int depth = -1) { (void)Create(width, height, depth); } wxBitmap(const wxSize& sz, int depth = -1) { (void)Create(sz, depth); } @@ -141,13 +141,13 @@ public: bool Create( CGImageRef image, double scale = 1.0 ); bool Create( WXImage image ); bool Create( CGContextRef bitmapcontext); - + // Create a bitmap compatible with the given DC, inheriting its magnification factor bool Create(int width, int height, const wxDC& dc); // Create a bitmap with a scale factor, width and height are multiplied with that factor bool CreateScaled(int logwidth, int logheight, int depth, double logicalScale); - + // virtual bool Create( WXHICON icon) ; virtual bool LoadFile(const wxString& name, wxBitmapType type = wxBITMAP_DEFAULT_TYPE); virtual bool SaveFile(const wxString& name, wxBitmapType type, const wxPalette *cmap = NULL) const; diff --git a/include/wx/osx/cocoa/chkconf.h b/include/wx/osx/cocoa/chkconf.h index 5cc104b02d..f2b5f528a6 100644 --- a/include/wx/osx/cocoa/chkconf.h +++ b/include/wx/osx/cocoa/chkconf.h @@ -22,7 +22,7 @@ /* * leave is isFlipped and don't override */ -#ifndef wxOSX_USE_NATIVE_FLIPPED +#ifndef wxOSX_USE_NATIVE_FLIPPED #define wxOSX_USE_NATIVE_FLIPPED 1 #endif diff --git a/include/wx/osx/cocoa/dataview.h b/include/wx/osx/cocoa/dataview.h index 58d9495f6e..b4203ca6ee 100644 --- a/include/wx/osx/cocoa/dataview.h +++ b/include/wx/osx/cocoa/dataview.h @@ -532,7 +532,7 @@ public: virtual void SetRowHeight(int height); virtual void SetRowHeight(const wxDataViewItem& item, unsigned int height); virtual void OnSize(); - + virtual void StartEditor( const wxDataViewItem & item, unsigned int column ); // drag & drop helper methods diff --git a/include/wx/osx/cocoa/evtloop.h b/include/wx/osx/cocoa/evtloop.h index ab15dd94af..12fd66a33a 100644 --- a/include/wx/osx/cocoa/evtloop.h +++ b/include/wx/osx/cocoa/evtloop.h @@ -15,16 +15,16 @@ class WXDLLIMPEXP_BASE wxGUIEventLoop : public wxCFEventLoop public: wxGUIEventLoop(); ~wxGUIEventLoop(); - + void BeginModalSession( wxWindow* modalWindow ); - + void EndModalSession(); virtual void WakeUp(); void OSXUseLowLevelWakeup(bool useIt) { m_osxLowLevelWakeUp = useIt ; } - + protected: virtual int DoDispatchTimeout(unsigned long timeout); @@ -32,15 +32,15 @@ protected: virtual void OSXDoStop(); virtual CFRunLoopRef CFGetCurrentRunLoop() const; - + void* m_modalSession; - + wxWindow* m_modalWindow; - + WXWindow m_dummyWindow; - + int m_modalNestedLevel; - + bool m_osxLowLevelWakeUp; }; diff --git a/include/wx/osx/cocoa/private.h b/include/wx/osx/cocoa/private.h index a28dd242d6..cc990135cc 100644 --- a/include/wx/osx/cocoa/private.h +++ b/include/wx/osx/cocoa/private.h @@ -163,7 +163,7 @@ public : #endif virtual double GetContentScaleFactor() const; - + // cocoa thunk connected calls #if wxUSE_DRAG_AND_DROP @@ -281,20 +281,20 @@ public : virtual void SetRepresentedFilename(const wxString& filename) wxOVERRIDE; wxNonOwnedWindow* GetWXPeer() { return m_wxPeer; } - + CGWindowLevel GetWindowLevel() const wxOVERRIDE { return m_macWindowLevel; } void RestoreWindowLevel() wxOVERRIDE; - + static WX_NSResponder GetNextFirstResponder() ; static WX_NSResponder GetFormerFirstResponder() ; protected : CGWindowLevel m_macWindowLevel; WXWindow m_macWindow; void * m_macFullScreenData ; - + private: void SetUpForModalParent(); - + wxDECLARE_DYNAMIC_CLASS_NO_COPY(wxNonOwnedWindowCocoaImpl); }; @@ -308,7 +308,7 @@ public: #if wxUSE_MARKUP virtual void SetLabelMarkup(const wxString& markup); #endif // wxUSE_MARKUP - + void SetPressedBitmap( const wxBitmap& bitmap ); void GetLayoutInset(int &left , int &top , int &right, int &bottom) const; void SetAcceleratorFromLabel(const wxString& label); diff --git a/include/wx/osx/cocoa/private/textimpl.h b/include/wx/osx/cocoa/private/textimpl.h index fa42e78341..fc44aeb15d 100644 --- a/include/wx/osx/cocoa/private/textimpl.h +++ b/include/wx/osx/cocoa/private/textimpl.h @@ -97,7 +97,7 @@ public: virtual ~wxNSTextViewControl(); virtual void insertText(NSString* text, WXWidget slf, void *_cmd) wxOVERRIDE; - + virtual wxString GetStringValue() const wxOVERRIDE ; virtual void SetStringValue( const wxString &str) wxOVERRIDE ; virtual void Copy() wxOVERRIDE ; diff --git a/include/wx/osx/core/cfdictionary.h b/include/wx/osx/core/cfdictionary.h index d27c0f5891..d3028e90c7 100644 --- a/include/wx/osx/core/cfdictionary.h +++ b/include/wx/osx/core/cfdictionary.h @@ -119,7 +119,7 @@ public: { SetValue(key, wxCFNumberRef(v)); } - + CFMutableDictionaryRef CreateCopy() const { return CFDictionaryCreateMutableCopy(kCFAllocatorDefault, 0, this->m_ptr); diff --git a/include/wx/osx/core/cfref.h b/include/wx/osx/core/cfref.h index b441693779..be349c08e7 100644 --- a/include/wx/osx/core/cfref.h +++ b/include/wx/osx/core/cfref.h @@ -176,7 +176,7 @@ public: */ wxCFRef(refType p) : m_ptr(p) { - + } /*! @method wxCFRef @abstract Assumes ownership of p and creates a reference to it. @@ -190,7 +190,7 @@ public: This method is templated and takes an otherType *p. This prevents implicit conversion using an operator refType() in a different ref-holding class type. */ - + template explicit wxCFRef(otherType *p) : m_ptr(p) // Implicit conversion from otherType* to refType should occur. diff --git a/include/wx/osx/core/colour.h b/include/wx/osx/core/colour.h index d3b6ec4eb6..cb0ce23367 100644 --- a/include/wx/osx/core/colour.h +++ b/include/wx/osx/core/colour.h @@ -47,10 +47,10 @@ public: // This ctor does take ownership of the color. wxColour( CGColorRef col ); - + // don't take ownership of the returned value CGColorRef GetCGColor() const; - + // do take ownership of the returned value CGColorRef CreateCGColor() const { return wxCFRetain(GetCGColor()); } @@ -69,7 +69,7 @@ public: explicit wxColour(WX_NSColor color); WX_NSColor OSXGetNSColor() const; #endif - + protected : virtual void InitRGBA(ChannelType r, ChannelType g, ChannelType b, ChannelType a) wxOVERRIDE; @@ -87,19 +87,19 @@ class wxColourRefData : public wxGDIRefData public: wxColourRefData() {} virtual ~wxColourRefData() {} - + virtual CGFloat Red() const = 0; virtual CGFloat Green() const = 0; virtual CGFloat Blue() const = 0; virtual CGFloat Alpha() const = 0; - + virtual bool IsSolid() const { return true; } virtual CGColorRef GetCGColor() const = 0; - + virtual wxColourRefData* Clone() const = 0; - + #if wxOSX_USE_COCOA virtual WX_NSColor GetNSColor() const; #endif diff --git a/include/wx/osx/core/evtloop.h b/include/wx/osx/core/evtloop.h index 7c4f189fdf..c2be89e33b 100644 --- a/include/wx/osx/core/evtloop.h +++ b/include/wx/osx/core/evtloop.h @@ -43,7 +43,7 @@ public: virtual void WakeUp(); bool ShouldProcessIdleEvents() const { return m_processIdleEvents ; } - + #if wxUSE_UIACTIONSIMULATOR // notifies Yield and Dispatch to wait for at least one event before // returning, this is necessary, because the synthesized events need to be diff --git a/include/wx/osx/core/private.h b/include/wx/osx/core/private.h index 9ada10b975..dfe47f4efd 100644 --- a/include/wx/osx/core/private.h +++ b/include/wx/osx/core/private.h @@ -168,7 +168,7 @@ public : const wxString& strHelp, wxItemKind kind, wxMenu *pSubMenu ); - + // handle OS specific menu items if they weren't handled during normal processing virtual bool DoDefault() { return false; } protected : @@ -197,7 +197,7 @@ public : wxMenu* GetWXPeer() { return m_peer ; } virtual void PopUp( wxWindow *win, int x, int y ) = 0; - + virtual void GetMenuBarDimensions(int &x, int &y, int &width, int &height) const { x = y = width = height = -1; @@ -232,13 +232,13 @@ public : void Init(); bool IsRootControl() const { return m_isRootControl; } - + // is a custom control that has all events handled in wx code, no built-ins bool IsUserPane() const { return m_isUserPane; } // we are doing keyboard handling in wx code, other events might be handled natively virtual bool HasUserKeyHandling() const { return m_wantsUserKey; } - + // we are doing mouse handling in wx code, other events might be handled natively virtual bool HasUserMouseHandling() const { return m_wantsUserMouse; } @@ -280,7 +280,7 @@ public : { return 1.0; } - + // the native coordinates may have an 'aura' for shadows etc, if this is the case the layout // inset indicates on which insets the real control is drawn virtual void GetLayoutInset(int &left , int &top , int &right, int &bottom) const @@ -299,7 +299,7 @@ public : virtual bool NeedsFrame() const; virtual void SetNeedsFrame( bool needs ); - + virtual void SetDrawingEnabled(bool enabled); virtual bool CanFocus() const = 0; @@ -322,7 +322,7 @@ public : virtual void SetCursor( const wxCursor & cursor ) = 0; virtual void CaptureMouse() = 0; virtual void ReleaseMouse() = 0; - + virtual void SetDropTarget( wxDropTarget * WXUNUSED(dropTarget) ) {} virtual wxInt32 GetValue() const = 0; @@ -371,7 +371,7 @@ public : // of a known control static wxWidgetImpl* FindBestFromWXWidget(WXWidget control); - + static void RemoveAssociations( wxWidgetImpl* impl); static void RemoveAssociation(WXWidget control); @@ -955,7 +955,7 @@ public : virtual void ScreenToWindow( int *x, int *y ) = 0; virtual void WindowToScreen( int *x, int *y ) = 0; - + virtual bool IsActive() = 0; wxNonOwnedWindow* GetWXPeer() { return m_wxPeer; } diff --git a/include/wx/osx/dataobj.h b/include/wx/osx/dataobj.h index 45a73f289f..86ab65d748 100644 --- a/include/wx/osx/dataobj.h +++ b/include/wx/osx/dataobj.h @@ -30,7 +30,7 @@ public: // returns true if any of the accepted formats of this dataobj is in the pasteboard bool HasDataInPasteboard( void * pasteboardRef ); bool GetFromPasteboard( void * pasteboardRef ); - + #if wxOSX_USE_COCOA virtual void AddSupportedTypes( void* cfarray); #endif diff --git a/include/wx/osx/dataview.h b/include/wx/osx/dataview.h index 2b958c60a4..2eb826b5c4 100644 --- a/include/wx/osx/dataview.h +++ b/include/wx/osx/dataview.h @@ -205,7 +205,7 @@ public: // finishes editing of custom items; if no custom item is currently edited the method does nothing void FinishCustomItemEditing(); - + virtual void EditItem(const wxDataViewItem& item, const wxDataViewColumn *column) wxOVERRIDE; // returns the n-th pointer to a column; diff --git a/include/wx/osx/dialog.h b/include/wx/osx/dialog.h index bce052f4c2..e8d871cd54 100644 --- a/include/wx/osx/dialog.h +++ b/include/wx/osx/dialog.h @@ -62,7 +62,7 @@ public: static bool OSXHasModalDialogsOpen(); void OSXBeginModalDialog(); void OSXEndModalDialog(); - + #if wxOSX_USE_COCOA bool OSXGetWorksWhenModal(); void OSXSetWorksWhenModal(bool worksWhenModal); @@ -94,7 +94,7 @@ protected: private: void Init(); - + static wxVector s_modalStack; #if wxOSX_USE_COCOA static wxVector s_modalWorksStack; diff --git a/include/wx/osx/evtloop.h b/include/wx/osx/evtloop.h index cbbab016d6..e9e7545f18 100644 --- a/include/wx/osx/evtloop.h +++ b/include/wx/osx/evtloop.h @@ -23,7 +23,7 @@ class WXDLLIMPEXP_CORE wxModalEventLoop : public wxGUIEventLoop public: wxModalEventLoop(wxWindow *modalWindow); wxModalEventLoop(WXWindow modalNativeWindow); - + #ifdef __WXOSX_COCOA__ // skip wxGUIEventLoop to avoid missing Enter/Exit notifications virtual int Run() { return wxCFEventLoop::Run(); } diff --git a/include/wx/osx/filedlg.h b/include/wx/osx/filedlg.h index d8e8a862a6..e106a48629 100644 --- a/include/wx/osx/filedlg.h +++ b/include/wx/osx/filedlg.h @@ -17,7 +17,7 @@ class WXDLLIMPEXP_FWD_CORE wxChoice; // wxFileDialog //------------------------------------------------------------------------- -// set this system option to 1 in order to always show the filetypes popup in +// set this system option to 1 in order to always show the filetypes popup in // file open dialogs if possible #define wxOSX_FILEDIALOG_ALWAYS_SHOW_TYPES wxT("osx.openfiledialog.always-show-types") @@ -59,7 +59,7 @@ public: #if wxOSX_USE_COCOA ~wxFileDialog(); #endif - + virtual void GetPaths(wxArrayString& paths) const { paths = m_paths; } virtual void GetFilenames(wxArrayString& files) const { files = m_fileNames ; } @@ -71,9 +71,9 @@ public: #endif virtual bool SupportsExtraControl() const; - + // implementation only - + #if wxOSX_USE_COCOA // returns true if the file can be shown as active bool CheckFile( const wxString& filename ); @@ -86,7 +86,7 @@ protected: int WXUNUSED(sizeFlags) = wxSIZE_AUTO) {} void SetupExtraControls(WXWindow nativeWindow); - + #if wxOSX_USE_COCOA virtual wxWindow* CreateFilterPanel(wxWindow *extracontrol); void DoOnFilterSelected(int index); diff --git a/include/wx/osx/iphone/private.h b/include/wx/osx/iphone/private.h index 557bb68308..a0694ed2d7 100644 --- a/include/wx/osx/iphone/private.h +++ b/include/wx/osx/iphone/private.h @@ -63,7 +63,7 @@ public : virtual void GetSize( int &width, int &height ) const; virtual void SetControlSize( wxWindowVariant variant ); virtual double GetContentScaleFactor() const ; - + virtual void SetNeedsDisplay( const wxRect* where = NULL ); virtual bool GetNeedsDisplay() const; @@ -176,7 +176,7 @@ public : virtual bool IsFullScreen() const; virtual bool EnableFullScreenView(bool enable); - + virtual bool ShowFullScreen(bool show, long style); virtual void RequestUserAttention(int flags); diff --git a/include/wx/osx/iphone/private/textimpl.h b/include/wx/osx/iphone/private/textimpl.h index 7c9e5fd109..4019881872 100644 --- a/include/wx/osx/iphone/private/textimpl.h +++ b/include/wx/osx/iphone/private/textimpl.h @@ -34,10 +34,10 @@ public : virtual void WriteText(const wxString& str) ; virtual bool HasOwnContextMenu() const { return true; } - virtual wxSize GetBestSize() const; - + virtual wxSize GetBestSize() const; + virtual bool SetHint(const wxString& hint); - + virtual void controlAction(WXWidget slf, void* _cmd, void *sender); protected : UITextField* m_textField; diff --git a/include/wx/osx/menu.h b/include/wx/osx/menu.h index d9808e5f1d..2fee40e622 100644 --- a/include/wx/osx/menu.h +++ b/include/wx/osx/menu.h @@ -170,7 +170,7 @@ public: static WXHMENU MacGetWindowMenuHMenu() { return s_macWindowMenuHandle ; } - + virtual void DoGetPosition(int *x, int *y) const; virtual void DoGetSize(int *width, int *height) const; virtual void DoGetClientSize(int *width, int *height) const; diff --git a/include/wx/osx/msgdlg.h b/include/wx/osx/msgdlg.h index c4257aff57..4d6e9d6a87 100644 --- a/include/wx/osx/msgdlg.h +++ b/include/wx/osx/msgdlg.h @@ -24,7 +24,7 @@ public: #if wxOSX_USE_COCOA ~wxMessageDialog(); #endif - + virtual int ShowModal(); #if wxOSX_USE_COCOA diff --git a/include/wx/osx/nonownedwnd.h b/include/wx/osx/nonownedwnd.h index a52eae9922..41c9ca0492 100644 --- a/include/wx/osx/nonownedwnd.h +++ b/include/wx/osx/nonownedwnd.h @@ -64,7 +64,7 @@ public: virtual void UnsubclassWin(); virtual wxPoint GetClientAreaOrigin() const; - + // implement base class pure virtuals virtual bool SetTransparent(wxByte alpha); @@ -151,7 +151,7 @@ protected: private : static clock_t s_lastFlush; - + wxRegion m_shape; #if wxUSE_GRAPHICS_CONTEXT wxGraphicsPath m_shapePath; diff --git a/include/wx/osx/popupwin.h b/include/wx/osx/popupwin.h index 21065febcf..8d9be37dee 100644 --- a/include/wx/osx/popupwin.h +++ b/include/wx/osx/popupwin.h @@ -27,7 +27,7 @@ public: bool Create(wxWindow *parent, int flags = wxBORDER_NONE); virtual bool Show(bool show = true); - + wxDECLARE_DYNAMIC_CLASS_NO_COPY(wxPopupWindow); }; diff --git a/include/wx/osx/toolbar.h b/include/wx/osx/toolbar.h index 70a33f77a7..52febf14a3 100644 --- a/include/wx/osx/toolbar.h +++ b/include/wx/osx/toolbar.h @@ -95,9 +95,9 @@ public: protected: // common part of all ctors void Init(); - + void DoLayout(); - + void DoSetSize(int x, int y, int width, int height, int sizeFlags) wxOVERRIDE; #ifndef __WXOSX_IPHONE__ diff --git a/include/wx/osx/toplevel.h b/include/wx/osx/toplevel.h index 72f58c98a6..c54528d97a 100644 --- a/include/wx/osx/toplevel.h +++ b/include/wx/osx/toplevel.h @@ -82,7 +82,7 @@ public: virtual void SetLabel(const wxString& label) wxOVERRIDE { SetTitle( label ); } virtual wxString GetLabel() const wxOVERRIDE { return GetTitle(); } - + virtual void OSXSetModified(bool modified) wxOVERRIDE; virtual bool OSXIsModified() const wxOVERRIDE; diff --git a/include/wx/osx/webview_webkit.h b/include/wx/osx/webview_webkit.h index dc54ec061c..32730fb613 100644 --- a/include/wx/osx/webview_webkit.h +++ b/include/wx/osx/webview_webkit.h @@ -14,7 +14,7 @@ #include "wx/defs.h" -#if wxUSE_WEBVIEW && wxUSE_WEBVIEW_WEBKIT && defined(__WXOSX__) +#if wxUSE_WEBVIEW && wxUSE_WEBVIEW_WEBKIT && defined(__WXOSX__) #include "wx/control.h" #include "wx/webview.h" @@ -86,10 +86,10 @@ public: //Find function virtual long Find(const wxString& text, int flags = wxWEBVIEW_FIND_DEFAULT) wxOVERRIDE - { + { wxUnusedVar(text); wxUnusedVar(flags); - return wxNOT_FOUND; + return wxNOT_FOUND; } //Clipboard functions diff --git a/include/wx/osx/window.h b/include/wx/osx/window.h index b192b44b47..e3d0a08a0a 100644 --- a/include/wx/osx/window.h +++ b/include/wx/osx/window.h @@ -52,7 +52,7 @@ public: const wxString& name = wxPanelNameStr ); virtual void SendSizeEvent(int flags = 0) wxOVERRIDE; - + // implement base class pure virtuals virtual void SetLabel( const wxString& label ) wxOVERRIDE; virtual wxString GetLabel() const wxOVERRIDE; @@ -92,10 +92,10 @@ public: virtual bool SetBackgroundStyle(wxBackgroundStyle style) wxOVERRIDE; virtual bool IsTransparentBackgroundSupported(wxString* reason = NULL) const wxOVERRIDE; - + virtual int GetCharHeight() const wxOVERRIDE; virtual int GetCharWidth() const wxOVERRIDE; - + public: virtual void SetScrollbar( int orient, int pos, int thumbVisible, int range, bool refresh = true ) wxOVERRIDE; @@ -117,11 +117,11 @@ public: #if wxUSE_HOTKEY && wxOSX_USE_COCOA_OR_CARBON // hot keys (system wide accelerators) // ----------------------------------- - + virtual bool RegisterHotKey(int hotkeyId, int modifiers, int keycode) wxOVERRIDE; virtual bool UnregisterHotKey(int hotkeyId) wxOVERRIDE; #endif // wxUSE_HOTKEY - + #if wxUSE_DRAG_AND_DROP virtual void SetDropTarget( wxDropTarget *dropTarget ) wxOVERRIDE; @@ -255,7 +255,7 @@ public: // the 'true' OS level control for this wxWindow wxOSXWidgetImpl* GetPeer() const; - + // optimization to avoid creating a user pane in wxWindow::Create if we already know // we will replace it with our own peer void DontCreatePeer(); @@ -263,10 +263,10 @@ public: // return true unless DontCreatePeer() had been called bool ShouldCreatePeer() const; - // sets the native implementation wrapper, can replace an existing peer, use peer = NULL to + // sets the native implementation wrapper, can replace an existing peer, use peer = NULL to // release existing peer void SetPeer(wxOSXWidgetImpl* peer); - + // wraps the already existing peer with the wrapper void SetWrappingPeer(wxOSXWidgetImpl* wrapper); @@ -289,9 +289,9 @@ public: virtual void OSXSimulateFocusEvents(); bool IsNativeWindowWrapper() const { return m_isNativeWindowWrapper; } - + double GetContentScaleFactor() const wxOVERRIDE; - + // internal response to size events virtual void MacOnInternalSize() {} diff --git a/include/wx/private/notifmsg.h b/include/wx/private/notifmsg.h index 772a9c308e..3f02a29e72 100644 --- a/include/wx/private/notifmsg.h +++ b/include/wx/private/notifmsg.h @@ -66,7 +66,7 @@ protected: void SetActive(bool active) { m_active = active; - + // Delete the implementation if the notification is detached if (!m_notification && !active) delete this; diff --git a/include/wx/qt/accel.h b/include/wx/qt/accel.h index a710f7f0ab..d402f4941a 100644 --- a/include/wx/qt/accel.h +++ b/include/wx/qt/accel.h @@ -52,8 +52,8 @@ protected: // ref counting code virtual wxObjectRefData *CreateRefData() const; virtual wxObjectRefData *CloneRefData(const wxObjectRefData *data) const; - -private: + +private: wxDECLARE_DYNAMIC_CLASS(wxAcceleratorTable); }; diff --git a/include/wx/qt/app.h b/include/wx/qt/app.h index 80bda3a773..8ce685eb62 100644 --- a/include/wx/qt/app.h +++ b/include/wx/qt/app.h @@ -15,15 +15,15 @@ class WXDLLIMPEXP_CORE wxApp : public wxAppBase public: wxApp(); ~wxApp(); - + virtual bool Initialize(int& argc, wxChar **argv); private: QApplication *m_qtApplication; int m_qtArgc; char **m_qtArgv; - + wxDECLARE_DYNAMIC_CLASS_NO_COPY( wxApp ); }; - + #endif // _WX_QT_APP_H_ diff --git a/include/wx/qt/bitmap.h b/include/wx/qt/bitmap.h index e03883ca3f..0da96633da 100644 --- a/include/wx/qt/bitmap.h +++ b/include/wx/qt/bitmap.h @@ -29,7 +29,7 @@ public: wxBitmap(const char* const* bits); wxBitmap(const wxString &filename, wxBitmapType type = wxBITMAP_TYPE_XPM); wxBitmap(const wxImage& image, int depth = wxBITMAP_SCREEN_DEPTH, double scale = 1.0); - + // Convert from wxIcon / wxCursor wxBitmap(const wxIcon& icon) { CopyFromIcon(icon); } explicit wxBitmap(const wxCursor& cursor); diff --git a/include/wx/qt/brush.h b/include/wx/qt/brush.h index 9359ac54ea..60c116574f 100644 --- a/include/wx/qt/brush.h +++ b/include/wx/qt/brush.h @@ -35,7 +35,7 @@ public: wxDEPRECATED_MSG("use wxBRUSHSTYLE_XXX constants") void SetStyle(int style) { SetStyle((wxBrushStyle)style); } - + QBrush GetHandle() const; protected: diff --git a/include/wx/qt/choice.h b/include/wx/qt/choice.h index 208005ec06..5808879ea8 100644 --- a/include/wx/qt/choice.h +++ b/include/wx/qt/choice.h @@ -14,7 +14,7 @@ class WXDLLIMPEXP_CORE wxChoice : public wxChoiceBase { public: wxChoice(); - + wxChoice( wxWindow *parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, @@ -22,7 +22,7 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxChoiceNameStr ); - + wxChoice( wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, @@ -38,7 +38,7 @@ public: long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxChoiceNameStr ); - + bool Create( wxWindow *parent, wxWindowID id, const wxPoint& pos, const wxSize& size, @@ -64,7 +64,7 @@ protected: void **clientData, wxClientDataType type); virtual int DoInsertOneItem(const wxString& item, unsigned int pos); - + virtual void DoSetItemClientData(unsigned int n, void *clientData); virtual void *DoGetItemClientData(unsigned int n) const; diff --git a/include/wx/qt/cursor.h b/include/wx/qt/cursor.h index b57f770a6f..218564e32d 100644 --- a/include/wx/qt/cursor.h +++ b/include/wx/qt/cursor.h @@ -29,7 +29,7 @@ public: virtual wxPoint GetHotSpot() const; QCursor &GetHandle() const; - + protected: void InitFromStock( wxStockCursor cursorId ); #if wxUSE_IMAGE diff --git a/include/wx/qt/dataform.h b/include/wx/qt/dataform.h index b6f5c307bf..4447e8a681 100644 --- a/include/wx/qt/dataform.h +++ b/include/wx/qt/dataform.h @@ -20,7 +20,7 @@ public: wxDataFormat(const wxChar *id); void SetId( const wxChar *id ); - + bool operator==(wxDataFormatId format) const; bool operator!=(wxDataFormatId format) const; bool operator==(const wxDataFormat& format) const; diff --git a/include/wx/qt/dataobj.h b/include/wx/qt/dataobj.h index 002de9c2a0..3ab0a7079b 100644 --- a/include/wx/qt/dataobj.h +++ b/include/wx/qt/dataobj.h @@ -15,7 +15,7 @@ class WXDLLIMPEXP_CORE wxDataObject : public wxDataObjectBase public: wxDataObject(); ~wxDataObject(); - + virtual bool IsSupportedFormat(const wxDataFormat& format, Direction dir) const; virtual wxDataFormat GetPreferredFormat(Direction dir = Get) const; virtual size_t GetFormatCount(Direction dir = Get) const; diff --git a/include/wx/qt/dc.h b/include/wx/qt/dc.h index d1c632f714..76abb7a43b 100644 --- a/include/wx/qt/dc.h +++ b/include/wx/qt/dc.h @@ -112,7 +112,7 @@ public: protected: virtual QPixmap *GetQPixmap() { return m_qtPixmap; } - + QPainter *m_qtPainter; QPixmap *m_qtPixmap; @@ -132,7 +132,7 @@ private: wxDECLARE_CLASS(wxQtDCImpl); wxDECLARE_NO_COPY_CLASS(wxQtDCImpl); - + }; #endif // _WX_QT_DC_H_ diff --git a/include/wx/qt/dcprint.h b/include/wx/qt/dcprint.h index 09ea99ea94..2c9dfce4f8 100644 --- a/include/wx/qt/dcprint.h +++ b/include/wx/qt/dcprint.h @@ -14,7 +14,7 @@ class WXDLLIMPEXP_CORE wxPrinterDCImpl : public wxDCImpl { public: wxPrinterDCImpl( wxPrinterDC *, const wxPrintData & ); - + virtual bool CanDrawBitmap() const; virtual bool CanGetTextExtent() const; @@ -35,7 +35,7 @@ public: #endif // wxUSE_PALETTE virtual void SetLogicalFunction(wxRasterOperationMode function); - + virtual wxCoord GetCharHeight() const; virtual wxCoord GetCharWidth() const; virtual void DoGetTextExtent(const wxString& string, @@ -43,7 +43,7 @@ public: wxCoord *descent = NULL, wxCoord *externalLeading = NULL, const wxFont *theFont = NULL) const; - + virtual void Clear(); virtual void DoSetClippingRegion(wxCoord x, wxCoord y, @@ -53,7 +53,7 @@ public: virtual bool DoFloodFill(wxCoord x, wxCoord y, const wxColour& col, wxFloodFillStyle style = wxFLOOD_SURFACE); - + virtual bool DoGetPixel(wxCoord x, wxCoord y, wxColour *col) const; virtual void DoDrawPoint(wxCoord x, wxCoord y); diff --git a/include/wx/qt/defs.h b/include/wx/qt/defs.h index be9129c036..b737b9290e 100644 --- a/include/wx/qt/defs.h +++ b/include/wx/qt/defs.h @@ -12,6 +12,6 @@ typedef class QWidget *WXWidget; -#endif +#endif #endif /* _WX_QT_DEFS_H_ */ diff --git a/include/wx/qt/dialog.h b/include/wx/qt/dialog.h index 288e1b3ed2..7a478bf9ff 100644 --- a/include/wx/qt/dialog.h +++ b/include/wx/qt/dialog.h @@ -23,7 +23,7 @@ public: const wxString &name = wxDialogNameStr ); virtual ~wxDialog(); - + bool Create( wxWindow *parent, wxWindowID id, const wxString &title, const wxPoint &pos = wxDefaultPosition, diff --git a/include/wx/qt/dnd.h b/include/wx/qt/dnd.h index d06a35a570..ca52754d6f 100644 --- a/include/wx/qt/dnd.h +++ b/include/wx/qt/dnd.h @@ -14,7 +14,7 @@ class WXDLLIMPEXP_CORE wxDropTarget : public wxDropTargetBase { public: wxDropTarget(wxDataObject *dataObject = NULL ); - + virtual bool OnDrop(wxCoord x, wxCoord y); virtual wxDragResult OnData(wxCoord x, wxCoord y, wxDragResult def); virtual bool GetData(); @@ -40,7 +40,7 @@ public: const wxIcon © = wxNullIcon, const wxIcon &move = wxNullIcon, const wxIcon &none = wxNullIcon); - + virtual wxDragResult DoDragDrop(int flags = wxDrag_CopyOnly); }; #endif // _WX_QT_DND_H_ diff --git a/include/wx/qt/font.h b/include/wx/qt/font.h index 44354e8f52..391623dcb9 100644 --- a/include/wx/qt/font.h +++ b/include/wx/qt/font.h @@ -71,11 +71,11 @@ public: virtual void SetUnderlined( bool underlined ); virtual void SetStrikethrough(bool strikethrough) wxOVERRIDE; virtual void SetEncoding(wxFontEncoding encoding); - + wxDECLARE_COMMON_FONT_METHODS(); virtual QFont GetHandle() const; - + protected: virtual wxGDIRefData *CreateGDIRefData() const; virtual wxGDIRefData *CloneGDIRefData(const wxGDIRefData *data) const; diff --git a/include/wx/qt/fontdlg.h b/include/wx/qt/fontdlg.h index df739d3852..a170578ffa 100644 --- a/include/wx/qt/fontdlg.h +++ b/include/wx/qt/fontdlg.h @@ -16,10 +16,10 @@ public: wxFontDialog() { } wxFontDialog(wxWindow *parent) { Create(parent); } wxFontDialog(wxWindow *parent, const wxFontData& data) { Create(parent, data); } - + protected: bool DoCreate(wxWindow *parent); - + private: wxFontData m_data; diff --git a/include/wx/qt/frame.h b/include/wx/qt/frame.h index 4a603be45c..4e164f3d26 100644 --- a/include/wx/qt/frame.h +++ b/include/wx/qt/frame.h @@ -45,7 +45,7 @@ public: virtual void SetMenuBar(wxMenuBar *menubar); virtual void SetStatusBar(wxStatusBar *statusBar ); virtual void SetToolBar(wxToolBar *toolbar); - + virtual void SetWindowStyleFlag( long style ); virtual void AddChild( wxWindowBase *child ); diff --git a/include/wx/qt/listbox.h b/include/wx/qt/listbox.h index 19126336a3..f3acc6eb5f 100644 --- a/include/wx/qt/listbox.h +++ b/include/wx/qt/listbox.h @@ -51,11 +51,11 @@ public: virtual bool IsSelected(int n) const wxOVERRIDE; virtual int GetSelections(wxArrayInt& aSelections) const wxOVERRIDE; - + virtual unsigned int GetCount() const; virtual wxString GetString(unsigned int n) const; virtual void SetString(unsigned int n, const wxString& s); - + virtual int GetSelection() const; virtual QWidget *GetHandle() const; @@ -66,16 +66,16 @@ protected: virtual void DoSetFirstItem(int n) wxOVERRIDE; virtual void DoSetSelection(int n, bool select) wxOVERRIDE; - + virtual int DoInsertItems(const wxArrayStringsAdapter & items, unsigned int pos, void **clientData, wxClientDataType type); virtual int DoInsertOneItem(const wxString& item, unsigned int pos); - + virtual void DoSetItemClientData(unsigned int n, void *clientData); virtual void *DoGetItemClientData(unsigned int n) const; - + virtual void DoClear(); virtual void DoDeleteOneItem(unsigned int pos); diff --git a/include/wx/qt/mdi.h b/include/wx/qt/mdi.h index 260857902b..a1970ba322 100644 --- a/include/wx/qt/mdi.h +++ b/include/wx/qt/mdi.h @@ -75,7 +75,7 @@ class WXDLLIMPEXP_CORE wxMDIClientWindow : public wxMDIClientWindowBase { public: wxMDIClientWindow(); - + virtual bool CreateClient(wxMDIParentFrame *parent, long style = wxVSCROLL | wxHSCROLL); wxDECLARE_DYNAMIC_CLASS(wxMDIClientWindow); }; diff --git a/include/wx/qt/minifram.h b/include/wx/qt/minifram.h index daf75a35f5..0c10e5a634 100644 --- a/include/wx/qt/minifram.h +++ b/include/wx/qt/minifram.h @@ -25,7 +25,7 @@ public: const wxString& name = wxFrameNameStr) { return wxFrame::Create(parent, id, title, pos, size, - style | wxFRAME_TOOL_WINDOW | wxFRAME_NO_TASKBAR, + style | wxFRAME_TOOL_WINDOW | wxFRAME_NO_TASKBAR, name); } diff --git a/include/wx/qt/notebook.h b/include/wx/qt/notebook.h index 9db81bb917..3175f35a0f 100644 --- a/include/wx/qt/notebook.h +++ b/include/wx/qt/notebook.h @@ -20,7 +20,7 @@ public: const wxSize& size = wxDefaultSize, long style = 0, const wxString& name = wxNotebookNameStr); - + bool Create(wxWindow *parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, diff --git a/include/wx/qt/palette.h b/include/wx/qt/palette.h index 7f01dfdc25..331130f79c 100644 --- a/include/wx/qt/palette.h +++ b/include/wx/qt/palette.h @@ -13,9 +13,9 @@ class WXDLLIMPEXP_CORE wxPalette : public wxPaletteBase public: wxPalette(); wxPalette(int n, unsigned char *red, unsigned char *green, unsigned char *blue); - + bool Create(int n, unsigned char *red, unsigned char *green, unsigned char *blue); - + bool GetRGB(int pixel, unsigned char *red, unsigned char *green, unsigned char *blue) const; int GetPixel(unsigned char red, unsigned char green, unsigned char blue) const; diff --git a/include/wx/qt/pen.h b/include/wx/qt/pen.h index 9a6ce1dc8c..c9d78b56ad 100644 --- a/include/wx/qt/pen.h +++ b/include/wx/qt/pen.h @@ -43,7 +43,7 @@ public: wxDEPRECATED_MSG("use wxPENSTYLE_XXX constants") void SetStyle(int style) { SetStyle((wxPenStyle)style); } - + QPen GetHandle() const; protected: diff --git a/include/wx/qt/printdlg.h b/include/wx/qt/printdlg.h index fc9fb91afe..1fd43ed1e9 100644 --- a/include/wx/qt/printdlg.h +++ b/include/wx/qt/printdlg.h @@ -15,12 +15,12 @@ class WXDLLIMPEXP_CORE wxQtPrintNativeData: public wxPrintNativeDataBase { public: wxQtPrintNativeData(); - + virtual bool TransferTo( wxPrintData &data ); virtual bool TransferFrom( const wxPrintData &data ); virtual bool IsOk() const; - + }; class WXDLLIMPEXP_CORE wxQtPrintDialog : public wxPrintDialogBase diff --git a/include/wx/qt/printqt.h b/include/wx/qt/printqt.h index 23d5dcb1bb..65c44bc194 100644 --- a/include/wx/qt/printqt.h +++ b/include/wx/qt/printqt.h @@ -32,7 +32,7 @@ public: wxQtPrintPreview(wxPrintout *printout, wxPrintout *printoutForPrinting, wxPrintData *data); - + virtual bool Print(bool interactive); virtual void DetermineScaling(); diff --git a/include/wx/qt/private/timer.h b/include/wx/qt/private/timer.h index 21ce2f79d6..d1d5790428 100644 --- a/include/wx/qt/private/timer.h +++ b/include/wx/qt/private/timer.h @@ -29,7 +29,7 @@ public: protected: virtual void timerEvent( QTimerEvent * event ); - + private: int m_timerId; }; diff --git a/include/wx/qt/private/winevent.h b/include/wx/qt/private/winevent.h index 40ea85e417..a8465b542a 100644 --- a/include/wx/qt/private/winevent.h +++ b/include/wx/qt/private/winevent.h @@ -253,7 +253,7 @@ protected: else event->accept(); } - + //wxMoveEvent virtual void moveEvent ( QMoveEvent * event ) { @@ -265,7 +265,7 @@ protected: else event->accept(); } - + //wxEraseEvent then wxPaintEvent virtual void paintEvent ( QPaintEvent * event ) { @@ -301,7 +301,7 @@ protected: else event->accept(); } - + //wxMouseEvent virtual void wheelEvent ( QWheelEvent * event ) { diff --git a/include/wx/qt/region.h b/include/wx/qt/region.h index d49ad45964..a1cb66c111 100644 --- a/include/wx/qt/region.h +++ b/include/wx/qt/region.h @@ -23,7 +23,7 @@ public: wxRegion(size_t n, const wxPoint *points, wxPolygonFillMode fillStyle = wxODDEVEN_RULE); wxRegion(const wxBitmap& bmp); wxRegion(const wxBitmap& bmp, const wxColour& transp, int tolerance = 0); - + virtual bool IsEmpty() const; virtual void Clear(); @@ -82,7 +82,7 @@ public: wxCoord GetH() const; wxCoord GetHeight() const; wxRect GetRect() const; - + private: QVector < QRect > *m_qtRects; int m_pos; diff --git a/include/wx/qt/statbox.h b/include/wx/qt/statbox.h index e116c57787..8589adf4b1 100644 --- a/include/wx/qt/statbox.h +++ b/include/wx/qt/statbox.h @@ -14,7 +14,7 @@ class WXDLLIMPEXP_CORE wxStaticBox : public wxStaticBoxBase { public: wxStaticBox(); - + wxStaticBox(wxWindow *parent, wxWindowID id, const wxString& label, const wxPoint& pos = wxDefaultPosition, diff --git a/include/wx/qt/statusbar.h b/include/wx/qt/statusbar.h index 0609d4b044..7e89426d25 100644 --- a/include/wx/qt/statusbar.h +++ b/include/wx/qt/statusbar.h @@ -36,7 +36,7 @@ public: QStatusBar *GetQStatusBar() const { return m_qtStatusBar; } QWidget *GetHandle() const; - + protected: virtual void DoUpdateStatusText(int number); diff --git a/include/wx/qt/textctrl.h b/include/wx/qt/textctrl.h index 68863a9a04..3cd57c936c 100644 --- a/include/wx/qt/textctrl.h +++ b/include/wx/qt/textctrl.h @@ -46,7 +46,7 @@ public: virtual bool SetStyle(long start, long end, const wxTextAttr& style); virtual bool GetStyle(long position, wxTextAttr& style); virtual bool SetDefaultStyle(const wxTextAttr& style); - + virtual long XYToPosition(long x, long y) const; virtual bool PositionToXY(long pos, long *x, long *y) const; diff --git a/include/wx/qt/textentry.h b/include/wx/qt/textentry.h index 458e6add68..685edda867 100644 --- a/include/wx/qt/textentry.h +++ b/include/wx/qt/textentry.h @@ -20,7 +20,7 @@ public: virtual void Copy(); virtual void Cut(); virtual void Paste(); - + virtual void Undo(); virtual void Redo(); virtual bool CanUndo() const; @@ -32,10 +32,10 @@ public: virtual void SetSelection(long from, long to); virtual void GetSelection(long *from, long *to) const; - + virtual bool IsEditable() const; virtual void SetEditable(bool editable); - + protected: virtual wxString DoGetValue() const; virtual void DoSetValue(const wxString& value, int flags=0); diff --git a/include/wx/qt/tooltip.h b/include/wx/qt/tooltip.h index 12b3d35ea0..8f8bb232fe 100644 --- a/include/wx/qt/tooltip.h +++ b/include/wx/qt/tooltip.h @@ -25,7 +25,7 @@ public: static void SetAutoPop(long milliseconds); // set the delay between subsequent tooltips to appear static void SetReshow(long milliseconds); - + wxToolTip(const wxString &tip); void SetTip(const wxString& tip); diff --git a/include/wx/qt/toplevel.h b/include/wx/qt/toplevel.h index 5bc66da183..8eb283cc70 100644 --- a/include/wx/qt/toplevel.h +++ b/include/wx/qt/toplevel.h @@ -28,7 +28,7 @@ public: const wxSize& size = wxDefaultSize, long style = wxDEFAULT_FRAME_STYLE, const wxString& name = wxFrameNameStr); - + virtual bool Show(bool show = true) wxOVERRIDE; virtual void Maximize(bool maximize = true); virtual void Restore(); @@ -41,10 +41,10 @@ public: virtual void SetTitle(const wxString& title); virtual wxString GetTitle() const; virtual void SetIcons(const wxIconBundle& icons); - + // Styles virtual void SetWindowStyleFlag( long style ); virtual long GetWindowStyleFlag() const; }; - + #endif // _WX_QT_TOPLEVEL_H_ diff --git a/include/wx/qt/treectrl.h b/include/wx/qt/treectrl.h index 2abf2e17f4..5fdc125ce0 100644 --- a/include/wx/qt/treectrl.h +++ b/include/wx/qt/treectrl.h @@ -29,7 +29,7 @@ public: const wxString& name = wxTreeCtrlNameStr); virtual unsigned int GetCount() const; - + virtual unsigned int GetIndent() const; virtual void SetIndent(unsigned int indent); @@ -55,15 +55,15 @@ public: virtual void SetItemTextColour(const wxTreeItemId& item, const wxColour& col); virtual void SetItemBackgroundColour(const wxTreeItemId& item, const wxColour& col); virtual void SetItemFont(const wxTreeItemId& item, const wxFont& font); - + virtual bool IsVisible(const wxTreeItemId& item) const; virtual bool ItemHasChildren(const wxTreeItemId& item) const; virtual bool IsExpanded(const wxTreeItemId& item) const; virtual bool IsSelected(const wxTreeItemId& item) const; virtual bool IsBold(const wxTreeItemId& item) const; - + virtual size_t GetChildrenCount(const wxTreeItemId& item, bool recursively = true) const; - + virtual wxTreeItemId GetRootItem() const; virtual wxTreeItemId GetSelection() const; virtual size_t GetSelections(wxArrayTreeItemIds& selections) const; @@ -73,7 +73,7 @@ public: virtual wxTreeItemId GetFocusedItem() const; virtual wxTreeItemId GetItemParent(const wxTreeItemId& item) const; - + virtual wxTreeItemId GetFirstChild(const wxTreeItemId& item, wxTreeItemIdValue& cookie) const; virtual wxTreeItemId GetNextChild(const wxTreeItemId& item, wxTreeItemIdValue& cookie) const; virtual wxTreeItemId GetLastChild(const wxTreeItemId& item) const; diff --git a/include/wx/rawbmp.h b/include/wx/rawbmp.h index fae330a7e3..12eb283723 100644 --- a/include/wx/rawbmp.h +++ b/include/wx/rawbmp.h @@ -171,7 +171,7 @@ typedef wxPixelFormat wxImagePixelFormat; #define wxPIXEL_FORMAT_ALPHA 3 #elif defined(__WXQT__) typedef wxPixelFormat wxNativePixelFormat; - + #define wxPIXEL_FORMAT_ALPHA 3 #endif diff --git a/include/wx/richtext/richtextbuffer.h b/include/wx/richtext/richtextbuffer.h index a3a900dde1..ce15e67aea 100644 --- a/include/wx/richtext/richtextbuffer.h +++ b/include/wx/richtext/richtextbuffer.h @@ -3905,7 +3905,7 @@ protected: covers common needs especially for simple, static fields using text or a bitmap. Register field types on application initialisation with the static function - wxRichTextBuffer::AddFieldType. They will be deleted automatically on + wxRichTextBuffer::AddFieldType. They will be deleted automatically on application exit. An application can write a field to a control with wxRichTextCtrl::WriteField, @@ -6122,7 +6122,7 @@ public: /** Returns the coordinates of the cell with keyboard focus, or (-1,-1) if none. - */ + */ virtual wxPosition GetFocusedCell() const; // Operations @@ -6206,7 +6206,7 @@ public: wxRichTextTableBlock(const wxRichTextTableBlock& block) { Copy(block); } void Init() { m_colStart = 0; m_colEnd = 0; m_rowStart = 0; m_rowEnd = 0; } - + void Copy(const wxRichTextTableBlock& block) { m_colStart = block.m_colStart; m_colEnd = block.m_colEnd; m_rowStart = block.m_rowStart; m_rowEnd = block.m_rowEnd; diff --git a/include/wx/richtext/richtextfontpage.h b/include/wx/richtext/richtextfontpage.h index b7a242d776..f52ee19b44 100644 --- a/include/wx/richtext/richtextfontpage.h +++ b/include/wx/richtext/richtextfontpage.h @@ -87,7 +87,7 @@ public: /// be removed from the page. By default, these effects are not shown as they /// have no effect in the editor. static int GetAllowedTextEffects() { return sm_allowedTextEffects; } - + /// Sets the allowed text effects in the page. static void SetAllowedTextEffects(int allowed) { sm_allowedTextEffects = allowed; } diff --git a/include/wx/richtext/richtextimagedlg.h b/include/wx/richtext/richtextimagedlg.h index daf320ae8c..bc29b1822e 100644 --- a/include/wx/richtext/richtextimagedlg.h +++ b/include/wx/richtext/richtextimagedlg.h @@ -44,7 +44,7 @@ class WXDLLIMPEXP_FWD_CORE wxTextCtrl; */ class WXDLLIMPEXP_RICHTEXT wxRichTextObjectPropertiesDialog: public wxRichTextFormattingDialog -{ +{ wxDECLARE_DYNAMIC_CLASS(wxRichTextObjectPropertiesDialog); wxDECLARE_EVENT_TABLE(); diff --git a/include/wx/richtext/richtextmarginspage.h b/include/wx/richtext/richtextmarginspage.h index d69184e51e..afdc2a09ae 100644 --- a/include/wx/richtext/richtextmarginspage.h +++ b/include/wx/richtext/richtextmarginspage.h @@ -2,7 +2,7 @@ // Name: wx/richtext/richtextmarginspage.h // Purpose: Declares the rich text formatting dialog margins page. // Author: Julian Smart -// Modified by: +// Modified by: // Created: 20/10/2010 10:27:34 // Copyright: (c) Julian Smart // Licence: wxWindows licence @@ -70,11 +70,11 @@ public: /// Gets the attributes from the formatting dialog wxRichTextAttr* GetAttributes(); - + /// Data transfer virtual bool TransferDataToWindow() wxOVERRIDE; virtual bool TransferDataFromWindow() wxOVERRIDE; - + ////@begin wxRichTextMarginsPage event handler declarations /// wxEVT_UPDATE_UI event handler for ID_RICHTEXT_LEFT_MARGIN diff --git a/include/wx/richtext/richtextuicustomization.h b/include/wx/richtext/richtextuicustomization.h index d9fadfc808..4d405bf6ff 100644 --- a/include/wx/richtext/richtextuicustomization.h +++ b/include/wx/richtext/richtextuicustomization.h @@ -26,7 +26,7 @@ wxRichTextFormattingDialog::GetHelpInfo().SetHelpId(ID_HELP_FORMATTINGDIALOG); wxRichTextFormattingDialog::GetHelpInfo().SetUICustomization(& wxGetApp().GetRichTextUICustomization()); wxRichTextBordersPage::GetHelpInfo().SetHelpId(ID_HELP_BORDERSPAGE); - + Only the wxRichTextFormattingDialog class needs to have its customization object and help id set, though the application set them for individual pages if it wants. **/ @@ -46,17 +46,17 @@ public: This class is used as a static member of dialogs, to store the help topic for the dialog and also the customization object that will allow help to be shown appropriately for the application. **/ - + class WXDLLIMPEXP_RICHTEXT wxRichTextHelpInfo { public: wxRichTextHelpInfo() { m_helpTopic = -1; - m_uiCustomization = NULL; + m_uiCustomization = NULL; } virtual ~wxRichTextHelpInfo() {} - + virtual bool ShowHelp(wxWindow* win) { if ( !m_uiCustomization || m_helpTopic == -1 ) diff --git a/include/wx/richtext/richtextxml.h b/include/wx/richtext/richtextxml.h index 9557d5d4b7..6f25e367ea 100644 --- a/include/wx/richtext/richtextxml.h +++ b/include/wx/richtext/richtextxml.h @@ -98,7 +98,7 @@ public: void OutputString(wxOutputStream& stream, const wxString& str); void OutputStringEnt(wxOutputStream& stream, const wxString& str); - + static void AddString(wxString& str, const int& v) { str << wxString::Format(wxT("%d"), v); } static void AddString(wxString& str, const long& v) { str << wxString::Format(wxT("%ld"), v); } static void AddString(wxString& str, const double& v) { str << wxString::Format(wxT("%.2f"), (float) v); } @@ -122,7 +122,7 @@ public: /// Create a string containing style attributes, plus further object 'attributes' (shown, id) static wxString AddAttributes(wxRichTextObject* obj, bool isPara = false); - + virtual bool ExportStyleDefinition(wxOutputStream& stream, wxRichTextStyleDefinition* def, int level); virtual bool WriteProperties(wxOutputStream& stream, const wxRichTextProperties& properties, int level); diff --git a/include/wx/variantbase.h b/include/wx/variantbase.h index 22f4c32788..8335415ee8 100644 --- a/include/wx/variantbase.h +++ b/include/wx/variantbase.h @@ -85,9 +85,9 @@ public: // If it based on wxObject return the ClassInfo. virtual wxClassInfo* GetValueClassInfo() { return NULL; } - int GetRefCount() const + int GetRefCount() const { return m_count; } - void IncRef() + void IncRef() { m_count++; } void DecRef() { @@ -151,7 +151,7 @@ public: wxVariantBase(const wxVariantBase& variant); wxVariantBase(wxVariantData* data, const wxString& name = wxEmptyString); - template + template wxVariantBase(const T& data, const wxString& name = wxEmptyString) : m_data(new wxVariantDataT(data)), m_name(name) {} @@ -207,19 +207,19 @@ public: // FIXME wxXTI methods: // get the typeinfo of the stored object - const wxTypeInfo* GetTypeInfo() const - { + const wxTypeInfo* GetTypeInfo() const + { if (!m_data) return NULL; - return m_data->GetTypeInfo(); + return m_data->GetTypeInfo(); } // get a ref to the stored data template T& Get() { - wxVariantDataT *dataptr = + wxVariantDataT *dataptr = wx_dynamic_cast(wxVariantDataT*, m_data); - wxASSERT_MSG( dataptr, + wxASSERT_MSG( dataptr, wxString::Format(wxT("Cast to %s not possible"), typeid(T).name()) ); return dataptr->Get(); } @@ -227,16 +227,16 @@ public: // get a const ref to the stored data template const T& Get() const { - const wxVariantDataT *dataptr = + const wxVariantDataT *dataptr = wx_dynamic_cast(const wxVariantDataT*, m_data); - wxASSERT_MSG( dataptr, + wxASSERT_MSG( dataptr, wxString::Format(wxT("Cast to %s not possible"), typeid(T).name()) ); return dataptr->Get(); } template bool HasData() const { - const wxVariantDataT *dataptr = + const wxVariantDataT *dataptr = wx_dynamic_cast(const wxVariantDataT*, m_data); return dataptr != NULL; } @@ -244,7 +244,7 @@ public: // returns this value as string wxString GetAsString() const; - // gets the stored data casted to a wxObject*, + // gets the stored data casted to a wxObject*, // returning NULL if cast is not possible wxObject* GetAsObject(); diff --git a/include/wx/xti.h b/include/wx/xti.h index f8ddce9bbd..f532318fb9 100644 --- a/include/wx/xti.h +++ b/include/wx/xti.h @@ -195,9 +195,9 @@ public: virtual ~wxClassInfo(); - // allocates an instance of this class, this object does not have to be + // allocates an instance of this class, this object does not have to be // initialized or fully constructed as this call will be followed by a call to Create - virtual wxObject *AllocateObject() const + virtual wxObject *AllocateObject() const { return m_objectConstructor ? (*m_objectConstructor)() : 0; } // 'old naming' for AllocateObject staying here for backward compatibility @@ -207,8 +207,8 @@ public: wxObject *ConstructObject(int ParamCount, wxAny *Params) const; bool NeedsDirectConstruction() const; - - const wxChar *GetClassName() const + + const wxChar *GetClassName() const { return m_className; } const wxChar *GetBaseClassName1() const { return m_parents[0] ? m_parents[0]->GetClassName() : NULL; } @@ -220,25 +220,25 @@ public: const wxClassInfo *GetBaseClass2() const { return m_parents[0] ? m_parents[1] : NULL; } - const wxChar *GetIncludeName() const + const wxChar *GetIncludeName() const { return m_unitName; } - const wxClassInfo **GetParents() const + const wxClassInfo **GetParents() const { return m_parents; } - int GetSize() const + int GetSize() const { return m_objectSize; } - bool IsDynamic() const + bool IsDynamic() const { return (NULL != m_objectConstructor); } - wxObjectConstructorFn GetConstructor() const + wxObjectConstructorFn GetConstructor() const { return m_objectConstructor; } - const wxClassInfo *GetNext() const + const wxClassInfo *GetNext() const { return m_next; } // statics: static void CleanUp(); static wxClassInfo *FindClass(const wxString& className); - static const wxClassInfo *GetFirst() + static const wxClassInfo *GetFirst() { return sm_first; } @@ -254,18 +254,18 @@ public: // this object by returning false, if this class has not registered a // callback, the search will go up the inheritance tree if no callback has // been registered true will be returned by default - bool BeforeWriteObject( const wxObject *obj, wxObjectWriter *streamer, + bool BeforeWriteObject( const wxObject *obj, wxObjectWriter *streamer, wxObjectWriterCallback *writercallback, const wxStringToAnyHashMap &metadata) const; // gets the streaming callback from this class or any superclass wxObjectStreamingCallback GetStreamingCallback() const; // returns the first property - wxPropertyInfo* GetFirstProperty() const + wxPropertyInfo* GetFirstProperty() const { EnsureInfosInited(); return m_firstProperty; } // returns the first handler - wxHandlerInfo* GetFirstHandler() const + wxHandlerInfo* GetFirstHandler() const { EnsureInfosInited(); return m_firstHandler; } // Call the Create upon an instance of the class, in the end the object is fully @@ -273,26 +273,26 @@ public: virtual bool Create (wxObject *object, int ParamCount, wxAny *Params) const; // get number of parameters for constructor - virtual int GetCreateParamCount() const + virtual int GetCreateParamCount() const { return m_constructorPropertiesCount; } // get n-th constructor parameter - virtual const wxChar* GetCreateParamName(int n) const + virtual const wxChar* GetCreateParamName(int n) const { return m_constructorProperties[n]; } - // Runtime access to objects for simple properties (get/set) by property + // Runtime access to objects for simple properties (get/set) by property // name and variant data - virtual void SetProperty (wxObject *object, const wxChar *propertyName, + virtual void SetProperty (wxObject *object, const wxChar *propertyName, const wxAny &value) const; virtual wxAny GetProperty (wxObject *object, const wxChar *propertyName) const; // Runtime access to objects for collection properties by property name - virtual wxAnyList GetPropertyCollection(wxObject *object, + virtual wxAnyList GetPropertyCollection(wxObject *object, const wxChar *propertyName) const; - virtual void AddToPropertyCollection(wxObject *object, const wxChar *propertyName, + virtual void AddToPropertyCollection(wxObject *object, const wxChar *propertyName, const wxAny& value) const; - // we must be able to cast variants to wxObject pointers, templates seem + // we must be able to cast variants to wxObject pointers, templates seem // not to be suitable void CallOnAny( const wxAny &data, wxObjectFunctor* functor ) const; @@ -312,7 +312,7 @@ public: // find handler by name virtual wxHandlerInfo *FindHandlerInfoInThisClass (const wxChar *handlerName) const; - // puts all the properties of this class and its superclasses in the map, + // puts all the properties of this class and its superclasses in the map, // as long as there is not yet an entry with the same name (overriding mechanism) void GetProperties( wxPropertyInfoMap &map ) const; @@ -385,7 +385,7 @@ class WXDLLIMPEXP_BASE wxDynamicClassInfo : public wxClassInfo friend class WXDLLIMPEXP_BASE wxDynamicObject; public: - wxDynamicClassInfo( const wxChar *_UnitName, const wxChar *_ClassName, + wxDynamicClassInfo( const wxChar *_UnitName, const wxChar *_ClassName, const wxClassInfo* superClass ); virtual ~wxDynamicClassInfo(); @@ -402,7 +402,7 @@ public: virtual const wxChar* GetCreateParamName(int i) const; // Runtime access to objects by property name, and variant data - virtual void SetProperty (wxObject *object, const wxChar *PropertyName, + virtual void SetProperty (wxObject *object, const wxChar *PropertyName, const wxAny &Value) const; virtual wxAny GetProperty (wxObject *object, const wxChar *PropertyName) const; @@ -416,7 +416,7 @@ public: void RenameProperty( const wxChar *oldPropertyName, const wxChar *newPropertyName ); // as a handler to this class at runtime - void AddHandler( const wxChar *handlerName, wxObjectEventFunction address, + void AddHandler( const wxChar *handlerName, wxObjectEventFunction address, const wxClassInfo* eventClassInfo ); // removes an existing runtime-handler diff --git a/include/wx/xti2.h b/include/wx/xti2.h index c7abd2fa3d..f153f17746 100644 --- a/include/wx/xti2.h +++ b/include/wx/xti2.h @@ -92,7 +92,7 @@ private : #define _DEFAULT_CONSTRUCTOR(name) \ wxObject* wxConstructorFor##name() \ -{ return new name; } +{ return new name; } #define _DEFAULT_CONVERTERS(name) \ wxObject* wxVariantOfPtrToObjectConverter##name ( const wxAny &data ) \ @@ -258,28 +258,28 @@ template void wxStringWriteValue( wxString &s, const T &data); template -void wxToStringConverter( const wxAny &v, wxString &s ) +void wxToStringConverter( const wxAny &v, wxString &s ) { wxStringWriteValue(s, v.As()); } template -void wxFromStringConverter( const wxString &s, wxAny &v) +void wxFromStringConverter( const wxString &s, wxAny &v) { T d; wxStringReadValue(s, d); v = wxAny(d); } // -------------------------------------------------------------------------- // Collection Support // -------------------------------------------------------------------------- -template void wxListCollectionToAnyList( +template void wxListCollectionToAnyList( const collection_t& coll, wxAnyList &value ) { - for ( iter current = coll.GetFirst(); current; + for ( iter current = coll.GetFirst(); current; current = current->GetNext() ) { value.Append( new wxAny(current->GetData()) ); } } -template void wxArrayCollectionToVariantArray( +template void wxArrayCollectionToVariantArray( const collection_t& coll, wxAnyList &value ) { for( size_t i = 0; i < coll.GetCount(); i++ ) diff --git a/include/wx/xtiprop.h b/include/wx/xtiprop.h index 8c18e2a35a..d0d20039ac 100644 --- a/include/wx/xtiprop.h +++ b/include/wx/xtiprop.h @@ -159,47 +159,47 @@ public: \ class WXDLLIMPEXP_BASE wxPropertyAccessor { public: - wxPropertyAccessor( wxPropertySetter *setter, wxPropertyGetter *getter, + wxPropertyAccessor( wxPropertySetter *setter, wxPropertyGetter *getter, wxPropertyCollectionAdder *adder, wxPropertyCollectionGetter *collectionGetter ) - { m_setter = setter; m_getter = getter; m_adder = adder; + { m_setter = setter; m_getter = getter; m_adder = adder; m_collectionGetter = collectionGetter; } virtual ~wxPropertyAccessor() {} // Setting a simple property (non-collection) virtual void SetProperty(wxObject *object, const wxAny &value) const - { - if ( m_setter ) - m_setter->Set( object, value ); - else - wxLogError( wxGetTranslation("SetProperty called w/o valid setter") ); + { + if ( m_setter ) + m_setter->Set( object, value ); + else + wxLogError( wxGetTranslation("SetProperty called w/o valid setter") ); } // Getting a simple property (non-collection) virtual void GetProperty(const wxObject *object, wxAny &result) const - { - if ( m_getter ) - m_getter->Get( object, result ); - else - wxLogError( wxGetTranslation("GetProperty called w/o valid getter") ); + { + if ( m_getter ) + m_getter->Get( object, result ); + else + wxLogError( wxGetTranslation("GetProperty called w/o valid getter") ); } // Adding an element to a collection property virtual void AddToPropertyCollection(wxObject *object, const wxAny &value) const - { - if ( m_adder ) - m_adder->Add( object, value ); - else - wxLogError( wxGetTranslation("AddToPropertyCollection called w/o valid adder") ); + { + if ( m_adder ) + m_adder->Add( object, value ); + else + wxLogError( wxGetTranslation("AddToPropertyCollection called w/o valid adder") ); } // Getting a collection property virtual void GetPropertyCollection( const wxObject *obj, wxAnyList &result) const - { - if ( m_collectionGetter ) - m_collectionGetter->Get( obj, result); - else - wxLogError( wxGetTranslation("GetPropertyCollection called w/o valid collection getter") ); + { + if ( m_collectionGetter ) + m_collectionGetter->Get( obj, result); + else + wxLogError( wxGetTranslation("GetPropertyCollection called w/o valid collection getter") ); } virtual bool HasSetter() const { return m_setter != NULL; } @@ -249,17 +249,17 @@ public: virtual void GetProperty(const wxObject *object, wxAny &value) const; // Adding an element to a collection property - virtual void AddToPropertyCollection(wxObject *WXUNUSED(object), + virtual void AddToPropertyCollection(wxObject *WXUNUSED(object), const wxAny &WXUNUSED(value)) const - { - wxLogError( wxGetTranslation("AddToPropertyCollection called on a generic accessor") ); + { + wxLogError( wxGetTranslation("AddToPropertyCollection called on a generic accessor") ); } // Getting a collection property - virtual void GetPropertyCollection( const wxObject *WXUNUSED(obj), + virtual void GetPropertyCollection( const wxObject *WXUNUSED(obj), wxAnyList &WXUNUSED(result)) const - { - wxLogError ( wxGetTranslation("GetPropertyCollection called on a generic accessor") ); + { + wxLogError ( wxGetTranslation("GetPropertyCollection called on a generic accessor") ); } private: @@ -271,7 +271,7 @@ private: }; typedef long wxPropertyInfoFlags; -enum +enum { // will be removed in future releases wxPROP_DEPRECATED = 0x00000001, @@ -279,11 +279,11 @@ enum // object graph property, will be streamed with priority (after constructor properties) wxPROP_OBJECT_GRAPH = 0x00000002, - // this will only be streamed out and in as enum/set, the internal representation + // this will only be streamed out and in as enum/set, the internal representation // is still a long wxPROP_ENUM_STORE_LONG = 0x00000004, - // don't stream out this property, needed eg to avoid streaming out children + // don't stream out this property, needed eg to avoid streaming out children // that are always created by their parents wxPROP_DONT_STREAM = 0x00000008 }; @@ -442,7 +442,7 @@ private: // stl is giving problems when forwarding declarations, therefore we define it as a subclass -WX_DECLARE_STRING_HASH_MAP_WITH_DECL( wxPropertyInfo*, wxPropertyInfoMapBase, +WX_DECLARE_STRING_HASH_MAP_WITH_DECL( wxPropertyInfo*, wxPropertyInfoMapBase, class WXDLLIMPEXP_BASE ); class WXDLLIMPEXP_BASE wxPropertyInfoMap : public wxPropertyInfoMapBase { diff --git a/include/wx/xtistrm.h b/include/wx/xtistrm.h index 0621ead1ea..9c9bef5372 100644 --- a/include/wx/xtistrm.h +++ b/include/wx/xtistrm.h @@ -54,58 +54,58 @@ public: virtual ~wxObjectWriterCallback() {} // will be called before an object is written, may veto by returning false - virtual bool BeforeWriteObject( wxObjectWriter *WXUNUSED(writer), - const wxObject *WXUNUSED(object), - const wxClassInfo *WXUNUSED(classInfo), - const wxStringToAnyHashMap &WXUNUSED(metadata)) + virtual bool BeforeWriteObject( wxObjectWriter *WXUNUSED(writer), + const wxObject *WXUNUSED(object), + const wxClassInfo *WXUNUSED(classInfo), + const wxStringToAnyHashMap &WXUNUSED(metadata)) { return true; } - // will be called after this object has been written, may be + // will be called after this object has been written, may be // needed for adjusting stacks - virtual void AfterWriteObject( wxObjectWriter *WXUNUSED(writer), - const wxObject *WXUNUSED(object), - const wxClassInfo *WXUNUSED(classInfo) ) + virtual void AfterWriteObject( wxObjectWriter *WXUNUSED(writer), + const wxObject *WXUNUSED(object), + const wxClassInfo *WXUNUSED(classInfo) ) {} - // will be called before a property gets written, may change the value, - // eg replace a concrete wxSize by wxSize( wxDefaultCoord, wxDefaultCoord ) + // will be called before a property gets written, may change the value, + // eg replace a concrete wxSize by wxSize( wxDefaultCoord, wxDefaultCoord ) // or veto writing that property at all by returning false - virtual bool BeforeWriteProperty( wxObjectWriter *WXUNUSED(writer), - const wxObject *WXUNUSED(object), - const wxPropertyInfo *WXUNUSED(propInfo), - const wxAny &WXUNUSED(value) ) + virtual bool BeforeWriteProperty( wxObjectWriter *WXUNUSED(writer), + const wxObject *WXUNUSED(object), + const wxPropertyInfo *WXUNUSED(propInfo), + const wxAny &WXUNUSED(value) ) { return true; } - // will be called before a property gets written, may change the value, - // eg replace a concrete wxSize by wxSize( wxDefaultCoord, wxDefaultCoord ) + // will be called before a property gets written, may change the value, + // eg replace a concrete wxSize by wxSize( wxDefaultCoord, wxDefaultCoord ) // or veto writing that property at all by returning false - virtual bool BeforeWriteProperty( wxObjectWriter *WXUNUSED(writer), - const wxObject *WXUNUSED(object), - const wxPropertyInfo *WXUNUSED(propInfo), - const wxAnyList &WXUNUSED(value) ) + virtual bool BeforeWriteProperty( wxObjectWriter *WXUNUSED(writer), + const wxObject *WXUNUSED(object), + const wxPropertyInfo *WXUNUSED(propInfo), + const wxAnyList &WXUNUSED(value) ) { return true; } - // will be called after a property has been written out, may be needed + // will be called after a property has been written out, may be needed // for adjusting stacks - virtual void AfterWriteProperty( wxObjectWriter *WXUNUSED(writer), - const wxPropertyInfo *WXUNUSED(propInfo) ) + virtual void AfterWriteProperty( wxObjectWriter *WXUNUSED(writer), + const wxPropertyInfo *WXUNUSED(propInfo) ) {} // will be called before this delegate gets written - virtual bool BeforeWriteDelegate( wxObjectWriter *WXUNUSED(writer), - const wxObject *WXUNUSED(object), - const wxClassInfo* WXUNUSED(classInfo), + virtual bool BeforeWriteDelegate( wxObjectWriter *WXUNUSED(writer), + const wxObject *WXUNUSED(object), + const wxClassInfo* WXUNUSED(classInfo), const wxPropertyInfo *WXUNUSED(propInfo), - const wxObject *&WXUNUSED(eventSink), - const wxHandlerInfo* &WXUNUSED(handlerInfo) ) + const wxObject *&WXUNUSED(eventSink), + const wxHandlerInfo* &WXUNUSED(handlerInfo) ) { return true; } - virtual void AfterWriteDelegate( wxObjectWriter *WXUNUSED(writer), - const wxObject *WXUNUSED(object), - const wxClassInfo* WXUNUSED(classInfo), + virtual void AfterWriteDelegate( wxObjectWriter *WXUNUSED(writer), + const wxObject *WXUNUSED(object), + const wxClassInfo* WXUNUSED(classInfo), const wxPropertyInfo *WXUNUSED(propInfo), - const wxObject *&WXUNUSED(eventSink), - const wxHandlerInfo* &WXUNUSED(handlerInfo) ) + const wxObject *&WXUNUSED(eventSink), + const wxHandlerInfo* &WXUNUSED(handlerInfo) ) { } }; @@ -121,15 +121,15 @@ public: virtual ~wxObjectWriter(); // with this call you start writing out a new top-level object - void WriteObject(const wxObject *object, const wxClassInfo *classInfo, - wxObjectWriterCallback *writercallback, const wxString &name, + void WriteObject(const wxObject *object, const wxClassInfo *classInfo, + wxObjectWriterCallback *writercallback, const wxString &name, const wxStringToAnyHashMap &metadata); // Managing the object identity table a.k.a context // - // these methods make sure that no object gets written twice, + // these methods make sure that no object gets written twice, // because sometimes multiple calls to the WriteObject will be - // made without wanting to have duplicate objects written, the + // made without wanting to have duplicate objects written, the // object identity table will be reset manually virtual void ClearObjectContext(); @@ -151,12 +151,12 @@ public: virtual void DoEndWriteTopLevelEntry( const wxString &name ) = 0; // start of writing an object having the passed in ID - virtual void DoBeginWriteObject(const wxObject *object, const wxClassInfo *classInfo, + virtual void DoBeginWriteObject(const wxObject *object, const wxClassInfo *classInfo, int objectID, const wxStringToAnyHashMap &metadata ) = 0; - // end of writing an toplevel object name param is used for unique + // end of writing an toplevel object name param is used for unique // identification within the container - virtual void DoEndWriteObject(const wxObject *object, + virtual void DoEndWriteObject(const wxObject *object, const wxClassInfo *classInfo, int objectID ) = 0; // writes a simple property in the stream format @@ -177,12 +177,12 @@ public: virtual void DoWriteNullObject() = 0; // writes a delegate in the stream format - virtual void DoWriteDelegate( const wxObject *object, const wxClassInfo* classInfo, - const wxPropertyInfo *propInfo, const wxObject *eventSink, + virtual void DoWriteDelegate( const wxObject *object, const wxClassInfo* classInfo, + const wxPropertyInfo *propInfo, const wxObject *eventSink, int sinkObjectID, const wxClassInfo* eventSinkClassInfo, const wxHandlerInfo* handlerIndo ) = 0; - void WriteObject(const wxObject *object, const wxClassInfo *classInfo, + void WriteObject(const wxObject *object, const wxClassInfo *classInfo, wxObjectWriterCallback *writercallback, bool isEmbedded, const wxStringToAnyHashMap &metadata ); protected: @@ -191,17 +191,17 @@ protected: struct wxObjectWriterInternalPropertiesData; - void WriteAllProperties( const wxObject * obj, const wxClassInfo* ci, - wxObjectWriterCallback *writercallback, + void WriteAllProperties( const wxObject * obj, const wxClassInfo* ci, + wxObjectWriterCallback *writercallback, wxObjectWriterInternalPropertiesData * data ); - void WriteOneProperty( const wxObject *obj, const wxClassInfo* ci, + void WriteOneProperty( const wxObject *obj, const wxClassInfo* ci, const wxPropertyInfo* pi, wxObjectWriterCallback *writercallback, wxObjectWriterInternalPropertiesData *data ); void FindConnectEntry(const wxEvtHandler * evSource, - const wxEventSourceTypeInfo* dti, const wxObject* &sink, + const wxEventSourceTypeInfo* dti, const wxObject* &sink, const wxHandlerInfo *&handler); }; @@ -213,8 +213,8 @@ Streaming callbacks for depersisting XML to code, or running objects class WXDLLIMPEXP_BASE wxObjectReaderCallback; /* -wxObjectReader handles streaming in a class from a arbitrary format. -While walking through it issues calls out to interfaces to readercallback +wxObjectReader handles streaming in a class from a arbitrary format. +While walking through it issues calls out to interfaces to readercallback the guts from the underlying storage format. */ @@ -252,7 +252,7 @@ public: virtual ~wxObjectReaderCallback() {} // allocate the new object on the heap, that object will have the passed in ID - virtual void AllocateObject(int objectID, wxClassInfo *classInfo, + virtual void AllocateObject(int objectID, wxClassInfo *classInfo, wxStringToAnyHashMap &metadata) = 0; // initialize the already allocated object having the ID objectID with the Create method @@ -267,9 +267,9 @@ public: const wxClassInfo **objectClassInfos, wxStringToAnyHashMap &metadata) = 0; - // construct the new object on the heap, that object will have the passed in ID + // construct the new object on the heap, that object will have the passed in ID // (for objects that don't support allocate-create type of creation) - // creation parameters which are objects are having their Ids passed in + // creation parameters which are objects are having their Ids passed in // objectIDValues having objectId <> wxInvalidObjectID virtual void ConstructObject(int objectID, @@ -280,8 +280,8 @@ public: const wxClassInfo **objectClassInfos, wxStringToAnyHashMap &metadata) = 0; - // destroy the heap-allocated object having the ID objectID, this may be used - // if an object is embedded in another object and set via value semantics, + // destroy the heap-allocated object having the ID objectID, this may be used + // if an object is embedded in another object and set via value semantics, // so the intermediate object can be destroyed after safely virtual void DestroyObject(int objectID, wxClassInfo *classInfo) = 0; @@ -339,8 +339,8 @@ public: virtual void AllocateObject(int objectID, wxClassInfo *classInfo, wxStringToAnyHashMap &metadata); - // initialize the already allocated object having the ID objectID with - // the Create method creation parameters which are objects are having + // initialize the already allocated object having the ID objectID with + // the Create method creation parameters which are objects are having // their Ids passed in objectIDValues having objectId <> wxInvalidObjectID virtual void CreateObject(int objectID, @@ -352,9 +352,9 @@ public: wxStringToAnyHashMap &metadata ); - // construct the new object on the heap, that object will have the - // passed in ID (for objects that don't support allocate-create type of - // creation) creation parameters which are objects are having their Ids + // construct the new object on the heap, that object will have the + // passed in ID (for objects that don't support allocate-create type of + // creation) creation parameters which are objects are having their Ids // passed in objectIDValues having objectId <> wxInvalidObjectID virtual void ConstructObject(int objectID, @@ -365,8 +365,8 @@ public: const wxClassInfo **objectClassInfos, wxStringToAnyHashMap &metadata); - // destroy the heap-allocated object having the ID objectID, this may be - // used if an object is embedded in another object and set via value semantics, + // destroy the heap-allocated object having the ID objectID, this may be + // used if an object is embedded in another object and set via value semantics, // so the intermediate object can be destroyed after safely virtual void DestroyObject(int objectID, wxClassInfo *classInfo); diff --git a/include/wx/xtitypes.h b/include/wx/xtitypes.h index f8d7165643..47ee22b17c 100644 --- a/include/wx/xtitypes.h +++ b/include/wx/xtitypes.h @@ -126,7 +126,7 @@ private: // // wxIMPLEMENT_SET_STREAMING( wxCoupe, wxFlavor ) // -// implementation note: no partial specialization for streaming, but a delegation +// implementation note: no partial specialization for streaming, but a delegation // to a different class // // ---------------------------------------------------------------------------- @@ -318,7 +318,7 @@ public: wxTypeInfo(wxTypeKind kind, wxVariant2StringFnc to, wxString2VariantFnc from, const char *name): - m_toString(to), m_fromString(from), m_kind(kind), + m_toString(to), m_fromString(from), m_kind(kind), m_name(wxString::FromAscii(name)) { Register(); @@ -350,20 +350,20 @@ public: // convert a wxAny holding data of this type into a string void ConvertToString( const wxAny& data, wxString &result ) const - { - if ( m_toString ) - (*m_toString)( data, result ); - else - wxLogError( wxGetTranslation(wxT("String conversions not supported")) ); + { + if ( m_toString ) + (*m_toString)( data, result ); + else + wxLogError( wxGetTranslation(wxT("String conversions not supported")) ); } // convert a string into a wxAny holding the corresponding data in this type void ConvertFromString( const wxString& data, wxAny &result ) const - { - if( m_fromString ) - (*m_fromString)( data, result ); - else - wxLogError( wxGetTranslation(wxT("String conversions not supported")) ); + { + if( m_fromString ) + (*m_fromString)( data, result ); + else + wxLogError( wxGetTranslation(wxT("String conversions not supported")) ); } // statics: @@ -387,8 +387,8 @@ private: class WXDLLIMPEXP_BASE wxBuiltInTypeInfo : public wxTypeInfo { public: - wxBuiltInTypeInfo( wxTypeKind kind, wxVariant2StringFnc to = NULL, - wxString2VariantFnc from = NULL, + wxBuiltInTypeInfo( wxTypeKind kind, wxVariant2StringFnc to = NULL, + wxString2VariantFnc from = NULL, const wxString &name = wxEmptyString ) : wxTypeInfo( kind, to, from, name ) { wxASSERT_MSG( GetKind() < wxT_SET, wxT("Illegal Kind for Base Type") ); } @@ -397,7 +397,7 @@ public: class WXDLLIMPEXP_BASE wxCustomTypeInfo : public wxTypeInfo { public: - wxCustomTypeInfo( const wxString &name, wxVariant2StringFnc to, + wxCustomTypeInfo( const wxString &name, wxVariant2StringFnc to, wxString2VariantFnc from ) : wxTypeInfo( wxT_CUSTOM, to, from, name ) {} @@ -413,30 +413,30 @@ public: wxString2VariantFnc from, converterToLong_t toLong, converterFromLong_t fromLong, const wxString &name ) : wxTypeInfo( kind, to, from, name ), m_toLong( toLong ), m_fromLong( fromLong ) - { + { wxASSERT_MSG( kind == wxT_ENUM || kind == wxT_SET, - wxT("Illegal Kind for Enum Type")); - m_enumInfo = enumInfo; + wxT("Illegal Kind for Enum Type")); + m_enumInfo = enumInfo; } const wxEnumData* GetEnumData() const { return m_enumInfo; } // convert a wxAny holding data of this type into a long void ConvertToLong( const wxAny& data, long &result ) const - { - if( m_toLong ) - (*m_toLong)( data, result ); - else - wxLogError( wxGetTranslation(wxT("Long Conversions not supported")) ); + { + if( m_toLong ) + (*m_toLong)( data, result ); + else + wxLogError( wxGetTranslation(wxT("Long Conversions not supported")) ); } // convert a long into a wxAny holding the corresponding data in this type void ConvertFromLong( long data, wxAny &result ) const - { - if( m_fromLong ) - (*m_fromLong)( data, result ); - else - wxLogError( wxGetTranslation(wxT("Long Conversions not supported")) ); + { + if( m_fromLong ) + (*m_fromLong)( data, result ); + else + wxLogError( wxGetTranslation(wxT("Long Conversions not supported")) ); } private: @@ -449,8 +449,8 @@ private: class WXDLLIMPEXP_BASE wxClassTypeInfo : public wxTypeInfo { public: - wxClassTypeInfo( wxTypeKind kind, wxClassInfo* classInfo, - wxVariant2StringFnc to = NULL, wxString2VariantFnc from = NULL, + wxClassTypeInfo( wxTypeKind kind, wxClassInfo* classInfo, + wxVariant2StringFnc to = NULL, wxString2VariantFnc from = NULL, const wxString &name = wxEmptyString); const wxClassInfo *GetClassInfo() const { return m_classInfo; } @@ -471,7 +471,7 @@ public: { if ( m_elementType == NULL ) m_elementType = wxTypeInfo::FindType( m_elementTypeName ); - return m_elementType; + return m_elementType; } private: @@ -482,10 +482,10 @@ private: class WXDLLIMPEXP_BASE wxEventSourceTypeInfo : public wxTypeInfo { public: - wxEventSourceTypeInfo( int eventType, wxClassInfo* eventClass, - wxVariant2StringFnc to = NULL, + wxEventSourceTypeInfo( int eventType, wxClassInfo* eventClass, + wxVariant2StringFnc to = NULL, wxString2VariantFnc from = NULL ); - wxEventSourceTypeInfo( int eventType, int lastEventType, wxClassInfo* eventClass, + wxEventSourceTypeInfo( int eventType, int lastEventType, wxClassInfo* eventClass, wxVariant2StringFnc to = NULL, wxString2VariantFnc from = NULL ); int GetEventType() const { return m_eventType; } @@ -498,10 +498,10 @@ private: int m_lastEventType; }; -template const wxTypeInfo* wxGetTypeInfo( T * ) +template const wxTypeInfo* wxGetTypeInfo( T * ) { return wxTypeInfo::FindType(typeid(T).name()); } -// this macro is for usage with custom, non-object derived classes and structs, +// this macro is for usage with custom, non-object derived classes and structs, // wxPoint is such a custom type #if wxUSE_FUNC_TEMPLATE_POINTER @@ -521,9 +521,9 @@ template const wxTypeInfo* wxGetTypeInfo( T * ) wxCollectionTypeInfo s_typeInfo##collection( typeid(element).name(), \ NULL, NULL, typeid(collection).name() ); -// sometimes a compiler invents specializations that are nowhere called, -// use this macro to satisfy the refs, currently we don't have to play -// tricks, but if we will have to according to the compiler, we will use +// sometimes a compiler invents specializations that are nowhere called, +// use this macro to satisfy the refs, currently we don't have to play +// tricks, but if we will have to according to the compiler, we will use // that macro for that #define wxILLEGAL_TYPE_SPECIALIZATION( a ) diff --git a/include/wx/xtixml.h b/include/wx/xtixml.h index 100e0653e1..df91f2bbd7 100644 --- a/include/wx/xtixml.h +++ b/include/wx/xtixml.h @@ -53,12 +53,12 @@ public: virtual void DoEndWriteTopLevelEntry( const wxString &name ); // start of writing an object having the passed in ID - virtual void DoBeginWriteObject(const wxObject *object, + virtual void DoBeginWriteObject(const wxObject *object, const wxClassInfo *classInfo, int objectID, const wxStringToAnyHashMap &metadata ); - // end of writing an toplevel object name param is used for unique + // end of writing an toplevel object name param is used for unique // identification within the container - virtual void DoEndWriteObject(const wxObject *object, + virtual void DoEndWriteObject(const wxObject *object, const wxClassInfo *classInfo, int objectID ); // writes a simple property in the stream format @@ -80,9 +80,9 @@ public: virtual void DoWriteNullObject(); // writes a delegate in the stream format - virtual void DoWriteDelegate( const wxObject *object, + virtual void DoWriteDelegate( const wxObject *object, const wxClassInfo* classInfo, const wxPropertyInfo *propInfo, - const wxObject *eventSink, int sinkObjectID, + const wxObject *eventSink, int sinkObjectID, const wxClassInfo* eventSinkClassInfo, const wxHandlerInfo* handlerIndo ); private: diff --git a/interface/wx/aboutdlg.h b/interface/wx/aboutdlg.h index 41719ec269..cd43d1bbdc 100644 --- a/interface/wx/aboutdlg.h +++ b/interface/wx/aboutdlg.h @@ -28,7 +28,7 @@ don't support URLs, licence text nor custom icons in the about dialog and if either of those is used, wxAboutBox() will automatically use the generic version so you should avoid specifying these fields to achieve more native look and feel. - + Example of usage: @code void MyFrame::OnAbout(wxCommandEvent& WXUNUSED(event)) @@ -170,7 +170,7 @@ public: Returns the icon set by SetIcon(). */ wxIcon GetIcon() const; - + /** Set the icon to be shown in the dialog. By default the icon of the main frame will be shown if the native about dialog supports custom icons. If it doesn't @@ -241,7 +241,7 @@ public: @see SetVersion() */ const wxString& GetVersion() const; - + /** Return the long version string if set. @@ -263,7 +263,7 @@ public: Returns the description of the website URL set for the dialog. */ const wxString& GetWebSiteDescription() const; - + /** Set the web site for the program and its description (which defaults to @a url itself if empty). @@ -275,7 +275,7 @@ public: void SetWebSite(const wxString& url, const wxString& desc = wxEmptyString); - + /** Returns @true if developers have been set in the dialog info. */ @@ -316,7 +316,7 @@ public: */ const wxArrayString& GetTranslators() const; - + }; diff --git a/interface/wx/affinematrix2dbase.h b/interface/wx/affinematrix2dbase.h index e7d0a6df11..7b95669808 100644 --- a/interface/wx/affinematrix2dbase.h +++ b/interface/wx/affinematrix2dbase.h @@ -36,7 +36,7 @@ struct wxMatrix2D /** @class wxAffineMatrix2DBase - + A 2x3 matrix representing an affine 2D transformation. This is an abstract base class implemented by wxAffineMatrix2D only so far, @@ -160,7 +160,7 @@ public: @param cRadians Rotation angle in radians, clockwise. - */ + */ virtual void Rotate(wxDouble cRadians) = 0; /** diff --git a/interface/wx/animate.h b/interface/wx/animate.h index d8d5e13edb..45e5e88adb 100644 --- a/interface/wx/animate.h +++ b/interface/wx/animate.h @@ -206,7 +206,7 @@ public: Default ctor. */ wxAnimation(); - + /** Copy ctor. */ diff --git a/interface/wx/anybutton.h b/interface/wx/anybutton.h index 5887f8ffd6..c993b062e2 100644 --- a/interface/wx/anybutton.h +++ b/interface/wx/anybutton.h @@ -91,7 +91,7 @@ public: */ wxBitmap GetBitmapPressed() const; - + /** Sets the bitmap to display in the button. @@ -177,7 +177,7 @@ public: previous versions) */ void SetBitmapPressed(const wxBitmap& bitmap); - + /** Get the margins between the bitmap and the text of the button. diff --git a/interface/wx/app.h b/interface/wx/app.h index fcaf21111a..0f9a0f344c 100644 --- a/interface/wx/app.h +++ b/interface/wx/app.h @@ -1063,7 +1063,7 @@ public: is specified in the @c Info.plist file. @onlyfor{wxosx} - + @since 3.0.1 */ virtual bool OSXIsGUIApplication(); diff --git a/interface/wx/artprov.h b/interface/wx/artprov.h index d0581d9913..e8c848452f 100644 --- a/interface/wx/artprov.h +++ b/interface/wx/artprov.h @@ -29,64 +29,64 @@ wxArtClient wxART_LIST; wxArtClient wxART_OTHER; -wxArtID wxART_ADD_BOOKMARK; -wxArtID wxART_DEL_BOOKMARK; -wxArtID wxART_HELP_SIDE_PANEL; -wxArtID wxART_HELP_SETTINGS; -wxArtID wxART_HELP_BOOK; -wxArtID wxART_HELP_FOLDER; -wxArtID wxART_HELP_PAGE; -wxArtID wxART_GO_BACK; -wxArtID wxART_GO_FORWARD; -wxArtID wxART_GO_UP; -wxArtID wxART_GO_DOWN; -wxArtID wxART_GO_TO_PARENT; -wxArtID wxART_GO_HOME; -wxArtID wxART_GOTO_FIRST; -wxArtID wxART_GOTO_LAST; -wxArtID wxART_FILE_OPEN; -wxArtID wxART_FILE_SAVE; -wxArtID wxART_FILE_SAVE_AS; -wxArtID wxART_PRINT; -wxArtID wxART_HELP; -wxArtID wxART_TIP; -wxArtID wxART_REPORT_VIEW; -wxArtID wxART_LIST_VIEW; -wxArtID wxART_NEW_DIR; -wxArtID wxART_HARDDISK; -wxArtID wxART_FLOPPY; -wxArtID wxART_CDROM; -wxArtID wxART_REMOVABLE; -wxArtID wxART_FOLDER; -wxArtID wxART_FOLDER_OPEN; -wxArtID wxART_GO_DIR_UP; -wxArtID wxART_EXECUTABLE_FILE; -wxArtID wxART_NORMAL_FILE; -wxArtID wxART_TICK_MARK; -wxArtID wxART_CROSS_MARK; -wxArtID wxART_ERROR; -wxArtID wxART_QUESTION; -wxArtID wxART_WARNING; -wxArtID wxART_INFORMATION; -wxArtID wxART_MISSING_IMAGE; +wxArtID wxART_ADD_BOOKMARK; +wxArtID wxART_DEL_BOOKMARK; +wxArtID wxART_HELP_SIDE_PANEL; +wxArtID wxART_HELP_SETTINGS; +wxArtID wxART_HELP_BOOK; +wxArtID wxART_HELP_FOLDER; +wxArtID wxART_HELP_PAGE; +wxArtID wxART_GO_BACK; +wxArtID wxART_GO_FORWARD; +wxArtID wxART_GO_UP; +wxArtID wxART_GO_DOWN; +wxArtID wxART_GO_TO_PARENT; +wxArtID wxART_GO_HOME; +wxArtID wxART_GOTO_FIRST; +wxArtID wxART_GOTO_LAST; +wxArtID wxART_FILE_OPEN; +wxArtID wxART_FILE_SAVE; +wxArtID wxART_FILE_SAVE_AS; +wxArtID wxART_PRINT; +wxArtID wxART_HELP; +wxArtID wxART_TIP; +wxArtID wxART_REPORT_VIEW; +wxArtID wxART_LIST_VIEW; +wxArtID wxART_NEW_DIR; +wxArtID wxART_HARDDISK; +wxArtID wxART_FLOPPY; +wxArtID wxART_CDROM; +wxArtID wxART_REMOVABLE; +wxArtID wxART_FOLDER; +wxArtID wxART_FOLDER_OPEN; +wxArtID wxART_GO_DIR_UP; +wxArtID wxART_EXECUTABLE_FILE; +wxArtID wxART_NORMAL_FILE; +wxArtID wxART_TICK_MARK; +wxArtID wxART_CROSS_MARK; +wxArtID wxART_ERROR; +wxArtID wxART_QUESTION; +wxArtID wxART_WARNING; +wxArtID wxART_INFORMATION; +wxArtID wxART_MISSING_IMAGE; -wxArtID wxART_COPY; -wxArtID wxART_CUT; -wxArtID wxART_PASTE; -wxArtID wxART_DELETE; -wxArtID wxART_NEW; +wxArtID wxART_COPY; +wxArtID wxART_CUT; +wxArtID wxART_PASTE; +wxArtID wxART_DELETE; +wxArtID wxART_NEW; -wxArtID wxART_UNDO; -wxArtID wxART_REDO; +wxArtID wxART_UNDO; +wxArtID wxART_REDO; -wxArtID wxART_PLUS; -wxArtID wxART_MINUS; +wxArtID wxART_PLUS; +wxArtID wxART_MINUS; -wxArtID wxART_CLOSE; -wxArtID wxART_QUIT; +wxArtID wxART_CLOSE; +wxArtID wxART_QUIT; -wxArtID wxART_FIND; -wxArtID wxART_FIND_AND_REPLACE; +wxArtID wxART_FIND; +wxArtID wxART_FIND_AND_REPLACE; wxArtID wxART_FULL_SCREEN; wxArtID wxART_EDIT; @@ -214,7 +214,7 @@ wxArtID wxART_EDIT; For a list of the GTK+ stock items please refer to the GTK+ documentation page. - It is also possible to load icons from the current icon theme by specifying their name + It is also possible to load icons from the current icon theme by specifying their name (without extension and directory components). Icon themes recognized by GTK+ follow the freedesktop.org Icon Themes specification. diff --git a/interface/wx/aui/auibar.h b/interface/wx/aui/auibar.h index ed5125e04e..899b956ff2 100644 --- a/interface/wx/aui/auibar.h +++ b/interface/wx/aui/auibar.h @@ -179,11 +179,11 @@ public: */ int GetToolId() const; - + void SetDropDownClicked(bool c); void SetClickPoint(const wxPoint& p); void SetItemRect(const wxRect& r); - void SetToolId(int toolId); + void SetToolId(int toolId); }; wxEventType wxEVT_AUITOOLBAR_TOOL_DROPDOWN; diff --git a/interface/wx/aui/framemanager.h b/interface/wx/aui/framemanager.h index 9daa9d888a..e39c50e1ab 100644 --- a/interface/wx/aui/framemanager.h +++ b/interface/wx/aui/framemanager.h @@ -333,12 +333,12 @@ public: /** LoadPaneInfo() is similar to LoadPerspective, with the exception that it only loads information about a single pane. - + This method writes the serialized data into the passed pane. Pointers to UI elements are not modified. @notice This operation also changes the name in the pane information! - + @sa LoadPerspective @sa SavePaneInfo(). @sa SavePerspective @@ -347,9 +347,9 @@ public: /** Loads a saved perspective. - + A perspective is the layout state of an AUI managed window. - + All currently existing panes that have an object in "perspective" with the same name ("equivalent") will receive the layout parameters of the object in "perspective". Existing panes that do not have an equivalent in "perspective" remain @@ -358,7 +358,7 @@ public: @param perspective Serialized layout information of a perspective (excl. pointers to UI elements). @param update If update is @true, wxAuiManager::Update() is automatically invoked, thus realizing the specified perspective on screen. - + @sa LoadPaneInfo @sa LoadPerspective @sa SavePerspective @@ -384,12 +384,12 @@ public: /** SavePaneInfo() is similar to SavePerspective, with the exception that it only saves information about a single pane. - + @param pane Pane whose layout parameters should be serialized. @return The serialized layout parameters of the pane are returned within the string. Information about the pointers to UI elements stored in the pane are not serialized. - + @sa LoadPaneInfo @sa LoadPerspective @sa SavePerspective @@ -399,7 +399,7 @@ public: /** Saves the entire user interface layout into an encoded wxString, which can then be stored by the application (probably using wxConfig). - + @sa LoadPerspective @sa LoadPaneInfo @sa SavePaneInfo @@ -953,7 +953,7 @@ public: */ wxAuiPaneInfo& operator=(const wxAuiPaneInfo& c); - + /// name of the pane wxString name; @@ -961,7 +961,7 @@ public: wxString caption; /// icon of the pane, may be invalid - wxBitmap icon; + wxBitmap icon; /// window that is in this pane wxWindow* window; @@ -1003,12 +1003,12 @@ public: int dock_proportion; /// buttons on the pane - wxAuiPaneButtonArray buttons; + wxAuiPaneButtonArray buttons; /// current rectangle (populated by wxAUI) wxRect rect; - bool IsValid() const; + bool IsValid() const; }; @@ -1137,7 +1137,7 @@ public: bool IsOk() const; bool IsHorizontal() const; bool IsVertical() const; - + wxAuiPaneInfoPtrArray panes; // array of panes wxRect rect; // current rectangle int dock_direction; // dock direction (top, bottom, left, right, center) diff --git a/interface/wx/aui/tabmdi.h b/interface/wx/aui/tabmdi.h index 4092edcdfc..e12fa75133 100644 --- a/interface/wx/aui/tabmdi.h +++ b/interface/wx/aui/tabmdi.h @@ -108,7 +108,7 @@ public: wxWindowID winid, const wxString& name); virtual wxToolBar *GetToolBar() const; - + // no maximize etc virtual void Maximize(bool maximize = true); virtual void Restore(); diff --git a/interface/wx/base64.h b/interface/wx/base64.h index dc5abe4402..56b13864d1 100644 --- a/interface/wx/base64.h +++ b/interface/wx/base64.h @@ -13,7 +13,7 @@ /** @addtogroup group_funcmacro_misc */ //@{ -/** +/** Elements of this enum specify the possible behaviours of wxBase64Decode when an invalid character is encountered. */ diff --git a/interface/wx/bitmap.h b/interface/wx/bitmap.h index c20aa7725e..57ce3e3ff3 100644 --- a/interface/wx/bitmap.h +++ b/interface/wx/bitmap.h @@ -172,7 +172,7 @@ public: class (either wxNativePixelData for RGB bitmaps or wxAlphaPixelData for bitmaps with an additionally alpha channel). - Note that many wxBitmap functions take a @e type parameter, which is a + Note that many wxBitmap functions take a @e type parameter, which is a value of the ::wxBitmapType enumeration. The validity of those values depends however on the platform where your program is running and from the wxWidgets configuration. @@ -183,9 +183,9 @@ public: - wxX11 supports XPM files, XPM data, XBM data; In addition, wxBitmap can load and save all formats that wxImage can; see wxImage - for more info. Of course, you must have loaded the wxImage handlers + for more info. Of course, you must have loaded the wxImage handlers (see ::wxInitAllImageHandlers() and wxImage::AddHandler). - Note that all available wxBitmapHandlers for a given wxWidgets port are + Note that all available wxBitmapHandlers for a given wxWidgets port are automatically loaded at startup so you won't need to use wxBitmap::AddHandler. More on the difference between wxImage and wxBitmap: wxImage is just a @@ -386,12 +386,12 @@ public: @param handler A new bitmap format handler object. There is usually only one instance of a given handler class in an application session. - + Note that unlike wxImage::AddHandler, there's no documented list of the wxBitmapHandlers available in wxWidgets. - This is because they are platform-specific and most important, they are + This is because they are platform-specific and most important, they are all automatically loaded at startup. - + If you want to be sure that wxBitmap can load a certain type of image, you'd better use wxImage::AddHandler. diff --git a/interface/wx/bmpbuttn.h b/interface/wx/bmpbuttn.h index 522b7f3408..be1657cabb 100644 --- a/interface/wx/bmpbuttn.h +++ b/interface/wx/bmpbuttn.h @@ -62,8 +62,8 @@ public: Button position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Button size. - If ::wxDefaultSize is specified then the button is sized appropriately + Button size. + If ::wxDefaultSize is specified then the button is sized appropriately for the bitmap. @param style Window style. See wxBitmapButton. diff --git a/interface/wx/button.h b/interface/wx/button.h index 6c2f9ac100..923415ae17 100644 --- a/interface/wx/button.h +++ b/interface/wx/button.h @@ -56,7 +56,7 @@ The position of the image inside the button be configured using SetBitmapPosition(). By default the image is on the left of the text. - Please also notice that GTK+ uses a global setting called @c gtk-button-images + Please also notice that GTK+ uses a global setting called @c gtk-button-images to determine if the images should be shown in the buttons at all. If it is off (which is the case in e.g. Gnome 2.28 by default), no images will be shown, consistently with the native behaviour. diff --git a/interface/wx/checkbox.h b/interface/wx/checkbox.h index 203928873c..c6a07ca246 100644 --- a/interface/wx/checkbox.h +++ b/interface/wx/checkbox.h @@ -91,10 +91,10 @@ public: @param label Text to be displayed next to the checkbox. @param pos - Checkbox position. + Checkbox position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Checkbox size. + Checkbox size. If ::wxDefaultSize is specified then a default size is chosen. @param style Window style. See wxCheckBox. diff --git a/interface/wx/checklst.h b/interface/wx/checklst.h index 315abbce3a..833aad5481 100644 --- a/interface/wx/checklst.h +++ b/interface/wx/checklst.h @@ -49,7 +49,7 @@ public: Window position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. + Window size. If ::wxDefaultSize is specified then the window is sized appropriately. @param n Number of strings with which to initialise the control. diff --git a/interface/wx/choice.h b/interface/wx/choice.h index dac038fb3a..fd0abd207d 100644 --- a/interface/wx/choice.h +++ b/interface/wx/choice.h @@ -51,7 +51,7 @@ public: Window position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. + Window size. If ::wxDefaultSize is specified then the choice is sized appropriately. @param n Number of strings with which to initialise the choice control. @@ -172,7 +172,7 @@ public: virtual void SetColumns(int n = 1); virtual bool IsSorted() const; - + virtual unsigned int GetCount() const ; virtual int GetSelection() const ; virtual void SetSelection(int n); diff --git a/interface/wx/choicebk.h b/interface/wx/choicebk.h index d96f9493a9..752a171042 100644 --- a/interface/wx/choicebk.h +++ b/interface/wx/choicebk.h @@ -88,7 +88,7 @@ public: long style = 0, const wxString& name = wxEmptyString); - + /** Returns the wxChoice associated with the control. */ diff --git a/interface/wx/clrpicker.h b/interface/wx/clrpicker.h index 90422e32e4..158457f3f7 100644 --- a/interface/wx/clrpicker.h +++ b/interface/wx/clrpicker.h @@ -57,7 +57,7 @@ class wxColourPickerCtrl : public wxPickerBase { public: wxColourPickerCtrl(); - + /** Initializes the object and calls Create() with all the parameters. */ diff --git a/interface/wx/colour.h b/interface/wx/colour.h index cd217d853a..a3d4ef7afa 100644 --- a/interface/wx/colour.h +++ b/interface/wx/colour.h @@ -86,7 +86,7 @@ public: A packed RGB value. */ wxColour(unsigned long colRGB); - + /** Copy constructor. */ @@ -194,8 +194,8 @@ public: string (third overload). When using third form, Set() accepts: colour names (those listed in - wxColourDatabase), the CSS-like @c "rgb(r,g,b)" or @c "rgba(r,g,b,a)" syntax - (case insensitive) and the HTML-like syntax: @c "#" followed by 6 hexadecimal + wxColourDatabase), the CSS-like @c "rgb(r,g,b)" or @c "rgba(r,g,b,a)" syntax + (case insensitive) and the HTML-like syntax: @c "#" followed by 6 hexadecimal digits for red, green, blue components. Returns @true if the conversion was successful, @false otherwise. @@ -233,7 +233,7 @@ public: @since 2.9.0 */ static void MakeMono(unsigned char* r, unsigned char* g, unsigned char* b, bool on); - + /** Create a disabled (dimmed) colour from (in/out) rgb parameters. @since 2.9.0 @@ -254,7 +254,7 @@ public: @since 2.9.0 */ static void MakeGrey(unsigned char* r, unsigned char* g, unsigned char* b); - + /** Create a grey colour from (in/out) rgb parameters using floating point arithmetic. Defaults to using the standard ITU-T BT.601 when converting to YUV, where every pixel equals @@ -269,7 +269,7 @@ public: @since 2.9.0 */ static unsigned char AlphaBlend(unsigned char fg, unsigned char bg, double alpha); - + /** ChangeLightness() is a utility function that simply darkens or lightens a color, based on the specified percentage diff --git a/interface/wx/combo.h b/interface/wx/combo.h index 443d9de1c4..7583ed3cb8 100644 --- a/interface/wx/combo.h +++ b/interface/wx/combo.h @@ -69,10 +69,10 @@ public: /** Implement to customize matching of value string to an item container entry. - + @param item String entered, usually by user or from SetValue() call. - + @param trueItem When item matches an entry, but the entry's string representation is not exactly the same (case mismatch, for example), then the @@ -130,7 +130,7 @@ public: Useful in conjunction with LazyCreate(). */ bool IsCreated() const; - + /** The derived class may implement this to return @true if it wants to delay call to Create() until the popup is shown for the first time. It @@ -386,7 +386,7 @@ public: Window position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. + Window size. If ::wxDefaultSize is specified then the window is sized appropriately. @param style Window style. See wxComboCtrl. @@ -450,7 +450,7 @@ public: */ void EnablePopupAnimation(bool enable = true); - + /** Returns true if given key combination should toggle the popup. */ diff --git a/interface/wx/combobox.h b/interface/wx/combobox.h index 5447243a4d..d6728a7efa 100644 --- a/interface/wx/combobox.h +++ b/interface/wx/combobox.h @@ -101,7 +101,7 @@ public: Window position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. + Window size. If ::wxDefaultSize is specified then the window is sized appropriately. @param n Number of strings with which to initialise the control. diff --git a/interface/wx/config.h b/interface/wx/config.h index 413bfa9b49..3b4fdc40c1 100644 --- a/interface/wx/config.h +++ b/interface/wx/config.h @@ -27,9 +27,9 @@ enum However, usually you don't even need to know the precise nature of the class you're working with but you would just use the wxConfigBase methods. This allows you to write the same code regardless of whether you're working - with the registry under Windows or text-based config files under Unix. - To make writing the portable code even easier, wxWidgets provides a typedef - wxConfig which is mapped onto the native wxConfigBase implementation on the + with the registry under Windows or text-based config files under Unix. + To make writing the portable code even easier, wxWidgets provides a typedef + wxConfig which is mapped onto the native wxConfigBase implementation on the given platform: i.e. wxRegConfig under Windows and wxFileConfig otherwise. See @ref overview_config for a description of all features of this class. @@ -253,7 +253,7 @@ enum @library{wxbase} @category{cfg} - + @see wxConfigPathChanger */ class wxConfigBase : public wxObject @@ -353,7 +353,7 @@ public: Set current path: if the first character is '/', it is the absolute path, otherwise it is a relative path. '..' is supported. If @a strPath doesn't exist, it is created. - + @see wxConfigPathChanger */ virtual void SetPath(const wxString& strPath) = 0; @@ -889,7 +889,7 @@ public: @class wxConfigPathChanger A handy little class which changes the current path in a wxConfig object and restores it in dtor. - Declaring a local variable of this type, it's possible to work in a specific directory + Declaring a local variable of this type, it's possible to work in a specific directory and ensure that the path is automatically restored when the function returns. For example: @@ -902,13 +902,13 @@ public: wxString str; if ( !config->Read("SomeString", &str) ) { wxLogError("Couldn't read SomeString!"); - return false; + return false; // NOTE: without wxConfigPathChanger it would be easy to forget to // set the old path back into the wxConfig object before this return! } - + // do something useful with SomeString... - + return true; // again: wxConfigPathChanger dtor will restore the original wxConfig path } @endcode @@ -923,21 +923,21 @@ public: /** Changes the path of the given wxConfigBase object so that the key @a strEntry is accessible (for read or write). - - In other words, the ctor uses wxConfigBase::SetPath() with everything which precedes the + + In other words, the ctor uses wxConfigBase::SetPath() with everything which precedes the last slash of @a strEntry, so that: @code wxConfigPathChanger(wxConfigBase::Get(), "/MyProgram/SomeKeyName"); - @endcode + @endcode has the same effect of: @code wxConfigPathChanger(wxConfigBase::Get(), "/MyProgram/"); - @endcode + @endcode */ wxConfigPathChanger(const wxConfigBase *pContainer, const wxString& strEntry); /** - Restores the path selected, inside the wxConfig object passed to the ctor, to the path which was + Restores the path selected, inside the wxConfig object passed to the ctor, to the path which was selected when the wxConfigPathChanger ctor was called. */ ~wxConfigPathChanger(); @@ -949,9 +949,9 @@ public: const wxString& Name() const; /** - This method must be called if the original path inside the wxConfig object - (i.e. the current path at the moment of creation of this wxConfigPathChanger object) - could have been deleted, thus preventing wxConfigPathChanger from restoring the not + This method must be called if the original path inside the wxConfig object + (i.e. the current path at the moment of creation of this wxConfigPathChanger object) + could have been deleted, thus preventing wxConfigPathChanger from restoring the not existing (any more) path. If the original path doesn't exist any more, the path will be restored to diff --git a/interface/wx/control.h b/interface/wx/control.h index 34d8a388a8..04670c9e04 100644 --- a/interface/wx/control.h +++ b/interface/wx/control.h @@ -50,7 +50,7 @@ public: @param style Control style. For generic window styles, please see wxWindow. @param validator - Control validator. + Control validator. @param name Control name. */ @@ -64,7 +64,7 @@ public: Default constructor to allow 2-phase creation. */ wxControl(); - + bool Create(wxWindow *parent, wxWindowID id, const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = 0, @@ -332,7 +332,7 @@ public: public: // static functions - + /** Returns the given @a label string without mnemonics ("&" characters). */ @@ -340,7 +340,7 @@ public: // static functions /** Returns the given @a str string without mnemonics ("&" characters). - + @note This function is identical to GetLabelText() and is provided mostly for symmetry with EscapeMnemonics(). */ diff --git a/interface/wx/cshelp.h b/interface/wx/cshelp.h index e7f80d4c6b..0d5a55ab2d 100644 --- a/interface/wx/cshelp.h +++ b/interface/wx/cshelp.h @@ -257,8 +257,8 @@ public: Button position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Button size. - If ::wxDefaultSize is specified then the button is sized appropriately + Button size. + If ::wxDefaultSize is specified then the button is sized appropriately for the question mark bitmap. @param style Window style. diff --git a/interface/wx/cursor.h b/interface/wx/cursor.h index 56b5b7ad1a..12d95b1d0a 100644 --- a/interface/wx/cursor.h +++ b/interface/wx/cursor.h @@ -138,12 +138,12 @@ public: (to load a cursor from a .ico icon file) and @c wxBITMAP_TYPE_ANI (to load a cursor from a .ani icon file). - under MacOS, it defaults to @c wxBITMAP_TYPE_MACCURSOR_RESOURCE; - when specifying a string resource name, first the color cursors 'crsr' - and then the black/white cursors 'CURS' in the resource chain are scanned + when specifying a string resource name, first the color cursors 'crsr' + and then the black/white cursors 'CURS' in the resource chain are scanned through. Note that resource forks are deprecated on OS X so this is only available for legacy reasons and should not be used in new code. - - under GTK, it defaults to @c wxBITMAP_TYPE_XPM. + - under GTK, it defaults to @c wxBITMAP_TYPE_XPM. See the wxCursor(const wxImage& image) ctor for more info. - under X11, it defaults to @c wxBITMAP_TYPE_XPM. - under Motif, it defaults to @c wxBITMAP_TYPE_XBM. diff --git a/interface/wx/dataobj.h b/interface/wx/dataobj.h index b6afd34daf..9a2ea4fb54 100644 --- a/interface/wx/dataobj.h +++ b/interface/wx/dataobj.h @@ -791,7 +791,7 @@ public: @class wxHTMLDataObject wxHTMLDataObject is used for working with HTML-formatted text. - + @library{wxcore} @category{dnd} @@ -809,7 +809,7 @@ public: Returns the HTML string. */ virtual wxString GetHTML() const; - + /** Sets the HTML string. */ diff --git a/interface/wx/dataview.h b/interface/wx/dataview.h index 0c82d35a45..1c9076a908 100644 --- a/interface/wx/dataview.h +++ b/interface/wx/dataview.h @@ -78,10 +78,10 @@ @endcode A potentially better way to avoid memory leaks is to use wxObjectDataPtr - + @code wxObjectDataPtr musicModel; - + wxDataViewCtrl *musicCtrl = new wxDataViewCtrl( this, wxID_ANY ); musicModel = new MyMusicModel; m_musicCtrl->AssociateModel( musicModel.get() ); @@ -382,7 +382,7 @@ public: */ bool ValueChanged(const wxDataViewItem& item, unsigned int col); - + virtual bool IsListModel() const; virtual bool IsVirtualListModel() const; @@ -527,7 +527,7 @@ public: have other reason to use a virtual control. @see wxDataViewListModel for the API. - + @library{wxcore} @category{dvc} */ @@ -2064,7 +2064,7 @@ public: */ virtual bool Validate(wxVariant& value); - + virtual bool HasEditorCtrl() const; virtual wxWindow* CreateEditorCtrl(wxWindow * parent, wxRect labelRect, @@ -3284,7 +3284,7 @@ public: Returns true if item is a container. */ bool IsContainer( const wxDataViewItem& item ); - + /** Calls the same method from wxDataViewTreeStore but uses an index position in the image list instead of a wxIcon. diff --git a/interface/wx/datectrl.h b/interface/wx/datectrl.h index 01bd909925..72199583e7 100644 --- a/interface/wx/datectrl.h +++ b/interface/wx/datectrl.h @@ -87,7 +87,7 @@ public: Default constructor. */ wxDatePickerCtrl(); - + /** Initializes the object and calls Create() with all the parameters. */ diff --git a/interface/wx/datetime.h b/interface/wx/datetime.h index 53595c78be..68f8630713 100644 --- a/interface/wx/datetime.h +++ b/interface/wx/datetime.h @@ -325,7 +325,7 @@ public: Copy constructor. */ wxDateTime(const wxDateTime& date); - + /** Same as Set(). */ @@ -387,7 +387,7 @@ public: @a wxDateTime::Tm structure. */ wxDateTime& Set(const Tm& tm); - + /** Sets the date from the so-called Julian Day Number. diff --git a/interface/wx/dc.h b/interface/wx/dc.h index 7d7f289e28..84238b44df 100644 --- a/interface/wx/dc.h +++ b/interface/wx/dc.h @@ -550,7 +550,7 @@ public: void DrawRectangle(const wxRect& rect); /** - Draws the text rotated by @a angle degrees + Draws the text rotated by @a angle degrees (positive angles are counterclockwise; the full angle is 360 degrees). Notice that, as with DrawText(), the @a text can contain multiple lines @@ -980,10 +980,10 @@ public: int GetBackgroundMode() const; /** - Gets the current font. - - Notice that even although each device context object has some default font - after creation, this method would return a ::wxNullFont initially and only + Gets the current font. + + Notice that even although each device context object has some default font + after creation, this method would return a ::wxNullFont initially and only after calling SetFont() a valid font is returned. */ const wxFont& GetFont() const; @@ -1014,17 +1014,17 @@ public: /** @a mode may be one of @c wxPENSTYLE_SOLID and @c wxPENSTYLE_TRANSPARENT. - - This setting determines whether text will be drawn with a background + + This setting determines whether text will be drawn with a background colour or not. */ void SetBackgroundMode(int mode); /** - Sets the current font for the DC. + Sets the current font for the DC. - If the argument is ::wxNullFont (or another invalid font; see wxFont::IsOk), - the current font is selected out of the device context (leaving wxDC without + If the argument is ::wxNullFont (or another invalid font; see wxFont::IsOk), + the current font is selected out of the device context (leaving wxDC without any valid font), allowing the current font to be destroyed safely. @see wxFont @@ -1045,9 +1045,9 @@ public: void SetTextForeground(const wxColour& colour); /** - Sets the current layout direction for the device context. - - @param dir + Sets the current layout direction for the device context. + + @param dir May be either @c wxLayout_Default, @c wxLayout_LeftToRight or @c wxLayout_RightToLeft. @@ -1333,8 +1333,8 @@ public: /** Sets the current brush for the DC. - If the argument is ::wxNullBrush (or another invalid brush; see wxBrush::IsOk), - the current brush is selected out of the device context (leaving wxDC without + If the argument is ::wxNullBrush (or another invalid brush; see wxBrush::IsOk), + the current brush is selected out of the device context (leaving wxDC without any valid brush), allowing the current brush to be destroyed safely. @see wxBrush, wxMemoryDC (for the interpretation of colours when @@ -1343,10 +1343,10 @@ public: void SetBrush(const wxBrush& brush); /** - Sets the current pen for the DC. + Sets the current pen for the DC. - If the argument is ::wxNullPen (or another invalid pen; see wxPen::IsOk), - the current pen is selected out of the device context (leaving wxDC without any + If the argument is ::wxNullPen (or another invalid pen; see wxPen::IsOk), + the current pen is selected out of the device context (leaving wxDC without any valid pen), allowing the current pen to be destroyed safely. @see wxMemoryDC for the interpretation of colours when drawing into a @@ -1592,7 +1592,7 @@ public: //@} - + /** @name query capabilities */ @@ -1607,7 +1607,7 @@ public: Does the DC support calculating the size required to draw text? */ bool CanGetTextExtent() const; - + //@} /** @@ -1620,12 +1620,12 @@ public: wxGCDC then the return value will be the value returned from wxGraphicsContext::GetNativeContext. A value of NULL is returned if the DC does not have anything that fits the handle concept. - + @since 2.9.5 */ void* GetHandle() const; - + /** If supported by the platform and the type of DC, fetch the contents of the DC, or a subset of it, as a bitmap. */ diff --git a/interface/wx/dcbuffer.h b/interface/wx/dcbuffer.h index 9268e437aa..e29859802b 100644 --- a/interface/wx/dcbuffer.h +++ b/interface/wx/dcbuffer.h @@ -122,7 +122,7 @@ public: /** Blits the buffer to the dc, and detaches the dc from the buffer (so it can be effectively used once only). - + Usually only called in the destructor or by the destructor of derived classes if the BufferedDC must blit before the derived class (which may own the dc it's blitting to) is destroyed. diff --git a/interface/wx/dcgraph.h b/interface/wx/dcgraph.h index ed2d01a9c1..e12a49db61 100644 --- a/interface/wx/dcgraph.h +++ b/interface/wx/dcgraph.h @@ -60,7 +60,7 @@ public: wxGCDC(); virtual ~wxGCDC(); - + /** Retrieves associated wxGraphicsContext */ diff --git a/interface/wx/debugrpt.h b/interface/wx/debugrpt.h index c6849f9e1e..7af5267efc 100644 --- a/interface/wx/debugrpt.h +++ b/interface/wx/debugrpt.h @@ -221,8 +221,8 @@ public: is copied to a file in the debug report directory with the same name. Otherwise the file will be searched in the temporary directory returned by GetDirectory(). - - The argument @a description only exists to be displayed to the user in + + The argument @a description only exists to be displayed to the user in the report summary shown by wxDebugReportPreview. @see GetDirectory(), AddText() diff --git a/interface/wx/defs.h b/interface/wx/defs.h index 2359cdcaab..3a07a81dab 100644 --- a/interface/wx/defs.h +++ b/interface/wx/defs.h @@ -536,7 +536,7 @@ enum wxBackgroundStyle with this style. */ wxBG_STYLE_PAINT, - + /* this style is deprecated and doesn't do anything, don't use */ wxBG_STYLE_COLOUR, @@ -907,7 +907,7 @@ enum wxKeyCode WXK_CONTROL_X, WXK_CONTROL_Y, WXK_CONTROL_Z, - + WXK_BACK = 8, //!< Backspace. WXK_TAB = 9, WXK_RETURN = 13, @@ -1034,7 +1034,7 @@ enum wxKeyCode WXK_WINDOWS_LEFT, WXK_WINDOWS_RIGHT, WXK_WINDOWS_MENU , - + /** This special key code was used to represent the key used for keyboard shortcuts. Under OS X, * this key maps to the 'Command' (aka logo or 'Apple') key, whereas on Linux/Windows/others * this is the Control key, with the new semantic of WXK_CONTROL, WXK_COMMAND is not needed anymore @@ -1095,11 +1095,11 @@ enum wxKeyModifier wxMOD_SHIFT = 0x0004, wxMOD_META = 0x0008, wxMOD_WIN = wxMOD_META, - + /** used to describe the true Ctrl Key under OS X, identic to @c wxMOD_CONTROL on other platforms */ wxMOD_RAW_CONTROL, - + /** deprecated, identic to @c wxMOD_CONTROL on all platforms */ wxMOD_CMD = wxMOD_CONTROL, wxMOD_ALL = 0xffff diff --git a/interface/wx/dir.h b/interface/wx/dir.h index 976f9a1a87..3fbb0fd083 100644 --- a/interface/wx/dir.h +++ b/interface/wx/dir.h @@ -233,7 +233,7 @@ public: would be unchanged and should include ::wxDIR_DIRS flag to recurse into subdirectories (both flags are included in the value by default). See ::wxDirFlags for the list of the possible flags. - + @return Returns the total number of files found while traversing the directory @a dirname (i.e. the number of entries appended to the @a files array). @@ -324,7 +324,7 @@ public: /** Creates a directory. - + This is just an alias for wxFileName::Mkdir(); refer to that function for more info. */ @@ -339,12 +339,12 @@ public: /** Removes a directory. - + This is just an alias for wxFileName::Rmdir(); refer to that function for more info. */ static bool Remove(const wxString &dir, int flags = 0); - + /** Enumerate all files and directories under the given directory. diff --git a/interface/wx/dirctrl.h b/interface/wx/dirctrl.h index dc43e1d6d1..69b4bb120b 100644 --- a/interface/wx/dirctrl.h +++ b/interface/wx/dirctrl.h @@ -52,7 +52,7 @@ enum @library{wxcore} @category{ctrl} @appearance{genericdirctrl} - + @beginEventEmissionTable @event{EVT_DIRCTRL_SELECTIONCHANGED(id, func)} Selected directory has changed. diff --git a/interface/wx/editlbox.h b/interface/wx/editlbox.h index 4152c63ea2..80462b24dc 100644 --- a/interface/wx/editlbox.h +++ b/interface/wx/editlbox.h @@ -58,7 +58,7 @@ public: Window position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. + Window size. If ::wxDefaultSize is specified then the window is sized appropriately. @param style Window style. See wxEditableListBox. diff --git a/interface/wx/event.h b/interface/wx/event.h index c198be2e6a..f0134f5d36 100644 --- a/interface/wx/event.h +++ b/interface/wx/event.h @@ -1867,7 +1867,7 @@ public: int GetPosition() const; void SetOrientation(int orient); - void SetPosition(int pos); + void SetPosition(int pos); }; @@ -3298,7 +3298,7 @@ class wxQueryNewPaletteEvent : public wxEvent { public: wxQueryNewPaletteEvent(wxWindowID winid = 0); - + void SetPaletteRealized(bool realized); bool GetPaletteRealized(); }; @@ -3653,9 +3653,9 @@ public: */ int GetPosition() const; - + void SetOrientation(int orient); - void SetPosition(int pos); + void SetPosition(int pos); }; @@ -4179,7 +4179,7 @@ public: /** Sets the flags for this event. - The @a flags can be a combination of the + The @a flags can be a combination of the wxNavigationKeyEvent::wxNavigationKeyEventFlags values. */ void SetFlags(long flags); @@ -4563,7 +4563,7 @@ public: wxRect GetRect() const; void SetRect(const wxRect& rect); - void SetPosition(const wxPoint& pos); + void SetPosition(const wxPoint& pos); }; @@ -4587,7 +4587,7 @@ public: @b Important : Sizers ( see @ref overview_sizer ) rely on size events to function correctly. Therefore, in a sizer-based layout, do not forget to call Skip on all size events you catch (and don't catch size events at all when you don't need to). - + @beginEventTable{wxSizeEvent} @event{EVT_SIZE(func)} Process a @c wxEVT_SIZE event. @@ -4844,7 +4844,7 @@ wxEventType wxNewEventType(); In the implementation file you'll need to use the wxBEGIN_EVENT_TABLE() and the wxEND_EVENT_TABLE() macros, plus some additional @c EVT_xxx macro to capture events. - + Note that this macro requires a final semicolon. @see @ref overview_events_eventtables diff --git a/interface/wx/evtloop.h b/interface/wx/evtloop.h index 87750b103d..74d0056232 100644 --- a/interface/wx/evtloop.h +++ b/interface/wx/evtloop.h @@ -324,7 +324,7 @@ public: @class wxGUIEventLoop A generic implementation of the GUI event loop. - + @library{wxbase} @category{appmanagement} */ diff --git a/interface/wx/fileconf.h b/interface/wx/fileconf.h index eff88ef6d2..8e71afb541 100644 --- a/interface/wx/fileconf.h +++ b/interface/wx/fileconf.h @@ -105,7 +105,7 @@ public: @see wxCHANGE_UMASK() */ void SetUmask(int mode); - + // implement inherited pure virtual functions virtual void SetPath(const wxString& strPath); virtual const wxString& GetPath() const; diff --git a/interface/wx/filedlg.h b/interface/wx/filedlg.h index 403d6c4d7d..890491d112 100644 --- a/interface/wx/filedlg.h +++ b/interface/wx/filedlg.h @@ -48,14 +48,14 @@ const char wxFileSelectorDefaultWildcardStr[]; return; //else: proceed asking to the user the new file to open } - - wxFileDialog + + wxFileDialog openFileDialog(this, _("Open XYZ file"), "", "", "XYZ files (*.xyz)|*.xyz", wxFD_OPEN|wxFD_FILE_MUST_EXIST); if (openFileDialog.ShowModal() == wxID_CANCEL) return; // the user changed idea... - + // proceed loading the file chosen by the user; // this can be done with e.g. wxWidgets input streams: wxFileInputStream input_stream(openFileDialog.GetPath()); @@ -64,22 +64,22 @@ const char wxFileSelectorDefaultWildcardStr[]; wxLogError("Cannot open file '%s'.", openFileDialog.GetPath()); return; } - + ... } @endcode - + The typical usage for the save file dialog is instead somewhat simpler: @code void MyFrame::OnSaveAs(wxCommandEvent& WXUNUSED(event)) { - wxFileDialog + wxFileDialog saveFileDialog(this, _("Save XYZ file"), "", "", "XYZ files (*.xyz)|*.xyz", wxFD_SAVE|wxFD_OVERWRITE_PROMPT); if (saveFileDialog.ShowModal() == wxID_CANCEL) return; // the user changed idea... - + // save the current contents in the file; // this can be done with e.g. wxWidgets output streams: wxFileOutputStream output_stream(saveFileDialog.GetPath()); @@ -88,7 +88,7 @@ const char wxFileSelectorDefaultWildcardStr[]; wxLogError("Cannot save current contents in file '%s'.", saveFileDialog.GetPath()); return; } - + ... } @endcode @@ -136,7 +136,7 @@ const char wxFileSelectorDefaultWildcardStr[]; @style{wxFD_MULTIPLE} For open dialog only: allows selecting multiple files. @style{wxFD_CHANGE_DIR} - Change the current working directory (when the dialog is dismissed) + Change the current working directory (when the dialog is dismissed) to the directory where the file(s) chosen by the user are. @style{wxFD_PREVIEW} Show the preview of the selected files (currently only supported by @@ -302,7 +302,7 @@ public: /** Sets the default filename. - + In wxGTK this will have little effect unless a default directory has previously been set. */ virtual void SetFilename(const wxString& setfilename); diff --git a/interface/wx/filepicker.h b/interface/wx/filepicker.h index 0856634770..d226838986 100644 --- a/interface/wx/filepicker.h +++ b/interface/wx/filepicker.h @@ -83,7 +83,7 @@ class wxFilePickerCtrl : public wxPickerBase { public: wxFilePickerCtrl(); - + /** Initializes the object and calls Create() with all the parameters. @@ -237,7 +237,7 @@ class wxDirPickerCtrl : public wxPickerBase { public: wxDirPickerCtrl(); - + /** Initializes the object and calls Create() with all the parameters. diff --git a/interface/wx/filesys.h b/interface/wx/filesys.h index 0145b949ba..1e7ca40d20 100644 --- a/interface/wx/filesys.h +++ b/interface/wx/filesys.h @@ -64,7 +64,7 @@ public: Remove a filesystem handler from the list of handlers. */ static wxFileSystemHandler* RemoveHandler(wxFileSystemHandler *handler); - + /** Sets the current location. @a location parameter passed to OpenFile() is relative to this path. diff --git a/interface/wx/fontpicker.h b/interface/wx/fontpicker.h index 7282c4f4cc..424fccd9be 100644 --- a/interface/wx/fontpicker.h +++ b/interface/wx/fontpicker.h @@ -59,7 +59,7 @@ class wxFontPickerCtrl : public wxPickerBase { public: wxFontPickerCtrl(); - + /** Initializes the object and calls Create() with all the parameters. diff --git a/interface/wx/fontutil.h b/interface/wx/fontutil.h index 5109babd57..d880edcb75 100644 --- a/interface/wx/fontutil.h +++ b/interface/wx/fontutil.h @@ -8,7 +8,7 @@ /** @class wxNativeFontInfo - + wxNativeFontInfo is platform-specific font representation: this class should be considered as an opaque font description only used by the native functions, the user code can only get the objects of this type from diff --git a/interface/wx/gbsizer.h b/interface/wx/gbsizer.h index 5279db00c0..1fd3857d8d 100644 --- a/interface/wx/gbsizer.h +++ b/interface/wx/gbsizer.h @@ -82,7 +82,7 @@ public: //@{ /** Adds the given item to the given position. - + @return A valid pointer if the item was successfully placed at the given position, or @NULL if something was already there. */ @@ -299,7 +299,7 @@ public: */ bool SetSpan(const wxGBSpan& span); - + wxGridBagSizer* GetGBSizer() const; void SetGBSizer(wxGridBagSizer* sizer); }; diff --git a/interface/wx/gdicmn.h b/interface/wx/gdicmn.h index 200c06ff89..50934ba2c5 100644 --- a/interface/wx/gdicmn.h +++ b/interface/wx/gdicmn.h @@ -557,7 +557,7 @@ public: */ void SetBottomLeft(const wxPoint &p); - + //@{ /** Modifies the rectangle to contain the bounding box of this rectangle diff --git a/interface/wx/generic/helpext.h b/interface/wx/generic/helpext.h index 2f0174f2ca..59d03baaac 100644 --- a/interface/wx/generic/helpext.h +++ b/interface/wx/generic/helpext.h @@ -111,9 +111,9 @@ public: @param k string to search for, empty string will list all entries - - @param mode - optional parameter allows the search the index (wxHELP_SEARCH_INDEX) + + @param mode + optional parameter allows the search the index (wxHELP_SEARCH_INDEX) but this currently only supported by the wxHtmlHelpController. @return @true on success diff --git a/interface/wx/geometry.h b/interface/wx/geometry.h index 51adabbb28..1db6856378 100644 --- a/interface/wx/geometry.h +++ b/interface/wx/geometry.h @@ -279,7 +279,7 @@ public: void Inset( wxInt32 x , wxInt32 y ); void Inset( wxInt32 left , wxInt32 top ,wxInt32 right , wxInt32 bottom ); void Offset( const wxPoint2DInt &pt ); - void ConstrainTo( const wxRect2DInt &rect ); + void ConstrainTo( const wxRect2DInt &rect ); wxPoint2DInt Interpolate( wxInt32 widthfactor , wxInt32 heightfactor ); static void Intersect( const wxRect2DInt &src1 , const wxRect2DInt &src2 , wxRect2DInt *dest ); diff --git a/interface/wx/headerctrl.h b/interface/wx/headerctrl.h index 8a9907d546..d8045cf6de 100644 --- a/interface/wx/headerctrl.h +++ b/interface/wx/headerctrl.h @@ -692,7 +692,7 @@ public: */ int GetColumn() const; void SetColumn(int col); - + /** Return the current width of the column. @@ -700,7 +700,7 @@ public: */ int GetWidth() const; void SetWidth(int width); - + /** Return the new order of the column. diff --git a/interface/wx/help.h b/interface/wx/help.h index 58294c23cd..9b7b3b8400 100644 --- a/interface/wx/help.h +++ b/interface/wx/help.h @@ -247,7 +247,7 @@ public: This is an alias for one of a family of help controller classes which is most appropriate for the current platform. - + A help controller allows an application to display help, at the contents or at a particular topic, and shut the help program down on termination. This avoids proliferation of many instances of the help viewer whenever the diff --git a/interface/wx/html/helpctrl.h b/interface/wx/html/helpctrl.h index 9cbea267c5..bb3e1064a7 100644 --- a/interface/wx/html/helpctrl.h +++ b/interface/wx/html/helpctrl.h @@ -269,7 +269,7 @@ public: wxHtmlHelpDialog* GetDialog(); - + protected: /** diff --git a/interface/wx/html/helpdata.h b/interface/wx/html/helpdata.h index 36537406b0..f652185a9e 100644 --- a/interface/wx/html/helpdata.h +++ b/interface/wx/html/helpdata.h @@ -20,7 +20,7 @@ public: wxString GetTitle() const; wxString GetStart() const; wxString GetBasePath() const; - + /* SetContentsRange: store in the bookrecord where in the index/contents lists the * book's records are stored. This to facilitate searching in a specific book. * This code will have to be revised when loading/removing books becomes dynamic. diff --git a/interface/wx/html/htmlcell.h b/interface/wx/html/htmlcell.h index ec5d7ae5f8..af3b201db1 100644 --- a/interface/wx/html/htmlcell.h +++ b/interface/wx/html/htmlcell.h @@ -8,7 +8,7 @@ /** @class wxHtmlRenderingStyle - + wxHtmlSelection is data holder with information about text selection. Selection is defined by two positions (beginning and end of the selection) and two leaf(!) cells at these positions. diff --git a/interface/wx/html/htmprint.h b/interface/wx/html/htmprint.h index 1b4a4e861b..cb6b86822e 100644 --- a/interface/wx/html/htmprint.h +++ b/interface/wx/html/htmprint.h @@ -136,15 +136,15 @@ public: Sets font sizes to be relative to the given size or the system default size; use either specified or default font - @param size + @param size Point size of the default HTML text @param normal_face - This is face name for normal (i.e. non-fixed) font. It can be - either empty string (then the default face is chosen) or - platform-specific face name. Examples are "helvetica" under + This is face name for normal (i.e. non-fixed) font. It can be + either empty string (then the default face is chosen) or + platform-specific face name. Examples are "helvetica" under Unix or "Times New Roman" under Windows. @param fixed_face - The same thing for fixed face ( \..\ ) + The same thing for fixed face ( \..\ ) @see SetSize() */ @@ -301,7 +301,7 @@ public: */ void SetFonts(const wxString& normal_face, const wxString& fixed_face, const int* sizes = NULL); - + /** Sets the name used for preview frames and setup dialogs. @@ -310,7 +310,7 @@ public: void SetName(const wxString& name); /** - Sets default font sizes and/or default font size. + Sets default font sizes and/or default font size. See wxHtmlDCRenderer::SetStandardFonts for detailed description. @see SetFonts() */ diff --git a/interface/wx/html/webkit.h b/interface/wx/html/webkit.h index dce5f0e5f5..d00c857f7a 100644 --- a/interface/wx/html/webkit.h +++ b/interface/wx/html/webkit.h @@ -35,7 +35,7 @@ public: const wxSize& size = wxDefaultSize, long style = 0, const wxValidator& validator = wxDefaultValidator, const wxString& name = wxWebKitCtrlNameStr); - + bool Create(wxWindow *parent, wxWindowID winid, const wxString& strURL, diff --git a/interface/wx/htmllbox.h b/interface/wx/htmllbox.h index 5a051bc1be..b70f62213f 100644 --- a/interface/wx/htmllbox.h +++ b/interface/wx/htmllbox.h @@ -218,7 +218,7 @@ public: Window position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. + Window size. If ::wxDefaultSize is specified then the window is sized appropriately. @param n Number of strings with which to initialise the control. diff --git a/interface/wx/hyperlink.h b/interface/wx/hyperlink.h index ff0f136654..b389e0b465 100644 --- a/interface/wx/hyperlink.h +++ b/interface/wx/hyperlink.h @@ -100,7 +100,7 @@ class wxHyperlinkCtrl : public wxControl { public: wxHyperlinkCtrl(); - + /** Constructor. See Create() for more info. */ diff --git a/interface/wx/iconbndl.h b/interface/wx/iconbndl.h index ef1fdd9023..f81f71f46f 100644 --- a/interface/wx/iconbndl.h +++ b/interface/wx/iconbndl.h @@ -140,10 +140,10 @@ public: always returned. Otherwise, the behaviour depends on the flags. If only wxIconBundle::FALLBACK_NONE is given, the function returns an invalid icon. If wxIconBundle::FALLBACK_SYSTEM is given, it tries to find the - icon of standard system size, regardless of the size passed as + icon of standard system size, regardless of the size passed as parameter. Otherwise, or if the icon system size is not found neither, but wxIconBundle::FALLBACK_NEAREST_LARGER flag is specified, the - function returns the smallest icon of the size larger than the + function returns the smallest icon of the size larger than the requested one or, if this fails too, just the icon closest to the specified size. diff --git a/interface/wx/image.h b/interface/wx/image.h index c3d47af52b..43f48aeb81 100644 --- a/interface/wx/image.h +++ b/interface/wx/image.h @@ -350,7 +350,7 @@ protected: /** Called to get the number of images available in a multi-image file type, if supported. - + NOTE: this function is allowed to change the current stream position since GetImageCount() will take care of restoring it later */ @@ -358,7 +358,7 @@ protected: /** Called to test if this handler can read an image from the given stream. - + NOTE: this function is allowed to change the current stream position since CallDoCanRead() will take care of restoring it later */ @@ -512,7 +512,7 @@ public: double hue; double saturation; - double value; + double value; }; /** @@ -1744,7 +1744,7 @@ public: /** Set the color of the pixel at the given x and y coordinate. */ - + void SetRGB( int x, int y, unsigned char r, unsigned char g, unsigned char b ); /** diff --git a/interface/wx/imaggif.h b/interface/wx/imaggif.h index 0fa8b0257a..b30540a4eb 100644 --- a/interface/wx/imaggif.h +++ b/interface/wx/imaggif.h @@ -1,9 +1,9 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: imaggif.h -// Purpose: interface of wxGIFHandler -// Author: Samuel Dunn -// Licence: wxWindows licence -//////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// +// Name: imaggif.h +// Purpose: interface of wxGIFHandler +// Author: Samuel Dunn +// Licence: wxWindows licence +//////////////////////////////////////////////////////////////////////////// #define wxIMAGE_OPTION_GIF_COMMENT wxT("GifComment") @@ -25,13 +25,13 @@ public: */ wxGIFHandler(); - virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose = true, + virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose = true, int index = -1); virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true); /** Save the animated gif. - + @param images The image array object which is to be affected by this operation. @param stream diff --git a/interface/wx/imagiff.h b/interface/wx/imagiff.h index 128b05935c..fdf19a469d 100644 --- a/interface/wx/imagiff.h +++ b/interface/wx/imagiff.h @@ -1,11 +1,11 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: imagiff.h -// Purpose: interface of wxIFFHandler -// Author: Samuel Dunn -// Licence: wxWindows licence -//////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// +// Name: imagiff.h +// Purpose: interface of wxIFFHandler +// Author: Samuel Dunn +// Licence: wxWindows licence +//////////////////////////////////////////////////////////////////////////// -/** +/** @class wxIFFHandler This is the image handler for the IFF format. diff --git a/interface/wx/imagjpeg.h b/interface/wx/imagjpeg.h index 3cbd9b2ef8..2e68d982db 100644 --- a/interface/wx/imagjpeg.h +++ b/interface/wx/imagjpeg.h @@ -1,11 +1,11 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: imagjpeg.h -// Purpose: interface of wxJPEGHandler -// Author: Samuel Dunn -// Licence: wxWindows licence -//////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// +// Name: imagjpeg.h +// Purpose: interface of wxJPEGHandler +// Author: Samuel Dunn +// Licence: wxWindows licence +//////////////////////////////////////////////////////////////////////////// -/** +/** @class wxJPEGHandler This is the image handler for the JPEG format. @@ -22,7 +22,7 @@ public: Default constructor for wxJPEGHandler */ wxJPEGHandler(); - + /** Retrieve the version information about the JPEG library used by this handler. diff --git a/interface/wx/imagpcx.h b/interface/wx/imagpcx.h index 4872dad801..b2dcbb7c42 100644 --- a/interface/wx/imagpcx.h +++ b/interface/wx/imagpcx.h @@ -1,11 +1,11 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: imagpcx.h -// Purpose: interface of wxPCXHandler -// Author: Samuel Dunn -// Licence: wxWindows licence -//////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// +// Name: imagpcx.h +// Purpose: interface of wxPCXHandler +// Author: Samuel Dunn +// Licence: wxWindows licence +//////////////////////////////////////////////////////////////////////////// -/** +/** @class wxPCXHandler This is the image handler for the PCX format. diff --git a/interface/wx/imagpng.h b/interface/wx/imagpng.h index a87febf1a4..7605c5bc69 100644 --- a/interface/wx/imagpng.h +++ b/interface/wx/imagpng.h @@ -1,9 +1,9 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: imagpng.h -// Purpose: interface of wxPNGHandler -// Author: Samuel Dunn -// Licence: wxWindows licence -//////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// +// Name: imagpng.h +// Purpose: interface of wxPNGHandler +// Author: Samuel Dunn +// Licence: wxWindows licence +//////////////////////////////////////////////////////////////////////////// #define wxIMAGE_OPTION_PNG_FORMAT wxT("PngFormat") #define wxIMAGE_OPTION_PNG_BITDEPTH wxT("PngBitDepth") diff --git a/interface/wx/imagpnm.h b/interface/wx/imagpnm.h index 01f923b59b..a538f48f72 100644 --- a/interface/wx/imagpnm.h +++ b/interface/wx/imagpnm.h @@ -1,11 +1,11 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: imagpnm.h -// Purpose: interface of wxPNMHandler -// Author: Samuel Dunn -// Licence: wxWindows licence -//////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// +// Name: imagpnm.h +// Purpose: interface of wxPNMHandler +// Author: Samuel Dunn +// Licence: wxWindows licence +//////////////////////////////////////////////////////////////////////////// -/** +/** @class wxPNMHandler This is the image handler for the PNM format. diff --git a/interface/wx/imagtga.h b/interface/wx/imagtga.h index b5c2682861..dbdd3d9207 100644 --- a/interface/wx/imagtga.h +++ b/interface/wx/imagtga.h @@ -1,11 +1,11 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: imagtga.h -// Purpose: interface of wxTGAHandler -// Author: Samuel Dunn -// Licence: wxWindows licence -//////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// +// Name: imagtga.h +// Purpose: interface of wxTGAHandler +// Author: Samuel Dunn +// Licence: wxWindows licence +//////////////////////////////////////////////////////////////////////////// -/** +/** @class wxTGAHandler This is the image handler for the TGA format. diff --git a/interface/wx/imagtiff.h b/interface/wx/imagtiff.h index 260c0ea1de..d370d2e72d 100644 --- a/interface/wx/imagtiff.h +++ b/interface/wx/imagtiff.h @@ -13,12 +13,12 @@ /** @class wxTIFFHandler - + This is the image handler for the TIFF format. - + @library{wxcore} @category{gdi} - + @see wxImage, wxImageHandler, wxInitAllImageHandlers() */ class wxTIFFHandler : public wxImageHandler @@ -28,7 +28,7 @@ public: Default constructor for wxTIFFHandler */ wxTIFFHandler(); - + /** Retrieve the version information about the TIFF library used by this handler. @@ -36,10 +36,10 @@ public: @since 2.9.2 */ static wxVersionInfo GetLibraryVersionInfo(); - + // let the parent class' (wxImageHandler) documentation through for these methods virtual bool LoadFile(wxImage *image, wxInputStream& stream, bool verbose=true, int index=-1); - + protected: virtual bool SaveFile(wxImage *image, wxOutputStream& stream, bool verbose=true); virtual int DoGetImageCount(wxInputStream& stream); diff --git a/interface/wx/imagxpm.h b/interface/wx/imagxpm.h index 03e6b5fc3c..dff40ed5a1 100644 --- a/interface/wx/imagxpm.h +++ b/interface/wx/imagxpm.h @@ -1,11 +1,11 @@ -///////////////////////////////////////////////////////////////////////////// -// Name: imagxpm.h -// Purpose: interface of wxXPMHandler -// Author: Samuel Dunn -// Licence: wxWindows licence -//////////////////////////////////////////////////////////////////////////// +///////////////////////////////////////////////////////////////////////////// +// Name: imagxpm.h +// Purpose: interface of wxXPMHandler +// Author: Samuel Dunn +// Licence: wxWindows licence +//////////////////////////////////////////////////////////////////////////// -/** +/** @class wxXPMHandler This is the image handler for the XPM format. diff --git a/interface/wx/intl.h b/interface/wx/intl.h index 63bcf9f260..8abf9a9c57 100644 --- a/interface/wx/intl.h +++ b/interface/wx/intl.h @@ -98,15 +98,15 @@ enum wxLocaleCategory /** The values understood by wxLocale::GetInfo(). - - Note that for the @c wxLOCALE_*_FMT constants (the date and time formats), + + Note that for the @c wxLOCALE_*_FMT constants (the date and time formats), the strings returned by wxLocale::GetInfo() use strftime() or, equivalently, wxDateTime::Format() format. If the relevant format couldn't be determined, an empty string is returned -- there is no fallback value so that the application could determine the best course of actions itself in such case. - All of these values are used with @c wxLOCALE_CAT_DATE in wxLocale::GetInfo() or, + All of these values are used with @c wxLOCALE_CAT_DATE in wxLocale::GetInfo() or, more typically, with @c wxLOCALE_CAT_DEFAULT as they only apply to a single category. */ enum wxLocaleInfo diff --git a/interface/wx/kbdstate.h b/interface/wx/kbdstate.h index bbc8e4eac7..fc26fc257e 100644 --- a/interface/wx/kbdstate.h +++ b/interface/wx/kbdstate.h @@ -107,9 +107,9 @@ public: /** Returns true if the Control key (also under OS X). - + This function doesn't distinguish between right and left control keys. - + Notice that GetModifiers() should usually be used instead of this one. */ bool RawControlDown() const; @@ -127,7 +127,7 @@ public: Returns true if the Meta/Windows/Apple key is pressed. This function tests the state of the key traditionally called Meta - under Unix systems, Windows keys under MSW + under Unix systems, Windows keys under MSW Notice that GetModifiers() should usually be used instead of this one. @see CmdDown() @@ -149,7 +149,7 @@ public: */ bool CmdDown() const; - + void SetControlDown(bool down); void SetRawControlDown(bool down); void SetShiftDown(bool down); diff --git a/interface/wx/listbox.h b/interface/wx/listbox.h index 7ccb4513e3..53c07ddab1 100644 --- a/interface/wx/listbox.h +++ b/interface/wx/listbox.h @@ -176,9 +176,9 @@ public: void Deselect(int n); virtual void SetSelection(int n); - + virtual int GetSelection() const; - + virtual bool SetStringSelection(const wxString& s, bool select); virtual bool SetStringSelection(const wxString& s); @@ -324,8 +324,8 @@ public: // NOTE: Phoenix needs to see the implementation of pure virtuals so it // knows that this class is not abstract. virtual unsigned int GetCount() const; - virtual wxString GetString(unsigned int n) const; - virtual void SetString(unsigned int n, const wxString& s); - virtual int FindString(const wxString& s, bool bCase = false) const; + virtual wxString GetString(unsigned int n) const; + virtual void SetString(unsigned int n, const wxString& s); + virtual int FindString(const wxString& s, bool bCase = false) const; }; diff --git a/interface/wx/listctrl.h b/interface/wx/listctrl.h index 47dc767f11..6692f09907 100644 --- a/interface/wx/listctrl.h +++ b/interface/wx/listctrl.h @@ -374,7 +374,7 @@ public: @return @true if all columns were successfully deleted, @false otherwise. */ bool DeleteAllColumns(); - + /** Deletes all items in the list control. @@ -1405,7 +1405,7 @@ protected: @event{EVT_LIST_ITEM_RIGHT_CLICK(id, func)} The right mouse button has been clicked on an item. @event{EVT_LIST_KEY_DOWN(id, func)} - A key has been pressed. GetIndex() may be -1 if no item is selected. + A key has been pressed. GetIndex() may be -1 if no item is selected. @event{EVT_LIST_INSERT_ITEM(id, func)} An item has been inserted. @event{EVT_LIST_COL_CLICK(id, func)} @@ -1516,7 +1516,7 @@ public: */ bool IsEditCancelled() const; - + /** @see GetKeyCode() */ diff --git a/interface/wx/log.h b/interface/wx/log.h index 53bb403bc6..213365b5d2 100644 --- a/interface/wx/log.h +++ b/interface/wx/log.h @@ -507,7 +507,7 @@ public: /** Show all pending output and clear the buffer. - + Some of wxLog implementations, most notably the standard wxLogGui class, buffer the messages (for example, to avoid showing the user a zillion of modal message boxes one after another -- which would be really annoying). @@ -1398,8 +1398,8 @@ void wxVLogError(const char* formatString, va_list argPtr); make sense to separate them from other debug messages. Trace messages can be separated into different categories; these functions in facts - only log the message if the given @a mask is currently enabled in wxLog. - This lets you selectively trace only some operations and not others by enabling the + only log the message if the given @a mask is currently enabled in wxLog. + This lets you selectively trace only some operations and not others by enabling the desired trace masks with wxLog::AddTraceMask() or by setting the @ref overview_envvars "@c WXTRACE environment variable". diff --git a/interface/wx/math.h b/interface/wx/math.h index b1486c270c..5774680131 100644 --- a/interface/wx/math.h +++ b/interface/wx/math.h @@ -93,7 +93,7 @@ unsigned int wxCTZ(wxUint32 x); */ int wxRound(double x); -/** +/** Returns true if both double values are identical. This is only reliable if both values have been assigned the same value. diff --git a/interface/wx/menu.h b/interface/wx/menu.h index 233f042f55..1b8a85aaca 100644 --- a/interface/wx/menu.h +++ b/interface/wx/menu.h @@ -382,27 +382,27 @@ public: @remarks Use only after the menubar has been associated with a frame. */ virtual void SetMenuLabel(size_t pos, const wxString& label); - - /** + + /** Enables you to set the global menubar on Mac, that is, the menubar displayed when the app is running without any frames open. - + @param menubar The menubar to set. - - @remarks Only exists on Mac, other platforms do not have this method. + + @remarks Only exists on Mac, other platforms do not have this method. @onlyfor{wxosx} */ static void MacSetCommonMenuBar(wxMenuBar* menubar); - - /** + + /** Enables you to get the global menubar on Mac, that is, the menubar displayed when the app is running without any frames open. - + @return The global menubar. - - @remarks Only exists on Mac, other platforms do not have this method. + + @remarks Only exists on Mac, other platforms do not have this method. @onlyfor{wxosx} */ @@ -511,7 +511,7 @@ public: Constructs a wxMenu object. */ wxMenu(); - + /** Constructs a wxMenu object. @@ -1050,7 +1050,7 @@ public: */ void UpdateUI(wxEvtHandler* source = NULL); - + void SetInvokingWindow(wxWindow *win); wxWindow *GetInvokingWindow() const; wxWindow *GetWindow() const; diff --git a/interface/wx/menuitem.h b/interface/wx/menuitem.h index 3597079e9d..b03ff5ae65 100644 --- a/interface/wx/menuitem.h +++ b/interface/wx/menuitem.h @@ -144,37 +144,37 @@ public: @see GetItemLabelText(), GetItemLabel() */ static wxString GetLabelText(const wxString& text); - - + + /** @name Getters */ //@{ - + /** Returns the background colour associated with the menu item. - + @onlyfor{wxmsw} */ wxColour& GetBackgroundColour() const; /** Returns the checked or unchecked bitmap. - + @onlyfor{wxmsw} */ virtual const wxBitmap& GetBitmap(bool checked = true) const; /** Returns the bitmap to be used for disabled items. - + @onlyfor{wxmsw} */ virtual const wxBitmap& GetDisabledBitmap() const; - + /** Returns the font associated with the menu item. - + @onlyfor{wxmsw} */ wxFont& GetFont() const; @@ -223,7 +223,7 @@ public: /** Gets the width of the menu item checkmark bitmap. - + @onlyfor{wxmsw} */ int GetMarginWidth() const; @@ -238,7 +238,7 @@ public: Returns the text associated with the menu item. @deprecated This function is deprecated. Please use GetItemLabel() or GetItemLabelText() instead. - + @see GetItemLabel(), GetItemLabelText() */ wxString GetName() const; @@ -260,11 +260,11 @@ public: /** Returns the text colour associated with the menu item. - + @onlyfor{wxmsw} */ wxColour& GetTextColour() const; - + /** Extract the accelerator from the given menu string, return NULL if none found. @@ -277,9 +277,9 @@ public: virtual wxAcceleratorEntry *GetAccel() const; //@} - - - + + + /** @name Checkers */ @@ -329,11 +329,11 @@ public: Returns @true if the item is a submenu. */ bool IsSubMenu() const; - + //@} - - - + + + /** @name Setters */ @@ -341,7 +341,7 @@ public: /** Sets the background colour associated with the menu item. - + @onlyfor{wxmsw} */ void SetBackgroundColour(const wxColour& colour); @@ -349,7 +349,7 @@ public: /** Sets the bitmap for the menu item. - It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap) if + It is equivalent to wxMenuItem::SetBitmaps(bmp, wxNullBitmap) if @a checked is @true (default value) or SetBitmaps(wxNullBitmap, bmp) otherwise. @@ -386,7 +386,7 @@ public: /** Sets the font associated with the menu item. - + @onlyfor{wxmsw} */ void SetFont(const wxFont& font); @@ -398,19 +398,19 @@ public: /** Sets the label associated with the menu item. - - Note that if the ID of this menu item corresponds to a stock ID, then it is + + Note that if the ID of this menu item corresponds to a stock ID, then it is not necessary to specify a label: wxWidgets will automatically use the stock item label associated with that ID. See the @ref wxMenuItem::wxMenuItem "constructor" for more info. - - The label string for the normal menu items (not separators) may include the + + The label string for the normal menu items (not separators) may include the accelerator which can be used to activate the menu item from keyboard. - An accelerator key can be specified using the ampersand & character. - In order to embed an ampersand character in the menu item text, the ampersand + An accelerator key can be specified using the ampersand & character. + In order to embed an ampersand character in the menu item text, the ampersand must be doubled. - - Optionally you can specify also an accelerator string appending a tab character + + Optionally you can specify also an accelerator string appending a tab character \\t followed by a valid key combination (e.g. CTRL+V). Its general syntax is any combination of @c "CTRL", @c "RAWCTRL", @c "ALT" and @c "SHIFT" strings (case doesn't matter) separated by either @@ -507,7 +507,7 @@ public: /** Sets the width of the menu item checkmark bitmap. - + @onlyfor{wxmsw} */ void SetMarginWidth(int width); @@ -526,18 +526,18 @@ public: Sets the text associated with the menu item. @deprecated This function is deprecated in favour of SetItemLabel(). - + @see SetItemLabel(). */ virtual void SetText(const wxString& text); /** Sets the text colour associated with the menu item. - + @onlyfor{wxmsw} */ void SetTextColour(const wxColour& colour); - + /** Set the accel for this item - this may also be done indirectly with SetText() diff --git a/interface/wx/mimetype.h b/interface/wx/mimetype.h index 54d0e10666..7cb00011ce 100644 --- a/interface/wx/mimetype.h +++ b/interface/wx/mimetype.h @@ -10,11 +10,11 @@ This class allows the application to retrieve information about all known MIME types from a system-specific location and the filename extensions to the - MIME types and vice versa. - + MIME types and vice versa. + MIME stands for "Multipurpose Internet Mail Extensions" and was originally used in mail protocols. It's standardized by several RFCs. - + Under Windows, the MIME type information is queried from registry. Under Linux and Unix, it is queried from the XDG data directories. @@ -23,7 +23,7 @@ The application should not construct its own manager: it should use the object pointer ::wxTheMimeTypesManager. The functions GetFileTypeFromMimeType() and GetFileTypeFromExtension() - return a wxFileType object which may be further queried for file description, + return a wxFileType object which may be further queried for file description, icon and other attributes. @section mimetypemanager_helpers Helper functions @@ -445,7 +445,7 @@ public: const wxString& description, const wxString& extension, ...); - + /** Constructor using an array of string elements corresponding to the parameters of the ctor above in the same order. @@ -497,7 +497,7 @@ public: Get the MIME type */ const wxString& GetMimeType() const; - + /** Get the open command */ @@ -507,17 +507,17 @@ public: Get the print command */ const wxString& GetPrintCommand() const; - + /** Get the short description (only used under Win32 so far) */ const wxString& GetShortDesc() const; - + /** Get the long, user visible description */ const wxString& GetDescription() const; - + /** Get the array of all extensions */ @@ -527,7 +527,7 @@ public: Get the number of extensions. */ size_t GetExtensionsCount() const; - + /** Get the icon filename */ diff --git a/interface/wx/mousestate.h b/interface/wx/mousestate.h index 2c5b4f9313..5bb1827b2f 100644 --- a/interface/wx/mousestate.h +++ b/interface/wx/mousestate.h @@ -108,7 +108,7 @@ public: void SetX(wxCoord x); void SetY(wxCoord y); void SetPosition(const wxPoint& pos); - + void SetLeftDown(bool down); void SetMiddleDown(bool down); void SetRightDown(bool down); @@ -116,7 +116,7 @@ public: void SetAux2Down(bool down); void SetState(const wxMouseState& state); - + }; diff --git a/interface/wx/msw/ole/automtn.h b/interface/wx/msw/ole/automtn.h index 1df6240a0b..352b022a60 100644 --- a/interface/wx/msw/ole/automtn.h +++ b/interface/wx/msw/ole/automtn.h @@ -388,7 +388,7 @@ public: @code wxAutomationObject excelObject; - + if ( excelObject.GetInstance("Excel.Application") ) excelObject.PutProperty("ActiveCell.Font.Bold", true); @endcode @@ -450,7 +450,7 @@ public: Creates a new object based on the @a progID, returning @true if the object was successfully created, or @false if not. - + @see GetInstance() */ bool CreateInstance(const wxString& progId) const; @@ -495,7 +495,7 @@ public: @param progId COM ProgID, e.g. "Excel.Application" @param flags The creation flags (this parameters was added in wxWidgets 2.9.2) - + @see CreateInstance() */ bool GetInstance(const wxString& progId, @@ -532,11 +532,11 @@ public: wxVariant res = obj.GetProperty("Range", wxVariant("A1")); wxVariant res = obj.GetProperty("Range", "A1"); @endcode - + Note that @a property can contain dot-separated property names, to save the application needing to call GetProperty several times using several temporary objects. - + @see GetObject(), PutProperty() */ wxVariant GetProperty(const wxString& property, int noArgs, diff --git a/interface/wx/msw/regconf.h b/interface/wx/msw/regconf.h index 85a37f603b..4e9e40cecf 100644 --- a/interface/wx/msw/regconf.h +++ b/interface/wx/msw/regconf.h @@ -25,7 +25,7 @@ public: /** The wxRegConfig constructor. For more info see the docs for the wxConfigBase::wxConfigBase() constructor. - + Note that wxRegConfig's @a style argument defaults to @c wxCONFIG_USE_GLOBAL_FILE, i.e. to the use of the @c HKLM key (also known as "HKEY_LOCAL_MACHINE"). */ diff --git a/interface/wx/notifmsg.h b/interface/wx/notifmsg.h index 4a35382ae5..4e86a59ca9 100644 --- a/interface/wx/notifmsg.h +++ b/interface/wx/notifmsg.h @@ -29,15 +29,15 @@ Windows 10 and for toast notification support on Windows 8 it is recommended to call MSWUseToasts() before showing the first notification message. - + @par OS X The OS X implementation uses Notification Center to display native notifications. In order to use actions your notifications must use the alert style. This can be enabled by the user in system settings or by setting the @c NSUserNotificationAlertStyle value in Info.plist to @c alert. Please note that the user always has the option to change the notification style. - - + + @beginEventEmissionTable{wxCommandEvent} @event{wxEVT_NOTIFICATION_MESSAGE_CLICK(id, func)} Process a @c wxEVT_NOTIFICATION_MESSAGE_CLICK event, when a notification @@ -49,7 +49,7 @@ Process a @c wxEVT_NOTIFICATION_MESSAGE_ACTION event, when the user selects on of the actions added by AddAction() @endEventTable - + @since 2.9.0 @library{wxcore} @category{misc} @@ -93,11 +93,11 @@ public: @return @false if the current implementation or OS version does not support actions in notifications. - + @since 3.1.0 */ bool AddAction(wxWindowID actionid, const wxString &label = wxString()); - + /** Hides the notification. @@ -114,22 +114,22 @@ public: Valid values are @c wxICON_INFORMATION, @c wxICON_WARNING and @c wxICON_ERROR (notice that @c wxICON_QUESTION is not allowed here). Some implementations of this class may not support the icons. - + @see SetIcon() */ void SetFlags(int flags); /** Specify a custom icon to be displayed in the notification. - + Some implementations of this class may not support custom icons. - + @see SetFlags() - + @since 3.1.0 */ void SetIcon(const wxIcon& icon); - + /** Set the main text of the notification. @@ -173,42 +173,42 @@ public: If the application already uses a wxTaskBarIcon, it should be connected to notifications by using this method. This has no effect if toast notifications are used. - + @return the task bar icon which was used previously (may be @c NULL) - + @onlyfor{wxmsw} */ static wxTaskBarIcon *UseTaskBarIcon(wxTaskBarIcon *icon); - + /** Enables toast notifications available since Windows 8 and suppresses the additional icon in the notification area on Windows 10. - + Toast notifications @b require a shortcut to the application in the - start menu. The start menu shortcut needs to contain an Application + start menu. The start menu shortcut needs to contain an Application User Model ID. It is recommended that the applications setup creates the shortcut and the application specifies the setup created shortcut in @c shortcutPath. A call to this method will verify (and if necessary modify) the shortcut before enabling toast notifications. - + @param shortcutPath - Path to a shortcut file referencing the applications executable. If - the string is empty the applications display name will be used. If - not fully qualified, it will be used as a path relative to the + Path to a shortcut file referencing the applications executable. If + the string is empty the applications display name will be used. If + not fully qualified, it will be used as a path relative to the users start menu directory. The file extension .lnk is optional. @param appId The applications Application User Model ID. If empty it will be extracted from the shortcut. If the shortcut does not contain an id an id will be automatically created from the applications vendor and app name. - + @return @false if toast notifications could not be enabled. - + @onlyfor{wxmsw} - + @see wxAppConsole::SetAppName(), wxAppConsole::SetVendorName() - + @since 3.1.0 */ static bool MSWUseToasts( diff --git a/interface/wx/object.h b/interface/wx/object.h index 3f17dcf264..e28facff9d 100644 --- a/interface/wx/object.h +++ b/interface/wx/object.h @@ -718,7 +718,7 @@ public: /** Used in a C++ implementation file to complete the declaration of a class that has run-time type information. - + @header{wx/object.h} Example: @@ -736,7 +736,7 @@ public: /** Used in a C++ implementation file to complete the declaration of a class - that has run-time type information and two base classes. + that has run-time type information and two base classes. @header{wx/object.h} */ diff --git a/interface/wx/overlay.h b/interface/wx/overlay.h index ecbefde926..c03732ce08 100644 --- a/interface/wx/overlay.h +++ b/interface/wx/overlay.h @@ -11,7 +11,7 @@ Creates an overlay over an existing window, allowing for manipulations like rubberbanding, etc. On wxOSX the overlay is implemented with native platform APIs, on the other platforms it is simulated using wxMemoryDC. - + @library{wxcore} @see wxDCOverlay, wxDC @@ -35,11 +35,11 @@ public: @class wxDCOverlay Connects an overlay with a drawing DC. - + @library{wxcore} @see wxOverlay, wxDC - + */ class wxDCOverlay { diff --git a/interface/wx/pickerbase.h b/interface/wx/pickerbase.h index b50a964225..22d08185af 100644 --- a/interface/wx/pickerbase.h +++ b/interface/wx/pickerbase.h @@ -163,7 +163,7 @@ public: virtual void UpdatePickerFromTextCtrl() = 0; virtual void UpdateTextCtrlFromPicker() = 0; - + protected: virtual long GetTextCtrlStyle(long style) const; virtual long GetPickerStyle(long style) const; diff --git a/interface/wx/platinfo.h b/interface/wx/platinfo.h index f279c15592..d10563c38a 100644 --- a/interface/wx/platinfo.h +++ b/interface/wx/platinfo.h @@ -24,12 +24,12 @@ enum wxOperatingSystemId wxOS_MAC_OS = 1 << 0, //!< Apple Mac OS 8/9/X with Mac paths wxOS_MAC_OSX_DARWIN = 1 << 1, //!< Apple OS X with Unix paths - + //! A combination of all @c wxOS_MAC_* values previously listed. wxOS_MAC = wxOS_MAC_OS|wxOS_MAC_OSX_DARWIN, wxOS_WINDOWS_NT = 1 << 3, //!< Windows NT family (XP/Vista/7/8/10) - + //! Any Windows system, currently can be only wxOS_WINDOWS_NT. wxOS_WINDOWS = wxOS_WINDOWS_NT, @@ -40,7 +40,7 @@ enum wxOperatingSystemId wxOS_UNIX_SOLARIS = 1 << 10, //!< SunOS wxOS_UNIX_AIX = 1 << 11, //!< AIX wxOS_UNIX_HPUX = 1 << 12, //!< HP/UX - + //! A combination of all @c wxOS_UNIX_* values previously listed. wxOS_UNIX = wxOS_UNIX_LINUX | wxOS_UNIX_FREEBSD | @@ -104,9 +104,9 @@ enum wxEndianness }; /** - A structure containing information about a Linux distribution as returned + A structure containing information about a Linux distribution as returned by the @c lsb_release utility. - + See wxGetLinuxDistributionInfo() or wxPlatformInfo::GetLinuxDistributionInfo() for more info. */ @@ -116,7 +116,7 @@ struct wxLinuxDistributionInfo wxString Release; //!< The version of the distribution; e.g. "9.04" wxString CodeName; //!< The code name of the distribution; e.g. "jaunty" wxString Description; //!< The description of the distribution; e.g. "Ubuntu 9.04" - + bool operator==(const wxLinuxDistributionInfo& ldi) const; bool operator!=(const wxLinuxDistributionInfo& ldi) const; }; @@ -125,16 +125,16 @@ struct wxLinuxDistributionInfo /** @class wxPlatformInfo - This class holds information about the operating system, the toolkit and the + This class holds information about the operating system, the toolkit and the basic architecture of the machine where the application is currently running. - + This class does not only have @e getters for the information above, it also has - @e setters. This allows you to e.g. save the current platform information in a + @e setters. This allows you to e.g. save the current platform information in a data file (maybe in string form) so that when you later load it, you can easily retrieve (see the static getters for string->enum conversion functions) and store - inside a wxPlatformInfo instance (using its setters) the signature of the system + inside a wxPlatformInfo instance (using its setters) the signature of the system which generated it. - + In general however you only need to use the static Get() function and then access the various information for the current platform: @code @@ -148,7 +148,7 @@ struct wxLinuxDistributionInfo @see ::wxGetOsVersion(), wxIsPlatformLittleEndian(), wxIsPlatform64Bit(), wxAppTraits, @ref group_funcmacro_networkuseros */ -class wxPlatformInfo +class wxPlatformInfo { public: @@ -211,16 +211,16 @@ public: Equality operator. Tests all class' internal variables. */ bool operator==(const wxPlatformInfo& t) const; - + /** Returns the global wxPlatformInfo object, initialized with the values for the currently running platform. */ static const wxPlatformInfo& Get(); - + /** @name Static enum getters - + These getters allow for easy string-to-enumeration-value conversion. */ //@{ @@ -251,13 +251,13 @@ public: ("wxGTK", "wxMSW", etc) nor any of the short wxWidgets name ports ("gtk", "msw", etc). */ static wxPortId GetPortId(const wxString& portname); - + //@} - - + + /** @name Static string-form getters - + These getters allow for easy enumeration-value-to-string conversion. */ //@{ @@ -271,7 +271,7 @@ public: Returns name for the given wxEndianness enumeration value. */ static wxString GetEndiannessName(wxEndianness end); - + /** Returns the operating system family name for the given wxOperatingSystemId enumeration value: @c Unix for @c wxOS_UNIX, @c OSX for @c wxOS_MAC_OS, @@ -308,14 +308,14 @@ public: /** Returns the operating system directory. - + See wxGetOSDirectory() for more info. */ static wxString GetOperatingSystemDirectory(); //@} - - + + /** @name Getters */ @@ -359,14 +359,14 @@ public: /** Returns the operating system ID of this wxPlatformInfo instance. - + See wxGetOsVersion() for more info. */ wxOperatingSystemId GetOperatingSystemId() const; - + /** Returns the description of the operating system of this wxPlatformInfo instance. - + See wxGetOsDescription() for more info. */ wxString GetOperatingSystemDescription() const; @@ -375,17 +375,17 @@ public: Returns the wxWidgets port ID associated with this wxPlatformInfo instance. */ wxPortId GetPortId() const; - + /** Returns the Linux distribution info associated with this wxPlatformInfo instance. - + See wxGetLinuxDistributionInfo() for more info. */ wxLinuxDistributionInfo GetLinuxDistributionInfo() const; - + /** Returns the desktop environment associated with this wxPlatformInfo instance. - + See wxAppTraits::GetDesktopEnvironment() for more info. */ wxString GetDesktopEnvironment() const; @@ -454,7 +454,7 @@ public: wxPlatformInfo instance. */ wxString GetOperatingSystemFamilyName() const; - + /** Returns the operating system name of the OS associated with this wxPlatformInfo instance. @@ -472,16 +472,16 @@ public: wxPlatformInfo instance. */ wxString GetPortIdShortName() const; - - //@} - - + //@} + + + /** @name Setters */ //@{ - + /** Sets the architecture enum value associated with this wxPlatformInfo instance. */ @@ -517,17 +517,17 @@ public: Sets the operating system description associated with this wxPlatformInfo instance. */ void SetOperatingSystemDescription(const wxString& desc); - + /** Sets the desktop environment associated with this wxPlatformInfo instance. */ void SetDesktopEnvironment(const wxString& de); - + /** Sets the linux distribution info associated with this wxPlatformInfo instance. */ void SetLinuxDistributionInfo(const wxLinuxDistributionInfo& di); - + //@} }; diff --git a/interface/wx/popupwin.h b/interface/wx/popupwin.h index b1a00a71f6..fe7c92b313 100644 --- a/interface/wx/popupwin.h +++ b/interface/wx/popupwin.h @@ -38,7 +38,7 @@ public: Default constructor */ wxPopupWindow(); - + /** Constructor */ @@ -125,5 +125,5 @@ protected: else but direct call to Dismiss(). */ virtual void OnDismiss(); - + }; diff --git a/interface/wx/power.h b/interface/wx/power.h index 375234568e..62fa9525e2 100644 --- a/interface/wx/power.h +++ b/interface/wx/power.h @@ -80,7 +80,7 @@ class wxPowerEvent : public wxEvent public: wxPowerEvent(); wxPowerEvent(wxEventType evtType); - + /** Call this to prevent suspend from taking place in @c wxEVT_POWER_SUSPENDING handler (it is ignored for all the others). diff --git a/interface/wx/process.h b/interface/wx/process.h index f5dc6d018f..50d49398b4 100644 --- a/interface/wx/process.h +++ b/interface/wx/process.h @@ -15,7 +15,7 @@ notified about the process termination and also retrieve its exit status which is unavailable from ::wxExecute() in the case of asynchronous execution. - @note + @note If the @c wxEVT_END_PROCESS event sent after termination is processed by the parent, then it is responsible for deleting the wxProcess object which sent it. However, if it is not processed, the object will delete itself and so the @@ -110,17 +110,17 @@ public: /** Detaches this event handler from the parent specified in the constructor (see wxEvtHandler::Unlink() for a similar but not identical function). - + Normally, a wxProcess object is deleted by its parent when it receives the - notification about the process termination. - - However, it might happen that the parent object is destroyed before the external - process is terminated (e.g. a window from which this external process was launched - is closed by the user) and in this case it @b should not delete the wxProcess - object, but @b should call Detach() instead. - - After the wxProcess object is detached from its parent, no notification events - will be sent to the parent and the object will delete itself upon reception of + notification about the process termination. + + However, it might happen that the parent object is destroyed before the external + process is terminated (e.g. a window from which this external process was launched + is closed by the user) and in this case it @b should not delete the wxProcess + object, but @b should call Detach() instead. + + After the wxProcess object is detached from its parent, no notification events + will be sent to the parent and the object will delete itself upon reception of the process termination notification. */ void Detach(); @@ -211,7 +211,7 @@ public: /** It is called when the process with the pid @a pid finishes. It raises a wxWidgets event when it isn't overridden. - + Note that this function won't be called if you Kill() the process. @param pid diff --git a/interface/wx/progdlg.h b/interface/wx/progdlg.h index 616b8530e1..e1ab36431b 100644 --- a/interface/wx/progdlg.h +++ b/interface/wx/progdlg.h @@ -167,7 +167,7 @@ public: /** Changes the maximum value of the progress meter given in the constructor. - This function can only be called (with a positive value) if the value passed + This function can only be called (with a positive value) if the value passed in the constructor was positive. @since 2.9.1 diff --git a/interface/wx/propdlg.h b/interface/wx/propdlg.h index 8ccdc1ca8b..e6932471e1 100644 --- a/interface/wx/propdlg.h +++ b/interface/wx/propdlg.h @@ -197,7 +197,7 @@ public: */ void SetSheetStyle(long style); - + /** Set the border around the whole dialog */ @@ -208,18 +208,18 @@ public: */ int GetSheetOuterBorder() const; - + /** Set the border around the book control only. */ void SetSheetInnerBorder(int border); - + /** Returns the border around the book control only. */ int GetSheetInnerBorder() const; - + virtual wxWindow* GetContentWindow() const; }; diff --git a/interface/wx/propgrid/editors.h b/interface/wx/propgrid/editors.h index 6fe9c15544..4af9d0c3e3 100644 --- a/interface/wx/propgrid/editors.h +++ b/interface/wx/propgrid/editors.h @@ -427,7 +427,7 @@ public: class wxSampleMultiButtonEditor : public wxPGTextCtrlEditor { wxDECLARE_DYNAMIC_CLASS(wxSampleMultiButtonEditor); - + public: wxSampleMultiButtonEditor() {} virtual ~wxSampleMultiButtonEditor() {} diff --git a/interface/wx/propgrid/property.h b/interface/wx/propgrid/property.h index 48e0e21dbe..896d4c73ed 100644 --- a/interface/wx/propgrid/property.h +++ b/interface/wx/propgrid/property.h @@ -516,7 +516,7 @@ wxPG_PROP_CLASS_SPECIFIC_3 = 0x00400000 Note that when displaying the value, sign is omitted if the resulting textual representation is effectively zero (for example, -0.0001 with - precision of 3 will become 0.0 instead of -0.0). This behaviour is unlike + precision of 3 will become 0.0 instead of -0.0). This behaviour is unlike what C standard library does, but should result in better end-user experience in almost all cases. diff --git a/interface/wx/propgrid/propgridpagestate.h b/interface/wx/propgrid/propgridpagestate.h index 1a392b7659..8289b59108 100644 --- a/interface/wx/propgrid/propgridpagestate.h +++ b/interface/wx/propgrid/propgridpagestate.h @@ -227,7 +227,7 @@ class wxPropertyGridIterator : public wxPropertyGridIteratorBase public: wxPropertyGridIterator(); wxPropertyGridIterator( wxPropertyGridPageState* state, - int flags = wxPG_ITERATE_DEFAULT, + int flags = wxPG_ITERATE_DEFAULT, wxPGProperty* property = NULL, int dir = 1 ); wxPropertyGridIterator( wxPropertyGridPageState* state, int flags, int startPos, int dir = 0 ); @@ -252,7 +252,7 @@ public: wxPropertyGridConstIterator(); wxPropertyGridConstIterator( const wxPropertyGridPageState* state, - int flags = wxPG_ITERATE_DEFAULT, + int flags = wxPG_ITERATE_DEFAULT, const wxPGProperty* property = NULL, int dir = 1 ); wxPropertyGridConstIterator( wxPropertyGridPageState* state, int flags, int startPos, int dir = 0 ); diff --git a/interface/wx/propgrid/props.h b/interface/wx/propgrid/props.h index ad4c7bc009..e7ef66a847 100644 --- a/interface/wx/propgrid/props.h +++ b/interface/wx/propgrid/props.h @@ -312,7 +312,7 @@ public: const wxChar* const* labels = NULL, const long* values = NULL, int value = 0 ); - + wxEnumProperty( const wxString& label, const wxString& name, wxPGChoices& choices, diff --git a/interface/wx/protocol/protocol.h b/interface/wx/protocol/protocol.h index 94330044c9..7ab332db9a 100644 --- a/interface/wx/protocol/protocol.h +++ b/interface/wx/protocol/protocol.h @@ -132,7 +132,7 @@ public: /** Detach the existing logger without deleting it. - + The caller is responsible for deleting the returned pointer if it's non-@c NULL. */ diff --git a/interface/wx/rearrangectrl.h b/interface/wx/rearrangectrl.h index d26113f095..2b200372bd 100644 --- a/interface/wx/rearrangectrl.h +++ b/interface/wx/rearrangectrl.h @@ -301,7 +301,7 @@ public: /** Effectively creates the dialog for an object created using the default - constructor. + constructor. @param parent The dialog parent, possibly @NULL. diff --git a/interface/wx/renderer.h b/interface/wx/renderer.h index ddd4d3a1f8..a94b5c9f9c 100644 --- a/interface/wx/renderer.h +++ b/interface/wx/renderer.h @@ -635,7 +635,7 @@ public: struct wxRendererVersion { wxRendererVersion(int version_, int age_); - + /** Checks if the main program is compatible with the renderer having the version @e ver, returns @true if it is and @false otherwise. diff --git a/interface/wx/ribbon/art.h b/interface/wx/ribbon/art.h index 055949e76a..7cdb0b9156 100644 --- a/interface/wx/ribbon/art.h +++ b/interface/wx/ribbon/art.h @@ -8,7 +8,7 @@ /** Identifiers for common settings on ribbon art providers which can be used to tweak the appearance of the art provider. - + @see wxRibbonArtProvider::GetColour() @see wxRibbonArtProvider::GetFont() @see wxRibbonArtProvider::GetMetric() @@ -127,7 +127,7 @@ enum wxRibbonArtSetting /** Flags used to describe the direction, state, and/or purpose of a ribbon-style scroll button. - + @see wxRibbonArtProvider::DrawScrollButton() @see wxRibbonArtProvider::GetScrollButtonMinimumSize() */ @@ -167,19 +167,19 @@ enum wxRibbonButtonKind action. */ wxRIBBON_BUTTON_NORMAL = 1 << 0, - + /** Dropdown button or tool with a clickable area which typically causes a dropdown menu. */ wxRIBBON_BUTTON_DROPDOWN = 1 << 1, - + /** Button or tool with two clickable areas - one which causes a dropdown menu, and one which causes a generic action. */ wxRIBBON_BUTTON_HYBRID = wxRIBBON_BUTTON_NORMAL | wxRIBBON_BUTTON_DROPDOWN, - + /** Normal button or tool with a clickable area which toggles the button between a pressed and unpressed state. @@ -216,7 +216,7 @@ public: Constructor. */ wxRibbonArtProvider(); - + /** Destructor. */ @@ -226,16 +226,16 @@ public: Create a new art provider which is a clone of this one. */ virtual wxRibbonArtProvider* Clone() const = 0; - + /** Set the style flags. - + Normally called automatically by wxRibbonBar::SetArtProvider with the ribbon bar's style flags, so that the art provider has the same flags as the bar which it is serving. */ virtual void SetFlags(long flags) = 0; - + /** Get the previously set style flags. */ @@ -246,53 +246,53 @@ public: @a id can be one of the size values of @ref wxRibbonArtSetting. */ virtual int GetMetric(int id) const = 0; - + /** Set the value of a certain integer setting to the value @e new_val. @a id can be one of the size values of @ref wxRibbonArtSetting. */ virtual void SetMetric(int id, int new_val) = 0; - + /** Set the value of a certain font setting to the value @e font. @a id can be one of the font values of @ref wxRibbonArtSetting. */ virtual void SetFont(int id, const wxFont& font) = 0; - + /** Get the value of a certain font setting. @a id can be one of the font values of @ref wxRibbonArtSetting. */ virtual wxFont GetFont(int id) const = 0; - + /** Get the value of a certain colour setting. @a id can be one of the colour values of @ref wxRibbonArtSetting. */ virtual wxColour GetColour(int id) const = 0; - + /** Set the value of a certain colour setting to the value @e colour. @a id can be one of the colour values of @ref wxRibbonArtSetting, though not all colour settings will have an effect on every art provider. - + @see SetColourScheme() */ virtual void SetColour(int id, const wxColour& colour) = 0; - + /** @see wxRibbonArtProvider::GetColour() */ wxColour GetColor(int id) const; - + /** @see wxRibbonArtProvider::SetColour() */ void SetColor(int id, const wxColour& color); - + /** Get the current colour scheme. - + Returns three colours such that if SetColourScheme() were called with them, the colour scheme would be restored to what it was when SetColourScheme() was last called. In practice, this usually means that @@ -308,7 +308,7 @@ public: and return a colour scheme similar to colours being used - it's return values are dependent upon the last values given to SetColourScheme(), as described above. - + @param[out] primary Pointer to a location to store the primary colour, or NULL. @param[out] secondary @@ -319,26 +319,26 @@ public: virtual void GetColourScheme(wxColour* primary, wxColour* secondary, wxColour* tertiary) const = 0; - + /** Set all applicable colour settings from a few base colours. - + Uses any or all of the three given colours to create a colour scheme, and then sets all colour settings which are relevant to the art provider using that scheme. Note that some art providers may not use the tertiary colour for anything, and some may not use the secondary colour either. - + @see SetColour() @see GetColourScheme() - */ + */ virtual void SetColourScheme(const wxColour& primary, const wxColour& secondary, const wxColour& tertiary) = 0; /** Draw the background of the tab region of a ribbon bar. - + @param dc The device context to draw onto. @param wnd @@ -353,7 +353,7 @@ public: /** Draw a single tab in the tab region of a ribbon bar. - + @param dc The device context to draw onto. @param wnd @@ -373,7 +373,7 @@ public: /** Draw a separator between two tabs in a ribbon bar. - + @param dc The device context to draw onto. @param wnd @@ -393,7 +393,7 @@ public: /** Draw the background of a ribbon page. - + @param dc The device context to draw onto. @param wnd @@ -401,7 +401,7 @@ public: whose background is being drawn, but doesn't have to be). @param rect The rectangle within which to draw. - + @sa GetPageBackgroundRedrawArea */ virtual void DrawPageBackground( @@ -411,7 +411,7 @@ public: /** Draw a ribbon-style scroll button. - + @param dc The device context to draw onto. @param wnd @@ -439,11 +439,11 @@ public: Draw the background and chrome for a ribbon panel. This should draw the border, background, label, and any other items of a panel which are outside the client area of a panel. - + Note that when a panel is minimised, this function is not called - only DrawMinimisedPanel() is called, so a background should be explicitly painted by that if required. - + @param dc The device context to draw onto. @param wnd @@ -457,13 +457,13 @@ public: wxDC& dc, wxRibbonPanel* wnd, const wxRect& rect) = 0; - + /** Draw the background and chrome for a wxRibbonGallery control. This should draw the border, background, scroll buttons, extension button, and any other UI elements which are not attached to a specific gallery item. - + @param dc The device context to draw onto. @param wnd @@ -488,7 +488,7 @@ public: is painted on top of a gallery background, and behind the items bitmap. Unlike DrawButtonBarButton() and DrawTool(), it is not expected to draw the item bitmap - that is done by the gallery control itself. - + @param dc The device context to draw onto. @param wnd @@ -515,10 +515,10 @@ public: wxRibbonGallery* wnd, const wxRect& rect, wxRibbonGalleryItem* item) = 0; - + /** Draw a minimised ribbon panel. - + @param dc The device context to draw onto. @param wnd @@ -539,10 +539,10 @@ public: wxRibbonPanel* wnd, const wxRect& rect, wxBitmap& bitmap) = 0; - + /** Draw the background for a wxRibbonButtonBar control. - + @param dc The device context to draw onto. @param wnd @@ -558,7 +558,7 @@ public: /** Draw a single button for a wxRibbonButtonBar control. - + @param dc The device context to draw onto. @param wnd @@ -591,10 +591,10 @@ public: const wxString& label, const wxBitmap& bitmap_large, const wxBitmap& bitmap_small) = 0; - + /** Draw the background for a wxRibbonToolBar control. - + @param dc The device context to draw onto. @param wnd @@ -613,7 +613,7 @@ public: /** Draw the background for a group of tools on a wxRibbonToolBar control. - + @param dc The device context to draw onto. @param wnd @@ -636,7 +636,7 @@ public: /** Draw a single tool (for a wxRibbonToolBar control). - + @param dc The device context to draw onto. @param wnd @@ -710,7 +710,7 @@ public: /** Calculate the ideal and minimum width (in pixels) of a tab in a ribbon bar. - + @param dc A device context to use when one is required for size calculations. @param wnd @@ -746,7 +746,7 @@ public: Note that as the tab region can contain scroll buttons, the height should be greater than or equal to the minimum height for a tab scroll button. - + @param dc A device context to use when one is required for size calculations. @param wnd @@ -761,7 +761,7 @@ public: /** Calculate the minimum size (in pixels) of a scroll button. - + @param dc A device context to use when one is required for size calculations. @param wnd @@ -781,7 +781,7 @@ public: Calculate the size of a panel for a given client size. This should increment the given size by enough to fit the panel label and other chrome. - + @param dc A device context to use if one is required for size calculations. @param wnd @@ -791,7 +791,7 @@ public: @param[out] client_offset The offset where the client rectangle begins within the panel (may be NULL). - + @sa GetPanelClientSize() */ virtual wxSize GetPanelSize( @@ -799,12 +799,12 @@ public: const wxRibbonPanel* wnd, wxSize client_size, wxPoint* client_offset) = 0; - + /** Calculate the client size of a panel for a given overall size. This should act as the inverse to GetPanelSize(), and decrement the given size by enough to fit the panel label and other chrome. - + @param dc A device context to use if one is required for size calculations. @param wnd @@ -814,7 +814,7 @@ public: @param[out] client_offset The offset where the returned client size begins within the given @a size (may be NULL). - + @sa GetPanelSize() */ virtual wxSize GetPanelClientSize( @@ -844,14 +844,14 @@ public: Calculate the size of a wxRibbonGallery control for a given client size. This should increment the given size by enough to fit the gallery border, buttons, and any other chrome. - + @param dc A device context to use if one is required for size calculations. @param wnd The gallery in question. @param client_size The client size. - + @sa GetGalleryClientSize() */ virtual wxSize GetGallerySize( @@ -864,7 +864,7 @@ public: size. This should act as the inverse to GetGallerySize(), and decrement the given size by enough to fit the gallery border, buttons, and other chrome. - + @param dc A device context to use if one is required for size calculations. @param wnd @@ -899,7 +899,7 @@ public: small an area as possible should be returned. Of course, if the way in which a background is drawn means that the entire background needs to be repainted on resize, then the entire new size should be returned. - + @param dc A device context to use when one is required for size calculations. @param wnd @@ -915,10 +915,10 @@ public: const wxRibbonPage* wnd, wxSize page_old_size, wxSize page_new_size) = 0; - + /** Calculate the size of a button within a wxRibbonButtonBar. - + @param dc A device context to use when one is required for size calculations. @param wnd @@ -947,7 +947,7 @@ public: The region of the button which constitutes the normal button. @param[out] dropdown_region The region of the button which constitutes the dropdown button. - + @return @true if a size exists for the button, @false otherwise. */ virtual bool GetButtonBarButtonSize( @@ -990,10 +990,10 @@ public: wxDC& dc, const wxString& label, wxRibbonButtonKind kind, wxRibbonButtonBarButtonState size) = 0; - + /** Calculate the size of a minimised ribbon panel. - + @param dc A device context to use when one is required for size calculations. @param wnd @@ -1011,10 +1011,10 @@ public: const wxRibbonPanel* wnd, wxSize* desired_bitmap_size, wxDirection* expanded_panel_direction) = 0; - + /** Calculate the size of a tool within a wxRibbonToolBar. - + @param dc A device context to use when one is required for size calculations. @param wnd diff --git a/interface/wx/ribbon/bar.h b/interface/wx/ribbon/bar.h index 3d98f0ca76..615d07e30b 100644 --- a/interface/wx/ribbon/bar.h +++ b/interface/wx/ribbon/bar.h @@ -77,7 +77,7 @@ public: Returns the page being changed to, or being clicked on. */ wxRibbonPage* GetPage(); - + /** Sets the page relating to this event. */ @@ -120,7 +120,7 @@ public: for wxRibbonPage - a ribbon user interface typically has a ribbon bar, which contains one or more wxRibbonPages, which in turn each contain one or more wxRibbonPanels, which in turn contain controls. - + While a wxRibbonBar has tabs similar to a wxNotebook, it does not follow the same API for adding pages. Containers like wxNotebook can contain any type of window as a page, hence the normal procedure is to create the @@ -128,13 +128,13 @@ public: have wxRibbonPage as children (and a wxRibbonPage can only have a wxRibbonBar as parent), when a page is created, it is automatically added to the bar - there is no AddPage equivalent to call. - + After all pages have been created, and all controls and panels placed on those pages, Realize() must be called. - + @sa wxRibbonPage @sa wxRibbonPanel - + @beginStyleTable @style{wxRIBBON_BAR_DEFAULT_STYLE} Defined as wxRIBBON_BAR_FLOW_HORIZONTAL | @@ -213,7 +213,7 @@ public: const wxPoint& pos = wxDefaultPosition, const wxSize& size = wxDefaultSize, long style = wxRIBBON_BAR_DEFAULT_STYLE); - + /** Create a ribbon bar in two-step ribbon bar construction. Should only be called when the default constructor is used, and @@ -235,7 +235,7 @@ public: tab bar region of the ribbon bar. These margins will be painted with the tab background, but tabs and scroll buttons will never be painted in the margins. - + The left margin could be used for rendering something equivalent to the "Office Button", though this is not currently implemented. The right margin could be used for rendering a help button, and/or MDI buttons, @@ -247,7 +247,7 @@ public: Set the art provider to be used be the ribbon bar. Also sets the art provider on all current wxRibbonPage children, and any wxRibbonPage children added in the future. - + Note that unlike most other ribbon controls, the ribbon bar creates a default art provider when initialised, so an explicit call to SetArtProvider() is not required if the default art provider is @@ -260,17 +260,17 @@ public: /** Set the active page by index, without triggering any events. - + @param page The zero-based index of the page to activate. @return @true if the specified page is now active, @false if it could not be activated (for example because the page index is invalid). */ bool SetActivePage(size_t page); - + /** Set the active page, without triggering any events. - + @param page The page to activate. @return @true if the specified page is now active, @false if it could @@ -278,21 +278,21 @@ public: of the ribbon bar). */ bool SetActivePage(wxRibbonPage* page); - + /** Get the index of the active page. - + In the rare case of no page being active, -1 is returned. */ int GetActivePage() const; - + /** Get a page by index. - + NULL will be returned if the given index is out of range. */ wxRibbonPage* GetPage(int n); - + /** Get the number of pages in this bar. @@ -302,7 +302,7 @@ public: /** Dismiss the expanded panel of the currently active page. - + Calls and returns the value from wxRibbonPage::DismissExpandedPanel() for the currently active page, or @false if there is no active page. */ @@ -433,7 +433,7 @@ public: @since 2.9.2 */ bool ArePanelsShown() const; - + /** Returns the current display mode of the panel area. @@ -449,7 +449,7 @@ public: children. This must be called after all of the bar's children have been created (and their children created, etc.) - if it is not, then windows may not be laid out or sized correctly. - + Also calls wxRibbonPage::Realize() on each child page. */ virtual bool Realize(); diff --git a/interface/wx/ribbon/buttonbar.h b/interface/wx/ribbon/buttonbar.h index 9b18fba7ce..b98b20f5a2 100644 --- a/interface/wx/ribbon/buttonbar.h +++ b/interface/wx/ribbon/buttonbar.h @@ -7,12 +7,12 @@ /** Flags for button bar button size and state. - + Buttons on a ribbon button bar can each come in three sizes: small, medium, and large. In some places this is called the size class, and the term size used for the pixel width and height associated with a particular size class. - + A button can also be in zero or more hovered or active states, or in the disabled state. */ @@ -23,19 +23,19 @@ enum wxRibbonButtonBarButtonState provider, but it will be smaller than medium). */ wxRIBBON_BUTTONBAR_BUTTON_SMALL = 0 << 0, - + /** Button is medium sized (the interpretation of medium is dependent upon the art provider, but it will be between small and large). */ wxRIBBON_BUTTONBAR_BUTTON_MEDIUM = 1 << 0, - + /** Button is large (the interpretation of large is dependent upon the art provider, but it will be larger than medium). */ wxRIBBON_BUTTONBAR_BUTTON_LARGE = 2 << 0, - + /** A mask to extract button size from a combination of flags. */ @@ -46,24 +46,24 @@ enum wxRibbonButtonBarButtonState the mouse cursor. Only applicable to normal and hybrid buttons. */ wxRIBBON_BUTTONBAR_BUTTON_NORMAL_HOVERED = 1 << 3, - + /** The dropdown region of the button is being hovered over by the mouse cursor. Only applicable to dropdown and hybrid buttons. */ wxRIBBON_BUTTONBAR_BUTTON_DROPDOWN_HOVERED = 1 << 4, - + /** A mask to extract button hover state from a combination of flags. */ wxRIBBON_BUTTONBAR_BUTTON_HOVER_MASK = wxRIBBON_BUTTONBAR_BUTTON_NORMAL_HOVERED | wxRIBBON_BUTTONBAR_BUTTON_DROPDOWN_HOVERED, - + /** The normal (non-dropdown) region of the button is being pressed. Only applicable to normal and hybrid buttons. */ wxRIBBON_BUTTONBAR_BUTTON_NORMAL_ACTIVE = 1 << 5, - + /** The dropdown region of the button is being pressed. Only applicable to dropdown and hybrid buttons. @@ -81,12 +81,12 @@ enum wxRibbonButtonBarButtonState disabled. */ wxRIBBON_BUTTONBAR_BUTTON_DISABLED = 1 << 7, - + /** The button is a toggle button which is currently in the toggled state. */ wxRIBBON_BUTTONBAR_BUTTON_TOGGLED = 1 << 8, - + /** A mask to extract button state from a combination of flags. */ @@ -95,7 +95,7 @@ enum wxRibbonButtonBarButtonState /** @class wxRibbonButtonBar - + A ribbon button bar is similar to a traditional toolbar. It contains one or more buttons (button bar buttons, not wxButtons), each of which has a label and an icon. It differs from a wxRibbonToolBar in several ways: @@ -106,7 +106,7 @@ enum wxRibbonButtonBarButtonState @li There is no grouping of buttons on a button bar @li A button bar typically has a border around each individual button, whereas a tool bar typically has a border around each group of buttons. - + @beginEventEmissionTable{wxRibbonButtonBarEvent} @event{EVT_RIBBONBUTTONBAR_CLICKED(id, func)} Triggered when the normal (non-dropdown) region of a button on the @@ -117,7 +117,7 @@ enum wxRibbonButtonBarButtonState event handler if it wants to display a popup menu (which is what most dropdown buttons should be doing). @endEventTable - + @library{wxribbon} @category{ribbon} */ @@ -133,7 +133,7 @@ public: /** Construct a ribbon button bar with the given parameters. - + @param parent Parent window for the button bar (typically a wxRibbonPanel). @param id @@ -179,7 +179,7 @@ public: /** Add a dropdown button to the button bar (simple version). - + @see AddButton() */ virtual wxRibbonButtonBarButtonBase* AddDropdownButton( @@ -190,7 +190,7 @@ public: /** Add a hybrid button to the button bar (simple version). - + @see AddButton() */ virtual wxRibbonButtonBarButtonBase* AddHybridButton( @@ -198,10 +198,10 @@ public: const wxString& label, const wxBitmap& bitmap, const wxString& help_string = wxEmptyString); - + /** Add a toggle button to the button bar (simple version). - + @see AddButton() */ virtual wxRibbonButtonBarButtonBase* AddToggleButton( @@ -209,10 +209,10 @@ public: const wxString& label, const wxBitmap& bitmap, const wxString& help_string = wxEmptyString); - + /** Add a button to the button bar. - + @param button_id ID of the new button (used for event callbacks). @param label @@ -235,10 +235,10 @@ public: The kind of button to add. @param help_string The UI help string to associate with the new button. - + @return An opaque pointer which can be used only with other button bar methods. - + @see AddDropdownButton() @see AddHybridButton() @see AddToggleButton() @@ -431,20 +431,20 @@ public: /** Calculate button layouts and positions. - + Must be called after buttons are added to the button bar, as otherwise the newly added buttons will not be displayed. In normal situations, it will be called automatically when wxRibbonBar::Realize() is called. */ virtual bool Realize(); - + /** Delete all buttons from the button bar. - + @see DeleteButton() */ virtual void ClearButtons(); - + /** Delete a single button from the button bar. @@ -454,20 +454,20 @@ public: @see ClearButtons() */ virtual bool DeleteButton(int button_id); - + /** Enable or disable a single button on the bar. - + @param button_id ID of the button to enable or disable. @param enable @true to enable the button, @false to disable it. */ virtual void EnableButton(int button_id, bool enable = true); - + /** Set a toggle button to the checked or unchecked state. - + @param button_id ID of the toggle button to manipulate. @param checked @@ -678,12 +678,12 @@ public: Returns the bar which contains the button which the event relates to. */ wxRibbonButtonBar* GetBar(); - + /** Sets the button bar relating to this event. */ void SetBar(wxRibbonButtonBar* bar); - + /** Returns the button which the event relates to. diff --git a/interface/wx/ribbon/gallery.h b/interface/wx/ribbon/gallery.h index 2b34f83a64..6fd8145746 100644 --- a/interface/wx/ribbon/gallery.h +++ b/interface/wx/ribbon/gallery.h @@ -238,7 +238,7 @@ public: direction, @false if it did not scroll. */ virtual bool ScrollLines(int lines); - + /** Scroll the gallery contents by some fine-grained amount. diff --git a/interface/wx/ribbon/page.h b/interface/wx/ribbon/page.h index c6e2845342..1e62dda8aa 100644 --- a/interface/wx/ribbon/page.h +++ b/interface/wx/ribbon/page.h @@ -9,7 +9,7 @@ @class wxRibbonPage Container for related ribbon panels, and a tab within a ribbon bar. - + @see wxRibbonBar @see wxRibbonPanel @@ -28,7 +28,7 @@ public: /** Constructs a ribbon page, which must be a child of a ribbon bar. - + @param parent Pointer to a parent wxRibbonBar (unlike most controls, a wxRibbonPage can only have wxRibbonBar as a parent). @@ -53,7 +53,7 @@ public: Destructor. */ virtual ~wxRibbonPage(); - + /** Create a ribbon page in two-step ribbon page construction. Should only be called when the default constructor is used, and @@ -69,7 +69,7 @@ public: Set the art provider to be used. Normally called automatically by wxRibbonBar when the page is created, or the art provider changed on the bar. - + The new art provider will be propagated to the children of the page. */ void SetArtProvider(wxRibbonArtProvider* art); @@ -79,10 +79,10 @@ public: displayed if the ribbon bar is actually showing icons). */ wxBitmap& GetIcon(); - + /** Set the size of the page and the external scroll buttons (if any). - + When a page is too small to display all of its children, scroll buttons will appear (and if the page is sized up enough, they will disappear again). Slightly counter-intuitively, these buttons are created as siblings of the @@ -91,78 +91,78 @@ public: buttons, this function behaves the same as SetSize(), however when there are scroll buttons, it positions them at the edges of the given area, and then calls SetSize() with the remaining area. - + This is provided as a separate function to SetSize() rather than within the implementation of SetSize(), as interacting algorithms may not expect SetSize() to also set the size of siblings. */ void SetSizeWithScrollButtonAdjustment(int x, int y, int width, int height); - + /** Expand a rectangle of the page to include external scroll buttons (if any). When no scroll buttons are shown, has no effect. - + @param[in,out] rect The rectangle to adjust. The width and height will not be reduced, and the x and y will not be increased. */ void AdjustRectToIncludeScrollButtons(wxRect* rect) const; - + /** Dismiss the current externally expanded panel, if there is one. - + When a ribbon panel automatically minimises, it can be externally expanded into a floating window. When the user clicks a button in such a panel, the panel should generally re-minimise. Event handlers for buttons on ribbon panels should call this method to achieve this behaviour. - + @return @true if a panel was minimised, @false otherwise. */ bool DismissExpandedPanel(); - + /** Perform a full re-layout of all panels on the page. - + Should be called after panels are added to the page, or the sizing behaviour of a panel on the page changes (i.e. due to children being added to it). Usually called automatically when wxRibbonBar::Realize() is called. - + Will invoke wxRibbonPanel::Realize() for all child panels. */ virtual bool Realize(); /** Scroll the page by some amount up / down / left / right. - + When the page's children are too big to fit in the onscreen area given to the page, scroll buttons will appear, and the page can be programmatically scrolled. Positive values of @a lines will scroll right or down, while negative values will scroll up or left (depending on the direction in which panels are stacked). A line is equivalent to a constant number of pixels. - + @return @true if the page scrolled at least one pixel in the given direction, @false if it did not scroll. - + @see GetMajorAxis() @see ScrollPixels() @see ScrollSections() */ virtual bool ScrollLines(int lines); - + /** Scroll the page by a set number of pixels up / down / left / right. - + When the page's children are too big to fit in the onscreen area given to the page, scroll buttons will appear, and the page can be programmatically scrolled. Positive values of @a lines will scroll right or down, while negative values will scroll up or left (depending on the direction in which panels are stacked). - + @return @true if the page scrolled at least one pixel in the given direction, @false if it did not scroll. - + @see GetMajorAxis() @see ScrollLines() @see ScrollSections() @@ -188,12 +188,12 @@ public: /** Get the direction in which ribbon panels are stacked within the page. - + This is controlled by the style of the containing wxRibbonBar, meaning that all pages within a bar will have the same major axis. As well as being the direction in which panels are stacked, it is also the axis in which scrolling will occur (when required). - + @return wxHORIZONTAL or wxVERTICAL (never wxBOTH). */ wxOrientation GetMajorAxis() const; diff --git a/interface/wx/ribbon/toolbar.h b/interface/wx/ribbon/toolbar.h index 588b6b3ea6..9b7c44c9a9 100644 --- a/interface/wx/ribbon/toolbar.h +++ b/interface/wx/ribbon/toolbar.h @@ -8,11 +8,11 @@ /** @class wxRibbonToolBar - + A ribbon tool bar is similar to a traditional toolbar which has no labels. It contains one or more tool groups, each of which contains one or more tools. Each tool is represented by a (generally small, i.e. 16x15) bitmap. - + @beginEventEmissionTable{wxRibbonToolBarEvent} @event{EVT_RIBBONTOOLBAR_CLICKED(id, func)} Triggered when the normal (non-dropdown) region of a tool on the tool @@ -23,7 +23,7 @@ event handler if it wants to display a popup menu (which is what most dropdown tools should be doing). @endEventTable - + @library{wxribbon} @category{ribbon} */ @@ -39,7 +39,7 @@ public: /** Construct a ribbon tool bar with the given parameters. - + @param parent Parent window for the tool bar (typically a wxRibbonPanel). @param id @@ -84,7 +84,7 @@ public: /** Add a dropdown tool to the tool bar (simple version). - + @see AddTool() */ virtual wxRibbonToolBarToolBase* AddDropdownTool( @@ -94,7 +94,7 @@ public: /** Add a hybrid tool to the tool bar (simple version). - + @see AddTool() */ virtual wxRibbonToolBarToolBase* AddHybridTool( @@ -116,7 +116,7 @@ public: /** Add a tool to the tool bar. - + @param tool_id ID of the new tool (used for event callbacks). @param bitmap @@ -132,10 +132,10 @@ public: The kind of tool to add. @param client_data Client data to associate with the new tool. - + @return An opaque pointer which can be used only with other tool bar methods. - + @see AddDropdownTool(), AddHybridTool(), AddSeparator(), InsertTool() */ virtual wxRibbonToolBarToolBase* AddTool( @@ -148,7 +148,7 @@ public: /** Add a separator to the tool bar. - + Separators are used to separate tools into groups. As such, a separator is not explicitly drawn, but is visually seen as the gap between tool groups. @@ -404,12 +404,12 @@ public: /** Set the number of rows to distribute tool groups over. - + Tool groups can be distributed over a variable number of rows. The way in which groups are assigned to rows is not specified, and the order of groups may change, but they will be distributed in such a way as to minimise the overall size of the tool bar. - + @param nMin The minimum number of rows to use. @param nMax diff --git a/interface/wx/richmsgdlg.h b/interface/wx/richmsgdlg.h index 649e0ae4d4..8cf94dbaae 100644 --- a/interface/wx/richmsgdlg.h +++ b/interface/wx/richmsgdlg.h @@ -115,7 +115,7 @@ public: The footer text if empty no footer text will be used. @see SetFooterIcon(), GetFooterText() - + @since 3.1.1 */ void SetFooterText(const wxString& footerText); diff --git a/interface/wx/richtext/richtextbuffer.h b/interface/wx/richtext/richtextbuffer.h index b58125debd..ae9554605b 100644 --- a/interface/wx/richtext/richtextbuffer.h +++ b/interface/wx/richtext/richtextbuffer.h @@ -4486,7 +4486,7 @@ protected: // Whether the paragraph is impacted by floating objects from above int m_impactedByFloatingObjects; - + // Default tabstops static wxArrayInt sm_defaultTabs; @@ -5702,7 +5702,7 @@ protected: wxRichTextCell is the cell in a table, in which the user can type. As well as text, it can also contain objects e.g. an image, or even another wxRichTextTable. - + A cell's appearance can be changed via its associated wxRichTextAttr; for example its size altered or its background colour set. It also has the properties of column- and row-span. By default these are 1, meaning that the cell only spans @@ -5745,46 +5745,46 @@ public: /** Returns the number of columns spanned by the cell. - + By default a cell doesn't span extra columns, so this function returns 1. - + @since 2.9.5 - + @see SetColSpan(), GetRowSpan() */ int GetColSpan() const; /** Set the number of columns spanned by the cell. - + By default colspan is 1 i.e. a cell doesn't span extra columns. Pass a value >1 to change this. Attempting to set a colspan <1 will assert and be ignored. - + @since 2.9.5 - + @see GetColSpan(), SetRowSpan() */ void SetColSpan(long span); /** Returns the number of rows spanned by the cell. - + By default a cell doesn't span extra rows, so this function returns 1. - + @since 2.9.5 - + @see SetRowSpan(), GetColSpan() */ int GetRowSpan() const; /** Set the number of rows spanned by the cell. - + By default colspan is 1 i.e. a cell doesn't span extra rows. Pass a value >1 to change this. Attempting to set a rowspan <1 will assert and be ignored. - + @since 2.9.5 - + @see GetRowSpan(), SetColSpan() */ void SetRowSpan(long span); @@ -5912,7 +5912,7 @@ public: /** Returns the coordinates of the cell with keyboard focus, or (-1,-1) if none. - */ + */ virtual wxPosition GetFocusedCell() const; // Operations @@ -5996,7 +5996,7 @@ public: wxRichTextTableBlock(const wxRichTextTableBlock& block) { Copy(block); } void Init() { m_colStart = 0; m_colEnd = 0; m_rowStart = 0; m_rowEnd = 0; } - + void Copy(const wxRichTextTableBlock& block) { m_colStart = block.m_colStart; m_colEnd = block.m_colEnd; m_rowStart = block.m_rowStart; m_rowEnd = block.m_rowEnd; diff --git a/interface/wx/richtext/richtextctrl.h b/interface/wx/richtext/richtextctrl.h index 3af29d13a5..2346593a3a 100644 --- a/interface/wx/richtext/richtextctrl.h +++ b/interface/wx/richtext/richtextctrl.h @@ -595,7 +595,7 @@ public: */ virtual void DiscardEdits(); - + void SetModified(bool modified); /** @@ -1236,7 +1236,7 @@ public: left of the actual paragraph is leftSubIndent. */ bool BeginNumberedBullet(int bulletNumber, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_ARABIC|wxTEXT_ATTR_BULLET_STYLE_PERIOD); - + /** Ends application of a numbered bullet. */ @@ -1248,7 +1248,7 @@ public: to render the bulleted paragraph. */ bool BeginSymbolBullet(const wxString& symbol, int leftIndent, int leftSubIndent, int bulletStyle = wxTEXT_ATTR_BULLET_STYLE_SYMBOL); - + /** Ends applying a symbol bullet. */ @@ -1503,7 +1503,7 @@ public: @a style must have flags indicating which attributes are of interest. */ virtual bool HasCharacterAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const; - + /** Test if this whole range has paragraph attributes of the specified kind. @@ -1512,7 +1512,7 @@ public: @a style must have flags indicating which attributes are of interest. */ virtual bool HasParagraphAttributes(const wxRichTextRange& range, const wxRichTextAttr& style) const; - + /** Returns @true if all of the selection, or the content at the caret position, is bold. @@ -2400,7 +2400,7 @@ public: Copy constructor. */ wxRichTextEvent(const wxRichTextEvent& event); - + /** Returns the buffer position at which the event occurred. */ diff --git a/interface/wx/sashwin.h b/interface/wx/sashwin.h index 28d48f8e7e..5710e09a2d 100644 --- a/interface/wx/sashwin.h +++ b/interface/wx/sashwin.h @@ -275,7 +275,7 @@ public: */ wxSashEdgePosition GetEdge() const; - + void SetEdge(wxSashEdgePosition edge); void SetDragRect(const wxRect& rect); void SetDragStatus(wxSashDragStatus status); diff --git a/interface/wx/scopedptr.h b/interface/wx/scopedptr.h index c72936eb0a..4895ee96e6 100644 --- a/interface/wx/scopedptr.h +++ b/interface/wx/scopedptr.h @@ -238,8 +238,8 @@ public: T& operator*() const; /** - Smart pointer member access. Returns pointer to object. - + Smart pointer member access. Returns pointer to object. + If the internal pointer is @NULL this method will cause an assert in debug mode. */ T* operator->() const; diff --git a/interface/wx/scrolbar.h b/interface/wx/scrolbar.h index 1f7ff099ef..18e7d155ff 100644 --- a/interface/wx/scrolbar.h +++ b/interface/wx/scrolbar.h @@ -124,10 +124,10 @@ public: @param id Window identifier. The value wxID_ANY indicates a default value. @param pos - Window position. + Window position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. + Window size. If ::wxDefaultSize is specified then a default size is chosen. @param style Window style. See wxScrollBar. diff --git a/interface/wx/scrolwin.h b/interface/wx/scrolwin.h index 7b44ae250c..177ce0545a 100644 --- a/interface/wx/scrolwin.h +++ b/interface/wx/scrolwin.h @@ -539,7 +539,7 @@ public: void SetTargetWindow(wxWindow *window); wxWindow *GetTargetWindow() const; - + void SetTargetRect(const wxRect& rect); wxRect GetTargetRect() const; @@ -562,13 +562,13 @@ public: window. */ void StopAutoScrolling(); - + /** This method can be overridden in a derived class to forbid sending the auto scroll events - note that unlike StopAutoScrolling() it doesn't stop the timer, so it will be called repeatedly and will typically return different values depending on the current mouse position - + The base class version just returns true. */ virtual bool SendAutoScrollEvents(wxScrollWinEvent& event) const; diff --git a/interface/wx/settings.h b/interface/wx/settings.h index 11f913a2f6..925c6aa9c4 100644 --- a/interface/wx/settings.h +++ b/interface/wx/settings.h @@ -257,7 +257,7 @@ enum wxSystemScreenType wxSystemSettings allows the application to ask for details about the system. - This can include settings such as standard colours, fonts, and user interface + This can include settings such as standard colours, fonts, and user interface element sizes. @library{wxcore} @@ -279,9 +279,9 @@ public: /** Returns a system colour. - @param index + @param index Can be one of the ::wxSystemColour enum values. - + @return The returned colour is always valid. */ @@ -290,9 +290,9 @@ public: /** Returns a system font. - @param index + @param index Can be one of the ::wxSystemFont enum values. - + @return The returned font is always valid. */ diff --git a/interface/wx/sizer.h b/interface/wx/sizer.h index e096c08c9d..c42fd3e380 100644 --- a/interface/wx/sizer.h +++ b/interface/wx/sizer.h @@ -294,7 +294,7 @@ public: int flag = 0, int border = 0, wxObject* userData = NULL); - + /** Appends a spacer child to the sizer. @@ -309,7 +309,7 @@ public: wxSizerItem* Add( int width, int height, const wxSizerFlags& flags); wxSizerItem* Add(wxSizerItem* item); - + /** This base function adds non-stretchable space to both the horizontal and vertical orientation of the sizer. @@ -439,7 +439,7 @@ public: */ virtual bool InformFirstDirection(int direction, int size, int availableOtherDir); - + //@{ /** Returns the list of the items in this sizer. @@ -460,7 +460,7 @@ public: Set the window this sizer is used in. */ void SetContainingWindow(wxWindow *window); - + /** Returns the number of items in the sizer. @@ -617,7 +617,7 @@ public: const wxSizerFlags& flags); wxSizerItem* Insert(size_t index, wxSizerItem* item); - + /** Inserts non-stretchable space to the sizer. More readable way of calling wxSizer::Insert(index, size, size). @@ -713,7 +713,7 @@ public: wxSizerItem* Prepend(int width, int height, const wxSizerFlags& flags); wxSizerItem* Prepend(wxSizerItem* item); - + /** Prepends non-stretchable space to the sizer. More readable way of calling wxSizer::Prepend(size, size, 0). @@ -1715,7 +1715,7 @@ public: virtual void RecalcSizes(); virtual wxSize CalcMin(); - + }; @@ -1778,7 +1778,7 @@ public: number of columns or rows being currently used, see GetEffectiveColsCount() */ int GetCols() const; - + /** Returns the number of rows that has been specified for the sizer. @@ -1798,7 +1798,7 @@ public: @since 2.9.1 */ int GetEffectiveColsCount() const; - + /** Returns the number of rows currently used by the sizer. diff --git a/interface/wx/slider.h b/interface/wx/slider.h index 68815389c5..f35e3cf574 100644 --- a/interface/wx/slider.h +++ b/interface/wx/slider.h @@ -167,10 +167,10 @@ public: @param maxValue Maximum slider position. @param pos - Window position. + Window position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. + Window size. If ::wxDefaultSize is specified then a default size is chosen. @param style Window style. See wxSlider. @@ -306,7 +306,7 @@ public: @param minValue The new bottom end of the slider range. - + @see GetMin(), SetRange() */ void SetMin( int minValue ); @@ -316,7 +316,7 @@ public: @param maxValue The new top end of the slider range. - + @see GetMax(), SetRange() */ void SetMax( int maxValue ); diff --git a/interface/wx/srchctrl.h b/interface/wx/srchctrl.h index 975a137703..0709cb9e11 100644 --- a/interface/wx/srchctrl.h +++ b/interface/wx/srchctrl.h @@ -100,7 +100,7 @@ public: */ virtual ~wxSearchCtrl(); - + bool Create(wxWindow* parent, wxWindowID id, const wxString& value = wxEmptyString, const wxPoint& pos = wxDefaultPosition, @@ -126,7 +126,7 @@ public: Returns the cancel button's visibility state. */ virtual bool IsCancelButtonVisible() const; - + /** Sets the search control's menu object. If there is already a menu associated with the search control it is deleted. diff --git a/interface/wx/statbmp.h b/interface/wx/statbmp.h index 06bfce85b2..e47094ae58 100644 --- a/interface/wx/statbmp.h +++ b/interface/wx/statbmp.h @@ -33,36 +33,36 @@ class wxStaticBitmap : public wxControl public: /** Specify how the bitmap should be scaled in the control. - + @see SetScaleMode(), GetScaleMode() */ enum ScaleMode { - /** + /** The bitmap is displayed in original size. Portions larger then the control will be cut off. */ Scale_None, - + /** Scale the bitmap to fit the size of the control by changing the aspect ratio of the bitmap if necessary. */ Scale_Fill, - + /** Scale the bitmap to fit the size of the control by maintaining the aspect ratio. Any remaining area of the control will use the background. */ Scale_AspectFit, - + /** Scale the bitmap to fill the size of the control. Some portion of the bitmap may be clipped to fill the control. */ Scale_AspectFill }; - + /** Default constructor */ @@ -138,31 +138,31 @@ public: The new icon. */ virtual void SetIcon(const wxIcon& label); - + /** Sets the scale mode. - + @param scaleMode Controls how the bitmap is scaled inside the control. - + @note Currently only the generic implementation supports all scaling modes. You may use generic implementation wxGenericStaticBitmap declared in \ in all ports. - + @see GetScaleMode() - + @since 3.1.0 */ virtual void SetScaleMode(ScaleMode scaleMode); - + /** Returns the scale mode currently used in the control. - + @see SetScaleMode() - + @since 3.1.0 */ virtual ScaleMode GetScaleMode() const; - + }; diff --git a/interface/wx/stc/stc.h b/interface/wx/stc/stc.h index 528667382d..3c992fe511 100644 --- a/interface/wx/stc/stc.h +++ b/interface/wx/stc/stc.h @@ -7,7 +7,7 @@ /* IMPORTANT: This file is generated by src/stc/gen_iface.py from - src/stc/stc.interface.h.in. Do not edit the file in + src/stc/stc.interface.h.in. Do not edit the file in interface/wx/stc or your changes will be lost. */ @@ -7275,7 +7275,7 @@ public: /** Extract style settings from a spec-string which is composed of one or more of the following comma separated elements: - + bold turns on bold italic turns on italics fore:[name or \#RRGGBB] sets the foreground colour diff --git a/interface/wx/stream.h b/interface/wx/stream.h index 5eccd60e15..b7f5bbc4f1 100644 --- a/interface/wx/stream.h +++ b/interface/wx/stream.h @@ -662,7 +662,7 @@ public: /** Changes the stream current position. - This operation in general is possible only for seekable streams + This operation in general is possible only for seekable streams (see wxStreamBase::IsSeekable()); non-seekable streams support only seeking positive amounts in mode @c wxFromCurrent (this is implemented by reading data and simply discarding it). diff --git a/interface/wx/sysopt.h b/interface/wx/sysopt.h index 2453fe6eea..bbf3d1ccac 100644 --- a/interface/wx/sysopt.h +++ b/interface/wx/sysopt.h @@ -112,7 +112,7 @@ If 1 activates the spell checking in wxTextCtrl. @flag{osx.openfiledialog.always-show-types} Per default a wxFileDialog with wxFD_OPEN does not show a types-popup on OS X but allows - the selection of files from any of the supported types. Setting this to 1 shows a wxChoice + the selection of files from any of the supported types. Setting this to 1 shows a wxChoice for selection (if there is more than one supported filetype). @endFlagTable diff --git a/interface/wx/textwrapper.h b/interface/wx/textwrapper.h index f4a3822cd9..495cb90ed1 100644 --- a/interface/wx/textwrapper.h +++ b/interface/wx/textwrapper.h @@ -19,7 +19,7 @@ Here is an example function using this class which inserts hard line breaks into a string of text at the positions where it would be wrapped: - + @code wxString WrapText(wxWindow *win, const wxString& text, int widthMax) { diff --git a/interface/wx/thread.h b/interface/wx/thread.h index c9ba40baf3..65d14dcddf 100644 --- a/interface/wx/thread.h +++ b/interface/wx/thread.h @@ -1224,7 +1224,7 @@ public: of detached threads. This function can only be called from another thread context. - + Finally, note that once a thread has completed and its Entry() function returns, you cannot call Run() on it again (an assert will fail in debug builds or @c wxTHREAD_RUNNING will be returned in release builds). diff --git a/interface/wx/timectrl.h b/interface/wx/timectrl.h index 0d1b77c542..daaba32ac6 100644 --- a/interface/wx/timectrl.h +++ b/interface/wx/timectrl.h @@ -57,7 +57,7 @@ public: Default constructor. */ wxTimePickerCtrl(); - + /** Initializes the object and calls Create() with all the parameters. */ diff --git a/interface/wx/timer.h b/interface/wx/timer.h index 6753e2dd12..d0a884c7b7 100644 --- a/interface/wx/timer.h +++ b/interface/wx/timer.h @@ -154,7 +154,7 @@ public: @class wxTimerRunner Starts the timer in its ctor, stops in the dtor. -*/ +*/ class wxTimerRunner { public: diff --git a/interface/wx/tokenzr.h b/interface/wx/tokenzr.h index d7861593b0..2ab0829f6b 100644 --- a/interface/wx/tokenzr.h +++ b/interface/wx/tokenzr.h @@ -7,7 +7,7 @@ /** The behaviour of wxStringTokenizer is governed by the - wxStringTokenizer::wxStringTokenizer() or wxStringTokenizer::SetString() + wxStringTokenizer::wxStringTokenizer() or wxStringTokenizer::SetString() with the parameter @e mode, which may be one of the following: */ enum wxStringTokenizerMode @@ -27,7 +27,7 @@ enum wxStringTokenizerMode /** In this mode, the empty tokens in the middle of the string will be returned, - i.e. @c "a::b:" will be tokenized in three tokens @c 'a', @c '' and @c 'b'. + i.e. @c "a::b:" will be tokenized in three tokens @c 'a', @c '' and @c 'b'. Notice that all trailing delimiters are ignored in this mode, not just the last one, i.e. a string @c "a::b::" would still result in the same set of tokens. */ @@ -72,7 +72,7 @@ enum wxStringTokenizerMode string to tokenize and also the delimiters which separate tokens in the string (by default, white space characters will be used). - Then wxStringTokenizer::GetNextToken() may be called repeatedly until + Then wxStringTokenizer::GetNextToken() may be called repeatedly until wxStringTokenizer::HasMoreTokens() returns @false. For example: @@ -169,17 +169,17 @@ public: //@{ /** - This is a convenience function wrapping wxStringTokenizer which simply + This is a convenience function wrapping wxStringTokenizer which simply returns all tokens found in the given @a str as an array. - Please see wxStringTokenizer::wxStringTokenizer for the description + Please see wxStringTokenizer::wxStringTokenizer for the description of the other parameters. @return The array with the parsed tokens. @header{wx/tokenzr.h} */ -wxArrayString +wxArrayString wxStringTokenize(const wxString& str, const wxString& delims = wxDEFAULT_DELIMITERS, wxStringTokenizerMode mode = wxTOKEN_DEFAULT); diff --git a/interface/wx/toplevel.h b/interface/wx/toplevel.h index 6935d638ce..5ad74b5912 100644 --- a/interface/wx/toplevel.h +++ b/interface/wx/toplevel.h @@ -445,11 +445,11 @@ public: */ wxWindow* SetDefaultItem(wxWindow* win); - + wxWindow* SetTmpDefaultItem(wxWindow * win); wxWindow* GetTmpDefaultItem() const; - + /** Sets the icon for this window. @@ -571,20 +571,20 @@ public: there are any open top level windows. */ virtual bool ShouldPreventAppExit() const; - + /** This function sets the wxTopLevelWindow's modified state on OS X, which currently draws a black dot in the wxTopLevelWindow's close button. On other platforms, this method does nothing. - + @see OSXIsModified() */ virtual void OSXSetModified(bool modified); - + /** Returns the current modified state of the wxTopLevelWindow on OS X. On other platforms, this method does nothing. - + @see OSXSetModified() */ virtual bool OSXIsModified() const; @@ -611,7 +611,7 @@ public: virtual void ShowWithoutActivating(); /** - Enables the maximize button to toggle full screen mode. Prior to + Enables the maximize button to toggle full screen mode. Prior to OS X 10.10 a full screen button is added to the right upper corner of a window's title bar. diff --git a/interface/wx/treectrl.h b/interface/wx/treectrl.h index 329ad6fe7a..1138f59d3f 100644 --- a/interface/wx/treectrl.h +++ b/interface/wx/treectrl.h @@ -185,7 +185,7 @@ public: Window position. If ::wxDefaultPosition is specified then a default position is chosen. @param size - Window size. + Window size. If ::wxDefaultSize is specified then the window is sized appropriately. @param style Window style. See wxTreeCtrl. @@ -470,7 +470,7 @@ public: Returns the item last clicked or otherwise selected. Unlike GetSelection(), it can be used whether or not the control has the @c wxTR_MULTIPLE style. - + @since 2.9.1 */ virtual wxTreeItemId GetFocusedItem() const; @@ -647,7 +647,7 @@ public: /** Returns the selection, or an invalid item if there is no selection. This function only works with the controls without @c wxTR_MULTIPLE style, - use GetSelections() for the controls which do have this style + use GetSelections() for the controls which do have this style or, if a single item is wanted, use GetFocusedItem(). */ virtual wxTreeItemId GetSelection() const; diff --git a/interface/wx/treelist.h b/interface/wx/treelist.h index 45c8d12c19..19633a3204 100644 --- a/interface/wx/treelist.h +++ b/interface/wx/treelist.h @@ -41,7 +41,7 @@ enum /** @class wxTreeListItem - + Unique identifier of an item in wxTreeListCtrl. This is an opaque class which can't be used by the application in any other @@ -74,7 +74,7 @@ public: /** @class wxTreeListItemComparator - + Class defining sort order for the items in wxTreeListCtrl. @see wxTreeListCtrl diff --git a/interface/wx/utils.h b/interface/wx/utils.h index 4557fc4f27..b4267d0f92 100644 --- a/interface/wx/utils.h +++ b/interface/wx/utils.h @@ -866,7 +866,7 @@ bool wxGetUserName(char* buf, int sz); wxString wxGetOsDescription(); /** - Gets the version and the operating system ID for currently running OS. + Gets the version and the operating system ID for currently running OS. The returned wxOperatingSystemId value can be used for a basic categorization of the OS family; the major, minor, and micro version numbers allows detecting a specific system. @@ -885,8 +885,8 @@ wxString wxGetOsDescription(); For OS X systems (@c wxOS_MAC) the major and minor version integers are the natural version numbers associated with the OS; e.g. "10", "11" and "2" if the machine is using OS X El Capitan 10.11.2. - - For Windows-like systems (@c wxOS_WINDOWS) the major and minor version integers will + + For Windows-like systems (@c wxOS_WINDOWS) the major and minor version integers will contain the following values: @beginTable @row3col{Windows OS name, Major version, Minor version} @@ -954,15 +954,15 @@ bool wxIsPlatformLittleEndian(); /** Returns a structure containing information about the currently running Linux distribution. - - This function uses the @c lsb_release utility which is part of the - Linux Standard Base Core specification - (see http://refspecs.linux-foundation.org/lsb.shtml) since the very first LSB + + This function uses the @c lsb_release utility which is part of the + Linux Standard Base Core specification + (see http://refspecs.linux-foundation.org/lsb.shtml) since the very first LSB release 1.0 (released in 2001). The @c lsb_release utility is very common on modern Linux distributions but in case it's not available, then this function will return a ::wxLinuxDistributionInfo structure containing empty strings. - + This function is Linux-specific and is only available when the @c __LINUX__ symbol is defined. */ diff --git a/interface/wx/validate.h b/interface/wx/validate.h index 1096077019..f1eaddc0ad 100644 --- a/interface/wx/validate.h +++ b/interface/wx/validate.h @@ -81,7 +81,7 @@ public: Returns if the error sound is currently disabled. */ static bool IsSilent(); - + /** Associates a window with the validator. diff --git a/interface/wx/webview.h b/interface/wx/webview.h index ffa2166878..0b441b3d0b 100644 --- a/interface/wx/webview.h +++ b/interface/wx/webview.h @@ -381,14 +381,14 @@ public: /** Factory function to create a new wxWebView with two-step creation, wxWebView::Create should be called on the returned object. - @param backend The backend web rendering engine to use. + @param backend The backend web rendering engine to use. @c wxWebViewBackendDefault, @c wxWebViewBackendIE and @c wxWebViewBackendWebKit are predefined where appropriate. @return The created wxWebView @since 2.9.5 */ static wxWebView* New(const wxString& backend = wxWebViewBackendDefault); - + /** Factory function to create a new wxWebView using a wxWebViewFactory. @param parent Parent window for the control @@ -415,15 +415,15 @@ public: long style = 0, const wxString& name = wxWebViewNameStr); - /** + /** Allows the registering of new backend for wxWebView. @a backend can be used as an argument to New(). @param backend The name for the new backend to be registered under - @param factory A shared pointer to the factory which creates the + @param factory A shared pointer to the factory which creates the appropriate backend. @since 2.9.5 */ - static void RegisterFactory(const wxString& backend, + static void RegisterFactory(const wxString& backend, wxSharedPtr factory); /** diff --git a/interface/wx/window.h b/interface/wx/window.h index 2ba856ea40..18f7b7b9af 100644 --- a/interface/wx/window.h +++ b/interface/wx/window.h @@ -486,7 +486,7 @@ public: container windows. */ virtual bool AcceptsFocusRecursively() const; - + /** Can this window itself have focus? */ @@ -494,7 +494,7 @@ public: /** Can this window have focus right now? - + If this method returns true, it means that calling SetFocus() will put focus either to this window or one of its children, if you need to know whether this window accepts focus itself, use IsFocusable() @@ -1410,7 +1410,7 @@ public: InformFirstDirection(int direction, int size, int availableOtherDir); - + /** Resets the cached best size value so it will be recalculated the next time it is needed. @@ -1793,7 +1793,7 @@ public: wxRect GetClientRect() const; - + /** Moves the window to the given position. @@ -3609,7 +3609,7 @@ public: */ wxBorder GetBorder() const; - + /** Does the window-specific updating after processing the update event. This function is called by UpdateWindowUI() in order to check return @@ -3721,7 +3721,7 @@ public: */ virtual bool IsTopLevel() const; - + /** This virtual function is normally only used internally, but sometimes an application may need it to implement functionality diff --git a/interface/wx/withimages.h b/interface/wx/withimages.h index a52104a2ab..3adc3e0d84 100644 --- a/interface/wx/withimages.h +++ b/interface/wx/withimages.h @@ -28,7 +28,7 @@ public: /** Sets the image list to use. It does not take ownership of the image list, you must delete it yourself. - + @see wxImageList, AssignImageList() */ virtual void SetImageList(wxImageList* imageList); @@ -39,7 +39,7 @@ public: @see wxImageList, SetImageList() */ wxImageList* GetImageList() const; - + protected: /** Return true if we have a valid image list. diff --git a/interface/wx/wrapsizer.h b/interface/wx/wrapsizer.h index 61bc160bb3..302da9643f 100644 --- a/interface/wx/wrapsizer.h +++ b/interface/wx/wrapsizer.h @@ -58,7 +58,7 @@ public: */ virtual bool InformFirstDirection(int direction, int size, int availableOtherDir); - + virtual void RecalcSizes(); virtual wxSize CalcMin(); diff --git a/interface/wx/xlocale.h b/interface/wx/xlocale.h index 21481dccf7..da67f0b127 100644 --- a/interface/wx/xlocale.h +++ b/interface/wx/xlocale.h @@ -49,7 +49,7 @@ @stdobjects @li ::wxNullXLocale - + @see wxLocale */ class wxXLocale @@ -85,7 +85,7 @@ public: or @false otherwise. */ bool IsOk() const; - + /** Comparison operator. */ diff --git a/samples/dataview/dataview.cpp b/samples/dataview/dataview.cpp index 10d613e618..53a80d920d 100644 --- a/samples/dataview/dataview.cpp +++ b/samples/dataview/dataview.cpp @@ -458,7 +458,7 @@ wxBEGIN_EVENT_TABLE(MyFrame, wxFrame) EVT_BUTTON( ID_SHOW_ATTRIBUTES, MyFrame::OnShowAttributes) EVT_CHECKBOX( ID_MULTIPLE_SORT, MyFrame::OnMultipleSort) EVT_CHECKBOX( ID_SORT_BY_FIRST_COLUMN, MyFrame::OnSortByFirstColumn) - + // Fourth page. EVT_BUTTON( ID_DELETE_TREE_ITEM, MyFrame::OnDeleteTreeItem ) EVT_BUTTON( ID_DELETE_ALL_TREE_ITEMS, MyFrame::OnDeleteAllTreeItems ) diff --git a/samples/html/html_samples.bkl b/samples/html/html_samples.bkl index f147d02f28..102802e4d7 100644 --- a/samples/html/html_samples.bkl +++ b/samples/html/html_samples.bkl @@ -2,7 +2,7 @@ - +