File: QwtCompassScaleDraw.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 (135 lines) | stat: -rw-r--r-- 2,900 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
.TH "QwtCompassScaleDraw" 3 "Thu Dec 11 2014" "Version 6.1.2" "Qwt User's Guide" \" -*- nroff -*-
.ad l
.nh
.SH NAME
QwtCompassScaleDraw \- 
.PP
A special scale draw made for \fBQwtCompass\fP\&.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <qwt_compass\&.h>\fP
.PP
Inherits \fBQwtRoundScaleDraw\fP\&.
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBQwtCompassScaleDraw\fP ()"
.br
.RI "\fIConstructor\&. \fP"
.ti -1c
.RI "\fBQwtCompassScaleDraw\fP (const QMap< double, QString > &map)"
.br
.RI "\fIConstructor\&. \fP"
.ti -1c
.RI "void \fBsetLabelMap\fP (const QMap< double, QString > &map)"
.br
.RI "\fISet a map, mapping values to labels\&. \fP"
.ti -1c
.RI "QMap< double, QString > \fBlabelMap\fP () const "
.br
.ti -1c
.RI "virtual \fBQwtText\fP \fBlabel\fP (double value) const "
.br
.in -1c
.SS "Additional Inherited Members"
.SH "Detailed Description"
.PP 
A special scale draw made for \fBQwtCompass\fP\&. 

\fBQwtCompassScaleDraw\fP maps values to strings using a special map, that can be modified by the application
.PP
The default map consists of the labels N, NE, E, SE, S, SW, W, NW\&.
.PP
\fBSee Also:\fP
.RS 4
\fBQwtCompass\fP 
.RE
.PP

.SH "Constructor & Destructor Documentation"
.PP 
.SS "QwtCompassScaleDraw::QwtCompassScaleDraw ()\fC [explicit]\fP"

.PP
Constructor\&. Initializes a label map for multiples of 45 degrees 
.SS "QwtCompassScaleDraw::QwtCompassScaleDraw (const QMap< double, QString > &map)\fC [explicit]\fP"

.PP
Constructor\&. 
.PP
\fBParameters:\fP
.RS 4
\fImap\fP Value to label map 
.RE
.PP

.SH "Member Function Documentation"
.PP 
.SS "\fBQwtText\fP QwtCompassScaleDraw::label (doublevalue) const\fC [virtual]\fP"
Map a value to a corresponding label
.PP
\fBParameters:\fP
.RS 4
\fIvalue\fP Value that will be mapped
.RE
.PP
\fBlabel()\fP looks in the \fBlabelMap()\fP for a corresponding label for value or returns an null text\&.
.PP
\fBReturns:\fP
.RS 4
Label, or QString::null 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBlabelMap()\fP, \fBsetLabelMap()\fP 
.RE
.PP

.PP
Reimplemented from \fBQwtAbstractScaleDraw\fP\&.
.SS "QMap< double, QString > QwtCompassScaleDraw::labelMap () const"

.PP
\fBReturns:\fP
.RS 4
map, mapping values to labels 
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBsetLabelMap()\fP 
.RE
.PP

.SS "void QwtCompassScaleDraw::setLabelMap (const QMap< double, QString > &map)"

.PP
Set a map, mapping values to labels\&. 
.PP
\fBParameters:\fP
.RS 4
\fImap\fP Value to label map
.RE
.PP
The values of the major ticks are found by looking into this map\&. The default map consists of the labels N, NE, E, SE, S, SW, W, NW\&.
.PP
\fBWarning:\fP
.RS 4
The map will have no effect for values that are no major tick values\&. Major ticks can be changed by QwtScaleDraw::setScale
.RE
.PP
\fBSee Also:\fP
.RS 4
\fBlabelMap()\fP, scaleDraw(), setScale() 
.RE
.PP


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