X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/bb94502f9fa4d842741769f64c5049463795c3bc..b387025d5d6ba9ca0d860b9962fdbbd5d0723dab:/docs/doxygen/mainpages/cat_classes.h?ds=sidebyside diff --git a/docs/doxygen/mainpages/cat_classes.h b/docs/doxygen/mainpages/cat_classes.h index 6b623f36d6..5fed4d6a98 100644 --- a/docs/doxygen/mainpages/cat_classes.h +++ b/docs/doxygen/mainpages/cat_classes.h @@ -3,66 +3,18 @@ // Purpose: Classes-by-category page of the Doxygen manual // Author: wxWidgets team // RCS-ID: $Id: cat_classes.h 52468 2008-03-13 16:30:38Z FM $ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** @page page_class_cat Summarized Class List by Category +@tableofcontents + This page contains a summarized listing of classes, please see the @ref group_class page for a full listing. -@beginInvisibleTable - -@li @ref page_class_cat_basicwnd -@li @ref page_class_cat_winlayout -@li @ref page_class_cat_managedwnd -@li @ref page_class_cat_menus -@li @ref page_class_cat_ctrl -@li @ref page_class_cat_validator -@li @ref page_class_cat_pickers -@li @ref page_class_cat_aui -@li @ref page_class_cat_cmndlg -@li @ref page_class_cat_html -@li @ref page_class_cat_miscwnd - -@li @ref page_class_cat_dc -@li @ref page_class_cat_gdi -@li @ref page_class_cat_gc -@li @ref page_class_cat_image -@li @ref page_class_cat_events -@li @ref page_class_cat_appmanagement -@li @ref page_class_cat_printing -@li @ref page_class_cat_dvf -@li @ref page_class_cat_dnd -@li @ref page_class_cat_vfs -@li @ref page_class_cat_threading - -@li @ref page_class_cat_rtti -@li @ref page_class_cat_debugging -@li @ref page_class_cat_logging -@li @ref page_class_cat_data -@li @ref page_class_cat_conv -@li @ref page_class_cat_containers -@li @ref page_class_cat_smartpointers -@li @ref page_class_cat_file -@li @ref page_class_cat_streams -@li @ref page_class_cat_xml -@li @ref page_class_cat_xrc - -@li @ref page_class_cat_net -@li @ref page_class_cat_archive -@li @ref page_class_cat_ipc -@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_basicwnd Basic Windows @@ -91,12 +43,12 @@ Related Overviews: @ref overview_sizer These are the classes relevant to sizer-based layout: @li wxSizer: Abstract base class +@li wxBoxSizer: A sizer for laying out windows in a row or column @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 @@ -142,10 +94,10 @@ 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 wxBitmapToggleButton: A toggle button with bitmaps. +@li wxButton: Push button control, displaying text @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 @@ -155,14 +107,16 @@ Controls that are not static can have wxValidator associated with them. @li wxComboCtrl: A combobox with application defined popup @li wxDataViewCtrl: A control to display tabular or tree like data @li wxDataViewTreeCtrl: A specialized wxDataViewCtrl with a wxTreeCtrl-like API +@li wxDataViewListCtrl: A specialized wxDataViewCtrl for displaying and editing simple tables. @li wxEditableListBox: A listbox with editable items. +@li wxFileCtrl: A control for selecting a file. Useful for custom file dialogs. @li wxGauge: A control to represent a varying quantity, such as time remaining @li wxGenericDirCtrl: A control for displaying a directory tree @li wxGrid: A control to display spread-sheet like data in tabular form +@li wxHeaderCtrl: a small control to display the top header of tabular data @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 wxHyperlinkCtrl: A static text which opens an URL when clicked @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 @@ -171,10 +125,13 @@ Controls that are not static can have wxValidator associated with them. @li wxNotebook: A notebook class @li wxOwnerDrawnComboBox: A combobox with owner-drawn list items @li wxPropertyGrid: A complex control to display hierachical, editable information +@li wxRadioBox: A group of radio buttons +@li wxRadioButton: A round button to be used with others in a mutually + exclusive way +@li wxRearrangeCtrl: A control allowing the user to rearrange a list of items. @li wxRichTextCtrl: Generic rich text editing control -@li wxTextCtrl: Single or multiline text editing control -@li wxToggleButton: A button which stays pressed when clicked by user. -@li wxTreeCtrl: Tree (hierarchy) control +@li wxSimpleHtmlListBox: A listbox showing HTML content +@li wxStaticBox: A static, or group box for visually grouping related controls @li wxScrollBar: Scrollbar control @li wxSearchCtrl: A text input control used to initiate a search @li wxSpinButton: A spin or `up-down' control @@ -183,11 +140,11 @@ Controls that are not static can have wxValidator associated with them. @li wxSpinCtrlDouble: A spin control - i.e. spin button and text control displaying a real number @li wxStaticText: One or more lines of non-editable text -@li wxHyperlinkCtrl: A static text which opens an URL when clicked +@li wxTextCtrl: Single or multiline text editing control +@li wxToggleButton: A button which stays pressed when clicked by user. +@li wxTreeCtrl: Tree (hierarchy) control +@li wxTreeListCtrl: Multi-column tree control with simple interface @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 wxStyledTextCtrl: A wxWidgets implementation of the Scintilla source code editing component for plain text editing. @li wxSlider: A slider that can be dragged by the user @@ -204,6 +161,8 @@ Related Overviews: @ref overview_validator @li wxValidator: Base validator class @li wxTextValidator: Text control validator class @li wxGenericValidator: Generic control validator class +@li wxIntegerValidator: Text control validator class for integer numbers +@li wxFloatingPointValidator: Text control validator class for floating point numbers @@ -235,6 +194,8 @@ The following are a variety of classes that are derived from wxWindow. @li wxHVScrolledWindow: As ::wxScrolledWindow but supports scroll units of variable sizes. @li wxGrid: A grid (table) window +@li wxInfoBar: An information bar usually shown on top of the main window. +@li wxRichToolTip: A customizable tooltip. @li wxSplitterWindow: Window which can be split vertically or horizontally @li wxStatusBar: Implements the status bar on a frame @li wxToolBar: Toolbar class @@ -245,9 +206,11 @@ The following are a variety of classes that are derived from wxWindow. @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 wxSimplebook: Another book control but one allowing only the program, not + the user, to change its current page. @li wxWizardPage: A base class for the page in wizard dialog. @li wxWizardPageSimple: A page in wizard dialog. - +@li wxCustomBackgroundWindow: A window allowing to set a custom bitmap. @section page_class_cat_aui Window Docking (wxAUI) @@ -279,19 +242,21 @@ Related Overviews: @ref overview_cmndlg @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 wxMessageDialog: Simple message box dialog +@li wxMultiChoiceDialog: Dialog to get one or more selections from a list @li wxPageSetupDialog: Standard page setup dialog +@li wxPasswordEntryDialog: Dialog to get a password from the user @li wxPrintDialog: Standard print dialog @li wxProgressDialog: Progress indication dialog -@li wxMessageDialog: Simple message box dialog -@li wxSymbolPickerDialog: Symbol selector dialog +@li wxRearrangeDialog: Dialog allowing the user to rearrange a list of items. @li wxRichTextFormattingDialog: A dialog for formatting the content of a wxRichTextCtrl +@li wxRichMessageDialog: Nicer message box dialog +@li wxSingleChoiceDialog: Dialog to get a single selection from a list and + return the string +@li wxSymbolPickerDialog: Symbol selector dialog +@li wxTextEntryDialog: Dialog to get a single line of text from the user @li wxWizard: A wizard dialog. @@ -401,7 +366,7 @@ Related Overviews: @ref overview_bitmap An event object contains information about a specific event. Event handlers (usually member functions) have a single, event argument. -Related Overviews: @ref overview_eventhandling +Related Overviews: @ref overview_events @li wxActivateEvent: A window or application activation event @li wxCalendarEvent: Used with wxCalendarCtrl @@ -424,12 +389,14 @@ Related Overviews: @ref overview_eventhandling @li wxIdleEvent: An idle event @li wxInitDialogEvent: A dialog initialisation event @li wxJoystickEvent: A joystick event +@li wxKeyboardState: State of the keyboard modifiers. @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 wxMouseState: State of the mouse @li wxMoveEvent: A move event @li wxNavigationKeyEvent: An event set by navigation keys such as tab @li wxNotebookEvent: A notebook control event @@ -595,7 +562,7 @@ Related Overviews: @ref overview_debugging wxWidgets provides several classes and functions for message logging. -Related Overviews: @ref overview_log +Related overview: @ref overview_log @see @ref group_funcmacro_log "Logging Functions and Macros" @@ -617,6 +584,7 @@ Related Overviews: @ref overview_log These are the data structure classes supported by wxWidgets. +@li wxAny: A class for storing arbitrary types that may change at run-time @li wxCmdLineParser: Command line parser class @li wxDateSpan: A logical time interval. @li wxDateTime: A class for date/time manipulations @@ -643,13 +611,13 @@ These are the data structure classes supported by wxWidgets. These classes define objects for performing conversions between different multibyte and Unicode encodings and wide character strings. -@li wxMBConv: Base class for all convertors, defines the API implemented by all - the other convertor classes. -@li wxMBConvUTF7: Convertor for UTF-7 -@li wxMBConvUTF8: Convertor for UTF-8 -@li wxMBConvUTF16: Convertor for UTF-16 -@li wxMBConvUTF32: Convertor for UTF-32 -@li wxCSConv: Convertor for any system-supported encoding which can be +@li wxMBConv: Base class for all converters, defines the API implemented by all + the other converter classes. +@li wxMBConvUTF7: Converter for UTF-7 +@li wxMBConvUTF8: Converter for UTF-8 +@li wxMBConvUTF16: Converter for UTF-16 +@li wxMBConvUTF32: Converter for UTF-32 +@li wxCSConv: Converter for any system-supported encoding which can be specified by name. Related Overviews: @ref overview_mbconv @@ -687,7 +655,7 @@ wxWidgets provides a few smart pointer class templates. wxWidgets has several small classes to work with disk files and directories. -Related Overviews: @ref overview_file +Related overview: @ref overview_file @li wxFileName: Operations with the file name and attributes @li wxDir: Class for enumerating files/subdirectories. @@ -699,13 +667,16 @@ Related Overviews: @ref overview_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 +@li wxFileSystemWatcher: Class providing notifications of file system changes @section page_class_cat_streams Streams -wxWidgets has its own set of stream classes, as an alternative to often buggy -standard stream libraries, and to provide enhanced functionality. +wxWidgets has its own set of stream classes as an alternative to the +standard stream libraries and to provide enhanced functionality. + +Related overview: @ref overview_stream @li wxStreamBase: Stream base class @li wxStreamBuffer: Stream buffer class @@ -762,7 +733,7 @@ standard stream libraries, and to provide enhanced functionality. Resources allow your application to create controls and other user interface elements from specifications stored in an XML format. -Related Overviews: @ref overview_xrc +Related overview: @ref overview_xrc @li wxXmlResource: The main class for working with resources @li wxXmlResourceHandler: The base class for XML resource handlers @@ -792,7 +763,7 @@ wxWidgets provides its own classes for socket based networking. wxWidgets provides simple interprocess communications facilities based on Windows DDE, but available on most platforms using TCP. -Related Overviews: @ref overview_ipc +Related overview: @ref overview_ipc @li wxClient, wxDDEClient: Represents a client @li wxConnection, wxDDEConnection: Represents the connection between a client