Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.PdfViewer.PdfToCWidget.html
src/eric7/Documentation/Source/eric7.PdfViewer.PdfToCWidget.html
- branch
- eric7
- changeset 9730
- 00cf7289d899
- child 10070
- 9f5758c0fec1
equal
deleted
inserted
replaced
| 9729:f17d787ca4fa | 9730:00cf7289d899 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric7.PdfViewer.PdfToCWidget</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.PdfToCWidget</h1> | |
| 10 | |
| 11 <p> | |
| 12 Module implementing a Table of Contents viewer widget. | |
| 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="#PdfToCModel">PdfToCModel</a></td> | |
| 25 <td>Class implementing a TOC model with page numbers.</td> | |
| 26 </tr> | |
| 27 <tr> | |
| 28 <td><a href="#PdfToCWidget">PdfToCWidget</a></td> | |
| 29 <td>Class implementing a Table of Contents viewer widget.</td> | |
| 30 </tr> | |
| 31 </table> | |
| 32 <h3>Functions</h3> | |
| 33 | |
| 34 <table> | |
| 35 <tr><td>None</td></tr> | |
| 36 </table> | |
| 37 <hr /> | |
| 38 <hr /> | |
| 39 <a NAME="PdfToCModel" ID="PdfToCModel"></a> | |
| 40 <h2>PdfToCModel</h2> | |
| 41 | |
| 42 <p> | |
| 43 Class implementing a TOC model with page numbers. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 QPdfBookmarkModel | |
| 47 <h3>Class Attributes</h3> | |
| 48 | |
| 49 <table> | |
| 50 <tr><td>None</td></tr> | |
| 51 </table> | |
| 52 <h3>Class Methods</h3> | |
| 53 | |
| 54 <table> | |
| 55 <tr><td>None</td></tr> | |
| 56 </table> | |
| 57 <h3>Methods</h3> | |
| 58 | |
| 59 <table> | |
| 60 | |
| 61 <tr> | |
| 62 <td><a href="#PdfToCModel.__init__">PdfToCModel</a></td> | |
| 63 <td>Constructor</td> | |
| 64 </tr> | |
| 65 <tr> | |
| 66 <td><a href="#PdfToCModel.columnCount">columnCount</a></td> | |
| 67 <td>Public method to define the number of columns to be shown.</td> | |
| 68 </tr> | |
| 69 <tr> | |
| 70 <td><a href="#PdfToCModel.data">data</a></td> | |
| 71 <td>Public method to return the requested data.</td> | |
| 72 </tr> | |
| 73 </table> | |
| 74 <h3>Static Methods</h3> | |
| 75 | |
| 76 <table> | |
| 77 <tr><td>None</td></tr> | |
| 78 </table> | |
| 79 | |
| 80 <a NAME="PdfToCModel.__init__" ID="PdfToCModel.__init__"></a> | |
| 81 <h4>PdfToCModel (Constructor)</h4> | |
| 82 <b>PdfToCModel</b>(<i>parent</i>) | |
| 83 | |
| 84 <p> | |
| 85 Constructor | |
| 86 </p> | |
| 87 <dl> | |
| 88 | |
| 89 <dt><i>parent</i> (TYPE)</dt> | |
| 90 <dd> | |
| 91 DESCRIPTION | |
| 92 </dd> | |
| 93 </dl> | |
| 94 <a NAME="PdfToCModel.columnCount" ID="PdfToCModel.columnCount"></a> | |
| 95 <h4>PdfToCModel.columnCount</h4> | |
| 96 <b>columnCount</b>(<i>index</i>) | |
| 97 | |
| 98 <p> | |
| 99 Public method to define the number of columns to be shown. | |
| 100 </p> | |
| 101 <dl> | |
| 102 | |
| 103 <dt><i>index</i> (QModelIndex)</dt> | |
| 104 <dd> | |
| 105 index of the element | |
| 106 </dd> | |
| 107 </dl> | |
| 108 <dl> | |
| 109 <dt>Return:</dt> | |
| 110 <dd> | |
| 111 column count (always 2) | |
| 112 </dd> | |
| 113 </dl> | |
| 114 <dl> | |
| 115 <dt>Return Type:</dt> | |
| 116 <dd> | |
| 117 int | |
| 118 </dd> | |
| 119 </dl> | |
| 120 <a NAME="PdfToCModel.data" ID="PdfToCModel.data"></a> | |
| 121 <h4>PdfToCModel.data</h4> | |
| 122 <b>data</b>(<i>index, role</i>) | |
| 123 | |
| 124 <p> | |
| 125 Public method to return the requested data. | |
| 126 </p> | |
| 127 <dl> | |
| 128 | |
| 129 <dt><i>index</i> (QModelIndex)</dt> | |
| 130 <dd> | |
| 131 index of the element | |
| 132 </dd> | |
| 133 <dt><i>role</i> (Qt.ItemDataRole)</dt> | |
| 134 <dd> | |
| 135 data role | |
| 136 </dd> | |
| 137 </dl> | |
| 138 <dl> | |
| 139 <dt>Return:</dt> | |
| 140 <dd> | |
| 141 requested data | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <dl> | |
| 145 <dt>Return Type:</dt> | |
| 146 <dd> | |
| 147 Any | |
| 148 </dd> | |
| 149 </dl> | |
| 150 <div align="right"><a href="#top">Up</a></div> | |
| 151 <hr /> | |
| 152 <hr /> | |
| 153 <a NAME="PdfToCWidget" ID="PdfToCWidget"></a> | |
| 154 <h2>PdfToCWidget</h2> | |
| 155 | |
| 156 <p> | |
| 157 Class implementing a Table of Contents viewer widget. | |
| 158 </p> | |
| 159 <h3>Signals</h3> | |
| 160 <dl> | |
| 161 | |
| 162 <dt>topicActivated(page, zoomFactor)</dt> | |
| 163 <dd> | |
| 164 emitted to navigate to the selected topic | |
| 165 </dd> | |
| 166 </dl> | |
| 167 <h3>Derived from</h3> | |
| 168 QWidget | |
| 169 <h3>Class Attributes</h3> | |
| 170 | |
| 171 <table> | |
| 172 <tr><td>None</td></tr> | |
| 173 </table> | |
| 174 <h3>Class Methods</h3> | |
| 175 | |
| 176 <table> | |
| 177 <tr><td>None</td></tr> | |
| 178 </table> | |
| 179 <h3>Methods</h3> | |
| 180 | |
| 181 <table> | |
| 182 | |
| 183 <tr> | |
| 184 <td><a href="#PdfToCWidget.__init__">PdfToCWidget</a></td> | |
| 185 <td>Constructor</td> | |
| 186 </tr> | |
| 187 <tr> | |
| 188 <td><a href="#PdfToCWidget.__handleDocumentStatus">__handleDocumentStatus</a></td> | |
| 189 <td>Private slot to handle a change of the document status.</td> | |
| 190 </tr> | |
| 191 <tr> | |
| 192 <td><a href="#PdfToCWidget.__searchTextChanged">__searchTextChanged</a></td> | |
| 193 <td>Private slot to handle a change of the search text.</td> | |
| 194 </tr> | |
| 195 <tr> | |
| 196 <td><a href="#PdfToCWidget.__topicSelected">__topicSelected</a></td> | |
| 197 <td>Private slot to handle the selection of a ToC entry.</td> | |
| 198 </tr> | |
| 199 </table> | |
| 200 <h3>Static Methods</h3> | |
| 201 | |
| 202 <table> | |
| 203 <tr><td>None</td></tr> | |
| 204 </table> | |
| 205 | |
| 206 <a NAME="PdfToCWidget.__init__" ID="PdfToCWidget.__init__"></a> | |
| 207 <h4>PdfToCWidget (Constructor)</h4> | |
| 208 <b>PdfToCWidget</b>(<i>document, parent=None</i>) | |
| 209 | |
| 210 <p> | |
| 211 Constructor | |
| 212 </p> | |
| 213 <dl> | |
| 214 | |
| 215 <dt><i>document</i> (QPdfDocument)</dt> | |
| 216 <dd> | |
| 217 reference to the PDF document object | |
| 218 </dd> | |
| 219 <dt><i>parent</i> (QWidget (optional))</dt> | |
| 220 <dd> | |
| 221 reference to the parent widget (defaults to None) | |
| 222 </dd> | |
| 223 </dl> | |
| 224 <a NAME="PdfToCWidget.__handleDocumentStatus" ID="PdfToCWidget.__handleDocumentStatus"></a> | |
| 225 <h4>PdfToCWidget.__handleDocumentStatus</h4> | |
| 226 <b>__handleDocumentStatus</b>(<i>status</i>) | |
| 227 | |
| 228 <p> | |
| 229 Private slot to handle a change of the document status. | |
| 230 </p> | |
| 231 <dl> | |
| 232 | |
| 233 <dt><i>status</i> (QPdfDocument.Status)</dt> | |
| 234 <dd> | |
| 235 document status | |
| 236 </dd> | |
| 237 </dl> | |
| 238 <a NAME="PdfToCWidget.__searchTextChanged" ID="PdfToCWidget.__searchTextChanged"></a> | |
| 239 <h4>PdfToCWidget.__searchTextChanged</h4> | |
| 240 <b>__searchTextChanged</b>(<i>text</i>) | |
| 241 | |
| 242 <p> | |
| 243 Private slot to handle a change of the search text. | |
| 244 </p> | |
| 245 <dl> | |
| 246 | |
| 247 <dt><i>text</i> (str)</dt> | |
| 248 <dd> | |
| 249 search text | |
| 250 </dd> | |
| 251 </dl> | |
| 252 <a NAME="PdfToCWidget.__topicSelected" ID="PdfToCWidget.__topicSelected"></a> | |
| 253 <h4>PdfToCWidget.__topicSelected</h4> | |
| 254 <b>__topicSelected</b>(<i>index</i>) | |
| 255 | |
| 256 <p> | |
| 257 Private slot to handle the selection of a ToC entry. | |
| 258 </p> | |
| 259 <dl> | |
| 260 | |
| 261 <dt><i>index</i> (QModelIndex)</dt> | |
| 262 <dd> | |
| 263 index of the activated entry | |
| 264 </dd> | |
| 265 </dl> | |
| 266 <div align="right"><a href="#top">Up</a></div> | |
| 267 <hr /> | |
| 268 </body></html> |
