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

Looking for comments on new functions and macros organization of Doxygen docs shown with this commit, see wx-dev.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52438 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-03-11 07:57:21 +00:00
parent 2aee749cb1
commit c83e60aab5
8 changed files with 1253 additions and 1168 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/doxygen/Doxyfile.inc
View File

@@ -211,7 +211,7 @@ WARN_LOGFILE = doxygen.log
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
# configuration options related to the input files # configuration options related to the input files
#--------------------------------------------------------------------------- #---------------------------------------------------------------------------
INPUT = ./mainpages ./overviews ../../interface INPUT = ./mainpages ./groups ./overviews ../../interface
INPUT_ENCODING = UTF-8 INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h *.txt FILE_PATTERNS = *.h *.txt
RECURSIVE = YES RECURSIVE = YES

21
docs/doxygen/groups/gdi.h Normal file
View File

@@ -0,0 +1,21 @@
/////////////////////////////////////////////////////////////////////////////
// Name: gdi.h
// Purpose: Graphics Device Interface function and macro docs
// Author: wxWidgets team
// RCS-ID: $Id: gdicmn.h 52425 2008-03-10 15:24:38Z FM $
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
@defgroup group_gdi Graphics Device Interface (GDI) Functions and Macros
The following are functions and macros related to GDI (Graphics Device
Interface) access.
Related Overviews: @ref overview_dc
@header{wx/gdicmn.h}
*/

1315
docs/doxygen/mainpages/cat_classes.h
View File

File diff suppressed because it is too large Load Diff

750
docs/doxygen/mainpages/cat_functions.h
View File

