Documentation/Source/eric6.Helpviewer.History.HistoryModel.html

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

eric ide

mercurial