/////////////////////////////////////////////////////////////////////////////
// Name: grid.h
-// Purpose: interface of wxGridCellFloatRenderer
+// Purpose: interface of wxGrid and related classes
// Author: wxWidgets team
// RCS-ID: $Id$
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
+/**
+ @class wxGridCellRenderer
+
+ This class is responsible for actually drawing the cell in the grid. You
+ may pass it to the wxGridCellAttr (below) to change the format of one given
+ cell or to wxGrid::SetDefaultRenderer() to change the view of all cells.
+ This is an abstract class, and you will normally use one of the predefined
+ derived classes or derive your own class from it.
+
+ @library{wxadv}
+ @category{grid}
+
+ @see wxGridCellBoolRenderer, wxGridCellFloatRenderer,
+ wxGridCellNumberRenderer, wxGridCellStringRenderer
+*/
+class wxGridCellRenderer
+{
+public:
+ /**
+ This function must be implemented in derived classes to return a copy
+ of itself.
+ */
+ virtual wxGridCellRenderer* Clone() const = 0;
+
+ /**
+ Draw the given cell on the provided DC inside the given rectangle using
+ the style specified by the attribute and the default or selected state
+ corresponding to the isSelected value.
+
+ This pure virtual function has a default implementation which will
+ prepare the DC using the given attribute: it will draw the rectangle
+ with the background colour from attr and set the text colour and font.
+ */
+ virtual void Draw(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
+ const wxRect& rect, int row, int col,
+ bool isSelected) = 0;
+
+ /**
+ Get the preferred size of the cell for its contents.
+ */
+ virtual wxSize GetBestSize(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
+ int row, int col) = 0;
+};
+
+/**
+ @class wxGridCellBoolRenderer
+
+ This class may be used to format boolean data in a cell.
+
+ @library{wxadv}
+ @category{grid}
+
+ @see wxGridCellRenderer, wxGridCellFloatRenderer, wxGridCellNumberRenderer,
+ wxGridCellStringRenderer
+*/
+class wxGridCellBoolRenderer : public wxGridCellRenderer
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxGridCellBoolRenderer();
+};
+
/**
@class wxGridCellFloatRenderer
@library{wxadv}
@category{grid}
- @see wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellStringRenderer,
- wxGridCellBoolRenderer
+ @see wxGridCellRenderer, wxGridCellBoolRenderer, wxGridCellNumberRenderer,
+ wxGridCellStringRenderer
*/
class wxGridCellFloatRenderer : public wxGridCellStringRenderer
{
void SetWidth(int width);
};
-
-
/**
- @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.
+ @class wxGridCellNumberRenderer
- @see wxGridStringTable
+ This class may be used to format integer data in a cell.
@library{wxadv}
@category{grid}
+
+ @see wxGridCellRenderer, wxGridCellBoolRenderer, wxGridCellFloatRenderer,
+ wxGridCellStringRenderer
*/
-class wxGridTableBase : public wxObject
+class wxGridCellNumberRenderer : public wxGridCellStringRenderer
{
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.
+ Default constructor.
+ */
+ wxGridCellNumberRenderer();
+};
- 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;
+/**
+ @class wxGridCellStringRenderer
- /**
- Must be overridden to return the number of columns in the table.
+ This class may be used to format string data in a cell; it is the default
+ for string cells.
- 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;
+ @library{wxadv}
+ @category{grid}
+ @see wxGridCellRenderer, wxGridCellBoolRenderer, wxGridCellFloatRenderer,
+ wxGridCellNumberRenderer
+*/
+class wxGridCellStringRenderer : public wxGridCellRenderer
+{
+public:
/**
- Return the number of rows in the table.
+ Default constructor.
+ */
+ wxGridCellStringRenderer();
+};
- 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;
+/**
+ @class wxGridCellEditor
+ This class is responsible for providing and manipulating the in-place edit
+ controls for the grid. Instances of wxGridCellEditor (actually, instances
+ of derived classes since it is an abstract class) can be associated with
+ the cell attributes for individual cells, rows, columns, or even for the
+ entire grid.
- /**
- Accessing table cells.
- */
- //@{
+ @library{wxadv}
+ @category{grid}
- /// Must be overridden to implement testing for empty cells.
- virtual bool IsEmptyCell(int row, int col) = 0;
+ @see wxGridCellBoolEditor, wxGridCellChoiceEditor, wxGridCellFloatEditor,
+ wxGridCellNumberEditor, wxGridCellTextEditor
+*/
+class wxGridCellEditor
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxGridCellEditor();
/**
- Same as IsEmptyCell() but taking wxGridCellCoords.
+ Fetch the value from the table and prepare the edit control to begin
+ editing. Sets the focus to the edit control.
+ */
+ virtual void BeginEdit(int row, int col, wxGrid* grid) = 0;
- Notice that this method is not virtual, only IsEmptyCell() should be
- overridden.
- */
- bool IsEmpty(const wxGridCellCoords& coords);
+ /**
+ Create a new object which is the copy of this one.
+ */
+ virtual wxGridCellEditor* Clone() const = 0;
- /// Must be overridden to implement accessing the table values as text.
- virtual wxString GetValue(int row, int col) = 0;
+ /**
+ Creates the actual edit control.
+ */
+ virtual void Create(wxWindow* parent, wxWindowID id,
+ wxEvtHandler* evtHandler) = 0;
- /// Must be overridden to implement setting the table values as text.
- virtual void SetValue(int row, int col, const wxString& value) = 0;
+ /**
+ Final cleanup.
+ */
+ virtual void Destroy();
/**
- Returns the type of the value in the given cell.
+ Complete the editing of the current cell. If necessary, the control may
+ be destroyed.
- By default all cells are strings and this method returns @c
- wxGRID_VALUE_STRING.
- */
- virtual wxString GetTypeName(int row, int col);
+ @return @true if the value has changed.
+ */
+ virtual bool EndEdit(int row, int col, wxGrid* grid) = 0;
/**
- 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);
+ Some types of controls on some platforms may need some help with the
+ Return key.
+ */
+ virtual void HandleReturn(wxKeyEvent& event);
/**
- Returns true if the value of the given cell can be set as if it were of
- the specified type.
+ Returns @true if the edit control has been created.
+ */
+ bool IsCreated();
- @see CanGetValueAs()
- */
- virtual bool CanSetValueAs(int row, int col, const wxString& typeName);
+ /**
+ Draws the part of the cell not occupied by the control: the base class
+ version just fills it with background colour from the attribute.
+ */
+ virtual void PaintBackground(const wxRect& rectCell, wxGridCellAttr* attr);
/**
- Returns the value of the given cell as a long.
+ Reset the value in the control back to its starting value.
+ */
+ virtual void Reset() = 0;
- 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);
+ /**
+ Size and position the edit control.
+ */
+ virtual void SetSize(const wxRect& rect);
/**
- Returns the value of the given cell as a double.
+ Show or hide the edit control, use the specified attributes to set
+ colours/fonts for it.
+ */
+ virtual void Show(bool show, wxGridCellAttr* attr = NULL);
- 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);
+ /**
+ If the editor is enabled by clicking on the cell, this method will be
+ called.
+ */
+ virtual void StartingClick();
/**
- Returns the value of the given cell as a boolean.
+ If the editor is enabled by pressing keys on the grid, this will be
+ called to let the editor do something about that first key if desired.
+ */
+ virtual void StartingKey(wxKeyEvent& event);
- 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);
+protected:
/**
- Returns the value of the given cell as a user-defined type.
+ The destructor is private because only DecRef() can delete us.
+ */
+ virtual ~wxGridCellEditor();
+};
- 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);
+/**
+ @class wxGridCellBoolEditor
+ Grid cell editor for boolean data.
+
+ @library{wxadv}
+ @category{grid}
+ @see wxGridCellEditor, wxGridCellChoiceEditor, wxGridCellFloatEditor,
+ wxGridCellNumberEditor, wxGridCellTextEditor
+*/
+class wxGridCellBoolEditor : public wxGridCellEditor
+{
+public:
/**
- Sets the value of the given cell as a long.
+ Default constructor.
+ */
+ wxGridCellBoolEditor();
- 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);
+ /**
+ Returns @true if the given @a value is equal to the string
+ representation of the truth value we currently use (see
+ UseStringValues()).
+ */
+ static bool IsTrueValue(const wxString& value);
/**
- Sets the value of the given cell as a double.
+ This method allows you to customize the values returned by GetValue()
+ for the cell using this editor. By default, the default values of the
+ arguments are used, i.e. @c "1" is returned if the cell is checked and
+ an empty string otherwise.
+ */
+ static void UseStringValues(const wxString& valueTrue = "1",
+ const wxString& valueFalse = wxEmptyString) const;
+};
- 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);
+/**
+ @class wxGridCellChoiceEditor
- /**
- Sets the value of the given cell as a boolean.
+ Grid cell editor for string data providing the user a choice from a list of
+ strings.
- This should only be called if CanSetValueAs() returns @true when called
- with @c wxGRID_VALUE_BOOL argument. Default implementation doesn't do
- anything.
+ @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 );
//@}
+
/**
Called by the grid when the table is associated with it.
/**
- Modifying the table structure.
+ @name Table Structure Modifiers
Notice that none of these functions are pure virtual as they don't have
to be implemented if the table structure is never modified after
arbitrary locations. In such case you may implement this method only
and leave InsertRows() unimplemented.
- @param pos
- The position of the first new row.
@param numRows
The number of rows to add.
*/
*/
virtual bool DeleteRows(size_t pos = 0, size_t numRows = 1);
- /// Exactly the same as InsertRows() but for columns.
+ /**
+ Exactly the same as InsertRows() but for columns.
+ */
virtual bool InsertCols(size_t pos = 0, size_t numCols = 1);
- /// Exactly the same as AppendRows() but for columns.
+ /**
+ Exactly the same as AppendRows() but for columns.
+ */
virtual bool AppendCols(size_t numCols = 1);
- /// Exactly the same as DeleteRows() but for columns.
+ /**
+ Exactly the same as DeleteRows() but for columns.
+ */
virtual bool DeleteCols(size_t pos = 0, size_t numCols = 1);
//@}
/**
- Table rows and columns labels.
+ @name Table Row and Column Labels
By default the numbers are used for labeling rows and Latin letters for
labeling columns. If the table has more than 26 columns, the pairs of
*/
//@{
- /// Return the label of the specified row.
- virtual wxString GetRowLabelValue(int row);
-
- /// Return the label of the specified column.
- virtual wxString GetColLabelValue(int col);
-
- /**
- Set the given label for the specified row.
-
- The default version does nothing, i.e. the label is not stored. You
- must override this method in your derived class if you wish
- wxGrid::SetRowLabelValue() to work.
- */
- virtual void SetRowLabelValue(int row, const wxString& label);
-
- /// Exactly the same as SetRowLabelValue() but for columns.
- virtual void SetColLabelValue(int col, const wxString& label);
-
- //@}
-
-
- /**
- Attributes management.
-
- By default the attributes management is delegated to
- wxGridCellAttrProvider class. You may override the methods in this
- section to handle the attributes directly if, for example, they can be
- computed from the cell values.
- */
- //@{
-
- /**
- Associate this attributes provider with the table.
-
- The table takes ownership of @a attrProvider pointer and will delete it
- when it doesn't need it any more. The pointer can be @NULL, however
- this won't disable attributes management in the table but will just
- result in a default attributes being recreated the next time any of the
- other functions in this section is called. To completely disable the
- attributes support, should this be needed, you need to override
- CanHaveAttributes() to return @false.
- */
- void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
-
- /**
- Returns the attribute provider currently being used.
-
- This function may return @NULL if the attribute provider hasn't been
- neither associated with this table by SetAttrProvider() nor created on
- demand by any other methods.
- */
- wxGridCellAttrProvider *GetAttrProvider() const { return m_attrProvider; }
-
- /**
- Returns true if this table supports attributes or false otherwise.
-
- By default, the table automatically creates a wxGridCellAttrProvider
- when this function is called if it had no attribute provider before and
- returns @true.
- */
- virtual bool CanHaveAttributes();
-
- /**
- Return the attribute for the given cell.
-
- By default this function is simply forwarded to
- wxGridCellAttrProvider::GetAttr() but it may be overridden to handle
- attributes directly in the table.
- */
- virtual wxGridCellAttr *GetAttr(int row, int col,
- wxGridCellAttr::wxAttrKind kind);
-
- /**
- Set attribute of the specified cell.
-
- By default this function is simply forwarded to
- wxGridCellAttrProvider::SetAttr().
-
- The table takes ownership of @a attr, i.e. will call DecRef() on it.
- */
- virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
-
- /**
- Set attribute of the specified row.
-
- By default this function is simply forwarded to
- wxGridCellAttrProvider::SetRowAttr().
-
- The table takes ownership of @a attr, i.e. will call DecRef() on it.
- */
- virtual void SetRowAttr(wxGridCellAttr *attr, int row);
-
/**
- Set attribute of the specified column.
-
- By default this function is simply forwarded to
- wxGridCellAttrProvider::SetColAttr().
-
- The table takes ownership of @a attr, i.e. will call DecRef() on it.
+ Return the label of the specified row.
*/
- virtual void SetColAttr(wxGridCellAttr *attr, int col);
-
- //@}
-};
-
-
-
-/**
- @class wxGridCellEditor
-
- This class is responsible for providing and manipulating
- the in-place edit controls for the grid. Instances of wxGridCellEditor
- (actually, instances of derived classes since it is an abstract class) can be
- associated with the cell attributes for individual cells, rows, columns, or
- even for the entire grid.
-
- @library{wxadv}
- @category{grid}
-
- @see wxGridCellTextEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
- wxGridCellNumberEditor, wxGridCellChoiceEditor
-*/
-class wxGridCellEditor
-{
-public:
- /**
-
- */
- wxGridCellEditor();
-
- /**
- The dtor is private because only DecRef() can delete us.
- */
- virtual ~wxGridCellEditor();
-
- /**
- Fetch the value from the table and prepare the edit control
- to begin editing. Set the focus to the edit control.
- */
- virtual void BeginEdit(int row, int col, wxGrid* grid) = 0;
-
- /**
- Create a new object which is the copy of this one.
- */
- virtual wxGridCellEditor* Clone() const = 0;
-
- /**
- Creates the actual edit control.
- */
- void Create(wxWindow* parent, wxWindowID id,
- wxEvtHandler* evtHandler);
-
- /**
- Final cleanup.
- */
- virtual void Destroy();
-
- /**
- Complete the editing of the current cell. Returns @true if the value has
- changed. If necessary, the control may be destroyed.
- */
- virtual bool EndEdit(int row, int col, wxGrid* grid) = 0;
-
- /**
- Some types of controls on some platforms may need some help
- with the Return key.
- */
- virtual void HandleReturn(wxKeyEvent& event);
-
- /**
-
- */
- bool IsCreated();
-
- /**
- Draws the part of the cell not occupied by the control: the base class
- version just fills it with background colour from the attribute.
- */
- void PaintBackground(const wxRect& rectCell,
- wxGridCellAttr* attr);
-
- /**
- Reset the value in the control back to its starting value.
- */
- virtual void Reset() = 0;
-
- /**
- Size and position the edit control.
- */
- virtual void SetSize(const wxRect& rect);
-
- /**
- Show or hide the edit control, use the specified attributes to set
- colours/fonts for it.
- */
- virtual void Show(bool show, wxGridCellAttr* attr = NULL);
-
- /**
- If the editor is enabled by clicking on the cell, this method will be
- called.
- */
- virtual void StartingClick();
-
- /**
- If the editor is enabled by pressing keys on the grid,
- this will be called to let the editor do something about
- that first key if desired.
- */
- virtual void StartingKey(wxKeyEvent& event);
-};
-
-
-
-/**
- @class wxGridCellTextEditor
-
- The editor for string/text data.
-
- @library{wxadv}
- @category{grid}
-
- @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
- wxGridCellNumberEditor, wxGridCellChoiceEditor
-*/
-class wxGridCellTextEditor : public wxGridCellEditor
-{
-public:
- /**
- Default constructor.
- */
- wxGridCellTextEditor();
+ virtual wxString GetRowLabelValue(int row);
/**
- The parameters string format is "n" where n is a number representing the
- maximum width.
- */
- virtual void SetParameters(const wxString& params);
-};
+ Return the label of the specified column.
+ */
+ virtual wxString GetColLabelValue(int col);
+ /**
+ Set the given label for the specified row.
+ The default version does nothing, i.e. the label is not stored. You
+ must override this method in your derived class if you wish
+ wxGrid::SetRowLabelValue() to work.
+ */
+ virtual void SetRowLabelValue(int row, const wxString& label);
-/**
- @class wxGridCellStringRenderer
+ /**
+ Exactly the same as SetRowLabelValue() but for columns.
+ */
+ virtual void SetColLabelValue(int col, const wxString& label);
- This class may be used to format string data in a cell; it is the default
- for string cells.
+ //@}
- @library{wxadv}
- @category{grid}
- @see wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer,
- wxGridCellBoolRenderer
-*/
-class wxGridCellStringRenderer : public wxGridCellRenderer
-{
-public:
/**
- Default constructor
- */
- wxGridCellStringRenderer();
-};
-
+ @name Attributes Management
+ By default the attributes management is delegated to
+ wxGridCellAttrProvider class. You may override the methods in this
+ section to handle the attributes directly if, for example, they can be
+ computed from the cell values.
+ */
+ //@{
-/**
- @class wxGridCellChoiceEditor
-
- The editor for string data allowing to choose from a list of strings.
+ /**
+ Associate this attributes provider with the table.
- @library{wxadv}
- @category{grid}
+ The table takes ownership of @a attrProvider pointer and will delete it
+ when it doesn't need it any more. The pointer can be @NULL, however
+ this won't disable attributes management in the table but will just
+ result in a default attributes being recreated the next time any of the
+ other functions in this section is called. To completely disable the
+ attributes support, should this be needed, you need to override
+ CanHaveAttributes() to return @false.
+ */
+ void SetAttrProvider(wxGridCellAttrProvider *attrProvider);
- @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
- wxGridCellTextEditor, wxGridCellNumberEditor
-*/
-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);
- wxGridCellChoiceEditor(const wxArrayString& choices,
- bool allowOthers = false);
- //@}
+ Returns the attribute provider currently being used.
+
+ This function may return @NULL if the attribute provider hasn't been
+ neither associated with this table by SetAttrProvider() nor created on
+ demand by any other methods.
+ */
+ wxGridCellAttrProvider *GetAttrProvider() const;
/**
- Parameters string format is "item1[,item2[...,itemN]]"
- */
- virtual void SetParameters(const wxString& params);
-};
+ Return the attribute for the given cell.
+ By default this function is simply forwarded to
+ wxGridCellAttrProvider::GetAttr() but it may be overridden to handle
+ attributes directly in the table.
+ */
+ virtual wxGridCellAttr *GetAttr(int row, int col,
+ wxGridCellAttr::wxAttrKind kind);
+ /**
+ Set attribute of the specified cell.
-/**
- @class wxGridEditorCreatedEvent
+ By default this function is simply forwarded to
+ wxGridCellAttrProvider::SetAttr().
+ The table takes ownership of @a attr, i.e. will call DecRef() on it.
+ */
+ virtual void SetAttr(wxGridCellAttr* attr, int row, int col);
- @library{wxadv}
- @category{grid}
-*/
-class wxGridEditorCreatedEvent : public wxCommandEvent
-{
-public:
- //@{
/**
+ Set attribute of the specified row.
- */
- wxGridEditorCreatedEvent();
- wxGridEditorCreatedEvent(int id, wxEventType type,
- wxObject* obj,
- int row,
- int col,
- wxControl* ctrl);
- //@}
+ By default this function is simply forwarded to
+ wxGridCellAttrProvider::SetRowAttr().
- /**
- Returns the column at which the event occurred.
- */
- int GetCol();
+ The table takes ownership of @a attr, i.e. will call DecRef() on it.
+ */
+ virtual void SetRowAttr(wxGridCellAttr *attr, int row);
/**
- Returns the edit control.
- */
- wxControl* GetControl();
+ Set attribute of the specified column.
- /**
- Returns the row at which the event occurred.
- */
- int GetRow();
+ By default this function is simply forwarded to
+ wxGridCellAttrProvider::SetColAttr().
- /**
- Sets the column at which the event occurred.
- */
- void SetCol(int col);
+ The table takes ownership of @a attr, i.e. will call DecRef() on it.
+ */
+ virtual void SetColAttr(wxGridCellAttr *attr, int col);
- /**
- Sets the edit control.
- */
- void SetControl(wxControl* ctrl);
+ //@}
/**
- Sets the row at which the event occurred.
- */
- void SetRow(int row);
+ Returns true if this table supports attributes or false otherwise.
+
+ By default, the table automatically creates a wxGridCellAttrProvider
+ when this function is called if it had no attribute provider before and
+ returns @true.
+ */
+ virtual bool CanHaveAttributes();
};
/**
- @class wxGridRangeSelectEvent
+ @class wxGrid
+
+ wxGrid and its related classes are used for displaying and editing tabular
+ data. They provide a rich set of features for display, editing, and
+ interacting with a variety of data sources. For simple applications, and to
+ help you get started, wxGrid is the only class you need to refer to
+ directly. It will set up default instances of the other classes and manage
+ them for you. For more complex applications you can derive your own classes
+ for custom grid views, grid data tables, cell editors and renderers. The
+ @ref overview_grid has examples of simple and more complex applications,
+ explains the relationship between the various grid classes and has a
+ summary of the keyboard shortcuts and mouse functions provided by wxGrid.
+
+ A wxGridTableBase class holds the actual data to be displayed by a wxGrid
+ class. One or more wxGrid classes may act as a view for one table class.
+ The default table class is called wxGridStringTable and holds an array of
+ strings. An instance of such a class is created by CreateGrid().
+
+ wxGridCellRenderer is the abstract base class for rendereing contents in a
+ cell. The following renderers are predefined:
+ - wxGridCellBoolRenderer
+ - wxGridCellFloatRenderer
+ - wxGridCellNumberRenderer
+ - wxGridCellStringRenderer
+
+ The look of a cell can be further defined using wxGridCellAttr. An object
+ of this type may be returned by wxGridTableBase::GetAttr().
+
+ wxGridCellEditor is the abstract base class for editing the value of a
+ cell. The following editors are predefined:
+
+ - wxGridCellBoolEditor
+ - wxGridCellChoiceEditor
+ - wxGridCellFloatEditor
+ - wxGridCellNumberEditor
+ - wxGridCellTextEditor
+
+ Please see wxGridEvent, wxGridSizeEvent, wxGridRangeSelectEvent, and
+ wxGridEditorCreatedEvent for the documentation of all event types you can
+ use with wxGrid.
@library{wxadv}
@category{grid}
+
+ @see @ref overview_grid, wxGridUpdateLocker
*/
-class wxGridRangeSelectEvent : public wxNotifyEvent
+class wxGrid : public wxScrolledWindow
{
public:
- //@{
+
/**
+ Different selection modes supported by the grid.
+ */
+ enum wxGridSelectionModes
+ {
+ /**
+ The default selection mode allowing selection of the individual
+ cells as well as of the entire rows and columns.
+ */
+ wxGridSelectCells,
- */
- wxGridRangeSelectEvent();
- wxGridRangeSelectEvent(int id, wxEventType type,
- wxObject* obj,
- const wxGridCellCoords& topLeft,
- const wxGridCellCoords& bottomRight,
- bool sel = true,
- bool control = false,
- bool shift = false,
- bool alt = false,
- bool meta = false);
- //@}
+ /**
+ The selection mode allowing the selection of the entire rows only.
- /**
- Returns @true if the Alt key was down at the time of the event.
- */
- bool AltDown() const;
+ The user won't be able to select any cells or columns in this mode.
+ */
+ wxGridSelectRows,
- /**
- Returns @true if the Control key was down at the time of the event.
- */
- bool ControlDown() const;
+ /**
+ The selection mode allowing the selection of the entire columns only.
- /**
- Top left corner of the rectangular area that was (de)selected.
- */
- wxGridCellCoords GetBottomRightCoords();
+ The user won't be able to select any cells or rows in this mode.
+ */
+ wxGridSelectColumns
+ };
- /**
- Bottom row of the rectangular area that was (de)selected.
- */
- int GetBottomRow();
/**
- Left column of the rectangular area that was (de)selected.
- */
- int GetLeftCol();
+ @name Constructors and Initialization
+ */
+ //@{
/**
- Right column of the rectangular area that was (de)selected.
- */
- int GetRightCol();
+ Default constructor.
+ You must call Create() to really create the grid window and also call
+ CreateGrid() or SetTable() to initialize the grid contents.
+ */
+ wxGrid();
/**
- Top left corner of the rectangular area that was (de)selected.
+ Constructor creating the grid window.
+
+ You must call either CreateGrid() or SetTable() to initialize the grid
+ contents before using it.
*/
- wxGridCellCoords GetTopLeftCoords();
+ wxGrid(wxWindow* parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxWANTS_CHARS,
+ const wxString& name = wxGridNameStr);
/**
- Top row of the rectangular area that was (de)selected.
+ Destructor.
+
+ This will also destroy the associated grid table unless you passed a
+ table object to the grid and specified that the grid should not take
+ ownership of the table (see SetTable()).
*/
- int GetTopRow();
+ virtual ~wxGrid();
/**
- Returns @true if the Meta key was down at the time of the event.
- */
- bool MetaDown() const;
+ Creates the grid window for an object initialized using the default
+ constructor.
+
+ You must call either CreateGrid() or SetTable() to initialize the grid
+ contents before using it.
+ */
+ bool Create(wxWindow* parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxWANTS_CHARS,
+ const wxString& name = wxGridNameStr);
/**
- Returns @true if the area was selected, @false otherwise.
- */
- bool Selecting();
+ Creates a grid with the specified initial number of rows and columns.
- /**
- Returns @true if the Shift key was down at the time of the event.
+ Call this directly after the grid constructor. When you use this
+ function wxGrid will create and manage a simple table of string values
+ for you. All of the grid data will be stored in memory.
+
+ For applications with more complex data types or relationships, or for
+ dealing with very large datasets, you should derive your own grid table
+ class and pass a table object to the grid with SetTable().
*/
- bool ShiftDown() const;
-};
+ bool CreateGrid(int numRows, int numCols,
+ wxGridSelectionModes selmode = wxGridSelectCells);
+ /**
+ Passes a pointer to a custom grid table to be used by the grid.
+ This should be called after the grid constructor and before using the
+ grid object. If @a takeOwnership is set to @true then the table will be
+ deleted by the wxGrid destructor.
-/**
- @class wxGridCellRenderer
+ Use this function instead of CreateGrid() when your application
+ involves complex or non-string data or data sets that are too large to
+ fit wholly in memory.
+ */
+ bool SetTable(wxGridTableBase* table, bool takeOwnership = false,
+ wxGridSelectionModes selmode = wxGridSelectCells);
- This class is responsible for actually drawing the cell
- in the grid. You may pass it to the wxGridCellAttr (below) to change the
- format of one given cell or to wxGrid::SetDefaultRenderer() to change the
- view of all cells. This is an abstract class, and you will normally use one of
- the
- predefined derived classes or derive your own class from it.
+ //@}
- @library{wxadv}
- @category{grid}
- @see wxGridCellStringRenderer, wxGridCellNumberRenderer,
- wxGridCellFloatRenderer, wxGridCellBoolRenderer
-*/
-class wxGridCellRenderer
-{
-public:
/**
-
- */
- virtual wxGridCellRenderer* Clone() const = 0;
+ @name Grid Line Formatting
+ */
+ //@{
/**
- Draw the given cell on the provided DC inside the given rectangle
- using the style specified by the attribute and the default or selected
- state corresponding to the isSelected value.
- This pure virtual function has a default implementation which will
- prepare the DC using the given attribute: it will draw the rectangle
- with the background colour from attr and set the text colour and font.
+ Turns the drawing of grid lines on or off.
*/
- virtual void Draw(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
- const wxRect& rect, int row, int col,
- bool isSelected) = 0;
+ void EnableGridLines(bool enable = true);
/**
- Get the preferred size of the cell for its contents.
- */
- wxSize GetBestSize(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
- int row, int col);
-};
+ Returns the pen used for vertical grid lines.
+ This virtual function may be overridden in derived classes in order to
+ change the appearance of individual grid lines for the given column
+ @a col.
+ See GetRowGridLinePen() for an example.
+ */
+ virtual wxPen GetColGridLinePen(int col);
-/**
- @class wxGridCellNumberEditor
+ /**
+ Returns the pen used for grid lines.
- The editor for numeric integer data.
+ This virtual function may be overridden in derived classes in order to
+ change the appearance of grid lines. Note that currently the pen width
+ must be 1.
- @library{wxadv}
- @category{grid}
+ @see GetColGridLinePen(), GetRowGridLinePen()
+ */
+ virtual wxPen GetDefaultGridLinePen();
- @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
- wxGridCellTextEditor, wxGridCellChoiceEditor
-*/
-class wxGridCellNumberEditor : public wxGridCellTextEditor
-{
-public:
/**
- Allows to specify the range for acceptable data;
- if min == max == -1, no range checking is done
+ Returns the colour used for grid lines.
+
+ @see GetDefaultGridLinePen()
*/
- wxGridCellNumberEditor(int min = -1, int max = -1);
+ wxColour GetGridLineColour() const;
/**
- String representation of the value.
+ Returns the pen used for horizontal grid lines.
+
+ This virtual function may be overridden in derived classes in order to
+ change the appearance of individual grid line for the given @a row.
+
+ Example:
+ @code
+ // in a grid displaying music notation, use a solid black pen between
+ // octaves (C0=row 127, C1=row 115 etc.)
+ wxPen MidiGrid::GetRowGridLinePen(int row)
+ {
+ if ( row % 12 == 7 )
+ return wxPen(*wxBLACK, 1, wxSOLID);
+ else
+ return GetDefaultGridLinePen();
+ }
+ @endcode
*/
- wxString GetString() const;
+ virtual wxPen GetRowGridLinePen(int row);
/**
- If the return value is @true, the editor uses a wxSpinCtrl to get user input,
- otherwise it uses a wxTextCtrl.
+ Returns @true if drawing of grid lines is turned on, @false otherwise.
*/
- bool HasRange() const;
+ bool GridLinesEnabled() const;
/**
- Parameters string format is "min,max".
+ Sets the colour used to draw grid lines.
*/
- virtual void SetParameters(const wxString& params);
-};
-
-
+ void SetGridLineColour(const wxColour& colour);
-/**
- @class wxGridSizeEvent
+ //@}
- This event class contains information about a row/column resize event.
- @library{wxadv}
- @category{grid}
-*/
-class wxGridSizeEvent : public wxNotifyEvent
-{
-public:
+ /**
+ @name Label Values and Formatting
+ */
//@{
+
/**
+ Sets the arguments to the current column label alignment values.
- */
- wxGridSizeEvent();
- wxGridSizeEvent(int id, wxEventType type, wxObject* obj,
- int rowOrCol = -1,
- int x = -1,
- int y = -1,
- bool control = false,
- bool shift = false,
- bool alt = false,
- bool meta = false);
- //@}
+ Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
+ or @c wxALIGN_RIGHT.
- /**
- Returns @true if the Alt key was down at the time of the event.
+ Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
+ @c wxALIGN_BOTTOM.
*/
- bool AltDown() const;
+ void GetColLabelAlignment(int* horiz, int* vert) const;
/**
- Returns @true if the Control key was down at the time of the event.
+ Returns the orientation of the column labels (either @c wxHORIZONTAL or
+ @c wxVERTICAL).
*/
- bool ControlDown() const;
+ int GetColLabelTextOrientation() const;
/**
- Position in pixels at which the event occurred.
- */
- wxPoint GetPosition();
+ Returns the specified column label.
- /**
- Row or column at that was resized.
+ The default grid table class provides column labels of the form
+ A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table you can
+ override wxGridTableBase::GetColLabelValue() to provide your own
+ labels.
*/
- int GetRowOrCol();
+ wxString GetColLabelValue(int col) const;
/**
- Returns @true if the Meta key was down at the time of the event.
+ Returns the colour used for the background of row and column labels.
*/
- bool MetaDown() const;
+ wxColour GetLabelBackgroundColour() const;
/**
- Returns @true if the Shift key was down at the time of the event.
+ Returns the font used for row and column labels.
*/
- bool ShiftDown() const;
-};
-
-
-
-/**
- @class wxGridCellNumberRenderer
-
- This class may be used to format integer data in a cell.
-
- @library{wxadv}
- @category{grid}
+ wxFont GetLabelFont() const;
- @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer,
- wxGridCellBoolRenderer
-*/
-class wxGridCellNumberRenderer : public wxGridCellStringRenderer
-{
-public:
/**
- Default constructor
+ Returns the colour used for row and column label text.
*/
- wxGridCellNumberRenderer();
-};
-
+ wxColour GetLabelTextColour() const;
+ /**
+ Returns the alignment used for row labels.
-/**
- @class wxGridCellAttr
+ Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
+ or @c wxALIGN_RIGHT.
- This class can be used to alter the cells' appearance in
- the grid by changing their colour/font/... from default. An object of this
- class may be returned by wxGridTableBase::GetAttr.
+ Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
+ @c wxALIGN_BOTTOM.
+ */
+ void GetRowLabelAlignment(int* horiz, int* vert) const;
- @library{wxadv}
- @category{grid}
-*/
-class wxGridCellAttr
-{
-public:
- //@{
/**
- Constructor specifying some of the often used attributes.
+ Returns the specified row label.
+
+ The default grid table class provides numeric row labels. If you are
+ using a custom grid table you can override
+ wxGridTableBase::GetRowLabelValue() to provide your own labels.
*/
- wxGridCellAttr();
- wxGridCellAttr(const wxColour& colText,
- const wxColour& colBack,
- const wxFont& font,
- int hAlign, int vAlign);
- //@}
+ wxString GetRowLabelValue(int row) const;
/**
- Creates a new copy of this object.
+ Hides the column labels by calling SetColLabelSize() with a size of 0.
+ Show labels again by calling that method with a width greater than 0.
*/
- wxGridCellAttr* Clone() const;
+ void HideColLabels();
/**
+ Hides the row labels by calling SetRowLabelSize() with a size of 0.
+ The labels can be shown again by calling SetRowLabelSize() with a width
+ greater than 0.
*/
- void DecRef();
+ void HideRowLabels();
/**
- See SetAlignment() for the returned values.
+ Sets the horizontal and vertical alignment of column label text.
+
+ Horizontal alignment should be one of @c wxALIGN_LEFT,
+ @c wxALIGN_CENTRE or @c wxALIGN_RIGHT. Vertical alignment should be one
+ of @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
*/
- void GetAlignment(int* hAlign, int* vAlign) const;
+ void SetColLabelAlignment(int horiz, int vert);
/**
-
+ Sets the orientation of the column labels (either @c wxHORIZONTAL or
+ @c wxVERTICAL).
*/
- const wxColour GetBackgroundColour() const;
+ void SetColLabelTextOrientation(int textOrientation);
/**
+ Set the value for the given column label.
+ If you are using a custom grid table you must override
+ wxGridTableBase::SetColLabelValue() for this to have any effect.
*/
- wxGridCellEditor* GetEditor(wxGrid* grid, int row, int col) const;
+ void SetColLabelValue(int col, const wxString& value);
/**
-
+ Sets the background colour for row and column labels.
*/
- const wxFont GetFont() const;
+ void SetLabelBackgroundColour(const wxColour& colour);
/**
-
+ Sets the font for row and column labels.
*/
- wxGridCellRenderer* GetRenderer(wxGrid* grid, int row, int col) const;
+ void SetLabelFont(const wxFont& font);
/**
-
+ Sets the colour for row and column label text.
*/
- const wxColour GetTextColour() const;
+ void SetLabelTextColour(const wxColour& colour);
/**
+ Sets the horizontal and vertical alignment of row label text.
+ Horizontal alignment should be one of @c wxALIGN_LEFT,
+ @c wxALIGN_CENTRE or @c wxALIGN_RIGHT. Vertical alignment should be one
+ of @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
*/
- bool HasAlignment() const;
+ void SetRowLabelAlignment(int horiz, int vert);
/**
+ Sets the value for the given row label.
+ If you are using a derived grid table you must override
+ wxGridTableBase::SetRowLabelValue() for this to have any effect.
*/
- bool HasBackgroundColour() const;
+ void SetRowLabelValue(int row, const wxString& value);
/**
+ Call this in order to make the column labels use a native look by using
+ wxRenderer::DrawHeaderButton() internally.
+ There is no equivalent method for drawing row columns as there is not
+ native look for that. This option is useful when using wxGrid for
+ displaying tables and not as a spread-sheet.
*/
- bool HasEditor() const;
+ void SetUseNativeColLabels(bool native = true);
- /**
+ //@}
- */
- bool HasFont() const;
/**
+ @name Cell Formatting
- */
- bool HasRenderer() const;
+ Note that wxGridCellAttr can be used alternatively to most of these
+ methods. See the "Attributes Management" of wxGridTableBase.
+ */
+ //@{
/**
- accessors
- */
- bool HasTextColour() const;
+ Sets the arguments to the horizontal and vertical text alignment values
+ for the grid cell at the specified location.
- /**
- This class is ref 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
+ Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
+ or @c wxALIGN_RIGHT.
+
+ Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
+ @c wxALIGN_BOTTOM.
*/
- void IncRef();
+ void GetCellAlignment(int row, int col, int* horiz, int* vert) const;
/**
-
+ Returns the background colour of the cell at the specified location.
*/
- bool IsReadOnly() const;
+ wxColour GetCellBackgroundColour(int row, int col) 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.
+ Returns the font for text in the grid cell at the specified location.
*/
- void SetAlignment(int hAlign, int vAlign);
+ wxFont GetCellFont(int row, int col) const;
/**
- Sets the background colour.
+ Returns the text colour for the grid cell at the specified location.
*/
- void SetBackgroundColour(const wxColour& colBack);
+ wxColour GetCellTextColour(int row, int col) const;
/**
+ Returns the default cell alignment.
- */
- void SetDefAttr(wxGridCellAttr* defAttr);
+ Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
+ or @c wxALIGN_RIGHT.
- /**
+ Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
+ @c wxALIGN_BOTTOM.
+ @see SetDefaultCellAlignment()
*/
- void SetEditor(wxGridCellEditor* editor);
+ void GetDefaultCellAlignment(int* horiz, int* vert) const;
/**
- Sets the font.
+ Returns the current default background colour for grid cells.
*/
- void SetFont(const wxFont& font);
+ wxColour GetDefaultCellBackgroundColour() const;
/**
-
+ Returns the current default font for grid cell text.
*/
- void SetReadOnly(bool isReadOnly = true);
+ wxFont GetDefaultCellFont() const;
/**
- takes ownership of the pointer
+ Returns the current default colour for grid cell text.
*/
- void SetRenderer(wxGridCellRenderer* renderer);
+ wxColour GetDefaultCellTextColour() const;
/**
- Sets the text colour.
- */
- void SetTextColour(const wxColour& colText);
-};
-
-
-
-/**
- @class wxGridCellBoolRenderer
-
- This class may be used to format boolean data in a cell.
- for string cells.
+ Sets the horizontal and vertical alignment for grid cell text at the
+ specified location.
- @library{wxadv}
- @category{grid}
+ Horizontal alignment should be one of @c wxALIGN_LEFT,
+ @c wxALIGN_CENTRE or @c wxALIGN_RIGHT.
- @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer,
- wxGridCellNumberRenderer
-*/
-class wxGridCellBoolRenderer : public wxGridCellRenderer
-{
-public:
- /**
- Default constructor
+ Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
+ or @c wxALIGN_BOTTOM.
*/
- wxGridCellBoolRenderer();
-};
-
-
-
-/**
- @class wxGridEvent
-
- This event class contains information about various grid events.
-
- @library{wxadv}
- @category{grid}
-*/
-class wxGridEvent : public wxNotifyEvent
-{
-public:
- //@{
+ void SetCellAlignment(int row, int col, int horiz, int vert);
/**
+ Sets the horizontal and vertical alignment for grid cell text at the
+ specified location.
- */
- wxGridEvent();
- wxGridEvent(int id, wxEventType type, wxObject* obj,
- int row = -1, int col = -1,
- int x = -1, int y = -1,
- bool sel = true,
- bool control = false,
- bool shift = false,
- bool alt = false,
- bool meta = false);
- //@}
+ Horizontal alignment should be one of @c wxALIGN_LEFT,
+ @c wxALIGN_CENTRE or @c wxALIGN_RIGHT.
- /**
- Returns @true if the Alt key was down at the time of the event.
+ Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
+ or @c wxALIGN_BOTTOM.
*/
- bool AltDown() const;
+ void SetCellAlignment(int align, int row, int col);
/**
- Returns @true if the Control key was down at the time of the event.
+ Set the background colour for the given cell or all cells by default.
*/
- bool ControlDown() const;
+ void SetCellBackgroundColour(int row, int col, const wxColour& colour);
/**
- Column at which the event occurred.
+ Sets the font for text in the grid cell at the specified location.
*/
- virtual int GetCol();
+ void SetCellFont(int row, int col, const wxFont& font);
/**
- Position in pixels at which the event occurred.
+ Sets the text colour for the given cell.
*/
- wxPoint GetPosition();
-
+ void SetCellTextColour(int row, int col, const wxColour& colour);
/**
- Row at which the event occurred.
+ Sets the text colour for the given cell.
*/
- virtual int GetRow();
-
+ void SetCellTextColour(const wxColour& val, int row, int col);
/**
- Returns @true if the Meta key was down at the time of the event.
+ Sets the text colour for all cells by default.
*/
- bool MetaDown() const;
+ void SetCellTextColour(const wxColour& colour);
/**
- Returns @true if the user is selecting grid cells, @false -- if
- deselecting.
+ Sets the default horizontal and vertical alignment for grid cell text.
+
+ Horizontal alignment should be one of @c wxALIGN_LEFT,
+ @c wxALIGN_CENTRE or @c wxALIGN_RIGHT. Vertical alignment should be one
+ of @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
*/
- bool Selecting();
+ void SetDefaultCellAlignment(int horiz, int vert);
/**
- Returns @true if the Shift key was down at the time of the event.
+ Sets the default background colour for grid cells.
*/
- bool ShiftDown() const;
-};
-
-
-
-/**
- @class wxGridCellFloatEditor
-
- The editor for floating point numbers data.
-
- @library{wxadv}
- @category{grid}
+ void SetDefaultCellBackgroundColour(const wxColour& colour);
- @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.
+ Sets the default font to be used for grid cell text.
*/
- wxGridCellFloatEditor(int width = -1, int precision = -1);
+ void SetDefaultCellFont(const wxFont& font);
/**
- Parameters string format is "width,precision"
+ Sets the current default colour for grid cell text.
*/
- virtual void SetParameters(const wxString& params);
-};
-
+ void SetDefaultCellTextColour(const wxColour& colour);
+ //@}
-/**
- @class wxGrid
- wxGrid and its related classes are used for displaying and editing tabular
- data.
- They provide a rich set of features for display, editing, and interacting
- with a variety of data sources. For simple applications, and to help you
- get started, wxGrid is the only class you need to refer to directly. It
- will set up default instances of the other classes and manage them for you.
- For more complex applications you can derive your own classes for custom
- grid views, grid data tables, cell editors and renderers. The @ref
- overview_grid "wxGrid overview" has examples of simple and more complex applications,
- explains the relationship between the various grid classes and has a
- summary of the keyboard shortcuts and mouse functions provided by wxGrid.
+ /**
+ @name Cell Values, Editors, and Renderers
- wxGrid has been greatly expanded and redesigned for wxWidgets 2.2 onwards.
- The new grid classes are reasonably backward-compatible but there are some
- exceptions. There are also easier ways of doing many things compared to the
- previous implementation.
+ Note that wxGridCellAttr can be used alternatively to most of these
+ methods. See the "Attributes Management" of wxGridTableBase.
+ */
+ //@{
- A wxGridTableBase class holds the actual data to be displayed by a wxGrid
- class. One or more wxGrid classes may act as a view for one table class.
- The default table class is called wxGridStringTable and holds an array of
- strings. An instance of such a class is created by wxGrid::CreateGrid.
+ /**
+ Returns @true if the in-place edit control for the current grid cell
+ can be used and @false otherwise.
- wxGridCellRenderer is the abstract base class for rendereing contents in a
- cell. The following renderers are predefined:
- - wxGridCellStringRenderer,
- - wxGridCellBoolRenderer,
- - wxGridCellFloatRenderer,
- - wxGridCellNumberRenderer.
- The look of a cell can be further defined using wxGridCellAttr. An object
- of this type may be returned by wxGridTableBase::GetAttr.
+ This function always returns @false for the read-only cells.
+ */
+ bool CanEnableCellControl() const;
- wxGridCellEditor is the abstract base class for editing the value of a
- cell. The following editors are predefined:
- - wxGridCellTextEditor
- - wxGridCellBoolEditor
- - wxGridCellChoiceEditor
- - wxGridCellNumberEditor.
+ /**
+ Disables in-place editing of grid cells.
- @library{wxadv}
- @category{grid}
+ Equivalent to calling EnableCellEditControl(@false).
+ */
+ void DisableCellEditControl();
- @see @ref overview_grid "wxGrid overview"
-*/
-class wxGrid : public wxScrolledWindow
-{
-public:
/**
- Different selection modes supported by the grid.
- */
- enum wxGridSelectionModes
- {
- /**
- The default selection mode allowing selection of the individual
- cells as well as of the entire rows and columns.
- */
- wxGridSelectCells,
+ Enables or disables in-place editing of grid cell data.
- /**
- The selection mode allowing the selection of the entire rows only.
+ The grid will issue either a @c wxEVT_GRID_EDITOR_SHOWN or
+ @c wxEVT_GRID_EDITOR_HIDDEN event.
+ */
+ void EnableCellEditControl(bool enable = true);
- The user won't be able to select any cells or columns in this mode.
- */
- wxGridSelectRows,
+ /**
+ Makes the grid globally editable or read-only.
- /**
- The selection mode allowing the selection of the entire columns only.
+ If the edit argument is @false this function sets the whole grid as
+ read-only. If the argument is @true the grid is set to the default
+ state where cells may be editable. In the default state you can set
+ single grid cells and whole rows and columns to be editable or
+ read-only via wxGridCellAttr::SetReadOnly(). For single cells you
+ can also use the shortcut function SetReadOnly().
- The user won't be able to select any cells or rows in this mode.
- */
- wxGridSelectColumns
- };
+ For more information about controlling grid cell attributes see the
+ wxGridCellAttr class and the @ref overview_grid.
+ */
+ void EnableEditing(bool edit);
/**
- Default constructor.
-
- You must call Create() to really create the grid window and also call
- CreateGrid() or SetTable() to initialize the grid contents.
- */
- wxGrid();
+ Returns a pointer to the editor for the cell at the specified location.
- /**
- Constructor creating the grid window.
+ See wxGridCellEditor and the @ref overview_grid for more information
+ about cell editors and renderers.
- You must call either CreateGrid() or SetTable() to initialize the grid
- contents before using it.
+ The caller must call DecRef() on the returned pointer.
*/
- wxGrid(wxWindow* parent,
- wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxWANTS_CHARS,
- const wxString& name = wxGridNameStr);
+ wxGridCellEditor* GetCellEditor(int row, int col) const;
/**
- Creates the grid window for an object initialized using the default
- constructor.
+ Returns a pointer to the renderer for the grid cell at the specified
+ location.
- You must call either CreateGrid() or SetTable() to initialize the grid
- contents before using it.
- */
- bool Create(wxWindow* parent,
- wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxWANTS_CHARS,
- const wxString& name = wxGridNameStr);
+ See wxGridCellRenderer and the @ref overview_grid for more information
+ about cell editors and renderers.
+
+ The caller must call DecRef() on the returned pointer.
+ */
+ wxGridCellRenderer* GetCellRenderer(int row, int col) const;
/**
- Destructor.
+ Returns the string contained in the cell at the specified location.
- This will also destroy the associated grid table unless you passed a
- table object to the grid and specified that the grid should not take
- ownership of the table (see wxGrid::SetTable).
- */
- virtual ~wxGrid();
+ For simple applications where a grid object automatically uses a
+ default grid table of string values you use this function together with
+ SetCellValue() to access cell values. For more complex applications
+ where you have derived your own grid table class that contains various
+ data types (e.g. numeric, boolean or user-defined custom types) then
+ you only use this function for those cells that contain string values.
+ See wxGridTableBase::CanGetValueAs() and the @ref overview_grid for
+ more information.
+ */
+ wxString GetCellValue(int row, int col) const;
/**
- Appends one or more new columns to the right of the grid.
+ Returns the string contained in the cell at the specified location.
- The @a updateLabels argument is not used at present. If you are using a
- derived grid table class you will need to override
- wxGridTableBase::AppendCols. See InsertCols() for further information.
+ For simple applications where a grid object automatically uses a
+ default grid table of string values you use this function together with
+ SetCellValue() to access cell values. For more complex applications
+ where you have derived your own grid table class that contains various
+ data types (e.g. numeric, boolean or user-defined custom types) then
+ you only use this function for those cells that contain string values.
- @return @true on success or @false if appending columns failed.
+ See wxGridTableBase::CanGetValueAs() and the @ref overview_grid for
+ more information.
*/
- bool AppendCols(int numCols = 1, bool updateLabels = true);
+ const wxString GetCellValue(const wxGridCellCoords& coords) const;
/**
- Appends one or more new rows to the bottom of the grid.
-
- The @a updateLabels argument is not used at present. If you are using a
- derived grid table class you will need to override
- wxGridTableBase::AppendRows. See InsertRows() for further information.
+ Returns a pointer to the current default grid cell editor.
- @return @true on success or @false if appending rows failed.
+ See wxGridCellEditor and the @ref overview_grid for more information
+ about cell editors and renderers.
*/
- bool AppendRows(int numRows = 1, bool updateLabels = true);
+ wxGridCellEditor* GetDefaultEditor() const;
/**
- Return @true if the horizontal grid lines stop at the last column
- boundary or @false if they continue to the end of the window.
+ Returns the default editor for the specified cell.
- The default is to clip grid lines.
+ The base class version returns the editor appropriate for the current
+ cell type but this method may be overridden in the derived classes to
+ use custom editors for some cells by default.
- @see ClipHorzGridLines(), AreVertGridLinesClipped()
- */
- bool AreHorzGridLinesClipped() const;
+ Notice that the same may be achieved in a usually simpler way by
+ associating a custom editor with the given cell or cells.
+ The caller must call DecRef() on the returned pointer.
+ */
+ virtual wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
/**
- Return @true if the vertical grid lines stop at the last row
- boundary or @false if they continue to the end of the window.
+ Returns the default editor for the specified cell.
- The default is to clip grid lines.
+ The base class version returns the editor appropriate for the current
+ cell type but this method may be overridden in the derived classes to
+ use custom editors for some cells by default.
- @see ClipVertGridLines(), AreHorzGridLinesClipped()
- */
- bool AreVertGridLinesClipped() const;
+ Notice that the same may be achieved in a usually simpler way by
+ associating a custom editor with the given cell or cells.
- /**
- Automatically sets the height and width of all rows and columns to fit their
- contents.
+ The caller must call DecRef() on the returned pointer.
*/
- void AutoSize();
+ wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const;
/**
- Automatically adjusts width of the column to fit its label.
+ Returns the default editor for the cells containing values of the given
+ type.
+
+ The base class version returns the editor which was associated with the
+ specified @a typeName when it was registered RegisterDataType() but
+ this function may be overridden to return something different. This
+ allows to override an editor used for one of the standard types.
+
+ The caller must call DecRef() on the returned pointer.
*/
- void AutoSizeColLabelSize(int col);
+ virtual wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
/**
- Automatically sizes the column to fit its contents. If setAsMin is @true the
- calculated width will
- also be set as the minimal width for the column.
+ Returns a pointer to the current default grid cell renderer.
+
+ See wxGridCellRenderer and the @ref overview_grid for more information
+ about cell editors and renderers.
+
+ The caller must call DecRef() on the returned pointer.
*/
- void AutoSizeColumn(int col, bool setAsMin = true);
+ wxGridCellRenderer* GetDefaultRenderer() const;
/**
- Automatically sizes all columns to fit their contents. If setAsMin is @true the
- calculated widths will
- also be set as the minimal widths for the columns.
+ Returns the default renderer for the given cell.
+
+ The base class version returns the renderer appropriate for the current
+ cell type but this method may be overridden in the derived classes to
+ use custom renderers for some cells by default.
+
+ The caller must call DecRef() on the returned pointer.
*/
- void AutoSizeColumns(bool setAsMin = true);
+ virtual wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
/**
- Automatically sizes the row to fit its contents. If setAsMin is @true the
- calculated height will
- also be set as the minimal height for the row.
+ Returns the default renderer for the cell containing values of the
+ given type.
+
+ @see GetDefaultEditorForType()
*/
- void AutoSizeRow(int row, bool setAsMin = true);
+ virtual wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
/**
- Automatically adjusts height of the row to fit its label.
+ Hides the in-place cell edit control.
*/
- void AutoSizeRowLabelSize(int col);
+ void HideCellEditControl();
/**
- Automatically sizes all rows to fit their contents. If setAsMin is @true the
- calculated heights will
- also be set as the minimal heights for the rows.
+ Returns @true if the in-place edit control is currently enabled.
*/
- void AutoSizeRows(bool setAsMin = true);
+ bool IsCellEditControlEnabled() const;
/**
- Increments the grid's batch count.
-
- When the count is greater than zero repainting of the grid is
- suppressed. Each call to BeginBatch must be matched by a later call to
- EndBatch(). Code that does a lot of grid modification can be enclosed
- between BeginBatch and EndBatch calls to avoid screen flicker. The
- final EndBatch will cause the grid to be repainted.
+ Returns @true if the current cell is read-only.
- Notice that you should use wxGridUpdateLocker which ensures that there
- is always a matching EndBatch() call for this BeginBatch() if possible
- instead of calling this method directly.
+ @see SetReadOnly(), IsReadOnly()
*/
- void BeginBatch();
+ bool IsCurrentCellReadOnly() const;
/**
- Convert grid cell coordinates to grid window pixel coordinates.
-
- This function returns the rectangle that encloses the block of cells
- limited by @a topLeft and @a bottomRight cell in device coords and
- clipped to the client size of the grid window.
+ Returns @false if the whole grid has been set as read-only or @true
+ otherwise.
- @see CellToRect()
+ See EnableEditing() for more information about controlling the editing
+ status of grid cells.
*/
- wxRect BlockToDeviceRect(const wxGridCellCoords& topLeft,
- const wxGridCellCoords& bottomRight) const;
+ bool IsEditable() const;
/**
- Returns @true if columns can be moved by dragging with the mouse.
+ Returns @true if the cell at the specified location can't be edited.
- Columns can be moved by dragging on their labels.
+ @see SetReadOnly(), IsCurrentCellReadOnly()
*/
- bool CanDragColMove() const;
+ bool IsReadOnly(int row, int col) const;
/**
- Returns @true if columns can be resized by dragging with the mouse.
+ Register a new data type.
- Columns can be resized by dragging the edges of their labels. If grid
- line dragging is enabled they can also be resized by dragging the right
- edge of the column in the grid cell area (see
- wxGrid::EnableDragGridSize).
- */
- bool CanDragColSize() const;
+ The data types allow to naturally associate specific renderers and
+ editors to the cells containing values of the given type. For example,
+ the grid automatically registers a data type with the name
+ @c wxGRID_VALUE_STRING which uses wxGridCellStringRenderer and
+ wxGridCellTextEditor as its renderer and editor respectively -- this is
+ the data type used by all the cells of the default wxGridStringTable,
+ so this renderer and editor are used by default for all grid cells.
- /**
- Return @true if the dragging of grid lines to resize rows and columns
- is enabled or @false otherwise.
- */
- bool CanDragGridSize() const;
+ However if a custom table returns @c wxGRID_VALUE_BOOL from its
+ wxGridTableBase::GetTypeName() method, then wxGridCellBoolRenderer and
+ wxGridCellBoolEditor are used for it because the grid also registers a
+ boolean data type with this name.
- /**
- Returns @true if rows can be resized by dragging with the mouse.
+ And as this mechanism is completely generic, you may register your own
+ data types using your own custom renderers and editors. Just remember
+ that the table must identify a cell as being of the given type for them
+ to be used for this cell.
- Rows can be resized by dragging the edges of their labels. If grid line
- dragging is enabled they can also be resized by dragging the lower edge
- of the row in the grid cell area (see wxGrid::EnableDragGridSize).
+ @param typeName
+ Name of the new type. May be any string, but if the type name is
+ the same as the name of an already registered type, including one
+ of the standard ones (which are @c wxGRID_VALUE_STRING, @c
+ wxGRID_VALUE_BOOL, @c wxGRID_VALUE_NUMBER, @c wxGRID_VALUE_FLOAT
+ and @c wxGRID_VALUE_CHOICE), then the new registration information
+ replaces the previously used renderer and editor.
+ @param renderer
+ The renderer to use for the cells of this type. Its ownership is
+ taken by the grid, i.e. it will call DecRef() on this pointer when
+ it doesn't need it any longer.
+ @param editor
+ The editor to use for the cells of this type. Its ownership is also
+ taken by the grid.
*/
- bool CanDragRowSize() const;
+ void RegisterDataType(const wxString& typeName,
+ wxGridCellRenderer* renderer,
+ wxGridCellEditor* editor);
/**
- Returns @true if the in-place edit control for the current grid cell
- can be used and @false otherwise.
+ Sets the value of the current grid cell to the current in-place edit
+ control value.
- This function always returns @false for the read-only cells.
+ This is called automatically when the grid cursor moves from the
+ current cell to a new cell. It is also a good idea to call this
+ function when closing a grid since any edits to the final cell location
+ will not be saved otherwise.
*/
- bool CanEnableCellControl() const;
+ void SaveEditControlValue();
/**
- Returns @true if this grid has support for cell attributes.
+ Sets the editor for the grid cell at the specified location.
- The grid supports attributes if it has the associated table which, in
- turn, has attributes support, i.e. wxGridTableBase::CanHaveAttributes()
- returns @true.
+ The grid will take ownership of the pointer.
+
+ See wxGridCellEditor and the @ref overview_grid for more information
+ about cell editors and renderers.
*/
- bool CanHaveAttributes() const;
+ void SetCellEditor(int row, int col, wxGridCellEditor* editor);
- //@{
/**
- Return the rectangle corresponding to the grid cell's size and position
- in logical coordinates.
+ Sets the renderer for the grid cell at the specified location.
- @see BlockToDeviceRect()
- */
- wxRect CellToRect(int row, int col) const;
- const wxRect CellToRect(const wxGridCellCoords& coords) const;
+ The grid will take ownership of the pointer.
- //@}
+ See wxGridCellRenderer and the @ref overview_grid for more information
+ about cell editors and renderers.
+ */
+ void SetCellRenderer(int row, int col, wxGridCellRenderer* renderer);
/**
- Clears all data in the underlying grid table and repaints the grid.
+ Sets the string value for the cell at the specified location.
- The table is not deleted by this function. If you are using a derived
- table class then you need to override wxGridTableBase::Clear() for this
- function to have any effect.
- */
- void ClearGrid();
+ For simple applications where a grid object automatically uses a
+ default grid table of string values you use this function together with
+ GetCellValue() to access cell values. For more complex applications
+ where you have derived your own grid table class that contains various
+ data types (e.g. numeric, boolean or user-defined custom types) then
+ you only use this function for those cells that contain string values.
- /**
- Deselects all cells that are currently selected.
+ See wxGridTableBase::CanSetValueAs() and the @ref overview_grid for
+ more information.
*/
- void ClearSelection();
-
+ void SetCellValue(int row, int col, const wxString& s);
/**
- Change whether the horizontal grid lines are clipped by the end of the
- last column.
-
- By default the grid lines are not drawn beyond the end of the last
- column but after calling this function with @a clip set to @false they
- will be drawn across the entire grid window.
+ Sets the string value for the cell at the specified location.
- @see AreHorzGridLinesClipped(), ClipVertGridLines()
- */
- void ClipHorzGridLines(bool clip);
+ For simple applications where a grid object automatically uses a
+ default grid table of string values you use this function together with
+ GetCellValue() to access cell values. For more complex applications
+ where you have derived your own grid table class that contains various
+ data types (e.g. numeric, boolean or user-defined custom types) then
+ you only use this function for those cells that contain string values.
+ See wxGridTableBase::CanSetValueAs() and the @ref overview_grid for
+ more information.
+ */
+ void SetCellValue(const wxGridCellCoords& coords, const wxString& s);
/**
- Change whether the vertical grid lines are clipped by the end of the
- last row.
-
- By default the grid lines are not drawn beyond the end of the last
- row but after calling this function with @a clip set to @false they
- will be drawn across the entire grid window.
+ @deprecated Please use SetCellValue(int,int,const wxString&) or
+ SetCellValue(const wxGridCellCoords&,const wxString&)
+ instead.
- @see AreVertzGridLinesClipped(), ClipHorzGridLines()
- */
- void ClipVertzGridLines(bool clip);
+ Sets the string value for the cell at the specified location.
- /**
- Creates a grid with the specified initial number of rows and columns.
+ For simple applications where a grid object automatically uses a
+ default grid table of string values you use this function together with
+ GetCellValue() to access cell values. For more complex applications
+ where you have derived your own grid table class that contains various
+ data types (e.g. numeric, boolean or user-defined custom types) then
+ you only use this function for those cells that contain string values.
- Call this directly after the grid constructor. When you use this
- function wxGrid will create and manage a simple table of string values
- for you. All of the grid data will be stored in memory.
- For applications with more complex data types or relationships, or for
- dealing with very large datasets, you should derive your own grid table
- class and pass a table object to the grid with SetTable().
+ See wxGridTableBase::CanSetValueAs() and the @ref overview_grid for
+ more information.
*/
- bool CreateGrid(int numRows, int numCols,
- wxGridSelectionModes selmode = wxGridSelectCells);
+ void SetCellValue(const wxString& val, int row, int col);
/**
- Deletes one or more columns from a grid starting at the specified
- position.
-
- The @a updateLabels argument is not used at present. If you are using a
- derived grid table class you will need to override
- wxGridTableBase::DeleteCols. See InsertCols() for further information.
+ Sets the specified column to display boolean values.
- @return @true on success or @false if deleting columns failed.
+ @see SetColFormatCustom()
*/
- bool DeleteCols(int pos = 0, int numCols = 1, bool updateLabels = true);
+ void SetColFormatBool(int col);
/**
- Deletes one or more rows from a grid starting at the specified position.
+ Sets the specified column to display data in a custom format.
- The @a updateLabels argument is not used at present. If you are using a
- derived grid table class you will need to override
- wxGridTableBase::DeleteRows. See InsertRows() for further information.
+ This method provides an alternative to defining a custom grid table
+ which would return @a typeName from its GetTypeName() method for the
+ cells in this column: while it doesn't really change the type of the
+ cells in this column, it does associate the renderer and editor used
+ for the cells of the specified type with them.
- @return @true on success or @false if appending rows failed.
+ See the @ref overview_grid for more information on working with custom
+ data types.
*/
- bool DeleteRows(int pos = 0, int numRows = 1, bool updateLabels = true);
+ void SetColFormatCustom(int col, const wxString& typeName);
/**
- Disables in-place editing of grid cells.
+ Sets the specified column to display floating point values with the
+ given width and precision.
- Equivalent to calling EnableCellEditControl(@false).
+ @see SetColFormatCustom()
*/
- void DisableCellEditControl();
+ void SetColFormatFloat(int col, int width = -1, int precision = -1);
/**
- Disables column moving by dragging with the mouse.
+ Sets the specified column to display integer values.
- Equivalent to passing @false to EnableDragColMove().
+ @see SetColFormatCustom()
*/
- void DisableDragColMove();
+ void SetColFormatNumber(int col);
/**
- Disables column sizing by dragging with the mouse.
-
- Equivalent to passing @false to EnableDragColSize().
- */
- void DisableDragColSize();
+ Sets the default editor for grid cells.
- /**
- Disable mouse dragging of grid lines to resize rows and columns.
+ The grid will take ownership of the pointer.
- Equivalent to passing @false to EnableDragGridSize()
+ See wxGridCellEditor and the @ref overview_grid for more information
+ about cell editors and renderers.
*/
- void DisableDragGridSize();
+ void SetDefaultEditor(wxGridCellEditor* editor);
/**
- Disables row sizing by dragging with the mouse.
+ Sets the default renderer for grid cells.
- Equivalent to passing @false to EnableDragRowSize().
+ The grid will take ownership of the pointer.
+
+ See wxGridCellRenderer and the @ref overview_grid for more information
+ about cell editors and renderers.
*/
- void DisableDragRowSize();
+ void SetDefaultRenderer(wxGridCellRenderer* renderer);
/**
- Enables or disables in-place editing of grid cell data.
+ Makes the cell at the specified location read-only or editable.
- The grid will issue either a wxEVT_GRID_EDITOR_SHOWN or
- wxEVT_GRID_EDITOR_HIDDEN event.
+ @see IsReadOnly()
*/
- void EnableCellEditControl(bool enable = true);
+ void SetReadOnly(int row, int col, bool isReadOnly = true);
/**
- Enables or disables column moving by dragging with the mouse.
+ Displays the in-place cell edit control for the current cell.
*/
- void EnableDragColMove(bool enable = true);
+ void ShowCellEditControl();
+
+ //@}
+
/**
- Enables or disables column sizing by dragging with the mouse.
- */
- void EnableDragColSize(bool enable = true);
+ @name Column and Row Sizes
+ */
+ //@{
/**
- Enables or disables row and column resizing by dragging gridlines with the
- mouse.
+ Automatically sets the height and width of all rows and columns to fit
+ their contents.
*/
- void EnableDragGridSize(bool enable = true);
+ void AutoSize();
/**
- Enables or disables row sizing by dragging with the mouse.
+ Automatically adjusts width of the column to fit its label.
*/
- void EnableDragRowSize(bool enable = true);
+ void AutoSizeColLabelSize(int col);
/**
- Makes the grid globally editable or read-only.
-
- If the edit argument is @false this function sets the whole grid as
- read-only. If the argument is @true the grid is set to the default
- state where cells may be editable. In the default state you can set
- single grid cells and whole rows and columns to be editable or
- read-only via wxGridCellAttribute::SetReadOnly. For single cells you
- can also use the shortcut function SetReadOnly().
-
- For more information about controlling grid cell attributes see the
- wxGridCellAttr cell attribute class and the
- @ref overview_grid "wxGrid overview".
+ Automatically sizes the column to fit its contents. If @a setAsMin is
+ @true the calculated width will also be set as the minimal width for
+ the column.
*/
- void EnableEditing(bool edit);
+ void AutoSizeColumn(int col, bool setAsMin = true);
/**
- Turns the drawing of grid lines on or off.
+ Automatically sizes all columns to fit their contents. If @a setAsMin
+ is @true the calculated widths will also be set as the minimal widths
+ for the columns.
*/
- void EnableGridLines(bool enable = true);
+ void AutoSizeColumns(bool setAsMin = true);
/**
- Decrements the grid's batch count.
-
- When the count is greater than zero repainting of the grid is
- suppressed. Each previous call to BeginBatch() must be matched by a
- later call to EndBatch. Code that does a lot of grid modification can
- be enclosed between BeginBatch and EndBatch calls to avoid screen
- flicker. The final EndBatch will cause the grid to be repainted.
-
- @see wxGridUpdateLocker
+ Automatically sizes the row to fit its contents. If @a setAsMin is
+ @true the calculated height will also be set as the minimal height for
+ the row.
*/
- void EndBatch();
+ void AutoSizeRow(int row, bool setAsMin = true);
/**
- Overridden wxWindow method.
+ Automatically adjusts height of the row to fit its label.
*/
- void Fit();
+ void AutoSizeRowLabelSize(int col);
/**
- Causes immediate repainting of the grid.
-
- Use this instead of the usual wxWindow::Refresh.
+ Automatically sizes all rows to fit their contents. If @a setAsMin is
+ @true the calculated heights will also be set as the minimal heights
+ for the rows.
*/
- void ForceRefresh();
+ void AutoSizeRows(bool setAsMin = true);
/**
- Returns the number of times that BeginBatch() has been called
- without (yet) matching calls to EndBatch(). While
- the grid's batch count is greater than zero the display will not be updated.
+ Returns the current height of the column labels.
*/
- int GetBatchCount();
+ int GetColLabelSize() const;
/**
- Sets the arguments to the horizontal and vertical text alignment values
- for the grid cell at the specified location.
+ Returns the minimal width to which a column may be resized.
- Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
- or @c wxALIGN_RIGHT.
+ Use SetColMinimalAcceptableWidth() to change this value globally or
+ SetColMinimalWidth() to do it for individual columns.
- Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
- @c wxALIGN_BOTTOM.
+ @see GetRowMinimalAcceptableHeight()
*/
- void GetCellAlignment(int row, int col, int* horiz, int* vert) const;
+ int GetColMinimalAcceptableWidth() const;
/**
- Returns the background colour of the cell at the specified location.
+ Returns the width of the specified column.
*/
- wxColour GetCellBackgroundColour(int row, int col) const;
+ int GetColSize(int col) const;
/**
- Returns a pointer to the editor for the cell at the specified location.
-
- See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
-
- The caller must call DecRef() on the returned pointer.
+ Returns the default height for column labels.
*/
- wxGridCellEditor* GetCellEditor(int row, int col) const;
+ int GetDefaultColLabelSize() const;
/**
- Returns the font for text in the grid cell at the specified location.
+ Returns the current default width for grid columns.
*/
- wxFont GetCellFont(int row, int col) const;
+ int GetDefaultColSize() const;
/**
- Returns a pointer to the renderer for the grid cell at the specified
- location.
-
- See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
-
- The caller must call DecRef() on the returned pointer.
+ Returns the default width for the row labels.
*/
- wxGridCellRenderer* GetCellRenderer(int row, int col) const;
+ int GetDefaultRowLabelSize() const;
/**
- Returns the text colour for the grid cell at the specified location.
+ Returns the current default height for grid rows.
*/
- wxColour GetCellTextColour(int row, int col) const;
+ int GetDefaultRowSize() const;
- //@{
/**
- Returns the string contained in the cell at the specified location.
+ Returns the minimal size to which rows can be resized.
- For simple applications where a grid object automatically uses a
- default grid table of string values you use this function together with
- SetCellValue() to access cell values. For more complex applications
- where you have derived your own grid table class that contains various
- data types (e.g. numeric, boolean or user-defined custom types) then
- you only use this function for those cells that contain string values.
+ Use SetRowMinimalAcceptableHeight() to change this value globally or
+ SetRowMinimalHeight() to do it for individual cells.
- See wxGridTableBase::CanGetValueAs and the @ref overview_grid "wxGrid overview"
- for more information.
+ @see GetColMinimalAcceptableWidth()
*/
- wxString GetCellValue(int row, int col) const;
- const wxString GetCellValue(const wxGridCellCoords& coords) const;
- //@}
+ int GetRowMinimalAcceptableHeight() const;
/**
- Returns the column ID of the specified column position.
+ Returns the current width of the row labels.
*/
- int GetColAt(int colPos) const;
+ int GetRowLabelSize() const;
/**
- Returns the pen used for vertical grid lines.
-
- This virtual function may be overridden in derived classes in order to
- change the appearance of individual grid lines for the given column @e
- col.
-
- See GetRowGridLinePen() for an example.
+ Returns the height of the specified row.
*/
- virtual wxPen GetColGridLinePen(int col);
+ int GetRowSize(int row) const;
/**
- Sets the arguments to the current column label alignment values.
-
- Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
- or @c wxALIGN_RIGHT.
+ Sets the height of the column labels.
- Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
- @c wxALIGN_BOTTOM.
+ If @a height equals to @c wxGRID_AUTOSIZE then height is calculated
+ automatically so that no label is truncated. Note that this could be
+ slow for a large table.
*/
- void GetColLabelAlignment(int* horiz, int* vert) const;
+ void SetColLabelSize(int height);
/**
- Returns the current height of the column labels.
+ Sets the minimal @a width to which the user can resize columns.
+
+ @see GetColMinimalAcceptableWidth()
*/
- int GetColLabelSize() const;
+ void SetColMinimalAcceptableWidth(int width);
/**
- Returns the specified column label.
+ Sets the minimal @a width for the specified column @a col.
- The default grid table class provides column labels of the form
- A,B...Z,AA,AB...ZZ,AAA... If you are using a custom grid table you can
- override wxGridTableBase::GetColLabelValue to provide your own labels.
- */
- wxString GetColLabelValue(int col) const;
+ It is usually best to call this method during grid creation as calling
+ it later will not resize the column to the given minimal width even if
+ it is currently narrower than it.
- /**
- Returns the coordinate of the left border specified column.
+ @a width must be greater than the minimal acceptable column width as
+ returned by GetColMinimalAcceptableWidth().
*/
- int GetColLeft(int col) const;
+ void SetColMinimalWidth(int col, int width);
/**
- Returns the minimal width to which a column may be resized.
+ Sets the width of the specified column.
- Use SetColMinimalAcceptableWidth() to change this value globally or
- SetColMinimalWidth() to do it for individual columns.
+ Notice that this function does not refresh the grid, you need to call
+ ForceRefresh() to make the changes take effect immediately.
+
+ @param col
+ The column index.
+ @param width
+ The new column width in pixels or a negative value to fit the
+ column width to its label width.
*/
- int GetColMinimalAcceptableWidth() const;
+ void SetColSize(int col, int width);
/**
- Get the minimal width of the given column/row.
+ Sets the default width for columns in the grid.
- The value returned by this function may be different than that returned
- by GetColMinimalAcceptableWidth() if SetColMinimalWidth() had been
- called for this column.
+ This will only affect columns subsequently added to the grid unless
+ @a resizeExistingCols is @true.
+
+ If @a width is less than GetColMinimalAcceptableWidth(), then the
+ minimal acceptable width is used instead of it.
*/
- int GetColMinimalWidth(int col) const;
+ void SetDefaultColSize(int width, bool resizeExistingCols = false);
/**
- Returns the position of the specified column.
+ Sets the default height for rows in the grid.
+
+ This will only affect rows subsequently added to the grid unless
+ @a resizeExistingRows is @true.
+
+ If @a height is less than GetRowMinimalAcceptableHeight(), then the
+ minimal acceptable heihgt is used instead of it.
*/
- int GetColPos(int colID) const;
+ void SetDefaultRowSize(int height, bool resizeExistingRows = false);
/**
- Returns the coordinate of the right border specified column.
+ Sets the width of the row labels.
+
+ If @a width equals @c wxGRID_AUTOSIZE then width is calculated
+ automatically so that no label is truncated. Note that this could be
+ slow for a large table.
*/
- int GetColRight(int col) const;
+ void SetRowLabelSize(int width);
/**
- Returns the width of the specified column.
+ Sets the minimal row @a height used by default.
+
+ See SetColMinimalAcceptableWidth() for more information.
*/
- int GetColSize(int col) const;
+ void SetRowMinimalAcceptableHeight(int height);
/**
- Returns the default cell alignment.
+ Sets the minimal @a height for the specified @a row.
- Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
- or @c wxALIGN_RIGHT.
+ See SetColMinimalWidth() for more information.
+ */
+ void SetRowMinimalHeight(int row, int height);
- Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
- @c wxALIGN_BOTTOM.
+ /**
+ Sets the height of the specified row.
- @see SetDefaultCellAlignment()
+ See SetColSize() for more information.
*/
- void GetDefaultCellAlignment(int* horiz, int* vert) const;
+ void SetRowSize(int row, int height);
+
+ //@}
+
/**
- Returns the current default background colour for grid cells.
- */
- wxColour GetDefaultCellBackgroundColour() const;
+ @name User-Resizing and Dragging
+ */
+ //@{
/**
- Returns the current default font for grid cell text.
+ Return @true if the dragging of cells is enabled or @false otherwise.
*/
- wxFont GetDefaultCellFont() const;
+ bool CanDragCell() const;
/**
- Returns the current default colour for grid cell text.
+ Returns @true if columns can be moved by dragging with the mouse.
+
+ Columns can be moved by dragging on their labels.
*/
- wxColour GetDefaultCellTextColour() const;
+ bool CanDragColMove() const;
/**
- Returns the default height for column labels.
+ Returns @true if columns can be resized by dragging with the mouse.
+
+ Columns can be resized by dragging the edges of their labels. If grid
+ line dragging is enabled they can also be resized by dragging the right
+ edge of the column in the grid cell area (see EnableDragGridSize()).
*/
- int GetDefaultColLabelSize() const;
+ bool CanDragColSize() const;
/**
- Returns the current default width for grid columns.
+ Return @true if the dragging of grid lines to resize rows and columns
+ is enabled or @false otherwise.
*/
- int GetDefaultColSize() const;
+ bool CanDragGridSize() const;
/**
- Returns a pointer to the current default grid cell editor.
+ Returns @true if rows can be resized by dragging with the mouse.
- See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
+ Rows can be resized by dragging the edges of their labels. If grid line
+ dragging is enabled they can also be resized by dragging the lower edge
+ of the row in the grid cell area (see EnableDragGridSize()).
*/
- wxGridCellEditor* GetDefaultEditor() const;
+ bool CanDragRowSize() const;
- //@{
/**
- Returns the default editor for the specified cell.
-
- The base class version returns the editor appropriate for the current
- cell type but this method may be overridden in the derived classes to
- use custom editors for some cells by default.
-
- Notice that the same may be usually achieved in simpler way by
- associating a custom editor with the given cell or cells.
+ Disables column moving by dragging with the mouse.
- The caller must call DecRef() on the returned pointer.
+ Equivalent to passing @false to EnableDragColMove().
*/
- virtual wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
- wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const;
- //@}
+ void DisableDragColMove();
/**
- Returns the default editor for the cells containing values of the given
- type.
-
- The base class version returns the editor which was associated with the
- specified @a typeName when it was registered RegisterDataType() but
- this function may be overridden to return something different. This
- allows to override an editor used for one of the standard types.
+ Disables column sizing by dragging with the mouse.
- The caller must call DecRef() on the returned pointer.
+ Equivalent to passing @false to EnableDragColSize().
*/
- virtual wxGridCellEditor *
- GetDefaultEditorForType(const wxString& typeName) const;
+ void DisableDragColSize();
/**
- Returns the pen used for grid lines.
-
- This virtual function may be overridden in derived classes in order to
- change the appearance of grid lines. Note that currently the pen width
- must be 1.
+ Disable mouse dragging of grid lines to resize rows and columns.
- @see GetColGridLinePen(), GetRowGridLinePen()
+ Equivalent to passing @false to EnableDragGridSize()
*/
- virtual wxPen GetDefaultGridLinePen();
+ void DisableDragGridSize();
/**
- Returns a pointer to the current default grid cell renderer.
+ Disables row sizing by dragging with the mouse.
- See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
+ Equivalent to passing @false to EnableDragRowSize().
+ */
+ void DisableDragRowSize();
- The caller must call DecRef() on the returned pointer.
+ /**
+ Enables or disables cell dragging with the mouse.
*/
- wxGridCellRenderer* GetDefaultRenderer() const;
+ void EnableDragCell(bool enable = true);
/**
- Returns the default renderer for the given cell.
+ Enables or disables column moving by dragging with the mouse.
+ */
+ void EnableDragColMove(bool enable = true);
- The base class version returns the renderer appropriate for the current
- cell type but this method may be overridden in the derived classes to
- use custom renderers for some cells by default.
+ /**
+ Enables or disables column sizing by dragging with the mouse.
+ */
+ void EnableDragColSize(bool enable = true);
- The caller must call DecRef() on the returned pointer.
+ /**
+ Enables or disables row and column resizing by dragging gridlines with
+ the mouse.
*/
- virtual wxGridCellRenderer *GetDefaultRendererForCell(int row, int col) const;
+ void EnableDragGridSize(bool enable = true);
/**
- Returns the default renderer for the cell containing values of the
- given type.
+ Enables or disables row sizing by dragging with the mouse.
+ */
+ void EnableDragRowSize(bool enable = true);
- @see GetDefaultEditorForType()
+ /**
+ Returns the column ID of the specified column position.
*/
- virtual wxGridCellRenderer *
- GetDefaultRendererForType(const wxString& typeName) const;
+ int GetColAt(int colPos) const;
/**
- Returns the default width for the row labels.
+ Returns the position of the specified column.
*/
- int GetDefaultRowLabelSize() const;
+ int GetColPos(int colID) const;
/**
- Returns the current default height for grid rows.
+ Sets the position of the specified column.
*/
- int GetDefaultRowSize() const;
+ void SetColPos(int colID, int newPos);
+
+ //@}
+
+
+ /**
+ @name Cursor Movement
+ */
+ //@{
/**
Returns the current grid cell column position.
int GetGridCursorRow() const;
/**
- Returns the colour used for grid lines.
-
- @see GetDefaultGridLinePen()
- */
- wxColour GetGridLineColour() const;
+ Make the given cell current and ensure it is visible.
+ This method is equivalent to calling MakeCellVisible() and
+ SetGridCursor() and so, as with the latter, a @c wxEVT_GRID_SELECT_CELL
+ event is generated by it and the selected cell doesn't change if the
+ event is vetoed.
+ */
+ void GoToCell(int row, int col);
/**
- Returns the colour used for the background of row and column labels.
- */
- wxColour GetLabelBackgroundColour() const;
+ Make the given cell current and ensure it is visible.
- /**
- Returns the font used for row and column labels.
- */
- wxFont GetLabelFont() const;
+ This method is equivalent to calling MakeCellVisible() and
+ SetGridCursor() and so, as with the latter, a @c wxEVT_GRID_SELECT_CELL
+ event is generated by it and the selected cell doesn't change if the
+ event is vetoed.
+ */
+ void GoToCell(const wxGridCellCoords& coords);
/**
- Returns the colour used for row and column label text.
+ Moves the grid cursor down by one row.
+
+ If a block of cells was previously selected it will expand if the
+ argument is @true or be cleared if the argument is @false.
*/
- wxColour GetLabelTextColour() const;
+ bool MoveCursorDown(bool expandSelection);
/**
- Returns the total number of grid columns.
+ Moves the grid cursor down in the current column such that it skips to
+ the beginning or end of a block of non-empty cells.
- This is the same as the number of columns in the underlying grid
- table.
+ If a block of cells was previously selected it will expand if the
+ argument is @true or be cleared if the argument is @false.
*/
- int GetNumberCols() const;
+ bool MoveCursorDownBlock(bool expandSelection);
/**
- Returns the total number of grid rows.
+ Moves the grid cursor left by one column.
- This is the same as the number of rows in the underlying grid table.
+ If a block of cells was previously selected it will expand if the
+ argument is @true or be cleared if the argument is @false.
*/
- int GetNumberRows() const;
+ bool MoveCursorLeft(bool expandSelection);
/**
- Returns the attribute for the given cell creating one if necessary.
-
- If the cell already has an attribute, it is returned. Otherwise a new
- attribute is created, associated with the cell and returned. In any
- case the caller must call DecRef() on the returned pointer.
+ Moves the grid cursor left in the current row such that it skips to the
+ beginning or end of a block of non-empty cells.
- This function may only be called if CanHaveAttributes() returns @true.
+ If a block of cells was previously selected it will expand if the
+ argument is @true or be cleared if the argument is @false.
*/
- wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const;
+ bool MoveCursorLeftBlock(bool expandSelection);
/**
- Returns the pen used for horizontal grid lines.
-
- This virtual function may be overridden in derived classes in order to
- change the appearance of individual grid line for the given row @e row.
+ Moves the grid cursor right by one column.
- Example:
- @code
- // in a grid displaying music notation, use a solid black pen between
- // octaves (C0=row 127, C1=row 115 etc.)
- wxPen MidiGrid::GetRowGridLinePen(int row)
- {
- if ( row % 12 == 7 )
- return wxPen(*wxBLACK, 1, wxSOLID);
- else
- return GetDefaultGridLinePen();
- }
- @endcode
+ If a block of cells was previously selected it will expand if the
+ argument is @true or be cleared if the argument is @false.
*/
- virtual wxPen GetRowGridLinePen(int row);
+ bool MoveCursorRight(bool expandSelection);
/**
- Returns the alignment used for row labels.
-
- Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
- or @c wxALIGN_RIGHT.
+ Moves the grid cursor right in the current row such that it skips to
+ the beginning or end of a block of non-empty cells.
- Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
- @c wxALIGN_BOTTOM.
+ If a block of cells was previously selected it will expand if the
+ argument is @true or be cleared if the argument is @false.
*/
- void GetRowLabelAlignment(int* horiz, int* vert) const;
+ bool MoveCursorRightBlock(bool expandSelection);
/**
- Returns the current width of the row labels.
+ Moves the grid cursor up by one row.
+
+ If a block of cells was previously selected it will expand if the
+ argument is @true or be cleared if the argument is @false.
*/
- int GetRowLabelSize() const;
+ bool MoveCursorUp(bool expandSelection);
/**
- Returns the specified row label.
+ Moves the grid cursor up in the current column such that it skips to
+ the beginning or end of a block of non-empty cells.
- The default grid table class provides numeric row labels. If you are
- using a custom grid table you can override
- wxGridTableBase::GetRowLabelValue to provide your own labels.
+ If a block of cells was previously selected it will expand if the
+ argument is @true or be cleared if the argument is @false.
*/
- wxString GetRowLabelValue(int row) const;
+ bool MoveCursorUpBlock(bool expandSelection);
/**
- Returns the minimal size to which rows can be resized.
-
- Use SetRowMinimalAcceptableHeight() to change this value globally or
- SetRowMinimalHeight() to do it for individual cells.
-
- @see GetColMinimalAcceptableWidth()
+ Moves the grid cursor down by some number of rows so that the previous
+ bottom visible row becomes the top visible row.
*/
- int GetRowMinimalAcceptableHeight() const;
+ bool MovePageDown();
/**
- Returns the minimal size for the given column.
-
- The value returned by this function may be different than that returned
- by GetRowMinimalAcceptableHeight() if SetRowMinimalHeight() had been
- called for this row.
+ Moves the grid cursor up by some number of rows so that the previous
+ top visible row becomes the bottom visible row.
*/
- int GetRowMinimalHeight(int col) const;
+ bool MovePageUp();
/**
- Returns the height of the specified row.
- */
- int GetRowSize(int row) const;
+ Set the grid cursor to the specified cell.
+ The grid cursor indicates the current cell and can be moved by the user
+ using the arrow keys or the mouse.
+
+ Calling this function generates a @c wxEVT_GRID_SELECT_CELL event and
+ if the event handler vetoes this event, the cursor is not moved.
+
+ This function doesn't make the target call visible, use GoToCell() to
+ do this.
+ */
+ void SetGridCursor(int row, int col);
/**
- Returns the number of pixels per horizontal scroll increment.
+ Set the grid cursor to the specified cell.
- The default is 15.
+ The grid cursor indicates the current cell and can be moved by the user
+ using the arrow keys or the mouse.
- @see GetScrollLineY(), SetScrollLineX(), SetScrollLineY()
+ Calling this function generates a @c wxEVT_GRID_SELECT_CELL event and
+ if the event handler vetoes this event, the cursor is not moved.
+
+ This function doesn't make the target call visible, use GoToCell() to
+ do this.
*/
- int GetScrollLineX() const;
+ void SetGridCursor(const wxGridCellCoords& coords);
- /**
- Returns the number of pixels per vertical scroll increment.
+ //@}
- The default is 15.
- @see GetScrollLineX(), SetScrollLineX(), SetScrollLineY()
+ /**
+ @name User Selection
+ */
+ //@{
+
+ /**
+ Deselects all cells that are currently selected.
*/
- int GetScrollLineY() const;
+ void ClearSelection();
/**
Returns an array of individually selected cells.
wxArrayInt GetSelectedRows() const;
/**
- Access or update the selection fore/back colours
+ Returns the colour used for drawing the selection background.
*/
wxColour GetSelectionBackground() const;
wxGridSelectionModes GetSelectionMode() const;
/**
- Returns a base pointer to the current table object.
+ Returns @true if the given cell is selected.
+ */
+ bool IsInSelection(int row, int col) const;
+ /**
+ Returns @true if the given cell is selected.
+ */
+ bool IsInSelection(const wxGridCellCoords& coords) const;
- The returned pointer is still owned by the grid.
+ /**
+ Returns @true if there are currently any selected cells, rows, columns
+ or blocks.
*/
- wxGridTableBase *GetTable() const;
+ bool IsSelection() const;
- //@{
/**
- Make the given cell current and ensure it is visible.
+ Selects all cells in the grid.
+ */
+ void SelectAll();
- This method is equivalent to calling MakeCellVisible() and
- SetGridCursor() and so, as with the latter, a wxEVT_GRID_SELECT_CELL
- event is generated by it and the selected cell doesn't change if the
- event is vetoed.
- */
- void GoToCell(int row, int col);
- void GoToCell(const wxGridCellCoords& coords);
- //@}
+ /**
+ Selects a rectangular block of cells.
+ If @a addToSelected is @false then any existing selection will be
+ deselected; if @true the column will be added to the existing
+ selection.
+ */
+ void SelectBlock(int topRow, int leftCol, int bottomRow, int rightCol,
+ bool addToSelected = false);
/**
- Returns @true if drawing of grid lines is turned on, @false otherwise.
+ Selects a rectangular block of cells.
+
+ If @a addToSelected is @false then any existing selection will be
+ deselected; if @true the column will be added to the existing
+ selection.
*/
- bool GridLinesEnabled() const;
+ void SelectBlock(const wxGridCellCoords& topLeft,
+ const wxGridCellCoords& bottomRight,
+ bool addToSelected = false);
/**
- Hides the in-place cell edit control.
+ Selects the specified column.
+
+ If @a addToSelected is @false then any existing selection will be
+ deselected; if @true the column will be added to the existing
+ selection.
+
+ This method won't select anything if the current selection mode is
+ wxGridSelectRows.
*/
- void HideCellEditControl();
+ void SelectCol(int col, bool addToSelected = false);
/**
- Hides the column labels by calling SetColLabelSize()
- with a size of 0. Show labels again by calling that method with
- a width greater than 0.
+ Selects the specified row.
+
+ If @a addToSelected is @false then any existing selection will be
+ deselected; if @true the row will be added to the existing selection.
+
+ This method won't select anything if the current selection mode is
+ wxGridSelectColumns.
*/
- void HideColLabels();
+ void SelectRow(int row, bool addToSelected = false);
/**
- Hides the row labels by calling SetRowLabelSize() with a size of 0.
+ Set the colour to be used for drawing the selection background.
+ */
+ void SetSelectionBackground(const wxColour& c);
- The labels can be shown again by calling SetRowLabelSize() with a width
- greater than 0.
+ /**
+ Set the colour to be used for drawing the selection foreground.
*/
- void HideRowLabels();
+ void SetSelectionForeground(const wxColour& c);
/**
- Inserts one or more new columns into a grid with the first new column
- at the specified position.
+ Set the selection behaviour of the grid.
- Notice that inserting the columns in the grid requires grid table
- cooperation: when this method is called, grid object begins by
- requesting the underlying grid table to insert new columns. If this is
- successful the table notifies the grid and the grid updates the
- display. For a default grid (one where you have called
- wxGrid::CreateGrid) this process is automatic. If you are using a
- custom grid table (specified with wxGrid::SetTable) then you must
- override wxGridTableBase::InsertCols() in your derived table class.
+ The existing selection is converted to conform to the new mode if
+ possible and discarded otherwise (e.g. any individual selected cells
+ are deselected if the new mode allows only the selection of the entire
+ rows or columns).
+ */
+ void SetSelectionMode(wxGridSelectionModes selmode);
- @param pos
- The position which the first newly inserted column will have.
- @param numCols
- The number of columns to insert.
- @param updateLabels
- Currently not used.
- @return
- @true if the columns were successfully inserted, @false if an error
- occurred (most likely the table couldn't be updated).
+ //@}
+
+
+ /**
+ @name Scrolling
+ */
+ //@{
+
+ /**
+ Returns the number of pixels per horizontal scroll increment.
+
+ The default is 15.
+
+ @see GetScrollLineY(), SetScrollLineX(), SetScrollLineY()
*/
- bool InsertCols(int pos = 0, int numCols = 1, bool updateLabels = true);
+ int GetScrollLineX() const;
/**
- Inserts one or more new rows into a grid with the first new row at the
- specified position.
+ Returns the number of pixels per vertical scroll increment.
- Notice that you must implement wxGridTableBase::InsertRows() if you use
- a grid with a custom table, please see InsertCols() for more
- information.
+ The default is 15.
- @param pos
- The position which the first newly inserted row will have.
- @param numRows
- The number of rows to insert.
- @param updateLabels
- Currently not used.
- @return
- @true if the rows were successfully inserted, @false if an error
- occurred (most likely the table couldn't be updated).
+ @see GetScrollLineX(), SetScrollLineX(), SetScrollLineY()
*/
- bool InsertRows(int pos = 0, int numRows = 1, bool updateLabels = true);
+ int GetScrollLineY() const;
/**
- Returns @true if the in-place edit control is currently enabled.
+ Returns @true if a cell is either entirely or at least partially
+ visible in the grid window.
+
+ By default, the cell must be entirely visible for this function to
+ return @true but if @a wholeCellVisible is @false, the function returns
+ @true even if the cell is only partially visible.
*/
- bool IsCellEditControlEnabled() const;
+ bool IsVisible(int row, int col, bool wholeCellVisible = true) const;
+ /**
+ Returns @true if a cell is either entirely or at least partially
+ visible in the grid window.
+
+ By default, the cell must be entirely visible for this function to
+ return @true but if @a wholeCellVisible is @false, the function returns
+ @true even if the cell is only partially visible.
+ */
+ bool IsVisible(const wxGridCellCoords& coords,
+ bool wholeCellVisible = true) const;
/**
- Returns @true if the current cell is read-only.
+ Brings the specified cell into the visible grid cell area with minimal
+ scrolling.
- @see SetReadOnly(), IsReadOnly()
+ Does nothing if the cell is already visible.
*/
- bool IsCurrentCellReadOnly() const;
+ void MakeCellVisible(int row, int col);
+ /**
+ Brings the specified cell into the visible grid cell area with minimal
+ scrolling.
+
+ Does nothing if the cell is already visible.
+ */
+ void MakeCellVisible(const wxGridCellCoords& coords);
/**
- Returns @false if the whole grid has been set as read-only or @true
- otherwise.
+ Sets the number of pixels per horizontal scroll increment.
- See EnableEditing() for more information about controlling the editing
- status of grid cells.
+ The default is 15.
+
+ @see GetScrollLineX(), GetScrollLineY(), SetScrollLineY()
*/
- bool IsEditable() const;
+ void SetScrollLineX(int x);
- //@{
/**
- Is this cell currently selected?
+ Sets the number of pixels per vertical scroll increment.
+
+ The default is 15.
+
+ @see GetScrollLineX(), GetScrollLineY(), SetScrollLineX()
*/
- bool IsInSelection(int row, int col) const;
- bool IsInSelection(const wxGridCellCoords& coords) const;
+ void SetScrollLineY(int y);
+
//@}
+
+ /**
+ @name Cell and Device Coordinate Translation
+ */
+ //@{
+
+ /**
+ Convert grid cell coordinates to grid window pixel coordinates.
+
+ This function returns the rectangle that encloses the block of cells
+ limited by @a topLeft and @a bottomRight cell in device coords and
+ clipped to the client size of the grid window.
+
+ @see CellToRect()
+ */
+ wxRect BlockToDeviceRect(const wxGridCellCoords& topLeft,
+ const wxGridCellCoords& bottomRight) const;
+
+ /**
+ Return the rectangle corresponding to the grid cell's size and position
+ in logical coordinates.
+
+ @see BlockToDeviceRect()
+ */
+ wxRect CellToRect(int row, int col) const;
+ /**
+ Return the rectangle corresponding to the grid cell's size and position
+ in logical coordinates.
+
+ @see BlockToDeviceRect()
+ */
+ const wxRect CellToRect(const wxGridCellCoords& coords) const;
+
+ /**
+ Returns the column at the given pixel position.
+
+ @param x
+ The x position to evaluate.
+ @param clipToMinMax
+ If @true, rather than returning @c wxNOT_FOUND, it returns either
+ the first or last column depending on whether @a x is too far to
+ the left or right respectively.
+ @return
+ The column index or @c wxNOT_FOUND.
+ */
+ int XToCol(int x, bool clipToMinMax = false) const;
+
+ /**
+ Returns the column whose right hand edge is close to the given logical
+ @a x position.
+
+ If no column edge is near to this position @c wxNOT_FOUND is returned.
+ */
+ int XToEdgeOfCol(int x) const;
+
+ /**
+ Translates logical pixel coordinates to the grid cell coordinates.
+
+ Notice that this function expects logical coordinates on input so if
+ you use this function in a mouse event handler you need to translate
+ the mouse position, which is expressed in device coordinates, to
+ logical ones.
+
+ @see XToCol(), YToRow()
+ */
+ wxGridCellCoords XYToCell(int x, int y) const;
/**
- Returns @true if the cell at the specified location can't be edited.
+ Translates logical pixel coordinates to the grid cell coordinates.
- @see SetReadOnly(), IsCurrentCellReadOnly()
- */
- bool IsReadOnly(int row, int col) const;
+ Notice that this function expects logical coordinates on input so if
+ you use this function in a mouse event handler you need to translate
+ the mouse position, which is expressed in device coordinates, to
+ logical ones.
- /**
- Returns @true if there are currently any selected cells, rows, columns
- or blocks.
- */
- bool IsSelection() const;
+ @see XToCol(), YToRow()
+ */
+ wxGridCellCoords XYToCell(const wxPoint& pos) const;
+ // XYToCell(int, int, wxGridCellCoords&) overload is intentionally
+ // undocumented, using it is ugly and non-const reference parameters are
+ // not used in wxWidgets API
- //@{
/**
- Returns @true if a cell is either wholly or at least partially visible
- in the grid window.
+ Returns the row whose bottom edge is close to the given logical @a y
+ position.
- By default, the cell must be entirely visible for this function to
- return true but if @a wholeCellVisible is @false, the function returns
- @true even if the cell is only partially visible.
+ If no row edge is near to this position @c wxNOT_FOUND is returned.
*/
- bool IsVisible(int row, int col, bool wholeCellVisible = true) const;
- const bool IsVisible(const wxGridCellCoords& coords,
- bool wholeCellVisible = true) const;
- //@}
+ int YToEdgeOfRow(int y) const;
- //@{
/**
- Brings the specified cell into the visible grid cell area with minimal
- scrolling.
+ Returns the grid row that corresponds to the logical @a y coordinate.
- Does nothing if the cell is already visible.
+ Returns @c wxNOT_FOUND if there is no row at the @a y position.
*/
- void MakeCellVisible(int row, int col);
- void MakeCellVisible(const wxGridCellCoords& coords);
+ int YToRow(int y, bool clipToMinMax = false) const;
+
//@}
- /**
- Moves the grid cursor down by one row.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
- */
- bool MoveCursorDown(bool expandSelection);
+ /**
+ @name Miscellaneous Functions
+ */
+ //@{
/**
- Moves the grid cursor down in the current column such that it skips to
- the beginning or end of a block of non-empty cells.
+ Appends one or more new columns to the right of the grid.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
+ The @a updateLabels argument is not used at present. If you are using a
+ derived grid table class you will need to override
+ wxGridTableBase::AppendCols(). See InsertCols() for further
+ information.
+
+ @return @true on success or @false if appending columns failed.
*/
- bool MoveCursorDownBlock(bool expandSelection);
+ bool AppendCols(int numCols = 1, bool updateLabels = true);
/**
- Moves the grid cursor left by one column.
+ Appends one or more new rows to the bottom of the grid.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
+ The @a updateLabels argument is not used at present. If you are using a
+ derived grid table class you will need to override
+ wxGridTableBase::AppendRows(). See InsertRows() for further
+ information.
+
+ @return @true on success or @false if appending rows failed.
*/
- bool MoveCursorLeft(bool expandSelection);
+ bool AppendRows(int numRows = 1, bool updateLabels = true);
/**
- Moves the grid cursor left in the current row such that it skips to the
- beginning or end of a block of non-empty cells.
+ Return @true if the horizontal grid lines stop at the last column
+ boundary or @false if they continue to the end of the window.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
- */
- bool MoveCursorLeftBlock(bool expandSelection);
+ The default is to clip grid lines.
+
+ @see ClipHorzGridLines(), AreVertGridLinesClipped()
+ */
+ bool AreHorzGridLinesClipped() const;
/**
- Moves the grid cursor right by one column.
+ Return @true if the vertical grid lines stop at the last row
+ boundary or @false if they continue to the end of the window.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
- */
- bool MoveCursorRight(bool expandSelection);
+ The default is to clip grid lines.
+
+ @see ClipVertGridLines(), AreHorzGridLinesClipped()
+ */
+ bool AreVertGridLinesClipped() const;
/**
- Moves the grid cursor right in the current row such that it skips to
- the beginning or end of a block of non-empty cells.
+ Increments the grid's batch count.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
+ When the count is greater than zero repainting of the grid is
+ suppressed. Each call to BeginBatch must be matched by a later call to
+ EndBatch(). Code that does a lot of grid modification can be enclosed
+ between BeginBatch() and EndBatch() calls to avoid screen flicker. The
+ final EndBatch() call will cause the grid to be repainted.
+
+ Notice that you should use wxGridUpdateLocker which ensures that there
+ is always a matching EndBatch() call for this BeginBatch() if possible
+ instead of calling this method directly.
*/
- bool MoveCursorRightBlock(bool expandSelection);
+ void BeginBatch();
/**
- Moves the grid cursor up by one row.
+ Clears all data in the underlying grid table and repaints the grid.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
+ The table is not deleted by this function. If you are using a derived
+ table class then you need to override wxGridTableBase::Clear() for this
+ function to have any effect.
*/
- bool MoveCursorUp(bool expandSelection);
+ void ClearGrid();
/**
- Moves the grid cursor up in the current column such that it skips to
- the beginning or end of a block of non-empty cells.
+ Change whether the horizontal grid lines are clipped by the end of the
+ last column.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
- */
- bool MoveCursorUpBlock(bool expandSelection);
+ By default the grid lines are not drawn beyond the end of the last
+ column but after calling this function with @a clip set to @false they
+ will be drawn across the entire grid window.
- /**
- Moves the grid cursor down by some number of rows so that the previous
- bottom visible row becomes the top visible row.
- */
- bool MovePageDown();
+ @see AreHorzGridLinesClipped(), ClipVertGridLines()
+ */
+ void ClipHorzGridLines(bool clip);
/**
- Moves the grid cursor up by some number of rows so that the previous
- top visible row becomes the bottom visible row.
- */
- bool MovePageUp();
+ Change whether the vertical grid lines are clipped by the end of the
+ last row.
- /**
- Register a new data type.
+ By default the grid lines are not drawn beyond the end of the last
+ row but after calling this function with @a clip set to @false they
+ will be drawn across the entire grid window.
- The data types allow to naturally associate specific renderers and
- editors to the cells containing values of the given type. For example,
- the grid automatically registers a data type with the name @c
- wxGRID_VALUE_STRING which uses wxGridCellStringRenderer and
- wxGridCellTextEditor as its renderer and editor respectively -- this is
- the data type used by all the cells of the default wxGridStringTable,
- so this renderer and editor are used by default for all grid cells.
+ @see AreVertGridLinesClipped(), ClipHorzGridLines()
+ */
+ void ClipVertGridLines(bool clip);
- However if a custom table returns @c wxGRID_VALUE_BOOL from its
- wxGridTableBase::GetTypeName() method, then wxGridCellBoolRenderer and
- wxGridCellBoolEditor are used for it because the grid also registers a
- boolean data type with this name.
+ /**
+ Deletes one or more columns from a grid starting at the specified
+ position.
- And as this mechanism is completely generic, you may register your own
- data types using your own custom renderers and editors. Just remember
- that the table must identify a cell as being of the given type for them
- to be used for this cell.
+ The @a updateLabels argument is not used at present. If you are using a
+ derived grid table class you will need to override
+ wxGridTableBase::DeleteCols(). See InsertCols() for further
+ information.
- @param typeName
- Name of the new type. May be any string, but if the type name is
- the same as the name of an already registered type, including one
- of the standard ones (which are @c wxGRID_VALUE_STRING, @c
- wxGRID_VALUE_BOOL, @c wxGRID_VALUE_NUMBER, @c wxGRID_VALUE_FLOAT
- and @c wxGRID_VALUE_CHOICE), then the new registration information
- replaces the previously used renderer and editor.
- @param renderer
- The renderer to use for the cells of this type. Its ownership is
- taken by the grid, i.e. it will call DecRef() on this pointer when
- it doesn't need it any longer.
- @param editor
- The editor to use for the cells of this type. Its ownership is also
- taken by the grid.
+ @return @true on success or @false if deleting columns failed.
*/
- void RegisterDataType(const wxString& typeName,
- wxGridCellRenderer* renderer,
- wxGridCellEditor* editor);
+ bool DeleteCols(int pos = 0, int numCols = 1, bool updateLabels = true);
/**
- Sets the value of the current grid cell to the current in-place edit
- control value.
+ Deletes one or more rows from a grid starting at the specified
+ position.
- This is called automatically when the grid cursor moves from the
- current cell to a new cell. It is also a good idea to call this
- function when closing a grid since any edits to the final cell location
- will not be saved otherwise.
- */
- void SaveEditControlValue();
+ The @a updateLabels argument is not used at present. If you are using a
+ derived grid table class you will need to override
+ wxGridTableBase::DeleteRows(). See InsertRows() for further
+ information.
- /**
- Selects all cells in the grid.
+ @return @true on success or @false if appending rows failed.
*/
- void SelectAll();
+ bool DeleteRows(int pos = 0, int numRows = 1, bool updateLabels = true);
- //@{
/**
- Selects a rectangular block of cells.
+ Decrements the grid's batch count.
- If @a addToSelected is @false then any existing selection will be
- deselected; if @true the column will be added to the existing
- selection.
+ When the count is greater than zero repainting of the grid is
+ suppressed. Each previous call to BeginBatch() must be matched by a
+ later call to EndBatch(). Code that does a lot of grid modification can
+ be enclosed between BeginBatch() and EndBatch() calls to avoid screen
+ flicker. The final EndBatch() will cause the grid to be repainted.
+
+ @see wxGridUpdateLocker
*/
- void SelectBlock(int topRow, int leftCol, int bottomRow, int rightCol,
- bool addToSelected = false);
- void SelectBlock(const wxGridCellCoords& topLeft,
- const wxGridCellCoords& bottomRight,
- bool addToSelected = false);
- //@}
+ void EndBatch();
/**
- Selects the specified column.
-
- If @a addToSelected is @false then any existing selection will be
- deselected; if @true the column will be added to the existing
- selection.
-
- This method won't select anything if the current selection mode is
- wxGridSelectRows.
+ Overridden wxWindow method.
*/
- void SelectCol(int col, bool addToSelected = false);
+ virtual void Fit();
/**
- Selects the specified row.
-
- If @a addToSelected is @false then any existing selection will be
- deselected; if @true the row will be added to the existing selection.
+ Causes immediate repainting of the grid.
- This method won't select anything if the current selection mode is
- wxGridSelectColumns.
+ Use this instead of the usual wxWindow::Refresh().
*/
- void SelectRow(int row, bool addToSelected = false);
+ void ForceRefresh();
- //@{
/**
- Sets the horizontal and vertical alignment for grid cell text at the
- specified location.
-
- Horizontal alignment should be one of @c wxALIGN_LEFT, @c
- wxALIGN_CENTRE or @c wxALIGN_RIGHT.
-
- Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
- or @c wxALIGN_BOTTOM.
+ Returns the number of times that BeginBatch() has been called without
+ (yet) matching calls to EndBatch(). While the grid's batch count is
+ greater than zero the display will not be updated.
*/
- void SetCellAlignment(int row, int col, int horiz, int vert);
- void SetCellAlignment(int align, int row, int col);
- //@}
+ int GetBatchCount();
- //@{
/**
- Set the background colour for the given cell or all cells by default.
+ Returns the total number of grid columns.
+
+ This is the same as the number of columns in the underlying grid table.
*/
- void SetCellBackgroundColour(int row, int col, const wxColour& colour);
- //@}
+ int GetNumberCols() const;
/**
- Sets the editor for the grid cell at the specified location.
-
- The grid will take ownership of the pointer.
+ Returns the total number of grid rows.
- See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
+ This is the same as the number of rows in the underlying grid table.
*/
- void SetCellEditor(int row, int col, wxGridCellEditor* editor);
+ int GetNumberRows() const;
/**
- Sets the font for text in the grid cell at the specified location.
+ Returns the attribute for the given cell creating one if necessary.
+
+ If the cell already has an attribute, it is returned. Otherwise a new
+ attribute is created, associated with the cell and returned. In any
+ case the caller must call DecRef() on the returned pointer.
+
+ This function may only be called if CanHaveAttributes() returns @true.
*/
- void SetCellFont(int row, int col, const wxFont& font);
+ wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const;
/**
- Sets the renderer for the grid cell at the specified location.
-
- The grid will take ownership of the pointer.
+ Returns a base pointer to the current table object.
- See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
+ The returned pointer is still owned by the grid.
*/
- void SetCellRenderer(int row, int col, wxGridCellRenderer* renderer);
+ wxGridTableBase *GetTable() const;
- //@{
/**
- Sets the text colour for the given cell or all cells by default.
+ Inserts one or more new columns into a grid with the first new column
+ at the specified position.
+
+ Notice that inserting the columns in the grid requires grid table
+ cooperation: when this method is called, grid object begins by
+ requesting the underlying grid table to insert new columns. If this is
+ successful the table notifies the grid and the grid updates the
+ display. For a default grid (one where you have called CreateGrid())
+ this process is automatic. If you are using a custom grid table
+ (specified with SetTable()) then you must override
+ wxGridTableBase::InsertCols() in your derived table class.
+
+ @param pos
+ The position which the first newly inserted column will have.
+ @param numCols
+ The number of columns to insert.
+ @param updateLabels
+ Currently not used.
+ @return
+ @true if the columns were successfully inserted, @false if an error
+ occurred (most likely the table couldn't be updated).
*/
- void SetCellTextColour(int row, int col, const wxColour& colour);
- void SetCellTextColour(const wxColour& val, int row, int col);
- void SetCellTextColour(const wxColour& colour);
- //@}
+ bool InsertCols(int pos = 0, int numCols = 1, bool updateLabels = true);
- //@{
/**
- Sets the string value for the cell at the specified location.
+ Inserts one or more new rows into a grid with the first new row at the
+ specified position.
- For simple applications where a grid object automatically uses a
- default grid table of string values you use this function together with
- GetCellValue() to access cell values. For more complex applications
- where you have derived your own grid table class that contains various
- data types (e.g. numeric, boolean or user-defined custom types) then
- you only use this function for those cells that contain string values.
- The last form is for backward compatibility only.
+ Notice that you must implement wxGridTableBase::InsertRows() if you use
+ a grid with a custom table, please see InsertCols() for more
+ information.
- See wxGridTableBase::CanSetValueAs and the @ref overview_grid
- "wxGrid overview" for more information.
+ @param pos
+ The position which the first newly inserted row will have.
+ @param numRows
+ The number of rows to insert.
+ @param updateLabels
+ Currently not used.
+ @return
+ @true if the rows were successfully inserted, @false if an error
+ occurred (most likely the table couldn't be updated).
*/
- void SetCellValue(int row, int col, const wxString& s);
- void SetCellValue(const wxGridCellCoords& coords, const wxString& s);
- void SetCellValue(const wxString& val, int row, int col);
- //@}
+ bool InsertRows(int pos = 0, int numRows = 1, bool updateLabels = true);
/**
Sets the cell attributes for all cells in the specified column.
For more information about controlling grid cell attributes see the
- wxGridCellAttr cell attribute class and the @ref overview_grid "wxGrid overview".
+ wxGridCellAttr cell attribute class and the @ref overview_grid.
*/
void SetColAttr(int col, wxGridCellAttr* attr);
/**
- Sets the specified column to display boolean values.
+ Sets the extra margins used around the grid area.
- @see SetColFormatCustom()
+ A grid may occupy more space than needed for its data display and
+ this function allows to set how big this extra space is
*/
- void SetColFormatBool(int col);
+ void SetMargins(int extraWidth, int extraHeight);
/**
- Sets the specified column to display data in a custom format.
+ Sets the cell attributes for all cells in the specified row.
- This method provides an alternative to defining a custom grid table
- which would return @a typeName from its GetTypeName() method for the
- cells in this column: while it doesn't really change the type of the
- cells in this column, it does associate the renderer and editor used
- for the cells of the specified type with them.
+ The grid takes ownership of the attribute pointer.
- See the @ref overview_grid "wxGrid overview" for more
- information on working with custom data types.
+ See the wxGridCellAttr class for more information about controlling
+ cell attributes.
*/
- void SetColFormatCustom(int col, const wxString& typeName);
-
- /**
- Sets the specified column to display floating point values with the
- given width and precision.
+ void SetRowAttr(int row, wxGridCellAttr* attr);
- @see SetColFormatCustom()
- */
- void SetColFormatFloat(int col, int width = -1, int precision = -1);
+ //@}
+protected:
/**
- Sets the specified column to display integer values.
+ Returns @true if this grid has support for cell attributes.
- @see SetColFormatCustom()
+ The grid supports attributes if it has the associated table which, in
+ turn, has attributes support, i.e. wxGridTableBase::CanHaveAttributes()
+ returns @true.
*/
- void SetColFormatNumber(int col);
+ bool CanHaveAttributes() const;
/**
- Sets the horizontal and vertical alignment of column label text.
+ Get the minimal width of the given column/row.
- Horizontal alignment should be one of @c wxALIGN_LEFT, @c
- wxALIGN_CENTRE or @c wxALIGN_RIGHT.
- Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
- or @c wxALIGN_BOTTOM.
+ The value returned by this function may be different than that returned
+ by GetColMinimalAcceptableWidth() if SetColMinimalWidth() had been
+ called for this column.
*/
- void SetColLabelAlignment(int horiz, int vert);
+ int GetColMinimalWidth(int col) const;
/**
- Sets the height of the column labels.
-
- If @a height equals to @c wxGRID_AUTOSIZE then height is calculated
- automatically so that no label is truncated. Note that this could be
- slow for a large table.
+ Returns the coordinate of the right border specified column.
*/
- void SetColLabelSize(int height);
+ int GetColRight(int col) const;
/**
- Set the value for the given column label.
-
- If you are using a custom grid table you must override
- wxGridTableBase::SetColLabelValue for this to have any effect.
+ Returns the coordinate of the left border specified column.
*/
- void SetColLabelValue(int col, const wxString& value);
+ int GetColLeft(int col) const;
/**
- Sets the minimal width to which the user can resize columns.
+ Returns the minimal size for the given column.
- @see GetColMinimalAcceptableWidth()
+ The value returned by this function may be different than that returned
+ by GetRowMinimalAcceptableHeight() if SetRowMinimalHeight() had been
+ called for this row.
*/
- void SetColMinimalAcceptableWidth(int width);
-
- /**
- Sets the minimal width for the specified column.
+ int GetRowMinimalHeight(int col) const;
+};
- It is usually best to call this method during grid creation as calling
- it later will not resize the column to the given minimal width even if
- it is currently narrower than it.
- @a width must be greater than the minimal acceptable column width as
- returned by GetColMinimalAcceptableWidth().
- */
- void SetColMinimalWidth(int col, int width);
- /**
- Sets the position of the specified column.
- */
- void SetColPos(int colID, int newPos);
+/**
+ @class wxGridUpdateLocker
- /**
- Sets the width of the specified column.
+ This small class can be used to prevent wxGrid from redrawing during its
+ lifetime by calling wxGrid::BeginBatch() in its constructor and
+ wxGrid::EndBatch() in its destructor. It is typically used in a function
+ performing several operations with a grid which would otherwise result in
+ flicker. For example:
- Notice that this function does not refresh the grid, you need to call
- ForceRefresh() to make the changes take effect immediately.
+ @code
+ void MyFrame::Foo()
+ {
+ m_grid = new wxGrid(this, ...);
- @param col
- The column index.
- @param width
- The new column width in pixels or a negative value to fit the
- column width to its label width.
- */
- void SetColSize(int col, int width);
+ wxGridUpdateLocker noUpdates(m_grid);
+ m_grid-AppendColumn();
+ // ... many other operations with m_grid ...
+ m_grid-AppendRow();
- /**
- Sets the default horizontal and vertical alignment for grid cell text.
+ // destructor called, grid refreshed
+ }
+ @endcode
- Horizontal alignment should be one of @c wxALIGN_LEFT, @c
- wxALIGN_CENTRE or @c wxALIGN_RIGHT.
- Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
- or @c wxALIGN_BOTTOM.
- */
- void SetDefaultCellAlignment(int horiz, int vert);
+ Using this class is easier and safer than calling wxGrid::BeginBatch() and
+ wxGrid::EndBatch() because you don't risk missing the call the latter (due
+ to an exception for example).
+ @library{wxadv}
+ @category{grid}
+*/
+class wxGridUpdateLocker
+{
+public:
/**
- Sets the default background colour for grid cells.
+ Creates an object preventing the updates of the specified @a grid. The
+ parameter could be @NULL in which case nothing is done. If @a grid is
+ non-@NULL then the grid must exist for longer than this
+ wxGridUpdateLocker object itself.
+
+ The default constructor could be followed by a call to Create() to set
+ the grid object later.
*/
- void SetDefaultCellBackgroundColour(const wxColour& colour);
+ wxGridUpdateLocker(wxGrid* grid = NULL);
/**
- Sets the default font to be used for grid cell text.
+ Destructor reenables updates for the grid this object is associated
+ with.
*/
- void SetDefaultCellFont(const wxFont& font);
+ ~wxGridUpdateLocker();
/**
- Sets the current default colour for grid cell text.
+ This method can be called if the object had been constructed using the
+ default constructor. It must not be called more than once.
*/
- void SetDefaultCellTextColour(const wxColour& colour);
+ void Create(wxGrid* grid);
+};
- /**
- Sets the default width for columns in the grid.
- This will only affect columns subsequently added to the grid unless
- @a resizeExistingCols is @true.
- If @a width is less than GetColMinimalAcceptableWidth(), then the
- minimal acceptable width is used instead of it.
- */
- void SetDefaultColSize(int width, bool resizeExistingCols = false);
+/**
+ @class wxGridEvent
- /**
- Sets the default editor for grid cells.
+ This event class contains information about various grid events.
- The grid will take ownership of the pointer.
+ @beginEventTable{wxGridEvent}
+ @event{EVT_GRID_CELL_CHANGE(func)}
+ The user changed the data in a cell. Processes a
+ @c wxEVT_GRID_CELL_CHANGE event type.
+ @event{EVT_GRID_CELL_LEFT_CLICK(func)}
+ The user clicked a cell with the left mouse button. Processes a
+ @c wxEVT_GRID_CELL_LEFT_CLICK event type.
+ @event{EVT_GRID_CELL_LEFT_DCLICK(func)}
+ The user double-clicked a cell with the left mouse button. Processes a
+ @c wxEVT_GRID_CELL_LEFT_DCLICK event type.
+ @event{EVT_GRID_CELL_RIGHT_CLICK(func)}
+ The user clicked a cell with the right mouse button. Processes a
+ @c wxEVT_GRID_CELL_RIGHT_CLICK event type.
+ @event{EVT_GRID_CELL_RIGHT_DCLICK(func)}
+ The user double-clicked a cell with the right mouse button. Processes a
+ @c wxEVT_GRID_CELL_RIGHT_DCLICK event type.
+ @event{EVT_GRID_EDITOR_HIDDEN(func)}
+ The editor for a cell was hidden. Processes a
+ @c wxEVT_GRID_EDITOR_HIDDEN event type.
+ @event{EVT_GRID_EDITOR_SHOWN(func)}
+ The editor for a cell was shown. Processes a
+ @c wxEVT_GRID_EDITOR_SHOWN event type.
+ @event{EVT_GRID_LABEL_LEFT_CLICK(func)}
+ The user clicked a label with the left mouse button. Processes a
+ @c wxEVT_GRID_LABEL_LEFT_CLICK event type.
+ @event{EVT_GRID_LABEL_LEFT_DCLICK(func)}
+ The user double-clicked a label with the left mouse button. Processes a
+ @c wxEVT_GRID_LABEL_LEFT_DCLICK event type.
+ @event{EVT_GRID_LABEL_RIGHT_CLICK(func)}
+ The user clicked a label with the right mouse button. Processes a
+ @c wxEVT_GRID_LABEL_RIGHT_CLICK event type.
+ @event{EVT_GRID_LABEL_RIGHT_DCLICK(func)}
+ The user double-clicked a label with the right mouse button. Processes
+ a @c wxEVT_GRID_LABEL_RIGHT_DCLICK event type.
+ @event{EVT_GRID_SELECT_CELL(func)}
+ The user moved to, and selected a cell. Processes a
+ @c wxEVT_GRID_SELECT_CELL event type.
+ @event{EVT_GRID_CMD_CELL_CHANGE(id, func)}
+ The user changed the data in a cell; variant taking a window
+ identifier. Processes a @c wxEVT_GRID_CELL_CHANGE event type.
+ @event{EVT_GRID_CMD_CELL_LEFT_CLICK(id, func)}
+ The user clicked a cell with the left mouse button; variant taking a
+ window identifier. Processes a @c wxEVT_GRID_CELL_LEFT_CLICK event
+ type.
+ @event{EVT_GRID_CMD_CELL_LEFT_DCLICK(id, func)}
+ The user double-clicked a cell with the left mouse button; variant
+ taking a window identifier. Processes a @c wxEVT_GRID_CELL_LEFT_DCLICK
+ event type.
+ @event{EVT_GRID_CMD_CELL_RIGHT_CLICK(id, func)}
+ The user clicked a cell with the right mouse button; variant taking a
+ window identifier. Processes a @c wxEVT_GRID_CELL_RIGHT_CLICK event
+ type.
+ @event{EVT_GRID_CMD_CELL_RIGHT_DCLICK(id, func)}
+ The user double-clicked a cell with the right mouse button; variant
+ taking a window identifier. Processes a @c wxEVT_GRID_CELL_RIGHT_DCLICK
+ event type.
+ @event{EVT_GRID_CMD_EDITOR_HIDDEN(id, func)}
+ The editor for a cell was hidden; variant taking a window identifier.
+ Processes a @c wxEVT_GRID_EDITOR_HIDDEN event type.
+ @event{EVT_GRID_CMD_EDITOR_SHOWN(id, func)}
+ The editor for a cell was shown; variant taking a window identifier.
+ Processes a @c wxEVT_GRID_EDITOR_SHOWN event type.
+ @event{EVT_GRID_CMD_LABEL_LEFT_CLICK(id, func)}
+ The user clicked a label with the left mouse button; variant taking a
+ window identifier. Processes a @c wxEVT_GRID_LABEL_LEFT_CLICK event
+ type.
+ @event{EVT_GRID_CMD_LABEL_LEFT_DCLICK(id, func)}
+ The user double-clicked a label with the left mouse button; variant
+ taking a window identifier. Processes a @c wxEVT_GRID_LABEL_LEFT_DCLICK
+ event type.
+ @event{EVT_GRID_CMD_LABEL_RIGHT_CLICK(id, func)}
+ The user clicked a label with the right mouse button; variant taking a
+ window identifier. Processes a @c wxEVT_GRID_LABEL_RIGHT_CLICK event
+ type.
+ @event{EVT_GRID_CMD_LABEL_RIGHT_DCLICK(id, func)}
+ The user double-clicked a label with the right mouse button; variant
+ taking a window identifier. Processes a
+ @c wxEVT_GRID_LABEL_RIGHT_DCLICK event type.
+ @event{EVT_GRID_CMD_SELECT_CELL(id, func)}
+ The user moved to, and selected a cell; variant taking a window
+ identifier. Processes a @c wxEVT_GRID_SELECT_CELL event type.
+ @endEventTable
- See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
+ @library{wxadv}
+ @category{grid}
+*/
+class wxGridEvent : public wxNotifyEvent
+{
+public:
+ /**
+ Default constructor.
*/
- void SetDefaultEditor(wxGridCellEditor* editor);
-
+ wxGridEvent();
/**
- Sets the default renderer for grid cells.
-
- The grid will take ownership of the pointer.
-
- See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
+ Constructor for initializing all event attributes.
*/
- void SetDefaultRenderer(wxGridCellRenderer* renderer);
+ wxGridEvent(int id, wxEventType type, wxObject* obj,
+ int row = -1, int col = -1, int x = -1, int y = -1,
+ bool sel = true, bool control = false, bool shift = false,
+ bool alt = false, bool meta = false);
/**
- Sets the default height for rows in the grid.
-
- This will only affect rows subsequently added to the grid unless
- @a resizeExistingRows is @true.
-
- If @a height is less than GetRowMinimalAcceptableHeight(), then the
- minimal acceptable heihgt is used instead of it.
+ Returns @true if the Alt key was down at the time of the event.
*/
- void SetDefaultRowSize(int height, bool resizeExistingRows = false);
+ bool AltDown() const;
- //@{
/**
- Set the grid cursor to the specified cell.
-
- The grid cursor indicates the current cell and can be moved by the user
- using the arrow keys or the mouse.
-
- Calling this function generates a wxEVT_GRID_SELECT_CELL event and if
- the event handler vetoes this event, the cursor is not moved.
-
- This function doesn't make the target call visible, use GoToCell() to
- do this.
+ Returns @true if the Control key was down at the time of the event.
*/
- void SetGridCursor(int row, int col);
- void SetGridCursor(const wxGridCellCoords& coords);
- //@}
+ bool ControlDown() const;
+
+ /**
+ Column at which the event occurred.
+ */
+ virtual int GetCol();
/**
- Sets the colour used to draw grid lines.
+ Position in pixels at which the event occurred.
*/
- void SetGridLineColour(const wxColour& colour);
+ wxPoint GetPosition();
/**
- Sets the background colour for row and column labels.
+ Row at which the event occurred.
*/
- void SetLabelBackgroundColour(const wxColour& colour);
+ virtual int GetRow();
/**
- Sets the font for row and column labels.
+ Returns @true if the Meta key was down at the time of the event.
*/
- void SetLabelFont(const wxFont& font);
+ bool MetaDown() const;
/**
- Sets the colour for row and column label text.
+ Returns @true if the user is selecting grid cells, or @false if
+ deselecting.
*/
- void SetLabelTextColour(const wxColour& colour);
+ bool Selecting();
/**
- Sets the extra margins used around the grid area.
-
- A grid may occupy more space than needed for its data display and
- this function allows to set how big this extra space is
+ Returns @true if the Shift key was down at the time of the event.
*/
- void SetMargins(int extraWidth, int extraHeight);
+ bool ShiftDown() const;
+};
- /**
- Makes the cell at the specified location read-only or editable.
- @see IsReadOnly()
- */
- void SetReadOnly(int row, int col, bool isReadOnly = true);
- /**
- Sets the cell attributes for all cells in the specified row.
+/**
+ @class wxGridSizeEvent
- The grid takes ownership of the attribute pointer.
+ This event class contains information about a row/column resize event.
- See the wxGridCellAttr class for more information about controlling
- cell attributes.
- */
- void SetRowAttr(int row, wxGridCellAttr* attr);
+ @beginEventTable{wxGridSizeEvent}
+ @event{EVT_GRID_COL_SIZE(func)}
+ The user resized a column by dragging it. Processes a
+ @c wxEVT_GRID_COL_SIZE event type.
+ @event{EVT_GRID_ROW_SIZE(func)}
+ The user resized a row by dragging it. Processes a
+ @c wxEVT_GRID_ROW_SIZE event type.
+ @event{EVT_GRID_CMD_COL_SIZE(id, func)}
+ The user resized a column by dragging it; variant taking a window
+ identifier. Processes a @c wxEVT_GRID_COL_SIZE event type.
+ @event{EVT_GRID_CMD_ROW_SIZE(id, func)}
+ The user resized a row by dragging it; variant taking a window
+ identifier. Processes a @c wxEVT_GRID_ROW_SIZE event type.
+ @endEventTable
+ @library{wxadv}
+ @category{grid}
+*/
+class wxGridSizeEvent : public wxNotifyEvent
+{
+public:
/**
- Sets the horizontal and vertical alignment of row label text.
-
- Horizontal alignment should be one of @c wxALIGN_LEFT, @c
- wxALIGN_CENTRE or @c wxALIGN_RIGHT.
- Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
- or @c wxALIGN_BOTTOM.
+ Default constructor.
*/
- void SetRowLabelAlignment(int horiz, int vert);
-
+ wxGridSizeEvent();
/**
- Sets the width of the row labels.
-
- If @a width equals @c wxGRID_AUTOSIZE then width is calculated
- automatically so that no label is truncated. Note that this could be
- slow for a large table.
+ Constructor for initializing all event attributes.
*/
- void SetRowLabelSize(int width);
+ wxGridSizeEvent(int id, wxEventType type, wxObject* obj,
+ int rowOrCol = -1, int x = -1, int y = -1,
+ bool control = false, bool shift = false,
+ bool alt = false, bool meta = false);
/**
- Sets the value for the given row label.
-
- If you are using a derived grid table you must override
- wxGridTableBase::SetRowLabelValue for this to have any effect.
+ Returns @true if the Alt key was down at the time of the event.
*/
- void SetRowLabelValue(int row, const wxString& value);
+ bool AltDown() const;
/**
- Sets the minimal row height used by default.
-
- See SetColMinimalAcceptableWidth() for more information.
+ Returns @true if the Control key was down at the time of the event.
*/
- void SetRowMinimalAcceptableHeight(int height);
+ bool ControlDown() const;
/**
- Sets the minimal height for the specified row.
-
- See SetColMinimalWidth() for more information.
+ Position in pixels at which the event occurred.
*/
- void SetRowMinimalHeight(int row, int height);
+ wxPoint GetPosition();
/**
- Sets the height of the specified row.
+ Row or column at that was resized.
+ */
+ int GetRowOrCol();
- See SetColSize() for more information.
+ /**
+ Returns @true if the Meta key was down at the time of the event.
*/
- void SetRowSize(int row, int height);
+ bool MetaDown() const;
/**
- Sets the number of pixels per horizontal scroll increment.
+ Returns @true if the Shift key was down at the time of the event.
+ */
+ bool ShiftDown() const;
+};
- The default is 15.
- @see GetScrollLineX(), GetScrollLineY(), SetScrollLineY()
- */
- void SetScrollLineX(int x);
- /**
- Sets the number of pixels per vertical scroll increment.
+/**
+ @class wxGridRangeSelectEvent
- The default is 15.
+ @beginEventTable{wxGridRangeSelectEvent}
+ @event{EVT_GRID_RANGE_SELECT(func)}
+ The user selected a group of contiguous cells. Processes a
+ @c wxEVT_GRID_RANGE_SELECT event type.
+ @event{EVT_GRID_CMD_RANGE_SELECT(id, func)}
+ The user selected a group of contiguous cells; variant taking a window
+ identifier. Processes a @c wxEVT_GRID_RANGE_SELECT event type.
+ @endEventTable
- @see GetScrollLineX(), GetScrollLineY(), SetScrollLineX()
+ @library{wxadv}
+ @category{grid}
+*/
+class wxGridRangeSelectEvent : public wxNotifyEvent
+{
+public:
+ /**
+ Default constructor.
*/
- void SetScrollLineY(int y);
-
+ wxGridRangeSelectEvent();
/**
- Set the colour to be used for drawing the selection background.
+ Constructor for initializing all event attributes.
*/
- void SetSelectionBackground(const wxColour& c);
+ wxGridRangeSelectEvent(int id, wxEventType type,
+ wxObject* obj,
+ const wxGridCellCoords& topLeft,
+ const wxGridCellCoords& bottomRight,
+ bool sel = true, bool control = false,
+ bool shift = false, bool alt = false,
+ bool meta = false);
/**
- Set the colour to be used for drawing the selection foreground.
+ Returns @true if the Alt key was down at the time of the event.
*/
- void SetSelectionForeground(const wxColour& c);
+ bool AltDown() const;
/**
- Set the selection behaviour of the grid.
-
- The existing selection is converted to conform to the new mode if
- possible and discarded otherwise (e.g. any individual selected cells
- are deselected if the new mode allows only the selection of the entire
- rows or columns).
+ Returns @true if the Control key was down at the time of the event.
*/
- void SetSelectionMode(wxGridSelectionModes selmode);
+ bool ControlDown() const;
/**
- Passes a pointer to a custom grid table to be used by the grid.
-
- This should be called after the grid constructor and before using the
- grid object. If @a takeOwnership is set to @true then the table will be
- deleted by the wxGrid destructor.
-
- Use this function instead of CreateGrid() when your application
- involves complex or non-string data or data sets that are too large to
- fit wholly in memory.
+ Top left corner of the rectangular area that was (de)selected.
*/
- bool SetTable(wxGridTableBase* table,
- bool takeOwnership = false,
- wxGridSelectionModes selmode = wxGridSelectCells);
+ wxGridCellCoords GetBottomRightCoords();
/**
- Call this in order to make the column labels use a native look by using
- wxRenderer::DrawHeaderButton internally.
-
- There is no equivalent method for drawing row columns as there is not
- native look for that. This option is useful when using wxGrid for
- displaying tables and not as a spread-sheet.
+ Bottom row of the rectangular area that was (de)selected.
*/
- void SetUseNativeColLabels(bool native = true);
+ int GetBottomRow();
/**
- Displays the in-place cell edit control for the current cell.
+ Left column of the rectangular area that was (de)selected.
*/
- void ShowCellEditControl();
+ int GetLeftCol();
/**
- Returns the column at the given pixel position.
-
- @param x
- The x position to evaluate.
- @param clipToMinMax
- If @true, rather than returning wxNOT_FOUND, it returns either the
- first or last column depending on whether x is too far to the left
- or right respectively.
- @return
- The column index or wxNOT_FOUND.
+ Right column of the rectangular area that was (de)selected.
*/
- int XToCol(int x, bool clipToMinMax = false) const;
+ int GetRightCol();
/**
- Returns the column whose right hand edge is close to the given logical
- x position.
-
- If no column edge is near to this position @c wxNOT_FOUND is returned.
+ Top left corner of the rectangular area that was (de)selected.
*/
- int XToEdgeOfCol(int x) const;
+ wxGridCellCoords GetTopLeftCoords();
- //@{
/**
- Translates logical pixel coordinates to the grid cell coordinates.
-
- Notice that this function expects logical coordinates on input so if
- you use this function in a mouse event handler you need to translate
- the mouse position, which is expressed in device coordinates, to
- logical ones.
-
- @see XToCol(), YToRow()
- */
-
- // XYToCell(int, int, wxGridCellCoords&) overload is intentionally
- // undocumented, using it is ugly and non-const reference parameters are
- // not used in wxWidgets API
-
- wxGridCellCoords XYToCell(int x, int y) const;
- wxGridCellCoords XYToCell(const wxPoint& pos) const;
-
- //@}
+ Top row of the rectangular area that was (de)selected.
+ */
+ int GetTopRow();
/**
- Returns the row whose bottom edge is close to the given logical y
- position.
-
- If no row edge is near to this position @c wxNOT_FOUND is returned.
+ Returns @true if the Meta key was down at the time of the event.
*/
- int YToEdgeOfRow(int y) const;
+ bool MetaDown() const;
/**
- Returns the grid row that corresponds to the logical y coordinate.
+ Returns @true if the area was selected, @false otherwise.
+ */
+ bool Selecting();
- Returns @c wxNOT_FOUND if there is no row at the y position.
+ /**
+ Returns @true if the Shift key was down at the time of the event.
*/
- int YToRow(int y) const;
+ bool ShiftDown() const;
};
/**
- @class wxGridCellBoolEditor
+ @class wxGridEditorCreatedEvent
- The editor for boolean data.
+ @beginEventTable{wxGridEditorCreatedEvent}
+ @event{EVT_GRID_EDITOR_CREATED(func)}
+ The editor for a cell was created. Processes a
+ @c wxEVT_GRID_EDITOR_CREATED event type.
+ @event{EVT_GRID_CMD_EDITOR_CREATED(id, func)}
+ The editor for a cell was created; variant taking a window identifier.
+ Processes a @c wxEVT_GRID_EDITOR_CREATED event type.
+ @endEventTable
@library{wxadv}
@category{grid}
-
- @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellNumberEditor,
- wxGridCellTextEditor, wxGridCellChoiceEditor
*/
-class wxGridCellBoolEditor : public wxGridCellEditor
+class wxGridEditorCreatedEvent : public wxCommandEvent
{
public:
/**
Default constructor.
*/
- wxGridCellBoolEditor();
-
+ wxGridEditorCreatedEvent();
/**
- Returns @true if the given @a value is equal to the string representation of
- the truth value we currently use (see
- wxGridCellBoolEditor::UseStringValues).
+ Constructor for initializing all event attributes.
*/
- static bool IsTrueValue(const wxString& value);
+ wxGridEditorCreatedEvent(int id, wxEventType type, wxObject* obj,
+ int row, int col, wxControl* ctrl);
/**
- , wxString&@e valueFalse = _T(""))
- This method allows to customize the values returned by GetValue() method for
- the cell using this editor. By default, the default values of the arguments are
- used, i.e. @c "1" is returned if the cell is checked and an empty string
- otherwise, using this method allows to change this.
+ Returns the column at which the event occurred.
*/
- static void UseStringValues() const;
-};
-
-
-
-/**
- @class wxGridUpdateLocker
-
- This small class can be used to prevent wxGrid from redrawing
- during its lifetime by calling wxGrid::BeginBatch
- in its constructor and wxGrid::EndBatch in its
- destructor. It is typically used in a function performing several operations
- with a grid which would otherwise result in flicker. For example:
-
- @code
- void MyFrame::Foo()
- {
- m_grid = new wxGrid(this, ...);
-
- wxGridUpdateLocker noUpdates(m_grid);
- m_grid-AppendColumn();
- ... many other operations with m_grid...
- m_grid-AppendRow();
+ int GetCol();
- // destructor called, grid refreshed
- }
- @endcode
+ /**
+ Returns the edit control.
+ */
+ wxControl* GetControl();
- Using this class is easier and safer than calling
- wxGrid::BeginBatch and wxGrid::EndBatch
- because you don't risk not to call the latter (due to an exception for example).
+ /**
+ Returns the row at which the event occurred.
+ */
+ int GetRow();
- @library{wxadv}
- @category{grid}
-*/
-class wxGridUpdateLocker
-{
-public:
/**
- Creates an object preventing the updates of the specified @e grid. The
- parameter could be @NULL in which case nothing is done. If @a grid is
- non-@NULL then the grid must exist for longer than wxGridUpdateLocker object
- itself.
- The default constructor could be followed by a call to
- Create() to set the
- grid object later.
+ Sets the column at which the event occurred.
*/
- wxGridUpdateLocker(wxGrid* grid = NULL);
+ void SetCol(int col);
/**
- Destructor reenables updates for the grid this object is associated with.
+ Sets the edit control.
*/
- ~wxGridUpdateLocker();
+ void SetControl(wxControl* ctrl);
/**
- This method can be called if the object had been constructed using the default
- constructor. It must not be called more than once.
+ Sets the row at which the event occurred.
*/
- void Create(wxGrid* grid);
+ void SetRow(int row);
};
projects / wxWidgets.git / blobdiff