Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.UI.PixmapCache.html
Documentation/Source/eric5.UI.PixmapCache.html
- changeset 17
- edde1fe80b3e
- child 21
- b88a0e6268bd
equal
deleted
inserted
replaced
| 16:892c1787d666 | 17:edde1fe80b3e |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.UI.PixmapCache</title> | |
| 6 <style> | |
| 7 b'body {\n background:white;\n margin: 0em 1em 10em 1em;\n color: black;\n}\n\nh1 { color: white; background: #4FA4FF; }\nh2 { color: white; background: #4FA4FF; }\nh3 { color: white; background: #00557F; }\nh4 { color: white; background: #00557F; }\n \na { color: #AA5500; }\n' | |
| 8 </style> | |
| 9 </head> | |
| 10 <body><a NAME="top" ID="top"></a> | |
| 11 <h1>eric5.UI.PixmapCache</h1> | |
| 12 <p> | |
| 13 Module implementing a pixmap cache for icons. | |
| 14 </p> | |
| 15 <h3>Global Attributes</h3> | |
| 16 <table> | |
| 17 <tr><td>pixCache</td></tr> | |
| 18 </table> | |
| 19 <h3>Classes</h3> | |
| 20 <table> | |
| 21 <tr> | |
| 22 <td><a href="#PixmapCache">PixmapCache</a></td> | |
| 23 <td>Class implementing a pixmap cache for icons.</td> | |
| 24 </tr> | |
| 25 </table> | |
| 26 <h3>Functions</h3> | |
| 27 <table> | |
| 28 <tr> | |
| 29 <td><a href="#addSearchPath">addSearchPath</a></td> | |
| 30 <td>Module function to add a path to the search path.</td> | |
| 31 </tr><tr> | |
| 32 <td><a href="#getIcon">getIcon</a></td> | |
| 33 <td>Module function to retrieve an icon.</td> | |
| 34 </tr><tr> | |
| 35 <td><a href="#getPixmap">getPixmap</a></td> | |
| 36 <td>Module function to retrieve a pixmap.</td> | |
| 37 </tr> | |
| 38 </table> | |
| 39 <hr /><hr /> | |
| 40 <a NAME="PixmapCache" ID="PixmapCache"></a> | |
| 41 <h2>PixmapCache</h2> | |
| 42 <p> | |
| 43 Class implementing a pixmap cache for icons. | |
| 44 </p> | |
| 45 <h3>Derived from</h3> | |
| 46 object | |
| 47 <h3>Class Attributes</h3> | |
| 48 <table> | |
| 49 <tr><td>None</td></tr> | |
| 50 </table> | |
| 51 <h3>Methods</h3> | |
| 52 <table> | |
| 53 <tr> | |
| 54 <td><a href="#PixmapCache.__init__">PixmapCache</a></td> | |
| 55 <td>Constructor</td> | |
| 56 </tr><tr> | |
| 57 <td><a href="#PixmapCache.addSearchPath">addSearchPath</a></td> | |
| 58 <td>Public method to add a path to the search path.</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#PixmapCache.getPixmap">getPixmap</a></td> | |
| 61 <td>Public method to retrieve a pixmap.</td> | |
| 62 </tr> | |
| 63 </table> | |
| 64 <a NAME="PixmapCache.__init__" ID="PixmapCache.__init__"></a> | |
| 65 <h4>PixmapCache (Constructor)</h4> | |
| 66 <b>PixmapCache</b>(<i></i>) | |
| 67 <p> | |
| 68 Constructor | |
| 69 </p><a NAME="PixmapCache.addSearchPath" ID="PixmapCache.addSearchPath"></a> | |
| 70 <h4>PixmapCache.addSearchPath</h4> | |
| 71 <b>addSearchPath</b>(<i>path</i>) | |
| 72 <p> | |
| 73 Public method to add a path to the search path. | |
| 74 </p><dl> | |
| 75 <dt><i>path</i></dt> | |
| 76 <dd> | |
| 77 path to add (string) | |
| 78 </dd> | |
| 79 </dl><a NAME="PixmapCache.getPixmap" ID="PixmapCache.getPixmap"></a> | |
| 80 <h4>PixmapCache.getPixmap</h4> | |
| 81 <b>getPixmap</b>(<i>key</i>) | |
| 82 <p> | |
| 83 Public method to retrieve a pixmap. | |
| 84 </p><dl> | |
| 85 <dt><i>key</i></dt> | |
| 86 <dd> | |
| 87 name of the wanted pixmap (string) | |
| 88 </dd> | |
| 89 </dl><dl> | |
| 90 <dt>Returns:</dt> | |
| 91 <dd> | |
| 92 the requested pixmap (QPixmap) | |
| 93 </dd> | |
| 94 </dl> | |
| 95 <div align="right"><a href="#top">Up</a></div> | |
| 96 <hr /><hr /> | |
| 97 <a NAME="addSearchPath" ID="addSearchPath"></a> | |
| 98 <h2>addSearchPath</h2> | |
| 99 <b>addSearchPath</b>(<i>path, cache = pixCache</i>) | |
| 100 <p> | |
| 101 Module function to add a path to the search path. | |
| 102 </p><dl> | |
| 103 <dt><i>path</i></dt> | |
| 104 <dd> | |
| 105 path to add (string) | |
| 106 </dd> | |
| 107 </dl> | |
| 108 <div align="right"><a href="#top">Up</a></div> | |
| 109 <hr /><hr /> | |
| 110 <a NAME="getIcon" ID="getIcon"></a> | |
| 111 <h2>getIcon</h2> | |
| 112 <b>getIcon</b>(<i>key, cache = pixCache</i>) | |
| 113 <p> | |
| 114 Module function to retrieve an icon. | |
| 115 </p><dl> | |
| 116 <dt><i>key</i></dt> | |
| 117 <dd> | |
| 118 name of the wanted icon (string) | |
| 119 </dd> | |
| 120 </dl><dl> | |
| 121 <dt>Returns:</dt> | |
| 122 <dd> | |
| 123 the requested icon (QIcon) | |
| 124 </dd> | |
| 125 </dl> | |
| 126 <div align="right"><a href="#top">Up</a></div> | |
| 127 <hr /><hr /> | |
| 128 <a NAME="getPixmap" ID="getPixmap"></a> | |
| 129 <h2>getPixmap</h2> | |
| 130 <b>getPixmap</b>(<i>key, cache = pixCache</i>) | |
| 131 <p> | |
| 132 Module function to retrieve a pixmap. | |
| 133 </p><dl> | |
| 134 <dt><i>key</i></dt> | |
| 135 <dd> | |
| 136 name of the wanted pixmap (string) | |
| 137 </dd> | |
| 138 </dl><dl> | |
| 139 <dt>Returns:</dt> | |
| 140 <dd> | |
| 141 the requested pixmap (QPixmap) | |
| 142 </dd> | |
| 143 </dl> | |
| 144 <div align="right"><a href="#top">Up</a></div> | |
| 145 <hr /> | |
| 146 </body></html> |
