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

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
<html><head>
<title>eric5.Helpviewer.History.HistoryModel</title>
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric5.Helpviewer.History.HistoryModel</h1>
<p>
Module implementing the history model.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#HistoryModel">HistoryModel</a></td>
<td>Class implementing the history model.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="HistoryModel" ID="HistoryModel"></a>
<h2>HistoryModel</h2>
<p>
    Class implementing the history model.
</p>
<h3>Derived from</h3>
QAbstractTableModel
<h3>Class Attributes</h3>
<table>
<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>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#HistoryModel.__init__">HistoryModel</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#HistoryModel.columnCount">columnCount</a></td>
<td>Public method to get the number of columns.</td>
</tr><tr>
<td><a href="#HistoryModel.data">data</a></td>
<td>Public method to get data from the model.</td>
</tr><tr>
<td><a href="#HistoryModel.entryAdded">entryAdded</a></td>
<td>Public slot to handle the addition of a history entry.</td>
</tr><tr>
<td><a href="#HistoryModel.entryUpdated">entryUpdated</a></td>
<td>Public slot to handle the update of a history entry.</td>
</tr><tr>
<td><a href="#HistoryModel.headerData">headerData</a></td>
<td>Public method to get the header data.</td>
</tr><tr>
<td><a href="#HistoryModel.historyReset">historyReset</a></td>
<td>Public slot to reset the model.</td>
</tr><tr>
<td><a href="#HistoryModel.removeRows">removeRows</a></td>
<td>Public method to remove history entries from the model.</td>
</tr><tr>
<td><a href="#HistoryModel.rowCount">rowCount</a></td>
<td>Public method to determine the number of rows.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="HistoryModel.__init__" ID="HistoryModel.__init__"></a>
<h4>HistoryModel (Constructor)</h4>
<b>HistoryModel</b>(<i>historyManager, parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>historyManager</i></dt>
<dd>
reference to the history manager object (HistoryManager)
</dd><dt><i>parent</i></dt>
<dd>
reference to the parent object (QObject)
</dd>
</dl><a NAME="HistoryModel.columnCount" ID="HistoryModel.columnCount"></a>
<h4>HistoryModel.columnCount</h4>
<b>columnCount</b>(<i>parent=QModelIndex()</i>)
<p>
        Public method to get the number of columns.
</p><dl>
<dt><i>parent</i></dt>
<dd>
index of parent (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
number of columns (integer)
</dd>
</dl><a NAME="HistoryModel.data" ID="HistoryModel.data"></a>
<h4>HistoryModel.data</h4>
<b>data</b>(<i>index, role=Qt.DisplayRole</i>)
<p>
        Public method to get data from the model.
</p><dl>
<dt><i>index</i></dt>
<dd>
index of history entry to get data for (QModelIndex)
</dd><dt><i>role</i></dt>
<dd>
data role (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
history entry data
</dd>
</dl><a NAME="HistoryModel.entryAdded" ID="HistoryModel.entryAdded"></a>
<h4>HistoryModel.entryAdded</h4>
<b>entryAdded</b>(<i></i>)
<p>
        Public slot to handle the addition of a history entry.
</p><a NAME="HistoryModel.entryUpdated" ID="HistoryModel.entryUpdated"></a>
<h4>HistoryModel.entryUpdated</h4>
<b>entryUpdated</b>(<i>row</i>)
<p>
        Public slot to handle the update of a history entry.
</p><dl>
<dt><i>row</i></dt>
<dd>
row number of the updated entry (integer)
</dd>
</dl><a NAME="HistoryModel.headerData" ID="HistoryModel.headerData"></a>
<h4>HistoryModel.headerData</h4>
<b>headerData</b>(<i>section, orientation, role=Qt.DisplayRole</i>)
<p>
        Public method to get the header data.
</p><dl>
<dt><i>section</i></dt>
<dd>
section number (integer)
</dd><dt><i>orientation</i></dt>
<dd>
header orientation (Qt.Orientation)
</dd><dt><i>role</i></dt>
<dd>
data role (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
header data
</dd>
</dl><a NAME="HistoryModel.historyReset" ID="HistoryModel.historyReset"></a>
<h4>HistoryModel.historyReset</h4>
<b>historyReset</b>(<i></i>)
<p>
        Public slot to reset the model.
</p><a NAME="HistoryModel.removeRows" ID="HistoryModel.removeRows"></a>
<h4>HistoryModel.removeRows</h4>
<b>removeRows</b>(<i>row, count, parent=QModelIndex()</i>)
<p>
        Public method to remove history entries from the model.
</p><dl>
<dt><i>row</i></dt>
<dd>
row of the first history entry to remove (integer)
</dd><dt><i>count</i></dt>
<dd>
number of history entries to remove (integer)
</dd><dt><i>index</i></dt>
<dd>
of the parent entry (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating successful removal (boolean)
</dd>
</dl><a NAME="HistoryModel.rowCount" ID="HistoryModel.rowCount"></a>
<h4>HistoryModel.rowCount</h4>
<b>rowCount</b>(<i>parent=QModelIndex()</i>)
<p>
        Public method to determine the number of rows.
</p><dl>
<dt><i>parent</i></dt>
<dd>
index of parent (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
number of rows (integer)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>