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