Documentation/Source/eric4.Helpviewer.History.HistoryModel.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.History.HistoryModel</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.History.HistoryModel</h1>
24 <p>
25 Module implementing the history model.
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="#HistoryModel">HistoryModel</a></td>
35 <td>Class implementing the history model.</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="HistoryModel" ID="HistoryModel"></a>
44 <h2>HistoryModel</h2>
45 <p>
46 Class implementing the history model.
47 </p>
48 <h3>Derived from</h3>
49 QAbstractTableModel
50 <h3>Class Attributes</h3>
51 <table>
52 <tr><td>DateRole</td></tr><tr><td>DateTimeRole</td></tr><tr><td>MaxRole</td></tr><tr><td>TitleRole</td></tr><tr><td>UrlRole</td></tr><tr><td>UrlStringRole</td></tr>
53 </table>
54 <h3>Methods</h3>
55 <table>
56 <tr>
57 <td><a href="#HistoryModel.__init__">HistoryModel</a></td>
58 <td>Constructor</td>
59 </tr><tr>
60 <td><a href="#HistoryModel.columnCount">columnCount</a></td>
61 <td>Public method to get the number of columns.</td>
62 </tr><tr>
63 <td><a href="#HistoryModel.data">data</a></td>
64 <td>Public method to get data from the model.</td>
65 </tr><tr>
66 <td><a href="#HistoryModel.entryAdded">entryAdded</a></td>
67 <td>Public slot to handle the addition of a history entry.</td>
68 </tr><tr>
69 <td><a href="#HistoryModel.entryUpdated">entryUpdated</a></td>
70 <td>Public slot to handle the update of a history entry.</td>
71 </tr><tr>
72 <td><a href="#HistoryModel.headerData">headerData</a></td>
73 <td>Public method to get the header data.</td>
74 </tr><tr>
75 <td><a href="#HistoryModel.historyReset">historyReset</a></td>
76 <td>Public slot to reset the model.</td>
77 </tr><tr>
78 <td><a href="#HistoryModel.removeRows">removeRows</a></td>
79 <td>Public method to remove history entries from the model.</td>
80 </tr><tr>
81 <td><a href="#HistoryModel.rowCount">rowCount</a></td>
82 <td>Public method to determine the number of rows.</td>
83 </tr>
84 </table>
85 <a NAME="HistoryModel.__init__" ID="HistoryModel.__init__"></a>
86 <h4>HistoryModel (Constructor)</h4>
87 <b>HistoryModel</b>(<i>historyManager, parent = None</i>)
88 <p>
89 Constructor
90 </p><dl>
91 <dt><i>historyManager</i></dt>
92 <dd>
93 reference to the history manager object (HistoryManager)
94 </dd><dt><i>parent</i></dt>
95 <dd>
96 reference to the parent object (QObject)
97 </dd>
98 </dl><a NAME="HistoryModel.columnCount" ID="HistoryModel.columnCount"></a>
99 <h4>HistoryModel.columnCount</h4>
100 <b>columnCount</b>(<i>parent = QModelIndex()</i>)
101 <p>
102 Public method to get the number of columns.
103 </p><dl>
104 <dt><i>parent</i></dt>
105 <dd>
106 index of parent (QModelIndex)
107 </dd>
108 </dl><dl>
109 <dt>Returns:</dt>
110 <dd>
111 number of columns (integer)
112 </dd>
113 </dl><a NAME="HistoryModel.data" ID="HistoryModel.data"></a>
114 <h4>HistoryModel.data</h4>
115 <b>data</b>(<i>index, role = Qt.DisplayRole</i>)
116 <p>
117 Public method to get data from the model.
118 </p><dl>
119 <dt><i>index</i></dt>
120 <dd>
121 index of history entry to get data for (QModelIndex)
122 </dd><dt><i>role</i></dt>
123 <dd>
124 data role (integer)
125 </dd>
126 </dl><dl>
127 <dt>Returns:</dt>
128 <dd>
129 history entry data (QVariant)
130 </dd>
131 </dl><a NAME="HistoryModel.entryAdded" ID="HistoryModel.entryAdded"></a>
132 <h4>HistoryModel.entryAdded</h4>
133 <b>entryAdded</b>(<i></i>)
134 <p>
135 Public slot to handle the addition of a history entry.
136 </p><a NAME="HistoryModel.entryUpdated" ID="HistoryModel.entryUpdated"></a>
137 <h4>HistoryModel.entryUpdated</h4>
138 <b>entryUpdated</b>(<i>row</i>)
139 <p>
140 Public slot to handle the update of a history entry.
141 </p><dl>
142 <dt><i>row</i></dt>
143 <dd>
144 row number of the updated entry (integer)
145 </dd>
146 </dl><a NAME="HistoryModel.headerData" ID="HistoryModel.headerData"></a>
147 <h4>HistoryModel.headerData</h4>
148 <b>headerData</b>(<i>section, orientation, role = Qt.DisplayRole</i>)
149 <p>
150 Public method to get the header data.
151 </p><dl>
152 <dt><i>section</i></dt>
153 <dd>
154 section number (integer)
155 </dd><dt><i>orientation</i></dt>
156 <dd>
157 header orientation (Qt.Orientation)
158 </dd><dt><i>role</i></dt>
159 <dd>
160 data role (integer)
161 </dd>
162 </dl><dl>
163 <dt>Returns:</dt>
164 <dd>
165 header data (QVariant)
166 </dd>
167 </dl><a NAME="HistoryModel.historyReset" ID="HistoryModel.historyReset"></a>
168 <h4>HistoryModel.historyReset</h4>
169 <b>historyReset</b>(<i></i>)
170 <p>
171 Public slot to reset the model.
172 </p><a NAME="HistoryModel.removeRows" ID="HistoryModel.removeRows"></a>
173 <h4>HistoryModel.removeRows</h4>
174 <b>removeRows</b>(<i>row, count, parent = QModelIndex()</i>)
175 <p>
176 Public method to remove history entries from the model.
177 </p><dl>
178 <dt><i>row</i></dt>
179 <dd>
180 row of the first history entry to remove (integer)
181 </dd><dt><i>count</i></dt>
182 <dd>
183 number of history entries to remove (integer)
184 </dd><dt><i>index</i></dt>
185 <dd>
186 of the parent entry (QModelIndex)
187 </dd>
188 </dl><dl>
189 <dt>Returns:</dt>
190 <dd>
191 flag indicating successful removal (boolean)
192 </dd>
193 </dl><a NAME="HistoryModel.rowCount" ID="HistoryModel.rowCount"></a>
194 <h4>HistoryModel.rowCount</h4>
195 <b>rowCount</b>(<i>parent = QModelIndex()</i>)
196 <p>
197 Public method to determine the number of rows.
198 </p><dl>
199 <dt><i>parent</i></dt>
200 <dd>
201 index of parent (QModelIndex)
202 </dd>
203 </dl><dl>
204 <dt>Returns:</dt>
205 <dd>
206 number of rows (integer)
207 </dd>
208 </dl>
209 <div align="right"><a href="#top">Up</a></div>
210 <hr />
211 </body></html>

eric ide

mercurial