src/eric7/Documentation/Source/eric7.WebBrowser.SpeedDial.Page.html

Fri, 22 Dec 2023 17:24:07 +0100

author
Detlev Offenbach <detlev@die-offenbachs.de>
date
Fri, 22 Dec 2023 17:24:07 +0100
branch
eric7
changeset 10436
f6881d10e995
parent 9209
b99e7fd55fd3
child 10479
856476537696
permissions
-rw-r--r--

Converted some source code documentation to the new style.

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

<p>
Module implementing a structure to hold the data for a speed dial page.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#Page">Page</a></td>
<td>Class to hold the data for a speed dial page.</td>
</tr>
</table>
<h3>Functions</h3>

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

<p>
    Class to hold the data for a speed dial page.
</p>
<h3>Derived from</h3>
None
<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="#Page.__init__">Page</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#Page.__eq__">__eq__</a></td>
<td>Special method implementing the equality operator.</td>
</tr>
<tr>
<td><a href="#Page.isValid">isValid</a></td>
<td>Public method to check the validity.</td>
</tr>
</table>
<h3>Static Methods</h3>

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

<a NAME="Page.__init__" ID="Page.__init__"></a>
<h4>Page (Constructor)</h4>
<b>Page</b>(<i>url="", title="", broken=False</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>url</i> (str)</dt>
<dd>
URL of the page
</dd>
<dt><i>title</i> (str)</dt>
<dd>
title of the page
</dd>
<dt><i>broken</i> (bool)</dt>
<dd>
flag indicating a broken connection
</dd>
</dl>
<a NAME="Page.__eq__" ID="Page.__eq__"></a>
<h4>Page.__eq__</h4>
<b>__eq__</b>(<i>other</i>)

<p>
        Special method implementing the equality operator.
</p>
<dl>

<dt><i>other</i> (Page)</dt>
<dd>
reference to the other page object
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
flag indicating equality
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<a NAME="Page.isValid" ID="Page.isValid"></a>
<h4>Page.isValid</h4>
<b>isValid</b>(<i></i>)

<p>
        Public method to check the validity.
</p>
<dl>
<dt>Return:</dt>
<dd>
flag indicating a valid object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
bool
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>

eric ide

mercurial