Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.PdfViewer.PdfPageSelector.html
src/eric7/Documentation/Source/eric7.PdfViewer.PdfPageSelector.html
- branch
- eric7
- changeset 9730
- 00cf7289d899
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 9729:f17d787ca4fa | 9730:00cf7289d899 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.PdfViewer.PdfPageSelector</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <link rel="stylesheet" href="styles.css"> | |
| 6 </head> | |
| 7 <body> | |
| 8 <a NAME="top" ID="top"></a> | |
| 9 <h1>eric7.PdfViewer.PdfPageSelector</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a widget to select a PDF page to be shown. | |
| 13 </p> | |
| 14 <h3>Global Attributes</h3> | |
| 15 | |
| 16 <table> | |
| 17 <tr><td>None</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 | |
| 21 <table> | |
| 22 | |
| 23 <tr> | |
| 24 <td><a href="#PdfPageSelector">PdfPageSelector</a></td> | |
| 25 <td>Class implementing a widget to select a PDF page to be shown.</td> | |
| 26 </tr> | |
| 27 </table> | |
| 28 <h3>Functions</h3> | |
| 29 | |
| 30 <table> | |
| 31 <tr><td>None</td></tr> | |
| 32 </table> | |
| 33 <hr /> | |
| 34 <hr /> | |
| 35 <a NAME="PdfPageSelector" ID="PdfPageSelector"></a> | |
| 36 <h2>PdfPageSelector</h2> | |
| 37 | |
| 38 <p> | |
| 39 Class implementing a widget to select a PDF page to be shown. | |
| 40 </p> | |
| 41 <h3>Signals</h3> | |
| 42 <dl> | |
| 43 | |
| 44 <dt>gotoPage()</dt> | |
| 45 <dd> | |
| 46 emitted to indicate the want to enter a page number via the | |
| 47 Go To dialog | |
| 48 </dd> | |
| 49 <dt>valueChanged(int)</dt> | |
| 50 <dd> | |
| 51 emitted to signal the new value of the selector | |
| 52 </dd> | |
| 53 </dl> | |
| 54 <h3>Derived from</h3> | |
| 55 QWidget | |
| 56 <h3>Class Attributes</h3> | |
| 57 | |
| 58 <table> | |
| 59 <tr><td>None</td></tr> | |
| 60 </table> | |
| 61 <h3>Class Methods</h3> | |
| 62 | |
| 63 <table> | |
| 64 <tr><td>None</td></tr> | |
| 65 </table> | |
| 66 <h3>Methods</h3> | |
| 67 | |
| 68 <table> | |
| 69 | |
| 70 <tr> | |
| 71 <td><a href="#PdfPageSelector.__init__">PdfPageSelector</a></td> | |
| 72 <td>Constructor</td> | |
| 73 </tr> | |
| 74 <tr> | |
| 75 <td><a href="#PdfPageSelector.__decrement">__decrement</a></td> | |
| 76 <td>Private slot to decrement the current value.</td> | |
| 77 </tr> | |
| 78 <tr> | |
| 79 <td><a href="#PdfPageSelector.__documentStatusChanged">__documentStatusChanged</a></td> | |
| 80 <td>Private slot to handle a change of the document status.</td> | |
| 81 </tr> | |
| 82 <tr> | |
| 83 <td><a href="#PdfPageSelector.__increment">__increment</a></td> | |
| 84 <td>Private slot to increment the current value.</td> | |
| 85 </tr> | |
| 86 <tr> | |
| 87 <td><a href="#PdfPageSelector.__initialize">__initialize</a></td> | |
| 88 <td>Private method to initialize some internal state.</td> | |
| 89 </tr> | |
| 90 <tr> | |
| 91 <td><a href="#PdfPageSelector.__pageButtonTriggered">__pageButtonTriggered</a></td> | |
| 92 <td>Private slot to handle the page button trigger.</td> | |
| 93 </tr> | |
| 94 <tr> | |
| 95 <td><a href="#PdfPageSelector.__pageEntered">__pageEntered</a></td> | |
| 96 <td>Private slot to handle the entering of a page value.</td> | |
| 97 </tr> | |
| 98 <tr> | |
| 99 <td><a href="#PdfPageSelector.setDocument">setDocument</a></td> | |
| 100 <td>Public method to set a reference to the associated PDF document.</td> | |
| 101 </tr> | |
| 102 <tr> | |
| 103 <td><a href="#PdfPageSelector.setMaximum">setMaximum</a></td> | |
| 104 <td>Public method to set the maximum value.</td> | |
| 105 </tr> | |
| 106 <tr> | |
| 107 <td><a href="#PdfPageSelector.setValue">setValue</a></td> | |
| 108 <td>Public slot to set the value.</td> | |
| 109 </tr> | |
| 110 <tr> | |
| 111 <td><a href="#PdfPageSelector.value">value</a></td> | |
| 112 <td>Public method to get the current value.</td> | |
| 113 </tr> | |
| 114 </table> | |
| 115 <h3>Static Methods</h3> | |
| 116 | |
| 117 <table> | |
| 118 <tr><td>None</td></tr> | |
| 119 </table> | |
| 120 | |
| 121 <a NAME="PdfPageSelector.__init__" ID="PdfPageSelector.__init__"></a> | |
| 122 <h4>PdfPageSelector (Constructor)</h4> | |
| 123 <b>PdfPageSelector</b>(<i>parent=None</i>) | |
| 124 | |
| 125 <p> | |
| 126 Constructor | |
| 127 </p> | |
| 128 <dl> | |
| 129 | |
| 130 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 131 <dd> | |
| 132 reference to the parent widget (defaults to None) | |
| 133 </dd> | |
| 134 </dl> | |
| 135 <a NAME="PdfPageSelector.__decrement" ID="PdfPageSelector.__decrement"></a> | |
| 136 <h4>PdfPageSelector.__decrement</h4> | |
| 137 <b>__decrement</b>(<i></i>) | |
| 138 | |
| 139 <p> | |
| 140 Private slot to decrement the current value. | |
| 141 </p> | |
| 142 <a NAME="PdfPageSelector.__documentStatusChanged" ID="PdfPageSelector.__documentStatusChanged"></a> | |
| 143 <h4>PdfPageSelector.__documentStatusChanged</h4> | |
| 144 <b>__documentStatusChanged</b>(<i>status</i>) | |
| 145 | |
| 146 <p> | |
| 147 Private slot to handle a change of the document status. | |
| 148 </p> | |
| 149 <dl> | |
| 150 | |
| 151 <dt><i>status</i> (QPdfDocument.Status)</dt> | |
| 152 <dd> | |
| 153 current document status | |
| 154 </dd> | |
| 155 </dl> | |
| 156 <a NAME="PdfPageSelector.__increment" ID="PdfPageSelector.__increment"></a> | |
| 157 <h4>PdfPageSelector.__increment</h4> | |
| 158 <b>__increment</b>(<i></i>) | |
| 159 | |
| 160 <p> | |
| 161 Private slot to increment the current value. | |
| 162 </p> | |
| 163 <a NAME="PdfPageSelector.__initialize" ID="PdfPageSelector.__initialize"></a> | |
| 164 <h4>PdfPageSelector.__initialize</h4> | |
| 165 <b>__initialize</b>(<i></i>) | |
| 166 | |
| 167 <p> | |
| 168 Private method to initialize some internal state. | |
| 169 </p> | |
| 170 <a NAME="PdfPageSelector.__pageButtonTriggered" ID="PdfPageSelector.__pageButtonTriggered"></a> | |
| 171 <h4>PdfPageSelector.__pageButtonTriggered</h4> | |
| 172 <b>__pageButtonTriggered</b>(<i></i>) | |
| 173 | |
| 174 <p> | |
| 175 Private slot to handle the page button trigger. | |
| 176 </p> | |
| 177 <a NAME="PdfPageSelector.__pageEntered" ID="PdfPageSelector.__pageEntered"></a> | |
| 178 <h4>PdfPageSelector.__pageEntered</h4> | |
| 179 <b>__pageEntered</b>(<i></i>) | |
| 180 | |
| 181 <p> | |
| 182 Private slot to handle the entering of a page value. | |
| 183 </p> | |
| 184 <a NAME="PdfPageSelector.setDocument" ID="PdfPageSelector.setDocument"></a> | |
| 185 <h4>PdfPageSelector.setDocument</h4> | |
| 186 <b>setDocument</b>(<i>document</i>) | |
| 187 | |
| 188 <p> | |
| 189 Public method to set a reference to the associated PDF document. | |
| 190 </p> | |
| 191 <dl> | |
| 192 | |
| 193 <dt><i>document</i> (QPdfDocument)</dt> | |
| 194 <dd> | |
| 195 reference to the associated PDF document | |
| 196 </dd> | |
| 197 </dl> | |
| 198 <a NAME="PdfPageSelector.setMaximum" ID="PdfPageSelector.setMaximum"></a> | |
| 199 <h4>PdfPageSelector.setMaximum</h4> | |
| 200 <b>setMaximum</b>(<i>maximum</i>) | |
| 201 | |
| 202 <p> | |
| 203 Public method to set the maximum value. | |
| 204 </p> | |
| 205 <p> | |
| 206 Note: maximum is 0 based. | |
| 207 </p> | |
| 208 <dl> | |
| 209 | |
| 210 <dt><i>maximum</i> (int)</dt> | |
| 211 <dd> | |
| 212 maximum value to be set | |
| 213 </dd> | |
| 214 </dl> | |
| 215 <a NAME="PdfPageSelector.setValue" ID="PdfPageSelector.setValue"></a> | |
| 216 <h4>PdfPageSelector.setValue</h4> | |
| 217 <b>setValue</b>(<i>value</i>) | |
| 218 | |
| 219 <p> | |
| 220 Public slot to set the value. | |
| 221 </p> | |
| 222 <p> | |
| 223 Note: value is 0 based. | |
| 224 </p> | |
| 225 <dl> | |
| 226 | |
| 227 <dt><i>value</i> (int)</dt> | |
| 228 <dd> | |
| 229 value to be set | |
| 230 </dd> | |
| 231 </dl> | |
| 232 <a NAME="PdfPageSelector.value" ID="PdfPageSelector.value"></a> | |
| 233 <h4>PdfPageSelector.value</h4> | |
| 234 <b>value</b>(<i></i>) | |
| 235 | |
| 236 <p> | |
| 237 Public method to get the current value. | |
| 238 </p> | |
| 239 <dl> | |
| 240 <dt>Return:</dt> | |
| 241 <dd> | |
| 242 current value | |
| 243 </dd> | |
| 244 </dl> | |
| 245 <dl> | |
| 246 <dt>Return Type:</dt> | |
| 247 <dd> | |
| 248 int | |
| 249 </dd> | |
| 250 </dl> | |
| 251 <div align="right"><a href="#top">Up</a></div> | |
| 252 <hr /> | |
| 253 </body></html> |
