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
#---------------------------------------------------------------------------
INPUT = ./mainpages ./overviews ../../interface
INPUT = ./mainpages ./groups ./overviews ../../interface
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.h *.txt
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}
*/

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

@@ -6,65 +6,65 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
/*!
@page page_class_cat Classes by category
A classification of wxWidgets classes by category.
@page page_class_cat Classes by Category
@beginInvisibleTable
<tr><td>
@li @ref page_class_cat_managedwnd
@li @ref page_class_cat_miscwnd
@li @ref page_class_cat_aui
@li @ref page_class_cat_winlayout
@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_aui
@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_validator
@li @ref page_class_cat_data
</td><td>
@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_class_cat_ipc
@li @ref page_class_cat_dvf
@li @ref page_class_cat_printing
@li @ref page_class_cat_dnd
@li @ref page_class_cat_file
@li @ref page_class_cat_vfs
@li @ref page_class_cat_streams
</td><td>
@li @ref page_class_cat_threading
@li @ref page_class_cat_rtti
@li @ref page_class_cat_appmanagement
@li @ref page_class_cat_html
@li @ref page_class_cat_richtext
@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
<hr>
@section page_class_cat_managedwnd Managed Windows
@section page_class_cat_managedwnd 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). Frames and dialogs
are similar in wxWidgets, but only dialogs may be modal.
There are several types of window that are directly controlled by the
window manager (such as MS Windows, or the Motif Window Manager).
Frames and dialogs are similar in wxWidgets, but only dialogs may be modal.
Related Overviews: @ref overview_cmndlg
@li wxTopLevelWindow: Any top level window, dialog or frame
@li wxDialog: Dialog box
@@ -77,10 +77,9 @@
@li wxTipWindow: Shows text in a small window
@li wxWizard: A wizard dialog
See also the @ref overview_cmndlg.
@section page_class_cat_miscwnd Miscellaneous windows
@section page_class_cat_miscwnd Miscellaneous Windows
The following are a variety of classes that are derived from wxWindow.
@@ -95,18 +94,71 @@
@li wxChoicebook: Similar to notebook but using choice control
@li wxTreebook: Similar to notebook but using tree control
@li wxSashWindow: Window with four optional sashes that can be dragged
@li wxSashLayoutWindow: Window that can be involved in an IDE-like layout arrangement
@li wxVScrolledWindow: As wxScrolledWindow but supports lines of variable height
@li wxSashLayoutWindow: Window that can be involved in an IDE-like layout
arrangement
@li wxVScrolledWindow: As wxScrolledWindow but supports lines of variable
height
@li wxWizardPage: A base class for the page in wizard dialog.
@li wxWizardPageSimple: A page in wizard dialog.
@section page_class_cat_cmndlg Common dialogs
@ref overview_cmndlg
@section page_class_cat_aui Window Docking (wxAUI)
Common dialogs are ready-made dialog classes which are frequently used
in an application.
wxAUI is a set classes for writing a customizable application interface
with built-in docking, floatable panes and a flexible MDI-like interface.
Related Overviews: @ref overview_aui
@li wxAuiManager: The central class for managing the interface
@li wxAuiNotebook: A replacement notebook class with extra features
@li wxAuiPaneInfo: Describes a single pane
@li wxAuiDockArt: Art and metrics provider for customizing the docking user
interface
@li wxAuiTabArt: Art and metrics provider for customizing the notebook user
interface
@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 and will in almost all cases produce dialogs looking
equally well on all platforms, the other is based on so-called constraints and
is deprecated, though still available.
Related Overviews: @ref overview_sizer, @ref overview_constraints
These are the classes relevant to sizer-based layout:
@li wxSizer: Abstract base class
@li wxGridSizer: A sizer for laying out windows in a grid with all fields
having the same size
@li wxFlexGridSizer: A sizer for laying out windows in a flexible grid
@li wxGridBagSizer: Another grid sizer that lets you specify the cell an item
is in, and items can span rows and/or columns.
@li wxBoxSizer: A sizer for laying out windows in a row or column
@li wxStaticBoxSizer: Same as wxBoxSizer, but with a surrounding static box
@li wxWrapSizer: A sizer which wraps its child controls as size permits
These are the classes relevant to constraints-based window layout:
@li wxIndividualLayoutConstraint: Represents a single constraint dimension
@li wxLayoutConstraints: Represents the constraints for a window class
Other layout classes:
@li wxLayoutAlgorithm: An alternative window layout facility
@section page_class_cat_cmndlg Common Dialogs
Common dialogs are ready-made dialog classes which are frequently used in an
application.
Related Overviews: @ref overview_cmndlg
@li wxDialog: Base class for common dialogs
@li wxColourDialog: Colour chooser dialog
@@ -114,7 +166,8 @@
@li wxFileDialog: File selector dialog
@li wxFindReplaceDialog: Text search/replace dialog
@li wxMultiChoiceDialog: Dialog to get one or more selections from a list
@li wxSingleChoiceDialog: Dialog to get a single selection from a list and return the string
@li wxSingleChoiceDialog: Dialog to get a single selection from a list and
return the string
@li wxTextEntryDialog: Dialog to get a single line of text from the user
@li wxPasswordEntryDialog: Dialog to get a password from the user
@li wxFontDialog: Font chooser dialog
@@ -123,14 +176,16 @@
@li wxProgressDialog: Progress indication dialog
@li wxMessageDialog: Simple message box dialog
@li wxSymbolPickerDialog: Symbol selector dialog
@li wxRichTextFormattingDialog: A dialog for formatting the content of a wxRichTextCtrl
@li wxRichTextFormattingDialog: A dialog for formatting the content of a
wxRichTextCtrl
@li wxWizard: A wizard dialog.
@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.
Typically, these are small windows which provide interaction with the user.
Controls that are not static can have wxValidator associated with them.
@li wxAnimationCtrl: A control to display an animation
@li wxControl: The base class for controls
@@ -150,12 +205,15 @@
@li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with wxTreeCtrl-like API
@li wxGauge: A control to represent a varying quantity, such as time remaining
@li wxGenericDirCtrl: A control for displaying a directory tree
@li wxHtmlListBox: An abstract class for creating listboxes showing HTML content
@li wxHtmlListBox: An abstract class for creating listboxes showing HTML
content
@li wxSimpleHtmlListBox: A listbox showing HTML content
@li wxStaticBox: A static, or group box for visually grouping related controls
@li wxListBox: A list of strings for single or multiple selection
@li wxListCtrl: A control for displaying lists of strings and/or icons, plus a multicolumn report view
@li wxListView: A simpler interface (fa&ccedil;ade) for wxListCtrl in report mode
@li wxListCtrl: A control for displaying lists of strings and/or icons, plus a
multicolumn report view
@li wxListView: A simpler interface (fa&ccedil;ade) for wxListCtrl in report
mode
@li wxOwnerDrawnComboBox: A combobox with owner-drawn list items
@li wxRichTextCtrl: Generic rich text editing control
@li wxTextCtrl: Single or multiline text editing control
@@ -167,15 +225,17 @@
@li wxHyperlinkCtrl: A static text which opens an URL when clicked
@li wxStaticBitmap: A control to display a bitmap
@li wxRadioBox: A group of radio buttons
@li wxRadioButton: A round button to be used with others in a mutually exclusive way
@li wxRadioButton: A round button to be used with others in a mutually
exclusive way
@li wxSlider: A slider that can be dragged by the user
@li wxVListBox: A listbox supporting variable height rows
@section page_class_cat_miscpickers Miscellaneous pickers
@section page_class_cat_miscpickers Picker Controls
A picker control is a control whose appearance and behaviour is highly platform-dependent.
A picker control is a control whose appearance and behaviour is highly
platform-dependent.
@li wxColourPickerCtrl: A control which allows the user to choose a colour
@li wxDirPickerCtrl: A control which allows the user to choose a directory
@@ -193,67 +253,23 @@
@section page_class_cat_aui wxAUI - advanced user interface
@section page_class_cat_dc Device Contexts
This is a new set of classes for writing a customizable application
interface with built-in docking, floatable panes and a flexible
MDI-like interface. Further classes for custom notebooks with
draggable tabs etc. are in progress. See also @ref overview_aui.
Device contexts are surfaces that may be drawn on, and provide an abstraction
that allows parameterisation of your drawing code by passing different device
contexts.
@li wxAuiManager: The central class for managing the interface
@li wxAuiNotebook: A replacement notebook class with extra features
@li wxAuiPaneInfo: Describes a single pane
@li wxAuiDockArt: Art and metrics provider for customizing the docking user interface
@li wxAuiTabArt: Art and metrics provider for customizing the notebook user interface
Related Overviews: @ref overview_dc
@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
and will in almost all cases produce dialogs looking equally well on all platforms, the
other is based on so-called constraints and is deprecated, though still available.
@ref overview_sizer describes sizer-based layout.
These are the classes relevant to sizer-based layout.
@li wxSizer: Abstract base class
@li wxGridSizer: A sizer for laying out windows in a grid with all fields
having the same size
@li wxFlexGridSizer: A sizer for laying out windows in a flexible grid
@li wxGridBagSizer: Another grid sizer that lets you specify the cell an item
is in, and items can span rows and/or columns.
@li wxBoxSizer: A sizer for laying out windows in a row or column
@li wxStaticBoxSizer: Same as wxBoxSizer, but with a surrounding static box
@li wxWrapSizer: A sizer which wraps its child controls as size permits
@ref overview_constraints describes constraints-based layout.
These are the classes relevant to constraints-based window layout.
@li wxIndividualLayoutConstraint: Represents a single constraint dimension
@li wxLayoutConstraints: Represents the constraints for a window class
Other layouting classes:
@li wxLayoutAlgorithm: An alternative window layout facility
@section page_class_cat_dc Device contexts
@ref overview_dc
Device contexts are surfaces that may be drawn on, and provide an
abstraction that allows parameterisation of your drawing code
by passing different device contexts.
@li wxAutoBufferedPaintDC: A helper device context for double buffered drawing inside @b OnPaint.
@li wxAutoBufferedPaintDC: A helper device context for double buffered drawing
inside @b OnPaint().
@li wxBufferedDC: A helper device context for double buffered drawing.
@li wxBufferedPaintDC: A helper device context for double buffered drawing inside @b OnPaint.
@li wxClientDC: A device context to access the client area outside @b OnPaint events
@li wxPaintDC: A device context to access the client area inside @b OnPaint events
@li wxBufferedPaintDC: A helper device context for double buffered drawing
inside @b OnPaint().
@li wxClientDC: A device context to access the client area outside
@b OnPaint() events
@li wxPaintDC: A device context to access the client area inside @b OnPaint()
events
@li wxWindowDC: A device context to access the non-client area
@li wxScreenDC: A device context to access the entire screen
@li wxDC: The device context base class
@@ -264,39 +280,44 @@
@li wxPrinterDC: A device context for drawing to printers
@section page_class_cat_gdi Graphics device interface
@ref overview_bitmap
@section page_class_cat_gdi Graphics Device Interface
These classes are related to drawing on device contexts and windows.
Related Overviews: @ref overview_bitmap
@li wxColour: Represents the red, blue and green elements of a colour
@li wxDCClipper: Wraps the operations of setting and destroying the clipping region
@li wxDCClipper: Wraps the operations of setting and destroying the clipping
region
@li wxBitmap: Represents a bitmap
@li wxBrush: Used for filling areas on a device context
@li wxBrushList: The list of previously-created brushes
@li wxCursor: A small, transparent bitmap representing the cursor
@li wxFont: Represents fonts
@li wxFontList: The list of previously-created fonts
@li wxIcon: A small, transparent bitmap for assigning to frames and drawing on device contexts
@li wxIcon: A small, transparent bitmap for assigning to frames and drawing on
device contexts
@li wxImage: A platform-independent image class
@li wxImageList: A list of images, used with some controls
@li wxMask: Represents a mask to be used with a bitmap for transparent drawing
@li wxPen: Used for drawing lines on a device context
@li wxPenList: The list of previously-created pens
@li wxPalette: Represents a table of indices into RGB values
@li wxRegion: Represents a simple or complex region on a window or device context
@li wxRegion: Represents a simple or complex region on a window or device
context
@li wxAnimation: Represents an animation
@li wxRendererNative: Abstracts high-level drawing primitives
@section page_class_cat_events Events
@ref overview_eventhandling
@section page_class_cat_events Events
An event object contains information about a specific event. Event handlers
(usually member functions) have a single, event argument.
Related Overviews: @ref overview_eventhandling
@li wxActivateEvent: A window or application activation event
@li wxCalendarEvent: Used with wxCalendarCtrl
@li wxCalculateLayoutEvent: Used to calculate window layout
@@ -304,7 +325,8 @@
@li wxClipboardTextEvent: A clipboard copy/cut/paste treebook event event
@li wxCloseEvent: A close window or end session event
@li wxCommandEvent: An event from a variety of standard controls
@li wxContextMenuEvent: An event generated when the user issues a context menu command
@li wxContextMenuEvent: An event generated when the user issues a context menu
command
@li wxDateEvent: Used with wxDatePickerCtrl
@li wxDialUpEvent: Event send by wxDialUpManager
@li wxDropFilesEvent: A drop files event
@@ -331,7 +353,8 @@
@li wxProcessEvent: A process ending event
@li wxQueryLayoutInfoEvent: Used to query layout information
@li wxRichTextEvent: A rich text editing event
@li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin buttons
@li wxScrollEvent: A scroll event from sliders, stand-alone scrollbars and spin
buttons
@li wxScrollWinEvent: A scroll event from scrolled windows
@li wxSizeEvent: A size event
@li wxSocketEvent: A socket event
@@ -347,19 +370,20 @@
@li wxWizardEvent: A wizard event
@section page_class_cat_validator Validators
@ref overview_validator
These are the window validators, used for filtering and validating user input.
These are the window validators, used for filtering and validating
user input.
Related Overviews: @ref overview_validator
@li wxValidator: Base validator class
@li wxTextValidator: Text control validator class
@li wxGenericValidator: Generic control validator class
@section page_class_cat_data Data structures
@section page_class_cat_data Data Structures
These are the data structure classes supported by wxWidgets.
@@ -374,7 +398,8 @@
@li wxRegEx: Regular expression support
@li wxRegion: A class representing a region
@li wxString: A string class
@li wxStringTokenizer: A class for interpreting a string as a list of tokens or words
@li wxStringTokenizer: A class for interpreting a string as a list of tokens or
words
@li wxRealPoint: Representation of a point using floating point numbers
@li wxSize: Representation of a size
@li wxTimeSpan: A time interval.
@@ -382,12 +407,13 @@
@li wxVariant: A class for storing arbitrary types that may change at run-time
@section page_class_cat_containers Container classes
@ref overview_container
@section page_class_cat_containers Containers
These are classes, templates and class macros are used by wxWidgets. Most
of these classes provide a subset or almost complete STL API.
These are classes, templates and class macros are used by wxWidgets. Most of
these classes provide a subset or almost complete STL API.
Related Overviews: @ref overview_container
@li wxArray<T>: A type-safe dynamic array implementation (macro based)
@li wxArrayString: An efficient container for storing wxString objects
@@ -398,7 +424,8 @@
@li wxVector<T>: Template base vector implementation identical to std::vector
@section page_class_cat_smartpointers Smart pointers
@section page_class_cat_smartpointers Smart Pointers
wxWidgets provides a few smart pointer class templates.
@@ -408,24 +435,12 @@
@li wxWeakRef<T>: A weak reference
@section page_class_cat_rtti Run-time class information system
@ref overview_rtti
wxWidgets supports run-time manipulation of class information, and dynamic
creation of objects given class names.
@li wxClassInfo: Holds run-time class information
@li wxObject: Root class for classes with run-time information
@li RTTI macros: Macros for manipulating run-time information
@section page_class_cat_logging Logging features
@ref overview_log
@section page_class_cat_logging Logging
wxWidgets provides several classes and functions for message logging.
Please see the @ref overview_log for more details.
Related Overviews: @ref overview_log
@li wxLog: The base log class
@li wxLogStderr: Log messages to a C STDIO stream
@@ -441,28 +456,33 @@
@li Log functions: Error and warning logging functions
@section page_class_cat_debugging Debugging features
@ref overview_debugging
@section page_class_cat_debugging Debugging
wxWidgets supports some aspects of debugging an application through
classes, functions and macros.
wxWidgets supports some aspects of debugging an application through classes,
functions and macros.
Related Overviews: @ref overview_debugging
@li wxDebugContext: Provides memory-checking facilities
@li Debugging macros: Debug macros for assertion and checking
@li WXDEBUG_NEW: Use this macro to give further debugging information
@li wxDebugReport: Base class for creating debug reports in case of a program crash.
@li wxDebugReport: Base class for creating debug reports in case of a program
crash.
@li wxDebugReportCompress: Class for creating compressed debug reports.
@li wxDebugReportUpload: Class for uploading compressed debug reports via HTTP.
@li wxDebugReportPreview: Abstract base class for previewing the contents of a debug report.
@li wxDebugReportPreview: Abstract base class for previewing the contents of a
debug report.
@li wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview.
@section page_class_cat_net Networking classes
@section page_class_cat_net Networking
wxWidgets provides its own classes for socket based networking.
@li wxDialUpManager: Provides functions to check the status of network connection and to establish one
@li wxDialUpManager: Provides functions to check the status of network
connection and to establish one
@li wxIPV4address: Represents an Internet address
@li wxIPaddress: Represents an Internet address
@li wxSocketBase: Represents a socket base object
@@ -475,43 +495,48 @@
@section page_class_cat_ipc Interprocess communication
@section page_class_cat_ipc Interprocess Communication
@ref overview_ipc
wxWidgets provides simple interprocess communications facilities based on
Windows DDE, but available on most platforms using TCP.
wxWidgets provides simple interprocess communications facilities
based on Windows DDE, but available on most platforms using TCP.
Related Overviews: @ref overview_ipc
@li wxClient, wxDDEClient: Represents a client
@li wxConnection, wxDDEConnection: Represents the connection between a client and a server
@li wxConnection, wxDDEConnection: Represents the connection between a client
and a server
@li wxServer, wxDDEServer: Represents a server
@section page_class_cat_dvf Document-view framework
@section page_class_cat_dvf Document/View Framework
@ref overview_docview
wxWidgets supports a document/view framework which provides housekeeping for a
document-centric application.
wxWidgets supports a document/view framework which provides
housekeeping for a document-centric application.
Related Overviews: @ref overview_docview
@li wxCommand: Base class for undo/redo actions
@li wxCommandProcessor: Maintains the undo/redo stack
@li wxDocument: Represents a document
@li wxView: Represents a view
@li wxDocTemplate: Manages the relationship between a document class and a view class
@li wxDocTemplate: Manages the relationship between a document class and a
view class
@li wxDocManager: Manages the documents and views in an application
@li wxDocChildFrame: A child frame for showing a document view
@li wxDocParentFrame: A parent frame to contain views
<!-- %@li wxMDIDocChildFrame: An MDI child frame for showing a document view
%@li wxMDIDocParentFrame: An MDI parent frame to contain views -->
@li wxDocMDIChildFrame: An MDI child frame for showing a document view
@li wxDocMDIParentFrame: An MDI parent frame to contain views
@li wxFileHistory: Maintains a list of the most recently visited files
@section page_class_cat_printing Printing framework
@ref overview_printing
@section page_class_cat_printing Printing Framework
A printing and previewing framework is implemented to
make it relatively straightforward to provide document printing
facilities.
A printing and previewing framework is implemented to make it relatively
straightforward to provide document printing facilities.
Related Overviews: @ref overview_printing
@li wxPreviewFrame: Frame for displaying a print preview
@li wxPreviewCanvas: Canvas for displaying a print preview
@@ -528,9 +553,9 @@
@section page_class_cat_dnd Drag and drop and clipboard classes
@section page_class_cat_dnd Clipboard and Drag & Drop
@ref overview_dnd
Related Overviews: @ref overview_dnd
@li wxDataObject: Data object class
@li wxDataFormat: Represents a data format
@@ -546,14 +571,17 @@
@li wxDropSource: Drop source class
@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.
@section page_class_cat_file File Handling
wxWidgets has several small classes to work with disk files and directories.
Related Overviews: @ref overview_file
@li wxFileName: Operations with the file name and attributes
@li wxDir: Class for enumerating files/subdirectories.
@li wxDirTraverser: Class used together with wxDir for recursively enumerating the files/subdirectories
@li wxDirTraverser: Class used together with wxDir for recursively enumerating
the files/subdirectories
@li wxFile: Low-level file input/output class.
@li wxFFile: Another low-level file input/output class.
@li wxTempFile: Class to safely replace an existing file
@@ -562,16 +590,29 @@
@li wxPathList: A class to help search multiple paths
@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.
@section page_class_cat_vfs Virtual File System
wxWidgets provides a set of classes that implement an extensible virtual file
system, used internally by the HTML classes.
@li wxFSFile: Represents a file in the virtual file system
@li wxFileSystem: Main interface for the virtual file system
@li wxFileSystemHandler: Class used to announce file system type
@section page_class_cat_streams Streams
wxWidgets has its own set of stream classes, as an alternative to often buggy
standard stream libraries, and to provide enhanced functionality.
@li wxStreamBase: Stream base class
@li wxStreamBuffer: Stream buffer class
@li wxInputStream: Input stream class
@li wxOutputStream: Output stream class
@li wxCountingOutputStream: Stream class for querying what size a stream would have.
@li wxCountingOutputStream: Stream class for querying what size a stream would
have.
@li wxFilterInputStream: Filtered input stream class
@li wxFilterOutputStream: Filtered output stream class
@li wxBufferedInputStream: Buffered input stream class
@@ -599,13 +640,14 @@
@li wxSocketOutputStream: Socket output stream class
@section page_class_cat_threading Threading classes
@ref overview_thread
@section page_class_cat_threading Threading
wxWidgets provides a set of classes to make use of the native thread
capabilities of the various platforms.
Related Overviews: @ref overview_thread
@li wxThread: Thread class
@li wxThreadHelper: Manages background threads easily
@li wxMutex: Mutex class
@@ -616,10 +658,34 @@
@li wxSemaphore: Semaphore class
@section page_class_cat_html HTML classes
@section page_class_cat_rtti Runtime Type Information (RTTI)
wxWidgets supports runtime manipulation of class information, and dynamic
creation of objects given class names.
Related Overviews: @ref overview_rtti
See also: @ref page_macro_cat_rtti
@li wxClassInfo: Holds runtime class information
@li wxObject: Root class for classes with runtime information
@section page_class_cat_appmanagement Application and Process Management
@li wxApp: Application class
@li wxCmdLineParser: Command line parser class
@li wxDllLoader: Class to work with shared libraries.
@li wxProcess: Process class
@section page_class_cat_html HTML
wxWidgets provides a set of classes to display text in HTML format. These
class include a help system based on the HTML widget.
classes include a help system based on the HTML widget.
@li wxHtmlHelpController: HTML help controller class
@li wxHtmlWindow: HTML window class
@@ -631,10 +697,11 @@
@li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser
@section page_class_cat_richtext Rich text classes
wxWidgets provides a set of generic classes to edit and print simple rich text with character
and paragraph formatting.
@section page_class_cat_richtext Rich Text
wxWidgets provides a set of generic classes to edit and print simple rich text
with character and paragraph formatting.
@li wxTextAttr: Attributes specifying text styling.
@li wxRichTextCtrl: A rich text control.
@@ -645,7 +712,8 @@
@li wxRichTextStyleSheet: A set of style definitions.
@li wxRichTextStyleComboCtrl: A drop-down control for applying styles.
@li wxRichTextStyleListBox: A listbox for applying styles.
@li wxRichTextStyleOrganiserDialog: A dialog that can be used for managing or browsing styles.
@li wxRichTextStyleOrganiserDialog: A dialog that can be used for managing or
browsing styles.
@li wxRichTextEvent: A rich text event.
@li wxRichTextRange: Specification for ranges in a rich text control or buffer.
@li wxRichTextFileHandler: File handler base class.
@@ -657,72 +725,65 @@
@li wxRichTextHeaderFooterData: Header and footer data specification.
@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.
@section page_class_cat_stc Scintilla Text Editor
@li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code editing component.
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.
@li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code
editing component.
@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.
@li wxFSFile: Represents a file in the virtual file system
@li wxFileSystem: Main interface for the virtual file system
@li wxFileSystemHandler: Class used to announce file system type
@section page_class_cat_xml XML classes
@section page_class_cat_xml XML
@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_class_cat_xrc XML-based resource system classes
@ref overview_xrc
@section page_class_cat_xrc XML Based Resource System (XRC)
Resources allow your application to create controls and other user interface elements
from specifications stored in an XML format.
Resources allow your application to create controls and other user interface
elements from specifications stored in an XML format.
Related Overviews: @ref overview_xrc
@li wxXmlResource: The main class for working with resources
@li wxXmlResourceHandler: The base class for XML resource handlers
@section page_class_cat_help Online help
@section page_class_cat_help Help
@li wxHelpController: Family of classes for controlling help windows
@li wxHtmlHelpController: HTML help controller class
@li wxContextHelp: Class to put application into context-sensitive help mode
@li wxContextHelpButton: Button class for putting application into context-sensitive help mode
@li wxContextHelpButton: Button class for putting application into
context-sensitive help mode
@li wxHelpProvider: Abstract class for context-sensitive help provision
@li wxSimpleHelpProvider: Class for simple context-sensitive help provision
@li wxHelpControllerHelpProvider: Class for context-sensitive help provision via a help controller
@li wxHelpControllerHelpProvider: Class for context-sensitive help provision
via a help controller
@li wxToolTip: Class implementing tooltips
@section page_class_cat_media Multimedia classes
@section page_class_cat_media Multimedia
@li wxMediaCtrl: Display multimedia contents.
@section page_class_cat_gl OpenGL classes
@section page_class_cat_gl OpenGL
@li wxGLCanvas: Canvas that you can render OpenGL calls to.
@li wxGLContext: Class to ease sharing of OpenGL data resources.
@section page_class_cat_appmanagement Application and process-management classes
@li wxApp: Application class
@li wxCmdLineParser: Command line parser class
@li wxDllLoader: Class to work with shared libraries.
@li wxProcess: Process class
@section page_class_cat_misc Miscellaneous
@@ -731,7 +792,8 @@
@li wxTimer: Timer class
@li wxStopWatch: Stop watch class
@li wxMimeTypesManager: MIME-types manager class
@li wxSystemSettings: System settings class for obtaining various global parameters
@li wxSystemSettings: System settings class for obtaining various global
parameters
@li wxSystemOptions: System options class for run-time configuration
@li wxAcceleratorTable: Accelerator table
@li wxAutomationObject: OLE automation class
@@ -742,3 +804,4 @@
@li wxSingleInstanceChecker: Check that only single program instance is running
*/

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

