Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UI.PixmapCache.html
Documentation/Source/eric5.UI.PixmapCache.html
- changeset 58
- 37f0444c3479
- parent 21
- b88a0e6268bd
- child 103
- 59137afca666
equal
deleted
inserted
replaced
| 57:81326a94fdca | 58:37f0444c3479 |
|---|---|
| 20 </style> | 20 </style> |
| 21 </head> | 21 </head> |
| 22 <body><a NAME="top" ID="top"></a> | 22 <body><a NAME="top" ID="top"></a> |
| 23 <h1>eric5.UI.PixmapCache</h1> | 23 <h1>eric5.UI.PixmapCache</h1> |
| 24 <p> | 24 <p> |
| 25 Module implementing a pixmap cache for icons. | 25 Module implementing a pixmap cache for icons. |
| 26 </p> | 26 </p> |
| 27 <h3>Global Attributes</h3> | 27 <h3>Global Attributes</h3> |
| 28 <table> | 28 <table> |
| 29 <tr><td>pixCache</td></tr> | 29 <tr><td>pixCache</td></tr> |
| 30 </table> | 30 </table> |
| 31 <h3>Classes</h3> | 31 <h3>Classes</h3> |
| 32 <table> | 32 <table> |
| 33 <tr> | 33 <tr> |
| 34 <td><a href="#PixmapCache">PixmapCache</a></td> | 34 <td><a href="#PixmapCache">PixmapCache</a></td> |
| 35 <td>Class implementing a pixmap cache for icons.</td> | 35 <td>Class implementing a pixmap cache for icons.</td> |
| 36 </tr> | 36 </tr> |
| 37 </table> | 37 </table> |
| 38 <h3>Functions</h3> | 38 <h3>Functions</h3> |
| 39 <table> | 39 <table> |
| 40 <tr> | 40 <tr> |
| 41 <td><a href="#addSearchPath">addSearchPath</a></td> | 41 <td><a href="#addSearchPath">addSearchPath</a></td> |
| 42 <td>Module function to add a path to the search path.</td> | 42 <td>Module function to add a path to the search path.</td> |
| 43 </tr><tr> | 43 </tr><tr> |
| 44 <td><a href="#getIcon">getIcon</a></td> | 44 <td><a href="#getIcon">getIcon</a></td> |
| 45 <td>Module function to retrieve an icon.</td> | 45 <td>Module function to retrieve an icon.</td> |
| 46 </tr><tr> | 46 </tr><tr> |
| 47 <td><a href="#getPixmap">getPixmap</a></td> | 47 <td><a href="#getPixmap">getPixmap</a></td> |
| 48 <td>Module function to retrieve a pixmap.</td> | 48 <td>Module function to retrieve a pixmap.</td> |
| 49 </tr> | 49 </tr> |
| 50 </table> | 50 </table> |
| 51 <hr /><hr /> | 51 <hr /><hr /> |
| 52 <a NAME="PixmapCache" ID="PixmapCache"></a> | 52 <a NAME="PixmapCache" ID="PixmapCache"></a> |
| 53 <h2>PixmapCache</h2> | 53 <h2>PixmapCache</h2> |
| 54 <p> | 54 <p> |
| 55 Class implementing a pixmap cache for icons. | 55 Class implementing a pixmap cache for icons. |
| 56 </p> | 56 </p> |
| 57 <h3>Derived from</h3> | 57 <h3>Derived from</h3> |
| 58 object | 58 object |
| 59 <h3>Class Attributes</h3> | 59 <h3>Class Attributes</h3> |
| 60 <table> | 60 <table> |
| 62 </table> | 62 </table> |
| 63 <h3>Methods</h3> | 63 <h3>Methods</h3> |
| 64 <table> | 64 <table> |
| 65 <tr> | 65 <tr> |
| 66 <td><a href="#PixmapCache.__init__">PixmapCache</a></td> | 66 <td><a href="#PixmapCache.__init__">PixmapCache</a></td> |
| 67 <td>Constructor</td> | 67 <td>Constructor</td> |
| 68 </tr><tr> | 68 </tr><tr> |
| 69 <td><a href="#PixmapCache.addSearchPath">addSearchPath</a></td> | 69 <td><a href="#PixmapCache.addSearchPath">addSearchPath</a></td> |
| 70 <td>Public method to add a path to the search path.</td> | 70 <td>Public method to add a path to the search path.</td> |
| 71 </tr><tr> | 71 </tr><tr> |
| 72 <td><a href="#PixmapCache.getPixmap">getPixmap</a></td> | 72 <td><a href="#PixmapCache.getPixmap">getPixmap</a></td> |
| 73 <td>Public method to retrieve a pixmap.</td> | 73 <td>Public method to retrieve a pixmap.</td> |
| 74 </tr> | 74 </tr> |
| 75 </table> | 75 </table> |
| 76 <a NAME="PixmapCache.__init__" ID="PixmapCache.__init__"></a> | 76 <a NAME="PixmapCache.__init__" ID="PixmapCache.__init__"></a> |
| 77 <h4>PixmapCache (Constructor)</h4> | 77 <h4>PixmapCache (Constructor)</h4> |
| 78 <b>PixmapCache</b>(<i></i>) | 78 <b>PixmapCache</b>(<i></i>) |
| 79 <p> | 79 <p> |
| 80 Constructor | 80 Constructor |
| 81 </p><a NAME="PixmapCache.addSearchPath" ID="PixmapCache.addSearchPath"></a> | 81 </p><a NAME="PixmapCache.addSearchPath" ID="PixmapCache.addSearchPath"></a> |
| 82 <h4>PixmapCache.addSearchPath</h4> | 82 <h4>PixmapCache.addSearchPath</h4> |
| 83 <b>addSearchPath</b>(<i>path</i>) | 83 <b>addSearchPath</b>(<i>path</i>) |
| 84 <p> | 84 <p> |
| 85 Public method to add a path to the search path. | 85 Public method to add a path to the search path. |
| 86 </p><dl> | 86 </p><dl> |
| 87 <dt><i>path</i></dt> | 87 <dt><i>path</i></dt> |
| 88 <dd> | 88 <dd> |
| 89 path to add (string) | 89 path to add (string) |
| 90 </dd> | 90 </dd> |
| 91 </dl><a NAME="PixmapCache.getPixmap" ID="PixmapCache.getPixmap"></a> | 91 </dl><a NAME="PixmapCache.getPixmap" ID="PixmapCache.getPixmap"></a> |
| 92 <h4>PixmapCache.getPixmap</h4> | 92 <h4>PixmapCache.getPixmap</h4> |
| 93 <b>getPixmap</b>(<i>key</i>) | 93 <b>getPixmap</b>(<i>key</i>) |
| 94 <p> | 94 <p> |
| 95 Public method to retrieve a pixmap. | 95 Public method to retrieve a pixmap. |
| 96 </p><dl> | 96 </p><dl> |
| 97 <dt><i>key</i></dt> | 97 <dt><i>key</i></dt> |
| 98 <dd> | 98 <dd> |
| 99 name of the wanted pixmap (string) | 99 name of the wanted pixmap (string) |
| 100 </dd> | 100 </dd> |
| 101 </dl><dl> | 101 </dl><dl> |
| 102 <dt>Returns:</dt> | 102 <dt>Returns:</dt> |
| 103 <dd> | 103 <dd> |
| 104 the requested pixmap (QPixmap) | 104 the requested pixmap (QPixmap) |
| 105 </dd> | 105 </dd> |
| 106 </dl> | 106 </dl> |
| 107 <div align="right"><a href="#top">Up</a></div> | 107 <div align="right"><a href="#top">Up</a></div> |
| 108 <hr /><hr /> | 108 <hr /><hr /> |
| 109 <a NAME="addSearchPath" ID="addSearchPath"></a> | 109 <a NAME="addSearchPath" ID="addSearchPath"></a> |
| 110 <h2>addSearchPath</h2> | 110 <h2>addSearchPath</h2> |
| 111 <b>addSearchPath</b>(<i>path, cache = pixCache</i>) | 111 <b>addSearchPath</b>(<i>path, cache = pixCache</i>) |
| 112 <p> | 112 <p> |
| 113 Module function to add a path to the search path. | 113 Module function to add a path to the search path. |
| 114 </p><dl> | 114 </p><dl> |
| 115 <dt><i>path</i></dt> | 115 <dt><i>path</i></dt> |
| 116 <dd> | 116 <dd> |
| 117 path to add (string) | 117 path to add (string) |
| 118 </dd> | 118 </dd> |
| 119 </dl> | 119 </dl> |
| 120 <div align="right"><a href="#top">Up</a></div> | 120 <div align="right"><a href="#top">Up</a></div> |
| 121 <hr /><hr /> | 121 <hr /><hr /> |
| 122 <a NAME="getIcon" ID="getIcon"></a> | 122 <a NAME="getIcon" ID="getIcon"></a> |
| 123 <h2>getIcon</h2> | 123 <h2>getIcon</h2> |
| 124 <b>getIcon</b>(<i>key, cache = pixCache</i>) | 124 <b>getIcon</b>(<i>key, cache = pixCache</i>) |
| 125 <p> | 125 <p> |
| 126 Module function to retrieve an icon. | 126 Module function to retrieve an icon. |
| 127 </p><dl> | 127 </p><dl> |
| 128 <dt><i>key</i></dt> | 128 <dt><i>key</i></dt> |
| 129 <dd> | 129 <dd> |
| 130 name of the wanted icon (string) | 130 name of the wanted icon (string) |
| 131 </dd> | 131 </dd> |
| 132 </dl><dl> | 132 </dl><dl> |
| 133 <dt>Returns:</dt> | 133 <dt>Returns:</dt> |
| 134 <dd> | 134 <dd> |
| 135 the requested icon (QIcon) | 135 the requested icon (QIcon) |
| 136 </dd> | 136 </dd> |
| 137 </dl> | 137 </dl> |
| 138 <div align="right"><a href="#top">Up</a></div> | 138 <div align="right"><a href="#top">Up</a></div> |
| 139 <hr /><hr /> | 139 <hr /><hr /> |
| 140 <a NAME="getPixmap" ID="getPixmap"></a> | 140 <a NAME="getPixmap" ID="getPixmap"></a> |
| 141 <h2>getPixmap</h2> | 141 <h2>getPixmap</h2> |
| 142 <b>getPixmap</b>(<i>key, cache = pixCache</i>) | 142 <b>getPixmap</b>(<i>key, cache = pixCache</i>) |
| 143 <p> | 143 <p> |
| 144 Module function to retrieve a pixmap. | 144 Module function to retrieve a pixmap. |
| 145 </p><dl> | 145 </p><dl> |
| 146 <dt><i>key</i></dt> | 146 <dt><i>key</i></dt> |
| 147 <dd> | 147 <dd> |
| 148 name of the wanted pixmap (string) | 148 name of the wanted pixmap (string) |
| 149 </dd> | 149 </dd> |
| 150 </dl><dl> | 150 </dl><dl> |
| 151 <dt>Returns:</dt> | 151 <dt>Returns:</dt> |
| 152 <dd> | 152 <dd> |
| 153 the requested pixmap (QPixmap) | 153 the requested pixmap (QPixmap) |
| 154 </dd> | 154 </dd> |
| 155 </dl> | 155 </dl> |
| 156 <div align="right"><a href="#top">Up</a></div> | 156 <div align="right"><a href="#top">Up</a></div> |
| 157 <hr /> | 157 <hr /> |
| 158 </body></html> | 158 </body></html> |