@@ -6,386 +6,390 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/**
/*! @page page_func_cat Functions by Category
@li @ref page_func_cat_appinitterm
@li @ref page_func_cat_procctrl
@li @ref page_func_cat_thread
@li @ref page_func_cat_file
@li @ref page_func_cat_networkuseros
@li @ref page_func_cat_string
@li @ref page_func_cat_dialog
@li @ref page_func_cat_math
@li @ref page_func_cat_gdi
@li @ref page_func_cat_printer
@li @ref page_func_cat_clipboard
@li @ref page_func_cat_log
@li @ref page_func_cat_time
@li @ref page_func_cat_debug
@li @ref page_func_cat_env
@li @ref page_func_cat_atomic
@li @ref page_func_cat_misc
<hr>
@section page_func_cat_appinitterm Application Initialization and Termination
The functions in this section are used on application startup/shutdown and also
to control the behaviour of the main event loop of the GUI programs.
@li ::wxEntry()
@li ::wxEntryCleanup()
@li ::wxEntryStart()
@li ::wxGetApp()
@li ::wxHandleFatalExceptions()
@li ::wxInitAllImageHandlers()
@li ::wxInitialize()
@li ::wxSafeYield()
@li ::wxUninitialize()
@li ::wxYield()
@li ::wxWakeUpIdle()
@section page_func_cat_procctrl Process Control
The functions in this section are used to launch or terminate the other
processes.
@li ::wxExecute()
@li ::wxExit()
@li ::wxJoin()
@li ::wxKill()
@li ::wxGetProcessId()
@li ::wxShell()
@li ::wxShutdown()
@section page_func_cat_thread Threads
The functions and macros here mainly exist to make it writing the code which
may be compiled in multi thread build (wxUSE_THREADS = 1) as well as in single
thread configuration (wxUSE_THREADS = 0).
For example, a static variable must be protected against simultaneous access by
multiple threads in the former configuration but in the latter the extra
overhead of using the critical section is not needed. To solve this problem,
the wxCRITICAL_SECTION macro may be used to create and use the critical section
only when needed.
@header{wx/thread.h}
@sa wxThread, wxMutex, @ref overview_thread
@li ::wxIsMainThread()
@li ::wxMutexGuiEnter()
@li ::wxMutexGuiLeave()
@section page_func_cat_file Files and Directories
@header{wx/filefn.h}
@sa wxPathList, wxDir, wxFile, wxFileName
@li ::wxDos2UnixFilename()
@li ::wxFileExists()
@li ::wxFileModificationTime()
@li ::wxFileNameFromPath()
@li ::wxFindFirstFile()
@li ::wxFindNextFile()
@li ::wxGetDiskSpace()
@li ::wxGetFileKind()
@li ::wxGetOSDirectory()
@li ::wxIsAbsolutePath()
@li ::wxDirExists()
@li ::wxPathOnly()
@li ::wxUnix2DosFilename()
@li ::wxConcatFiles()
@li ::wxCopyFile()
@li ::wxGetCwd()
@li ::wxGetWorkingDirectory()
@li ::wxGetTempFileName()
@li ::wxIsWild()
@li ::wxMatchWild()
@li ::wxMkdir()
@li ::wxParseCommonDialogsFilter()
@li ::wxRemoveFile()
@li ::wxRenameFile()
@li ::wxRmdir()
@li ::wxSetWorkingDirectory()
@li ::wxSplit()
@li ::wxSplitPath()
@li ::wxTransferFileToStream()
@li ::wxTransferStreamToFile()
@section page_func_cat_networkuseros Network, User and OS
The functions in this section are used to retrieve information about the
current computer and/or user characteristics.
@li ::wxGetEmailAddress()
@li ::wxGetFreeMemory()
@li ::wxGetFullHostName()
@li ::wxGetHomeDir()
@li ::wxGetHostName()
@li ::wxGetOsDescription()
@li ::wxGetOsVersion()
@li ::wxIsPlatformLittleEndian()
@li ::wxIsPlatform64Bit()
@li ::wxGetUserHome()
@li ::wxGetUserId()
@li ::wxGetUserName()
@section page_func_cat_string Strings
@li ::wxGetTranslation()
@li ::wxIsEmpty()
@li ::wxStrcmp()
@li ::wxStricmp()
@li ::wxStringEq()
@li ::wxStringMatch()
@li ::wxStringTokenize()
@li ::wxStrlen()
@li ::wxSnprintf()
@li ::wxVsnprintf()
@section page_func_cat_dialog Dialogs
Below are a number of convenience functions for getting input from the user
or displaying messages. Note that in these functions the last three parameters
are optional. However, it is recommended to pass a parent frame parameter, or
(in MS Windows or Motif) the wrong window frame may be brought to the front when
the dialog box is popped up.
@li ::wxAboutBox()
@li ::wxBeginBusyCursor()
@li ::wxBell()
@li ::wxCreateFileTipProvider()
@li ::wxDirSelector()
@li ::wxFileSelector()
@li ::wxEndBusyCursor()
@li ::wxGenericAboutBox()
@li ::wxGetColourFromUser()
@li ::wxGetFontFromUser()
@li ::wxGetMultipleChoices()
@li ::wxGetNumberFromUser()
@li ::wxGetPasswordFromUser()
@li ::wxGetTextFromUser()
@li ::wxGetSingleChoice()
@li ::wxGetSingleChoiceIndex()
@li ::wxGetSingleChoiceData()
@li ::wxInfoMessageBox()
@li ::wxIsBusy()
@li ::wxMessageBox()
@li ::wxShowTip()
@section page_func_cat_math Math
@header{wx/math.h}
@li ::wxFinite()
@li ::wxIsNaN()
@section page_func_cat_gdi Graphics Device Interface
The following are relevant to the GDI (Graphics Device Interface).
@header{wx/gdicmn.h}
@li ::wxBITMAP()
@li ::wxClientDisplayRect()
@li ::wxColourDisplay()
@li ::wxDisplayDepth()
@li ::wxDisplaySize()
@li ::wxDisplaySizeMM()
@li ::wxDROP_ICON()
@li ::wxICON()
@li ::wxMakeMetafilePlaceable()
@li ::wxSetCursor()
@section page_func_cat_printer Printing
@warning These functions are deprecated and should no longer be used.
The following functions are used to control PostScript printing. Under Windows,
PostScript output can only be sent to a file.
@header{wx/dcps.h}
@li ::wxGetPrinterCommand()
@li ::wxGetPrinterFile()
@li ::wxGetPrinterMode()
@li ::wxGetPrinterOptions()
@li ::wxGetPrinterOrientation()
@li ::wxGetPrinterPreviewCommand()
@li ::wxGetPrinterScaling()
@li ::wxGetPrinterTranslation()
@li ::wxSetPrinterCommand()
@li ::wxSetPrinterFile()
@li ::wxSetPrinterMode()
@li ::wxSetPrinterOptions()
@li ::wxSetPrinterOrientation()
@li ::wxSetPrinterPreviewCommand()
@li ::wxSetPrinterScaling()
@li ::wxSetPrinterTranslation()
@page page_func_cat Functions by category
A classification of wxWidgets functions by category. @section page_func_cat_clipboard Clipboard
@li @ref page_func_cat_appinitterm
@li @ref page_func_cat_procctrl
@li @ref page_func_cat_thread
@li @ref page_func_cat_file
@li @ref page_func_cat_networkuseros
@li @ref page_func_cat_string
@li @ref page_func_cat_dialog
@li @ref page_func_cat_math
@li @ref page_func_cat_gdi
@li @ref page_func_cat_printer
@li @ref page_func_cat_clipboard
@li @ref page_func_cat_misc
@li @ref page_func_cat_log
@li @ref page_func_cat_time
@li @ref page_func_cat_debug
@li @ref page_func_cat_env
@li @ref page_func_cat_atomic
@warning These functions are deprecated, use the wxClipboard class instead.
These clipboard functions are implemented for Windows only.
@header{wx/clipbrd.h}
@li ::wxClipboardOpen()
@li ::wxCloseClipboard()
@li ::wxEmptyClipboard()
@li ::wxEnumClipboardFormats()
@li ::wxGetClipboardData()
@li ::wxGetClipboardFormatName()
@li ::wxIsClipboardFormatAvailable()
@li ::wxOpenClipboard()
@li ::wxRegisterClipboardFormat()
@li ::wxSetClipboardData()
<hr>
@section page_func_cat_appinitterm Application initialization and termination
The functions in this section are used on application startup/shutdown and also
to control the behaviour of the main event loop of the GUI programs.
@li wxEntry
@li wxEntryCleanup
@li wxEntryStart
@li wxGetApp
@li wxHandleFatalExceptions
@li wxInitAllImageHandlers
@li wxInitialize
@li wxSafeYield
@li wxUninitialize
@li wxYield
@li wxWakeUpIdle
@section page_func_cat_procctrl Process control functions
The functions in this section are used to launch or terminate the other processes.
@li wxExecute
@li wxExit
@li wxJoin
@li wxKill
@li wxGetProcessId
@li wxShell
@li wxShutdown
@section page_func_cat_thread Thread functions
The functions and macros here mainly exist to make it writing the code which may be
compiled in multi thread build (wxUSE_THREADS = 1) as well as in single thread
configuration (wxUSE_THREADS = 0).
For example, a static variable must be protected against simultaneous access by multiple
threads in the former configuration but in the latter the extra overhead of using the
critical section is not needed. To solve this problem, the wxCRITICAL_SECTION macro
may be used to create and use the critical section only when needed.
@header{wx/thread.h}
@sa
wxThread, wxMutex, @ref overview_thread
@li wxIsMainThread
@li wxMutexGuiEnter
@li wxMutexGuiLeave
@section page_func_cat_file File functions
@header{wx/filefn.h}
@sa
wxPathList, wxDir, wxFile, wxFileName
@li wxDos2UnixFilename
@li wxFileExists
@li wxFileModificationTime
@li wxFileNameFromPath
@li wxFindFirstFile
@li wxFindNextFile
@li wxGetDiskSpace
@li wxGetFileKind
@li wxGetOSDirectory
@li wxIsAbsolutePath
@li wxDirExists
@li wxPathOnly
@li wxUnix2DosFilename
@li wxConcatFiles
@li wxCopyFile
@li wxGetCwd
@li wxGetWorkingDirectory
@li wxGetTempFileName
@li wxIsWild
@li wxMatchWild
@li wxMkdir
@li wxParseCommonDialogsFilter
@li wxRemoveFile
@li wxRenameFile
@li wxRmdir
@li wxSetWorkingDirectory
@li wxSplit
@li wxSplitPath
@li wxTransferFileToStream
@li wxTransferStreamToFile
@section page_func_cat_networkuseros Network, user and OS functions
The functions in this section are used to retrieve information about the current
computer and/or user characteristics.
@li wxGetEmailAddress
@li wxGetFreeMemory
@li wxGetFullHostName
@li wxGetHomeDir
@li wxGetHostName
@li wxGetOsDescription
@li wxGetOsVersion
@li wxIsPlatformLittleEndian
@li wxIsPlatform64Bit
@li wxGetUserHome
@li wxGetUserId
@li wxGetUserName
@section page_func_cat_string String functions
@li wxGetTranslation
@li wxIsEmpty
@li wxStrcmp
@li wxStricmp
@li wxStringEq
@li wxStringMatch
@li wxStringTokenize
@li wxStrlen
@li wxSnprintf
@li wxVsnprintf
@section page_func_cat_dialog Dialog functions
Below are a number of convenience functions for getting input from the user
or displaying messages. Note that in these functions the last three parameters
are optional. However, it is recommended to pass a parent frame parameter, or
(in MS Windows or Motif) the wrong window frame may be brought to the front when
the dialog box is popped up.
@li wxAboutBox
@li wxBeginBusyCursor
@li wxBell
@li wxCreateFileTipProvider
@li wxDirSelector
@li wxFileSelector
@li wxEndBusyCursor
@li wxGenericAboutBox
@li wxGetColourFromUser
@li wxGetFontFromUser
@li wxGetMultipleChoices
@li wxGetNumberFromUser
@li wxGetPasswordFromUser
@li wxGetTextFromUser
@li wxGetSingleChoice
@li wxGetSingleChoiceIndex
@li wxGetSingleChoiceData
@li wxInfoMessageBox
@li wxIsBusy
@li wxMessageBox
@li wxShowTip
@section page_func_cat_math Math functions
@header{wx/math.h}
@li wxFinite
@li wxIsNaN
@section page_func_cat_gdi GDI functions
The following are relevant to the GDI (Graphics Device Interface).
@header{gdicmn.h}
@li wxBITMAP
@li wxClientDisplayRect
@li wxColourDisplay
@li wxDisplayDepth
@li wxDisplaySize
@li wxDisplaySizeMM
@li wxDROP_ICON
@li wxICON
@li wxMakeMetafilePlaceable
@li wxSetCursor
@section page_func_cat_printer Printer settings
NB: These routines are obsolete and should no longer be used!
The following functions are used to control PostScript printing.
Under Windows, PostScript output can only be sent to a file.
@header{wx/dcps.h}
@li wxGetPrinterCommand
@li wxGetPrinterFile
@li wxGetPrinterMode
@li wxGetPrinterOptions
@li wxGetPrinterOrientation
@li wxGetPrinterPreviewCommand
@li wxGetPrinterScaling
@li wxGetPrinterTranslation
@li wxSetPrinterCommand
@li wxSetPrinterFile
@li wxSetPrinterMode
@li wxSetPrinterOptions
@li wxSetPrinterOrientation
@li wxSetPrinterPreviewCommand
@li wxSetPrinterScaling
@li wxSetPrinterTranslation
@section page_func_cat_clipboard Clipboard functions
These clipboard functions are implemented for Windows only.
The use of these functions is deprecated and the code is no longer maintained.
Use the wxClipboard class instead.
@header{wx/clipbrd.h}
@li wxClipboardOpen
@li wxCloseClipboard
@li wxEmptyClipboard
@li wxEnumClipboardFormats
@li wxGetClipboardData
@li wxGetClipboardFormatName
@li wxIsClipboardFormatAvailable
@li wxOpenClipboard
@li wxRegisterClipboardFormat
@li wxSetClipboardData
@section page_func_cat_misc Miscellaneous functions and macros
@li wxBase64Decode
@li wxBase64DecodedSize
@li wxBase64Encode
@li wxBase64EncodedSize
@li wxGetKeyState
@li wxNewId
@li wxRegisterId
@li wxDDECleanUp
@li wxDDEInitialize
@li wxEnableTopLevelWindows
@li wxFindMenuItemId
@li wxFindWindowByLabel
@li wxFindWindowByName
@li wxFindWindowAtPoint
@li wxFindWindowAtPointer
@li wxGetActiveWindow
@li wxGetBatteryState
@li wxGetDisplayName
@li wxGetPowerType
@li wxGetMousePosition
@li wxGetMouseState
@li wxGetStockLabel
@li wxGetTopLevelParent
@li wxLaunchDefaultBrowser
@li wxLoadUserResource
@li wxPostDelete
@li wxPostEvent
@li wxSetDisplayName
@li wxStripMenuCodes
@section page_func_cat_log Log functions
These functions provide a variety of logging functions: see @ref overview_log for
further information. The functions use (implicitly) the currently active log target,
so their descriptions here may not apply if the log target is not the standard one
(installed by wxWidgets in the beginning of the program).
@header{wx/log.h}
@li wxDebugMsg
@li wxError
@li wxFatalError
@li wxLogError
@li wxLogFatalError
@li wxLogWarning
@li wxLogMessage
@li wxLogVerbose
@li wxLogStatus
@li wxLogSysError
@li wxLogDebug
@li wxLogTrace
@li wxSafeShowMessage
@li wxSysErrorCode
@li wxSysErrorMsg
@li wxTrace
@li wxTraceLevel
@section page_func_cat_time Time functions
The functions in this section deal with getting the current time and sleeping
for the specified time interval.
@li wxGetLocalTime
@li wxGetLocalTimeMillis
@li wxGetUTCTime
@li wxMicroSleep
@li wxMilliSleep
@li wxNow
@li wxSleep
@li wxUsleep
@section page_func_cat_debug Debugging macros and functions
Useful macros and functions for error checking and defensive programming.
wxWidgets defines three families of the assert-like macros: the wxASSERT and wxFAIL
macros only do anything if __WXDEBUG__ is defined (in other words, in the debug build)
but disappear completely in the release build. On the other hand, the wxCHECK macros
stay event in release builds but a check failure doesn't generate any user-visible effects
then. Finally, the compile time assertions don't happen during the run-time but result
in the compilation error messages if the condition they check fail.
@header{wx/debug.h}
@li wxOnAssert
@li wxTrap
@li wxIsDebuggerRunning
@section page_func_cat_env Environment access functions
The functions in this section allow to access (get) or change value of environment
variables in a portable way. They are currently implemented under Win32 and
POSIX-like systems (Unix).
@header{wx/utils.h}
@li wxGetenv
@li wxGetEnv
@li wxSetEnv
@li wxUnsetEnv
@section page_func_cat_atomic Atomic operation functions
When using multi-threaded applications, it is often required to access or modify
memory which is shared between threads. Atomic integer and pointer operations are
an efficient way to handle this issue (another, less efficient, way is to use a mutex
or critical section). A native implementation exists for Windows, Linux, Solaris and
Mac OS X, for other OS, a wxCriticalSection is used to protect the data.
One particular application is reference counting (used by so-called smart pointers).
You should define your variable with the type wxAtomicInt in order to apply atomic operations to it. @section page_func_cat_log Logging
@header{wx/atomic.h} These functions provide a variety of logging functions. The functions use
(implicitly) the currently active log target, so their descriptions here may
not apply if the log target is not the standard one (installed by wxWidgets in
the beginning of the program).
@li wxAtomicInc Related Overviews: @ref overview_log
@li wxAtomicDec
@header{wx/log.h}
@li ::wxDebugMsg()
@li ::wxError()
@li ::wxFatalError()
@li ::wxLogError()
@li ::wxLogFatalError()
@li ::wxLogWarning()
@li ::wxLogMessage()
@li ::wxLogVerbose()
@li ::wxLogStatus()
@li ::wxLogSysError()
@li ::wxLogDebug()
@li ::wxLogTrace()
@li ::wxSafeShowMessage()
@li ::wxSysErrorCode()
@li ::wxSysErrorMsg()
@li ::wxTrace()
@li ::wxTraceLevel()
@section page_func_cat_time Time
The functions in this section deal with getting the current time and sleeping
for the specified time interval.
@li ::wxGetLocalTime()
@li ::wxGetLocalTimeMillis()
@li ::wxGetUTCTime()
@li ::wxMicroSleep()
@li ::wxMilliSleep()
@li ::wxNow()
@li ::wxSleep()
@li ::wxUsleep()
@section page_func_cat_debug Debugging
Useful macros and functions for error checking and defensive programming.
wxWidgets defines three families of the assert-like macros: the wxASSERT and
wxFAIL macros only do anything if __WXDEBUG__ is defined (in other words, in
the debug build) but disappear completely in the release build. On the other
hand, the wxCHECK macros stay event in release builds but a check failure
doesn't generate any user-visible effects then. Finally, the compile time
assertions don't happen during the run-time but result in the compilation error
messages if the condition they check fail.
@header{wx/debug.h}
@li ::wxOnAssert()
@li ::wxTrap()
@li ::wxIsDebuggerRunning()
@section page_func_cat_env Environment
The functions in this section allow to access (get) or change value of
environment variables in a portable way. They are currently implemented under
Win32 and POSIX-like systems (Unix).
@header{wx/utils.h}
@li ::wxGetenv()
@li ::wxGetEnv()
@li ::wxSetEnv()
@li ::wxUnsetEnv()
@section page_func_cat_atomic Atomic Operations
When using multi-threaded applications, it is often required to access or
modify memory which is shared between threads. Atomic integer and pointer
operations are an efficient way to handle this issue (another, less efficient,
way is to use a mutex or critical section). A native implementation exists for
Windows, Linux, Solaris and Mac OS X, for other OS, a wxCriticalSection is used
to protect the data.
One particular application is reference counting (used by so-called smart
pointers).
You should define your variable with the type wxAtomicInt in order to apply
atomic operations to it.
@header{wx/atomic.h}
@li ::wxAtomicInc()
@li ::wxAtomicDec()
@section page_func_cat_misc Miscellaneous
@li ::wxBase64Decode()
@li ::wxBase64DecodedSize()
@li ::wxBase64Encode()
@li ::wxBase64EncodedSize()
@li ::wxGetKeyState()
@li ::wxNewId()
@li ::wxRegisterId()
@li ::wxDDECleanUp()
@li ::wxDDEInitialize()
@li ::wxEnableTopLevelWindows()
@li ::wxFindMenuItemId()
@li ::wxFindWindowByLabel()
@li ::wxFindWindowByName()
@li ::wxFindWindowAtPoint()
@li ::wxFindWindowAtPointer()
@li ::wxGetActiveWindow()
@li ::wxGetBatteryState()
@li ::wxGetDisplayName()
@li ::wxGetPowerType()
@li ::wxGetMousePosition()
@li ::wxGetMouseState()
@li ::wxGetStockLabel()
@li ::wxGetTopLevelParent()
@li ::wxLaunchDefaultBrowser()
@li ::wxLoadUserResource()
@li ::wxPostDelete()
@li ::wxPostEvent()
@li ::wxSetDisplayName()
@li ::wxStripMenuCodes()
*/ */