@@ -6,12 +6,9 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
/*!
@page page_func_cat Functions by category
A classification of wxWidgets functions by category.
@page page_func_cat Functions by Category
@li @ref page_func_cat_appinitterm
@li @ref page_func_cat_procctrl
@@ -24,143 +21,143 @@
@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
@li @ref page_func_cat_misc
<hr>
@section page_func_cat_appinitterm Application initialization and termination
@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
@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
@section page_func_cat_procctrl Process Control
The functions in this section are used to launch or terminate the other processes.
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
@li ::wxExecute()
@li ::wxExit()
@li ::wxJoin()
@li ::wxKill()
@li ::wxGetProcessId()
@li ::wxShell()
@li ::wxShutdown()
@section page_func_cat_thread Thread functions
@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).
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.
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
@sa wxThread, wxMutex, @ref overview_thread
@li wxIsMainThread
@li wxMutexGuiEnter
@li wxMutexGuiLeave
@li ::wxIsMainThread()
@li ::wxMutexGuiEnter()
@li ::wxMutexGuiLeave()
@section page_func_cat_file File functions
@section page_func_cat_file Files and Directories
@header{wx/filefn.h}
@sa
wxPathList, wxDir, wxFile, wxFileName
@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
@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
@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.
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
@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
@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
@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
@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
@@ -168,224 +165,231 @@
(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
@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
@section page_func_cat_math Math
@header{wx/math.h}
@li wxFinite
@li wxIsNaN
@li ::wxFinite()
@li ::wxIsNaN()
@section page_func_cat_gdi GDI functions
@section page_func_cat_gdi Graphics Device Interface
The following are relevant to the GDI (Graphics Device Interface).
@header{gdicmn.h}
@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
@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
@section page_func_cat_printer Printing
NB: These routines are obsolete and should no longer be used!
@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.
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
@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
@section page_func_cat_clipboard Clipboard
@warning These functions are deprecated, use the wxClipboard class instead.
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
@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
@section page_func_cat_log Logging
@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
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).
@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).
Related Overviews: @ref overview_log
@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
@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
@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
@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
@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.
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
@li ::wxOnAssert()
@li ::wxTrap()
@li ::wxIsDebuggerRunning()
@section page_func_cat_env Environment access functions
@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).
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
@li ::wxGetenv()
@li ::wxGetEnv()
@li ::wxSetEnv()
@li ::wxUnsetEnv()
@section page_func_cat_atomic Atomic operation functions
@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.
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).
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.
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
@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()
*/

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

