~ubuntu-branches/ubuntu/oneiric/qwt/oneiric-proposed

« back to all changes in this revision

Viewing changes to qwt-5.1.2/doc/man/man3/QwtArrowButton.3

  • Committer: Bazaar Package Importer
  • Author(s): Fathi Boudra
  • Date: 2009-04-12 23:25:58 UTC
  • mfrom: (1.1.4 upstream) (2.1.2 squeeze)
  • Revision ID: james.westby@ubuntu.com-20090412232558-3bl06x785yr8xm8u
Tags: 5.1.2-1
* New upstream release.
* Bump compat/debhelper to 7.
* Bump Standards-Version to 3.8.1. No changes needed.
* Invert Maintainers and Uploaders field.
* Fix lintian warnings:
  - dh_clean _k deprecated.
  - missing dependency on libc.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.TH "QwtArrowButton" 3 "22 Mar 2009" "Version 5.1.2" "Qwt User's Guide" \" -*- nroff -*-
 
2
.ad l
 
3
.nh
 
4
.SH NAME
 
5
QwtArrowButton \- 
 
6
.SH SYNOPSIS
 
7
.br
 
8
.PP
 
9
.SH "Detailed Description"
 
10
.PP 
 
11
Arrow Button. 
 
12
 
 
13
A push button with one or more filled triangles on its front. An Arrow button can have 1 to 3 arrows in a row, pointing up, down, left or right. 
 
14
.PP
 
15
Definition at line 23 of file qwt_arrow_button.h.
 
16
.SS "Public Member Functions"
 
17
 
 
18
.in +1c
 
19
.ti -1c
 
20
.RI "\fBQwtArrowButton\fP (int num, Qt::ArrowType, QWidget *parent=NULL)"
 
21
.br
 
22
.ti -1c
 
23
.RI "virtual \fB~QwtArrowButton\fP ()"
 
24
.br
 
25
.ti -1c
 
26
.RI "Qt::ArrowType \fBarrowType\fP () const"
 
27
.br
 
28
.ti -1c
 
29
.RI "int \fBnum\fP () const"
 
30
.br
 
31
.ti -1c
 
32
.RI "virtual QSize \fBsizeHint\fP () const"
 
33
.br
 
34
.ti -1c
 
35
.RI "virtual QSize \fBminimumSizeHint\fP () const"
 
36
.br
 
37
.in -1c
 
38
.SS "Protected Member Functions"
 
39
 
 
40
.in +1c
 
41
.ti -1c
 
42
.RI "virtual void \fBpaintEvent\fP (QPaintEvent *event)"
 
43
.br
 
44
.ti -1c
 
45
.RI "virtual void \fBdrawButtonLabel\fP (QPainter *p)"
 
46
.br
 
47
.ti -1c
 
48
.RI "virtual void \fBdrawArrow\fP (QPainter *, const QRect &, Qt::ArrowType) const"
 
49
.br
 
50
.ti -1c
 
51
.RI "virtual QRect \fBlabelRect\fP () const"
 
52
.br
 
53
.ti -1c
 
54
.RI "virtual QSize \fBarrowSize\fP (Qt::ArrowType, const QSize &boundingSize) const"
 
55
.br
 
56
.ti -1c
 
57
.RI "virtual void \fBkeyPressEvent\fP (QKeyEvent *)"
 
58
.br
 
59
.in -1c
 
60
.SH "Constructor & Destructor Documentation"
 
61
.PP 
 
62
.SS "QwtArrowButton::QwtArrowButton (int num, Qt::ArrowType arrowType, QWidget * parent = \fCNULL\fP)\fC [explicit]\fP"
 
63
.PP
 
64
\fBParameters:\fP
 
65
.RS 4
 
66
\fInum\fP Number of arrows 
 
67
.br
 
68
\fIarrowType\fP see Qt::ArowType in the Qt docs. 
 
69
.br
 
70
\fIparent\fP Parent widget 
 
71
.RE
 
72
.PP
 
73
 
 
74
.PP
 
75
Definition at line 58 of file qwt_arrow_button.cpp.
 
76
.SS "QwtArrowButton::~QwtArrowButton ()\fC [virtual]\fP"
 
77
.PP
 
78
Destructor. 
 
79
.PP
 
80
Definition at line 83 of file qwt_arrow_button.cpp.
 
81
.SH "Member Function Documentation"
 
82
.PP 
 
83
.SS "Qt::ArrowType QwtArrowButton::arrowType () const"
 
84
.PP
 
85
The direction of the arrows. 
 
86
.PP
 
87
Definition at line 92 of file qwt_arrow_button.cpp.
 
88
.SS "int QwtArrowButton::num () const"
 
