File: dataviewrenderer.tex

package info (click to toggle)
wxwidgets2.8 2.8.10.1-3
  • links: PTS, VCS
  • area: main
  • in suites: squeeze
  • size: 239,052 kB
  • ctags: 289,550
  • sloc: cpp: 1,838,857; xml: 396,717; python: 282,506; ansic: 126,171; makefile: 51,406; sh: 14,581; asm: 299; sql: 258; lex: 194; perl: 139; yacc: 128; pascal: 95; php: 39; lisp: 38; tcl: 24; haskell: 20; java: 18; cs: 18; erlang: 17; ruby: 16; ada: 9; ml: 9; csh: 9
file content (272 lines) | stat: -rw-r--r-- 8,315 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272

\section{\class{wxDataViewRenderer}}\label{wxdataviewrenderer}


This class is used by \helpref{wxDataViewCtrl}{wxdataviewctrl} to
render the individual cells. One instance of a renderer class is
owned by \helpref{wxDataViewColumn}{wxdataviewcolumn}. There is
a number of ready-to-use renderers provided:
\helpref{wxDataViewTextRenderer}{wxdataviewtextrenderer},
\helpref{wxDataViewToggleRenderer}{wxdataviewtogglerenderer},
\helpref{wxDataViewProgressRenderer}{wxdataviewprogressrenderer},
\helpref{wxDataViewBitmapRenderer}{wxdataviewbitmaprenderer},
\helpref{wxDataViewDateRenderer}{wxdataviewdaterenderer}.


Additionally, the user can write own renderers by deriving from
\helpref{wxDataViewCustomRenderer}{wxdataviewcustomrenderer}.

These flags control the behaviour of the renderer and they
are used for controlling in what mode the renderer shall
render its contents:

{\small
\begin{verbatim}
enum wxDataViewCellMode
{
    wxDATAVIEW_CELL_INERT,
    wxDATAVIEW_CELL_ACTIVATABLE,
    wxDATAVIEW_CELL_EDITABLE
};

enum wxDataViewCellRenderState
{
    wxDATAVIEW_CELL_SELECTED    = 1,
    wxDATAVIEW_CELL_PRELIT      = 2,
    wxDATAVIEW_CELL_INSENSITIVE = 4,
    wxDATAVIEW_CELL_FOCUSED     = 8
};
\end{verbatim}
}


\wxheading{Derived from}

\helpref{wxObject}{wxobject}

\wxheading{Include files}

<wx/dataview.h>


\membersection{wxDataViewRenderer::wxDataViewRenderer}\label{wxdataviewrendererwxdataviewrenderer}

\func{}{wxDataViewRenderer}{\param{const wxString\& }{varianttype}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}}

Constructor.

\membersection{wxDataViewRenderer::GetMode}\label{wxdataviewrenderergetmode}

\func{virtual wxDataViewCellMode}{GetMode}{\void}

Returns the cell mode.

\membersection{wxDataViewRenderer::GetOwner}\label{wxdataviewrenderergetowner}

\func{virtual wxDataViewColumn*}{GetOwner}{\void}

Returns pointer to the owning \helpref{wxDataViewColumn}{wxdataviewcolumn}.

\membersection{wxDataViewRenderer::GetValue}\label{wxdataviewrenderergetvalue}

\func{virtual bool}{GetValue}{\param{wxVariant\& }{value}}

This methods retrieves the value from the renderer in order to
transfer the value back to the data model. Returns {\it false}
on failure.

\membersection{wxDataViewRenderer::GetVariantType}\label{wxdataviewrenderergetvarianttype}

\func{virtual wxString}{GetVariantType}{\void}

Returns a string with the type of the \helpref{wxVariant}{wxvariant}
supported by this renderer.

\membersection{wxDataViewRenderer::SetOwner}\label{wxdataviewrenderersetowner}

\func{virtual void}{SetOwner}{\param{wxDataViewColumn* }{owner}}

Sets the owning \helpref{wxDataViewColumn}{wxdataviewcolumn}. This
is usually called from within wxDataViewColumn.

\membersection{wxDataViewRenderer::SetValue}\label{wxdataviewrenderersetvalue}

\func{virtual bool}{SetValue}{\param{const wxVariant\& }{value}}

Set the value of the renderer (and thus its cell) to {\it value}.
The internal code will then render this cell with this data.


\membersection{wxDataViewRenderer::Validate}\label{wxdataviewrenderervalidate}

\func{virtual bool}{Validate}{\param{wxVariant\& }{value}}

To be implemented.


\section{\class{wxDataViewTextRenderer}}\label{wxdataviewtextrenderer}

wxDataViewTextRenderer


\wxheading{Derived from}

\helpref{wxDataViewRenderer}{wxdataviewrenderer}

\wxheading{Include files}

<wx/dataview.h>


\membersection{wxDataViewTextRenderer::wxDataViewTextRenderer}\label{wxdataviewtextrendererwxdataviewtextrenderer}

\func{}{wxDataViewTextRenderer}{\param{const wxString\& }{varianttype = wxT("string")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}}