247
docs/doxygen/mainpages/cat_macros.h
View File

@@ -6,165 +6,158 @@
// Licence: wxWindows license // Licence: wxWindows license
///////////////////////////////////////////////////////////////////////////// /////////////////////////////////////////////////////////////////////////////
/**
/*! @page page_macro_cat Macros by Category
@page page_macro_cat Macros by category @li @ref page_macro_cat_version
@li @ref page_macro_cat_byteorder
A classification of wxWidgets macros by category. @li @ref page_macro_cat_rtti
@li @ref page_macro_cat_debugging
@li @ref page_macro_cat_version @li @ref page_macro_cat_misc
@li @ref page_macro_cat_misc
@li @ref page_macro_cat_byteorder
@li @ref page_macro_cat_rtti
@li @ref page_macro_cat_debugging
<hr> <hr>
@section page_macro_cat_version Versioning
@section page_macro_cat_version Version macros The following constants are defined in wxWidgets:
The following constants are defined in wxWidgets: @li wxMAJOR_VERSION is the major version of wxWidgets
@li wxMINOR_VERSION is the minor version of wxWidgets
@li wxRELEASE_NUMBER is the release number
@li wxSUBRELEASE_NUMBER is the subrelease number which is @c 0 for all
official releases
@li @c wxMAJOR_VERSION is the major version of wxWidgets For example, the values or these constants for wxWidgets 2.8.7
@li @c wxMINOR_VERSION is the minor version of wxWidgets are 2, 8, 7 and 0.
@li @c wxRELEASE_NUMBER is the release number
@li @c wxSUBRELEASE_NUMBER is the subrelease number which is @c 0
for all official releases
For example, the values or these constants for wxWidgets 2.8.7 Additionally, wxVERSION_STRING is a user-readable string containing the full
are 2, 8, 7 and 0. wxWidgets version and wxVERSION_NUMBER is a combination of the three version
numbers above: for 2.1.15, it is 2115 and it is 2200 for wxWidgets 2.2.
Additionally, @c wxVERSION_STRING is a user-readable string containing The subrelease number is only used for the sources in between official releases
the full wxWidgets version and @c wxVERSION_NUMBER is a combination of the and so normally is not useful.
three version numbers above: for 2.1.15, it is 2115 and it is 2200 for
wxWidgets 2.2.
The subrelease number is only used for the sources in between official releases @header{wx/version.h}
and so normally is not useful. @header{wx/defs.h}
@header{wx/version.h} @li wxCHECK_GCC_VERSION
@header{wx/defs.h} @li wxCHECK_SUNCC_VERSION
@li wxCHECK_VERSION
@li wxCHECK_GCC_VERSION @li wxCHECK_VERSION_FULL
@li wxCHECK_SUNCC_VERSION @li wxCHECK_VISUALC_VERSION
@li wxCHECK_VERSION @li wxCHECK_W32API_VERSION
@li wxCHECK_VERSION_FULL
@li wxCHECK_VISUALC_VERSION
@li wxCHECK_W32API_VERSION
@section page_macro_cat_misc Miscellaneous macros @section page_macro_cat_misc Miscellaneous
@header{FIXME} @header{FIXME}
@li wxCONCAT @li wxCONCAT
@li wxDECLARE_APP @li wxDECLARE_APP
@li wxDYNLIB_FUNCTION @li wxDYNLIB_FUNCTION
@li wxDEPRECATED @li wxDEPRECATED
@li wxDEPRECATED_BUT_USED_INTERNALLY @li wxDEPRECATED_BUT_USED_INTERNALLY
@li wxDEPRECATED_INLINE @li wxDEPRECATED_INLINE
@li wxEXPLICIT @li wxEXPLICIT
@li wxON_BLOCK_EXIT @li wxON_BLOCK_EXIT
@li wxON_BLOCK_EXIT_OBJ @li wxON_BLOCK_EXIT_OBJ
@li wxSTRINGIZE @li wxSTRINGIZE
@li wxSTRINGIZE_T @li wxSTRINGIZE_T
@li wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING @li wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING
@li __WXFUNCTION__ @li __WXFUNCTION__
@li wxS @li wxS
@li wxT @li wxT
@li wxTRANSLATE @li wxTRANSLATE
@li _ @li _
@li wxPLURAL @li wxPLURAL
@li _T @li _T
@li WXTRACE @li WXTRACE
@li WXTRACELEVEL @li WXTRACELEVEL
@section page_macro_cat_byteorder Byte order macros @section page_macro_cat_byteorder Byte Order
@header{FIXME} @header{FIXME}
The endian-ness issues (that is the difference between big-endian The endian-ness issues (that is the difference between big-endian and
and little-endian architectures) are important for the portable little-endian architectures) are important for the portable programs working
programs working with the external binary data (for example, data with the external binary data (for example, data files or data coming from
files or data coming from network) which is usually in some fixed, network) which is usually in some fixed, platform-independent format.
platform-independent format.
The macros are helpful for transforming the data to the correct format. The macros are helpful for transforming the data to the correct format.
@li wxINTXX_SWAP_ALWAYS @li wxINTXX_SWAP_ALWAYS
@li wxINTXX_SWAP_ON_BE @li wxINTXX_SWAP_ON_BE
@li wxINTXX_SWAP_ON_LE @li wxINTXX_SWAP_ON_LE
@li wxFORCE_LINK_THIS_MODULE @li wxFORCE_LINK_THIS_MODULE
@li wxFORCE_LINK_MODULE @li wxFORCE_LINK_MODULE
@li wxIMPLEMENT_APP @li wxIMPLEMENT_APP
@section page_macro_cat_rtti RTTI macros @section page_macro_cat_rtti Runtime Type Information (RTTI)
wxWidgets uses its own RTTI ("run-time type identification") system wxWidgets uses its own RTTI ("run-time type identification") system which
which predates the current standard C++ RTTI and so is kept for backwards predates the current standard C++ RTTI and so is kept for backwards
compatibility reasons but also because it allows some things which the compatibility reasons but also because it allows some things which the standard
standard RTTI doesn't directly support (such as creating a class from its name). RTTI doesn't directly support (such as creating a class from its name). The
The standard C++ RTTI can be used in the user code without any problems and in standard C++ RTTI can be used in the user code without any problems and in
general you shouldn't need to use the functions and the macros in this section general you shouldn't need to use the functions and the macros in this section
unless you are thinking of modifying or adding any wxWidgets classes. unless you are thinking of modifying or adding any wxWidgets classes.
@sa Related Overviews: @ref overview_rtti
@ref overview_rtti
@li CLASSINFO @li #CLASSINFO
@li DECLARE_ABSTRACT_CLASS @li #DECLARE_ABSTRACT_CLASS
@li DECLARE_APP @li #DECLARE_APP
@li DECLARE_CLASS @li #DECLARE_CLASS
@li DECLARE_DYNAMIC_CLASS @li #DECLARE_DYNAMIC_CLASS
@li IMPLEMENT_ABSTRACT_CLASS @li #IMPLEMENT_ABSTRACT_CLASS
@li IMPLEMENT_ABSTRACT_CLASS2 @li #IMPLEMENT_ABSTRACT_CLASS2
@li IMPLEMENT_APP @li #IMPLEMENT_APP
@li IMPLEMENT_CLASS @li #IMPLEMENT_CLASS
@li IMPLEMENT_CLASS2 @li #IMPLEMENT_CLASS2
@li IMPLEMENT_DYNAMIC_CLASS @li #IMPLEMENT_DYNAMIC_CLASS
@li IMPLEMENT_DYNAMIC_CLASS2 @li #IMPLEMENT_DYNAMIC_CLASS2
@li wxConstCast @li #wxConstCast
@li ::wxCreateDynamicObject @li ::wxCreateDynamicObject
@li WXDEBUG_NEW @li #WXDEBUG_NEW
@li wxDynamicCast @li #wxDynamicCast
@li wxDynamicCastThis @li #wxDynamicCastThis
@li wxStaticCast @li #wxStaticCast
@li wx_const_cast @li #wx_const_cast
@li wx_reinterpret_cast @li #wx_reinterpret_cast
@li wx_static_cast @li #wx_static_cast
@li wx_truncate_cast @li #wx_truncate_cast
@section page_macro_cat_debugging Debugging macros @section page_macro_cat_debugging Debugging
Useful macros and functions for error checking and defensive programming. Useful macros and functions for error checking and defensive programming.
wxWidgets defines three families of the assert-like macros: the wxASSERT wxWidgets defines three families of the assert-like macros: the wxASSERT and
and wxFAIL macros only do anything if __WXDEBUG__ is defined (in other words, wxFAIL macros only do anything if __WXDEBUG__ is defined (in other words, in
in the debug build) but disappear completely in the release build. On the other the debug build) but disappear completely in the release build. On the other
hand, the wxCHECK macros stay event in release builds but a check failure doesn't hand, the wxCHECK macros stay event in release builds but a check failure
generate any user-visible effects then. Finally, the compile time assertions doesn't generate any user-visible effects then. Finally, the compile time
don't happen during the run-time but result in the compilation error messages assertions don't happen during the run-time but result in the compilation error
if the condition they check fail. messages if the condition they check fail.
@header{wx/debug.h} @header{wx/debug.h}
@li wxASSERT
@li wxASSERT_MIN_BITSIZE
@li wxASSERT_MSG
@li wxCOMPILE_TIME_ASSERT
@li wxCOMPILE_TIME_ASSERT2
@li wxFAIL
@li wxFAIL_MSG
@li wxCHECK
@li wxCHECK_MSG
@li wxCHECK_RET
@li wxCHECK2
@li wxCHECK2_MSG
@li wxASSERT
@li wxASSERT_MIN_BITSIZE
@li wxASSERT_MSG
@li wxCOMPILE_TIME_ASSERT
@li wxCOMPILE_TIME_ASSERT2
@li wxFAIL
@li wxFAIL_MSG
@li wxCHECK
@li wxCHECK_MSG
@li wxCHECK_RET
@li wxCHECK2
@li wxCHECK2_MSG
*/ */

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

