]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/gridrend.tex
silence gcc warnings about values not handled in switch
[wxWidgets.git] / docs / latex / wx / gridrend.tex
CommitLineData
cbc95b2c
MB
1\section{\class{wxGridCellBoolRenderer}}\label{wxgridcellboolrenderer}
2
3This class may be used to format boolean data in a cell.
4for 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
0e10e38d
VZ
17\wxheading{Include files}
18
19<wx/grid.h>
20
cbc95b2c
MB
21\latexignore{\rtfignore{\wxheading{Members}}}
22
23\membersection{wxGridCellBoolRenderer::wxGridCellBoolRenderer}\label{wxgridcellboolrendererconstr}
24
25\func{}{wxGridCellBoolRenderer}{}
26
27Default constructor
28
29
30
31\section{\class{wxGridCellFloatRenderer}}\label{wxgridcellfloatrenderer}
32
33This 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
e676441f 44\helpref{wxGridCellStringRenderer}{wxgridcellstringrenderer},\rtfsp
cbc95b2c
MB
45\helpref{wxGridCellBoolRenderer}{wxgridcellboolrenderer}
46
0e10e38d
VZ
47\wxheading{Include files}
48
49<wx/grid.h>
50
cbc95b2c
MB
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
64Returns the precision ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).
65
66\membersection{wxGridCellFloatRenderer::GetWidth}\label{wxgridcellfloatrenderergetwidth}
67
68\constfunc{int}{GetWidth}{\void}
69
70Returns the width ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).
71
72\membersection{wxGridCellFloatRenderer::SetParameters}\label{wxgridcellfloatrenderersetparameters}
73
74\func{void}{SetParameters}{\param{const wxString\& }{params}}
75
76Parameters string format is "width[,precision]".
77
78\membersection{wxGridCellFloatRenderer::SetPrecision}\label{wxgridcellfloatrenderersetprecision}
79
80\func{void}{SetPrecision}{\param{int }{precision}}
81
82Sets the precision ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} ).
83
84\membersection{wxGridCellFloatRenderer::SetWidth}\label{wxgridcellfloatrenderersetwidth}
85
86\func{void}{SetWidth}{\param{int }{width}}
87
88Sets the width ( see \helpref{wxGridCellFloatRenderer}{wxgridcellfloatrendererconstr} )
89
90
91
92\section{\class{wxGridCellNumberRenderer}}\label{wxgridcellnumberrenderer}
93
94This 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
0e10e38d
VZ
108\wxheading{Include files}
109
110<wx/grid.h>
111
cbc95b2c
MB
112\latexignore{\rtfignore{\wxheading{Members}}}
113
114\membersection{wxGridCellNumberRenderer::wxGridCellNumberRenderer}\label{wxgridcellnumberrendererconstr}
115
116\func{}{wxGridCellNumberRenderer}{}
117
118Default constructor
119
f3845e88
VZ
120\section{\class{wxGridCellRenderer}}\label{wxgridcellrenderer}
121
122This class is responsible for actually drawing the cell
123in the grid. You may pass it to the wxGridCellAttr (below) to change the
124format of one given cell or to wxGrid::SetDefaultRenderer() to change the
125view of all cells. This is an abstract class, and you will normally use one of the
126predefined derived classes or derive your own class from it.
127
128\wxheading{Derived from}
129
130wxGridCellWorker
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
0e10e38d
VZ
139\wxheading{Include files}
140
141<wx/grid.h>
142
f3845e88
VZ
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
149Draw the given cell on the provided DC inside the given rectangle
150using the style specified by the attribute and the default or selected
151state corresponding to the isSelected value.
152
153This pure virtual function has a default implementation which will
154prepare the DC using the given attribute: it will draw the rectangle
155with 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
161Get the preferred size of the cell for its contents.
162
163\membersection{wxGridCellRenderer::Clone}\label{wxgridcellrendererclone}
164
165\constfunc{wxGridCellRenderer*}{Clone}{\void}
cbc95b2c
MB
166
167\section{\class{wxGridCellStringRenderer}}\label{wxgridcellstringrenderer}
168
169This class may be used to format string data in a cell; it is the default
170for 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
0e10e38d
VZ
183\wxheading{Include files}
184
185<wx/grid.h>
186
cbc95b2c
MB
187\latexignore{\rtfignore{\wxheading{Members}}}
188
189\membersection{wxGridCellStringRenderer::wxGridCellStringRenderer}\label{wxgridcellstringrendererconstr}
190
191\func{}{wxGridCellStringRenderer}{}
192
193Default constructor
194
195