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