/////////////////////////////////////////////////////////////////////////////
// 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
+ @class wxGridCellNumberRenderer
- The almost abstract base class for grid tables.
+ This class may be used to format integer data in a cell.
- 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.
+ @library{wxadv}
+ @category{grid}
- 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 wxGridCellRenderer, wxGridCellBoolRenderer, wxGridCellFloatRenderer,
+ wxGridCellStringRenderer
+*/
+class wxGridCellNumberRenderer : public wxGridCellStringRenderer
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxGridCellNumberRenderer();
+};
- @see wxGridStringTable
+/**
+ @class wxGridCellStringRenderer
+
+ 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, wxGridCellBoolRenderer, wxGridCellFloatRenderer,
+ wxGridCellNumberRenderer
*/
-class wxGridTableBase : public wxObject
+class wxGridCellStringRenderer : public wxGridCellRenderer
{
public:
- /// Default constructor.
- wxGridTableBase();
+ /**
+ Default constructor.
+ */
+ wxGridCellStringRenderer();
+};
- /// 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;
+/**
+ @class wxGridCellEditor
- /**
- Must be overridden to return the number of columns in the table.
+ 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.
- 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 wxGridCellBoolEditor, wxGridCellChoiceEditor, wxGridCellFloatEditor,
+ wxGridCellNumberEditor, wxGridCellTextEditor
+*/
+class wxGridCellEditor
+{
+public:
/**
- 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;
+ Default constructor.
+ */
+ wxGridCellEditor();
/**
- Return the number of columns in the table.
+ Fetch the value from the table and prepare the edit control to begin
+ editing.
- 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;
+ This function should save the original value of the grid cell at the
+ given @a row and @a col and show the control allowing the user to
+ change it.
+ @see EndEdit()
+ */
+ virtual void BeginEdit(int row, int col, wxGrid* grid) = 0;
/**
- Accessing table cells.
- */
- //@{
+ Create a new object which is the copy of this one.
+ */
+ virtual wxGridCellEditor* Clone() const = 0;
- /// Must be overridden to implement testing for empty cells.
- virtual bool IsEmptyCell(int row, int col) = 0;
+ /**
+ Creates the actual edit control.
+ */
+ virtual void Create(wxWindow* parent, wxWindowID id,
+ wxEvtHandler* evtHandler) = 0;
/**
- Same as IsEmptyCell() but taking wxGridCellCoords.
+ Final cleanup.
+ */
+ virtual void Destroy();
- Notice that this method is not virtual, only IsEmptyCell() should be
- overridden.
- */
- bool IsEmpty(const wxGridCellCoords& coords);
+ /**
+ End editing the cell.
- /// Must be overridden to implement accessing the table values as text.
- virtual wxString GetValue(int row, int col) = 0;
+ This function must check if the current value of the editing control is
+ valid and different from the original value (available as @a oldval in
+ its string form and possibly saved internally using its real type by
+ BeginEdit()). If it isn't, it just returns @false, otherwise it fills
+ @a newval with the representation of the new value in the string form,
+ if necessary saves it using its real type internally, and returns @true.
- /// Must be overridden to implement setting the table values as text.
- virtual void SetValue(int row, int col, const wxString& value) = 0;
+ If the user-defined wxEVT_GRID_CELL_CHANGING event handler doesn't veto
+ this change, ApplyEdit() will be called next.
+ */
+ virtual bool EndEdit(const wxString& oldval, wxString* newval) = 0;
/**
- Returns the type of the value in the given cell.
+ Effectively save the changes in the grid.
- By default all cells are strings and this method returns @c
- wxGRID_VALUE_STRING.
+ This function should save the value of the control in the grid. It is
+ called only after EndEdit() returns @true.
*/
- virtual wxString GetTypeName(int row, int col);
+ virtual void ApplyEdit(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.
-
- 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);
+ The destructor is private because only DecRef() can delete us.
+ */
+ virtual ~wxGridCellEditor();
+};
+/**
+ @class wxGridCellBoolEditor
- /**
- Sets the value of the given cell as a long.
+ Grid cell editor for boolean data.
- 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);
+ @library{wxadv}
+ @category{grid}
+ @see wxGridCellEditor, wxGridCellChoiceEditor, wxGridCellFloatEditor,
+ wxGridCellNumberEditor, wxGridCellTextEditor
+*/
+class wxGridCellBoolEditor : public wxGridCellEditor
+{
+public:
/**
- Sets the value of the given cell as a double.
+ Default constructor.
+ */
+ wxGridCellBoolEditor();
- 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);
+ /**
+ 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 boolean.
+ 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);
+};
- 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 );
+/**
+ @class wxGridCellChoiceEditor
- /**
- Sets the value of the given cell as a user-defined type.
+ 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 @a typeName. 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(wxGridCellAttr* attrDefault = NULL);
+ /**
+ Constructor specifying some of the often used attributes.
+ */
+ wxGridCellAttr(const wxColour& colText, const wxColour& colBack,
+ const wxFont& font, int hAlign, int vAlign);
+
+ /**
+ Creates a new copy of this object.
+ */
+ wxGridCellAttr* Clone() const;
+
+ /**
+ This class is reference counted: it is created with ref count of 1, so
+ calling DecRef() once will delete it. Calling IncRef() allows to lock
+ it until the matching DecRef() is called.
+ */
+ void DecRef();
+
+ /**
+ See SetAlignment() for the returned values.
+ */
+ void GetAlignment(int* hAlign, int* vAlign) const;
+
+ /**
+ Returns the background colour.
+ */
+ const wxColour& GetBackgroundColour() const;
+
+ /**
+ Returns the cell editor.
+ */
+ wxGridCellEditor* GetEditor(const wxGrid* grid, int row, int col) const;
+
+ /**
+ Returns the font.
+ */
+ const wxFont& GetFont() const;
+
+ /**
+ Returns the cell renderer.
+ */
+ wxGridCellRenderer* GetRenderer(const wxGrid* grid, int row, int col) const;
+
+ /**
+ Returns the text colour.
+ */
+ const wxColour& GetTextColour() const;
+
+ /**
+ Returns @true if this attribute has a valid alignment set.
+ */
+ bool HasAlignment() const;
+
+ /**
+ Returns @true if this attribute has a valid background colour set.
+ */
+ bool HasBackgroundColour() const;
+
+ /**
+ Returns @true if this attribute has a valid cell editor set.
+ */
+ bool HasEditor() const;
+
+ /**
+ Returns @true if this attribute has a valid font set.
+ */
+ bool HasFont() const;
+
+ /**
+ Returns @true if this attribute has a valid cell renderer set.
+ */
+ bool HasRenderer() const;
+
+ /**
+ Returns @true if this attribute has a valid text colour set.
+ */
+ bool HasTextColour() const;
+
+ /**
+ This class is reference counted: it is created with ref count of 1, so
+ calling DecRef() once will delete it. Calling IncRef() allows to lock
+ it until the matching DecRef() is called.
+ */
+ void IncRef();
+
+ /**
+ Returns @true if this cell is set as read-only.
+ */
+ bool IsReadOnly() const;
+
+ /**
+ Sets the alignment. @a hAlign can be one of @c wxALIGN_LEFT,
+ @c wxALIGN_CENTRE or @c wxALIGN_RIGHT and @a vAlign can be one of
+ @c wxALIGN_TOP, @c wxALIGN_CENTRE or @c wxALIGN_BOTTOM.
+ */
+ void SetAlignment(int hAlign, int vAlign);
+
+ /**
+ Sets the background colour.
+ */
+ void SetBackgroundColour(const wxColour& colBack);
+
+ /**
+ @todo Needs documentation.
+ */
+ void SetDefAttr(wxGridCellAttr* defAttr);
+
+ /**
+ Sets the editor to be used with the cells with this attribute.
+ */
+ void SetEditor(wxGridCellEditor* editor);
+
+ /**
+ Sets the font.
+ */
+ void SetFont(const wxFont& font);
+
+ /**
+ Sets the cell as read-only.
+ */
+ void SetReadOnly(bool isReadOnly = true);
+
+ /**
+ Sets the renderer to be used for cells with this attribute. Takes
+ ownership of the pointer.
+ */
+ void SetRenderer(wxGridCellRenderer* renderer);
+
+ /**
+ Sets the text colour.
+ */
+ void SetTextColour(const wxColour& colText);
+};
+
+
+
+/**
+ @class wxGridTableBase
+
+ The almost abstract base class for grid tables.
+
+ A grid table is responsible for storing the grid data and, indirectly, grid
+ cell attributes. The data can be stored in the way most convenient for the
+ application but has to be provided in string form to wxGrid. It is also
+ possible to provide cells values in other formats if appropriate, e.g. as
+ numbers.
+
+ This base class is not quite abstract as it implements a trivial strategy
+ for storing the attributes by forwarding it to wxGridCellAttrProvider and
+ also provides stubs for some other functions. However it does have a number
+ of pure virtual methods which must be implemented in the derived classes.
+
+ @see wxGridStringTable
+
+ @library{wxadv}
+ @category{grid}
+*/
+class wxGridTableBase : public wxObject
+{
+public:
+ /**
+ Default constructor.
+ */
+ wxGridTableBase();
+
+ /**
+ Destructor frees the attribute provider if it was created.
+ */
+ virtual ~wxGridTableBase();
+
+ /**
+ Must be overridden to return the number of rows in the table.
+
+ For backwards compatibility reasons, this method is not const.
+ Use GetRowsCount() instead of it in const methods of derived table
+ classes.
+ */
+ virtual int GetNumberRows() = 0;
+
+ /**
+ Must be overridden to return the number of columns in the table.
+
+ For backwards compatibility reasons, this method is not const.
+ Use GetColsCount() instead of it in const methods of derived table
+ classes,
+ */
+ virtual int GetNumberCols() = 0;
+
+ /**
+ Return the number of rows in the table.
+
+ This method is not virtual and is only provided as a convenience for
+ the derived classes which can't call GetNumberRows() without a
+ @c const_cast from their const methods.
+ */
+ int GetRowsCount() const;
+
+ /**
+ Return the number of columns in the table.
+
+ This method is not virtual and is only provided as a convenience for
+ the derived classes which can't call GetNumberCols() without a
+ @c const_cast from their const methods.
+ */
+ int GetColsCount() const;
+
+
+ /**
+ @name Table Cell Accessors
+ */
+ //@{
+
+ /**
+ May be overridden to implement testing for empty cells.
+
+ This method is used by the grid to test if the given cell is not used
+ and so whether a neighbouring cell may overflow into it. By default it
+ only returns true if the value of the given cell, as returned by
+ GetValue(), is empty.
+ */
+ virtual bool IsEmptyCell(int row, int col);
+
+ /**
+ Same as IsEmptyCell() but taking wxGridCellCoords.
+
+ Notice that this method is not virtual, only IsEmptyCell() should be
+ overridden.
+ */
+ bool IsEmpty(const wxGridCellCoords& coords);
+
+ /**
+ Must be overridden to implement accessing the table values as text.
+ */
+ virtual wxString GetValue(int row, int col) = 0;
+
+ /**
+ Must be overridden to implement setting the table values as text.
+ */
+ virtual void SetValue(int row, int col, const wxString& value) = 0;
+
+ /**
+ Returns the type of the value in the given cell.
+
+ By default all cells are strings and this method returns
+ @c wxGRID_VALUE_STRING.
+ */
+ virtual wxString GetTypeName(int row, int col);
+
+ /**
+ Returns true if the value of the given cell can be accessed as if it
+ were of the specified type.
+
+ By default the cells can only be accessed as strings. Note that a cell
+ could be accessible in different ways, e.g. a numeric cell may return
+ @true for @c wxGRID_VALUE_NUMBER but also for @c wxGRID_VALUE_STRING
+ indicating that the value can be coerced to a string form.
+ */
+ virtual bool CanGetValueAs(int row, int col, const wxString& typeName);
+
+ /**
+ Returns true if the value of the given cell can be set as if it were of
+ the specified type.
+
+ @see CanGetValueAs()
+ */
+ virtual bool CanSetValueAs(int row, int col, const wxString& typeName);
+
+ /**
+ Returns the value of the given cell as a long.
+
+ This should only be called if CanGetValueAs() returns @true when called
+ with @c wxGRID_VALUE_NUMBER argument. Default implementation always
+ return 0.
+ */
+ virtual long GetValueAsLong(int row, int col);
+
+ /**
+ Returns the value of the given cell as a double.
+
+ This should only be called if CanGetValueAs() returns @true when called
+ with @c wxGRID_VALUE_FLOAT argument. Default implementation always
+ return 0.0.
+ */
+ virtual double GetValueAsDouble(int row, int col);
+
+ /**
+ Returns the value of the given cell as a boolean.
+
+ This should only be called if CanGetValueAs() returns @true when called
+ with @c wxGRID_VALUE_BOOL argument. Default implementation always
+ return false.
+ */
+ virtual bool GetValueAsBool(int row, int col);
+
+ /**
+ Returns the value of the given cell as a user-defined type.
+
+ This should only be called if CanGetValueAs() returns @true when called
+ with @a typeName. Default implementation always return @NULL.
+ */
+ virtual void *GetValueAsCustom(int row, int col, const wxString& typeName);
+
+ /**
+ Sets the value of the given cell as a long.
+
+ This should only be called if CanSetValueAs() returns @true when called
+ with @c wxGRID_VALUE_NUMBER argument. Default implementation doesn't do
+ anything.
+ */
+ virtual void SetValueAsLong(int row, int col, long value);
+
+ /**
+ Sets the value of the given cell as a double.
+
+ This should only be called if CanSetValueAs() returns @true when called
+ with @c wxGRID_VALUE_FLOAT argument. Default implementation doesn't do
+ anything.
+ */
+ virtual void SetValueAsDouble(int row, int col, double value);
+
+ /**
+ Sets the value of the given cell as a boolean.
+
+ This should only be called if CanSetValueAs() returns @true when called
+ with @c wxGRID_VALUE_BOOL argument. Default implementation doesn't do
+ anything.
+ */
+ virtual void SetValueAsBool( int row, int col, bool value );
+
+ /**
+ Sets the value of the given cell as a user-defined type.
+
+ This should only be called if CanSetValueAs() returns @true when called
+ with @a typeName. Default implementation doesn't do anything.
*/
virtual void SetValueAsCustom(int row, int col, const wxString& typeName,
void *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.
+ /**
+ Return the label of the specified row.
+ */
virtual wxString GetRowLabelValue(int row);
- /// Return the label of the specified column.
+ /**
+ Return the label of the specified column.
+ */
virtual wxString GetColLabelValue(int col);
/**
*/
virtual void SetRowLabelValue(int row, const wxString& label);
- /// Exactly the same as SetRowLabelValue() but for columns.
+ /**
+ Exactly the same as SetRowLabelValue() but for columns.
+ */
virtual void SetColLabelValue(int col, const wxString& label);
//@}
/**
- Attributes management.
+ @name Attributes Management
By default the attributes management is delegated to
wxGridCellAttrProvider class. You may override the methods in this
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();
+ wxGridCellAttrProvider *GetAttrProvider() const;
/**
Return the attribute for the given cell.
wxGridCellAttrProvider::SetColAttr().
The table takes ownership of @a attr, i.e. will call DecRef() on it.
- */
- 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);
+ */
+ virtual void SetColAttr(wxGridCellAttr *attr, int col);
- /**
- 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();
+ Returns true if this table supports attributes or false otherwise.
- /**
- 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);
+ 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 wxGridCellTextEditor
+ @class wxGrid
- The editor for string/text data.
+ 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.
- @library{wxadv}
- @category{grid}
+ 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().
- @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
- wxGridCellNumberEditor, wxGridCellChoiceEditor
-*/
-class wxGridCellTextEditor : public wxGridCellEditor
-{
-public:
- /**
- Default constructor.
- */
- wxGridCellTextEditor();
+ wxGridCellRenderer is the abstract base class for rendereing contents in a
+ cell. The following renderers are predefined:
- /**
- The parameters string format is "n" where n is a number representing the
- maximum width.
- */
- virtual void SetParameters(const wxString& params);
-};
+ - 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:
-/**
- @class wxGridCellStringRenderer
+ - wxGridCellBoolEditor
+ - wxGridCellChoiceEditor
+ - wxGridCellFloatEditor
+ - wxGridCellNumberEditor
+ - wxGridCellTextEditor
- This class may be used to format string data in a cell; it is the default
- for string cells.
+ Please see wxGridEvent, wxGridSizeEvent, wxGridRangeSelectEvent, and
+ wxGridEditorCreatedEvent for the documentation of all event types you can
+ use with wxGrid.
@library{wxadv}
@category{grid}
- @see wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer,
- wxGridCellBoolRenderer
+ @see @ref overview_grid, wxGridUpdateLocker
*/
-class wxGridCellStringRenderer : public wxGridCellRenderer
+class wxGrid : public wxScrolledWindow
{
public:
+
/**
- Default constructor
- */
- wxGridCellStringRenderer();
-};
+ 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,
+ /**
+ The selection mode allowing the selection of the entire rows only.
+ The user won't be able to select any cells or columns in this mode.
+ */
+ wxGridSelectRows,
-/**
- @class wxGridCellChoiceEditor
+ /**
+ The selection mode allowing the selection of the entire columns only.
- The editor for string data allowing to choose from a list of strings.
+ The user won't be able to select any cells or rows in this mode.
+ */
+ wxGridSelectColumns
+ };
- @library{wxadv}
- @category{grid}
- @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor,
- wxGridCellTextEditor, wxGridCellNumberEditor
-*/
-class wxGridCellChoiceEditor : public wxGridCellEditor
-{
-public:
+ /**
+ @name Constructors and Initialization
+ */
//@{
+
/**
- @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);
- //@}
+ Default constructor.
+ You must call Create() to really create the grid window and also call
+ CreateGrid() or SetTable() to initialize the grid contents.
+ */
+ wxGrid();
/**
- Parameters string format is "item1[,item2[...,itemN]]"
+ Constructor creating the grid window.
+
+ You must call either CreateGrid() or SetTable() to initialize the grid
+ contents before using it.
*/
- virtual void SetParameters(const wxString& params);
-};
+ wxGrid(wxWindow* parent, wxWindowID id,
+ const wxPoint& pos = wxDefaultPosition,
+ const wxSize& size = wxDefaultSize,
+ long style = wxWANTS_CHARS,
+ const wxString& name = wxGridNameStr);
+ /**
+ 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()).
+ */
+ virtual ~wxGrid();
-/**
- @class wxGridEditorCreatedEvent
+ /**
+ 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);
- @library{wxadv}
- @category{grid}
-*/
-class wxGridEditorCreatedEvent : public wxCommandEvent
-{
-public:
- //@{
/**
+ Creates a grid with the specified initial number of rows and columns.
- */
- wxGridEditorCreatedEvent();
- wxGridEditorCreatedEvent(int id, wxEventType type,
- wxObject* obj,
- int row,
- int col,
- wxControl* ctrl);
- //@}
+ 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.
- /**
- Returns the column at which the event occurred.
+ 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().
*/
- int GetCol();
+ bool CreateGrid(int numRows, int numCols,
+ wxGridSelectionModes selmode = wxGridSelectCells);
/**
- Returns the edit control.
- */
- wxControl* GetControl();
+ Passes a pointer to a custom grid table to be used by the grid.
- /**
- Returns the row at which the event occurred.
+ 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.
*/
- int GetRow();
+ bool SetTable(wxGridTableBase* table, bool takeOwnership = false,
+ wxGridSelectionModes selmode = wxGridSelectCells);
+
+ //@}
+
/**
- Sets the column at which the event occurred.
- */
- void SetCol(int col);
+ @name Grid Line Formatting
+ */
+ //@{
/**
- Sets the edit control.
+ Turns the drawing of grid lines on or off.
*/
- void SetControl(wxControl* ctrl);
+ void EnableGridLines(bool enable = true);
/**
- Sets the row at which the event occurred.
- */
- void SetRow(int row);
-};
+ 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);
+ /**
+ Returns the pen used for grid lines.
-/**
- @class wxGridRangeSelectEvent
+ 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.
+ @see GetColGridLinePen(), GetRowGridLinePen()
+ */
+ virtual wxPen GetDefaultGridLinePen();
- @library{wxadv}
- @category{grid}
-*/
-class wxGridRangeSelectEvent : public wxNotifyEvent
-{
-public:
- //@{
/**
+ Returns the colour used for grid lines.
+ @see GetDefaultGridLinePen()
*/
- 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);
- //@}
+ wxColour GetGridLineColour() const;
/**
- Returns @true if the Alt key was down at the time of the event.
+ 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
*/
- bool AltDown() const;
+ virtual wxPen GetRowGridLinePen(int row);
/**
- Returns @true if the Control key was down at the time of the event.
+ Returns @true if drawing of grid lines is turned on, @false otherwise.
*/
- bool ControlDown() const;
+ bool GridLinesEnabled() const;
/**
- Top left corner of the rectangular area that was (de)selected.
+ Sets the colour used to draw grid lines.
*/
- wxGridCellCoords GetBottomRightCoords();
+ void SetGridLineColour(const wxColour& colour);
+
+ //@}
+
/**
- Bottom row of the rectangular area that was (de)selected.
- */
- int GetBottomRow();
+ @name Label Values and Formatting
+ */
+ //@{
/**
- Left column of the rectangular area that was (de)selected.
+ 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.
+
+ Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
+ @c wxALIGN_BOTTOM.
*/
- int GetLeftCol();
+ void GetColLabelAlignment(int* horiz, int* vert) const;
/**
- Right column of the rectangular area that was (de)selected.
+ Returns the orientation of the column labels (either @c wxHORIZONTAL or
+ @c wxVERTICAL).
*/
- int GetRightCol();
+ int GetColLabelTextOrientation() const;
/**
- Top left corner of the rectangular area that was (de)selected.
- */
- wxGridCellCoords GetTopLeftCoords();
+ Returns the specified column label.
- /**
- Top row of the rectangular area that was (de)selected.
+ 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 GetTopRow();
+ 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 area was selected, @false otherwise.
+ Returns the font used for row and column labels.
*/
- bool Selecting();
+ wxFont GetLabelFont() const;
/**
- Returns @true if the Shift key was down at the time of the event.
+ Returns the colour used for row and column label text.
*/
- bool ShiftDown() const;
-};
-
-
+ wxColour GetLabelTextColour() const;
-/**
- @class wxGridCellRenderer
+ /**
+ Returns the alignment used for row labels.
- 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.
+ Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
+ or @c wxALIGN_RIGHT.
- @library{wxadv}
- @category{grid}
+ Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
+ @c wxALIGN_BOTTOM.
+ */
+ void GetRowLabelAlignment(int* horiz, int* vert) const;
- @see wxGridCellStringRenderer, wxGridCellNumberRenderer,
- wxGridCellFloatRenderer, wxGridCellBoolRenderer
-*/
-class wxGridCellRenderer
-{
-public:
/**
+ 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.
*/
- virtual wxGridCellRenderer* Clone() const = 0;
+ wxString GetRowLabelValue(int row) const;
/**
- 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.
+ 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.
*/
- virtual void Draw(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
- const wxRect& rect, int row, int col,
- bool isSelected) = 0;
+ void HideColLabels();
/**
- Get the preferred size of the cell for its contents.
+ 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.
*/
- wxSize GetBestSize(wxGrid& grid, wxGridCellAttr& attr, wxDC& dc,
- int row, int col);
-};
+ void HideRowLabels();
+ /**
+ 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 SetColLabelAlignment(int horiz, int vert);
-/**
- @class wxGridCellNumberEditor
+ /**
+ Sets the orientation of the column labels (either @c wxHORIZONTAL or
+ @c wxVERTICAL).
+ */
+ void SetColLabelTextOrientation(int textOrientation);
- The editor for numeric integer data.
+ /**
+ Set the value for the given column label.
- @library{wxadv}
- @category{grid}
+ If you are using a custom grid table you must override
+ wxGridTableBase::SetColLabelValue() for this to have any effect.
+ */
+ void SetColLabelValue(int col, const wxString& value);
- @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
+ Sets the background colour for row and column labels.
*/
- wxGridCellNumberEditor(int min = -1, int max = -1);
+ void SetLabelBackgroundColour(const wxColour& colour);
/**
- String representation of the value.
+ Sets the font for row and column labels.
*/
- wxString GetString() const;
+ void SetLabelFont(const wxFont& font);
/**
- If the return value is @true, the editor uses a wxSpinCtrl to get user input,
- otherwise it uses a wxTextCtrl.
+ Sets the colour for row and column label text.
*/
- bool HasRange() const;
+ void SetLabelTextColour(const wxColour& colour);
/**
- Parameters string format is "min,max".
+ 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.
*/
- virtual void SetParameters(const wxString& params);
-};
+ 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.
+ */
+ void SetRowLabelValue(int row, const wxString& value);
-/**
- @class wxGridSizeEvent
+ /**
+ Call this in order to make the column labels use a native look by using
+ wxRenderer::DrawHeaderButton() internally.
- This event class contains information about a row/column resize event.
+ 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.
+
+ @see UseNativeHeader()
+ */
+ void SetUseNativeColLabels(bool native = true);
- @library{wxadv}
- @category{grid}
-*/
-class wxGridSizeEvent : public wxNotifyEvent
-{
-public:
- //@{
/**
+ Enable the use of native header window for column labels.
+
+ If this function is called with @true argument, a wxHeaderCtrl is used
+ instead to display the column labels instead of drawing them in wxGrid
+ code itself. This has the advantage of making the grid look and feel
+ perfectly the same as native applications (using SetUseNativeColLabels()
+ the grid can be made to look more natively but it still doesn't feel
+ natively, notably the column resizing and dragging still works slightly
+ differently as it is implemented in wxWidgets itself) but results in
+ different behaviour for column and row headers, for which there is no
+ equivalent function, and, most importantly, is unsuitable for grids
+ with huge numbers of columns as wxHeaderCtrl doesn't support virtual
+ mode. Because of this, by default the grid does not use the native
+ header control but you should call this function to enable it if you
+ are using the grid to display tabular data and don't have thousands of
+ columns in it.
+
+ Also note that currently @c wxEVT_GRID_LABEL_LEFT_DCLICK and @c
+ wxEVT_GRID_LABEL_RIGHT_DCLICK events are not generated for the column
+ labels if the native columns header is used (but this limitation could
+ possibly be lifted in the future).
+ */
+ void UseNativeColHeader(bool native = true);
- */
- 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);
//@}
+
/**
- Returns @true if the Alt key was down at the time of the event.
- */
- bool AltDown() const;
+ @name Cell Formatting
+
+ Note that wxGridCellAttr can be used alternatively to most of these
+ methods. See the "Attributes Management" of wxGridTableBase.
+ */
+ //@{
/**
- Returns @true if the Control key was down at the time of the event.
+ Sets the arguments to the horizontal and vertical text alignment values
+ for the grid cell at the specified location.
+
+ 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.
*/
- bool ControlDown() const;
+ void GetCellAlignment(int row, int col, int* horiz, int* vert) const;
/**
- Position in pixels at which the event occurred.
+ Returns the background colour of the cell at the specified location.
*/
- wxPoint GetPosition();
+ wxColour GetCellBackgroundColour(int row, int col) const;
/**
- Row or column at that was resized.
+ Returns the font for text in the grid cell at the specified location.
*/
- int GetRowOrCol();
+ wxFont GetCellFont(int row, int col) const;
/**
- Returns @true if the Meta key was down at the time of the event.
+ Returns the text colour for the grid cell at the specified location.
*/
- bool MetaDown() const;
+ wxColour GetCellTextColour(int row, int col) const;
/**
- Returns @true if the Shift key was down at the time of the event.
- */
- bool ShiftDown() const;
-};
+ Returns the default cell alignment.
+ 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.
-/**
- @class wxGridCellNumberRenderer
+ @see SetDefaultCellAlignment()
+ */
+ void GetDefaultCellAlignment(int* horiz, int* vert) const;
- This class may be used to format integer data in a cell.
+ /**
+ Returns the current default background colour for grid cells.
+ */
+ wxColour GetDefaultCellBackgroundColour() const;
- @library{wxadv}
- @category{grid}
+ /**
+ Returns the current default font for grid cell text.
+ */
+ wxFont GetDefaultCellFont() const;
- @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer,
- wxGridCellBoolRenderer
-*/
-class wxGridCellNumberRenderer : public wxGridCellStringRenderer
-{
-public:
/**
- Default constructor
+ Returns the current default colour for grid cell text.
*/
- wxGridCellNumberRenderer();
-};
+ wxColour GetDefaultCellTextColour() const;
+ /**
+ 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.
-/**
- @class wxGridCellAttr
+ Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
+ or @c wxALIGN_BOTTOM.
+ */
+ void SetCellAlignment(int row, int col, int horiz, int vert);
+ /**
+ Sets the horizontal and vertical alignment for grid cell text at the
+ specified location.
- 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.
+ Horizontal alignment should be one of @c wxALIGN_LEFT,
+ @c wxALIGN_CENTRE or @c wxALIGN_RIGHT.
- @library{wxadv}
- @category{grid}
-*/
-class wxGridCellAttr
-{
-public:
- //@{
- /**
- Constructor specifying some of the often used attributes.
+ Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
+ or @c wxALIGN_BOTTOM.
*/
- wxGridCellAttr();
- wxGridCellAttr(const wxColour& colText,
- const wxColour& colBack,
- const wxFont& font,
- int hAlign, int vAlign);
- //@}
+ void SetCellAlignment(int align, int row, int col);
/**
- Creates a new copy of this object.
+ Set the background colour for the given cell or all cells by default.
*/
- wxGridCellAttr* Clone() const;
+ void SetCellBackgroundColour(int row, int col, const wxColour& colour);
/**
-
+ Sets the font for text in the grid cell at the specified location.
*/
- void DecRef();
+ void SetCellFont(int row, int col, const wxFont& font);
/**
- See SetAlignment() for the returned values.
+ Sets the text colour for the given cell.
*/
- void GetAlignment(int* hAlign, int* vAlign) const;
-
+ void SetCellTextColour(int row, int col, const wxColour& colour);
/**
-
+ Sets the text colour for the given cell.
*/
- const wxColour GetBackgroundColour() const;
-
+ void SetCellTextColour(const wxColour& val, int row, int col);
/**
-
+ Sets the text colour for all cells by default.
*/
- wxGridCellEditor* GetEditor(wxGrid* grid, int row, int col) const;
+ void SetCellTextColour(const wxColour& colour);
/**
+ 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.
*/
- const wxFont GetFont() const;
+ void SetDefaultCellAlignment(int horiz, int vert);
/**
-
+ Sets the default background colour for grid cells.
*/
- wxGridCellRenderer* GetRenderer(wxGrid* grid, int row, int col) const;
+ void SetDefaultCellBackgroundColour(const wxColour& colour);
/**
-
+ Sets the default font to be used for grid cell text.
*/
- const wxColour GetTextColour() const;
+ void SetDefaultCellFont(const wxFont& font);
/**
-
+ Sets the current default colour for grid cell text.
*/
- bool HasAlignment() const;
+ void SetDefaultCellTextColour(const wxColour& colour);
+
+ //@}
+
/**
+ @name Cell Values, Editors, and Renderers
- */
- bool HasBackgroundColour() const;
+ Note that wxGridCellAttr can be used alternatively to most of these
+ methods. See the "Attributes Management" of wxGridTableBase.
+ */
+ //@{
/**
+ Returns @true if the in-place edit control for the current grid cell
+ can be used and @false otherwise.
+ This function always returns @false for the read-only cells.
*/
- bool HasEditor() const;
+ bool CanEnableCellControl() const;
/**
+ Disables in-place editing of grid cells.
+ Equivalent to calling EnableCellEditControl(@false).
*/
- bool HasFont() const;
+ void DisableCellEditControl();
/**
+ Enables or disables in-place editing of grid cell data.
+ The grid will issue either a @c wxEVT_GRID_EDITOR_SHOWN or
+ @c wxEVT_GRID_EDITOR_HIDDEN event.
*/
- bool HasRenderer() const;
+ void EnableCellEditControl(bool enable = true);
/**
- accessors
- */
- bool HasTextColour() const;
+ Makes the grid globally editable or read-only.
- /**
- 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
+ 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().
+
+ For more information about controlling grid cell attributes see the
+ wxGridCellAttr class and the @ref overview_grid.
*/
- void IncRef();
+ void EnableEditing(bool edit);
/**
+ Returns a pointer to the editor for the cell at the specified location.
- */
- bool IsReadOnly() const;
+ See wxGridCellEditor and the @ref overview_grid for more information
+ about cell editors and renderers.
- /**
- 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.
+ The caller must call DecRef() on the returned pointer.
*/
- void SetAlignment(int hAlign, int vAlign);
+ wxGridCellEditor* GetCellEditor(int row, int col) const;
/**
- Sets the background colour.
- */
- void SetBackgroundColour(const wxColour& colBack);
+ Returns a pointer to the renderer for the grid cell at the specified
+ location.
- /**
+ 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 SetDefAttr(wxGridCellAttr* defAttr);
+ wxGridCellRenderer* GetCellRenderer(int row, int col) const;
/**
+ Returns the string contained in the cell at the specified location.
- */
- void SetEditor(wxGridCellEditor* editor);
+ 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.
- /**
- Sets the font.
+ See wxGridTableBase::CanGetValueAs() and the @ref overview_grid for
+ more information.
*/
- void SetFont(const wxFont& font);
-
+ wxString GetCellValue(int row, int col) const;
/**
+ Returns the string contained in the cell at the specified location.
+
+ 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.
*/
- void SetReadOnly(bool isReadOnly = true);
+ wxString GetCellValue(const wxGridCellCoords& coords) const;
/**
- takes ownership of the pointer
+ Returns a pointer to the current default grid cell editor.
+
+ See wxGridCellEditor and the @ref overview_grid for more information
+ about cell editors and renderers.
*/
- void SetRenderer(wxGridCellRenderer* renderer);
+ wxGridCellEditor* GetDefaultEditor() const;
/**
- Sets the text colour.
- */
- void SetTextColour(const wxColour& colText);
-};
+ 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 achieved in a usually simpler way by
+ associating a custom editor with the given cell or cells.
-/**
- @class wxGridCellBoolRenderer
+ The caller must call DecRef() on the returned pointer.
+ */
+ virtual wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
+ /**
+ Returns the default editor for the specified cell.
- This class may be used to format boolean data in a cell.
- for string cells.
+ 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.
- @library{wxadv}
- @category{grid}
+ Notice that the same may be achieved in a usually simpler way by
+ associating a custom editor with the given cell or cells.
- @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer,
- wxGridCellNumberRenderer
-*/
-class wxGridCellBoolRenderer : public wxGridCellRenderer
-{
-public:
- /**
- Default constructor
+ The caller must call DecRef() on the returned pointer.
*/
- wxGridCellBoolRenderer();
-};
-
+ wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const;
+ /**
+ Returns the default editor for the cells containing values of the given
+ type.
-/**
- @class wxGridEvent
+ 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.
- This event class contains information about various grid events.
+ The caller must call DecRef() on the returned pointer.
+ */
+ virtual wxGridCellEditor* GetDefaultEditorForType(const wxString& typeName) const;
- @library{wxadv}
- @category{grid}
-*/
-class wxGridEvent : public wxNotifyEvent
-{
-public:
- //@{
/**
+ Returns a pointer to the current default grid cell renderer.
- */
- 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);
- //@}
+ See wxGridCellRenderer and the @ref overview_grid for more information
+ about cell editors and renderers.
- /**
- Returns @true if the Alt key was down at the time of the event.
+ The caller must call DecRef() on the returned pointer.
*/
- bool AltDown() const;
+ wxGridCellRenderer* GetDefaultRenderer() const;
/**
- Returns @true if the Control key was down at the time of the event.
+ 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.
*/
- bool ControlDown() const;
+ virtual wxGridCellRenderer* GetDefaultRendererForCell(int row, int col) const;
/**
- Column at which the event occurred.
+ Returns the default renderer for the cell containing values of the
+ given type.
+
+ @see GetDefaultEditorForType()
*/
- virtual int GetCol();
+ virtual wxGridCellRenderer* GetDefaultRendererForType(const wxString& typeName) const;
/**
- Position in pixels at which the event occurred.
+ Hides the in-place cell edit control.
*/
- wxPoint GetPosition();
+ void HideCellEditControl();
/**
- Row at which the event occurred.
+ Returns @true if the in-place edit control is currently enabled.
*/
- virtual int GetRow();
+ bool IsCellEditControlEnabled() const;
/**
- Returns @true if the Meta key was down at the time of the event.
+ Returns @true if the current cell is read-only.
+
+ @see SetReadOnly(), IsReadOnly()
*/
- bool MetaDown() const;
+ bool IsCurrentCellReadOnly() const;
/**
- Returns @true if the user is selecting grid cells, @false -- if
- deselecting.
+ Returns @false if the whole grid has been set as read-only or @true
+ otherwise.
+
+ See EnableEditing() for more information about controlling the editing
+ status of grid cells.
*/
- bool Selecting();
+ bool IsEditable() const;
/**
- Returns @true if the Shift key was down at the time of the event.
- */
- bool ShiftDown() const;
-};
+ Returns @true if the cell at the specified location can't be edited.
+ @see SetReadOnly(), IsCurrentCellReadOnly()
+ */
+ bool IsReadOnly(int row, int col) const;
+ /**
+ Register a new data type.
-/**
- @class wxGridCellFloatEditor
+ 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.
- The editor for floating point numbers data.
+ 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.
- @library{wxadv}
- @category{grid}
+ 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.
- @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.
+ @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.
*/
- wxGridCellFloatEditor(int width = -1, int precision = -1);
+ void RegisterDataType(const wxString& typeName,
+ wxGridCellRenderer* renderer,
+ wxGridCellEditor* editor);
/**
- Parameters string format is "width,precision"
- */
- virtual void SetParameters(const wxString& params);
-};
-
+ Sets the value of the current grid cell to the current in-place edit
+ control value.
+ 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();
-/**
- @class wxGrid
+ /**
+ Sets the editor for the grid cell at the specified location.
- 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.
+ The grid will take ownership of the pointer.
- 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.
+ See wxGridCellEditor and the @ref overview_grid for more information
+ about cell editors and renderers.
+ */
+ void SetCellEditor(int row, int col, wxGridCellEditor* editor);
- 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.
+ /**
+ Sets the renderer for the grid cell at the specified location.
- 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.
+ The grid will take ownership of the pointer.
- wxGridCellEditor is the abstract base class for editing the value of a
- cell. The following editors are predefined:
- - wxGridCellTextEditor
- - wxGridCellBoolEditor
- - wxGridCellChoiceEditor
- - wxGridCellNumberEditor.
+ See wxGridCellRenderer and the @ref overview_grid for more information
+ about cell editors and renderers.
+ */
+ void SetCellRenderer(int row, int col, wxGridCellRenderer* renderer);
- @library{wxadv}
- @category{grid}
+ /**
+ Sets the string value for the cell at the specified location.
- @see @ref overview_grid "wxGrid overview"
-*/
-class wxGrid : public wxScrolledWindow
-{
-public:
+ 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(int row, int col, const wxString& s);
/**
- 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,
+ Sets the string value for the cell at the specified location.
- /**
- The selection mode allowing the selection of the entire rows only.
+ 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 user won't be able to select any cells or columns in this mode.
- */
- wxGridSelectRows,
+ See wxGridTableBase::CanSetValueAs() and the @ref overview_grid for
+ more information.
+ */
+ void SetCellValue(const wxGridCellCoords& coords, const wxString& s);
+ /**
+ @deprecated Please use SetCellValue(int,int,const wxString&) or
+ SetCellValue(const wxGridCellCoords&,const wxString&)
+ instead.
- /**
- The selection mode allowing the selection of the entire columns only.
+ Sets the string value for the cell at the specified location.
- The user won't be able to select any cells or rows in this mode.
- */
- wxGridSelectColumns
- };
+ 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 wxString& val, int row, int col);
/**
- Default constructor.
+ Sets the specified column to display boolean values.
- You must call Create() to really create the grid window and also call
- CreateGrid() or SetTable() to initialize the grid contents.
- */
- wxGrid();
+ @see SetColFormatCustom()
+ */
+ void SetColFormatBool(int col);
/**
- Constructor creating the grid window.
+ Sets the specified column to display data in a custom format.
- You must call either CreateGrid() or SetTable() to initialize the grid
- contents before using it.
+ 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.
+
+ See the @ref overview_grid for more information on working with custom
+ data types.
*/
- wxGrid(wxWindow* parent,
- wxWindowID id,
- const wxPoint& pos = wxDefaultPosition,
- const wxSize& size = wxDefaultSize,
- long style = wxWANTS_CHARS,
- const wxString& name = wxGridNameStr);
+ void SetColFormatCustom(int col, const wxString& typeName);
/**
- Creates the grid window for an object initialized using the default
- constructor.
+ Sets the specified column to display floating point values with the
+ given width and precision.
- 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 SetColFormatCustom()
+ */
+ void SetColFormatFloat(int col, int width = -1, int precision = -1);
/**
- Destructor.
+ Sets the specified column to display integer values.
- 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).
+ @see SetColFormatCustom()
*/
- virtual ~wxGrid();
+ void SetColFormatNumber(int col);
/**
- Appends one or more new columns to the right of the grid.
+ Sets the default editor for grid cells.
- 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.
+ The grid will take ownership of the pointer.
- @return @true on success or @false if appending columns failed.
+ See wxGridCellEditor and the @ref overview_grid for more information
+ about cell editors and renderers.
*/
- bool AppendCols(int numCols = 1, bool updateLabels = true);
+ void SetDefaultEditor(wxGridCellEditor* editor);
/**
- Appends one or more new rows to the bottom of the grid.
+ Sets the default renderer for grid cells.
- 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.
+ The grid will take ownership of the pointer.
- @return @true on success or @false if appending rows failed.
+ See wxGridCellRenderer and the @ref overview_grid for more information
+ about cell editors and renderers.
*/
- bool AppendRows(int numRows = 1, bool updateLabels = true);
+ void SetDefaultRenderer(wxGridCellRenderer* renderer);
/**
- Return @true if the horizontal grid lines stop at the last column
- boundary or @false if they continue to the end of the window.
-
- The default is to clip grid lines.
+ Makes the cell at the specified location read-only or editable.
- @see ClipHorzGridLines(), AreVertGridLinesClipped()
- */
- bool AreHorzGridLinesClipped() const;
+ @see IsReadOnly()
+ */
+ void SetReadOnly(int row, int col, bool isReadOnly = true);
/**
- Return @true if the vertical grid lines stop at the last row
- boundary or @false if they continue to the end of the window.
+ Displays the in-place cell edit control for the current cell.
+ */
+ void ShowCellEditControl();
- The default is to clip grid lines.
+ //@}
- @see ClipVertGridLines(), AreHorzGridLinesClipped()
+
+ /**
+ @name Column and Row Sizes
*/
- bool AreVertGridLinesClipped() const;
+ //@{
/**
- Automatically sets the height and width of all rows and columns to fit their
- contents.
+ Automatically sets the height and width of all rows and columns to fit
+ their contents.
*/
void AutoSize();
void AutoSizeColLabelSize(int col);
/**
- 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.
+ 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 AutoSizeColumn(int col, bool setAsMin = true);
/**
- 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.
+ 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 AutoSizeColumns(bool setAsMin = true);
/**
- 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.
+ 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 AutoSizeRow(int row, bool setAsMin = true);
void AutoSizeRowLabelSize(int col);
/**
- 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.
+ 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 AutoSizeRows(bool setAsMin = true);
/**
- Increments the grid's batch count.
+ Returns the current height of the column labels.
+ */
+ int GetColLabelSize() const;
- 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 the minimal width to which a column may be resized.
- 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.
+ Use SetColMinimalAcceptableWidth() to change this value globally or
+ SetColMinimalWidth() to do it for individual columns.
+
+ @see GetRowMinimalAcceptableHeight()
*/
- void BeginBatch();
+ int GetColMinimalAcceptableWidth() const;
/**
- Convert grid cell coordinates to grid window pixel coordinates.
+ Returns the width of the specified column.
+ */
+ int GetColSize(int col) const;
- 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 @true if the specified column is not currently hidden.
+ */
+ bool IsColShown(int col) const;
- @see CellToRect()
+ /**
+ Returns the default height for column labels.
*/
- wxRect BlockToDeviceRect(const wxGridCellCoords& topLeft,
- const wxGridCellCoords& bottomRight) const;
+ int GetDefaultColLabelSize() const;
/**
- Returns @true if columns can be moved by dragging with the mouse.
+ Returns the current default width for grid columns.
+ */
+ int GetDefaultColSize() const;
- Columns can be moved by dragging on their labels.
+ /**
+ Returns the default width for the row labels.
*/
- bool CanDragColMove() const;
+ int GetDefaultRowLabelSize() const;
/**
- Returns @true if columns can be resized by dragging with the mouse.
+ Returns the current default height for grid rows.
+ */
+ int GetDefaultRowSize() const;
- 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).
+ /**
+ 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()
*/
- bool CanDragColSize() const;
+ int GetRowMinimalAcceptableHeight() const;
+
+ /**
+ Returns the current width of the row labels.
+ */
+ int GetRowLabelSize() const;
+
+ /**
+ Returns the height of the specified row.
+ */
+ int GetRowSize(int row) const;
+
+ /**
+ Returns @true if the specified row is not currently hidden.
+ */
+ bool IsRowShown(int row) 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.
+ */
+ void SetColLabelSize(int height);
+
+ /**
+ Sets the minimal @a width to which the user can resize columns.
+
+ @see GetColMinimalAcceptableWidth()
+ */
+ void SetColMinimalAcceptableWidth(int width);
+
+ /**
+ Sets the minimal @a width for the specified column @a col.
+
+ 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 width of the specified column.
+
+ @param col
+ The column index.
+ @param width
+ The new column width in pixels, 0 to hide the column or -1 to fit
+ the column width to its label width.
+ */
+ void SetColSize(int col, int width);
+
+ /**
+ Hides the specified column.
+
+ To show the column later you need to call SetColSize() with non-0
+ width or ShowCol().
+
+ @param col
+ The column index.
+ */
+ void HideCol(int col);
/**
- Return @true if the dragging of grid lines to resize rows and columns
- is enabled or @false otherwise.
- */
- bool CanDragGridSize() const;
+ Shows the previously hidden column by resizing it to non-0 size.
+
+ @see HideCol(), SetColSize()
+ */
+ void ShowCol(int col);
+
/**
- Returns @true if rows can be resized by dragging with the mouse.
+ Sets the default width for columns in the grid.
- 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).
+ 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.
*/
- bool CanDragRowSize() const;
+ void SetDefaultColSize(int width, bool resizeExistingCols = false);
/**
- Returns @true if the in-place edit control for the current grid cell
- can be used and @false otherwise.
+ Sets the default height for rows in the grid.
- This function always returns @false for the read-only cells.
+ 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.
*/
- bool CanEnableCellControl() const;
+ void SetDefaultRowSize(int height, bool resizeExistingRows = false);
/**
- Returns @true if this grid has support for cell attributes.
+ Sets the width of the row labels.
- The grid supports attributes if it has the associated table which, in
- turn, has attributes support, i.e. wxGridTableBase::CanHaveAttributes()
- returns @true.
+ 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.
*/
- bool CanHaveAttributes() const;
+ void SetRowLabelSize(int width);
- //@{
/**
- Return the rectangle corresponding to the grid cell's size and position
- in logical coordinates.
+ Sets the minimal row @a height used by default.
- @see BlockToDeviceRect()
+ See SetColMinimalAcceptableWidth() for more information.
*/
- wxRect CellToRect(int row, int col) const;
- const wxRect CellToRect(const wxGridCellCoords& coords) const;
-
- //@}
+ void SetRowMinimalAcceptableHeight(int height);
/**
- Clears all data in the underlying grid table and repaints the grid.
+ Sets the minimal @a height for the specified @a row.
- 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.
+ See SetColMinimalWidth() for more information.
*/
- void ClearGrid();
+ void SetRowMinimalHeight(int row, int height);
/**
- Deselects all cells that are currently selected.
+ Sets the height of the specified row.
+
+ See SetColSize() for more information.
*/
- void ClearSelection();
+ void SetRowSize(int row, int height);
/**
- Change whether the horizontal grid lines are clipped by the end of the
- last column.
+ Hides the specified row.
- 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.
+ To show the row later you need to call SetRowSize() with non-0
+ width or ShowRow().
- @see AreHorzGridLinesClipped(), ClipVertGridLines()
+ @param col
+ The row index.
*/
- void ClipHorzGridLines(bool clip);
+ void HideRow(int col);
/**
- Change whether the vertical grid lines are clipped by the end of the
- last row.
+ Shows the previously hidden row by resizing it to non-0 size.
- 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.
-
- @see AreVertzGridLinesClipped(), ClipHorzGridLines()
+ @see HideRow(), SetRowSize()
*/
- void ClipVertzGridLines(bool clip);
+ void ShowRow(int col);
+
+ //@}
+
/**
- Creates a grid with the specified initial number of rows and columns.
+ @name User-Resizing and Dragging
+ */
+ //@{
- 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().
+ /**
+ Return @true if the dragging of cells is enabled or @false otherwise.
*/
- bool CreateGrid(int numRows, int numCols,
- wxGridSelectionModes selmode = wxGridSelectCells);
+ bool CanDragCell() const;
/**
- 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.
+ Returns @true if columns can be moved by dragging with the mouse.
- @return @true on success or @false if deleting columns failed.
+ Columns can be moved by dragging on their labels.
*/
- bool DeleteCols(int pos = 0, int numCols = 1, bool updateLabels = true);
+ bool CanDragColMove() const;
/**
- Deletes one or more rows from a grid starting at the specified position.
+ Returns @true if columns can be resized by dragging with the mouse.
- 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.
+ 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()).
+ */
+ bool CanDragColSize() const;
- @return @true on success or @false if appending rows failed.
+ /**
+ Return @true if the dragging of grid lines to resize rows and columns
+ is enabled or @false otherwise.
*/
- bool DeleteRows(int pos = 0, int numRows = 1, bool updateLabels = true);
+ bool CanDragGridSize() const;
/**
- Disables in-place editing of grid cells.
+ Returns @true if rows can be resized by dragging with the mouse.
- Equivalent to calling EnableCellEditControl(@false).
+ 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()).
*/
- void DisableCellEditControl();
+ bool CanDragRowSize() const;
/**
Disables column moving by dragging with the mouse.
void DisableDragRowSize();
/**
- Enables or disables in-place editing of grid cell data.
-
- The grid will issue either a wxEVT_GRID_EDITOR_SHOWN or
- wxEVT_GRID_EDITOR_HIDDEN event.
+ Enables or disables cell dragging with the mouse.
*/
- void EnableCellEditControl(bool enable = true);
+ void EnableDragCell(bool enable = true);
/**
Enables or disables column moving by dragging with the mouse.
void EnableDragColSize(bool enable = true);
/**
- Enables or disables row and column resizing by dragging gridlines with the
- mouse.
+ Enables or disables row and column resizing by dragging gridlines with
+ the mouse.
*/
void EnableDragGridSize(bool enable = true);
void EnableDragRowSize(bool enable = true);
/**
- 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".
- */
- void EnableEditing(bool edit);
-
- /**
- Turns the drawing of grid lines on or off.
- */
- void EnableGridLines(bool enable = 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
- */
- void EndBatch();
-
- /**
- Overridden wxWindow method.
- */
- void Fit();
-
- /**
- Causes immediate repainting of the grid.
-
- Use this instead of the usual wxWindow::Refresh.
- */
- void ForceRefresh();
-
- /**
- 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 column ID of the specified column position.
*/
- int GetBatchCount();
+ int GetColAt(int colPos) const;
/**
- Sets the arguments to the horizontal and vertical text alignment values
- for the grid cell at the specified location.
-
- 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.
+ Returns the position of the specified column.
*/
- void GetCellAlignment(int row, int col, int* horiz, int* vert) const;
+ int GetColPos(int colID) const;
/**
- Returns the background colour of the cell at the specified location.
+ Sets the position of the specified column.
*/
- wxColour GetCellBackgroundColour(int row, int col) const;
+ void SetColPos(int colID, int newPos);
/**
- 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.
+ Sets the positions of all columns at once.
- The caller must call DecRef() on the returned pointer.
+ This method takes an array containing the indices of the columns in
+ their display order, i.e. uses the same convention as
+ wxHeaderCtrl::SetColumnsOrder().
*/
- wxGridCellEditor* GetCellEditor(int row, int col) const;
+ void SetColumnsOrder(const wxArrayInt& order);
/**
- Returns the font for text in the grid cell at the specified location.
+ Resets the position of the columns to the default.
*/
- wxFont GetCellFont(int row, int col) const;
-
- /**
- Returns a pointer to the renderer for the grid cell at the specified
- location.
+ void ResetColPos();
- 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.
- */
- wxGridCellRenderer* GetCellRenderer(int row, int col) const;
/**
- Returns the text colour for the grid cell at the specified location.
+ @name Cursor Movement
*/
- wxColour GetCellTextColour(int row, int col) const;
-
//@{
- /**
- Returns the string contained in the cell at the specified location.
-
- 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 "wxGrid overview"
- for more information.
- */
- wxString GetCellValue(int row, int col) const;
- const wxString GetCellValue(const wxGridCellCoords& coords) const;
- //@}
-
- /**
- Returns the column ID of the specified column position.
- */
- int GetColAt(int colPos) 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 current grid cell column position.
*/
- virtual wxPen GetColGridLinePen(int col);
+ int GetGridCursorCol() 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.
-
- Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
- @c wxALIGN_BOTTOM.
+ Returns the current grid cell row position.
*/
- void GetColLabelAlignment(int* horiz, int* vert) const;
+ int GetGridCursorRow() const;
/**
- Returns the current height of the column labels.
- */
- int GetColLabelSize() 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 specified column label.
-
- 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;
+ Make the given cell current and ensure it is visible.
- /**
- Returns the coordinate of the left border specified column.
- */
- int GetColLeft(int col) 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 minimal width to which a column may be resized.
+ Moves the grid cursor down by one row.
- Use SetColMinimalAcceptableWidth() to change this value globally or
- SetColMinimalWidth() to do it for individual columns.
+ 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 GetColMinimalAcceptableWidth() const;
+ bool MoveCursorDown(bool expandSelection);
/**
- Get the minimal width of the given column/row.
+ 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.
- The value returned by this function may be different than that returned
- by GetColMinimalAcceptableWidth() if SetColMinimalWidth() had been
- called for this 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.
*/
- int GetColMinimalWidth(int col) const;
+ bool MoveCursorDownBlock(bool expandSelection);
/**
- Returns the position of the specified column.
- */
- int GetColPos(int colID) const;
+ Moves the grid cursor left by one column.
- /**
- Returns the coordinate of the right border specified 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.
*/
- int GetColRight(int col) const;
+ bool MoveCursorLeft(bool expandSelection);
/**
- Returns the width of the specified column.
+ 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.
+
+ 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 GetColSize(int col) const;
+ bool MoveCursorLeftBlock(bool expandSelection);
/**
- Returns the default cell alignment.
-
- 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.
+ Moves the grid cursor right by one column.
- @see SetDefaultCellAlignment()
+ 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 GetDefaultCellAlignment(int* horiz, int* vert) const;
+ bool MoveCursorRight(bool expandSelection);
/**
- Returns the current default background colour for grid cells.
- */
- wxColour GetDefaultCellBackgroundColour() 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.
- /**
- Returns the current default font for grid cell text.
+ If a block of cells was previously selected it will expand if the
+ argument is @true or be cleared if the argument is @false.
*/
- wxFont GetDefaultCellFont() const;
+ bool MoveCursorRightBlock(bool expandSelection);
/**
- Returns the current default colour for grid cell text.
+ 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.
*/
- wxColour GetDefaultCellTextColour() const;
+ bool MoveCursorUp(bool expandSelection);
/**
- Returns the default height for column labels.
+ 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.
+
+ 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 GetDefaultColLabelSize() const;
+ bool MoveCursorUpBlock(bool expandSelection);
/**
- Returns the current default width for grid columns.
+ Moves the grid cursor down by some number of rows so that the previous
+ bottom visible row becomes the top visible row.
*/
- int GetDefaultColSize() const;
+ bool MovePageDown();
/**
- Returns a pointer to the current default grid cell editor.
-
- See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
+ Moves the grid cursor up by some number of rows so that the previous
+ top visible row becomes the bottom visible row.
*/
- wxGridCellEditor* GetDefaultEditor() const;
+ bool MovePageUp();
- //@{
/**
- Returns the default editor for the specified cell.
+ Set the grid cursor to 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.
+ The grid cursor indicates the current cell and can be moved by the user
+ using the arrow keys or the mouse.
- Notice that the same may be usually achieved in simpler way by
- associating a custom editor with the given cell or cells.
+ Calling this function generates a @c wxEVT_GRID_SELECT_CELL event and
+ if the event handler vetoes this event, the cursor is not moved.
- The caller must call DecRef() on the returned pointer.
+ This function doesn't make the target call visible, use GoToCell() to
+ do this.
*/
- virtual wxGridCellEditor* GetDefaultEditorForCell(int row, int col) const;
- wxGridCellEditor* GetDefaultEditorForCell(const wxGridCellCoords& c) const;
- //@}
-
+ void SetGridCursor(int row, int col);
/**
- Returns the default editor for the cells containing values of the given
- type.
+ Set the grid cursor to the specified cell.
- 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 grid cursor indicates the current cell and can be moved by the user
+ using the arrow keys or the mouse.
- The caller must call DecRef() on the returned pointer.
+ 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.
*/
- virtual wxGridCellEditor *
- GetDefaultEditorForType(const wxString& typeName) const;
+ void SetGridCursor(const wxGridCellCoords& coords);
- /**
- 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.
- @see GetColGridLinePen(), GetRowGridLinePen()
+ /**
+ @name User Selection
+ */
+ //@{
+
+ /**
+ Deselects all cells that are currently selected.
*/
- virtual wxPen GetDefaultGridLinePen();
+ void ClearSelection();
/**
- Returns a pointer to the current default grid cell renderer.
+ Returns an array of individually selected cells.
- See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
+ Notice that this array does @em not contain all the selected cells in
+ general as it doesn't include the cells selected as part of column, row
+ or block selection. You must use this method, GetSelectedCols(),
+ GetSelectedRows() and GetSelectionBlockTopLeft() and
+ GetSelectionBlockBottomRight() methods to obtain the entire selection
+ in general.
- The caller must call DecRef() on the returned pointer.
+ Please notice this behaviour is by design and is needed in order to
+ support grids of arbitrary size (when an entire column is selected in
+ a grid with a million of columns, we don't want to create an array with
+ a million of entries in this function, instead it returns an empty
+ array and GetSelectedCols() returns an array containing one element).
*/
- wxGridCellRenderer* GetDefaultRenderer() const;
+ wxGridCellCoordsArray GetSelectedCells() const;
/**
- 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.
+ Returns an array of selected columns.
- The caller must call DecRef() on the returned pointer.
+ Please notice that this method alone is not sufficient to find all the
+ selected columns as it contains only the columns which were
+ individually selected but not those being part of the block selection
+ or being selected in virtue of all of their cells being selected
+ individually, please see GetSelectedCells() for more details.
*/
- virtual wxGridCellRenderer *GetDefaultRendererForCell(int row, int col) const;
+ wxArrayInt GetSelectedCols() const;
/**
- Returns the default renderer for the cell containing values of the
- given type.
+ Returns an array of selected rows.
- @see GetDefaultEditorForType()
+ Please notice that this method alone is not sufficient to find all the
+ selected rows as it contains only the rows which were individually
+ selected but not those being part of the block selection or being
+ selected in virtue of all of their cells being selected individually,
+ please see GetSelectedCells() for more details.
*/
- virtual wxGridCellRenderer *
- GetDefaultRendererForType(const wxString& typeName) const;
+ wxArrayInt GetSelectedRows() const;
/**
- Returns the default width for the row labels.
+ Returns the colour used for drawing the selection background.
*/
- int GetDefaultRowLabelSize() const;
+ wxColour GetSelectionBackground() const;
/**
- Returns the current default height for grid rows.
+ Returns an array of the bottom right corners of blocks of selected
+ cells.
+
+ Please see GetSelectedCells() for more information about the selection
+ representation in wxGrid.
+
+ @see GetSelectionBlockTopLeft()
*/
- int GetDefaultRowSize() const;
+ wxGridCellCoordsArray GetSelectionBlockBottomRight() const;
/**
- Returns the current grid cell column position.
+ Returns an array of the top left corners of blocks of selected cells.
+
+ Please see GetSelectedCells() for more information about the selection
+ representation in wxGrid.
+
+ @see GetSelectionBlockBottomRight()
*/
- int GetGridCursorCol() const;
+ wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
/**
- Returns the current grid cell row position.
+ Returns the colour used for drawing the selection foreground.
*/
- int GetGridCursorRow() const;
+ wxColour GetSelectionForeground() const;
/**
- Returns the colour used for grid lines.
+ Returns the current selection mode.
- @see GetDefaultGridLinePen()
+ @see SetSelectionMode().
*/
- wxColour GetGridLineColour() const;
+ wxGridSelectionModes GetSelectionMode() const;
/**
- Returns the colour used for the background of row and column labels.
+ Returns @true if the given cell is selected.
*/
- wxColour GetLabelBackgroundColour() const;
-
+ bool IsInSelection(int row, int col) const;
/**
- Returns the font used for row and column labels.
+ Returns @true if the given cell is selected.
*/
- wxFont GetLabelFont() const;
+ bool IsInSelection(const wxGridCellCoords& coords) const;
/**
- Returns the colour used for row and column label text.
+ Returns @true if there are currently any selected cells, rows, columns
+ or blocks.
*/
- wxColour GetLabelTextColour() const;
+ bool IsSelection() const;
/**
- Returns the total number of grid columns.
-
- This is the same as the number of columns in the underlying grid
- table.
+ Selects all cells in the grid.
*/
- int GetNumberCols() const;
+ void SelectAll();
/**
- Returns the total number of grid rows.
+ Selects a rectangular block of cells.
- This is the same as the number of rows in the underlying grid table.
+ If @a addToSelected is @false then any existing selection will be
+ deselected; if @true the column will be added to the existing
+ selection.
*/
- int GetNumberRows() const;
-
+ void SelectBlock(int topRow, int leftCol, int bottomRow, int rightCol,
+ bool addToSelected = false);
/**
- 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.
+ Selects a rectangular block of cells.
- This function may only be called if CanHaveAttributes() returns @true.
+ If @a addToSelected is @false then any existing selection will be
+ deselected; if @true the column will be added to the existing
+ selection.
*/
- wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const;
+ void SelectBlock(const wxGridCellCoords& topLeft,
+ const wxGridCellCoords& bottomRight,
+ bool addToSelected = false);
/**
- Returns the pen used for horizontal grid lines.
+ Selects the specified column.
- 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.
+ If @a addToSelected is @false then any existing selection will be
+ deselected; if @true the column will be added to the existing
+ selection.
- 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
+ This method won't select anything if the current selection mode is
+ wxGridSelectRows.
*/
- virtual wxPen GetRowGridLinePen(int row);
+ void SelectCol(int col, bool addToSelected = false);
/**
- Returns the alignment used for row labels.
+ Selects the specified row.
- Horizontal alignment will be one of @c wxALIGN_LEFT, @c wxALIGN_CENTRE
- or @c wxALIGN_RIGHT.
+ If @a addToSelected is @false then any existing selection will be
+ deselected; if @true the row will be added to the existing selection.
- Vertical alignment will be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE or
- @c wxALIGN_BOTTOM.
+ This method won't select anything if the current selection mode is
+ wxGridSelectColumns.
*/
- void GetRowLabelAlignment(int* horiz, int* vert) const;
+ void SelectRow(int row, bool addToSelected = false);
/**
- Returns the current width of the row labels.
+ Set the colour to be used for drawing the selection background.
*/
- int GetRowLabelSize() const;
+ void SetSelectionBackground(const wxColour& c);
/**
- 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.
+ Set the colour to be used for drawing the selection foreground.
*/
- wxString GetRowLabelValue(int row) const;
+ void SetSelectionForeground(const wxColour& c);
/**
- 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.
+ Set the selection behaviour of the grid.
- @see GetColMinimalAcceptableWidth()
+ 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).
*/
- int GetRowMinimalAcceptableHeight() const;
+ void SetSelectionMode(wxGridSelectionModes selmode);
- /**
- 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.
- */
- int GetRowMinimalHeight(int col) const;
/**
- Returns the height of the specified row.
- */
- int GetRowSize(int row) const;
+ @name Scrolling
+ */
+ //@{
/**
Returns the number of pixels per horizontal scroll increment.
int GetScrollLineY() const;
/**
- Returns an array of individually selected cells.
+ Returns @true if a cell is either entirely or at least partially
+ visible in the grid window.
- Notice that this array does @em not contain all the selected cells in
- general as it doesn't include the cells selected as part of column, row
- or block selection. You must use this method, GetSelectedCols(),
- GetSelectedRows() and GetSelectionBlockTopLeft() and
- GetSelectionBlockBottomRight() methods to obtain the entire selection
- in general.
+ 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(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.
- Please notice this behaviour is by design and is needed in order to
- support grids of arbitrary size (when an entire column is selected in
- a grid with a million of columns, we don't want to create an array with
- a million of entries in this function, instead it returns an empty
- array and GetSelectedCols() returns an array containing one element).
+ 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.
*/
- wxGridCellCoordsArray GetSelectedCells() const;
+ bool IsVisible(const wxGridCellCoords& coords,
+ bool wholeCellVisible = true) const;
/**
- Returns an array of selected columns.
+ Brings the specified cell into the visible grid cell area with minimal
+ scrolling.
- Please notice that this method alone is not sufficient to find all the
- selected columns as it contains only the columns which were
- individually selected but not those being part of the block selection
- or being selected in virtue of all of their cells being selected
- individually, please see GetSelectedCells() for more details.
+ Does nothing if the cell is already visible.
*/
- wxArrayInt GetSelectedCols() const;
-
+ void MakeCellVisible(int row, int col);
/**
- Returns an array of selected rows.
+ Brings the specified cell into the visible grid cell area with minimal
+ scrolling.
- Please notice that this method alone is not sufficient to find all the
- selected rows as it contains only the rows which were individually
- selected but not those being part of the block selection or being
- selected in virtue of all of their cells being selected individually,
- please see GetSelectedCells() for more details.
+ Does nothing if the cell is already visible.
*/
- wxArrayInt GetSelectedRows() const;
+ void MakeCellVisible(const wxGridCellCoords& coords);
/**
- Access or update the selection fore/back colours
+ Sets the number of pixels per horizontal scroll increment.
+
+ The default is 15.
+
+ @see GetScrollLineX(), GetScrollLineY(), SetScrollLineY()
*/
- wxColour GetSelectionBackground() const;
+ void SetScrollLineX(int x);
/**
- Returns an array of the bottom right corners of blocks of selected
- cells.
+ Sets the number of pixels per vertical scroll increment.
- Please see GetSelectedCells() for more information about the selection
- representation in wxGrid.
+ The default is 15.
- @see GetSelectionBlockTopLeft()
+ @see GetScrollLineX(), GetScrollLineY(), SetScrollLineX()
*/
- wxGridCellCoordsArray GetSelectionBlockBottomRight() const;
+ void SetScrollLineY(int y);
+
+ //@}
+
/**
- Returns an array of the top left corners of blocks of selected cells.
+ @name Cell and Device Coordinate Translation
+ */
+ //@{
- Please see GetSelectedCells() for more information about the selection
- representation in wxGrid.
+ /**
+ Convert grid cell coordinates to grid window pixel coordinates.
- @see GetSelectionBlockBottomRight()
+ 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()
*/
- wxGridCellCoordsArray GetSelectionBlockTopLeft() const;
+ wxRect BlockToDeviceRect(const wxGridCellCoords& topLeft,
+ const wxGridCellCoords& bottomRight) const;
/**
- Returns the colour used for drawing the selection foreground.
+ Return the rectangle corresponding to the grid cell's size and position
+ in logical coordinates.
+
+ @see BlockToDeviceRect()
*/
- wxColour GetSelectionForeground() const;
+ wxRect CellToRect(int row, int col) const;
+ /**
+ Return the rectangle corresponding to the grid cell's size and position
+ in logical coordinates.
+
+ @see BlockToDeviceRect()
+ */
+ wxRect CellToRect(const wxGridCellCoords& coords) const;
/**
- Returns the current selection mode.
+ Returns the column at the given pixel position.
- @see SetSelectionMode().
+ @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.
*/
- wxGridSelectionModes GetSelectionMode() const;
+ int XToCol(int x, bool clipToMinMax = false) const;
/**
- Returns a base pointer to the current table object.
+ Returns the column whose right hand edge is close to the given logical
+ @a x position.
- The returned pointer is still owned by the grid.
+ If no column edge is near to this position @c wxNOT_FOUND is returned.
*/
- wxGridTableBase *GetTable() const;
+ int XToEdgeOfCol(int x) const;
- //@{
/**
- Make the given cell current and ensure it is visible.
+ Translates logical pixel coordinates to the grid cell coordinates.
- 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.
+ 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()
*/
- void GoToCell(int row, int col);
- void GoToCell(const wxGridCellCoords& coords);
- //@}
+ wxGridCellCoords XYToCell(int x, int y) 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(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 drawing of grid lines is turned on, @false otherwise.
+ Returns the row whose bottom edge is close to the given logical @a y
+ position.
+
+ If no row edge is near to this position @c wxNOT_FOUND is returned.
*/
- bool GridLinesEnabled() const;
+ int YToEdgeOfRow(int y) const;
/**
- Hides the in-place cell edit control.
+ Returns the grid row that corresponds to the logical @a y coordinate.
+
+ Returns @c wxNOT_FOUND if there is no row at the @a y position.
*/
- void HideCellEditControl();
+ int YToRow(int y, bool clipToMinMax = false) const;
+
+ //@}
+
/**
- 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.
- */
- void HideColLabels();
+ @name Miscellaneous Functions
+ */
+ //@{
/**
- Hides the row labels by calling SetRowLabelSize() with a size of 0.
+ Appends one or more new columns to the right of the grid.
- The labels can be shown again by calling SetRowLabelSize() with a width
- greater than 0.
+ 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.
*/
- void HideRowLabels();
+ bool AppendCols(int numCols = 1, bool updateLabels = true);
/**
- Inserts one or more new columns into a grid with the first new column
- at the specified position.
+ Appends one or more new rows to the bottom 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 @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.
- @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).
+ @return @true on success or @false if appending rows failed.
*/
- bool InsertCols(int pos = 0, int numCols = 1, bool updateLabels = true);
+ bool AppendRows(int numRows = 1, bool updateLabels = true);
/**
- Inserts one or more new rows into a grid with the first new row at the
- specified position.
+ Return @true if the horizontal grid lines stop at the last column
+ boundary or @false if they continue to the end of the window.
- 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 to clip grid lines.
- @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).
- */
- bool InsertRows(int pos = 0, int numRows = 1, bool updateLabels = true);
+ @see ClipHorzGridLines(), AreVertGridLinesClipped()
+ */
+ bool AreHorzGridLinesClipped() const;
/**
- Returns @true if the in-place edit control is currently enabled.
- */
- bool IsCellEditControlEnabled() 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 @true if the current cell is read-only.
+ The default is to clip grid lines.
- @see SetReadOnly(), IsReadOnly()
- */
- bool IsCurrentCellReadOnly() const;
+ @see ClipVertGridLines(), AreHorzGridLinesClipped()
+ */
+ bool AreVertGridLinesClipped() const;
/**
- Returns @false if the whole grid has been set as read-only or @true
- otherwise.
+ Increments the grid's batch count.
- See EnableEditing() for more information about controlling the editing
- status of grid cells.
- */
- bool IsEditable() const;
+ 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.
- //@{
- /**
- Is this cell currently selected?
+ 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 IsInSelection(int row, int col) const;
- bool IsInSelection(const wxGridCellCoords& coords) const;
- //@}
+ void BeginBatch();
/**
- Returns @true if the cell at the specified location can't be edited.
+ Clears all data in the underlying grid table and repaints the grid.
- @see SetReadOnly(), IsCurrentCellReadOnly()
+ 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 IsReadOnly(int row, int col) const;
+ void ClearGrid();
/**
- Returns @true if there are currently any selected cells, rows, columns
- or blocks.
- */
- bool IsSelection() const;
+ Change whether the horizontal grid lines are clipped by the end of the
+ last column.
- //@{
- /**
- Returns @true if a cell is either wholly or at least partially visible
- in the grid window.
+ 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.
- 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(int row, int col, bool wholeCellVisible = true) const;
- const bool IsVisible(const wxGridCellCoords& coords,
- bool wholeCellVisible = true) const;
- //@}
+ @see AreHorzGridLinesClipped(), ClipVertGridLines()
+ */
+ void ClipHorzGridLines(bool clip);
- //@{
/**
- Brings the specified cell into the visible grid cell area with minimal
- scrolling.
+ Change whether the vertical grid lines are clipped by the end of the
+ last row.
- Does nothing if the cell is already visible.
- */
- void MakeCellVisible(int row, int col);
- void MakeCellVisible(const wxGridCellCoords& coords);
- //@}
+ 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.
+
+ @see AreVertGridLinesClipped(), ClipHorzGridLines()
+ */
+ void ClipVertGridLines(bool clip);
/**
- Moves the grid cursor down by one row.
+ Deletes one or more columns from a grid starting at the specified
+ position.
- 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::DeleteCols(). See InsertCols() for further
+ information.
+
+ @return @true on success or @false if deleting columns failed.
*/
- bool MoveCursorDown(bool expandSelection);
+ bool DeleteCols(int pos = 0, int numCols = 1, bool updateLabels = true);
/**
- 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.
+ Deletes one or more rows from a grid starting at the specified
+ position.
- 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::DeleteRows(). See InsertRows() for further
+ information.
+
+ @return @true on success or @false if appending rows failed.
*/
- bool MoveCursorDownBlock(bool expandSelection);
+ bool DeleteRows(int pos = 0, int numRows = 1, bool updateLabels = true);
/**
- Moves the grid cursor left by one column.
+ Decrements 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 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
*/
- bool MoveCursorLeft(bool expandSelection);
+ void EndBatch();
/**
- 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.
-
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
+ Overridden wxWindow method.
*/
- bool MoveCursorLeftBlock(bool expandSelection);
+ virtual void Fit();
/**
- Moves the grid cursor right by one column.
+ Causes immediate repainting 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.
+ Use this instead of the usual wxWindow::Refresh().
*/
- bool MoveCursorRight(bool expandSelection);
+ void ForceRefresh();
/**
- 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.
-
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
+ 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.
*/
- bool MoveCursorRightBlock(bool expandSelection);
+ int GetBatchCount();
/**
- Moves the grid cursor up by one row.
+ Returns the total number of grid columns.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
+ This is the same as the number of columns in the underlying grid table.
*/
- bool MoveCursorUp(bool expandSelection);
+ int GetNumberCols() const;
/**
- 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.
+ Returns the total number of grid rows.
- If a block of cells was previously selected it will expand if the
- argument is @true or be cleared if the argument is @false.
+ This is the same as the number of rows in the underlying grid table.
*/
- bool MoveCursorUpBlock(bool expandSelection);
+ int GetNumberRows() const;
/**
- Moves the grid cursor down by some number of rows so that the previous
- bottom visible row becomes the top visible row.
- */
- bool MovePageDown();
+ Returns the attribute for the given cell creating one if necessary.
- /**
- Moves the grid cursor up by some number of rows so that the previous
- top visible row becomes the bottom visible row.
+ 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.
*/
- bool MovePageUp();
+ wxGridCellAttr *GetOrCreateCellAttr(int row, int col) const;
/**
- Register a new data type.
+ Returns a base pointer to the current table object.
- 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.
+ The returned pointer is still owned by the grid.
+ */
+ wxGridTableBase *GetTable() 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.
+ /**
+ Inserts one or more new columns into a grid with the first new column
+ 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.
+ 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 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.
+ @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 RegisterDataType(const wxString& typeName,
- wxGridCellRenderer* renderer,
- wxGridCellEditor* editor);
+ bool InsertCols(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.
+ Inserts one or more new rows into a grid with the first new row 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.
+ Notice that you must implement wxGridTableBase::InsertRows() if you use
+ a grid with a custom table, please see InsertCols() 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 SaveEditControlValue();
+ bool InsertRows(int pos = 0, int numRows = 1, bool updateLabels = true);
/**
- Selects all cells in the grid.
+ 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.
*/
- void SelectAll();
+ void SetColAttr(int col, wxGridCellAttr* attr);
- //@{
/**
- Selects a rectangular block of cells.
+ Sets the extra margins used around the grid area.
- 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);
- void SelectBlock(const wxGridCellCoords& topLeft,
- const wxGridCellCoords& bottomRight,
- bool addToSelected = false);
- //@}
+ 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 SetMargins(int extraWidth, int extraHeight);
/**
- Selects the specified column.
+ Sets the cell attributes for all cells in the specified row.
- If @a addToSelected is @false then any existing selection will be
- deselected; if @true the column will be added to the existing
- selection.
+ The grid takes ownership of the attribute pointer.
- This method won't select anything if the current selection mode is
- wxGridSelectRows.
+ See the wxGridCellAttr class for more information about controlling
+ cell attributes.
*/
- void SelectCol(int col, bool addToSelected = false);
+ void SetRowAttr(int row, wxGridCellAttr* attr);
+
+ //@}
+
/**
- Selects the specified row.
+ @name Sorting support.
- If @a addToSelected is @false then any existing selection will be
- deselected; if @true the row will be added to the existing selection.
+ wxGrid doesn't provide any support for sorting the data but it does
+ generate events allowing the user code to sort it and supports
+ displaying the sort indicator in the column used for sorting.
- This method won't select anything if the current selection mode is
- wxGridSelectColumns.
- */
- void SelectRow(int row, bool addToSelected = false);
+ To use wxGrid sorting support you need to handle wxEVT_GRID_COL_SORT
+ event (and not veto it) and resort the data displayed in the grid. The
+ grid will automatically update the sorting indicator on the column
+ which was clicked.
+ You can also call the functions in this section directly to update the
+ sorting indicator. Once again, they don't do anything with the grid
+ data, it remains your responsibility to actually sort it appropriately.
+ */
//@{
+
/**
- Sets the horizontal and vertical alignment for grid cell text at the
- specified location.
+ Return the column in which the sorting indicator is currently
+ displayed.
- Horizontal alignment should be one of @c wxALIGN_LEFT, @c
- wxALIGN_CENTRE or @c wxALIGN_RIGHT.
+ Returns @c wxNOT_FOUND if sorting indicator is not currently displayed
+ at all.
- Vertical alignment should be one of @c wxALIGN_TOP, @c wxALIGN_CENTRE
- or @c wxALIGN_BOTTOM.
- */
- void SetCellAlignment(int row, int col, int horiz, int vert);
- void SetCellAlignment(int align, int row, int col);
- //@}
+ @see SetSortingColumn()
+ */
+ int GetSortingColumn() const;
- //@{
/**
- Set the background colour for the given cell or all cells by default.
- */
- void SetCellBackgroundColour(int row, int col, const wxColour& colour);
- //@}
+ Return @true if this column is currently used for sorting.
- /**
- Sets the editor for the grid cell at the specified location.
+ @see GetSortingColumn()
+ */
+ bool IsSortingBy(int col) const;
- The grid will take ownership of the pointer.
+ /**
+ Return @true if the current sorting order is ascending or @false if it
+ is descending.
- See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
- */
- void SetCellEditor(int row, int col, wxGridCellEditor* editor);
+ It only makes sense to call this function if GetSortingColumn() returns
+ a valid column index and not @c wxNOT_FOUND.
- /**
- Sets the font for text in the grid cell at the specified location.
- */
- void SetCellFont(int row, int col, const wxFont& font);
+ @see SetSortingColumn()
+ */
+ bool IsSortOrderAscending() const;
/**
- Sets the renderer for the grid cell at the specified location.
+ Set the column to display the sorting indicator in and its direction.
- The grid will take ownership of the pointer.
+ @param col
+ The column to display the sorting indicator in or @c wxNOT_FOUND to
+ remove any currently displayed sorting indicator.
+ @param ascending
+ If @true, display the ascending sort indicator, otherwise display
+ the descending sort indicator.
- See wxGridCellRenderer and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
- */
- void SetCellRenderer(int row, int col, wxGridCellRenderer* renderer);
+ @see GetSortingColumn(), IsSortOrderAscending()
+ */
+ void SetSortingColumn(int col, bool ascending = true);
- //@{
/**
- Sets the text colour for the given cell or all cells by default.
- */
- void SetCellTextColour(int row, int col, const wxColour& colour);
- void SetCellTextColour(const wxColour& val, int row, int col);
- void SetCellTextColour(const wxColour& colour);
+ Remove any currently shown sorting indicator.
+
+ This is equivalent to calling SetSortingColumn() with @c wxNOT_FOUND
+ first argument.
+ */
+ void UnsetSortingColumn();
//@}
- //@{
+
/**
- Sets the string value for the cell at the specified location.
+ @name Accessors for component windows.
- 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.
+ Return the various child windows of wxGrid.
- See wxGridTableBase::CanSetValueAs and the @ref overview_grid
- "wxGrid overview" for more information.
- */
- 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);
- //@}
+ wxGrid is an empty parent window for 4 children representing the column
+ labels window (top), the row labels window (left), the corner window
+ (top left) and the main grid window. It may be necessary to use these
+ individual windows and not the wxGrid window itself if you need to
+ handle events for them (this can be done using wxEvtHandler::Connect()
+ or wxWindow::PushEventHandler()) or do something else requiring the use
+ of the correct window pointer. Notice that you should not, however,
+ change these windows (e.g. reposition them or draw over them) because
+ they are managed by wxGrid itself.
+ */
+ //@{
/**
- Sets the cell attributes for all cells in the specified column.
+ Return the main grid window containing the grid cells.
- For more information about controlling grid cell attributes see the
- wxGridCellAttr cell attribute class and the @ref overview_grid "wxGrid overview".
- */
- void SetColAttr(int col, wxGridCellAttr* attr);
+ This window is always shown.
+ */
+ wxWindow *GetGridWindow() const;
/**
- Sets the specified column to display boolean values.
+ Return the row labels window.
- @see SetColFormatCustom()
- */
- void SetColFormatBool(int col);
+ This window is not shown if the row labels were hidden using
+ HideRowLabels().
+ */
+ wxWindow *GetGridRowLabelWindow() const;
/**
- Sets the specified column to display data in a custom format.
+ Return the column labels window.
- 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.
+ This window is not shown if the columns labels were hidden using
+ HideColLabels().
- See the @ref overview_grid "wxGrid overview" for more
- information on working with custom data types.
- */
- void SetColFormatCustom(int col, const wxString& typeName);
+ Depending on whether UseNativeColHeader() was called or not this can be
+ either a wxHeaderCtrl or a plain wxWindow. This function returns a valid
+ window pointer in either case but in the former case you can also use
+ GetGridColHeader() to access it if you need wxHeaderCtrl-specific
+ functionality.
+ */
+ wxWindow *GetGridColLabelWindow() const;
/**
- Sets the specified column to display floating point values with the
- given width and precision.
+ Return the window in the top left grid corner.
- @see SetColFormatCustom()
- */
- void SetColFormatFloat(int col, int width = -1, int precision = -1);
+ This window is shown only of both columns and row labels are shown and
+ normally doesn't contain anything. Clicking on it is handled by wxGrid
+ however and can be used to select the entire grid.
+ */
+ wxWindow *GetGridCornerLabelWindow() const;
/**
- Sets the specified column to display integer values.
+ Return the header control used for column labels display.
- @see SetColFormatCustom()
- */
- void SetColFormatNumber(int col);
+ This function can only be called if UseNativeColHeader() had been
+ called.
+ */
+ wxHeaderCtrl *GetGridColHeader() const;
+ //@}
+
+protected:
/**
- Sets the horizontal and vertical alignment of column label text.
+ Returns @true if this grid has support for cell attributes.
- 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 grid supports attributes if it has the associated table which, in
+ turn, has attributes support, i.e. wxGridTableBase::CanHaveAttributes()
+ returns @true.
*/
- void SetColLabelAlignment(int horiz, int vert);
+ bool CanHaveAttributes() const;
/**
- Sets the height of the column labels.
+ Get the minimal width of the given column/row.
- 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.
+ The value returned by this function may be different than that returned
+ by GetColMinimalAcceptableWidth() if SetColMinimalWidth() had been
+ called for this column.
*/
- void SetColLabelSize(int height);
+ int GetColMinimalWidth(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 right border specified column.
*/
- void SetColLabelValue(int col, const wxString& value);
+ int GetColRight(int col) const;
/**
- Sets the minimal width to which the user can resize columns.
-
- @see GetColMinimalAcceptableWidth()
+ Returns the coordinate of the left border specified column.
*/
- void SetColMinimalAcceptableWidth(int width);
+ int GetColLeft(int col) const;
/**
- Sets the minimal width for the specified column.
-
- 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 minimal size for the given column.
- @a width must be greater than the minimal acceptable column width as
- returned by GetColMinimalAcceptableWidth().
+ The value returned by this function may be different than that returned
+ by GetRowMinimalAcceptableHeight() if SetRowMinimalHeight() had been
+ called for this row.
*/
- void SetColMinimalWidth(int col, int width);
+ int GetRowMinimalHeight(int col) const;
+};
- /**
- Sets the position of the specified column.
- */
- void SetColPos(int colID, int newPos);
- /**
- Sets the width of the specified column.
- Notice that this function does not refresh the grid, you need to call
- ForceRefresh() to make the changes take effect immediately.
+/**
+ @class wxGridUpdateLocker
- @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);
+ 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:
- /**
- Sets the default horizontal and vertical alignment for grid cell text.
+ @code
+ void MyFrame::Foo()
+ {
+ m_grid = new wxGrid(this, ...);
- 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);
+ wxGridUpdateLocker noUpdates(m_grid);
+ m_grid-AppendColumn();
+ // ... many other operations with m_grid ...
+ m_grid-AppendRow();
+
+ // destructor called, grid refreshed
+ }
+ @endcode
+
+ 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.
+ Notice that all grid event table macros are available in two versions:
+ @c EVT_GRID_XXX and @c EVT_GRID_CMD_XXX. The only difference between the
+ two is that the former doesn't allow to specify the grid window identifier
+ and so takes a single parameter, the event handler, but is not suitable if
+ there is more than one grid control in the window where the event table is
+ used (as it would catch the events from all the grids). The version with @c
+ CMD takes the id as first argument and the event handler as the second one
+ and so can be used with multiple grids as well. Otherwise there are no
+ difference between the two and only the versions without the id are
+ documented below for brevity.
+
+ @beginEventTable{wxGridEvent}
+ @event{EVT_GRID_CELL_CHANGING(func)}
+ The user is about to change the data in a cell. The new cell value as
+ string is available from GetString() event object method. This event
+ can be vetoed if the change is not allowed.
+ Processes a @c wxEVT_GRID_CELL_CHANGING event type.
+ @event{EVT_GRID_CELL_CHANGED(func)}
+ The user changed the data in a cell. The old cell value as string is
+ available from GetString() event object method. Notice that vetoing
+ this event still works for backwards compatibility reasons but any new
+ code should only veto EVT_GRID_CELL_CHANGING event and not this one.
+ Processes a @c wxEVT_GRID_CELL_CHANGED 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_COL_MOVE(func)}
+ The user tries to change the order of the columns in the grid by
+ dragging the column specified by GetCol(). This event can be vetoed to
+ either prevent the user from reordering the column change completely
+ (but notice that if you don't want to allow it at all, you simply
+ shouldn't call wxGrid::EnableDragColMove() in the first place), vetoed
+ but handled in some way in the handler, e.g. by really moving the
+ column to the new position at the associated table level, or allowed to
+ proceed in which case wxGrid::SetColPos() is used to reorder the
+ columns display order without affecting the use of the column indices
+ otherwise.
+ This event macro corresponds to @c wxEVT_GRID_COL_MOVE event type.
+ @event{EVT_GRID_COL_SORT(func)}
+ This event is generated when a column is clicked by the user and its
+ name is explained by the fact that the custom reaction to a click on a
+ column is to sort the grid contents by this column. However the grid
+ itself has no special support for sorting and it's up to the handler of
+ this event to update the associated table. But if the event is handled
+ (and not vetoed) the grid supposes that the table was indeed resorted
+ and updates the column to indicate the new sort order and refreshes
+ itself.
+ This event macro corresponds to @c wxEVT_GRID_COL_SORT event type.
+ @endEventTable
- See wxGridCellEditor and the @ref overview_grid "wxGrid overview"
- for more information about cell editors and renderers.
+ @library{wxadv}
+ @category{grid,events}
+*/
+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, const wxKeyboardState& kbd = wxKeyboardState());
/**
- 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;
/**
- Sets the colour used to draw grid lines.
+ Column at which the event occurred.
*/
- void SetGridLineColour(const wxColour& colour);
+ virtual int GetCol();
/**
- Sets the background colour for row and column labels.
+ Position in pixels at which the event occurred.
*/
- void SetLabelBackgroundColour(const wxColour& colour);
+ wxPoint GetPosition();
/**
- Sets the font for row and column labels.
+ Row at which the event occurred.
*/
- void SetLabelFont(const wxFont& font);
+ virtual int GetRow();
/**
- Sets the colour for row and column label text.
+ Returns @true if the Meta key was down at the time of the event.
*/
- void SetLabelTextColour(const wxColour& colour);
+ bool MetaDown() const;
/**
- 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 user is selecting grid cells, or @false if
+ deselecting.
*/
- void SetMargins(int extraWidth, int extraHeight);
+ bool Selecting();
/**
- Makes the cell at the specified location read-only or editable.
-
- @see IsReadOnly()
+ Returns @true if the Shift key was down at the time of the event.
*/
- void SetReadOnly(int row, int col, bool isReadOnly = true);
+ bool ShiftDown() const;
+};
- /**
- Sets the cell attributes for all cells in the specified row.
- The grid takes ownership of the attribute pointer.
- See the wxGridCellAttr class for more information about controlling
- cell attributes.
- */
- void SetRowAttr(int row, wxGridCellAttr* attr);
+/**
+ @class wxGridSizeEvent
- /**
- Sets the horizontal and vertical alignment of row label text.
+ This event class contains information about a row/column resize event.
- 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 SetRowLabelAlignment(int horiz, int vert);
+ @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,events}
+*/
+class wxGridSizeEvent : public wxNotifyEvent
+{
+public:
/**
- 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.
+ Default constructor.
*/
- void SetRowLabelSize(int width);
-
+ wxGridSizeEvent();
/**
- 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.
+ Constructor for initializing all event attributes.
*/
- void SetRowLabelValue(int row, const wxString& value);
+ wxGridSizeEvent(int id, wxEventType type, wxObject* obj,
+ int rowOrCol = -1, int x = -1, int y = -1,
+ const wxKeyboardState& kbd = wxKeyboardState());
/**
- Sets the minimal row height used by default.
-
- See SetColMinimalAcceptableWidth() for more information.
+ Returns @true if the Alt key was down at the time of the event.
*/
- void SetRowMinimalAcceptableHeight(int height);
+ bool AltDown() const;
/**
- Sets the minimal height for the specified row.
+ Returns @true if the Control key was down at the time of the event.
+ */
+ bool ControlDown() const;
- 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,events}
+*/
+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, const wxKeyboardState& kbd = wxKeyboardState());
/**
- 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
+ @category{grid,events}
*/
-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