diff -r 3fc8dfeb6ebe -r b99e7fd55fd3 src/eric7/Documentation/Source/eric7.EricGui.EricOverrideCursor.html --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/src/eric7/Documentation/Source/eric7.EricGui.EricOverrideCursor.html Thu Jul 07 11:23:56 2022 +0200 @@ -0,0 +1,340 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.EricGui.EricOverrideCursor</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.EricGui.EricOverrideCursor</h1> + +<p> +Module implementing a context manager class for an override cursor and a +QProcess class controlling an override cursor. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#EricOverrideCursor">EricOverrideCursor</a></td> +<td>Class implementing a context manager class for an override cursor.</td> +</tr> +<tr> +<td><a href="#EricOverrideCursorProcess">EricOverrideCursorProcess</a></td> +<td>Class implementing a QProcess subclass controlling an override cursor.</td> +</tr> +<tr> +<td><a href="#EricOverridenCursor">EricOverridenCursor</a></td> +<td>Class implementing a context manager class for an overriden cursor.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="EricOverrideCursor" ID="EricOverrideCursor"></a> +<h2>EricOverrideCursor</h2> + +<p> + Class implementing a context manager class for an override cursor. +</p> +<h3>Derived from</h3> +contextlib.AbstractContextManager +<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="#EricOverrideCursor.__init__">EricOverrideCursor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#EricOverrideCursor.__enter__">__enter__</a></td> +<td>Special method called when entering the runtime ccontext.</td> +</tr> +<tr> +<td><a href="#EricOverrideCursor.__exit__">__exit__</a></td> +<td>Special method called when exiting the runtime ccontext.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="EricOverrideCursor.__init__" ID="EricOverrideCursor.__init__"></a> +<h4>EricOverrideCursor (Constructor)</h4> +<b>EricOverrideCursor</b>(<i>cursorShape=Qt.CursorShape.WaitCursor</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>cursorShape</i> (Qt.CursorShape)</dt> +<dd> +shape of the override cursor +</dd> +</dl> +<a NAME="EricOverrideCursor.__enter__" ID="EricOverrideCursor.__enter__"></a> +<h4>EricOverrideCursor.__enter__</h4> +<b>__enter__</b>(<i></i>) + +<p> + Special method called when entering the runtime ccontext. +</p> +<dl> +<dt>Return:</dt> +<dd> +reference to the context manager object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +EricOverrideCursor +</dd> +</dl> +<a NAME="EricOverrideCursor.__exit__" ID="EricOverrideCursor.__exit__"></a> +<h4>EricOverrideCursor.__exit__</h4> +<b>__exit__</b>(<i>exc_type, exc_value, traceback</i>) + +<p> + Special method called when exiting the runtime ccontext. +</p> +<dl> + +<dt><i>exc_type</i></dt> +<dd> +type of an exception raised in the runtime context +</dd> +<dt><i>exc_value</i></dt> +<dd> +value of an exception raised in the runtime context +</dd> +<dt><i>traceback</i></dt> +<dd> +traceback of an exception raised in the runtime + context +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +always returns None to not suppress any exception +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +None +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="EricOverrideCursorProcess" ID="EricOverrideCursorProcess"></a> +<h2>EricOverrideCursorProcess</h2> + +<p> + Class implementing a QProcess subclass controlling an override cursor. +</p> +<h3>Derived from</h3> +QProcess +<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="#EricOverrideCursorProcess.__init__">EricOverrideCursorProcess</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#EricOverrideCursorProcess.__processFinished">__processFinished</a></td> +<td>Private slot resetting the cursor when the process finished.</td> +</tr> +<tr> +<td><a href="#EricOverrideCursorProcess.__processStarted">__processStarted</a></td> +<td>Private slot setting the cursor after the process has started.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="EricOverrideCursorProcess.__init__" ID="EricOverrideCursorProcess.__init__"></a> +<h4>EricOverrideCursorProcess (Constructor)</h4> +<b>EricOverrideCursorProcess</b>(<i>parent=None, cursorShape=Qt.CursorShape.WaitCursor</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>parent</i> (QObject)</dt> +<dd> +reference to the parent object +</dd> +<dt><i>cursorShape</i> (Qt.CursorShape)</dt> +<dd> +shape of the override cursor +</dd> +</dl> +<a NAME="EricOverrideCursorProcess.__processFinished" ID="EricOverrideCursorProcess.__processFinished"></a> +<h4>EricOverrideCursorProcess.__processFinished</h4> +<b>__processFinished</b>(<i></i>) + +<p> + Private slot resetting the cursor when the process finished. +</p> +<a NAME="EricOverrideCursorProcess.__processStarted" ID="EricOverrideCursorProcess.__processStarted"></a> +<h4>EricOverrideCursorProcess.__processStarted</h4> +<b>__processStarted</b>(<i></i>) + +<p> + Private slot setting the cursor after the process has started. +</p> +<div align="right"><a href="#top">Up</a></div> +<hr /> +<hr /> +<a NAME="EricOverridenCursor" ID="EricOverridenCursor"></a> +<h2>EricOverridenCursor</h2> + +<p> + Class implementing a context manager class for an overriden cursor. +</p> +<p> + The cursor is reset upon entering the runtime context and restored + upon exiting it. +</p> +<h3>Derived from</h3> +contextlib.AbstractContextManager +<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="#EricOverridenCursor.__init__">EricOverridenCursor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#EricOverridenCursor.__enter__">__enter__</a></td> +<td>Special method called when entering the runtime ccontext.</td> +</tr> +<tr> +<td><a href="#EricOverridenCursor.__exit__">__exit__</a></td> +<td>Special method called when exiting the runtime ccontext.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="EricOverridenCursor.__init__" ID="EricOverridenCursor.__init__"></a> +<h4>EricOverridenCursor (Constructor)</h4> +<b>EricOverridenCursor</b>(<i></i>) + +<p> + Constructor +</p> +<a NAME="EricOverridenCursor.__enter__" ID="EricOverridenCursor.__enter__"></a> +<h4>EricOverridenCursor.__enter__</h4> +<b>__enter__</b>(<i></i>) + +<p> + Special method called when entering the runtime ccontext. +</p> +<dl> +<dt>Return:</dt> +<dd> +reference to the context manager object +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +EricOverrideCursor +</dd> +</dl> +<a NAME="EricOverridenCursor.__exit__" ID="EricOverridenCursor.__exit__"></a> +<h4>EricOverridenCursor.__exit__</h4> +<b>__exit__</b>(<i>exc_type, exc_value, traceback</i>) + +<p> + Special method called when exiting the runtime ccontext. +</p> +<dl> + +<dt><i>exc_type</i></dt> +<dd> +type of an exception raised in the runtime context +</dd> +<dt><i>exc_value</i></dt> +<dd> +value of an exception raised in the runtime context +</dd> +<dt><i>traceback</i></dt> +<dd> +traceback of an exception raised in the runtime + context +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +always returns None to not suppress any exception +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +None +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file