src/eric7/Documentation/Source/eric7.PdfViewer.PdfPageSelector.html

branch
eric7
changeset 10479
856476537696
parent 9730
00cf7289d899
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.PdfViewer.PdfPageSelector</h1> 9 <h1>eric7.PdfViewer.PdfPageSelector</h1>
10
11 <p> 10 <p>
12 Module implementing a widget to select a PDF page to be shown. 11 Module implementing a widget to select a PDF page to be shown.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#PdfPageSelector">PdfPageSelector</a></td> 22 <td><a href="#PdfPageSelector">PdfPageSelector</a></td>
25 <td>Class implementing a widget to select a PDF page to be shown.</td> 23 <td>Class implementing a widget to select a PDF page to be shown.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="PdfPageSelector" ID="PdfPageSelector"></a> 34 <a NAME="PdfPageSelector" ID="PdfPageSelector"></a>
36 <h2>PdfPageSelector</h2> 35 <h2>PdfPageSelector</h2>
37
38 <p> 36 <p>
39 Class implementing a widget to select a PDF page to be shown. 37 Class implementing a widget to select a PDF page to be shown.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>gotoPage()</dt> 43 <dt>gotoPage()</dt>
45 <dd> 44 <dd>
52 </dd> 51 </dd>
53 </dl> 52 </dl>
54 <h3>Derived from</h3> 53 <h3>Derived from</h3>
55 QWidget 54 QWidget
56 <h3>Class Attributes</h3> 55 <h3>Class Attributes</h3>
57 56 <table>
58 <table> 57 <tr><td>None</td></tr>
59 <tr><td>None</td></tr> 58 </table>
60 </table> 59
61 <h3>Class Methods</h3> 60 <h3>Class Methods</h3>
62 61 <table>
63 <table> 62 <tr><td>None</td></tr>
64 <tr><td>None</td></tr> 63 </table>
65 </table> 64
66 <h3>Methods</h3> 65 <h3>Methods</h3>
67 66 <table>
68 <table>
69
70 <tr> 67 <tr>
71 <td><a href="#PdfPageSelector.__init__">PdfPageSelector</a></td> 68 <td><a href="#PdfPageSelector.__init__">PdfPageSelector</a></td>
72 <td>Constructor</td> 69 <td>Constructor</td>
73 </tr> 70 </tr>
74 <tr> 71 <tr>
110 <tr> 107 <tr>
111 <td><a href="#PdfPageSelector.value">value</a></td> 108 <td><a href="#PdfPageSelector.value">value</a></td>
112 <td>Public method to get the current value.</td> 109 <td>Public method to get the current value.</td>
113 </tr> 110 </tr>
114 </table> 111 </table>
112
115 <h3>Static Methods</h3> 113 <h3>Static Methods</h3>
116 114 <table>
117 <table> 115 <tr><td>None</td></tr>
118 <tr><td>None</td></tr> 116 </table>
119 </table> 117
120 118
121 <a NAME="PdfPageSelector.__init__" ID="PdfPageSelector.__init__"></a> 119 <a NAME="PdfPageSelector.__init__" ID="PdfPageSelector.__init__"></a>
122 <h4>PdfPageSelector (Constructor)</h4> 120 <h4>PdfPageSelector (Constructor)</h4>
123 <b>PdfPageSelector</b>(<i>parent=None</i>) 121 <b>PdfPageSelector</b>(<i>parent=None</i>)
124
125 <p> 122 <p>
126 Constructor 123 Constructor
127 </p> 124 </p>
125
128 <dl> 126 <dl>
129 127
130 <dt><i>parent</i> (QWidget (optional))</dt> 128 <dt><i>parent</i> (QWidget (optional))</dt>
131 <dd> 129 <dd>
132 reference to the parent widget (defaults to None) 130 reference to the parent widget (defaults to None)
133 </dd> 131 </dd>
134 </dl> 132 </dl>
135 <a NAME="PdfPageSelector.__decrement" ID="PdfPageSelector.__decrement"></a> 133 <a NAME="PdfPageSelector.__decrement" ID="PdfPageSelector.__decrement"></a>
136 <h4>PdfPageSelector.__decrement</h4> 134 <h4>PdfPageSelector.__decrement</h4>
137 <b>__decrement</b>(<i></i>) 135 <b>__decrement</b>(<i></i>)
138
139 <p> 136 <p>
140 Private slot to decrement the current value. 137 Private slot to decrement the current value.
141 </p> 138 </p>
139
142 <a NAME="PdfPageSelector.__documentStatusChanged" ID="PdfPageSelector.__documentStatusChanged"></a> 140 <a NAME="PdfPageSelector.__documentStatusChanged" ID="PdfPageSelector.__documentStatusChanged"></a>
143 <h4>PdfPageSelector.__documentStatusChanged</h4> 141 <h4>PdfPageSelector.__documentStatusChanged</h4>
144 <b>__documentStatusChanged</b>(<i>status</i>) 142 <b>__documentStatusChanged</b>(<i>status</i>)
145
146 <p> 143 <p>
147 Private slot to handle a change of the document status. 144 Private slot to handle a change of the document status.
148 </p> 145 </p>
146
149 <dl> 147 <dl>
150 148
151 <dt><i>status</i> (QPdfDocument.Status)</dt> 149 <dt><i>status</i> (QPdfDocument.Status)</dt>
152 <dd> 150 <dd>
153 current document status 151 current document status
154 </dd> 152 </dd>
155 </dl> 153 </dl>
156 <a NAME="PdfPageSelector.__increment" ID="PdfPageSelector.__increment"></a> 154 <a NAME="PdfPageSelector.__increment" ID="PdfPageSelector.__increment"></a>
157 <h4>PdfPageSelector.__increment</h4> 155 <h4>PdfPageSelector.__increment</h4>
158 <b>__increment</b>(<i></i>) 156 <b>__increment</b>(<i></i>)
159
160 <p> 157 <p>
161 Private slot to increment the current value. 158 Private slot to increment the current value.
162 </p> 159 </p>
160
163 <a NAME="PdfPageSelector.__initialize" ID="PdfPageSelector.__initialize"></a> 161 <a NAME="PdfPageSelector.__initialize" ID="PdfPageSelector.__initialize"></a>
164 <h4>PdfPageSelector.__initialize</h4> 162 <h4>PdfPageSelector.__initialize</h4>
165 <b>__initialize</b>(<i></i>) 163 <b>__initialize</b>(<i></i>)
166
167 <p> 164 <p>
168 Private method to initialize some internal state. 165 Private method to initialize some internal state.
169 </p> 166 </p>
167
170 <a NAME="PdfPageSelector.__pageButtonTriggered" ID="PdfPageSelector.__pageButtonTriggered"></a> 168 <a NAME="PdfPageSelector.__pageButtonTriggered" ID="PdfPageSelector.__pageButtonTriggered"></a>
171 <h4>PdfPageSelector.__pageButtonTriggered</h4> 169 <h4>PdfPageSelector.__pageButtonTriggered</h4>
172 <b>__pageButtonTriggered</b>(<i></i>) 170 <b>__pageButtonTriggered</b>(<i></i>)
173
174 <p> 171 <p>
175 Private slot to handle the page button trigger. 172 Private slot to handle the page button trigger.
176 </p> 173 </p>
174
177 <a NAME="PdfPageSelector.__pageEntered" ID="PdfPageSelector.__pageEntered"></a> 175 <a NAME="PdfPageSelector.__pageEntered" ID="PdfPageSelector.__pageEntered"></a>
178 <h4>PdfPageSelector.__pageEntered</h4> 176 <h4>PdfPageSelector.__pageEntered</h4>
179 <b>__pageEntered</b>(<i></i>) 177 <b>__pageEntered</b>(<i></i>)
180
181 <p> 178 <p>
182 Private slot to handle the entering of a page value. 179 Private slot to handle the entering of a page value.
183 </p> 180 </p>
181
184 <a NAME="PdfPageSelector.setDocument" ID="PdfPageSelector.setDocument"></a> 182 <a NAME="PdfPageSelector.setDocument" ID="PdfPageSelector.setDocument"></a>
185 <h4>PdfPageSelector.setDocument</h4> 183 <h4>PdfPageSelector.setDocument</h4>
186 <b>setDocument</b>(<i>document</i>) 184 <b>setDocument</b>(<i>document</i>)
187
188 <p> 185 <p>
189 Public method to set a reference to the associated PDF document. 186 Public method to set a reference to the associated PDF document.
190 </p> 187 </p>
188
191 <dl> 189 <dl>
192 190
193 <dt><i>document</i> (QPdfDocument)</dt> 191 <dt><i>document</i> (QPdfDocument)</dt>
194 <dd> 192 <dd>
195 reference to the associated PDF document 193 reference to the associated PDF document
196 </dd> 194 </dd>
197 </dl> 195 </dl>
198 <a NAME="PdfPageSelector.setMaximum" ID="PdfPageSelector.setMaximum"></a> 196 <a NAME="PdfPageSelector.setMaximum" ID="PdfPageSelector.setMaximum"></a>
199 <h4>PdfPageSelector.setMaximum</h4> 197 <h4>PdfPageSelector.setMaximum</h4>
200 <b>setMaximum</b>(<i>maximum</i>) 198 <b>setMaximum</b>(<i>maximum</i>)
201
202 <p> 199 <p>
203 Public method to set the maximum value. 200 Public method to set the maximum value.
204 </p> 201 </p>
205 <p> 202 <p>
206 Note: maximum is 0 based. 203 Note: maximum is 0 based.
207 </p> 204 </p>
205
208 <dl> 206 <dl>
209 207
210 <dt><i>maximum</i> (int)</dt> 208 <dt><i>maximum</i> (int)</dt>
211 <dd> 209 <dd>
212 maximum value to be set 210 maximum value to be set
213 </dd> 211 </dd>
214 </dl> 212 </dl>
215 <a NAME="PdfPageSelector.setValue" ID="PdfPageSelector.setValue"></a> 213 <a NAME="PdfPageSelector.setValue" ID="PdfPageSelector.setValue"></a>
216 <h4>PdfPageSelector.setValue</h4> 214 <h4>PdfPageSelector.setValue</h4>
217 <b>setValue</b>(<i>value</i>) 215 <b>setValue</b>(<i>value</i>)
218
219 <p> 216 <p>
220 Public slot to set the value. 217 Public slot to set the value.
221 </p> 218 </p>
222 <p> 219 <p>
223 Note: value is 0 based. 220 Note: value is 0 based.
224 </p> 221 </p>
222
225 <dl> 223 <dl>
226 224
227 <dt><i>value</i> (int)</dt> 225 <dt><i>value</i> (int)</dt>
228 <dd> 226 <dd>
229 value to be set 227 value to be set
230 </dd> 228 </dd>
231 </dl> 229 </dl>
232 <a NAME="PdfPageSelector.value" ID="PdfPageSelector.value"></a> 230 <a NAME="PdfPageSelector.value" ID="PdfPageSelector.value"></a>
233 <h4>PdfPageSelector.value</h4> 231 <h4>PdfPageSelector.value</h4>
234 <b>value</b>(<i></i>) 232 <b>value</b>(<i></i>)
235
236 <p> 233 <p>
237 Public method to get the current value. 234 Public method to get the current value.
238 </p> 235 </p>
236
239 <dl> 237 <dl>
240 <dt>Return:</dt> 238 <dt>Return:</dt>
241 <dd> 239 <dd>
242 current value 240 current value
243 </dd> 241 </dd>

eric ide

mercurial