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

branch
eric7
changeset 10479
856476537696
parent 10259
b51dfacef37f
child 10684
58c7f23ae1cb
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.PdfToCWidget</h1> 9 <h1>eric7.PdfViewer.PdfToCWidget</h1>
10
11 <p> 10 <p>
12 Module implementing a Table of Contents viewer widget. 11 Module implementing a Table of Contents viewer widget.
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="#PdfToCModel">PdfToCModel</a></td> 22 <td><a href="#PdfToCModel">PdfToCModel</a></td>
25 <td>Class implementing a TOC model with page numbers.</td> 23 <td>Class implementing a TOC model with page numbers.</td>
26 </tr> 24 </tr>
27 <tr> 25 <tr>
28 <td><a href="#PdfToCWidget">PdfToCWidget</a></td> 26 <td><a href="#PdfToCWidget">PdfToCWidget</a></td>
29 <td>Class implementing a Table of Contents viewer widget.</td> 27 <td>Class implementing a Table of Contents viewer widget.</td>
30 </tr> 28 </tr>
31 </table> 29 </table>
30
32 <h3>Functions</h3> 31 <h3>Functions</h3>
33 32 <table>
34 <table> 33 <tr><td>None</td></tr>
35 <tr><td>None</td></tr> 34 </table>
36 </table> 35
37 <hr /> 36 <hr />
38 <hr /> 37 <hr />
39 <a NAME="PdfToCModel" ID="PdfToCModel"></a> 38 <a NAME="PdfToCModel" ID="PdfToCModel"></a>
40 <h2>PdfToCModel</h2> 39 <h2>PdfToCModel</h2>
41
42 <p> 40 <p>
43 Class implementing a TOC model with page numbers. 41 Class implementing a TOC model with page numbers.
44 </p> 42 </p>
43
45 <h3>Derived from</h3> 44 <h3>Derived from</h3>
46 QPdfBookmarkModel 45 QPdfBookmarkModel
47 <h3>Class Attributes</h3> 46 <h3>Class Attributes</h3>
48 47 <table>
49 <table> 48 <tr><td>None</td></tr>
50 <tr><td>None</td></tr> 49 </table>
51 </table> 50
52 <h3>Class Methods</h3> 51 <h3>Class Methods</h3>
53 52 <table>
54 <table> 53 <tr><td>None</td></tr>
55 <tr><td>None</td></tr> 54 </table>
56 </table> 55
57 <h3>Methods</h3> 56 <h3>Methods</h3>
58 57 <table>
59 <table>
60
61 <tr> 58 <tr>
62 <td><a href="#PdfToCModel.__init__">PdfToCModel</a></td> 59 <td><a href="#PdfToCModel.__init__">PdfToCModel</a></td>
63 <td>Constructor</td> 60 <td>Constructor</td>
64 </tr> 61 </tr>
65 <tr> 62 <tr>
69 <tr> 66 <tr>
70 <td><a href="#PdfToCModel.data">data</a></td> 67 <td><a href="#PdfToCModel.data">data</a></td>
71 <td>Public method to return the requested data.</td> 68 <td>Public method to return the requested data.</td>
72 </tr> 69 </tr>
73 </table> 70 </table>
71
74 <h3>Static Methods</h3> 72 <h3>Static Methods</h3>
75 73 <table>
76 <table> 74 <tr><td>None</td></tr>
77 <tr><td>None</td></tr> 75 </table>
78 </table> 76
79 77
80 <a NAME="PdfToCModel.__init__" ID="PdfToCModel.__init__"></a> 78 <a NAME="PdfToCModel.__init__" ID="PdfToCModel.__init__"></a>
81 <h4>PdfToCModel (Constructor)</h4> 79 <h4>PdfToCModel (Constructor)</h4>
82 <b>PdfToCModel</b>(<i>parent</i>) 80 <b>PdfToCModel</b>(<i>parent</i>)
83
84 <p> 81 <p>
85 Constructor 82 Constructor
86 </p> 83 </p>
84
87 <dl> 85 <dl>
88 86
89 <dt><i>parent</i> (TYPE)</dt> 87 <dt><i>parent</i> (TYPE)</dt>
90 <dd> 88 <dd>
91 DESCRIPTION 89 DESCRIPTION
92 </dd> 90 </dd>
93 </dl> 91 </dl>
94 <a NAME="PdfToCModel.columnCount" ID="PdfToCModel.columnCount"></a> 92 <a NAME="PdfToCModel.columnCount" ID="PdfToCModel.columnCount"></a>
95 <h4>PdfToCModel.columnCount</h4> 93 <h4>PdfToCModel.columnCount</h4>
96 <b>columnCount</b>(<i>index</i>) 94 <b>columnCount</b>(<i>index</i>)
97
98 <p> 95 <p>
99 Public method to define the number of columns to be shown. 96 Public method to define the number of columns to be shown.
100 </p> 97 </p>
98
101 <dl> 99 <dl>
102 100
103 <dt><i>index</i> (QModelIndex)</dt> 101 <dt><i>index</i> (QModelIndex)</dt>
104 <dd> 102 <dd>
105 index of the element 103 index of the element
118 </dd> 116 </dd>
119 </dl> 117 </dl>
120 <a NAME="PdfToCModel.data" ID="PdfToCModel.data"></a> 118 <a NAME="PdfToCModel.data" ID="PdfToCModel.data"></a>
121 <h4>PdfToCModel.data</h4> 119 <h4>PdfToCModel.data</h4>
122 <b>data</b>(<i>index, role</i>) 120 <b>data</b>(<i>index, role</i>)
123
124 <p> 121 <p>
125 Public method to return the requested data. 122 Public method to return the requested data.
126 </p> 123 </p>
124
127 <dl> 125 <dl>
128 126
129 <dt><i>index</i> (QModelIndex)</dt> 127 <dt><i>index</i> (QModelIndex)</dt>
130 <dd> 128 <dd>
131 index of the element 129 index of the element
150 <div align="right"><a href="#top">Up</a></div> 148 <div align="right"><a href="#top">Up</a></div>
151 <hr /> 149 <hr />
152 <hr /> 150 <hr />
153 <a NAME="PdfToCWidget" ID="PdfToCWidget"></a> 151 <a NAME="PdfToCWidget" ID="PdfToCWidget"></a>
154 <h2>PdfToCWidget</h2> 152 <h2>PdfToCWidget</h2>
155
156 <p> 153 <p>
157 Class implementing a Table of Contents viewer widget. 154 Class implementing a Table of Contents viewer widget.
158 </p> 155 </p>
156
159 <h3>Signals</h3> 157 <h3>Signals</h3>
160 <dl> 158 <dl>
161 159
162 <dt>topicActivated(page, zoomFactor)</dt> 160 <dt>topicActivated(page, zoomFactor)</dt>
163 <dd> 161 <dd>
165 </dd> 163 </dd>
166 </dl> 164 </dl>
167 <h3>Derived from</h3> 165 <h3>Derived from</h3>
168 QWidget 166 QWidget
169 <h3>Class Attributes</h3> 167 <h3>Class Attributes</h3>
170 168 <table>
171 <table> 169 <tr><td>None</td></tr>
172 <tr><td>None</td></tr> 170 </table>
173 </table> 171
174 <h3>Class Methods</h3> 172 <h3>Class Methods</h3>
175 173 <table>
176 <table> 174 <tr><td>None</td></tr>
177 <tr><td>None</td></tr> 175 </table>
178 </table> 176
179 <h3>Methods</h3> 177 <h3>Methods</h3>
180 178 <table>
181 <table>
182
183 <tr> 179 <tr>
184 <td><a href="#PdfToCWidget.__init__">PdfToCWidget</a></td> 180 <td><a href="#PdfToCWidget.__init__">PdfToCWidget</a></td>
185 <td>Constructor</td> 181 <td>Constructor</td>
186 </tr> 182 </tr>
187 <tr> 183 <tr>
195 <tr> 191 <tr>
196 <td><a href="#PdfToCWidget.__topicSelected">__topicSelected</a></td> 192 <td><a href="#PdfToCWidget.__topicSelected">__topicSelected</a></td>
197 <td>Private slot to handle the selection of a ToC entry.</td> 193 <td>Private slot to handle the selection of a ToC entry.</td>
198 </tr> 194 </tr>
199 </table> 195 </table>
196
200 <h3>Static Methods</h3> 197 <h3>Static Methods</h3>
201 198 <table>
202 <table> 199 <tr><td>None</td></tr>
203 <tr><td>None</td></tr> 200 </table>
204 </table> 201
205 202
206 <a NAME="PdfToCWidget.__init__" ID="PdfToCWidget.__init__"></a> 203 <a NAME="PdfToCWidget.__init__" ID="PdfToCWidget.__init__"></a>
207 <h4>PdfToCWidget (Constructor)</h4> 204 <h4>PdfToCWidget (Constructor)</h4>
208 <b>PdfToCWidget</b>(<i>document, parent=None</i>) 205 <b>PdfToCWidget</b>(<i>document, parent=None</i>)
209
210 <p> 206 <p>
211 Constructor 207 Constructor
212 </p> 208 </p>
209
213 <dl> 210 <dl>
214 211
215 <dt><i>document</i> (QPdfDocument)</dt> 212 <dt><i>document</i> (QPdfDocument)</dt>
216 <dd> 213 <dd>
217 reference to the PDF document object 214 reference to the PDF document object
222 </dd> 219 </dd>
223 </dl> 220 </dl>
224 <a NAME="PdfToCWidget.__handleDocumentStatus" ID="PdfToCWidget.__handleDocumentStatus"></a> 221 <a NAME="PdfToCWidget.__handleDocumentStatus" ID="PdfToCWidget.__handleDocumentStatus"></a>
225 <h4>PdfToCWidget.__handleDocumentStatus</h4> 222 <h4>PdfToCWidget.__handleDocumentStatus</h4>
226 <b>__handleDocumentStatus</b>(<i>status</i>) 223 <b>__handleDocumentStatus</b>(<i>status</i>)
227
228 <p> 224 <p>
229 Private slot to handle a change of the document status. 225 Private slot to handle a change of the document status.
230 </p> 226 </p>
227
231 <dl> 228 <dl>
232 229
233 <dt><i>status</i> (QPdfDocument.Status)</dt> 230 <dt><i>status</i> (QPdfDocument.Status)</dt>
234 <dd> 231 <dd>
235 document status 232 document status
236 </dd> 233 </dd>
237 </dl> 234 </dl>
238 <a NAME="PdfToCWidget.__searchTextChanged" ID="PdfToCWidget.__searchTextChanged"></a> 235 <a NAME="PdfToCWidget.__searchTextChanged" ID="PdfToCWidget.__searchTextChanged"></a>
239 <h4>PdfToCWidget.__searchTextChanged</h4> 236 <h4>PdfToCWidget.__searchTextChanged</h4>
240 <b>__searchTextChanged</b>(<i>text</i>) 237 <b>__searchTextChanged</b>(<i>text</i>)
241
242 <p> 238 <p>
243 Private slot to handle a change of the search text. 239 Private slot to handle a change of the search text.
244 </p> 240 </p>
241
245 <dl> 242 <dl>
246 243
247 <dt><i>text</i> (str)</dt> 244 <dt><i>text</i> (str)</dt>
248 <dd> 245 <dd>
249 search text 246 search text
250 </dd> 247 </dd>
251 </dl> 248 </dl>
252 <a NAME="PdfToCWidget.__topicSelected" ID="PdfToCWidget.__topicSelected"></a> 249 <a NAME="PdfToCWidget.__topicSelected" ID="PdfToCWidget.__topicSelected"></a>
253 <h4>PdfToCWidget.__topicSelected</h4> 250 <h4>PdfToCWidget.__topicSelected</h4>
254 <b>__topicSelected</b>(<i>index</i>) 251 <b>__topicSelected</b>(<i>index</i>)
255
256 <p> 252 <p>
257 Private slot to handle the selection of a ToC entry. 253 Private slot to handle the selection of a ToC entry.
258 </p> 254 </p>
255
259 <dl> 256 <dl>
260 257
261 <dt><i>index</i> (QModelIndex)</dt> 258 <dt><i>index</i> (QModelIndex)</dt>
262 <dd> 259 <dd>
263 index of the activated entry 260 index of the activated entry

eric ide

mercurial