.\" This is a wxWidgets manpage page generated from the XML docs
.TH wxGridCellEditor 3wx 2005-02-15 "wxWidgets" "wxWidgets class documentation"
.SH NAME
wxGridCellEditor \- 
.SH 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.
  
 
.SH "PARENTS"

  wxGridCellWorker
 
.SH "INCLUDE FILES"
wx/grid.h
.SH MEMBERS

  
.SS  wxGridCellEditor ()

   
  
.SS bool IsCreated ()

   
  
.SS void Create (wxWindow* parentwxWindowID idwxEvtHandler* evtHandler)

     


      Creates the actual edit control.
     
    
   
  
.SS void SetSize (const wxRect& rect)

     


      Size and position the edit control.
     
    
   
  
.SS void Show (bool showwxGridCellAttr* attr = NULL)

     


      Show or hide the edit control, use the specified attributes to set
      colours/fonts for it.
     
    
   
  
.SS void PaintBackground (const wxRect& rectCellwxGridCellAttr* 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.
     
    
   
  
.SS void BeginEdit (int rowint colwxGrid* grid)

     


      Fetch the value from the table and prepare the edit control to begin
      editing. Set the focus to the edit control.
     
    
   
  
.SS bool EndEdit (int rowint colwxGrid* grid)

     


      Complete the editing of the current cell. Returns true if the value has
      changed. If necessary, the control may be destroyed.
     
    
   
  
.SS void Reset ()

     


      Reset the value in the control back to its starting value.
     
    
   
  
.SS 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.
     
    
   
  
.SS void StartingClick ()

     


      If the editor is enabled by clicking on the cell, this method will be
      called.
     
    
   
  
.SS void HandleReturn (wxKeyEvent& event)

     


      Some types of controls on some platforms may need some help with the
      Return key.
     
    
   
  
.SS void Destroy ()

     


      Final cleanup.
     
    
   
  
.SS wxGridCellEditor* Clone ()

     


      Create a new object which is the copy of this one.
     
    
   
  
.SS  ~wxGridCellEditor ()

     


      The dtor is private because only DecRef() can delete us.
     
    
 
.SH "SEE ALSO"

  wxGridCellWorker
 
  wxGridCellTextEditor
  , 
  wxGridCellFloatEditor
  , 
  wxGridCellBoolEditor
  , 
  wxGridCellNumberEditor
  , 
  wxGridCellChoiceEditor
 
.SH "AUTHORS"
Documentation content by Julian Smart, Robert Roebling, Vadim Zeitlin, Robin Dunn, et al

Conversion to manpage format by Arnout Engelen (http://bzzt.net), bugreports welcome.