\section{\class{wxDataViewProgressRenderer}}\label{wxdataviewprogressrenderer}

wxDataViewProgressRenderer


\wxheading{Derived from}

\helpref{wxDataViewRenderer}{wxdataviewrenderer}

\wxheading{Include files}

<wx/dataview.h>


\membersection{wxDataViewProgressRenderer::wxDataViewProgressRenderer}\label{wxdataviewprogressrendererwxdataviewprogressrenderer}

\func{}{wxDataViewProgressRenderer}{\param{const wxString\& }{label = wxEmptyString}, \param{const wxString\& }{varianttype = wxT("long")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}}



\section{\class{wxDataViewToggleRenderer}}\label{wxdataviewtogglerenderer}

wxDataViewToggleRenderer

\wxheading{Derived from}

\helpref{wxDataViewRenderer}{wxdataviewrenderer}

\wxheading{Include files}

<wx/dataview.h>


\membersection{wxDataViewToggleRenderer::wxDataViewToggleRenderer}\label{wxdataviewtogglerendererwxdataviewtogglerenderer}

\func{}{wxDataViewToggleRenderer}{\param{const wxString\& }{varianttype = wxT("bool")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}}


\section{\class{wxDataViewBitmapRenderer}}\label{wxdataviewbitmaprenderer}

wxDataViewBitmapRenderer

\wxheading{Derived from}

\helpref{wxDataViewRenderer}{wxdataviewrenderer}

\wxheading{Include files}

<wx/dataview.h>


\membersection{wxDataViewBitmapRenderer::wxDataViewBitmapRenderer}\label{wxdataviewbitmaprendererwxdataviewbitmaprenderer}

\func{}{wxDataViewBitmapRenderer}{\param{const wxString\& }{varianttype = wxT("wxBitmap")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}}


\section{\class{wxDataViewDateRenderer}}\label{wxdataviewdaterenderer}

wxDataViewDateRenderer


\wxheading{Derived from}

\helpref{wxDataViewRenderer}{wxdataviewrenderer}

\wxheading{Include files}

<wx/dataview.h>

\membersection{wxDataViewDateRenderer::wxDataViewDateRenderer}\label{wxdataviewdaterendererwxdataviewdaterenderer}

\func{}{wxDataViewDateRenderer}{\param{const wxString\& }{varianttype = wxT("datetime")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_ACTIVATABLE}}


\section{\class{wxDataViewCustomRenderer}}\label{wxdataviewcustomrenderer}

wxDataViewCustomRenderer

\wxheading{Derived from}

\helpref{wxDataViewRenderer}{wxdataviewrenderer}

\wxheading{Include files}

<wx/dataview.h>

\membersection{wxDataViewCustomRenderer::wxDataViewCustomRenderer}\label{wxdataviewcustomrendererwxdataviewcustomrenderer}

\func{}{wxDataViewCustomRenderer}{\param{const wxString\& }{varianttype = wxT("string")}, \param{wxDataViewCellMode }{mode = wxDATAVIEW\_CELL\_INERT}, \param{bool }{no\_init = false}}

Constructor.

\membersection{wxDataViewCustomRenderer::\destruct{wxDataViewCustomRenderer}}\label{wxdataviewcustomrendererdtor}

\func{}{\destruct{wxDataViewCustomRenderer}}{\void}

Destructor.

\membersection{wxDataViewCustomRenderer::Activate}\label{wxdataviewcustomrendereractivate}

\func{virtual bool}{Activate}{\param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}}

Override this to react to double clicks or <ENTER>.

\membersection{wxDataViewCustomRenderer::GetDC}\label{wxdataviewcustomrenderergetdc}

\func{virtual wxDC*}{GetDC}{\void}

Create DC on request. Internal.


\membersection{wxDataViewCustomRenderer::GetSize}\label{wxdataviewcustomrenderergetsize}

\func{virtual wxSize}{GetSize}{\void}

Return size required to show content.


\membersection{wxDataViewCustomRenderer::LeftClick}\label{wxdataviewcustomrendererleftclick}

\func{virtual bool}{LeftClick}{\param{wxPoint }{cursor}, \param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}}

Overrride this to react to a left click.

\membersection{wxDataViewCustomRenderer::Render}\label{wxdataviewcustomrendererrender}

\func{virtual bool}{Render}{\param{wxRect }{cell}, \param{wxDC* }{dc}, \param{int }{state}}

Override this to render the cell. Before this is called,
\helpref{SetValue}{wxdataviewrenderersetvalue} was called
so that this instance knows what to render.

\membersection{wxDataViewCustomRenderer::RightClick}\label{wxdataviewcustomrendererrightclick}

\func{virtual bool}{RightClick}{\param{wxPoint }{cursor}, \param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}}

Overrride this to react to a right click.

\membersection{wxDataViewCustomRenderer::StartDrag}\label{wxdataviewcustomrendererstartdrag}

\func{virtual bool}{StartDrag}{\param{wxPoint }{cursor}, \param{wxRect }{cell}, \param{wxDataViewListModel* }{model}, \param{unsigned int }{col}, \param{unsigned int }{row}}

Overrride this to start a drag operation.