@@ -8,7 +8,7 @@
/*! /*!
@page overview_rtti Runtime Class Information (RTTI) @page overview_rtti Runtime Type Information (RTTI)
@li @ref overview_rtti_intro @li @ref overview_rtti_intro
@li @ref overview_rtti_classinfo @li @ref overview_rtti_classinfo
@@ -25,7 +25,7 @@
@section overview_rtti_intro Introduction @section overview_rtti_intro Introduction
One of the failings of C++ used to be that no run-time information was provided One of the failings of C++ used to be that no runtime information was provided
about a class and its position in the inheritance hierarchy. Another, which about a class and its position in the inheritance hierarchy. Another, which
still persists, is that instances of a class cannot be created just by knowing still persists, is that instances of a class cannot be created just by knowing
the name of a class, which makes facilities such as persistent storage hard to the name of a class, which makes facilities such as persistent storage hard to
@@ -76,7 +76,7 @@ wxClassInfo object instead, then you can simply call wxClassInfo::CreateObject.
@section overview_rtti_classinfo wxClassInfo @section overview_rtti_classinfo wxClassInfo
This class stores meta-information about classes. An application may use macros This class stores meta-information about classes. An application may use macros
such as DECLARE_DYNAMIC_CLASS and IMPLEMENT_DYNAMIC_CLASS to record run-time such as DECLARE_DYNAMIC_CLASS and IMPLEMENT_DYNAMIC_CLASS to record runtime
information about a class, including: information about a class, including:
@li It's position in the inheritance hierarchy. @li It's position in the inheritance hierarchy.

9
interface/gdicmn.h
View File

@@ -739,7 +739,9 @@ public:
// Global functions/macros // Global functions/macros
// ============================================================================ // ============================================================================
/** @addtogroup group_gdi */
//@{ //@{
/** /**
Returns the dimensions of the work area on the display. On Windows Returns the dimensions of the work area on the display. On Windows
this means the area not covered by the taskbar, etc. Other platforms this means the area not covered by the taskbar, etc. Other platforms
@@ -749,23 +751,18 @@ public:
void wxClientDisplayRect(int* x, int* y, int* width, void wxClientDisplayRect(int* x, int* y, int* width,
int* height); int* height);
wxRect wxGetClientDisplayRect(); wxRect wxGetClientDisplayRect();
//@}
//@{
/** /**
Returns the display size in pixels. Returns the display size in pixels.
*/ */
void wxDisplaySize(int* width, int* height); void wxDisplaySize(int* width, int* height);
wxSize wxGetDisplaySize(); wxSize wxGetDisplaySize();
//@}
//@{
/** /**
Returns the display size in millimeters. Returns the display size in millimeters.
*/ */
void wxDisplaySizeMM(int* width, int* height); void wxDisplaySizeMM(int* width, int* height);
wxSize wxGetDisplaySizeMM(); wxSize wxGetDisplaySizeMM();
//@}
/** /**
This macro loads an icon from either application resources (on the platforms This macro loads an icon from either application resources (on the platforms
@@ -795,3 +792,5 @@ bool wxColourDisplay();
*/ */
int wxDisplayDepth(); int wxDisplayDepth();
//@}

