added category pages for macros and functions
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52260 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
parent
0909f9a33e
commit
f446361445
@ -1,5 +1,5 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: categories.h
|
||||
// Name: cat_classes.h
|
||||
// Purpose: Classes-by-category page of the Doxygen manual
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
@ -9,50 +9,50 @@
|
||||
|
||||
/*!
|
||||
|
||||
@page page_categories Classes by category
|
||||
@page page_class_cat Classes by category
|
||||
|
||||
A classification of wxWidgets classes by category.
|
||||
|
||||
@beginInvisibleTable
|
||||
<tr><td>
|
||||
@li @ref page_categories_manwnd
|
||||
@li @ref page_categories_miscwnd
|
||||
@li @ref page_categories_cmndlg
|
||||
@li @ref page_categories_ctrl
|
||||
@li @ref page_categories_miscpickers
|
||||
@li @ref page_categories_menus
|
||||
@li @ref page_categories_wxaui
|
||||
@li @ref page_categories_winlayout
|
||||
@li @ref page_categories_dc
|
||||
@li @ref page_categories_gdi
|
||||
@li @ref page_categories_events
|
||||
@li @ref page_categories_val
|
||||
@li @ref page_categories_data
|
||||
@li @ref page_categories_containers
|
||||
@li @ref page_categories_smartpointers
|
||||
@li @ref page_categories_rtti
|
||||
@li @ref page_categories_logging
|
||||
@li @ref page_categories_debugging
|
||||
@li @ref page_categories_net
|
||||
@li @ref page_class_cat_manwnd
|
||||
@li @ref page_class_cat_miscwnd
|
||||
@li @ref page_class_cat_cmndlg
|
||||
@li @ref page_class_cat_ctrl
|
||||
@li @ref page_class_cat_miscpickers
|
||||
@li @ref page_class_cat_menus
|
||||
@li @ref page_class_cat_wxaui
|
||||
@li @ref page_class_cat_winlayout
|
||||
@li @ref page_class_cat_dc
|
||||
@li @ref page_class_cat_gdi
|
||||
@li @ref page_class_cat_events
|
||||
@li @ref page_class_cat_val
|
||||
@li @ref page_class_cat_data
|
||||
@li @ref page_class_cat_containers
|
||||
@li @ref page_class_cat_smartpointers
|
||||
@li @ref page_class_cat_rtti
|
||||
@li @ref page_class_cat_logging
|
||||
@li @ref page_class_cat_debugging
|
||||
@li @ref page_class_cat_net
|
||||
</td><td>
|
||||
@li @ref page_categories_ipc
|
||||
@li @ref page_categories_dvf
|
||||
@li @ref page_categories_printing
|
||||
@li @ref page_categories_dd
|
||||
@li @ref page_categories_file
|
||||
@li @ref page_categories_streams
|
||||
@li @ref page_categories_threading
|
||||
@li @ref page_categories_html
|
||||
@li @ref page_categories_rich
|
||||
@li @ref page_categories_stc
|
||||
@li @ref page_categories_vfs
|
||||
@li @ref page_categories_xml
|
||||
@li @ref page_categories_xrc
|
||||
@li @ref page_categories_help
|
||||
@li @ref page_categories_media
|
||||
@li @ref page_categories_gl
|
||||
@li @ref page_categories_appmanagement
|
||||
@li @ref page_categories_misc
|
||||
@li @ref page_class_cat_ipc
|
||||
@li @ref page_class_cat_dvf
|
||||
@li @ref page_class_cat_printing
|
||||
@li @ref page_class_cat_dd
|
||||
@li @ref page_class_cat_file
|
||||
@li @ref page_class_cat_streams
|
||||
@li @ref page_class_cat_threading
|
||||
@li @ref page_class_cat_html
|
||||
@li @ref page_class_cat_rich
|
||||
@li @ref page_class_cat_stc
|
||||
@li @ref page_class_cat_vfs
|
||||
@li @ref page_class_cat_xml
|
||||
@li @ref page_class_cat_xrc
|
||||
@li @ref page_class_cat_help
|
||||
@li @ref page_class_cat_media
|
||||
@li @ref page_class_cat_gl
|
||||
@li @ref page_class_cat_appmanagement
|
||||
@li @ref page_class_cat_misc
|
||||
</td></tr>
|
||||
@endTable
|
||||
|
||||
@ -60,7 +60,7 @@
|
||||
|
||||
|
||||
|
||||
@section page_categories_manwnd Managed windows
|
||||
@section page_class_cat_manwnd Managed windows
|
||||
|
||||
There are several types of window that are directly controlled by the
|
||||
window manager (such as MS Windows, or the Motif Window Manager).
|
||||
@ -80,7 +80,7 @@
|
||||
See also the @ref overview_cmndlg.
|
||||
|
||||
|
||||
@section page_categories_miscwnd Miscellaneous windows
|
||||
@section page_class_cat_miscwnd Miscellaneous windows
|
||||
|
||||
The following are a variety of classes that are derived from wxWindow.
|
||||
|
||||
@ -101,7 +101,7 @@
|
||||
@li wxWizardPageSimple: A page in wizard dialog.
|
||||
|
||||
|
||||
@section page_categories_cmndlg Common dialogs
|
||||
@section page_class_cat_cmndlg Common dialogs
|
||||
|
||||
@ref overview_cmndlg
|
||||
|
||||
@ -127,7 +127,7 @@
|
||||
@li wxWizard: A wizard dialog.
|
||||
|
||||
|
||||
@section page_categories_ctrl Controls
|
||||
@section page_class_cat_ctrl Controls
|
||||
|
||||
Typically, these are small windows which provide interaction with the user. Controls
|
||||
that are not static can have wxValidator associated with them.
|
||||
@ -173,7 +173,7 @@
|
||||
|
||||
|
||||
|
||||
@section page_categories_miscpickers Miscellaneous pickers
|
||||
@section page_class_cat_miscpickers Miscellaneous pickers
|
||||
|
||||
A picker control is a control whose appearance and behaviour is highly platform-dependent.
|
||||
|
||||
@ -185,7 +185,7 @@
|
||||
|
||||
|
||||
|
||||
@section page_categories_menus Menus
|
||||
@section page_class_cat_menus Menus
|
||||
|
||||
@li wxMenu: Displays a series of menu items for selection
|
||||
@li wxMenuBar: Contains a series of menus for use with a frame
|
||||
@ -193,7 +193,7 @@
|
||||
|
||||
|
||||
|
||||
@section page_categories_wxaui wxAUI - advanced user interface
|
||||
@section page_class_cat_wxaui wxAUI - advanced user interface
|
||||
|
||||
This is a new set of classes for writing a customizable application
|
||||
interface with built-in docking, floatable panes and a flexible
|
||||
@ -208,7 +208,7 @@
|
||||
|
||||
|
||||
|
||||
@section page_categories_winlayout Window layout
|
||||
@section page_class_cat_winlayout Window layout
|
||||
|
||||
There are two different systems for laying out windows (and dialogs in particular).
|
||||
One is based upon so-called sizers and it requires less typing, thinking and calculating
|
||||
@ -239,7 +239,7 @@
|
||||
@li wxLayoutAlgorithm: An alternative window layout facility
|
||||
|
||||
|
||||
@section page_categories_dc Device contexts
|
||||
@section page_class_cat_dc Device contexts
|
||||
|
||||
@ref overview_dc
|
||||
|
||||
@ -262,7 +262,7 @@
|
||||
@li wxPrinterDC: A device context for drawing to printers
|
||||
|
||||
|
||||
@section page_categories_gdi Graphics device interface
|
||||
@section page_class_cat_gdi Graphics device interface
|
||||
|
||||
@ref overview_bitmap
|
||||
|
||||
@ -287,7 +287,7 @@
|
||||
@li wxRendererNative: Abstracts high-level drawing primitives
|
||||
|
||||
|
||||
@section page_categories_events Events
|
||||
@section page_class_cat_events Events
|
||||
|
||||
@ref overview_eventhandling
|
||||
|
||||
@ -344,7 +344,7 @@
|
||||
@li wxWizardEvent: A wizard event
|
||||
|
||||
|
||||
@section page_categories_val Validators
|
||||
@section page_class_cat_val Validators
|
||||
|
||||
@ref overview_validator
|
||||
|
||||
@ -356,7 +356,7 @@
|
||||
@li wxGenericValidator: Generic control validator class
|
||||
|
||||
|
||||
@section page_categories_data Data structures
|
||||
@section page_class_cat_data Data structures
|
||||
|
||||
These are the data structure classes supported by wxWidgets.
|
||||
|
||||
@ -379,7 +379,7 @@
|
||||
@li wxVariant: A class for storing arbitrary types that may change at run-time
|
||||
|
||||
|
||||
@section page_categories_containers Container classes
|
||||
@section page_class_cat_containers Container classes
|
||||
|
||||
@ref overview_container
|
||||
|
||||
@ -395,7 +395,7 @@
|
||||
@li wxVector<T>: Template base vector implementation identical to std::vector
|
||||
|
||||
|
||||
@section page_categories_smartpointers Smart pointers
|
||||
@section page_class_cat_smartpointers Smart pointers
|
||||
|
||||
wxWidgets provides a few smart pointer class templates.
|
||||
|
||||
@ -405,7 +405,7 @@
|
||||
@li wxWeakRef<T>: A weak reference
|
||||
|
||||
|
||||
@section page_categories_rtti Run-time class information system
|
||||
@section page_class_cat_rtti Run-time class information system
|
||||
|
||||
@ref overview_runtimeclass
|
||||
|
||||
@ -417,7 +417,7 @@
|
||||
@li RTTI macros: Macros for manipulating run-time information
|
||||
|
||||
|
||||
@section page_categories_logging Logging features
|
||||
@section page_class_cat_logging Logging features
|
||||
|
||||
@ref overview_log
|
||||
|
||||
@ -438,7 +438,7 @@
|
||||
@li Log functions: Error and warning logging functions
|
||||
|
||||
|
||||
@section page_categories_debugging Debugging features
|
||||
@section page_class_cat_debugging Debugging features
|
||||
|
||||
@ref overview_debugging
|
||||
|
||||
@ -455,7 +455,7 @@
|
||||
@li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
|
||||
|
||||
|
||||
@section page_categories_net Networking classes
|
||||
@section page_class_cat_net Networking classes
|
||||
|
||||
wxWidgets provides its own classes for socket based networking.
|
||||
|
||||
@ -472,7 +472,7 @@
|
||||
|
||||
|
||||
|
||||
@section page_categories_ipc Interprocess communication
|
||||
@section page_class_cat_ipc Interprocess communication
|
||||
|
||||
@ref overview_ipc
|
||||
|
||||
@ -485,7 +485,7 @@
|
||||
|
||||
|
||||
|
||||
@section page_categories_dvf Document-view framework
|
||||
@section page_class_cat_dvf Document-view framework
|
||||
|
||||
@ref overview_docview
|
||||
|
||||
@ -502,7 +502,7 @@
|
||||
%@li wxMDIDocParentFrame: An MDI parent frame to contain views -->
|
||||
|
||||
|
||||
@section page_categories_printing Printing framework
|
||||
@section page_class_cat_printing Printing framework
|
||||
|
||||
@ref overview_printing
|
||||
|
||||
@ -525,7 +525,7 @@
|
||||
|
||||
|
||||
|
||||
@section page_categories_dd Drag and drop and clipboard classes
|
||||
@section page_class_cat_dd Drag and drop and clipboard classes
|
||||
|
||||
@ref overview_dnd
|
||||
|
||||
@ -543,7 +543,7 @@
|
||||
@li wxDropSource: Drop source class
|
||||
|
||||
|
||||
@section page_categories_file File related classes
|
||||
@section page_class_cat_file File related classes
|
||||
|
||||
wxWidgets has several small classes to work with disk files, see
|
||||
@ref overview_file for more details.
|
||||
@ -559,7 +559,7 @@
|
||||
@li wxPathList: A class to help search multiple paths
|
||||
|
||||
|
||||
@section page_categories_streams Stream classes
|
||||
@section page_class_cat_streams Stream classes
|
||||
|
||||
wxWidgets has its own set of stream classes, as an alternative to often buggy standard stream
|
||||
libraries, and to provide enhanced functionality.
|
||||
@ -596,7 +596,7 @@
|
||||
@li wxSocketOutputStream: Socket output stream class
|
||||
|
||||
|
||||
@section page_categories_threading Threading classes
|
||||
@section page_class_cat_threading Threading classes
|
||||
|
||||
@ref overview_thread
|
||||
|
||||
@ -613,7 +613,7 @@
|
||||
@li wxSemaphore: Semaphore class
|
||||
|
||||
|
||||
@section page_categories_html HTML classes
|
||||
@section page_class_cat_html HTML classes
|
||||
|
||||
wxWidgets provides a set of classes to display text in HTML format. These
|
||||
class include a help system based on the HTML widget.
|
||||
@ -628,7 +628,7 @@
|
||||
@li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
|
||||
|
||||
|
||||
@section page_categories_rich Rich text classes
|
||||
@section page_class_cat_rich Rich text classes
|
||||
|
||||
wxWidgets provides a set of generic classes to edit and print simple rich text with character
|
||||
and paragraph formatting.
|
||||
@ -654,7 +654,7 @@
|
||||
@li wxRichTextHeaderFooterData: Header and footer data specification.
|
||||
|
||||
|
||||
@section page_categories_stc Scintilla text editor classes
|
||||
@section page_class_cat_stc Scintilla text editor classes
|
||||
|
||||
wxWidgets also provides a wrapper around the Scintilla text editor control, which is
|
||||
a control for plain-text editing with support for highlighting, smart indentation, etc.
|
||||
@ -662,7 +662,7 @@
|
||||
@li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code editing component.
|
||||
|
||||
|
||||
@section page_categories_vfs Virtual file system classes
|
||||
@section page_class_cat_vfs Virtual file system classes
|
||||
|
||||
wxWidgets provides a set of classes that implement an extensible virtual file system,
|
||||
used internally by the HTML classes.
|
||||
@ -672,14 +672,14 @@
|
||||
@li wxFileSystemHandler: Class used to announce file system type
|
||||
|
||||
|
||||
@section page_categories_xml XML classes
|
||||
@section page_class_cat_xml XML classes
|
||||
|
||||
@li wxXmlDocument: A class to parse XML files
|
||||
@li wxXmlNode: A class which represents XML nodes
|
||||
@li wxXmlAttribute: A class which represent an XML attribute
|
||||
|
||||
|
||||
@section page_categories_xrc XML-based resource system classes
|
||||
@section page_class_cat_xrc XML-based resource system classes
|
||||
|
||||
@ref overview_xrc
|
||||
|
||||
@ -690,7 +690,7 @@
|
||||
@li wxXmlResourceHandler: The base class for XML resource handlers
|
||||
|
||||
|
||||
@section page_categories_help Online help
|
||||
@section page_class_cat_help Online help
|
||||
|
||||
@li wxHelpController: Family of classes for controlling help windows
|
||||
@li wxHtmlHelpController: HTML help controller class
|
||||
@ -702,18 +702,18 @@
|
||||
@li wxToolTip: Class implementing tooltips
|
||||
|
||||
|
||||
@section page_categories_media Multimedia classes
|
||||
@section page_class_cat_media Multimedia classes
|
||||
|
||||
@li wxMediaCtrl: Display multimedia contents.
|
||||
|
||||
|
||||
@section page_categories_gl OpenGL classes
|
||||
@section page_class_cat_gl OpenGL classes
|
||||
|
||||
@li wxGLCanvas: Canvas that you can render OpenGL calls to.
|
||||
@li wxGLContext: Class to ease sharing of OpenGL data resources.
|
||||
|
||||
|
||||
@section page_categories_appmanagement Application and process-management classes
|
||||
@section page_class_cat_appmanagement Application and process-management classes
|
||||
|
||||
@li wxApp: Application class
|
||||
@li wxCmdLineParser: Command line parser class
|
||||
@ -721,7 +721,7 @@
|
||||
@li wxProcess: Process class
|
||||
|
||||
|
||||
@section page_categories_misc Miscellaneous
|
||||
@section page_class_cat_misc Miscellaneous
|
||||
|
||||
@li wxCaret: A caret (cursor) object
|
||||
@li wxConfigBase: Classes for reading/writing the configuration settings
|
||||
327
docs/doxygen/mainpages/cat_functions.h
Normal file
327
docs/doxygen/mainpages/cat_functions.h
Normal file
@ -0,0 +1,327 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: cat_functions.h
|
||||
// Purpose: Functions-by-category page of the Doxygen manual
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
||||
/*!
|
||||
|
||||
@page page_func_cat Functions by category
|
||||
|
||||
A classification of wxWidgets 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_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
|
||||
|
||||
|
||||
<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.
|
||||
::wxEntry
|
||||
::wxEntryCleanup
|
||||
::wxEntryStart
|
||||
::wxGetApp
|
||||
::wxHandleFatalExceptions
|
||||
::wxInitAllImageHandlers
|
||||
::wxInitialize
|
||||
::wxSafeYield
|
||||
::wxUninitialize
|
||||
::wxYield
|
||||
::wxWakeUpIdle
|
||||
|
||||
|
||||
@section page_func_cat_procctrl Process control functions
|
||||
The functions in this section are used to launch or terminate the other processes.
|
||||
::wxExecute
|
||||
::wxExit
|
||||
::wxJoin
|
||||
::wxKill
|
||||
::wxGetProcessId
|
||||
::wxShell
|
||||
::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.
|
||||
Include files
|
||||
<wx/thread.h>
|
||||
See also
|
||||
wxThread, wxMutex, Multithreading overview
|
||||
|
||||
::wxIsMainThread
|
||||
::wxMutexGuiEnter
|
||||
::wxMutexGuiLeave
|
||||
|
||||
@section page_func_cat_file File functions
|
||||
Include files
|
||||
<wx/filefn.h>
|
||||
See also
|
||||
wxPathList
|
||||
wxDir
|
||||
wxFile
|
||||
wxFileName
|
||||
|
||||
::wxDos2UnixFilename
|
||||
::wxFileExists
|
||||
::wxFileModificationTime
|
||||
::wxFileNameFromPath
|
||||
::wxFindFirstFile
|
||||
::wxFindNextFile
|
||||
::wxGetDiskSpace
|
||||
::wxGetFileKind
|
||||
::wxGetOSDirectory
|
||||
::wxIsAbsolutePath
|
||||
::wxDirExists
|
||||
::wxPathOnly
|
||||
::wxUnix2DosFilename
|
||||
::wxConcatFiles
|
||||
::wxCopyFile
|
||||
::wxGetCwd
|
||||
::wxGetWorkingDirectory
|
||||
::wxGetTempFileName
|
||||
::wxIsWild
|
||||
::wxMatchWild
|
||||
::wxMkdir
|
||||
::wxParseCommonDialogsFilter
|
||||
::wxRemoveFile
|
||||
::wxRenameFile
|
||||
::wxRmdir
|
||||
::wxSetWorkingDirectory
|
||||
::wxSplit
|
||||
::wxSplitPath
|
||||
::wxTransferFileToStream
|
||||
::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.
|
||||
::wxGetEmailAddress
|
||||
::wxGetFreeMemory
|
||||
::wxGetFullHostName
|
||||
::wxGetHomeDir
|
||||
::wxGetHostName
|
||||
::wxGetOsDescription
|
||||
::wxGetOsVersion
|
||||
::wxIsPlatformLittleEndian
|
||||
::wxIsPlatform64Bit
|
||||
::wxGetUserHome
|
||||
::wxGetUserId
|
||||
::wxGetUserName
|
||||
|
||||
|
||||
@section page_func_cat_string String functions
|
||||
::wxGetTranslation
|
||||
::wxIsEmpty
|
||||
wxS
|
||||
::wxStrcmp
|
||||
::wxStricmp
|
||||
::wxStringEq
|
||||
::wxStringMatch
|
||||
::wxStringTokenize
|
||||
::wxStrlen
|
||||
::wxSnprintf
|
||||
wxT
|
||||
wxTRANSLATE
|
||||
::wxVsnprintf
|
||||
_
|
||||
wxPLURAL
|
||||
_T
|
||||
|
||||
@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.
|
||||
::wxAboutBox
|
||||
::wxBeginBusyCursor
|
||||
::wxBell
|
||||
::wxCreateFileTipProvider
|
||||
::wxDirSelector
|
||||
::wxFileSelector
|
||||
::wxEndBusyCursor
|
||||
::wxGenericAboutBox
|
||||
::wxGetColourFromUser
|
||||
::wxGetFontFromUser
|
||||
::wxGetMultipleChoices
|
||||
::wxGetNumberFromUser
|
||||
::wxGetPasswordFromUser
|
||||
::wxGetTextFromUser
|
||||
::wxGetSingleChoice
|
||||
::wxGetSingleChoiceIndex
|
||||
::wxGetSingleChoiceData
|
||||
::wxInfoMessageBox
|
||||
::wxIsBusy
|
||||
::wxMessageBox
|
||||
::wxShowTip
|
||||
|
||||
@section page_func_cat_math Math functions
|
||||
Include files
|
||||
<wx/math.h>
|
||||
wxFinite
|
||||
wxIsNaN
|
||||
|
||||
@section page_func_cat_gdi GDI functions
|
||||
The following are relevant to the GDI (Graphics Device Interface).
|
||||
Include files
|
||||
<wx/gdicmn.h>
|
||||
wxBITMAP
|
||||
::wxClientDisplayRect
|
||||
::wxColourDisplay
|
||||
::wxDisplayDepth
|
||||
::wxDisplaySize
|
||||
::wxDisplaySizeMM
|
||||
::wxDROP_ICON
|
||||
wxICON
|
||||
::wxMakeMetafilePlaceable
|
||||
::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.
|
||||
Include files
|
||||
<wx/dcps.h>
|
||||
::wxGetPrinterCommand
|
||||
::wxGetPrinterFile
|
||||
::wxGetPrinterMode
|
||||
::wxGetPrinterOptions
|
||||
::wxGetPrinterOrientation
|
||||
::wxGetPrinterPreviewCommand
|
||||
::wxGetPrinterScaling
|
||||
::wxGetPrinterTranslation
|
||||
::wxSetPrinterCommand
|
||||
::wxSetPrinterFile
|
||||
::wxSetPrinterMode
|
||||
::wxSetPrinterOptions
|
||||
::wxSetPrinterOrientation
|
||||
::wxSetPrinterPreviewCommand
|
||||
::wxSetPrinterScaling
|
||||
::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.
|
||||
Include files
|
||||
<wx/clipbrd.h>
|
||||
::wxClipboardOpen
|
||||
::wxCloseClipboard
|
||||
::wxEmptyClipboard
|
||||
::wxEnumClipboardFormats
|
||||
::wxGetClipboardData
|
||||
::wxGetClipboardFormatName
|
||||
::wxIsClipboardFormatAvailable
|
||||
::wxOpenClipboard
|
||||
::wxRegisterClipboardFormat
|
||||
::wxSetClipboardData
|
||||
|
||||
@section page_func_cat_misc Miscellaneous functions and macros
|
||||
::wxBase64Decode
|
||||
::wxBase64DecodedSize
|
||||
::wxBase64Encode
|
||||
::wxBase64EncodedSize
|
||||
::wxGetKeyState
|
||||
::wxNewId
|
||||
::wxRegisterId
|
||||
::wxDDECleanUp
|
||||
::wxDDEInitialize
|
||||
::wxEnableTopLevelWindows
|
||||
::wxFindMenuItemId
|
||||
::wxFindWindowByLabel
|
||||
::wxFindWindowByName
|
||||
::wxFindWindowAtPoint
|
||||
::wxFindWindowAtPointer
|
||||
::wxGetActiveWindow
|
||||
::wxGetBatteryState
|
||||
::wxGetDisplayName
|
||||
::wxGetPowerType
|
||||
::wxGetMousePosition
|
||||
::wxGetMouseState
|
||||
::wxGetStockLabel
|
||||
::wxGetTopLevelParent
|
||||
::wxLaunchDefaultBrowser
|
||||
::wxLoadUserResource
|
||||
::wxPostDelete
|
||||
::wxPostEvent
|
||||
::wxSetDisplayName
|
||||
::wxStripMenuCodes
|
||||
|
||||
|
||||
@section page_func_cat_log Log functions
|
||||
These functions provide a variety of logging functions: see Log classes overview 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).
|
||||
Include files
|
||||
<wx/log.h>
|
||||
::wxDebugMsg
|
||||
::wxError
|
||||
::wxFatalError
|
||||
::wxLogError
|
||||
::wxLogFatalError
|
||||
::wxLogWarning
|
||||
::wxLogMessage
|
||||
::wxLogVerbose
|
||||
::wxLogStatus
|
||||
::wxLogSysError
|
||||
::wxLogDebug
|
||||
::wxLogTrace
|
||||
::wxSafeShowMessage
|
||||
::wxSysErrorCode
|
||||
::wxSysErrorMsg
|
||||
WXTRACE
|
||||
WXTRACELEVEL
|
||||
::wxTrace
|
||||
::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.
|
||||
::wxGetLocalTime
|
||||
::wxGetLocalTimeMillis
|
||||
::wxGetUTCTime
|
||||
::wxMicroSleep
|
||||
::wxMilliSleep
|
||||
::wxNow
|
||||
::wxSleep
|
||||
::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.
|
||||
Include files
|
||||
<wx/debug.h>
|
||||
::wxOnAssert
|
||||
::wxTrap
|
||||
::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).
|
||||
Include files
|
||||
<wx/utils.h>
|
||||
wxGetenv
|
||||
wxGetEnv
|
||||
wxSetEnv
|
||||
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.
|
||||
Include files
|
||||
<wx/atomic.h>
|
||||
::wxAtomicInc
|
||||
::wxAtomicDec
|
||||
|
||||
*/
|
||||
163
docs/doxygen/mainpages/cat_macros.h
Normal file
163
docs/doxygen/mainpages/cat_macros.h
Normal file
@ -0,0 +1,163 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: cat_macros.h
|
||||
// Purpose: Macros-by-category page of the Doxygen manual
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
|
||||
/*!
|
||||
|
||||
@page page_macro_cat Macros by category
|
||||
|
||||
A classification of wxWidgets macros by category.
|
||||
|
||||
@li @ref page_macro_cat_version
|
||||
@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>
|
||||
|
||||
|
||||
|
||||
@section page_macro_cat_version Version macros
|
||||
|
||||
The following constants are defined in wxWidgets:
|
||||
|
||||
@li @c wxMAJOR_VERSION is the major version of wxWidgets
|
||||
@li @c wxMINOR_VERSION is the minor version of wxWidgets
|
||||
@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
|
||||
are 2, 8, 7 and 0.
|
||||
|
||||
Additionally, @c wxVERSION_STRING is a user-readable string containing
|
||||
the full wxWidgets version and @c 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.
|
||||
|
||||
The subrelease number is only used for the sources in between official releases
|
||||
and so normally is not useful.
|
||||
|
||||
@header{wx/version.h}
|
||||
@header{wx/defs.h}
|
||||
|
||||
@li wxCHECK_GCC_VERSION
|
||||
@li wxCHECK_SUNCC_VERSION
|
||||
@li wxCHECK_VERSION
|
||||
@li wxCHECK_VERSION_FULL
|
||||
@li wxCHECK_VISUALC_VERSION
|
||||
@li wxCHECK_W32API_VERSION
|
||||
|
||||
|
||||
@section page_macro_cat_misc Miscellaneous macros
|
||||
|
||||
@header{FIXME}
|
||||
|
||||
@li wxCONCAT
|
||||
@li wxDECLARE_APP
|
||||
@li wxDYNLIB_FUNCTION
|
||||
@li wxDEPRECATED
|
||||
@li wxDEPRECATED_BUT_USED_INTERNALLY
|
||||
@li wxDEPRECATED_INLINE
|
||||
@li wxEXPLICIT
|
||||
@li wxON_BLOCK_EXIT
|
||||
@li wxON_BLOCK_EXIT_OBJ
|
||||
@li wxSTRINGIZE
|
||||
@li wxSTRINGIZE_T
|
||||
@li wxSUPPRESS_GCC_PRIVATE_DTOR_WARNING
|
||||
@li __WXFUNCTION__
|
||||
|
||||
|
||||
|
||||
@section page_macro_cat_byteorder Byte order macros
|
||||
|
||||
@header{FIXME}
|
||||
|
||||
The endian-ness issues (that is the difference between big-endian
|
||||
and little-endian architectures) are important for the portable
|
||||
programs working with the external binary data (for example, data
|
||||
files or data coming from network) which is usually in some fixed,
|
||||
platform-independent format.
|
||||
|
||||
The macros are helpful for transforming the data to the correct format.
|
||||
|
||||
@li wxINTXX_SWAP_ALWAYS
|
||||
@li wxINTXX_SWAP_ON_BE
|
||||
@li wxINTXX_SWAP_ON_LE
|
||||
@li wxFORCE_LINK_THIS_MODULE
|
||||
@li wxFORCE_LINK_MODULE
|
||||
@li wxIMPLEMENT_APP
|
||||
|
||||
|
||||
@section page_macro_cat_rtti RTTI macros
|
||||
|
||||
wxWidgets uses its own RTTI ("run-time type identification") system
|
||||
which predates the current standard C++ RTTI and so is kept for backwards
|
||||
compatibility reasons but also because it allows some things which the
|
||||
standard RTTI doesn't directly support (such as creating a class from its name).
|
||||
The 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
|
||||
unless you are thinking of modifying or adding any wxWidgets classes.
|
||||
|
||||
@seealso
|
||||
@ref overview_rtti
|
||||
|
||||
@li CLASSINFO
|
||||
@li DECLARE_ABSTRACT_CLASS
|
||||
@li DECLARE_APP
|
||||
@li DECLARE_CLASS
|
||||
@li DECLARE_DYNAMIC_CLASS
|
||||
@li IMPLEMENT_ABSTRACT_CLASS
|
||||
@li IMPLEMENT_ABSTRACT_CLASS2
|
||||
@li IMPLEMENT_APP
|
||||
@li IMPLEMENT_CLASS
|
||||
@li IMPLEMENT_CLASS2
|
||||
@li IMPLEMENT_DYNAMIC_CLASS
|
||||
@li IMPLEMENT_DYNAMIC_CLASS2
|
||||
@li wxConstCast
|
||||
@li ::wxCreateDynamicObject
|
||||
@li WXDEBUG_NEW
|
||||
@li wxDynamicCast
|
||||
@li wxDynamicCastThis
|
||||
@li wxStaticCast
|
||||
@li wx_const_cast
|
||||
@li wx_reinterpret_cast
|
||||
@li wx_static_cast
|
||||
@li wx_truncate_cast
|
||||
|
||||
|
||||
@section page_macro_cat_debugging 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 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
|
||||
|
||||
|
||||
*/
|
||||
@ -23,11 +23,10 @@
|
||||
@li @subpage page_strategies
|
||||
@li @subpage page_libs
|
||||
@li @subpage page_constants
|
||||
@li @subpage page_categories
|
||||
@li @subpage page_class_cat
|
||||
@li @subpage page_func_cat
|
||||
@li @subpage page_macro_cat
|
||||
@li @subpage page_topics
|
||||
@li @subpage page_platdetails
|
||||
|
||||
<!-- @li Alphabetical class reference
|
||||
@li Functions and macros -->
|
||||
|
||||
*/
|
||||
|
||||
Loading…
Reference in New Issue
Block a user