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