| 1 | % |
| 2 | % automatically generated by HelpGen from |
| 3 | % grid.h at 11/May/00 18:30:18 |
| 4 | % |
| 5 | |
| 6 | \section{\class{wxGridCellEditor}}\label{wxgridcelleditor} |
| 7 | |
| 8 | This class is responsible for providing and manipulating |
| 9 | the in-place edit controls for the grid. Instances of wxGridCellEditor |
| 10 | (actually, instances of derived classes since it is an abstract class) can be |
| 11 | associated with the cell attributes for individual cells, rows, columns, or |
| 12 | even for the entire grid. |
| 13 | |
| 14 | \wxheading{Derived from} |
| 15 | |
| 16 | wxGridCellWorker |
| 17 | |
| 18 | \wxheading{Data structures} |
| 19 | |
| 20 | \latexignore{\rtfignore{\wxheading{Members}}} |
| 21 | |
| 22 | \membersection{wxGridCellEditor::wxGridCellEditor}\label{wxgridcelleditorwxgridcelleditor} |
| 23 | |
| 24 | \func{}{wxGridCellEditor}{\void} |
| 25 | |
| 26 | \membersection{wxGridCellEditor::IsCreated}\label{wxgridcelleditoriscreated} |
| 27 | |
| 28 | \func{bool}{IsCreated}{\void} |
| 29 | |
| 30 | \membersection{wxGridCellEditor::Create}\label{wxgridcelleditorcreate} |
| 31 | |
| 32 | \func{void}{Create}{\param{wxWindow* }{parent}, \param{wxWindowID }{id}, \param{wxEvtHandler* }{evtHandler}} |
| 33 | |
| 34 | Creates the actual edit control. |
| 35 | |
| 36 | \membersection{wxGridCellEditor::SetSize}\label{wxgridcelleditorsetsize} |
| 37 | |
| 38 | \func{void}{SetSize}{\param{const wxRect\& }{rect}} |
| 39 | |
| 40 | Size and position the edit control. |
| 41 | |
| 42 | \membersection{wxGridCellEditor::Show}\label{wxgridcelleditorshow} |
| 43 | |
| 44 | \func{void}{Show}{\param{bool }{show}, \param{wxGridCellAttr* }{attr = NULL}} |
| 45 | |
| 46 | Show or hide the edit control, use the specified attributes to set |
| 47 | colours/fonts for it. |
| 48 | |
| 49 | \membersection{wxGridCellEditor::PaintBackground}\label{wxgridcelleditorpaintbackground} |
| 50 | |
| 51 | \func{void}{PaintBackground}{\param{const wxRect\& }{rectCell}, \param{wxGridCellAttr* }{attr}} |
| 52 | |
| 53 | Draws the part of the cell not occupied by the control: the base class |
| 54 | version just fills it with background colour from the attribute. |
| 55 | |
| 56 | \membersection{wxGridCellEditor::BeginEdit}\label{wxgridcelleditorbeginedit} |
| 57 | |
| 58 | \func{void}{BeginEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}} |
| 59 | |
| 60 | Fetch the value from the table and prepare the edit control |
| 61 | to begin editing. Set the focus to the edit control. |
| 62 | |
| 63 | \membersection{wxGridCellEditor::EndEdit}\label{wxgridcelleditorendedit} |
| 64 | |
| 65 | \func{bool}{EndEdit}{\param{int }{row}, \param{int }{col}, \param{wxGrid* }{grid}} |
| 66 | |
| 67 | Complete the editing of the current cell. Returns true if the value has |
| 68 | changed. If necessary, the control may be destroyed. |
| 69 | |
| 70 | \membersection{wxGridCellEditor::Reset}\label{wxgridcelleditorreset} |
| 71 | |
| 72 | \func{void}{Reset}{\void} |
| 73 | |
| 74 | Reset the value in the control back to its starting value. |
| 75 | |
| 76 | \membersection{wxGridCellEditor::StartingKey}\label{wxgridcelleditorstartingkey} |
| 77 | |
| 78 | \func{void}{StartingKey}{\param{wxKeyEvent\& }{event}} |
| 79 | |
| 80 | If the editor is enabled by pressing keys on the grid, |
| 81 | this will be called to let the editor do something about |
| 82 | that first key if desired. |
| 83 | |
| 84 | \membersection{wxGridCellEditor::StartingClick}\label{wxgridcelleditorstartingclick} |
| 85 | |
| 86 | \func{void}{StartingClick}{\void} |
| 87 | |
| 88 | If the editor is enabled by clicking on the cell, this method will be |
| 89 | called. |
| 90 | |
| 91 | \membersection{wxGridCellEditor::HandleReturn}\label{wxgridcelleditorhandlereturn} |
| 92 | |
| 93 | \func{void}{HandleReturn}{\param{wxKeyEvent\& }{event}} |
| 94 | |
| 95 | Some types of controls on some platforms may need some help |
| 96 | with the Return key. |
| 97 | |
| 98 | \membersection{wxGridCellEditor::Destroy}\label{wxgridcelleditordestroy} |
| 99 | |
| 100 | \func{void}{Destroy}{\void} |
| 101 | |
| 102 | Final cleanup. |
| 103 | |
| 104 | \membersection{wxGridCellEditor::Clone}\label{wxgridcelleditorclone} |
| 105 | |
| 106 | \constfunc{wxGridCellEditor*}{Clone}{\void} |
| 107 | |
| 108 | Create a new object which is the copy of this one. |
| 109 | |
| 110 | \membersection{wxGridCellEditor::\destruct{wxGridCellEditor}}\label{wxgridcelleditordtor} |
| 111 | |
| 112 | \func{}{\destruct{wxGridCellEditor}}{\void} |
| 113 | |
| 114 | The dtor is private because only DecRef() can delete us. |
| 115 | |