docs/latex/wx/gridtbl.tex

   1 \section{\class{wxGridTableBase}}\label{wxgridtablebase}
   2
   3 Grid table classes.
   4
   5 \wxheading{Derived from}
   6
   7 \helpref{wxObject}{wxobject}
   8
   9 \wxheading{Include files}
  10
  11 <wx/grid.h>
  12
  13 \wxheading{Library}
  14
  15 \helpref{wxAdv}{librarieslist}
  16
  17 \latexignore{\rtfignore{\wxheading{Members}}}
  18
  19 \membersection{wxGridTableBase::wxGridTableBase}\label{wxgridtablebasewxgridtablebase}
  20
  21 \func{}{wxGridTableBase}{\void}
  22
  23 \membersection{wxGridTableBase::\destruct{wxGridTableBase}}\label{wxgridtablebasedtor}
  24
  25 \func{}{\destruct{wxGridTableBase}}{\void}
  26
  27 \membersection{wxGridTableBase::GetNumberRows}\label{wxgridtablebasegetnumberrows}
  28
  29 \func{int}{GetNumberRows}{\void}
  30
  31 You must override these functions in a derived table class.
  32
  33 \membersection{wxGridTableBase::GetNumberCols}\label{wxgridtablebasegetnumbercols}
  34
  35 \func{int}{GetNumberCols}{\void}
  36
  37
  38 \membersection{wxGridTableBase::IsEmptyCell}\label{wxgridtablebaseisemptycell}
  39
  40 \func{bool}{IsEmptyCell}{\param{int }{row}, \param{int }{col}}
  41
  42
  43 \membersection{wxGridTableBase::GetValue}\label{wxgridtablebasegetvalue}
  44
  45 \func{wxString}{GetValue}{\param{int }{row}, \param{int }{col}}
  46
  47
  48 \membersection{wxGridTableBase::SetValue}\label{wxgridtablebasesetvalue}
  49
  50 \func{void}{SetValue}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{value}}
  51
  52
  53 \membersection{wxGridTableBase::GetTypeName}\label{wxgridtablebasegettypename}
  54
  55 \func{wxString}{GetTypeName}{\param{int }{row}, \param{int }{col}}
  56
  57 Data type determination and value access.
  58
  59 \membersection{wxGridTableBase::CanGetValueAs}\label{wxgridtablebasecangetvalueas}
  60
  61 \func{bool}{CanGetValueAs}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{typeName}}
  62
  63
  64 \membersection{wxGridTableBase::CanSetValueAs}\label{wxgridtablebasecansetvalueas}
  65
  66 \func{bool}{CanSetValueAs}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{typeName}}
  67
  68
  69 \membersection{wxGridTableBase::GetValueAsLong}\label{wxgridtablebasegetvalueaslong}
  70
  71 \func{long}{GetValueAsLong}{\param{int }{row}, \param{int }{col}}
  72
  73
  74 \membersection{wxGridTableBase::GetValueAsDouble}\label{wxgridtablebasegetvalueasdouble}
  75
  76 \func{double}{GetValueAsDouble}{\param{int }{row}, \param{int }{col}}
  77
  78
  79 \membersection{wxGridTableBase::GetValueAsBool}\label{wxgridtablebasegetvalueasbool}
  80
  81 \func{bool}{GetValueAsBool}{\param{int }{row}, \param{int }{col}}
  82
  83
  84 \membersection{wxGridTableBase::SetValueAsLong}\label{wxgridtablebasesetvalueaslong}
  85
  86 \func{void}{SetValueAsLong}{\param{int }{row}, \param{int }{col}, \param{long }{value}}
  87
  88
  89 \membersection{wxGridTableBase::SetValueAsDouble}\label{wxgridtablebasesetvalueasdouble}
  90
  91 \func{void}{SetValueAsDouble}{\param{int }{row}, \param{int }{col}, \param{double }{value}}
  92
  93
  94 \membersection{wxGridTableBase::SetValueAsBool}\label{wxgridtablebasesetvalueasbool}
  95
  96 \func{void}{SetValueAsBool}{\param{int }{row}, \param{int }{col}, \param{bool }{value}}
  97
  98
  99 \membersection{wxGridTableBase::GetValueAsCustom}\label{wxgridtablebasegetvalueascustom}
 100
 101 \func{void*}{GetValueAsCustom}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{typeName}}
 102
 103 For user defined types
 104
 105
 106 \membersection{wxGridTableBase::SetValueAsCustom}\label{wxgridtablebasesetvalueascustom}
 107
 108 \func{void}{SetValueAsCustom}{\param{int }{row}, \param{int }{col}, \param{const wxString\& }{typeName}, \param{void* }{value}}
 109
 110
 111 \membersection{wxGridTableBase::SetView}\label{wxgridtablebasesetview}
 112
 113 \func{void}{SetView}{\param{wxGrid* }{grid}}
 114
 115 Overriding these is optional
 116
 117
 118 \membersection{wxGridTableBase::GetView}\label{wxgridtablebasegetview}
 119
 120 \constfunc{wxGrid *}{GetView}{\void}
 121
 122
 123 \membersection{wxGridTableBase::Clear}\label{wxgridtablebaseclear}
 124
 125 \func{void}{Clear}{\void}
 126
 127
 128 \membersection{wxGridTableBase::InsertRows}\label{wxgridtablebaseinsertrows}
 129
 130 \func{bool}{InsertRows}{\param{size\_t }{pos = 0}, \param{size\_t }{numRows = 1}}
 131
 132
 133 \membersection{wxGridTableBase::AppendRows}\label{wxgridtablebaseappendrows}
 134
 135 \func{bool}{AppendRows}{\param{size\_t }{numRows = 1}}
 136
 137
 138 \membersection{wxGridTableBase::DeleteRows}\label{wxgridtablebasedeleterows}
 139
 140 \func{bool}{DeleteRows}{\param{size\_t }{pos = 0}, \param{size\_t }{numRows = 1}}
 141
 142
 143 \membersection{wxGridTableBase::InsertCols}\label{wxgridtablebaseinsertcols}
 144
 145 \func{bool}{InsertCols}{\param{size\_t }{pos = 0}, \param{size\_t }{numCols = 1}}
 146
 147
 148 \membersection{wxGridTableBase::AppendCols}\label{wxgridtablebaseappendcols}
 149
 150 \func{bool}{AppendCols}{\param{size\_t }{numCols = 1}}
 151
 152
 153 \membersection{wxGridTableBase::DeleteCols}\label{wxgridtablebasedeletecols}
 154
 155 \func{bool}{DeleteCols}{\param{size\_t }{pos = 0}, \param{size\_t }{numCols = 1}}
 156
 157
 158 \membersection{wxGridTableBase::GetRowLabelValue}\label{wxgridtablebasegetrowlabelvalue}
 159
 160 \func{wxString}{GetRowLabelValue}{\param{int }{row}}
 161
 162
 163 \membersection{wxGridTableBase::GetColLabelValue}\label{wxgridtablebasegetcollabelvalue}
 164
 165 \func{wxString}{GetColLabelValue}{\param{int }{col}}
 166
 167
 168 \membersection{wxGridTableBase::SetRowLabelValue}\label{wxgridtablebasesetrowlabelvalue}
 169
 170 \func{void}{SetRowLabelValue}{\param{int }{WXUNUSED(row)}, \param{const }{wxString\&}}
 171
 172
 173 \membersection{wxGridTableBase::SetColLabelValue}\label{wxgridtablebasesetcollabelvalue}
 174
 175 \func{void}{SetColLabelValue}{\param{int }{WXUNUSED(col)}, \param{const }{wxString\&}}
 176
 177
 178 \membersection{wxGridTableBase::SetAttrProvider}\label{wxgridtablebasesetattrprovider}
 179
 180 \func{void}{SetAttrProvider}{\param{wxGridCellAttrProvider* }{attrProvider}}
 181
 182 Attribute handling
 183 give us the attr provider to use - we take ownership of the pointer
 184
 185
 186 \membersection{wxGridTableBase::GetAttrProvider}\label{wxgridtablebasegetattrprovider}
 187
 188 \constfunc{wxGridCellAttrProvider*}{GetAttrProvider}{\void}
 189
 190 get the currently used attr provider (may be NULL)
 191
 192
 193 \membersection{wxGridTableBase::CanHaveAttributes}\label{wxgridtablebasecanhaveattributes}
 194
 195 \func{bool}{CanHaveAttributes}{\void}
 196
 197 Does this table allow attributes?  Default implementation creates
 198 a wxGridCellAttrProvider if necessary.
 199
 200
 201 \membersection{wxGridTableBase::UpdateAttrRows}\label{wxgridtablebaseupdateattrrows}
 202
 203 \func{void}{UpdateAttrRows}{\param{size\_t }{pos}, \param{int }{numRows}}
 204
 205 change row/col number in attribute if needed
 206
 207
 208 \membersection{wxGridTableBase::UpdateAttrCols}\label{wxgridtablebaseupdateattrcols}
 209
 210 \func{void}{UpdateAttrCols}{\param{size\_t }{pos}, \param{int }{numCols}}
 211
 212
 213 \membersection{wxGridTableBase::GetAttr}\label{wxgridtablebasegetattr}
 214
 215 \func{wxGridCellAttr*}{GetAttr}{\param{int }{row}, \param{int }{col}}
 216
 217 by default forwarded to wxGridCellAttrProvider if any. May be
 218 overridden to handle attributes directly in the table.
 219
 220
 221 \membersection{wxGridTableBase::SetAttr}\label{wxgridtablebasesetattr}
 222
 223 \func{void}{SetAttr}{\param{wxGridCellAttr* }{attr}, \param{int }{row}, \param{int }{col}}
 224
 225 these functions take ownership of the pointer
 226
 227
 228 \membersection{wxGridTableBase::SetRowAttr}\label{wxgridtablebasesetrowattr}
 229
 230 \func{void}{SetRowAttr}{\param{wxGridCellAttr* }{attr}, \param{int }{row}}
 231
 232
 233 \membersection{wxGridTableBase::SetColAttr}\label{wxgridtablebasesetcolattr}
 234
 235 \func{void}{SetColAttr}{\param{wxGridCellAttr* }{attr}, \param{int }{col}}
 236