Version: 3.1.1
wxGridCellEditor Class Referenceabstract

#include <wx/grid.h>

+ Inheritance diagram for wxGridCellEditor:

Detailed Description

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:  wxAdvanced
Category:  Grid Related Classes
See also
wxGridCellAutoWrapStringEditor, wxGridCellBoolEditor, wxGridCellChoiceEditor, wxGridCellEnumEditor, wxGridCellFloatEditor, wxGridCellNumberEditor, wxGridCellTextEditor

Public Member Functions

 wxGridCellEditor ()
 Default constructor. More...
 
virtual void BeginEdit (int row, int col, wxGrid *grid)=0
 Fetch the value from the table and prepare the edit control to begin editing. More...
 
virtual wxGridCellEditorClone () const =0
 Create a new object which is the copy of this one. More...
 
virtual void Create (wxWindow *parent, wxWindowID id, wxEvtHandler *evtHandler)=0
 Creates the actual edit control. More...
 
virtual void Destroy ()
 Final cleanup. More...
 
virtual bool EndEdit (int row, int col, const wxGrid *grid, const wxString &oldval, wxString *newval)=0
 End editing the cell. More...
 
virtual void ApplyEdit (int row, int col, wxGrid *grid)=0
 Effectively save the changes in the grid. More...
 
virtual void HandleReturn (wxKeyEvent &event)
 Some types of controls on some platforms may need some help with the Return key. More...
 
bool IsCreated ()
 Returns true if the edit control has been created. More...
 
virtual void PaintBackground (wxDC &dc, const wxRect &rectCell, wxGridCellAttr &attr)
 Draws the part of the cell not occupied by the control: the base class version just fills it with background colour from the attribute. More...
 
virtual void Reset ()=0
 Reset the value in the control back to its starting value. More...
 
virtual void SetSize (const wxRect &rect)
 Size and position the edit control. More...
 
virtual void Show (bool show, wxGridCellAttr *attr=NULL)
 Show or hide the edit control, use the specified attributes to set colours/fonts for it. More...
 
virtual void StartingClick ()
 If the editor is enabled by clicking on the cell, this method will be called. More...
 
virtual void StartingKey (wxKeyEvent &event)
 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. More...
 
virtual wxString GetValue () const =0
 Returns the value currently in the editor control. More...
 
wxControlGetControl () const
 Get the wxControl used by this editor. More...
 
void SetControl (wxControl *control)
 Set the wxControl that will be used by this cell editor for editing the value. More...
 
- Public Member Functions inherited from wxClientDataContainer
 wxClientDataContainer ()
 Default constructor. More...
 
virtual ~wxClientDataContainer ()
 Destructor. More...
 
void * GetClientData () const
 Get the untyped client data. More...
 
wxClientDataGetClientObject () const
 Get a pointer to the client data object. More...
 
void SetClientData (void *data)
 Set the untyped client data. More...
 
void SetClientObject (wxClientData *data)
 Set the client data object. More...
 
- Public Member Functions inherited from wxRefCounter
 wxRefCounter ()
 Default constructor. More...
 
void DecRef ()
 Decrements the reference count associated with this shared data and, if it reaches zero, destroys this instance of wxRefCounter releasing its memory. More...
 
int GetRefCount () const
 Returns the reference count associated with this shared data. More...
 
void IncRef ()
 Increments the reference count associated with this shared data. More...
 

Protected Member Functions

virtual ~wxGridCellEditor ()
 The destructor is private because only DecRef() can delete us. More...
 
- Protected Member Functions inherited from wxRefCounter
virtual ~wxRefCounter ()
 Destructor. More...
 

Constructor & Destructor Documentation

wxGridCellEditor::wxGridCellEditor ( )

Default constructor.

virtual wxGridCellEditor::~wxGridCellEditor ( )
protectedvirtual

The destructor is private because only DecRef() can delete us.

Member Function Documentation

virtual void wxGridCellEditor::ApplyEdit ( int  row,
int  col,
wxGrid grid 
)
pure virtual

Effectively save the changes in the grid.

This function should save the value of the control in the grid. It is called only after EndEdit() returns true.

virtual void wxGridCellEditor::BeginEdit ( int  row,
int  col,
wxGrid grid 
)
pure virtual

Fetch the value from the table and prepare the edit control to begin editing.

This function should save the original value of the grid cell at the given row and col and show the control allowing the user to change it.

See also
EndEdit()
virtual wxGridCellEditor* wxGridCellEditor::Clone ( ) const
pure virtual

Create a new object which is the copy of this one.

virtual void wxGridCellEditor::Create ( wxWindow parent,
wxWindowID  id,
wxEvtHandler evtHandler 
)
pure virtual

Creates the actual edit control.

virtual void wxGridCellEditor::Destroy ( )
virtual

Final cleanup.

virtual bool wxGridCellEditor::EndEdit ( int  row,
int  col,
const wxGrid grid,
const wxString oldval,
wxString newval 
)
pure virtual

End editing the cell.

This function must check if the current value of the editing control is valid and different from the original value (available as 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 must do the following:

  • Save the new value internally so that ApplyEdit() could apply it.
  • Fill newval (which is never NULL) with the string representation of the new value.
  • Return true

Notice that it must not modify the grid as the change could still be vetoed.

If the user-defined wxEVT_GRID_CELL_CHANGING event handler doesn't veto this change, ApplyEdit() will be called next.

wxControl* wxGridCellEditor::GetControl ( ) const

Get the wxControl used by this editor.

virtual wxString wxGridCellEditor::GetValue ( ) const
pure virtual

Returns the value currently in the editor control.

virtual void wxGridCellEditor::HandleReturn ( wxKeyEvent event)
virtual

Some types of controls on some platforms may need some help with the Return key.

bool wxGridCellEditor::IsCreated ( )

Returns true if the edit control has been created.

virtual void wxGridCellEditor::PaintBackground ( wxDC dc,
const wxRect rectCell,
wxGridCellAttr attr 
)
virtual

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 wxGridCellEditor::Reset ( )
pure virtual

Reset the value in the control back to its starting value.

void wxGridCellEditor::SetControl ( wxControl control)

Set the wxControl that will be used by this cell editor for editing the value.

virtual void wxGridCellEditor::SetSize ( const wxRect rect)
virtual

Size and position the edit control.

virtual void wxGridCellEditor::Show ( bool  show,
wxGridCellAttr attr = NULL 
)
virtual

Show or hide the edit control, use the specified attributes to set colours/fonts for it.

virtual void wxGridCellEditor::StartingClick ( )
virtual

If the editor is enabled by clicking on the cell, this method will be called.

virtual void wxGridCellEditor::StartingKey ( wxKeyEvent event)
virtual

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.