File: QwtLegendData.3

package info (click to toggle)
qwt 6.1.2-6
  • links: PTS, VCS
  • area: main
  • in suites: stretch
  • size: 23,848 kB
  • ctags: 15,811
  • sloc: cpp: 57,382; makefile: 41
file content (217 lines) | stat: -rw-r--r-- 3,983 bytes parent folder | download
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
.TH "QwtLegendData" 3 "Thu Dec 11 2014" "Version 6.1.2" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtLegendData \- 
.PP
Attributes of an entry on a legend\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_legend_data\&.h>\fP
.SS "Public Types"

.in +1c
.ti -1c
.RI "enum \fBMode\fP { \fBReadOnly\fP, \fBClickable\fP, \fBCheckable\fP }"
.br
.RI "\fIMode defining how a legend entry interacts\&. \fP"
.ti -1c
.RI "enum \fBRole\fP { \fBModeRole\fP, \fBTitleRole\fP, \fBIconRole\fP, \fBUserRole\fP = 32 }"
.br
.RI "\fIIdentifier how to interprete a QVariant\&. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtLegendData\fP ()"
.br
.RI "\fIConstructor\&. \fP"
.ti -1c
.RI "\fB~QwtLegendData\fP ()"
.br
.RI "\fIDestructor\&. \fP"
.ti -1c
.RI "void \fBsetValues\fP (const QMap< int, QVariant > &)"
.br
.ti -1c
.RI "const QMap< int, QVariant > & \fBvalues\fP () const "
.br
.ti -1c
.RI "void \fBsetValue\fP (int role, const QVariant &)"
.br
.ti -1c
.RI "QVariant \fBvalue\fP (int role) const "
.br
.ti -1c
.RI "bool \fBhasRole\fP (int role) const "
.br
.ti -1c
.RI "bool \fBisValid\fP () const "
.br
.ti -1c
.RI "\fBQwtGraphic\fP \fBicon\fP () const "
.br
.ti -1c
.RI "\fBQwtText\fP \fBtitle\fP () const "
.br
.ti -1c
.RI "\fBMode\fP \fBmode\fP () const "
.br
.in -1c
.SH "Detailed Description"
.PP 
Attributes of an entry on a legend\&. 

\fBQwtLegendData\fP is an abstract container ( like QAbstractModel ) to exchange attributes, that are only known between to the plot item and the legend\&.
.PP
By overloading \fBQwtPlotItem::legendData()\fP any other set of attributes could be used, that can be handled by a modified ( or completely different ) implementation of a legend\&.
.PP
\fBSee Also:\fP
.RS 4
\fBQwtLegend\fP, \fBQwtPlotLegendItem\fP 
.RE
.PP
\fBNote:\fP
.RS 4
The stockchart example implements a legend as a tree with checkable items 
.RE
.PP

.SH "Member Enumeration Documentation"
.PP 
.SS "enum \fBQwtLegendData::Mode\fP"

.PP
Mode defining how a legend entry interacts\&. 
.PP
\fBEnumerator\fP
.in +1c
.TP
\fB\fIReadOnly \fP\fP
The legend item is not interactive, like a label\&. 
.TP
\fB\fIClickable \fP\fP
The legend item is clickable, like a push button\&. 
.TP
\fB\fICheckable \fP\fP
The legend item is checkable, like a checkable button\&. 
.SH "Member Function Documentation"
.PP 
.SS "bool QwtLegendData::hasRole (introle) const"

.PP
\fBParameters:\fP
.RS 4
\fIrole\fP Attribute role 
.RE
.PP
\fBReturns:\fP
.RS 4
True, when the internal map has an entry for role 
.RE
.PP

.SS "\fBQwtGraphic\fP QwtLegendData::icon () const"

.PP
\fBReturns:\fP
.RS 4
Value of the IconRole attribute 
.RE
.PP

.SS "bool QwtLegendData::isValid () const"

.PP
\fBReturns:\fP
.RS 4
True, when the internal map is empty 
.RE
.PP

.SS "\fBQwtLegendData::Mode\fP QwtLegendData::mode () const"

.PP
\fBReturns:\fP
.RS 4
Value of the ModeRole attribute 
.RE
.PP

.SS "void QwtLegendData::setValue (introle, const QVariant &data)"
Set an attribute value
.PP
\fBParameters:\fP
.RS 4
\fIrole\fP Attribute role 
.br
\fIdata\fP Attribute value
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBvalue()\fP 
.RE
.PP

.SS "void QwtLegendData::setValues (const QMap< int, QVariant > &map)"
Set the legend attributes
.PP
\fBQwtLegendData\fP actually is a QMap<int, QVariant> with some convenience interfaces
.PP
\fBParameters:\fP
.RS 4
\fImap\fP Values 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBvalues()\fP 
.RE
.PP

.SS "\fBQwtText\fP QwtLegendData::title () const"

.PP
\fBReturns:\fP
.RS 4
Value of the TitleRole attribute 
.RE
.PP

.SS "QVariant QwtLegendData::value (introle) const"

.PP
\fBParameters:\fP
.RS 4
\fIrole\fP Attribute role 
.RE
.PP
\fBReturns:\fP
.RS 4
Attribute value for a specific role 
.RE
.PP

.SS "const QMap< int, QVariant > & QwtLegendData::values () const"

.PP
\fBReturns:\fP
.RS 4
Legend attributes 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetValues()\fP 
.RE
.PP


.SH "Author"
.PP 
Generated automatically by Doxygen for Qwt User's Guide from the source code\&.