src/eric7/Documentation/Source/eric7.WebBrowser.CookieJar.CookieExceptionsModel.html

Thu, 07 Jul 2022 11:23:56 +0200

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Thu, 07 Jul 2022 11:23:56 +0200
branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
eric7/Documentation/Source/eric7.WebBrowser.CookieJar.CookieExceptionsModel.html@d64760b2da50
child 10436
f6881d10e995
permissions
-rw-r--r--

Reorganized the project structure to use the source layout in order to support up-to-date build systems with "pyproject.toml".

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.CookieJar.CookieExceptionsModel</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.CookieJar.CookieExceptionsModel</h1>

<p>
Module implementing the cookie exceptions model.
</p>
<h3>Global Attributes</h3>

<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>

<table>

<tr>
<td><a href="#CookieExceptionsModel">CookieExceptionsModel</a></td>
<td>Class implementing the cookie exceptions model.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="CookieExceptionsModel" ID="CookieExceptionsModel"></a>
<h2>CookieExceptionsModel</h2>

<p>
    Class implementing the cookie exceptions model.
</p>
<h3>Derived from</h3>
QAbstractTableModel
<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="#CookieExceptionsModel.__init__">CookieExceptionsModel</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#CookieExceptionsModel.__addHost">__addHost</a></td>
<td>Private method to add a host to an exception list.</td>
</tr>
<tr>
<td><a href="#CookieExceptionsModel.addRule">addRule</a></td>
<td>Public method to add an exception rule.</td>
</tr>
<tr>
<td><a href="#CookieExceptionsModel.columnCount">columnCount</a></td>
<td>Public method to get the number of columns of the model.</td>
</tr>
<tr>
<td><a href="#CookieExceptionsModel.data">data</a></td>
<td>Public method to get data from the model.</td>
</tr>
<tr>
<td><a href="#CookieExceptionsModel.headerData">headerData</a></td>
<td>Public method to get header data from the model.</td>
</tr>
<tr>
<td><a href="#CookieExceptionsModel.removeRows">removeRows</a></td>
<td>Public method to remove entries from the model.</td>
</tr>
<tr>
<td><a href="#CookieExceptionsModel.rowCount">rowCount</a></td>
<td>Public method to get the number of rows of the model.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="CookieExceptionsModel.__init__" ID="CookieExceptionsModel.__init__"></a>
<h4>CookieExceptionsModel (Constructor)</h4>
<b>CookieExceptionsModel</b>(<i>cookieJar, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>cookieJar</i></dt>
<dd>
reference to the cookie jar (CookieJar)
</dd>
<dt><i>parent</i></dt>
<dd>
reference to the parent object (QObject)
</dd>
</dl>
<a NAME="CookieExceptionsModel.__addHost" ID="CookieExceptionsModel.__addHost"></a>
<h4>CookieExceptionsModel.__addHost</h4>
<b>__addHost</b>(<i>host, addList, removeList1, removeList2</i>)

<p>
        Private method to add a host to an exception list.
</p>
<dl>

<dt><i>host</i></dt>
<dd>
name of the host to add (string)
</dd>
<dt><i>addList</i></dt>
<dd>
reference to the list to add it to (list of strings)
</dd>
<dt><i>removeList1</i></dt>
<dd>
reference to first list to remove it from
            (list of strings)
</dd>
<dt><i>removeList2</i></dt>
<dd>
reference to second list to remove it from
            (list of strings)
</dd>
</dl>
<a NAME="CookieExceptionsModel.addRule" ID="CookieExceptionsModel.addRule"></a>
<h4>CookieExceptionsModel.addRule</h4>
<b>addRule</b>(<i>host, rule</i>)

<p>
        Public method to add an exception rule.
</p>
<dl>

<dt><i>host</i></dt>
<dd>
name of the host to add a rule for (string)
</dd>
<dt><i>rule</i></dt>
<dd>
type of rule to add (CookieJar.Allow, CookieJar.Block or
            CookieJar.AllowForSession)
</dd>
</dl>
<a NAME="CookieExceptionsModel.columnCount" ID="CookieExceptionsModel.columnCount"></a>
<h4>CookieExceptionsModel.columnCount</h4>
<b>columnCount</b>(<i>parent=None</i>)

<p>
        Public method to get the number of columns of the model.
</p>
<dl>

<dt><i>parent</i></dt>
<dd>
parent index (QModelIndex)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
number of columns (integer)
</dd>
</dl>
<a NAME="CookieExceptionsModel.data" ID="CookieExceptionsModel.data"></a>
<h4>CookieExceptionsModel.data</h4>
<b>data</b>(<i>index, role</i>)

<p>
        Public method to get data from the model.
</p>
<dl>

<dt><i>index</i></dt>
<dd>
index to get data for (QModelIndex)
</dd>
<dt><i>role</i></dt>
<dd>
role of the data to retrieve (integer)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
requested data
</dd>
</dl>
<a NAME="CookieExceptionsModel.headerData" ID="CookieExceptionsModel.headerData"></a>
<h4>CookieExceptionsModel.headerData</h4>
<b>headerData</b>(<i>section, orientation, role</i>)

<p>
        Public method to get header data from the model.
</p>
<dl>

<dt><i>section</i></dt>
<dd>
section number (integer)
</dd>
<dt><i>orientation</i></dt>
<dd>
orientation (Qt.Orientation)
</dd>
<dt><i>role</i></dt>
<dd>
role of the data to retrieve (Qt.ItemDataRole)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
requested data
</dd>
</dl>
<a NAME="CookieExceptionsModel.removeRows" ID="CookieExceptionsModel.removeRows"></a>
<h4>CookieExceptionsModel.removeRows</h4>
<b>removeRows</b>(<i>row, count, parent=None</i>)

<p>
        Public method to remove entries from the model.
</p>
<dl>

<dt><i>row</i></dt>
<dd>
start row (integer)
</dd>
<dt><i>count</i></dt>
<dd>
number of rows to remove (integer)
</dd>
<dt><i>parent</i></dt>
<dd>
parent index (QModelIndex)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating success (boolean)
</dd>
</dl>
<a NAME="CookieExceptionsModel.rowCount" ID="CookieExceptionsModel.rowCount"></a>
<h4>CookieExceptionsModel.rowCount</h4>
<b>rowCount</b>(<i>parent=None</i>)

<p>
        Public method to get the number of rows of the model.
</p>
<dl>

<dt><i>parent</i></dt>
<dd>
parent index (QModelIndex)
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
number of rows (integer)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial