From: Vadim Zeitlin Date: Fri, 12 Sep 2008 13:09:03 +0000 (+0000) Subject: add grid category and mark all grid-related classes as belonging to it X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/42b5841f5a6b74bed177bc281400421cee62153c add grid category and mark all grid-related classes as belonging to it git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@55569 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/mainpages/cat_classes.h b/docs/doxygen/mainpages/cat_classes.h index 46f3fd8243..ea42b6da35 100644 --- a/docs/doxygen/mainpages/cat_classes.h +++ b/docs/doxygen/mainpages/cat_classes.h @@ -21,11 +21,12 @@ 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_grid +@li @ref page_class_cat_miscwnd @li @ref page_class_cat_dc @li @ref page_class_cat_gdi @@ -159,7 +160,6 @@ Controls that are not static can have wxValidator associated with them. @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 wxGrid: A grid (table) window @li wxHtmlListBox: An abstract class for creating listboxes showing HTML content @li wxSimpleHtmlListBox: A listbox showing HTML content @@ -326,6 +326,52 @@ with character and paragraph formatting. @li wxRichTextHeaderFooterData: Header and footer data specification. +@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_dc Device Contexts Device contexts are surfaces that may be drawn on, and provide an abstraction diff --git a/interface/wx/grid.h b/interface/wx/grid.h index 47a223594c..773063cc36 100644 --- a/interface/wx/grid.h +++ b/interface/wx/grid.h @@ -12,7 +12,7 @@ This class may be used to format floating point data in a cell. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellStringRenderer, wxGridCellBoolRenderer @@ -29,12 +29,12 @@ public: wxGridCellFloatRenderer(int width = -1, int precision = -1); /** - Returns the precision ( see @ref constr() wxGridCellFloatRenderer ). + Returns the precision. */ int GetPrecision() const; /** - Returns the width ( see @ref constr() wxGridCellFloatRenderer ). + Returns the width. */ int GetWidth() const; @@ -44,12 +44,12 @@ public: void SetParameters(const wxString& params); /** - Sets the precision ( see @ref constr() wxGridCellFloatRenderer ). + Sets the precision. */ void SetPrecision(int precision); /** - Sets the width ( see @ref constr() wxGridCellFloatRenderer ) + Sets the width. */ void SetWidth(int width); }; @@ -62,7 +62,7 @@ public: Grid table classes. @library{wxadv} - @category{FIXME} + @category{grid} */ class wxGridTableBase : public wxObject { @@ -285,7 +285,7 @@ public: even for the entire grid. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellTextEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, wxGridCellNumberEditor, wxGridCellChoiceEditor @@ -387,7 +387,7 @@ public: The editor for string/text data. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, wxGridCellNumberEditor, wxGridCellChoiceEditor @@ -416,7 +416,7 @@ public: for string cells. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer, wxGridCellBoolRenderer @@ -438,7 +438,7 @@ public: The editor for string data allowing to choose from a list of strings. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, wxGridCellTextEditor, wxGridCellNumberEditor @@ -475,7 +475,7 @@ public: @library{wxadv} - @category{FIXME} + @category{grid} */ class wxGridEditorCreatedEvent : public wxCommandEvent { @@ -530,7 +530,7 @@ public: @library{wxadv} - @category{FIXME} + @category{grid} */ class wxGridRangeSelectEvent : public wxNotifyEvent { @@ -620,7 +620,7 @@ public: predefined derived classes or derive your own class from it. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellStringRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer, wxGridCellBoolRenderer @@ -660,7 +660,7 @@ public: The editor for numeric integer data. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, wxGridCellTextEditor, wxGridCellChoiceEditor @@ -699,7 +699,7 @@ public: This event class contains information about a row/column resize event. @library{wxadv} - @category{FIXME} + @category{grid} */ class wxGridSizeEvent : public wxNotifyEvent { @@ -758,7 +758,7 @@ public: This class may be used to format integer data in a cell. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer, wxGridCellBoolRenderer @@ -782,7 +782,7 @@ public: class may be returned by wxGridTableBase::GetAttr. @library{wxadv} - @category{FIXME} + @category{grid} */ class wxGridCellAttr { @@ -932,7 +932,7 @@ public: for string cells. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer, wxGridCellNumberRenderer @@ -954,7 +954,7 @@ public: This event class contains information about various grid events. @library{wxadv} - @category{FIXME} + @category{grid} */ class wxGridEvent : public wxNotifyEvent { @@ -1024,7 +1024,7 @@ public: The editor for floating point numbers data. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellEditor, wxGridCellNumberEditor, wxGridCellBoolEditor, wxGridCellTextEditor, wxGridCellChoiceEditor @@ -2716,7 +2716,7 @@ public: The editor for boolean data. @library{wxadv} - @category{FIXME} + @category{grid} @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellNumberEditor, wxGridCellTextEditor, wxGridCellChoiceEditor @@ -2776,7 +2776,7 @@ public: because you don't risk not to call the latter (due to an exception for example). @library{wxadv} - @category{FIXME} + @category{grid} */ class wxGridUpdateLocker {