From: Bryan Petty Date: Tue, 11 Mar 2008 07:57:21 +0000 (+0000) Subject: Looking for comments on new functions and macros organization of Doxygen docs shown... X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/c83e60aab58ed216f32f557c88533abb3ed1df61 Looking for comments on new functions and macros organization of Doxygen docs shown with this commit, see wx-dev. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52438 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/Doxyfile.inc b/docs/doxygen/Doxyfile.inc index 217f499902..976b624fa2 100644 --- a/docs/doxygen/Doxyfile.inc +++ b/docs/doxygen/Doxyfile.inc @@ -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 diff --git a/docs/doxygen/groups/gdi.h b/docs/doxygen/groups/gdi.h new file mode 100644 index 0000000000..d4abfb62f1 --- /dev/null +++ b/docs/doxygen/groups/gdi.h @@ -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} + +*/ + diff --git a/docs/doxygen/mainpages/cat_classes.h b/docs/doxygen/mainpages/cat_classes.h index cf88943999..ef23e000f4 100644 --- a/docs/doxygen/mainpages/cat_classes.h +++ b/docs/doxygen/mainpages/cat_classes.h @@ -6,739 +6,802 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// +/** + +@page page_class_cat Classes by Category + +@beginInvisibleTable + +@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_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 + +@li @ref page_class_cat_containers +@li @ref page_class_cat_smartpointers +@li @ref page_class_cat_logging +@li @ref page_class_cat_debugging +@li @ref page_class_cat_net +@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 + +@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_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_misc + +@endTable + + +
+ + +@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. + +Related Overviews: @ref overview_cmndlg + +@li wxTopLevelWindow: Any top level window, dialog or frame +@li wxDialog: Dialog box +@li wxFrame: Normal frame +@li wxMDIChildFrame: MDI child frame +@li wxMDIParentFrame: MDI parent frame +@li wxMiniFrame: A frame with a small title bar +@li wxPropertySheetDialog: Property sheet dialog +@li wxSplashScreen: Splash screen class +@li wxTipWindow: Shows text in a small window +@li wxWizard: A wizard dialog + + + +@section page_class_cat_miscwnd Miscellaneous Windows + +The following are a variety of classes that are derived from wxWindow. + +@li wxPanel: A window whose colour changes according to current user settings +@li wxScrolledWindow: Window with automatically managed scrollbars +@li wxGrid: A grid (table) window +@li wxSplitterWindow: Window which can be split vertically or horizontally +@li wxStatusBar: Implements the status bar on a frame +@li wxToolBar: Toolbar class +@li wxNotebook: Notebook class +@li wxListbook: Similar to notebook but using list control +@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 wxWizardPage: A base class for the page in wizard dialog. +@li wxWizardPageSimple: A page in wizard dialog. + + + +@section page_class_cat_aui Window Docking (wxAUI) + +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 -/*! - - @page page_class_cat Classes by category - - A classification of wxWidgets classes by category. - - @beginInvisibleTable - - @li @ref page_class_cat_managedwnd - @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_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 - @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 - - @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_streams - @li @ref page_class_cat_threading - @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 - - @endTable - -
- - - - @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. - - @li wxTopLevelWindow: Any top level window, dialog or frame - @li wxDialog: Dialog box - @li wxFrame: Normal frame - @li wxMDIChildFrame: MDI child frame - @li wxMDIParentFrame: MDI parent frame - @li wxMiniFrame: A frame with a small title bar - @li wxPropertySheetDialog: Property sheet dialog - @li wxSplashScreen: Splash screen class - @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 - - The following are a variety of classes that are derived from wxWindow. - - @li wxPanel: A window whose colour changes according to current user settings - @li wxScrolledWindow: Window with automatically managed scrollbars - @li wxGrid: A grid (table) window - @li wxSplitterWindow: Window which can be split vertically or horizontally - @li wxStatusBar: Implements the status bar on a frame - @li wxToolBar: Toolbar class - @li wxNotebook: Notebook class - @li wxListbook: Similar to notebook but using list control - @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 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 - - Common dialogs are ready-made dialog classes which are frequently used - in an application. - - @li wxDialog: Base class for common dialogs - @li wxColourDialog: Colour chooser dialog - @li wxDirDialog: Directory selector dialog - @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 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 - @li wxPageSetupDialog: Standard page setup dialog - @li wxPrintDialog: Standard print dialog - @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 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. - - @li wxAnimationCtrl: A control to display an animation - @li wxControl: The base class for controls - @li wxButton: Push button control, displaying text - @li wxBitmapButton: Push button control, displaying a bitmap - @li wxBitmapComboBox: A combobox with bitmaps next to text items - @li wxToggleButton: A button which stays pressed when clicked by user. - @li wxBitmapToggleButton: A toggle button with bitmaps. - @li wxCalendarCtrl: Control showing an entire calendar month - @li wxCheckBox: Checkbox control - @li wxCheckListBox: A listbox with a checkbox to the left of each item - @li wxChoice: Choice control (a combobox without the editable area) - @li wxCollapsiblePane: A panel which can be shown/hidden by the user - @li wxComboBox: A choice with an editable area - @li wxComboCtrl: A combobox with application defined popup - @li wxDataViewCtrl: A control to tabular or tree like data - @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 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ç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 - @li wxTreeCtrl: Tree (hierarchy) control - @li wxScrollBar: Scrollbar control - @li wxSpinButton: A spin or `up-down' control - @li wxSpinCtrl: A spin control - i.e. spin button and text control - @li wxStaticText: One or more lines of non-editable text - @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 wxSlider: A slider that can be dragged by the user - @li wxVListBox: A listbox supporting variable height rows +@section page_class_cat_cmndlg Common Dialogs - @section page_class_cat_miscpickers Miscellaneous pickers +Common dialogs are ready-made dialog classes which are frequently used in an +application. - A picker control is a control whose appearance and behaviour is highly platform-dependent. +Related Overviews: @ref overview_cmndlg - @li wxColourPickerCtrl: A control which allows the user to choose a colour - @li wxDirPickerCtrl: A control which allows the user to choose a directory - @li wxFilePickerCtrl: A control which allows the user to choose a file - @li wxFontPickerCtrl: A control which allows the user to choose a font - @li wxDatePickerCtrl: Small date picker control - - - - @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 - @li wxMenuItem: Represents a single menu item - - - - @section page_class_cat_aui 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 - MDI-like interface. Further classes for custom notebooks with - draggable tabs etc. are in progress. See also @ref overview_aui. +@li wxDialog: Base class for common dialogs +@li wxColourDialog: Colour chooser dialog +@li wxDirDialog: Directory selector dialog +@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 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 +@li wxPageSetupDialog: Standard page setup dialog +@li wxPrintDialog: Standard print dialog +@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 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. + +@li wxAnimationCtrl: A control to display an animation +@li wxControl: The base class for controls +@li wxButton: Push button control, displaying text +@li wxBitmapButton: Push button control, displaying a bitmap +@li wxBitmapComboBox: A combobox with bitmaps next to text items +@li wxToggleButton: A button which stays pressed when clicked by user. +@li wxBitmapToggleButton: A toggle button with bitmaps. +@li wxCalendarCtrl: Control showing an entire calendar month +@li wxCheckBox: Checkbox control +@li wxCheckListBox: A listbox with a checkbox to the left of each item +@li wxChoice: Choice control (a combobox without the editable area) +@li wxCollapsiblePane: A panel which can be shown/hidden by the user +@li wxComboBox: A choice with an editable area +@li wxComboCtrl: A combobox with application defined popup +@li wxDataViewCtrl: A control to tabular or tree like data +@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 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ç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 +@li wxTreeCtrl: Tree (hierarchy) control +@li wxScrollBar: Scrollbar control +@li wxSpinButton: A spin or `up-down' control +@li wxSpinCtrl: A spin control - i.e. spin button and text control +@li wxStaticText: One or more lines of non-editable text +@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 wxSlider: A slider that can be dragged by the user +@li wxVListBox: A listbox supporting variable height rows + + + +@section page_class_cat_miscpickers Picker Controls + +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 +@li wxFilePickerCtrl: A control which allows the user to choose a file +@li wxFontPickerCtrl: A control which allows the user to choose a font +@li wxDatePickerCtrl: Small date picker control + + + +@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 +@li wxMenuItem: Represents a single menu item + + + +@section page_class_cat_dc Device Contexts + +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. + +Related Overviews: @ref overview_dc + +@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 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 +@li wxMemoryDC: A device context for drawing into bitmaps +@li wxMetafileDC: A device context for drawing into metafiles +@li wxMirrorDC: A proxy device context allowing for simple mirroring. +@li wxPostScriptDC: A device context for drawing into PostScript files +@li wxPrinterDC: A device context for drawing to printers + + + +@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 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 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 wxAnimation: Represents an animation +@li wxRendererNative: Abstracts high-level drawing primitives + + + +@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 +@li wxChildFocusEvent: A child window focus event +@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 wxDateEvent: Used with wxDatePickerCtrl +@li wxDialUpEvent: Event send by wxDialUpManager +@li wxDropFilesEvent: A drop files event +@li wxEraseEvent: An erase background event +@li wxEvent: The event base class +@li wxFindDialogEvent: Event sent by wxFindReplaceDialog +@li wxFocusEvent: A window focus event +@li wxKeyEvent: A keypress event +@li wxIconizeEvent: An iconize/restore event +@li wxIdleEvent: An idle event +@li wxInitDialogEvent: A dialog initialisation event +@li wxJoystickEvent: A joystick event +@li wxListEvent: A list control event +@li wxMaximizeEvent: A maximize event +@li wxMenuEvent: A menu event +@li wxMouseCaptureChangedEvent: A mouse capture changed event +@li wxMouseCaptureLostEvent: A mouse capture lost event +@li wxMouseEvent: A mouse event +@li wxMoveEvent: A move event +@li wxNavigationKeyEvent: An event set by navigation keys such as tab +@li wxNotebookEvent: A notebook control event +@li wxNotifyEvent: A notification event, which can be vetoed +@li wxPaintEvent: A paint event +@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 wxScrollWinEvent: A scroll event from scrolled windows +@li wxSizeEvent: A size event +@li wxSocketEvent: A socket event +@li wxSpinEvent: An event from wxSpinButton +@li wxSplitterEvent: An event from wxSplitterWindow +@li wxSysColourChangedEvent: A system colour change event +@li wxTimerEvent: A timer expiration event +@li wxTreebookEvent: A treebook control event +@li wxTreeEvent: A tree control event +@li wxUpdateUIEvent: A user interface update event +@li wxWindowCreateEvent: A window creation event +@li wxWindowDestroyEvent: A window destruction event +@li wxWizardEvent: A wizard event + + + +@section page_class_cat_validator Validators + +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 + +These are the data structure classes supported by wxWidgets. + +@li wxCmdLineParser: Command line parser class +@li wxDateSpan: A logical time interval. +@li wxDateTime: A class for date/time manipulations +@li wxLongLong: A portable 64 bit integer type +@li wxObject: The root class for most wxWidgets classes +@li wxPathList: A class to help search multiple paths +@li wxPoint: Representation of a point +@li wxRect: A class representing a rectangle +@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 wxRealPoint: Representation of a point using floating point numbers +@li wxSize: Representation of a size +@li wxTimeSpan: A time interval. +@li wxURI: Represents a Uniform Resource Identifier +@li wxVariant: A class for storing arbitrary types that may change at run-time - @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. - - @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 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 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 - @li wxMemoryDC: A device context for drawing into bitmaps - @li wxMetafileDC: A device context for drawing into metafiles - @li wxMirrorDC: A proxy device context allowing for simple mirroring. - @li wxPostScriptDC: A device context for drawing into PostScript files - @li wxPrinterDC: A device context for drawing to printers - @section page_class_cat_gdi Graphics device interface +@section page_class_cat_containers Containers - @ref overview_bitmap +These are classes, templates and class macros are used by wxWidgets. Most of +these classes provide a subset or almost complete STL API. - These classes are related to drawing on device contexts and windows. +Related Overviews: @ref overview_container - @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 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 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 wxAnimation: Represents an animation - @li wxRendererNative: Abstracts high-level drawing primitives - - - @section page_class_cat_events Events - - @ref overview_eventhandling - - An event object contains information about a specific event. Event handlers - (usually member functions) have a single, event argument. - - @li wxActivateEvent: A window or application activation event - @li wxCalendarEvent: Used with wxCalendarCtrl - @li wxCalculateLayoutEvent: Used to calculate window layout - @li wxChildFocusEvent: A child window focus event - @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 wxDateEvent: Used with wxDatePickerCtrl - @li wxDialUpEvent: Event send by wxDialUpManager - @li wxDropFilesEvent: A drop files event - @li wxEraseEvent: An erase background event - @li wxEvent: The event base class - @li wxFindDialogEvent: Event sent by wxFindReplaceDialog - @li wxFocusEvent: A window focus event - @li wxKeyEvent: A keypress event - @li wxIconizeEvent: An iconize/restore event - @li wxIdleEvent: An idle event - @li wxInitDialogEvent: A dialog initialisation event - @li wxJoystickEvent: A joystick event - @li wxListEvent: A list control event - @li wxMaximizeEvent: A maximize event - @li wxMenuEvent: A menu event - @li wxMouseCaptureChangedEvent: A mouse capture changed event - @li wxMouseCaptureLostEvent: A mouse capture lost event - @li wxMouseEvent: A mouse event - @li wxMoveEvent: A move event - @li wxNavigationKeyEvent: An event set by navigation keys such as tab - @li wxNotebookEvent: A notebook control event - @li wxNotifyEvent: A notification event, which can be vetoed - @li wxPaintEvent: A paint event - @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 wxScrollWinEvent: A scroll event from scrolled windows - @li wxSizeEvent: A size event - @li wxSocketEvent: A socket event - @li wxSpinEvent: An event from wxSpinButton - @li wxSplitterEvent: An event from wxSplitterWindow - @li wxSysColourChangedEvent: A system colour change event - @li wxTimerEvent: A timer expiration event - @li wxTreebookEvent: A treebook control event - @li wxTreeEvent: A tree control event - @li wxUpdateUIEvent: A user interface update event - @li wxWindowCreateEvent: A window creation event - @li wxWindowDestroyEvent: A window destruction event - @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. - - @li wxValidator: Base validator class - @li wxTextValidator: Text control validator class - @li wxGenericValidator: Generic control validator class - - - @section page_class_cat_data Data structures - - These are the data structure classes supported by wxWidgets. - - @li wxCmdLineParser: Command line parser class - @li wxDateSpan: A logical time interval. - @li wxDateTime: A class for date/time manipulations - @li wxLongLong: A portable 64 bit integer type - @li wxObject: The root class for most wxWidgets classes - @li wxPathList: A class to help search multiple paths - @li wxPoint: Representation of a point - @li wxRect: A class representing a rectangle - @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 wxRealPoint: Representation of a point using floating point numbers - @li wxSize: Representation of a size - @li wxTimeSpan: A time interval. - @li wxURI: Represents a Uniform Resource Identifier - @li wxVariant: A class for storing arbitrary types that may change at run-time - - - @section page_class_cat_containers Container classes - - @ref overview_container - - These are classes, templates and class macros are used by wxWidgets. Most - of these classes provide a subset or almost complete STL API. +@li wxArray: A type-safe dynamic array implementation (macro based) +@li wxArrayString: An efficient container for storing wxString objects +@li wxHashMap: A type-safe hash map implementation (macro based) +@li wxHashSet: A type-safe hash set implementation(macro based) +@li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap) +@li wxList: A type-safe linked list implementation (macro based) +@li wxVector: Template base vector implementation identical to std::vector - @li wxArray: A type-safe dynamic array implementation (macro based) - @li wxArrayString: An efficient container for storing wxString objects - @li wxHashMap: A type-safe hash map implementation (macro based) - @li wxHashSet: A type-safe hash set implementation(macro based) - @li wxHashTable: A simple hash table implementation (deprecated, use wxHashMap) - @li wxList: A type-safe linked list implementation (macro based) - @li wxVector: Template base vector implementation identical to std::vector - @section page_class_cat_smartpointers Smart pointers - - wxWidgets provides a few smart pointer class templates. - - @li wxObjectDataPtr: A shared pointer (using intrusive reference counting) - @li wxScopedPtr: A scoped pointer - @li wxSharedPtr: A shared pointer (using non-intrusive reference counting) - @li wxWeakRef: A weak reference - +@section page_class_cat_smartpointers Smart Pointers - @section page_class_cat_rtti Run-time class information system +wxWidgets provides a few smart pointer class templates. - @ref overview_rtti +@li wxObjectDataPtr: A shared pointer (using intrusive reference counting) +@li wxScopedPtr: A scoped pointer +@li wxSharedPtr: A shared pointer (using non-intrusive reference counting) +@li wxWeakRef: A weak reference - 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 - @section page_class_cat_logging Logging features +wxWidgets provides several classes and functions for message logging. - @ref overview_log +Related Overviews: @ref overview_log - wxWidgets provides several classes and functions for message logging. - Please see the @ref overview_log for more details. +@li wxLog: The base log class +@li wxLogStderr: Log messages to a C STDIO stream +@li wxLogStream: Log messages to a C++ iostream +@li wxLogTextCtrl: Log messages to a wxTextCtrl +@li wxLogWindow: Log messages to a log frame +@li wxLogGui: Default log target for GUI programs +@li wxLogNull: Temporarily suppress message logging +@li wxLogChain: Allows to chain two log targets +@li wxLogInterposer: Allows to filter the log messages +@li wxLogInterposerTemp: Allows to filter the log messages +@li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl +@li Log functions: Error and warning logging functions - @li wxLog: The base log class - @li wxLogStderr: Log messages to a C STDIO stream - @li wxLogStream: Log messages to a C++ iostream - @li wxLogTextCtrl: Log messages to a wxTextCtrl - @li wxLogWindow: Log messages to a log frame - @li wxLogGui: Default log target for GUI programs - @li wxLogNull: Temporarily suppress message logging - @li wxLogChain: Allows to chain two log targets - @li wxLogInterposer: Allows to filter the log messages - @li wxLogInterposerTemp: Allows to filter the log messages - @li wxStreamToTextRedirector: Allows to redirect output sent to @c cout to a wxTextCtrl - @li Log functions: Error and warning logging functions - @section page_class_cat_debugging Debugging features +@section page_class_cat_debugging Debugging - @ref overview_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 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 wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview. +@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 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 wxDebugReportPreviewStd: Standard implementation of wxDebugReportPreview. - @section page_class_cat_net Networking classes - wxWidgets provides its own classes for socket based networking. +@section page_class_cat_net Networking - @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 - @li wxSocketClient: Represents a socket client - @li wxSocketServer: Represents a socket server - @li wxSocketEvent: A socket event - @li wxFTP: FTP protocol class - @li wxHTTP: HTTP protocol class - @li wxURL: Represents a Universal Resource Locator +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 wxIPV4address: Represents an Internet address +@li wxIPaddress: Represents an Internet address +@li wxSocketBase: Represents a socket base object +@li wxSocketClient: Represents a socket client +@li wxSocketServer: Represents a socket server +@li wxSocketEvent: A socket event +@li wxFTP: FTP protocol class +@li wxHTTP: HTTP protocol class +@li wxURL: Represents a Universal Resource Locator - @section page_class_cat_ipc Interprocess communication - @ref overview_ipc +@section page_class_cat_ipc Interprocess Communication - 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. - @li wxClient, wxDDEClient: Represents a client - @li wxConnection, wxDDEConnection: Represents the connection between a client and a server - @li wxServer, wxDDEServer: Represents a server +Related Overviews: @ref overview_ipc +@li wxClient, wxDDEClient: Represents a client +@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 - @ref overview_docview +@section page_class_cat_dvf Document/View Framework - 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. - @li wxDocument: Represents a document - @li wxView: Represents a view - @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 - +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 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 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 - A printing and previewing framework is implemented to - make it relatively straightforward to provide document printing - facilities. +@section page_class_cat_printing Printing Framework - @li wxPreviewFrame: Frame for displaying a print preview - @li wxPreviewCanvas: Canvas for displaying a print preview - @li wxPreviewControlBar: Standard control bar for a print preview - @li wxPrintDialog: Standard print dialog - @li wxPageSetupDialog: Standard page setup dialog - @li wxPrinter: Class representing the printer - @li wxPrinterDC: Printer device context - @li wxPrintout: Class representing a particular printout - @li wxPrintPreview: Class representing a print preview - @li wxPrintData: Represents information about the document being printed - @li wxPrintDialogData: Represents information about the print dialog - @li wxPageSetupDialogData: Represents information about the page setup dialog - - - - @section page_class_cat_dnd Drag and drop and clipboard classes - - @ref overview_dnd +A printing and previewing framework is implemented to make it relatively +straightforward to provide document printing facilities. - @li wxDataObject: Data object class - @li wxDataFormat: Represents a data format - @li wxTextDataObject: Text data object class - @li wxFileDataObject: File data object class - @li wxBitmapDataObject: Bitmap data object class - @li wxURLDataObject: URL data object class - @li wxCustomDataObject: Custom data object class - @li wxClipboard: Clipboard class - @li wxDropTarget: Drop target class - @li wxFileDropTarget: File drop target class - @li wxTextDropTarget: Text drop target class - @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. - - @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 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 - @li wxTextFile: Class for working with text files as with arrays of lines - @li wxStandardPaths: Paths for standard directories - @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. +Related Overviews: @ref overview_printing - @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 wxFilterInputStream: Filtered input stream class - @li wxFilterOutputStream: Filtered output stream class - @li wxBufferedInputStream: Buffered input stream class - @li wxBufferedOutputStream: Buffered output stream class - @li wxMemoryInputStream: Memory input stream class - @li wxMemoryOutputStream: Memory output stream class - @li wxDataInputStream: Platform-independent binary data input stream class - @li wxDataOutputStream: Platform-independent binary data output stream class - @li wxTextInputStream: Platform-independent text data input stream class - @li wxTextOutputStream: Platform-independent text data output stream class - @li wxFileInputStream: File input stream class - @li wxFileOutputStream: File output stream class - @li wxFFileInputStream: Another file input stream class - @li wxFFileOutputStream: Another file output stream class - @li wxTempFileOutputStream: Stream to safely replace an existing file - @li wxStringInputStream: String input stream class - @li wxStringOutputStream: String output stream class - @li wxZlibInputStream: Zlib and gzip (compression) input stream class - @li wxZlibOutputStream: Zlib and gzip (compression) output stream class - @li wxZipInputStream: Input stream for reading from ZIP archives - @li wxZipOutputStream: Output stream for writing from ZIP archives - @li wxTarInputStream: Input stream for reading from tar archives - @li wxTarOutputStream: Output stream for writing from tar archives - @li wxSocketInputStream: Socket input stream class - @li wxSocketOutputStream: Socket output stream class +@li wxPreviewFrame: Frame for displaying a print preview +@li wxPreviewCanvas: Canvas for displaying a print preview +@li wxPreviewControlBar: Standard control bar for a print preview +@li wxPrintDialog: Standard print dialog +@li wxPageSetupDialog: Standard page setup dialog +@li wxPrinter: Class representing the printer +@li wxPrinterDC: Printer device context +@li wxPrintout: Class representing a particular printout +@li wxPrintPreview: Class representing a print preview +@li wxPrintData: Represents information about the document being printed +@li wxPrintDialogData: Represents information about the print dialog +@li wxPageSetupDialogData: Represents information about the page setup dialog - @section page_class_cat_threading Threading classes - @ref overview_thread +@section page_class_cat_dnd Clipboard and Drag & Drop - wxWidgets provides a set of classes to make use of the native thread - capabilities of the various platforms. +Related Overviews: @ref overview_dnd - @li wxThread: Thread class - @li wxThreadHelper: Manages background threads easily - @li wxMutex: Mutex class - @li wxMutexLocker: Mutex locker utility class - @li wxCriticalSection: Critical section class - @li wxCriticalSectionLocker: Critical section locker utility class - @li wxCondition: Condition class - @li wxSemaphore: Semaphore class +@li wxDataObject: Data object class +@li wxDataFormat: Represents a data format +@li wxTextDataObject: Text data object class +@li wxFileDataObject: File data object class +@li wxBitmapDataObject: Bitmap data object class +@li wxURLDataObject: URL data object class +@li wxCustomDataObject: Custom data object class +@li wxClipboard: Clipboard class +@li wxDropTarget: Drop target class +@li wxFileDropTarget: File drop target class +@li wxTextDropTarget: Text drop target class +@li wxDropSource: Drop source class - @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. +@section page_class_cat_file File Handling - @li wxHtmlHelpController: HTML help controller class - @li wxHtmlWindow: HTML window class - @li wxHtmlEasyPrinting: Simple class for printing HTML - @li wxHtmlPrintout: Generic HTML wxPrintout class - @li wxHtmlParser: Generic HTML parser class - @li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser - @li wxHtmlWinParser: HTML parser class for wxHtmlWindow - @li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser +wxWidgets has several small classes to work with disk files and directories. +Related Overviews: @ref overview_file - @section page_class_cat_richtext Rich text classes +@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 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 +@li wxTextFile: Class for working with text files as with arrays of lines +@li wxStandardPaths: Paths for standard directories +@li wxPathList: A class to help search multiple paths - 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. - @li wxRichTextBuffer: The content of a rich text control. - @li wxRichTextCharacterStyleDefinition: Definition of character styling. - @li wxRichTextParagraphStyleDefinition: Definition of paragraph styling. - @li wxRichTextListStyleDefinition: Definition of list styling. - @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 wxRichTextEvent: A rich text event. - @li wxRichTextRange: Specification for ranges in a rich text control or buffer. - @li wxRichTextFileHandler: File handler base class. - @li wxRichTextHTMLHandler: A handler for converting rich text to HTML. - @li wxRichTextXMLHandler: A handler for loading and saving rich text XML. - @li wxRichTextFormattingDialog: A dialog for rich text formatting. - @li wxRichTextPrinting: A class for easy printing of rich text buffers. - @li wxRichTextPrintout: A class used by wxRichTextPrinting. - @li wxRichTextHeaderFooterData: Header and footer data specification. +@section page_class_cat_vfs Virtual File System - @section page_class_cat_stc Scintilla text editor classes +wxWidgets provides a set of classes that implement an extensible virtual file +system, used internally by the HTML 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. +@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 - @li wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code editing component. - @section page_class_cat_vfs Virtual file system classes +@section page_class_cat_streams Streams - wxWidgets provides a set of classes that implement an extensible virtual file system, - used internally by the HTML classes. +wxWidgets has its own set of stream classes, as an alternative to often buggy +standard stream libraries, and to provide enhanced functionality. - @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 +@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 wxFilterInputStream: Filtered input stream class +@li wxFilterOutputStream: Filtered output stream class +@li wxBufferedInputStream: Buffered input stream class +@li wxBufferedOutputStream: Buffered output stream class +@li wxMemoryInputStream: Memory input stream class +@li wxMemoryOutputStream: Memory output stream class +@li wxDataInputStream: Platform-independent binary data input stream class +@li wxDataOutputStream: Platform-independent binary data output stream class +@li wxTextInputStream: Platform-independent text data input stream class +@li wxTextOutputStream: Platform-independent text data output stream class +@li wxFileInputStream: File input stream class +@li wxFileOutputStream: File output stream class +@li wxFFileInputStream: Another file input stream class +@li wxFFileOutputStream: Another file output stream class +@li wxTempFileOutputStream: Stream to safely replace an existing file +@li wxStringInputStream: String input stream class +@li wxStringOutputStream: String output stream class +@li wxZlibInputStream: Zlib and gzip (compression) input stream class +@li wxZlibOutputStream: Zlib and gzip (compression) output stream class +@li wxZipInputStream: Input stream for reading from ZIP archives +@li wxZipOutputStream: Output stream for writing from ZIP archives +@li wxTarInputStream: Input stream for reading from tar archives +@li wxTarOutputStream: Output stream for writing from tar archives +@li wxSocketInputStream: Socket input stream class +@li wxSocketOutputStream: Socket output stream class - @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_class_cat_threading Threading +wxWidgets provides a set of classes to make use of the native thread +capabilities of the various platforms. - @section page_class_cat_xrc XML-based resource system classes +Related Overviews: @ref overview_thread - @ref overview_xrc +@li wxThread: Thread class +@li wxThreadHelper: Manages background threads easily +@li wxMutex: Mutex class +@li wxMutexLocker: Mutex locker utility class +@li wxCriticalSection: Critical section class +@li wxCriticalSectionLocker: Critical section locker utility class +@li wxCondition: Condition class +@li wxSemaphore: Semaphore class - Resources allow your application to create controls and other user interface elements - from specifications stored in an XML format. - @li wxXmlResource: The main class for working with resources - @li wxXmlResourceHandler: The base class for XML resource handlers +@section page_class_cat_rtti Runtime Type Information (RTTI) - @section page_class_cat_help Online help +wxWidgets supports runtime manipulation of class information, and dynamic +creation of objects given class names. - @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 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 wxToolTip: Class implementing tooltips +Related Overviews: @ref overview_rtti +See also: @ref page_macro_cat_rtti - @section page_class_cat_media Multimedia classes +@li wxClassInfo: Holds runtime class information +@li wxObject: Root class for classes with runtime information - @li wxMediaCtrl: Display multimedia contents. - @section page_class_cat_gl OpenGL classes +@section page_class_cat_appmanagement Application and Process Management - @li wxGLCanvas: Canvas that you can render OpenGL calls to. - @li wxGLContext: Class to ease sharing of OpenGL data resources. +@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_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_html HTML +wxWidgets provides a set of classes to display text in HTML format. These +classes include a help system based on the HTML widget. - @section page_class_cat_misc Miscellaneous +@li wxHtmlHelpController: HTML help controller class +@li wxHtmlWindow: HTML window class +@li wxHtmlEasyPrinting: Simple class for printing HTML +@li wxHtmlPrintout: Generic HTML wxPrintout class +@li wxHtmlParser: Generic HTML parser class +@li wxHtmlTagHandler: HTML tag handler, pluginable into wxHtmlParser +@li wxHtmlWinParser: HTML parser class for wxHtmlWindow +@li wxHtmlWinTagHandler: HTML tag handler, pluginable into wxHtmlWinParser - @li wxCaret: A caret (cursor) object - @li wxConfigBase: Classes for reading/writing the configuration settings - @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 wxSystemOptions: System options class for run-time configuration - @li wxAcceleratorTable: Accelerator table - @li wxAutomationObject: OLE automation class - @li wxFontMapper: Font mapping, finding suitable font for given encoding - @li wxEncodingConverter: Encoding conversions - @li wxCalendarDateAttr: Used with wxCalendarCtrl - @li wxQuantize: Class to perform quantization, or colour reduction - @li wxSingleInstanceChecker: Check that only single program instance is running -*/ \ No newline at end of file + +@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. +@li wxRichTextBuffer: The content of a rich text control. +@li wxRichTextCharacterStyleDefinition: Definition of character styling. +@li wxRichTextParagraphStyleDefinition: Definition of paragraph styling. +@li wxRichTextListStyleDefinition: Definition of list styling. +@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 wxRichTextEvent: A rich text event. +@li wxRichTextRange: Specification for ranges in a rich text control or buffer. +@li wxRichTextFileHandler: File handler base class. +@li wxRichTextHTMLHandler: A handler for converting rich text to HTML. +@li wxRichTextXMLHandler: A handler for loading and saving rich text XML. +@li wxRichTextFormattingDialog: A dialog for rich text formatting. +@li wxRichTextPrinting: A class for easy printing of rich text buffers. +@li wxRichTextPrintout: A class used by wxRichTextPrinting. +@li wxRichTextHeaderFooterData: Header and footer data specification. + + + +@section page_class_cat_stc Scintilla Text Editor + +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_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 (XRC) + +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 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 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 wxToolTip: Class implementing tooltips + + + +@section page_class_cat_media Multimedia + +@li wxMediaCtrl: Display multimedia contents. + + + +@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_misc Miscellaneous + +@li wxCaret: A caret (cursor) object +@li wxConfigBase: Classes for reading/writing the configuration settings +@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 wxSystemOptions: System options class for run-time configuration +@li wxAcceleratorTable: Accelerator table +@li wxAutomationObject: OLE automation class +@li wxFontMapper: Font mapping, finding suitable font for given encoding +@li wxEncodingConverter: Encoding conversions +@li wxCalendarDateAttr: Used with wxCalendarCtrl +@li wxQuantize: Class to perform quantization, or colour reduction +@li wxSingleInstanceChecker: Check that only single program instance is running + +*/ + diff --git a/docs/doxygen/mainpages/cat_functions.h b/docs/doxygen/mainpages/cat_functions.h index a4fd7125dc..8b48c6c935 100644 --- a/docs/doxygen/mainpages/cat_functions.h +++ b/docs/doxygen/mainpages/cat_functions.h @@ -6,386 +6,390 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// +/** -/*! +@page page_func_cat Functions by Category + +@li @ref page_func_cat_appinitterm +@li @ref page_func_cat_procctrl +@li @ref page_func_cat_thread +@li @ref page_func_cat_file +@li @ref page_func_cat_networkuseros +@li @ref page_func_cat_string +@li @ref page_func_cat_dialog +@li @ref page_func_cat_math +@li @ref page_func_cat_gdi +@li @ref page_func_cat_printer +@li @ref page_func_cat_clipboard +@li @ref page_func_cat_log +@li @ref page_func_cat_time +@li @ref page_func_cat_debug +@li @ref page_func_cat_env +@li @ref page_func_cat_atomic +@li @ref page_func_cat_misc + + +
+ + + +@section page_func_cat_appinitterm Application Initialization and Termination + +The functions in this section are used on application startup/shutdown and also +to control the behaviour of the main event loop of the GUI programs. + +@li ::wxEntry() +@li ::wxEntryCleanup() +@li ::wxEntryStart() +@li ::wxGetApp() +@li ::wxHandleFatalExceptions() +@li ::wxInitAllImageHandlers() +@li ::wxInitialize() +@li ::wxSafeYield() +@li ::wxUninitialize() +@li ::wxYield() +@li ::wxWakeUpIdle() + + +@section page_func_cat_procctrl Process Control + +The functions in this section are used to launch or terminate the other +processes. + +@li ::wxExecute() +@li ::wxExit() +@li ::wxJoin() +@li ::wxKill() +@li ::wxGetProcessId() +@li ::wxShell() +@li ::wxShutdown() + + +@section page_func_cat_thread Threads + +The functions and macros here mainly exist to make it writing the code which +may be compiled in multi thread build (wxUSE_THREADS = 1) as well as in single +thread configuration (wxUSE_THREADS = 0). + +For example, a static variable must be protected against simultaneous access by +multiple threads in the former configuration but in the latter the extra +overhead of using the critical section is not needed. To solve this problem, +the wxCRITICAL_SECTION macro may be used to create and use the critical section +only when needed. + +@header{wx/thread.h} + +@sa wxThread, wxMutex, @ref overview_thread + +@li ::wxIsMainThread() +@li ::wxMutexGuiEnter() +@li ::wxMutexGuiLeave() + + +@section page_func_cat_file Files and Directories + +@header{wx/filefn.h} + +@sa wxPathList, wxDir, wxFile, wxFileName + +@li ::wxDos2UnixFilename() +@li ::wxFileExists() +@li ::wxFileModificationTime() +@li ::wxFileNameFromPath() +@li ::wxFindFirstFile() +@li ::wxFindNextFile() +@li ::wxGetDiskSpace() +@li ::wxGetFileKind() +@li ::wxGetOSDirectory() +@li ::wxIsAbsolutePath() +@li ::wxDirExists() +@li ::wxPathOnly() +@li ::wxUnix2DosFilename() +@li ::wxConcatFiles() +@li ::wxCopyFile() +@li ::wxGetCwd() +@li ::wxGetWorkingDirectory() +@li ::wxGetTempFileName() +@li ::wxIsWild() +@li ::wxMatchWild() +@li ::wxMkdir() +@li ::wxParseCommonDialogsFilter() +@li ::wxRemoveFile() +@li ::wxRenameFile() +@li ::wxRmdir() +@li ::wxSetWorkingDirectory() +@li ::wxSplit() +@li ::wxSplitPath() +@li ::wxTransferFileToStream() +@li ::wxTransferStreamToFile() + + +@section page_func_cat_networkuseros Network, User and OS + +The functions in this section are used to retrieve information about the +current computer and/or user characteristics. + +@li ::wxGetEmailAddress() +@li ::wxGetFreeMemory() +@li ::wxGetFullHostName() +@li ::wxGetHomeDir() +@li ::wxGetHostName() +@li ::wxGetOsDescription() +@li ::wxGetOsVersion() +@li ::wxIsPlatformLittleEndian() +@li ::wxIsPlatform64Bit() +@li ::wxGetUserHome() +@li ::wxGetUserId() +@li ::wxGetUserName() + + +@section page_func_cat_string Strings + +@li ::wxGetTranslation() +@li ::wxIsEmpty() +@li ::wxStrcmp() +@li ::wxStricmp() +@li ::wxStringEq() +@li ::wxStringMatch() +@li ::wxStringTokenize() +@li ::wxStrlen() +@li ::wxSnprintf() +@li ::wxVsnprintf() + + +@section page_func_cat_dialog Dialogs + +Below are a number of convenience functions for getting input from the user +or displaying messages. Note that in these functions the last three parameters +are optional. However, it is recommended to pass a parent frame parameter, or +(in MS Windows or Motif) the wrong window frame may be brought to the front when +the dialog box is popped up. + +@li ::wxAboutBox() +@li ::wxBeginBusyCursor() +@li ::wxBell() +@li ::wxCreateFileTipProvider() +@li ::wxDirSelector() +@li ::wxFileSelector() +@li ::wxEndBusyCursor() +@li ::wxGenericAboutBox() +@li ::wxGetColourFromUser() +@li ::wxGetFontFromUser() +@li ::wxGetMultipleChoices() +@li ::wxGetNumberFromUser() +@li ::wxGetPasswordFromUser() +@li ::wxGetTextFromUser() +@li ::wxGetSingleChoice() +@li ::wxGetSingleChoiceIndex() +@li ::wxGetSingleChoiceData() +@li ::wxInfoMessageBox() +@li ::wxIsBusy() +@li ::wxMessageBox() +@li ::wxShowTip() + + +@section page_func_cat_math Math + +@header{wx/math.h} + +@li ::wxFinite() +@li ::wxIsNaN() + + +@section page_func_cat_gdi Graphics Device Interface + +The following are relevant to the GDI (Graphics Device Interface). + +@header{wx/gdicmn.h} + +@li ::wxBITMAP() +@li ::wxClientDisplayRect() +@li ::wxColourDisplay() +@li ::wxDisplayDepth() +@li ::wxDisplaySize() +@li ::wxDisplaySizeMM() +@li ::wxDROP_ICON() +@li ::wxICON() +@li ::wxMakeMetafilePlaceable() +@li ::wxSetCursor() + + +@section page_func_cat_printer Printing + +@warning These functions are deprecated and should no longer be used. + +The following functions are used to control PostScript printing. Under Windows, +PostScript output can only be sent to a file. + +@header{wx/dcps.h} + +@li ::wxGetPrinterCommand() +@li ::wxGetPrinterFile() +@li ::wxGetPrinterMode() +@li ::wxGetPrinterOptions() +@li ::wxGetPrinterOrientation() +@li ::wxGetPrinterPreviewCommand() +@li ::wxGetPrinterScaling() +@li ::wxGetPrinterTranslation() +@li ::wxSetPrinterCommand() +@li ::wxSetPrinterFile() +@li ::wxSetPrinterMode() +@li ::wxSetPrinterOptions() +@li ::wxSetPrinterOrientation() +@li ::wxSetPrinterPreviewCommand() +@li ::wxSetPrinterScaling() +@li ::wxSetPrinterTranslation() - @page page_func_cat Functions by category - A classification of wxWidgets functions by category. - - @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 +@section page_func_cat_clipboard Clipboard +@warning These functions are deprecated, use the wxClipboard class instead. + +These clipboard functions are implemented for Windows only. + +@header{wx/clipbrd.h} + +@li ::wxClipboardOpen() +@li ::wxCloseClipboard() +@li ::wxEmptyClipboard() +@li ::wxEnumClipboardFormats() +@li ::wxGetClipboardData() +@li ::wxGetClipboardFormatName() +@li ::wxIsClipboardFormatAvailable() +@li ::wxOpenClipboard() +@li ::wxRegisterClipboardFormat() +@li ::wxSetClipboardData() -
- - - - @section page_func_cat_appinitterm Application initialization and termination - - The functions in this section are used on application startup/shutdown and also - to control the behaviour of the main event loop of the GUI programs. - - @li wxEntry - @li wxEntryCleanup - @li wxEntryStart - @li wxGetApp - @li wxHandleFatalExceptions - @li wxInitAllImageHandlers - @li wxInitialize - @li wxSafeYield - @li wxUninitialize - @li wxYield - @li wxWakeUpIdle - - - @section page_func_cat_procctrl Process control functions - - The functions in this section are used to launch or terminate the other processes. - - @li wxExecute - @li wxExit - @li wxJoin - @li wxKill - @li wxGetProcessId - @li wxShell - @li wxShutdown - - - @section page_func_cat_thread Thread functions - - The functions and macros here mainly exist to make it writing the code which may be - compiled in multi thread build (wxUSE_THREADS = 1) as well as in single thread - configuration (wxUSE_THREADS = 0). - - For example, a static variable must be protected against simultaneous access by multiple - threads in the former configuration but in the latter the extra overhead of using the - critical section is not needed. To solve this problem, the wxCRITICAL_SECTION macro - may be used to create and use the critical section only when needed. - - @header{wx/thread.h} - - @sa - wxThread, wxMutex, @ref overview_thread - - @li wxIsMainThread - @li wxMutexGuiEnter - @li wxMutexGuiLeave - - - @section page_func_cat_file File functions - - @header{wx/filefn.h} - - @sa - wxPathList, wxDir, wxFile, wxFileName - - @li wxDos2UnixFilename - @li wxFileExists - @li wxFileModificationTime - @li wxFileNameFromPath - @li wxFindFirstFile - @li wxFindNextFile - @li wxGetDiskSpace - @li wxGetFileKind - @li wxGetOSDirectory - @li wxIsAbsolutePath - @li wxDirExists - @li wxPathOnly - @li wxUnix2DosFilename - @li wxConcatFiles - @li wxCopyFile - @li wxGetCwd - @li wxGetWorkingDirectory - @li wxGetTempFileName - @li wxIsWild - @li wxMatchWild - @li wxMkdir - @li wxParseCommonDialogsFilter - @li wxRemoveFile - @li wxRenameFile - @li wxRmdir - @li wxSetWorkingDirectory - @li wxSplit - @li wxSplitPath - @li wxTransferFileToStream - @li wxTransferStreamToFile - - - @section page_func_cat_networkuseros Network, user and OS functions - - The functions in this section are used to retrieve information about the current - computer and/or user characteristics. - - @li wxGetEmailAddress - @li wxGetFreeMemory - @li wxGetFullHostName - @li wxGetHomeDir - @li wxGetHostName - @li wxGetOsDescription - @li wxGetOsVersion - @li wxIsPlatformLittleEndian - @li wxIsPlatform64Bit - @li wxGetUserHome - @li wxGetUserId - @li wxGetUserName - - - @section page_func_cat_string String functions - - @li wxGetTranslation - @li wxIsEmpty - @li wxStrcmp - @li wxStricmp - @li wxStringEq - @li wxStringMatch - @li wxStringTokenize - @li wxStrlen - @li wxSnprintf - @li wxVsnprintf - - - @section page_func_cat_dialog Dialog functions - - Below are a number of convenience functions for getting input from the user - or displaying messages. Note that in these functions the last three parameters - are optional. However, it is recommended to pass a parent frame parameter, or - (in MS Windows or Motif) the wrong window frame may be brought to the front when - the dialog box is popped up. - - @li wxAboutBox - @li wxBeginBusyCursor - @li wxBell - @li wxCreateFileTipProvider - @li wxDirSelector - @li wxFileSelector - @li wxEndBusyCursor - @li wxGenericAboutBox - @li wxGetColourFromUser - @li wxGetFontFromUser - @li wxGetMultipleChoices - @li wxGetNumberFromUser - @li wxGetPasswordFromUser - @li wxGetTextFromUser - @li wxGetSingleChoice - @li wxGetSingleChoiceIndex - @li wxGetSingleChoiceData - @li wxInfoMessageBox - @li wxIsBusy - @li wxMessageBox - @li wxShowTip - - - @section page_func_cat_math Math functions - - @header{wx/math.h} - - @li wxFinite - @li wxIsNaN - - - @section page_func_cat_gdi GDI functions - - The following are relevant to the GDI (Graphics Device Interface). - - @header{gdicmn.h} - - @li wxBITMAP - @li wxClientDisplayRect - @li wxColourDisplay - @li wxDisplayDepth - @li wxDisplaySize - @li wxDisplaySizeMM - @li wxDROP_ICON - @li wxICON - @li wxMakeMetafilePlaceable - @li wxSetCursor - - - @section page_func_cat_printer Printer settings - - NB: These routines are obsolete and should no longer be used! - - The following functions are used to control PostScript printing. - Under Windows, PostScript output can only be sent to a file. - - @header{wx/dcps.h} - - @li wxGetPrinterCommand - @li wxGetPrinterFile - @li wxGetPrinterMode - @li wxGetPrinterOptions - @li wxGetPrinterOrientation - @li wxGetPrinterPreviewCommand - @li wxGetPrinterScaling - @li wxGetPrinterTranslation - @li wxSetPrinterCommand - @li wxSetPrinterFile - @li wxSetPrinterMode - @li wxSetPrinterOptions - @li wxSetPrinterOrientation - @li wxSetPrinterPreviewCommand - @li wxSetPrinterScaling - @li wxSetPrinterTranslation - - - @section page_func_cat_clipboard Clipboard functions - - These clipboard functions are implemented for Windows only. - The use of these functions is deprecated and the code is no longer maintained. - Use the wxClipboard class instead. - - @header{wx/clipbrd.h} - - @li wxClipboardOpen - @li wxCloseClipboard - @li wxEmptyClipboard - @li wxEnumClipboardFormats - @li wxGetClipboardData - @li wxGetClipboardFormatName - @li wxIsClipboardFormatAvailable - @li wxOpenClipboard - @li wxRegisterClipboardFormat - @li wxSetClipboardData - - - @section page_func_cat_misc Miscellaneous functions and macros - - @li wxBase64Decode - @li wxBase64DecodedSize - @li wxBase64Encode - @li wxBase64EncodedSize - @li wxGetKeyState - @li wxNewId - @li wxRegisterId - @li wxDDECleanUp - @li wxDDEInitialize - @li wxEnableTopLevelWindows - @li wxFindMenuItemId - @li wxFindWindowByLabel - @li wxFindWindowByName - @li wxFindWindowAtPoint - @li wxFindWindowAtPointer - @li wxGetActiveWindow - @li wxGetBatteryState - @li wxGetDisplayName - @li wxGetPowerType - @li wxGetMousePosition - @li wxGetMouseState - @li wxGetStockLabel - @li wxGetTopLevelParent - @li wxLaunchDefaultBrowser - @li wxLoadUserResource - @li wxPostDelete - @li wxPostEvent - @li wxSetDisplayName - @li wxStripMenuCodes - - - @section page_func_cat_log Log functions - - These functions provide a variety of logging functions: see @ref overview_log for - further information. The functions use (implicitly) the currently active log target, - so their descriptions here may not apply if the log target is not the standard one - (installed by wxWidgets in the beginning of the program). - - @header{wx/log.h} - - @li wxDebugMsg - @li wxError - @li wxFatalError - @li wxLogError - @li wxLogFatalError - @li wxLogWarning - @li wxLogMessage - @li wxLogVerbose - @li wxLogStatus - @li wxLogSysError - @li wxLogDebug - @li wxLogTrace - @li wxSafeShowMessage - @li wxSysErrorCode - @li wxSysErrorMsg - @li wxTrace - @li wxTraceLevel - - - @section page_func_cat_time Time functions - - The functions in this section deal with getting the current time and sleeping - for the specified time interval. - - @li wxGetLocalTime - @li wxGetLocalTimeMillis - @li wxGetUTCTime - @li wxMicroSleep - @li wxMilliSleep - @li wxNow - @li wxSleep - @li wxUsleep - - - @section page_func_cat_debug Debugging macros and functions - - Useful macros and functions for error checking and defensive programming. - wxWidgets defines three families of the assert-like macros: the wxASSERT and wxFAIL - macros only do anything if __WXDEBUG__ is defined (in other words, in the debug build) - but disappear completely in the release build. On the other hand, the wxCHECK macros - stay event in release builds but a check failure doesn't generate any user-visible effects - then. Finally, the compile time assertions don't happen during the run-time but result - in the compilation error messages if the condition they check fail. - - @header{wx/debug.h} - - @li wxOnAssert - @li wxTrap - @li wxIsDebuggerRunning - - - @section page_func_cat_env Environment access functions - - The functions in this section allow to access (get) or change value of environment - variables in a portable way. They are currently implemented under Win32 and - POSIX-like systems (Unix). - - @header{wx/utils.h} - - @li wxGetenv - @li wxGetEnv - @li wxSetEnv - @li wxUnsetEnv - - - @section page_func_cat_atomic Atomic operation functions - - When using multi-threaded applications, it is often required to access or modify - memory which is shared between threads. Atomic integer and pointer operations are - an efficient way to handle this issue (another, less efficient, way is to use a mutex - or critical section). A native implementation exists for Windows, Linux, Solaris and - Mac OS X, for other OS, a wxCriticalSection is used to protect the data. - One particular application is reference counting (used by so-called smart pointers). +@section page_func_cat_log Logging - You should define your variable with the type wxAtomicInt in order to apply atomic operations to it. +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). - @header{wx/atomic.h} +Related Overviews: @ref overview_log - @li wxAtomicInc - @li wxAtomicDec +@header{wx/log.h} + +@li ::wxDebugMsg() +@li ::wxError() +@li ::wxFatalError() +@li ::wxLogError() +@li ::wxLogFatalError() +@li ::wxLogWarning() +@li ::wxLogMessage() +@li ::wxLogVerbose() +@li ::wxLogStatus() +@li ::wxLogSysError() +@li ::wxLogDebug() +@li ::wxLogTrace() +@li ::wxSafeShowMessage() +@li ::wxSysErrorCode() +@li ::wxSysErrorMsg() +@li ::wxTrace() +@li ::wxTraceLevel() + + +@section page_func_cat_time Time + +The functions in this section deal with getting the current time and sleeping +for the specified time interval. + +@li ::wxGetLocalTime() +@li ::wxGetLocalTimeMillis() +@li ::wxGetUTCTime() +@li ::wxMicroSleep() +@li ::wxMilliSleep() +@li ::wxNow() +@li ::wxSleep() +@li ::wxUsleep() + + +@section page_func_cat_debug Debugging + +Useful macros and functions for error checking and defensive programming. +wxWidgets defines three families of the assert-like macros: the wxASSERT and +wxFAIL macros only do anything if __WXDEBUG__ is defined (in other words, in +the debug build) but disappear completely in the release build. On the other +hand, the wxCHECK macros stay event in release builds but a check failure +doesn't generate any user-visible effects then. Finally, the compile time +assertions don't happen during the run-time but result in the compilation error +messages if the condition they check fail. + +@header{wx/debug.h} + +@li ::wxOnAssert() +@li ::wxTrap() +@li ::wxIsDebuggerRunning() + + +@section page_func_cat_env Environment + +The functions in this section allow to access (get) or change value of +environment variables in a portable way. They are currently implemented under +Win32 and POSIX-like systems (Unix). + +@header{wx/utils.h} + +@li ::wxGetenv() +@li ::wxGetEnv() +@li ::wxSetEnv() +@li ::wxUnsetEnv() + + +@section page_func_cat_atomic Atomic Operations + +When using multi-threaded applications, it is often required to access or +modify memory which is shared between threads. Atomic integer and pointer +operations are an efficient way to handle this issue (another, less efficient, +way is to use a mutex or critical section). A native implementation exists for +Windows, Linux, Solaris and Mac OS X, for other OS, a wxCriticalSection is used +to protect the data. + +One particular application is reference counting (used by so-called smart +pointers). + +You should define your variable with the type wxAtomicInt in order to apply +atomic operations to it. + +@header{wx/atomic.h} + +@li ::wxAtomicInc() +@li ::wxAtomicDec() + + +@section page_func_cat_misc Miscellaneous + +@li ::wxBase64Decode() +@li ::wxBase64DecodedSize() +@li ::wxBase64Encode() +@li ::wxBase64EncodedSize() +@li ::wxGetKeyState() +@li ::wxNewId() +@li ::wxRegisterId() +@li ::wxDDECleanUp() +@li ::wxDDEInitialize() +@li ::wxEnableTopLevelWindows() +@li ::wxFindMenuItemId() +@li ::wxFindWindowByLabel() +@li ::wxFindWindowByName() +@li ::wxFindWindowAtPoint() +@li ::wxFindWindowAtPointer() +@li ::wxGetActiveWindow() +@li ::wxGetBatteryState() +@li ::wxGetDisplayName() +@li ::wxGetPowerType() +@li ::wxGetMousePosition() +@li ::wxGetMouseState() +@li ::wxGetStockLabel() +@li ::wxGetTopLevelParent() +@li ::wxLaunchDefaultBrowser() +@li ::wxLoadUserResource() +@li ::wxPostDelete() +@li ::wxPostEvent() +@li ::wxSetDisplayName() +@li ::wxStripMenuCodes() + +*/ -*/ \ No newline at end of file diff --git a/docs/doxygen/mainpages/cat_macros.h b/docs/doxygen/mainpages/cat_macros.h index d13dba262b..855b84802d 100644 --- a/docs/doxygen/mainpages/cat_macros.h +++ b/docs/doxygen/mainpages/cat_macros.h @@ -6,165 +6,158 @@ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// +/** + +@page page_macro_cat Macros by Category + +@li @ref page_macro_cat_version +@li @ref page_macro_cat_byteorder +@li @ref page_macro_cat_rtti +@li @ref page_macro_cat_debugging +@li @ref page_macro_cat_misc + + +
+ + +@section page_macro_cat_version Versioning + +The following constants are defined in wxWidgets: + +@li wxMAJOR_VERSION is the major version of wxWidgets +@li wxMINOR_VERSION is the minor version of wxWidgets +@li wxRELEASE_NUMBER is the release number +@li wxSUBRELEASE_NUMBER is the subrelease number which is @c 0 for all + official releases + +For example, the values or these constants for wxWidgets 2.8.7 +are 2, 8, 7 and 0. + +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. + +@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 + +@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__ +@li wxS +@li wxT +@li wxTRANSLATE +@li _ +@li wxPLURAL +@li _T +@li WXTRACE +@li WXTRACELEVEL + + +@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 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 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 +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. + +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 ::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 + +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 + +*/ -/*! - - @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 - - -
- - - - @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__ - @li wxS - @li wxT - @li wxTRANSLATE - @li _ - @li wxPLURAL - @li _T - @li WXTRACE - @li WXTRACELEVEL - - - @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. - - @sa - @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 - - 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 - - -*/ \ No newline at end of file diff --git a/docs/doxygen/overviews/runtimeclass.h b/docs/doxygen/overviews/runtimeclass.h index 6b7add1e45..790bf04d3e 100644 --- a/docs/doxygen/overviews/runtimeclass.h +++ b/docs/doxygen/overviews/runtimeclass.h @@ -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. diff --git a/interface/gdicmn.h b/interface/gdicmn.h index 8256fa8a27..cd3f33a15e 100644 --- a/interface/gdicmn.h +++ b/interface/gdicmn.h @@ -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 @@ -788,10 +785,12 @@ bool wxColourDisplay(); @see @ref overview_wxbitmapoverview, wxICON() */ -#define wxBITMAP() /* implementation is private */ +#define wxBITMAP() /* implementation is private */ /** Returns the depth of the display (a value of 1 denotes a monochrome display). */ int wxDisplayDepth(); +//@} + diff --git a/interface/metafile.h b/interface/metafile.h index 78b060ed68..9fd2a88c1e 100644 --- a/interface/metafile.h +++ b/interface/metafile.h @@ -117,27 +117,30 @@ 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); - SetWindowOrg(dc, minX, minY); - SetWindowExt(dc, maxX - minX, maxY - minY); + SetWindowOrg(dc, minX, minY); + SetWindowExt(dc, maxX - minX, maxY - minY); @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); +//@} +