X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/2b3416df5d2fe261c67dfc08156ab5745e28c1af..7664a67f57db442025638bb87099fb2826bc2400:/docs/doxygen/mainpages/cat_classes.h diff --git a/docs/doxygen/mainpages/cat_classes.h b/docs/doxygen/mainpages/cat_classes.h index 1420509a69..28f225d2db 100644 --- a/docs/doxygen/mainpages/cat_classes.h +++ b/docs/doxygen/mainpages/cat_classes.h @@ -21,15 +21,18 @@ This page contains a summarized listing of classes, please see the @li @ref page_class_cat_menus @li @ref page_class_cat_ctrl @li @ref page_class_cat_pickers -@li @ref page_class_cat_miscwnd @li @ref page_class_cat_aui @li @ref page_class_cat_cmndlg @li @ref page_class_cat_html @li @ref page_class_cat_richtext -@li @ref page_class_cat_stc +@li @ref page_class_cat_grid +@li @ref page_class_cat_miscwnd +@li @ref page_class_cat_propgrid @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_validator @li @ref page_class_cat_appmanagement @@ -43,15 +46,16 @@ This page contains a summarized listing of classes, please see the @li @ref page_class_cat_logging @li @ref page_class_cat_threading @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_archive @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 @@ -71,9 +75,8 @@ The following are the most important window classes @li wxWindow: base class for all windows and controls @li wxControl: base class (mostly) for native controls/widgets @li wxPanel: window which can smartly manage child windows -@li wxScrolledWindow: Window with automatically managed scrollbars (see wxScrolled) -@li wxVScrolledWindow: As wxScrolledWindow but supports lines of variable - height +@li ::wxScrolledWindow: Window with automatically managed scrollbars (see + wxScrolled) @li wxTopLevelWindow: Any top level window, dialog or frame @@ -86,7 +89,7 @@ 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 +Related Overviews: @ref overview_sizer These are the classes relevant to sizer-based layout: @@ -100,11 +103,6 @@ These are the classes relevant to sizer-based layout: @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 @@ -150,7 +148,6 @@ Controls that are not static can have wxValidator associated with them. @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 @@ -161,6 +158,7 @@ Controls that are not static can have wxValidator associated with them. @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 wxEditableListBox: A listbox with editable items. @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 @@ -172,19 +170,26 @@ Controls that are not static can have wxValidator associated with them. multicolumn report view @li wxListView: A simpler interface (façade) for wxListCtrl in report mode +@li wxNotebook: A notebook class @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 wxToggleButton: A button which stays pressed when clicked by user. @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 wxSpinCtrl: A spin control - i.e. spin button and text control displaying + an integer +@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 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 @li wxVListBox: A listbox supporting variable height rows @@ -207,8 +212,16 @@ platform-dependent. The following are a variety of classes that are derived from wxWindow. +@li wxCollapsiblePane: A panel which can be shown/hidden by the user @li wxPanel: A window whose colour changes according to current user settings -@li wxScrolledWindow: Window with automatically managed scrollbars +@li ::wxScrolledWindow: Window with automatically managed scrollbars (see + wxScrolled) +@li wxHScrolledWindow: As ::wxScrolledWindow but supports columns of variable + widths +@li wxVScrolledWindow: As ::wxScrolledWindow but supports rows of variable + heights +@li wxHVScrolledWindow: As ::wxScrolledWindow but supports scroll units of + variable sizes. @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 @@ -220,8 +233,6 @@ 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 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. @@ -316,16 +327,56 @@ with character and paragraph formatting. @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_grid Grid + +wxGrid represents a two-dimensional table of data. It supports custom +attributes for the table cells, allowing to completely customize its +appearance and uses a separate grid table (wxGridTableBase-derived) class for +the data management meaning that it can be used to display arbitrary amounts of +data. + +@li wxGrid: The main grid control class itself. +@li wxGridTableBase: The base class for grid data provider. +@li wxGridStringTable: Simple wxGridTableBase implementation supporting only + string data items and storing them all in memory (hence suitable for not + too large grids only). +@li wxGridCellAttr: A cell attribute, allowing to customize its appearance as + well as the renderer and editor used for displaying and editing it. +@li wxGridCellAttrProvider: The object responsible for storing and retrieving + the cell attributes. +@li wxGridColLabelWindow: The window showing the grid columns labels. +@li wxGridRowLabelWindow: The window showing the grid rows labels. +@li wxGridCornerLabelWindow: The window used in the upper left grid corner. +@li wxGridWindow: The window representing the main part of the grid. +@li wxGridCellRenderer: Base class for objects used to display a cell value. +@li wxGridCellStringRenderer: Renderer showing the cell as a text string. +@li wxGridCellNumberRenderer: Renderer showing the cell as an integer number. +@li wxGridCellFloatRenderer: Renderer showing the cell as a floating point + number. +@li wxGridCellBoolRenderer: Renderer showing the cell as checked or unchecked + box. +@li wxGridCellEditor: Base class for objects used to edit the cell value. +@li wxGridCellStringEditor: Editor for cells containing text strings. +@li wxGridCellNumberEditor: Editor for cells containing integer numbers. +@li wxGridCellFloatEditor: Editor for cells containing floating point numbers. +@li wxGridCellBoolEditor: Editor for boolean-valued cells. +@li wxGridCellChoiceEditor: Editor allowing to choose one of the predefined + strings (and possibly enter new one). +@li wxGridEvent: The event sent by most of wxGrid actions. +@li wxGridSizeEvent: The special event sent when a grid column or row is + resized. +@li wxGridRangeSelectEvent: The special event sent when a range of cells is + selected in the grid. +@li wxGridEditorCreatedEvent: The special event sent when a cell editor is + created. +@li wxGridSelection: The object efficiently representing the grid selection. +@li wxGridTypeRegistry: Contains information about the data types supported by + the grid. + +@section page_class_cat_propgrid Property Grid + +wxPropertyGrid is a property sheet control, which API consists of +various classes listed here. @section page_class_cat_dc Device Contexts @@ -356,36 +407,63 @@ Related Overviews: @ref overview_dc +@section page_class_cat_gc Graphics Context classes + +These classes are related to drawing using a new vector based drawing API and +are based on the modern drawing backend GDI+, CoreGraphics and Cairo. + +@li wxGraphicsRenderer: Represents a drawing engine. +@li wxGraphicsContext: Represents a graphics context currently being drawn on. +@li wxGraphicsBrush: Brush for drawing into a wxGraphicsContext +@li wxGraphicsPen: Pen for drawing into a wxGraphicsContext +@li wxGraphicsFont: Font for drawing text on a wxGraphicsContext +@li wxGraphicsMatrix: Represents an affine matrix for drawing transformation +@li wxGraphicsPath: Represents a path for drawing + + + @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_image Image and bitmap classes + +These classes represent images and bitmap in various formats and ways +to access and create them. + +Related Overviews: @ref overview_bitmap + +@li wxAnimation: Represents an animation +@li wxBitmap: Represents a platform dependent bitmap +@li wxBitmapHandler: Class for loading a saving a wxBitmap in a specific format +@li wxCursor: A small, transparent bitmap representing the cursor +@li wxIcon: A small, transparent bitmap for assigning to frames and drawing on + device contexts +@li wxImage: A platform-independent image class +@li wxImageHandler: Class for loading a saving a wxImage in a specific format +@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 wxMemoryDC: A device context for drawing into bitmaps +@li wxPixelData: Class template for direct access to wxBitmap's and wxImage's internal data + + + @section page_class_cat_events Events An event object contains information about a specific event. Event handlers @@ -462,7 +540,7 @@ Related Overviews: @ref overview_validator @li wxApp: Application class @li wxCmdLineParser: Command line parser class -@li wxDllLoader: Class to work with shared libraries. +@li wxDynamicLibrary: Class to work with shared libraries. @li wxProcess: Process class @@ -640,6 +718,23 @@ These are the data structure classes supported by wxWidgets. +@section page_class_cat_conv Text Conversion + +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 + specified by name. + +Related Overviews: @ref overview_mbconv + + @section page_class_cat_containers Containers These are classes, templates and class macros are used by wxWidgets. Most of