|
1 <!DOCTYPE html> |
|
2 <html><head> |
|
3 <title>eric6.Helpviewer.OpenSearch.OpenSearchEngineModel</title> |
|
4 <meta charset="UTF-8"> |
|
5 <style> |
|
6 body { |
|
7 background: #EDECE6; |
|
8 margin: 0em 1em 10em 1em; |
|
9 color: black; |
|
10 } |
|
11 |
|
12 h1 { color: white; background: #85774A; } |
|
13 h2 { color: white; background: #85774A; } |
|
14 h3 { color: white; background: #9D936E; } |
|
15 h4 { color: white; background: #9D936E; } |
|
16 |
|
17 a { color: #BA6D36; } |
|
18 |
|
19 </style> |
|
20 </head> |
|
21 <body><a NAME="top" ID="top"></a> |
|
22 <h1>eric6.Helpviewer.OpenSearch.OpenSearchEngineModel</h1> |
|
23 <p> |
|
24 Module implementing a model for search engines. |
|
25 </p> |
|
26 <h3>Global Attributes</h3> |
|
27 <table> |
|
28 <tr><td>None</td></tr> |
|
29 </table> |
|
30 <h3>Classes</h3> |
|
31 <table> |
|
32 <tr> |
|
33 <td><a href="#OpenSearchEngineModel">OpenSearchEngineModel</a></td> |
|
34 <td>Class implementing a model for search engines.</td> |
|
35 </tr> |
|
36 </table> |
|
37 <h3>Functions</h3> |
|
38 <table> |
|
39 <tr><td>None</td></tr> |
|
40 </table> |
|
41 <hr /><hr /> |
|
42 <a NAME="OpenSearchEngineModel" ID="OpenSearchEngineModel"></a> |
|
43 <h2>OpenSearchEngineModel</h2> |
|
44 <p> |
|
45 Class implementing a model for search engines. |
|
46 </p> |
|
47 <h3>Derived from</h3> |
|
48 QAbstractTableModel |
|
49 <h3>Class Attributes</h3> |
|
50 <table> |
|
51 <tr><td>None</td></tr> |
|
52 </table> |
|
53 <h3>Class Methods</h3> |
|
54 <table> |
|
55 <tr><td>None</td></tr> |
|
56 </table> |
|
57 <h3>Methods</h3> |
|
58 <table> |
|
59 <tr> |
|
60 <td><a href="#OpenSearchEngineModel.__init__">OpenSearchEngineModel</a></td> |
|
61 <td>Constructor</td> |
|
62 </tr><tr> |
|
63 <td><a href="#OpenSearchEngineModel.__enginesChanged">__enginesChanged</a></td> |
|
64 <td>Private slot handling a change of the registered engines.</td> |
|
65 </tr><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><tr> |
|
69 <td><a href="#OpenSearchEngineModel.data">data</a></td> |
|
70 <td>Public method to get data from the model.</td> |
|
71 </tr><tr> |
|
72 <td><a href="#OpenSearchEngineModel.flags">flags</a></td> |
|
73 <td>Public method to get flags for a model cell.</td> |
|
74 </tr><tr> |
|
75 <td><a href="#OpenSearchEngineModel.headerData">headerData</a></td> |
|
76 <td>Public method to get the header data.</td> |
|
77 </tr><tr> |
|
78 <td><a href="#OpenSearchEngineModel.removeRows">removeRows</a></td> |
|
79 <td>Public method to remove entries from the model.</td> |
|
80 </tr><tr> |
|
81 <td><a href="#OpenSearchEngineModel.rowCount">rowCount</a></td> |
|
82 <td>Public method to get the number of rows of the model.</td> |
|
83 </tr><tr> |
|
84 <td><a href="#OpenSearchEngineModel.setData">setData</a></td> |
|
85 <td>Public method to set the data of a model cell.</td> |
|
86 </tr> |
|
87 </table> |
|
88 <h3>Static Methods</h3> |
|
89 <table> |
|
90 <tr><td>None</td></tr> |
|
91 </table> |
|
92 <a NAME="OpenSearchEngineModel.__init__" ID="OpenSearchEngineModel.__init__"></a> |
|
93 <h4>OpenSearchEngineModel (Constructor)</h4> |
|
94 <b>OpenSearchEngineModel</b>(<i>manager, parent=None</i>) |
|
95 <p> |
|
96 Constructor |
|
97 </p><dl> |
|
98 <dt><i>manager</i></dt> |
|
99 <dd> |
|
100 reference to the search engine manager |
|
101 (OpenSearchManager) |
|
102 </dd><dt><i>parent</i></dt> |
|
103 <dd> |
|
104 reference to the parent object (QObject) |
|
105 </dd> |
|
106 </dl><a NAME="OpenSearchEngineModel.__enginesChanged" ID="OpenSearchEngineModel.__enginesChanged"></a> |
|
107 <h4>OpenSearchEngineModel.__enginesChanged</h4> |
|
108 <b>__enginesChanged</b>(<i></i>) |
|
109 <p> |
|
110 Private slot handling a change of the registered engines. |
|
111 </p><a NAME="OpenSearchEngineModel.columnCount" ID="OpenSearchEngineModel.columnCount"></a> |
|
112 <h4>OpenSearchEngineModel.columnCount</h4> |
|
113 <b>columnCount</b>(<i>parent=QModelIndex()</i>) |
|
114 <p> |
|
115 Public method to get the number of columns of the model. |
|
116 </p><dl> |
|
117 <dt><i>parent</i></dt> |
|
118 <dd> |
|
119 parent index (QModelIndex) |
|
120 </dd> |
|
121 </dl><dl> |
|
122 <dt>Returns:</dt> |
|
123 <dd> |
|
124 number of columns (integer) |
|
125 </dd> |
|
126 </dl><a NAME="OpenSearchEngineModel.data" ID="OpenSearchEngineModel.data"></a> |
|
127 <h4>OpenSearchEngineModel.data</h4> |
|
128 <b>data</b>(<i>index, role</i>) |
|
129 <p> |
|
130 Public method to get data from the model. |
|
131 </p><dl> |
|
132 <dt><i>index</i></dt> |
|
133 <dd> |
|
134 index to get data for (QModelIndex) |
|
135 </dd><dt><i>role</i></dt> |
|
136 <dd> |
|
137 role of the data to retrieve (integer) |
|
138 </dd> |
|
139 </dl><dl> |
|
140 <dt>Returns:</dt> |
|
141 <dd> |
|
142 requested data |
|
143 </dd> |
|
144 </dl><a NAME="OpenSearchEngineModel.flags" ID="OpenSearchEngineModel.flags"></a> |
|
145 <h4>OpenSearchEngineModel.flags</h4> |
|
146 <b>flags</b>(<i>index</i>) |
|
147 <p> |
|
148 Public method to get flags for a model cell. |
|
149 </p><dl> |
|
150 <dt><i>index</i></dt> |
|
151 <dd> |
|
152 index of the model cell (QModelIndex) |
|
153 </dd> |
|
154 </dl><dl> |
|
155 <dt>Returns:</dt> |
|
156 <dd> |
|
157 flags (Qt.ItemFlags) |
|
158 </dd> |
|
159 </dl><a NAME="OpenSearchEngineModel.headerData" ID="OpenSearchEngineModel.headerData"></a> |
|
160 <h4>OpenSearchEngineModel.headerData</h4> |
|
161 <b>headerData</b>(<i>section, orientation, role=Qt.DisplayRole</i>) |
|
162 <p> |
|
163 Public method to get the header data. |
|
164 </p><dl> |
|
165 <dt><i>section</i></dt> |
|
166 <dd> |
|
167 section number (integer) |
|
168 </dd><dt><i>orientation</i></dt> |
|
169 <dd> |
|
170 header orientation (Qt.Orientation) |
|
171 </dd><dt><i>role</i></dt> |
|
172 <dd> |
|
173 data role (integer) |
|
174 </dd> |
|
175 </dl><dl> |
|
176 <dt>Returns:</dt> |
|
177 <dd> |
|
178 header data |
|
179 </dd> |
|
180 </dl><a NAME="OpenSearchEngineModel.removeRows" ID="OpenSearchEngineModel.removeRows"></a> |
|
181 <h4>OpenSearchEngineModel.removeRows</h4> |
|
182 <b>removeRows</b>(<i>row, count, parent=QModelIndex()</i>) |
|
183 <p> |
|
184 Public method to remove entries from the model. |
|
185 </p><dl> |
|
186 <dt><i>row</i></dt> |
|
187 <dd> |
|
188 start row (integer) |
|
189 </dd><dt><i>count</i></dt> |
|
190 <dd> |
|
191 number of rows to remove (integer) |
|
192 </dd><dt><i>parent</i></dt> |
|
193 <dd> |
|
194 parent index (QModelIndex) |
|
195 </dd> |
|
196 </dl><dl> |
|
197 <dt>Returns:</dt> |
|
198 <dd> |
|
199 flag indicating success (boolean) |
|
200 </dd> |
|
201 </dl><a NAME="OpenSearchEngineModel.rowCount" ID="OpenSearchEngineModel.rowCount"></a> |
|
202 <h4>OpenSearchEngineModel.rowCount</h4> |
|
203 <b>rowCount</b>(<i>parent=QModelIndex()</i>) |
|
204 <p> |
|
205 Public method to get the number of rows of the model. |
|
206 </p><dl> |
|
207 <dt><i>parent</i></dt> |
|
208 <dd> |
|
209 parent index (QModelIndex) |
|
210 </dd> |
|
211 </dl><dl> |
|
212 <dt>Returns:</dt> |
|
213 <dd> |
|
214 number of rows (integer) |
|
215 </dd> |
|
216 </dl><a NAME="OpenSearchEngineModel.setData" ID="OpenSearchEngineModel.setData"></a> |
|
217 <h4>OpenSearchEngineModel.setData</h4> |
|
218 <b>setData</b>(<i>index, value, role=Qt.EditRole</i>) |
|
219 <p> |
|
220 Public method to set the data of a model cell. |
|
221 </p><dl> |
|
222 <dt><i>index</i></dt> |
|
223 <dd> |
|
224 index of the model cell (QModelIndex) |
|
225 </dd><dt><i>value</i></dt> |
|
226 <dd> |
|
227 value to be set |
|
228 </dd><dt><i>role</i></dt> |
|
229 <dd> |
|
230 role of the data (integer) |
|
231 </dd> |
|
232 </dl><dl> |
|
233 <dt>Returns:</dt> |
|
234 <dd> |
|
235 flag indicating success (boolean) |
|
236 </dd> |
|
237 </dl> |
|
238 <div align="right"><a href="#top">Up</a></div> |
|
239 <hr /> |
|
240 </body></html> |