--- a/src/eric7/Documentation/Source/eric7.UI.PixmapCache.html Tue Oct 18 16:10:00 2022 +0200 +++ b/src/eric7/Documentation/Source/eric7.UI.PixmapCache.html Tue Oct 18 16:11:00 2022 +0200 @@ -9,353 +9,23 @@ <h1>eric7.UI.PixmapCache</h1> <p> -Module implementing a pixmap cache for icons. +Module implementing a compatibility interface of the EricPixmapCache functionality to +satisfy old plug-ins. </p> <h3>Global Attributes</h3> <table> -<tr><td>pixCache</td></tr> +<tr><td>addSearchPath</td></tr><tr><td>getCombinedIcon</td></tr><tr><td>getIcon</td></tr><tr><td>getPixmap</td></tr><tr><td>getSymlinkIcon</td></tr><tr><td>removeSearchPath</td></tr> </table> <h3>Classes</h3> <table> - -<tr> -<td><a href="#PixmapCache">PixmapCache</a></td> -<td>Class implementing a pixmap cache for icons.</td> -</tr> -</table> -<h3>Functions</h3> - -<table> - -<tr> -<td><a href="#addSearchPath">addSearchPath</a></td> -<td>Module function to add a path to the search path.</td> -</tr> -<tr> -<td><a href="#getCombinedIcon">getCombinedIcon</a></td> -<td>Module function to retrieve a symbolic link icon.</td> -</tr> -<tr> -<td><a href="#getIcon">getIcon</a></td> -<td>Module function to retrieve an icon.</td> -</tr> -<tr> -<td><a href="#getPixmap">getPixmap</a></td> -<td>Module function to retrieve a pixmap.</td> -</tr> -<tr> -<td><a href="#getSymlinkIcon">getSymlinkIcon</a></td> -<td>Module function to retrieve a symbolic link icon.</td> -</tr> -<tr> -<td><a href="#removeSearchPath">removeSearchPath</a></td> -<td>Public method to remove a path from the search path.</td> -</tr> -</table> -<hr /> -<hr /> -<a NAME="PixmapCache" ID="PixmapCache"></a> -<h2>PixmapCache</h2> - -<p> - Class implementing a pixmap cache for icons. -</p> -<h3>Derived from</h3> -None -<h3>Class Attributes</h3> - -<table> -<tr><td>SupportedExtensions</td></tr> -</table> -<h3>Class Methods</h3> - -<table> -<tr><td>None</td></tr> -</table> -<h3>Methods</h3> - -<table> - -<tr> -<td><a href="#PixmapCache.__init__">PixmapCache</a></td> -<td>Constructor</td> -</tr> -<tr> -<td><a href="#PixmapCache.addSearchPath">addSearchPath</a></td> -<td>Public method to add a path to the search path.</td> -</tr> -<tr> -<td><a href="#PixmapCache.getPixmap">getPixmap</a></td> -<td>Public method to retrieve a pixmap.</td> -</tr> -<tr> -<td><a href="#PixmapCache.removeSearchPath">removeSearchPath</a></td> -<td>Public method to remove a path from the search path.</td> -</tr> -</table> -<h3>Static Methods</h3> - -<table> <tr><td>None</td></tr> </table> - -<a NAME="PixmapCache.__init__" ID="PixmapCache.__init__"></a> -<h4>PixmapCache (Constructor)</h4> -<b>PixmapCache</b>(<i></i>) - -<p> - Constructor -</p> -<a NAME="PixmapCache.addSearchPath" ID="PixmapCache.addSearchPath"></a> -<h4>PixmapCache.addSearchPath</h4> -<b>addSearchPath</b>(<i>path</i>) - -<p> - Public method to add a path to the search path. -</p> -<dl> - -<dt><i>path</i> (str)</dt> -<dd> -path to add -</dd> -</dl> -<a NAME="PixmapCache.getPixmap" ID="PixmapCache.getPixmap"></a> -<h4>PixmapCache.getPixmap</h4> -<b>getPixmap</b>(<i>key, size=None</i>) - -<p> - Public method to retrieve a pixmap. -</p> -<dl> - -<dt><i>key</i> (str)</dt> -<dd> -name of the wanted pixmap -</dd> -<dt><i>size</i> (QSize)</dt> -<dd> -requested size -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -the requested pixmap -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -QPixmap -</dd> -</dl> -<a NAME="PixmapCache.removeSearchPath" ID="PixmapCache.removeSearchPath"></a> -<h4>PixmapCache.removeSearchPath</h4> -<b>removeSearchPath</b>(<i>path</i>) - -<p> - Public method to remove a path from the search path. -</p> -<dl> - -<dt><i>path</i> (str)</dt> -<dd> -path to remove -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="addSearchPath" ID="addSearchPath"></a> -<h2>addSearchPath</h2> -<b>addSearchPath</b>(<i>path, cache=pixCache</i>) - -<p> - Module function to add a path to the search path. -</p> -<dl> - -<dt><i>path</i> (str)</dt> -<dd> -path to add -</dd> -<dt><i>cache</i> (PixmapCache)</dt> -<dd> -reference to the pixmap cache object -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getCombinedIcon" ID="getCombinedIcon"></a> -<h2>getCombinedIcon</h2> -<b>getCombinedIcon</b>(<i>keys, size=None, cache=pixCache</i>) - -<p> - Module function to retrieve a symbolic link icon. -</p> -<dl> +<h3>Functions</h3> -<dt><i>keys</i> (list of str)</dt> -<dd> -list of names of icons -</dd> -<dt><i>size</i> (QSize)</dt> -<dd> -requested size of individual icons -</dd> -<dt><i>cache</i> (PixmapCache)</dt> -<dd> -reference to the pixmap cache object -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -the requested icon -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -QIcon -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getIcon" ID="getIcon"></a> -<h2>getIcon</h2> -<b>getIcon</b>(<i>key, size=None, cache=pixCache</i>) - -<p> - Module function to retrieve an icon. -</p> -<dl> - -<dt><i>key</i> (str)</dt> -<dd> -name of the wanted pixmap -</dd> -<dt><i>size</i> (QSize)</dt> -<dd> -requested size -</dd> -<dt><i>cache</i> (PixmapCache)</dt> -<dd> -reference to the pixmap cache object -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -the requested icon -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -QIcon -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getPixmap" ID="getPixmap"></a> -<h2>getPixmap</h2> -<b>getPixmap</b>(<i>key, size=None, cache=pixCache</i>) - -<p> - Module function to retrieve a pixmap. -</p> -<dl> - -<dt><i>key</i> (str)</dt> -<dd> -name of the wanted pixmap -</dd> -<dt><i>size</i> (QSize)</dt> -<dd> -requested size -</dd> -<dt><i>cache</i> (PixmapCache)</dt> -<dd> -reference to the pixmap cache object -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -the requested pixmap -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -QPixmap -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="getSymlinkIcon" ID="getSymlinkIcon"></a> -<h2>getSymlinkIcon</h2> -<b>getSymlinkIcon</b>(<i>key, size=None, cache=pixCache</i>) - -<p> - Module function to retrieve a symbolic link icon. -</p> -<dl> - -<dt><i>key</i> (str)</dt> -<dd> -name of the wanted pixmap -</dd> -<dt><i>size</i> (QSize)</dt> -<dd> -requested size -</dd> -<dt><i>cache</i> (PixmapCache)</dt> -<dd> -reference to the pixmap cache object -</dd> -</dl> -<dl> -<dt>Return:</dt> -<dd> -the requested icon -</dd> -</dl> -<dl> -<dt>Return Type:</dt> -<dd> -QIcon -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> -<hr /> -<hr /> -<a NAME="removeSearchPath" ID="removeSearchPath"></a> -<h2>removeSearchPath</h2> -<b>removeSearchPath</b>(<i>path, cache=pixCache</i>) - -<p> - Public method to remove a path from the search path. -</p> -<dl> - -<dt><i>path</i> (str)</dt> -<dd> -path to remove -</dd> -<dt><i>cache</i> (PixmapCache)</dt> -<dd> -reference to the pixmap cache object -</dd> -</dl> -<div align="right"><a href="#top">Up</a></div> +<table> +<tr><td>None</td></tr> +</table> <hr /> </body></html> \ No newline at end of file