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