docs/latex/wx/gridrend.tex

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