Documentation/Source/eric4.Helpviewer.OpenSearch.OpenSearchEngineModel.html

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

eric ide

mercurial