From: Robert Roebling Date: Thu, 10 Apr 2008 20:02:27 +0000 (+0000) Subject: Rearrange categories, II# X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/7ac7b53386fccfa4a6dc5128286f06e86d4dd842 Rearrange categories, II# git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@53113 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/mainpages/cat_classes.h b/docs/doxygen/mainpages/cat_classes.h index 7aed325b98..3bb6636c0e 100644 --- a/docs/doxygen/mainpages/cat_classes.h +++ b/docs/doxygen/mainpages/cat_classes.h @@ -44,10 +44,10 @@ This page contains a summarized listing of classes, please see the @li @ref page_class_cat_data @li @ref page_class_cat_containers @li @ref page_class_cat_smartpointers -@li @ref page_class_cat_xml @li @ref page_class_cat_file -@li @ref page_class_cat_archive @li @ref page_class_cat_streams +@li @ref page_class_cat_xml +@li @ref page_class_cat_archive @li @ref page_class_cat_xrc @li @ref page_class_cat_net @@ -447,78 +447,100 @@ Related Overviews: @ref overview_validator -@section page_class_cat_data Data Structures - -These are the data structure classes supported by wxWidgets. +@section page_class_cat_appmanagement Application and Process Management +@li wxApp: Application class @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 wxDllLoader: Class to work with shared libraries. +@li wxProcess: Process class -@section page_class_cat_containers Containers +@section page_class_cat_printing Printing Framework -These are classes, templates and class macros are used by wxWidgets. Most of -these classes provide a subset or almost complete STL API. +A printing and previewing framework is implemented to make it relatively +straightforward to provide document printing facilities. -Related Overviews: @ref overview_container +Related Overviews: @ref overview_printing -@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 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_smartpointers Smart Pointers +@section page_class_cat_dvf Document/View Framework -wxWidgets provides a few smart pointer class templates. +wxWidgets supports a document/view framework which provides housekeeping for a +document-centric application. -@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 +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_logging Logging -wxWidgets provides several classes and functions for message logging. +@section page_class_cat_dnd Clipboard and Drag & Drop -Related Overviews: @ref overview_log +Related Overviews: @ref overview_dnd -@see @ref group_funcmacro_log "Logging Functions and Macros" +@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 -@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 + + +@section page_class_cat_vfs Virtual File System + +wxWidgets provides a set of classes that implement an extensible virtual file +system, used internally by the HTML classes. + +@li wxFSFile: Represents a file in the virtual file system +@li wxFileSystem: Main interface for the virtual file system +@li wxFileSystemHandler: Class used to announce file system type + + + +@section page_class_cat_rtti Runtime Type Information (RTTI) + +wxWidgets supports runtime manipulation of class information, and dynamic +creation of objects given class names. + +Related Overviews: @ref overview_rtti + +@see @ref group_funcmacro_rtti "RTTI Functions and Macros" + +@li wxClassInfo: Holds runtime class information +@li wxObject: Root class for classes with runtime information @@ -542,98 +564,97 @@ Related Overviews: @ref overview_debugging -@section page_class_cat_net Networking +@section page_class_cat_logging Logging -wxWidgets provides its own classes for socket based networking. +wxWidgets provides several classes and functions for message logging. -@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 +Related Overviews: @ref overview_log +@see @ref group_funcmacro_log "Logging Functions and Macros" +@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 -@section page_class_cat_ipc Interprocess Communication -wxWidgets provides simple interprocess communications facilities based on -Windows DDE, but available on most platforms using TCP. -Related Overviews: @ref overview_ipc +@section page_class_cat_threading Threading -@li wxClient, wxDDEClient: Represents a client -@li wxConnection, wxDDEConnection: Represents the connection between a client - and a server -@li wxServer, wxDDEServer: Represents a server +wxWidgets provides a set of classes to make use of the native thread +capabilities of the various platforms. + +Related Overviews: @ref overview_thread +@li wxThread: Thread class +@li wxThreadHelper: Manages background threads easily +@li wxMutex: Mutex class +@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 +@section page_class_cat_stc Scintilla Text Editor -@section page_class_cat_dvf Document/View Framework -wxWidgets supports a document/view framework which provides housekeeping for a -document-centric application. +@section page_class_cat_data Data Structures -Related Overviews: @ref overview_docview +These are the data structure classes supported by wxWidgets. -@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 +@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_printing Printing Framework +@section page_class_cat_containers Containers -A printing and previewing framework is implemented to make it relatively -straightforward to provide document printing facilities. +These are classes, templates and class macros are used by wxWidgets. Most of +these classes provide a subset or almost complete STL API. -Related Overviews: @ref overview_printing +Related Overviews: @ref overview_container -@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 +@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_dnd Clipboard and Drag & Drop +@section page_class_cat_smartpointers Smart Pointers -Related Overviews: @ref overview_dnd +wxWidgets provides a few smart pointer class templates. -@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 +@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 @@ -656,17 +677,6 @@ Related Overviews: @ref overview_file -@section page_class_cat_vfs Virtual File System - -wxWidgets provides a set of classes that implement an extensible virtual file -system, used internally by the HTML classes. - -@li wxFSFile: Represents a file in the virtual file system -@li wxFileSystem: Main interface for the virtual file system -@li wxFileSystemHandler: Class used to announce file system type - - - @section page_class_cat_streams Streams wxWidgets has its own set of stream classes, as an alternative to often buggy @@ -706,48 +716,55 @@ standard stream libraries, and to provide enhanced functionality. -@section page_class_cat_threading Threading +@section page_class_cat_xml XML -wxWidgets provides a set of classes to make use of the native thread -capabilities of the various platforms. +@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 -Related Overviews: @ref overview_thread -@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 +@section page_class_cat_archive Archive +@li wxArchiveInputStream +@li wxArchiveOutputStream +@li wxArchiveEntry -@section page_class_cat_rtti Runtime Type Information (RTTI) -wxWidgets supports runtime manipulation of class information, and dynamic -creation of objects given class names. -Related Overviews: @ref overview_rtti +**** -@see @ref group_funcmacro_rtti "RTTI Functions and Macros" +@section page_class_cat_net Networking -@li wxClassInfo: Holds runtime class information -@li wxObject: Root class for classes with runtime information +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_appmanagement Application and Process Management -@li wxApp: Application class -@li wxCmdLineParser: Command line parser class -@li wxDllLoader: Class to work with shared libraries. -@li wxProcess: Process class +@section page_class_cat_ipc Interprocess Communication +wxWidgets provides simple interprocess communications facilities based on +Windows DDE, but available on most platforms using TCP. + +Related Overviews: @ref overview_ipc + +@li wxClient, wxDDEClient: Represents a client +@li wxConnection, wxDDEConnection: Represents the connection between a client + and a server +@li wxServer, wxDDEServer: Represents a server -@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 @@ -758,14 +775,6 @@ indentation, etc. -@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 @@ -806,14 +815,6 @@ Related Overviews: @ref overview_xrc -@section page_class_cat_archive Archive - -@li wxArchiveInputStream -@li wxArchiveOutputStream -@li wxArchiveEntry - - - @section page_class_cat_misc Miscellaneous @li wxCaret: A caret (cursor) object