+ @library{wxadv}
+ @category{grid}
+
+ @see wxGridCellEditor, wxGridCellBoolEditor, wxGridCellFloatEditor,
+ wxGridCellNumberEditor, wxGridCellTextEditor
+*/
+class wxGridCellChoiceEditor : public wxGridCellEditor
+{
+public:
+ /**
+ @param count
+ Number of strings from which the user can choose.
+ @param choices
+ An array of strings from which the user can choose.
+ @param allowOthers
+ If allowOthers is @true, the user can type a string not in choices
+ array.
+ */
+ wxGridCellChoiceEditor(size_t count = 0,
+ const wxString choices[] = NULL,
+ bool allowOthers = false);
+ /**
+ @param choices
+ An array of strings from which the user can choose.
+ @param allowOthers
+ If allowOthers is @true, the user can type a string not in choices
+ array.
+ */
+ wxGridCellChoiceEditor(const wxArrayString& choices,
+ bool allowOthers = false);
+
+ /**
+ Parameters string format is "item1[,item2[...,itemN]]"
+ */
+ virtual void SetParameters(const wxString& params);
+};
+
+/**
+ @class wxGridCellTextEditor
+
+ Grid cell editor for string/text data.
+
+ @library{wxadv}
+ @category{grid}
+
+ @see wxGridCellEditor, wxGridCellBoolEditor, wxGridCellChoiceEditor,
+ wxGridCellFloatEditor, wxGridCellNumberEditor
+*/
+class wxGridCellTextEditor : public wxGridCellEditor
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxGridCellTextEditor();
+
+ /**
+ The parameters string format is "n" where n is a number representing
+ the maximum width.
+ */
+ virtual void SetParameters(const wxString& params);
+};
+
+/**
+ @class wxGridCellFloatEditor
+
+ The editor for floating point numbers data.
+
+ @library{wxadv}
+ @category{grid}
+
+ @see wxGridCellEditor, wxGridCellNumberEditor, wxGridCellBoolEditor,
+ wxGridCellTextEditor, wxGridCellChoiceEditor
+*/
+class wxGridCellFloatEditor : public wxGridCellTextEditor
+{
+public:
+ /**
+ @param width
+ Minimum number of characters to be shown.
+ @param precision
+ Number of digits after the decimal dot.
+ */
+ wxGridCellFloatEditor(int width = -1, int precision = -1);
+
+ /**
+ Parameters string format is "width,precision"
+ */
+ virtual void SetParameters(const wxString& params);
+};
+
+/**
+ @class wxGridCellNumberEditor
+
+ Grid cell editor for numeric integer data.
+
+ @library{wxadv}
+ @category{grid}
+
+ @see wxGridCellEditor, wxGridCellBoolEditor, wxGridCellChoiceEditor,
+ wxGridCellFloatEditor, wxGridCellTextEditor
+*/
+class wxGridCellNumberEditor : public wxGridCellTextEditor
+{
+public:
+ /**
+ Allows you to specify the range for acceptable data. Values equal to
+ -1 for both @a min and @a max indicate that no range checking should be
+ done.
+ */
+ wxGridCellNumberEditor(int min = -1, int max = -1);
+
+
+ /**
+ Parameters string format is "min,max".
+ */
+ virtual void SetParameters(const wxString& params);
+
+protected:
+
+ /**
+ If the return value is @true, the editor uses a wxSpinCtrl to get user
+ input, otherwise it uses a wxTextCtrl.
+ */
+ bool HasRange() const;
+
+ /**
+ String representation of the value.
+ */
+ wxString GetString() const;
+};
+
+
+
+/**
+ @class wxGridCellAttr
+
+ This class can be used to alter the cells' appearance in the grid by
+ changing their attributes from the defaults. An object of this class may be
+ returned by wxGridTableBase::GetAttr().
+
+ @library{wxadv}
+ @category{grid}
+*/
+class wxGridCellAttr
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxGridCellAttr();
+ /**
+ Constructor specifying some of the often used attributes.
+ */
+ wxGridCellAttr(const wxColour& colText, const wxColour& colBack,
+ const wxFont& font, int hAlign, int vAlign);
+
+ /**
+ Creates a new copy of this object.
+ */
+ wxGridCellAttr* Clone() const;
+
+ /**
+ This class is reference counted: it is created with ref count of 1, so
+ calling DecRef() once will delete it. Calling IncRef() allows to lock
+ it until the matching DecRef() is called.
+ */
+ void DecRef();
+
+ /**
+ See SetAlignment() for the returned values.
+ */
+ void GetAlignment(int* hAlign, int* vAlign) const;
+
+ /**
+ Returns the background colour.
+ */
+ const wxColour& GetBackgroundColour() const;
+
+ /**
+ Returns the cell editor.
+ */
+ wxGridCellEditor* GetEditor(const wxGrid* grid, int row, int col) const;
+
+ /**
+ Returns the font.
+ */
+ const wxFont& GetFont() const;
+
+ /**
+ Returns the cell renderer.
+ */
+ wxGridCellRenderer* GetRenderer(const wxGrid* grid, int row, int col) const;
+
+ /**
+ Returns the text colour.
+ */
+ const wxColour& GetTextColour() const;
+
+ /**
+ Returns @true if this attribute has a valid alignment set.
+ */
+ bool HasAlignment() const;
+
+ /**
+ Returns @true if this attribute has a valid background colour set.
+ */
+ bool HasBackgroundColour() const;
+
+ /**
+ Returns @true if this attribute has a valid cell editor set.
+ */
+ bool HasEditor() const;
+
+ /**
+ Returns @true if this attribute has a valid font set.
+ */
+ bool HasFont() const;
+
+ /**
+ Returns @true if this attribute has a valid cell renderer set.
+ */
+ bool HasRenderer() const;
+
+ /**
+ Returns @true if this attribute has a valid text colour set.
+ */
+ bool HasTextColour() const;
+
+ /**
+ This class is reference counted: it is created with ref count of 1, so
+ calling DecRef() once will delete it. Calling IncRef() allows to lock
+ it until the matching DecRef() is called.
+ */
+ void IncRef();
+
+ /**
+ Returns @true if this cell is set as read-only.
+ */
+ bool IsReadOnly() const;
+
+ /**
+ Sets the alignment. @a hAlign can be one of @c wxALIGN_LEFT,
+ @c wxALIGN_CENTRE or @c wxALIGN_RIGHT and @a vAlign can be one of
+ @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
+ */
+ void SetAlignment(int hAlign, int vAlign);
+
+ /**
+ Sets the background colour.
+ */
+ void SetBackgroundColour(const wxColour& colBack);
+
+ /**
+ @todo Needs documentation.
+ */
+ void SetDefAttr(wxGridCellAttr* defAttr);
+
+ /**
+ Sets the editor to be used with the cells with this attribute.
+ */
+ void SetEditor(wxGridCellEditor* editor);
+
+ /**
+ Sets the font.
+ */
+ void SetFont(const wxFont& font);
+
+ /**
+ Sets the cell as read-only.
+ */
+ void SetReadOnly(bool isReadOnly = true);
+
+ /**
+ Sets the renderer to be used for cells with this attribute. Takes
+ ownership of the pointer.
+ */
+ void SetRenderer(wxGridCellRenderer* renderer);
+
+ /**
+ Sets the text colour.
+ */
+ void SetTextColour(const wxColour& colText);
+};
+
+
+
+/**
+ @class wxGridTableBase
+
+ The almost abstract base class for grid tables.
+
+ A grid table is responsible for storing the grid data and, indirectly, grid
+ cell attributes. The data can be stored in the way most convenient for the
+ application but has to be provided in string form to wxGrid. It is also
+ possible to provide cells values in other formats if appropriate, e.g. as
+ numbers.
+
+ This base class is not quite abstract as it implements a trivial strategy
+ for storing the attributes by forwarding it to wxGridCellAttrProvider and
+ also provides stubs for some other functions. However it does have a number
+ of pure virtual methods which must be implemented in the derived classes.
+
+ @see wxGridStringTable
+
+ @library{wxadv}
+ @category{grid}
+*/
+class wxGridTableBase : public wxObject
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxGridTableBase();
+
+ /**
+ Destructor frees the attribute provider if it was created.
+ */
+ virtual ~wxGridTableBase();
+
+ /**
+ Must be overridden to return the number of rows in the table.
+
+ For backwards compatibility reasons, this method is not const.
+ Use GetRowsCount() instead of it in const methods of derived table
+ classes.
+ */
+ virtual int GetNumberRows() = 0;
+
+ /**
+ Must be overridden to return the number of columns in the table.
+
+ For backwards compatibility reasons, this method is not const.
+ Use GetColsCount() instead of it in const methods of derived table
+ classes,
+ */
+ virtual int GetNumberCols() = 0;
+
+ /**
+ Return the number of rows in the table.
+
+ This method is not virtual and is only provided as a convenience for
+ the derived classes which can't call GetNumberRows() without a
+ @c const_cast from their const methods.
+ */
+ int GetRowsCount() const;
+
+ /**
+ Return the number of columns in the table.
+
+ This method is not virtual and is only provided as a convenience for
+ the derived classes which can't call GetNumberCols() without a
+ @c const_cast from their const methods.
+ */
+ int GetColsCount() const;
+
+
+ /**
+ @name Table Cell Accessors
+ */
+ //@{
+
+ /**
+ May be overridden to implement testing for empty cells.
+
+ This method is used by the grid to test if the given cell is not used
+ and so whether a neighbouring cell may overflow into it. By default it
+ only returns true if the value of the given cell, as returned by
+ GetValue(), is empty.
+ */
+ virtual bool IsEmptyCell(int row, int col);
+
+ /**
+ Same as IsEmptyCell() but taking wxGridCellCoords.
+
+ Notice that this method is not virtual, only IsEmptyCell() should be
+ overridden.
+ */
+ bool IsEmpty(const wxGridCellCoords& coords);
+
+ /**
+ Must be overridden to implement accessing the table values as text.
+ */
+ virtual wxString GetValue(int row, int col) = 0;
+
+ /**
+ Must be overridden to implement setting the table values as text.
+ */
+ virtual void SetValue(int row, int col, const wxString& value) = 0;
+
+ /**
+ Returns the type of the value in the given cell.
+
+ By default all cells are strings and this method returns
+ @c wxGRID_VALUE_STRING.
+ */
+ virtual wxString GetTypeName(int row, int col);
+
+ /**
+ Returns true if the value of the given cell can be accessed as if it
+ were of the specified type.
+
+ By default the cells can only be accessed as strings. Note that a cell
+ could be accessible in different ways, e.g. a numeric cell may return
+ @true for @c wxGRID_VALUE_NUMBER but also for @c wxGRID_VALUE_STRING
+ indicating that the value can be coerced to a string form.
+ */
+ virtual bool CanGetValueAs(int row, int col, const wxString& typeName);
+
+ /**
+ Returns true if the value of the given cell can be set as if it were of
+ the specified type.
+
+ @see CanGetValueAs()
+ */
+ virtual bool CanSetValueAs(int row, int col, const wxString& typeName);
+
+ /**
+ Returns the value of the given cell as a long.
+
+ This should only be called if CanGetValueAs() returns @true when called
+ with @c wxGRID_VALUE_NUMBER argument. Default implementation always
+ return 0.
+ */
+ virtual long GetValueAsLong(int row, int col);
+
+ /**
+ Returns the value of the given cell as a double.
+
+ This should only be called if CanGetValueAs() returns @true when called
+ with @c wxGRID_VALUE_FLOAT argument. Default implementation always
+ return 0.0.
+ */
+ virtual double GetValueAsDouble(int row, int col);
+
+ /**
+ Returns the value of the given cell as a boolean.
+
+ This should only be called if CanGetValueAs() returns @true when called
+ with @c wxGRID_VALUE_BOOL argument. Default implementation always
+ return false.
+ */
+ virtual bool GetValueAsBool(int row, int col);
+
+ /**
+ Returns the value of the given cell as a user-defined type.
+
+ This should only be called if CanGetValueAs() returns @true when called
+ with @a typeName. Default implementation always return @NULL.
+ */
+ virtual void *GetValueAsCustom(int row, int col, const wxString& typeName);
+
+ /**
+ Sets the value of the given cell as a long.
+
+ This should only be called if CanSetValueAs() returns @true when called
+ with @c wxGRID_VALUE_NUMBER argument. Default implementation doesn't do
+ anything.
+ */
+ virtual void SetValueAsLong(int row, int col, long value);
+
+ /**
+ Sets the value of the given cell as a double.
+
+ This should only be called if CanSetValueAs() returns @true when called
+ with @c wxGRID_VALUE_FLOAT argument. Default implementation doesn't do
+ anything.
+ */
+ virtual void SetValueAsDouble(int row, int col, double value);
+
+ /**
+ Sets the value of the given cell as a boolean.
+
+ This should only be called if CanSetValueAs() returns @true when called
+ with @c wxGRID_VALUE_BOOL argument. Default implementation doesn't do
+ anything.
+ */
+ virtual void SetValueAsBool( int row, int col, bool value );
+
+ /**
+ Sets the value of the given cell as a user-defined type.
+
+ This should only be called if CanSetValueAs() returns @true when called
projects / wxWidgets.git / blobdiff