docs/latex/wx/gridedit.tex

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