89
.PP
 
90
The number of arrows. 
 
91
.PP
 
92
Definition at line 100 of file qwt_arrow_button.cpp.
 
93
.SS "QSize QwtArrowButton::sizeHint () const\fC [virtual]\fP"
 
94
.PP
 
95
\fBReturns:\fP
 
96
.RS 4
 
97
a size hint 
 
98
.RE
 
99
.PP
 
100
 
 
101
.PP
 
102
Definition at line 286 of file qwt_arrow_button.cpp.
 
103
.PP
 
104
References minimumSizeHint().
 
105
.SS "QSize QwtArrowButton::minimumSizeHint () const\fC [virtual]\fP"
 
106
.PP
 
107
Return a minimum size hint. 
 
108
.PP
 
109
Definition at line 294 of file qwt_arrow_button.cpp.
 
110
.PP
 
111
References arrowSize().
 
112
.PP
 
113
Referenced by sizeHint().
 
114
.SS "void QwtArrowButton::paintEvent (QPaintEvent * event)\fC [protected, virtual]\fP"
 
115
.PP
 
116
Paint event handler 
 
117
.PP
 
118
\fBParameters:\fP
 
119
.RS 4
 
120
\fIevent\fP Paint event 
 
121
.RE
 
122
.PP
 
123
 
 
124
.PP
 
125
Definition at line 143 of file qwt_arrow_button.cpp.
 
126
.PP
 
127
References drawButtonLabel().
 
128
.SS "void QwtArrowButton::drawButtonLabel (QPainter * painter)\fC [protected, virtual]\fP"
 
129
.PP
 
130
Draw the button label. 
 
131
.PP
 
132
\fBParameters:\fP
 
133
.RS 4
 
134
\fIpainter\fP Painter 
 
135
.RE
 
136
.PP
 
137
\fBSee also:\fP
 
138
.RS 4
 
139
The Qt Manual on QPushButton 
 
140
.RE
 
141
.PP
 
142
 
 
143
.PP
 
144
Definition at line 157 of file qwt_arrow_button.cpp.
 
145
.PP
 
146
References arrowSize(), drawArrow(), and labelRect().
 
147
.PP
 
148
Referenced by paintEvent().
 
149
.SS "void QwtArrowButton::drawArrow (QPainter * painter, const QRect & r, Qt::ArrowType arrowType) const\fC [protected, virtual]\fP"
 
150
.PP
 
151
Draw an arrow int a bounding rect
 
152
.PP
 
153
\fBParameters:\fP
 
154
.RS 4
 
155
\fIpainter\fP Painter 
 
156
.br
 
157
\fIr\fP Rectangle where to paint the arrow 
 
158
.br
 
159
\fIarrowType\fP Arrow type 
 
160
.RE
 
161
.PP
 
162
 
 
163
.PP
 
164
Definition at line 240 of file qwt_arrow_button.cpp.
 
165
.PP
 
166
Referenced by drawButtonLabel().
 
167
.SS "QRect QwtArrowButton::labelRect () const\fC [protected, virtual]\fP"
 
168
.PP
 
169
\fBReturns:\fP
 
170
.RS 4
 
171
the bounding rect for the label 
 
172
.RE
 
173
.PP
 
174
 
 
175
.PP
 
176
Definition at line 108 of file qwt_arrow_button.cpp.
 
177
.PP
 
178
Referenced by drawButtonLabel().
 
179
.SS "QSize QwtArrowButton::arrowSize (Qt::ArrowType arrowType, const QSize & boundingSize) const\fC [protected, virtual]\fP"
 
180
.PP
 
181
Calculate the size for a arrow that fits into a rect of a given size
 
182
.PP
 
183
\fBParameters:\fP
 
184
.RS 4
 
185
\fIarrowType\fP Arrow type 
 
186
.br
 
187
\fIboundingSize\fP Bounding size 
 
188
.RE
 
189
.PP
 
190
\fBReturns:\fP
 
191
.RS 4
 
192
Size of the arrow 
 
193
.RE
 
194
.PP
 
195
 
 
196
.PP
 
197
Definition at line 331 of file qwt_arrow_button.cpp.
 
198
.PP
 
199
Referenced by drawButtonLabel(), and minimumSizeHint().
 
200
.SS "void QwtArrowButton::keyPressEvent (QKeyEvent *)\fC [protected, virtual]\fP"
 
201
.PP
 
202
autoRepeat for the space keys 
 
203
.PP
 
204
Definition at line 361 of file qwt_arrow_button.cpp.
 
205
 
 
206
.SH "Author"
 
207
.PP 
 
208
Generated automatically by Doxygen for Qwt User's Guide from the source code.