docs/latex/wx/gridrend.tex

   1 \section{\class{wxGridCellBoolRenderer}}\label{wxgridcellboolrenderer}
   2
   3 This class may be used to format boolean data in a cell.
   4 for string cells.
   5
   6 \wxheading{Derived from}
   7
   8 \helpref{wxGridCellRenderer}{wxgridcellrenderer}
   9
  10 \wxheading{See also}
  11
  12 \helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
  13 \helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
  14 \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
  15 \helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer}
  16
  17 \wxheading{Include files}
  18
  19 <wx/grid.h>
  20
  21 \latexignore{\rtfignore{\wxheading{Members}}}
  22
  23 \membersection{wxGridCellBoolRenderer::wxGridCellBoolRenderer}\label{wxgridcellboolrendererconstr}
  24
  25 \func{}{wxGridCellBoolRenderer}{}
  26
  27 Default constructor
  28
  29
  30
  31 \section{\class{wxGridCellFloatRenderer}}\label{wxgridcellfloatrenderer}
  32
  33 This class may be used to format floating point data in a cell.
  34
  35 \wxheading{Derived from}
  36
  37 \helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer}\\
  38 \helpref{wxGridCellRenderer}{wxgridcellrenderer}
  39
  40 \wxheading{See also}
  41
  42 \helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
  43 \helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer},\rtfsp
  44 \helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
  45 \helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
  46
  47 \wxheading{Include files}
  48
  49 <wx/grid.h>
  50
  51 \latexignore{\rtfignore{\wxheading{Members}}}
  52
  53 \membersection{wxGridCellFloatRenderer::wxGridCellFloatRenderer}\label{wxgridcellfloatrendererconstr}
  54
  55 \func{}{wxGridCellFloatRenderer}{\param{int }{width = -1}, \param{int }{precision = -1}}
  56
  57 \docparam{width}{Minimum number of characters to be shown.}
  58 \docparam{precision}{Number of digits after the decimal dot.}
  59
  60 \membersection{wxGridCellFloatRenderer::GetPrecision}\label{wxgridcellfloatrenderergetprecision}
  61
  62 \constfunc{int}{GetPrecision}{\void}
  63
  64 Returns the precision ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).
  65
  66 \membersection{wxGridCellFloatRenderer::GetWidth}\label{wxgridcellfloatrenderergetwidth}
  67
  68 \constfunc{int}{GetWidth}{\void}
  69
  70 Returns the width ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).
  71
  72 \membersection{wxGridCellFloatRenderer::SetParameters}\label{wxgridcellfloatrenderersetparameters}
  73
  74 \func{void}{SetParameters}{\param{const wxString\& }{params}}
  75
  76 Parameters string format is "width[,precision]".
  77
  78 \membersection{wxGridCellFloatRenderer::SetPrecision}\label{wxgridcellfloatrenderersetprecision}
  79
  80 \func{void}{SetPrecision}{\param{int }{precision}}
  81
  82 Sets the precision ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).
  83
  84 \membersection{wxGridCellFloatRenderer::SetWidth}\label{wxgridcellfloatrenderersetwidth}
  85
  86 \func{void}{SetWidth}{\param{int }{width}}
  87
  88 Sets the width ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} )
  89
  90
  91
  92 \section{\class{wxGridCellNumberRenderer}}\label{wxgridcellnumberrenderer}
  93
  94 This class may be used to format integer data in a cell.
  95
  96 \wxheading{Derived from}
  97
  98 \helpref{wxGridellStringRenderer}{wxgridcellstringrenderer}\\
  99 \helpref{wxGridCellRenderer}{wxgridcellrenderer}
 100
 101 \wxheading{See also}
 102
 103 \helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
 104 \helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
 105 \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
 106 \helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
 107
 108 \wxheading{Include files}
 109
 110 <wx/grid.h>
 111
 112 \latexignore{\rtfignore{\wxheading{Members}}}
 113
 114 \membersection{wxGridCellNumberRenderer::wxGridCellNumberRenderer}\label{wxgridcellnumberrendererconstr}
 115
 116 \func{}{wxGridCellNumberRenderer}{}
 117
 118 Default constructor
 119
 120 \section{\class{wxGridCellRenderer}}\label{wxgridcellrenderer}
 121
 122 This class is responsible for actually drawing the cell
 123 in the grid. You may pass it to the wxGridCellAttr (below) to change the
 124 format of one given cell or to wxGrid::SetDefaultRenderer() to change the
 125 view of all cells. This is an abstract class, and you will normally use one of the
 126 predefined derived classes or derive your own class from it.
 127
 128 \wxheading{Derived from}
 129
 130 wxGridCellWorker
 131
 132 \wxheading{See also}
 133
 134 \helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
 135 \helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer},\rtfsp
 136 \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
 137 \helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
 138
 139 \wxheading{Include files}
 140
 141 <wx/grid.h>
 142
 143 \latexignore{\rtfignore{\wxheading{Members}}}
 144
 145 \membersection{wxGridCellRenderer::Draw}\label{wxgridcellrendererdraw}
 146
 147 \func{void}{Draw}{\param{wxGrid\& }{grid}, \param{wxGridCellAttr\& }{attr}, \param{wxDC\& }{dc}, \param{const wxRect\& }{rect}, \param{int }{row}, \param{int }{col}, \param{bool }{isSelected}}
 148
 149 Draw the given cell on the provided DC inside the given rectangle
 150 using the style specified by the attribute and the default or selected
 151 state corresponding to the isSelected value.
 152
 153 This pure virtual function has a default implementation which will
 154 prepare the DC using the given attribute: it will draw the rectangle
 155 with the background colour from attr and set the text colour and font.
 156
 157 \membersection{wxGridCellRenderer::GetBestSize}\label{wxgridcellrenderergetbestsize}
 158
 159 \func{wxSize}{GetBestSize}{\param{wxGrid\& }{grid}, \param{wxGridCellAttr\& }{attr}, \param{wxDC\& }{dc}, \param{int }{row}, \param{int }{col}}
 160
 161 Get the preferred size of the cell for its contents.
 162
 163 \membersection{wxGridCellRenderer::Clone}\label{wxgridcellrendererclone}
 164
 165 \constfunc{wxGridCellRenderer*}{Clone}{\void}
 166
 167 \section{\class{wxGridCellStringRenderer}}\label{wxgridcellstringrenderer}
 168
 169 This class may be used to format string data in a cell; it is the default
 170 for string cells.
 171
 172 \wxheading{Derived from}
 173
 174 \helpref{wxGridCellRenderer}{wxgridcellrenderer}
 175
 176 \wxheading{See also}
 177
 178 \helpref{wxGridCellRenderer}{wxgridcellrenderer},\rtfsp
 179 \helpref{wxGridCellNumberRenderer}{wxgridcellnumberrenderer},\rtfsp
 180 \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrenderer},\rtfsp
 181 \helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
 182
 183 \wxheading{Include files}
 184
 185 <wx/grid.h>
 186
 187 \latexignore{\rtfignore{\wxheading{Members}}}
 188
 189 \membersection{wxGridCellStringRenderer::wxGridCellStringRenderer}\label{wxgridcellstringrendererconstr}
 190
 191 \func{}{wxGridCellStringRenderer}{}
 192
 193 Default constructor
 194
 195