|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric7.WebBrowser.OpenSearch.OpenSearchEngineModel</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.WebBrowser.OpenSearch.OpenSearchEngineModel</h1> |
|
10 |
|
11 <p> |
|
12 Module implementing a model for search engines. |
|
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="#OpenSearchEngineModel">OpenSearchEngineModel</a></td> |
|
25 <td>Class implementing a model for search engines.</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="OpenSearchEngineModel" ID="OpenSearchEngineModel"></a> |
|
36 <h2>OpenSearchEngineModel</h2> |
|
37 |
|
38 <p> |
|
39 Class implementing a model for search engines. |
|
40 </p> |
|
41 <h3>Derived from</h3> |
|
42 QAbstractTableModel |
|
43 <h3>Class Attributes</h3> |
|
44 |
|
45 <table> |
|
46 <tr><td>None</td></tr> |
|
47 </table> |
|
48 <h3>Class Methods</h3> |
|
49 |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Methods</h3> |
|
54 |
|
55 <table> |
|
56 |
|
57 <tr> |
|
58 <td><a href="#OpenSearchEngineModel.__init__">OpenSearchEngineModel</a></td> |
|
59 <td>Constructor</td> |
|
60 </tr> |
|
61 <tr> |
|
62 <td><a href="#OpenSearchEngineModel.__enginesChanged">__enginesChanged</a></td> |
|
63 <td>Private slot handling a change of the registered engines.</td> |
|
64 </tr> |
|
65 <tr> |
|
66 <td><a href="#OpenSearchEngineModel.columnCount">columnCount</a></td> |
|
67 <td>Public method to get the number of columns of the model.</td> |
|
68 </tr> |
|
69 <tr> |
|
70 <td><a href="#OpenSearchEngineModel.data">data</a></td> |
|
71 <td>Public method to get data from the model.</td> |
|
72 </tr> |
|
73 <tr> |
|
74 <td><a href="#OpenSearchEngineModel.flags">flags</a></td> |
|
75 <td>Public method to get flags for a model cell.</td> |
|
76 </tr> |
|
77 <tr> |
|
78 <td><a href="#OpenSearchEngineModel.headerData">headerData</a></td> |
|
79 <td>Public method to get the header data.</td> |
|
80 </tr> |
|
81 <tr> |
|
82 <td><a href="#OpenSearchEngineModel.removeRows">removeRows</a></td> |
|
83 <td>Public method to remove entries from the model.</td> |
|
84 </tr> |
|
85 <tr> |
|
86 <td><a href="#OpenSearchEngineModel.rowCount">rowCount</a></td> |
|
87 <td>Public method to get the number of rows of the model.</td> |
|
88 </tr> |
|
89 <tr> |
|
90 <td><a href="#OpenSearchEngineModel.setData">setData</a></td> |
|
91 <td>Public method to set the data of a model cell.</td> |
|
92 </tr> |
|
93 </table> |
|
94 <h3>Static Methods</h3> |
|
95 |
|
96 <table> |
|
97 <tr><td>None</td></tr> |
|
98 </table> |
|
99 |
|
100 <a NAME="OpenSearchEngineModel.__init__" ID="OpenSearchEngineModel.__init__"></a> |
|
101 <h4>OpenSearchEngineModel (Constructor)</h4> |
|
102 <b>OpenSearchEngineModel</b>(<i>manager, parent=None</i>) |
|
103 |
|
104 <p> |
|
105 Constructor |
|
106 </p> |
|
107 <dl> |
|
108 |
|
109 <dt><i>manager</i></dt> |
|
110 <dd> |
|
111 reference to the search engine manager |
|
112 (OpenSearchManager) |
|
113 </dd> |
|
114 <dt><i>parent</i></dt> |
|
115 <dd> |
|
116 reference to the parent object (QObject) |
|
117 </dd> |
|
118 </dl> |
|
119 <a NAME="OpenSearchEngineModel.__enginesChanged" ID="OpenSearchEngineModel.__enginesChanged"></a> |
|
120 <h4>OpenSearchEngineModel.__enginesChanged</h4> |
|
121 <b>__enginesChanged</b>(<i></i>) |
|
122 |
|
123 <p> |
|
124 Private slot handling a change of the registered engines. |
|
125 </p> |
|
126 <a NAME="OpenSearchEngineModel.columnCount" ID="OpenSearchEngineModel.columnCount"></a> |
|
127 <h4>OpenSearchEngineModel.columnCount</h4> |
|
128 <b>columnCount</b>(<i>parent=None</i>) |
|
129 |
|
130 <p> |
|
131 Public method to get the number of columns of the model. |
|
132 </p> |
|
133 <dl> |
|
134 |
|
135 <dt><i>parent</i></dt> |
|
136 <dd> |
|
137 parent index (QModelIndex) (Unused) |
|
138 </dd> |
|
139 </dl> |
|
140 <dl> |
|
141 <dt>Return:</dt> |
|
142 <dd> |
|
143 number of columns (integer) |
|
144 </dd> |
|
145 </dl> |
|
146 <a NAME="OpenSearchEngineModel.data" ID="OpenSearchEngineModel.data"></a> |
|
147 <h4>OpenSearchEngineModel.data</h4> |
|
148 <b>data</b>(<i>index, role</i>) |
|
149 |
|
150 <p> |
|
151 Public method to get data from the model. |
|
152 </p> |
|
153 <dl> |
|
154 |
|
155 <dt><i>index</i></dt> |
|
156 <dd> |
|
157 index to get data for (QModelIndex) |
|
158 </dd> |
|
159 <dt><i>role</i></dt> |
|
160 <dd> |
|
161 role of the data to retrieve (integer) |
|
162 </dd> |
|
163 </dl> |
|
164 <dl> |
|
165 <dt>Return:</dt> |
|
166 <dd> |
|
167 requested data |
|
168 </dd> |
|
169 </dl> |
|
170 <a NAME="OpenSearchEngineModel.flags" ID="OpenSearchEngineModel.flags"></a> |
|
171 <h4>OpenSearchEngineModel.flags</h4> |
|
172 <b>flags</b>(<i>index</i>) |
|
173 |
|
174 <p> |
|
175 Public method to get flags for a model cell. |
|
176 </p> |
|
177 <dl> |
|
178 |
|
179 <dt><i>index</i></dt> |
|
180 <dd> |
|
181 index of the model cell (QModelIndex) |
|
182 </dd> |
|
183 </dl> |
|
184 <dl> |
|
185 <dt>Return:</dt> |
|
186 <dd> |
|
187 flags (Qt.ItemFlags) |
|
188 </dd> |
|
189 </dl> |
|
190 <a NAME="OpenSearchEngineModel.headerData" ID="OpenSearchEngineModel.headerData"></a> |
|
191 <h4>OpenSearchEngineModel.headerData</h4> |
|
192 <b>headerData</b>(<i>section, orientation, role=Qt.ItemDataRole.DisplayRole</i>) |
|
193 |
|
194 <p> |
|
195 Public method to get the header data. |
|
196 </p> |
|
197 <dl> |
|
198 |
|
199 <dt><i>section</i></dt> |
|
200 <dd> |
|
201 section number (integer) |
|
202 </dd> |
|
203 <dt><i>orientation</i></dt> |
|
204 <dd> |
|
205 header orientation (Qt.Orientation) |
|
206 </dd> |
|
207 <dt><i>role</i></dt> |
|
208 <dd> |
|
209 data role (Qt.ItemDataRole) |
|
210 </dd> |
|
211 </dl> |
|
212 <dl> |
|
213 <dt>Return:</dt> |
|
214 <dd> |
|
215 header data |
|
216 </dd> |
|
217 </dl> |
|
218 <a NAME="OpenSearchEngineModel.removeRows" ID="OpenSearchEngineModel.removeRows"></a> |
|
219 <h4>OpenSearchEngineModel.removeRows</h4> |
|
220 <b>removeRows</b>(<i>row, count, parent=None</i>) |
|
221 |
|
222 <p> |
|
223 Public method to remove entries from the model. |
|
224 </p> |
|
225 <dl> |
|
226 |
|
227 <dt><i>row</i></dt> |
|
228 <dd> |
|
229 start row (integer) |
|
230 </dd> |
|
231 <dt><i>count</i></dt> |
|
232 <dd> |
|
233 number of rows to remove (integer) |
|
234 </dd> |
|
235 <dt><i>parent</i></dt> |
|
236 <dd> |
|
237 parent index (QModelIndex) |
|
238 </dd> |
|
239 </dl> |
|
240 <dl> |
|
241 <dt>Return:</dt> |
|
242 <dd> |
|
243 flag indicating success (boolean) |
|
244 </dd> |
|
245 </dl> |
|
246 <a NAME="OpenSearchEngineModel.rowCount" ID="OpenSearchEngineModel.rowCount"></a> |
|
247 <h4>OpenSearchEngineModel.rowCount</h4> |
|
248 <b>rowCount</b>(<i>parent=None</i>) |
|
249 |
|
250 <p> |
|
251 Public method to get the number of rows of the model. |
|
252 </p> |
|
253 <dl> |
|
254 |
|
255 <dt><i>parent</i></dt> |
|
256 <dd> |
|
257 parent index (QModelIndex) |
|
258 </dd> |
|
259 </dl> |
|
260 <dl> |
|
261 <dt>Return:</dt> |
|
262 <dd> |
|
263 number of rows (integer) |
|
264 </dd> |
|
265 </dl> |
|
266 <a NAME="OpenSearchEngineModel.setData" ID="OpenSearchEngineModel.setData"></a> |
|
267 <h4>OpenSearchEngineModel.setData</h4> |
|
268 <b>setData</b>(<i>index, value, role=Qt.ItemDataRole.EditRole</i>) |
|
269 |
|
270 <p> |
|
271 Public method to set the data of a model cell. |
|
272 </p> |
|
273 <dl> |
|
274 |
|
275 <dt><i>index</i></dt> |
|
276 <dd> |
|
277 index of the model cell (QModelIndex) |
|
278 </dd> |
|
279 <dt><i>value</i></dt> |
|
280 <dd> |
|
281 value to be set |
|
282 </dd> |
|
283 <dt><i>role</i></dt> |
|
284 <dd> |
|
285 role of the data (integer) |
|
286 </dd> |
|
287 </dl> |
|
288 <dl> |
|
289 <dt>Return:</dt> |
|
290 <dd> |
|
291 flag indicating success (boolean) |
|
292 </dd> |
|
293 </dl> |
|
294 <div align="right"><a href="#top">Up</a></div> |
|
295 <hr /> |
|
296 </body></html> |