Documentation/Source/eric5.Helpviewer.AdBlock.AdBlockModel.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.AdBlock.AdBlockModel</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.AdBlock.AdBlockModel</h1>
<p>
Module implementing a model for the AdBlock dialog.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#AdBlockModel">AdBlockModel</a></td>
<td>Class implementing a model for the AdBlock dialog.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="AdBlockModel" ID="AdBlockModel"></a>
<h2>AdBlockModel</h2>
<p>
    Class implementing a model for the AdBlock dialog.
</p>
<h3>Derived from</h3>
QAbstractItemModel
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#AdBlockModel.__init__">AdBlockModel</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#AdBlockModel.__rulesChanged">__rulesChanged</a></td>
<td>Private slot to handle changes in rules.</td>
</tr><tr>
<td><a href="#AdBlockModel.columnCount">columnCount</a></td>
<td>Public method to get the number of columns.</td>
</tr><tr>
<td><a href="#AdBlockModel.data">data</a></td>
<td>Public method to get data from the model.</td>
</tr><tr>
<td><a href="#AdBlockModel.flags">flags</a></td>
<td>Public method to get flags for a node cell.</td>
</tr><tr>
<td><a href="#AdBlockModel.hasChildren">hasChildren</a></td>
<td>Public method to check, if a parent node has some children.</td>
</tr><tr>
<td><a href="#AdBlockModel.headerData">headerData</a></td>
<td>Public method to get the header data.</td>
</tr><tr>
<td><a href="#AdBlockModel.index">index</a></td>
<td>Public method to get a model index for a node cell.</td>
</tr><tr>
<td><a href="#AdBlockModel.parent">parent</a></td>
<td>Public method to get the index of the parent node.</td>
</tr><tr>
<td><a href="#AdBlockModel.removeRows">removeRows</a></td>
<td>Public method to remove bookmarks from the model.</td>
</tr><tr>
<td><a href="#AdBlockModel.rowCount">rowCount</a></td>
<td>Public method to determine the number of rows.</td>
</tr><tr>
<td><a href="#AdBlockModel.rule">rule</a></td>
<td>Public method to get the rule given it's index.</td>
</tr><tr>
<td><a href="#AdBlockModel.setData">setData</a></td>
<td>Public method to set the data of a node cell.</td>
</tr><tr>
<td><a href="#AdBlockModel.subscription">subscription</a></td>
<td>Public method to get the subscription given it's index.</td>
</tr><tr>
<td><a href="#AdBlockModel.subscriptionIndex">subscriptionIndex</a></td>
<td>Public method to get the index of a subscription.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="AdBlockModel.__init__" ID="AdBlockModel.__init__"></a>
<h4>AdBlockModel (Constructor)</h4>
<b>AdBlockModel</b>(<i>parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>parent</i></dt>
<dd>
reference to the parent object (QObject)
</dd>
</dl><a NAME="AdBlockModel.__rulesChanged" ID="AdBlockModel.__rulesChanged"></a>
<h4>AdBlockModel.__rulesChanged</h4>
<b>__rulesChanged</b>(<i></i>)
<p>
        Private slot to handle changes in rules.
</p><a NAME="AdBlockModel.columnCount" ID="AdBlockModel.columnCount"></a>
<h4>AdBlockModel.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="AdBlockModel.data" ID="AdBlockModel.data"></a>
<h4>AdBlockModel.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 bookmark to get data for (QModelIndex)
</dd><dt><i>role</i></dt>
<dd>
data role (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
bookmark data
</dd>
</dl><a NAME="AdBlockModel.flags" ID="AdBlockModel.flags"></a>
<h4>AdBlockModel.flags</h4>
<b>flags</b>(<i>index</i>)
<p>
        Public method to get flags for a node cell.
</p><dl>
<dt><i>index</i></dt>
<dd>
index of the node cell (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flags (Qt.ItemFlags)
</dd>
</dl><a NAME="AdBlockModel.hasChildren" ID="AdBlockModel.hasChildren"></a>
<h4>AdBlockModel.hasChildren</h4>
<b>hasChildren</b>(<i>parent=QModelIndex()</i>)
<p>
        Public method to check, if a parent node has some children.
</p><dl>
<dt><i>parent</i></dt>
<dd>
index of the parent node (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating the presence of children (boolean)
</dd>
</dl><a NAME="AdBlockModel.headerData" ID="AdBlockModel.headerData"></a>
<h4>AdBlockModel.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="AdBlockModel.index" ID="AdBlockModel.index"></a>
<h4>AdBlockModel.index</h4>
<b>index</b>(<i>row, column, parent=QModelIndex()</i>)
<p>
        Public method to get a model index for a node cell.
</p><dl>
<dt><i>row</i></dt>
<dd>
row number (integer)
</dd><dt><i>column</i></dt>
<dd>
column number (integer)
</dd><dt><i>parent</i></dt>
<dd>
index of the parent (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
index (QModelIndex)
</dd>
</dl><a NAME="AdBlockModel.parent" ID="AdBlockModel.parent"></a>
<h4>AdBlockModel.parent</h4>
<b>parent</b>(<i>index=QModelIndex()</i>)
<p>
        Public method to get the index of the parent node.
</p><dl>
<dt><i>index</i></dt>
<dd>
index of the child node (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
index of the parent node (QModelIndex)
</dd>
</dl><a NAME="AdBlockModel.removeRows" ID="AdBlockModel.removeRows"></a>
<h4>AdBlockModel.removeRows</h4>
<b>removeRows</b>(<i>row, count, parent=QModelIndex()</i>)
<p>
        Public method to remove bookmarks from the model.
</p><dl>
<dt><i>row</i></dt>
<dd>
row of the first bookmark to remove (integer)
</dd><dt><i>count</i></dt>
<dd>
number of bookmarks to remove (integer)
</dd><dt><i>index</i></dt>
<dd>
of the parent bookmark node (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating successful removal (boolean)
</dd>
</dl><a NAME="AdBlockModel.rowCount" ID="AdBlockModel.rowCount"></a>
<h4>AdBlockModel.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><a NAME="AdBlockModel.rule" ID="AdBlockModel.rule"></a>
<h4>AdBlockModel.rule</h4>
<b>rule</b>(<i>index</i>)
<p>
        Public method to get the rule given it's index.
</p><dl>
<dt><i>index</i></dt>
<dd>
index of the rule (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the rule (AdBlockRule)
</dd>
</dl><a NAME="AdBlockModel.setData" ID="AdBlockModel.setData"></a>
<h4>AdBlockModel.setData</h4>
<b>setData</b>(<i>index, value, role=Qt.EditRole</i>)
<p>
        Public method to set the data of a node cell.
</p><dl>
<dt><i>index</i></dt>
<dd>
index of the node cell (QModelIndex)
</dd><dt><i>value</i></dt>
<dd>
value to be set
</dd><dt><i>role</i></dt>
<dd>
role of the data (integer)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
flag indicating success (boolean)
</dd>
</dl><a NAME="AdBlockModel.subscription" ID="AdBlockModel.subscription"></a>
<h4>AdBlockModel.subscription</h4>
<b>subscription</b>(<i>index</i>)
<p>
        Public method to get the subscription given it's index.
</p><dl>
<dt><i>index</i></dt>
<dd>
index of the subscription (QModelIndex)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
reference to the subscription (AdBlockSubscription)
</dd>
</dl><a NAME="AdBlockModel.subscriptionIndex" ID="AdBlockModel.subscriptionIndex"></a>
<h4>AdBlockModel.subscriptionIndex</h4>
<b>subscriptionIndex</b>(<i>subscription</i>)
<p>
        Public method to get the index of a subscription.
</p><dl>
<dt><i>subscription</i></dt>
<dd>
reference to the subscription (AdBlockSubscription)
</dd>
</dl><dl>
<dt>Returns:</dt>
<dd>
index of the subscription (QModelIndex)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>