@@ -6,41 +6,36 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/**
/*!
@page page_macro_cat Macros by category
A classification of wxWidgets macros by category.
@page page_macro_cat 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
@li @ref page_macro_cat_misc
<hr>
@section page_macro_cat_version Version macros
@section page_macro_cat_version Versioning
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
@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
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.
Additionally, wxVERSION_STRING is a user-readable string containing the full
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.
The subrelease number is only used for the sources in between official releases
and so normally is not useful.
@@ -56,7 +51,7 @@
@li wxCHECK_W32API_VERSION
@section page_macro_cat_misc Miscellaneous macros
@section page_macro_cat_misc Miscellaneous
@header{FIXME}
@@ -83,15 +78,14 @@
@li WXTRACELEVEL
@section page_macro_cat_byteorder Byte order macros
@section page_macro_cat_byteorder Byte Order
@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 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.
@@ -103,53 +97,52 @@
@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
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
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.
@sa
@ref overview_rtti
Related Overviews: @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 #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
@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
@section page_macro_cat_debugging 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.
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}
@@ -166,5 +159,5 @@
@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_classinfo
@@ -25,7 +25,7 @@
@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
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
@@ -76,7 +76,7 @@ wxClassInfo object instead, then you can simply call wxClassInfo::CreateObject.
@section overview_rtti_classinfo wxClassInfo
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:
@li It's position in the inheritance hierarchy.

9
interface/gdicmn.h
View File

@@ -739,7 +739,9 @@ public:
// Global functions/macros
// ============================================================================
/** @addtogroup group_gdi */
//@{
/**
Returns the dimensions of the work area on the display. On Windows
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,
int* height);
wxRect wxGetClientDisplayRect();
//@}
//@{
/**
Returns the display size in pixels.
*/
void wxDisplaySize(int* width, int* height);
wxSize wxGetDisplaySize();
//@}
//@{
/**
Returns the display size in millimeters.
*/
void wxDisplaySizeMM(int* width, int* height);
wxSize wxGetDisplaySizeMM();
//@}
/**
This macro loads an icon from either application resources (on the platforms
@@ -795,3 +792,5 @@ bool wxColourDisplay();
*/
int wxDisplayDepth();
//@}

27
interface/metafile.h
View File

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