27
interface/metafile.h
View File

@@ -117,15 +117,19 @@ public:
// Global functions/macros // Global functions/macros
// ============================================================================ // ============================================================================
/** @addtogroup group_gdi */
//@{
/** /**
@header{wx/metafile.h}
Given a filename for an existing, valid metafile (as constructed using Given a filename for an existing, valid metafile (as constructed using
wxMetafileDC) wxMetafileDC) makes it into a placeable metafile by prepending a header
makes it into a placeable metafile by prepending a header containing the given containing the given bounding box. The bounding box may be obtained from a
bounding box. The bounding box may be obtained from a device context after device context after drawing into it, using the functions wxDC::MinX(),
drawing wxDC::MinY(), wxDC::MaxX() and wxDC::MaxY(). In addition to adding the
into it, using the functions wxDC::MinX, wxDC::MinY, wxDC::MaxX and wxDC::MaxY. placeable metafile header, this function adds the equivalent of the
In addition to adding the placeable metafile header, this function adds following code to the start of the metafile data:
the equivalent of the following code to the start of the metafile data:
@code @code
SetMapMode(dc, MM_ANISOTROPIC); SetMapMode(dc, MM_ANISOTROPIC);
@@ -134,10 +138,9 @@ public:
@endcode @endcode
This simulates the wxMM_TEXT mapping mode, which wxWidgets assumes. This simulates the wxMM_TEXT mapping mode, which wxWidgets assumes.
Placeable metafiles may be imported by many Windows applications, and can be Placeable metafiles may be imported by many Windows applications, and can
used in RTF (Rich Text Format) files. be used in RTF (Rich Text Format) files. @a scale allows the specification
@a scale allows the specification of scale for the metafile. of scale for the metafile. This function is only available under Windows.
This function is only available under Windows.
*/ */
bool wxMakeMetafilePlaceable(const wxString& filename, int minX, bool wxMakeMetafilePlaceable(const wxString& filename, int minX,
int minY, int minY,
@@ -145,3 +148,5 @@ bool wxMakeMetafilePlaceable(const wxString& filename, int minX,
int maxY, int maxY,
float scale = 1.0); float scale = 1.0);
//@}