Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.UI.PixmapCache.html

eric6/Documentation/Source/eric6.UI.PixmapCache.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7489
6543bcd150fd
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.UI.PixmapCache</h1> 23 <h1>eric6.UI.PixmapCache</h1>
24
23 <p> 25 <p>
24 Module implementing a pixmap cache for icons. 26 Module implementing a pixmap cache for icons.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>pixCache</td></tr> 31 <tr><td>pixCache</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
31 <table> 34
35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#PixmapCache">PixmapCache</a></td> 38 <td><a href="#PixmapCache">PixmapCache</a></td>
34 <td>Class implementing a pixmap cache for icons.</td> 39 <td>Class implementing a pixmap cache for icons.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
38 <table> 43
44 <table>
45
39 <tr> 46 <tr>
40 <td><a href="#addSearchPath">addSearchPath</a></td> 47 <td><a href="#addSearchPath">addSearchPath</a></td>
41 <td>Module function to add a path to the search path.</td> 48 <td>Module function to add a path to the search path.</td>
42 </tr><tr> 49 </tr>
50 <tr>
43 <td><a href="#getCombinedIcon">getCombinedIcon</a></td> 51 <td><a href="#getCombinedIcon">getCombinedIcon</a></td>
44 <td>Module function to retrieve a symbolic link icon.</td> 52 <td>Module function to retrieve a symbolic link icon.</td>
45 </tr><tr> 53 </tr>
54 <tr>
46 <td><a href="#getIcon">getIcon</a></td> 55 <td><a href="#getIcon">getIcon</a></td>
47 <td>Module function to retrieve an icon.</td> 56 <td>Module function to retrieve an icon.</td>
48 </tr><tr> 57 </tr>
58 <tr>
49 <td><a href="#getPixmap">getPixmap</a></td> 59 <td><a href="#getPixmap">getPixmap</a></td>
50 <td>Module function to retrieve a pixmap.</td> 60 <td>Module function to retrieve a pixmap.</td>
51 </tr><tr> 61 </tr>
62 <tr>
52 <td><a href="#getSymlinkIcon">getSymlinkIcon</a></td> 63 <td><a href="#getSymlinkIcon">getSymlinkIcon</a></td>
53 <td>Module function to retrieve a symbolic link icon.</td> 64 <td>Module function to retrieve a symbolic link icon.</td>
54 </tr> 65 </tr>
55 </table> 66 </table>
56 <hr /><hr /> 67 <hr />
68 <hr />
57 <a NAME="PixmapCache" ID="PixmapCache"></a> 69 <a NAME="PixmapCache" ID="PixmapCache"></a>
58 <h2>PixmapCache</h2> 70 <h2>PixmapCache</h2>
71
59 <p> 72 <p>
60 Class implementing a pixmap cache for icons. 73 Class implementing a pixmap cache for icons.
61 </p> 74 </p>
62 <h3>Derived from</h3> 75 <h3>Derived from</h3>
63 object 76 object
64 <h3>Class Attributes</h3> 77 <h3>Class Attributes</h3>
78
65 <table> 79 <table>
66 <tr><td>SupportedExtensions</td></tr> 80 <tr><td>SupportedExtensions</td></tr>
67 </table> 81 </table>
68 <h3>Class Methods</h3> 82 <h3>Class Methods</h3>
83
69 <table> 84 <table>
70 <tr><td>None</td></tr> 85 <tr><td>None</td></tr>
71 </table> 86 </table>
72 <h3>Methods</h3> 87 <h3>Methods</h3>
73 <table> 88
89 <table>
90
74 <tr> 91 <tr>
75 <td><a href="#PixmapCache.__init__">PixmapCache</a></td> 92 <td><a href="#PixmapCache.__init__">PixmapCache</a></td>
76 <td>Constructor</td> 93 <td>Constructor</td>
77 </tr><tr> 94 </tr>
95 <tr>
78 <td><a href="#PixmapCache.addSearchPath">addSearchPath</a></td> 96 <td><a href="#PixmapCache.addSearchPath">addSearchPath</a></td>
79 <td>Public method to add a path to the search path.</td> 97 <td>Public method to add a path to the search path.</td>
80 </tr><tr> 98 </tr>
99 <tr>
81 <td><a href="#PixmapCache.getPixmap">getPixmap</a></td> 100 <td><a href="#PixmapCache.getPixmap">getPixmap</a></td>
82 <td>Public method to retrieve a pixmap.</td> 101 <td>Public method to retrieve a pixmap.</td>
83 </tr> 102 </tr>
84 </table> 103 </table>
85 <h3>Static Methods</h3> 104 <h3>Static Methods</h3>
105
86 <table> 106 <table>
87 <tr><td>None</td></tr> 107 <tr><td>None</td></tr>
88 </table> 108 </table>
109
89 <a NAME="PixmapCache.__init__" ID="PixmapCache.__init__"></a> 110 <a NAME="PixmapCache.__init__" ID="PixmapCache.__init__"></a>
90 <h4>PixmapCache (Constructor)</h4> 111 <h4>PixmapCache (Constructor)</h4>
91 <b>PixmapCache</b>(<i></i>) 112 <b>PixmapCache</b>(<i></i>)
113
92 <p> 114 <p>
93 Constructor 115 Constructor
94 </p><a NAME="PixmapCache.addSearchPath" ID="PixmapCache.addSearchPath"></a> 116 </p>
117 <a NAME="PixmapCache.addSearchPath" ID="PixmapCache.addSearchPath"></a>
95 <h4>PixmapCache.addSearchPath</h4> 118 <h4>PixmapCache.addSearchPath</h4>
96 <b>addSearchPath</b>(<i>path</i>) 119 <b>addSearchPath</b>(<i>path</i>)
120
97 <p> 121 <p>
98 Public method to add a path to the search path. 122 Public method to add a path to the search path.
99 </p><dl> 123 </p>
124 <dl>
125
100 <dt><i>path</i></dt> 126 <dt><i>path</i></dt>
101 <dd> 127 <dd>
102 path to add (string) 128 path to add (string)
103 </dd> 129 </dd>
104 </dl><a NAME="PixmapCache.getPixmap" ID="PixmapCache.getPixmap"></a> 130 </dl>
131 <a NAME="PixmapCache.getPixmap" ID="PixmapCache.getPixmap"></a>
105 <h4>PixmapCache.getPixmap</h4> 132 <h4>PixmapCache.getPixmap</h4>
106 <b>getPixmap</b>(<i>key, size=None</i>) 133 <b>getPixmap</b>(<i>key, size=None</i>)
134
107 <p> 135 <p>
108 Public method to retrieve a pixmap. 136 Public method to retrieve a pixmap.
109 </p><dl> 137 </p>
138 <dl>
139
110 <dt><i>key</i> (str)</dt> 140 <dt><i>key</i> (str)</dt>
111 <dd> 141 <dd>
112 name of the wanted pixmap 142 name of the wanted pixmap
113 </dd><dt><i>size</i> (QSize)</dt> 143 </dd>
144 <dt><i>size</i> (QSize)</dt>
114 <dd> 145 <dd>
115 requested size 146 requested size
116 </dd> 147 </dd>
117 </dl><dl> 148 </dl>
149 <dl>
118 <dt>Returns:</dt> 150 <dt>Returns:</dt>
119 <dd> 151 <dd>
120 the requested pixmap 152 the requested pixmap
121 </dd> 153 </dd>
122 </dl><dl> 154 </dl>
155 <dl>
123 <dt>Return Type:</dt> 156 <dt>Return Type:</dt>
124 <dd> 157 <dd>
125 QPixmap 158 QPixmap
126 </dd> 159 </dd>
127 </dl> 160 </dl>
128 <div align="right"><a href="#top">Up</a></div> 161 <div align="right"><a href="#top">Up</a></div>
129 <hr /><hr /> 162 <hr />
163 <hr />
130 <a NAME="addSearchPath" ID="addSearchPath"></a> 164 <a NAME="addSearchPath" ID="addSearchPath"></a>
131 <h2>addSearchPath</h2> 165 <h2>addSearchPath</h2>
132 <b>addSearchPath</b>(<i>path, cache=pixCache</i>) 166 <b>addSearchPath</b>(<i>path, cache=pixCache</i>)
167
133 <p> 168 <p>
134 Module function to add a path to the search path. 169 Module function to add a path to the search path.
135 </p><dl> 170 </p>
171 <dl>
172
136 <dt><i>path</i></dt> 173 <dt><i>path</i></dt>
137 <dd> 174 <dd>
138 path to add (string) 175 path to add (string)
139 </dd><dt><i>cache</i></dt> 176 </dd>
177 <dt><i>cache</i></dt>
140 <dd> 178 <dd>
141 reference to the pixmap cache object (PixmapCache) 179 reference to the pixmap cache object (PixmapCache)
142 </dd> 180 </dd>
143 </dl> 181 </dl>
144 <div align="right"><a href="#top">Up</a></div> 182 <div align="right"><a href="#top">Up</a></div>
145 <hr /><hr /> 183 <hr />
184 <hr />
146 <a NAME="getCombinedIcon" ID="getCombinedIcon"></a> 185 <a NAME="getCombinedIcon" ID="getCombinedIcon"></a>
147 <h2>getCombinedIcon</h2> 186 <h2>getCombinedIcon</h2>
148 <b>getCombinedIcon</b>(<i>keys, size=None, cache=pixCache</i>) 187 <b>getCombinedIcon</b>(<i>keys, size=None, cache=pixCache</i>)
188
149 <p> 189 <p>
150 Module function to retrieve a symbolic link icon. 190 Module function to retrieve a symbolic link icon.
151 </p><dl> 191 </p>
192 <dl>
193
152 <dt><i>keys</i> (list of str)</dt> 194 <dt><i>keys</i> (list of str)</dt>
153 <dd> 195 <dd>
154 list of names of icons 196 list of names of icons
155 </dd><dt><i>size</i> (QSize)</dt> 197 </dd>
198 <dt><i>size</i> (QSize)</dt>
156 <dd> 199 <dd>
157 requested size of individual icons 200 requested size of individual icons
158 </dd><dt><i>cache</i> (PixmapCache)</dt> 201 </dd>
202 <dt><i>cache</i> (PixmapCache)</dt>
159 <dd> 203 <dd>
160 reference to the pixmap cache object 204 reference to the pixmap cache object
161 </dd> 205 </dd>
162 </dl><dl> 206 </dl>
207 <dl>
163 <dt>Returns:</dt> 208 <dt>Returns:</dt>
164 <dd> 209 <dd>
165 the requested icon 210 the requested icon
166 </dd> 211 </dd>
167 </dl><dl> 212 </dl>
213 <dl>
168 <dt>Return Type:</dt> 214 <dt>Return Type:</dt>
169 <dd> 215 <dd>
170 QIcon 216 QIcon
171 </dd> 217 </dd>
172 </dl> 218 </dl>
173 <div align="right"><a href="#top">Up</a></div> 219 <div align="right"><a href="#top">Up</a></div>
174 <hr /><hr /> 220 <hr />
221 <hr />
175 <a NAME="getIcon" ID="getIcon"></a> 222 <a NAME="getIcon" ID="getIcon"></a>
176 <h2>getIcon</h2> 223 <h2>getIcon</h2>
177 <b>getIcon</b>(<i>key, size=None, cache=pixCache</i>) 224 <b>getIcon</b>(<i>key, size=None, cache=pixCache</i>)
225
178 <p> 226 <p>
179 Module function to retrieve an icon. 227 Module function to retrieve an icon.
180 </p><dl> 228 </p>
229 <dl>
230
181 <dt><i>key</i> (str)</dt> 231 <dt><i>key</i> (str)</dt>
182 <dd> 232 <dd>
183 name of the wanted pixmap 233 name of the wanted pixmap
184 </dd><dt><i>size</i> (QSize)</dt> 234 </dd>
235 <dt><i>size</i> (QSize)</dt>
185 <dd> 236 <dd>
186 requested size 237 requested size
187 </dd><dt><i>cache</i> (PixmapCache)</dt> 238 </dd>
239 <dt><i>cache</i> (PixmapCache)</dt>
188 <dd> 240 <dd>
189 reference to the pixmap cache object 241 reference to the pixmap cache object
190 </dd> 242 </dd>
191 </dl><dl> 243 </dl>
244 <dl>
192 <dt>Returns:</dt> 245 <dt>Returns:</dt>
193 <dd> 246 <dd>
194 the requested icon 247 the requested icon
195 </dd> 248 </dd>
196 </dl><dl> 249 </dl>
250 <dl>
197 <dt>Return Type:</dt> 251 <dt>Return Type:</dt>
198 <dd> 252 <dd>
199 QIcon 253 QIcon
200 </dd> 254 </dd>
201 </dl> 255 </dl>
202 <div align="right"><a href="#top">Up</a></div> 256 <div align="right"><a href="#top">Up</a></div>
203 <hr /><hr /> 257 <hr />
258 <hr />
204 <a NAME="getPixmap" ID="getPixmap"></a> 259 <a NAME="getPixmap" ID="getPixmap"></a>
205 <h2>getPixmap</h2> 260 <h2>getPixmap</h2>
206 <b>getPixmap</b>(<i>key, size=None, cache=pixCache</i>) 261 <b>getPixmap</b>(<i>key, size=None, cache=pixCache</i>)
262
207 <p> 263 <p>
208 Module function to retrieve a pixmap. 264 Module function to retrieve a pixmap.
209 </p><dl> 265 </p>
266 <dl>
267
210 <dt><i>key</i> (str)</dt> 268 <dt><i>key</i> (str)</dt>
211 <dd> 269 <dd>
212 name of the wanted pixmap 270 name of the wanted pixmap
213 </dd><dt><i>size</i> (QSize)</dt> 271 </dd>
272 <dt><i>size</i> (QSize)</dt>
214 <dd> 273 <dd>
215 requested size 274 requested size
216 </dd><dt><i>cache</i> (PixmapCache)</dt> 275 </dd>
276 <dt><i>cache</i> (PixmapCache)</dt>
217 <dd> 277 <dd>
218 reference to the pixmap cache object 278 reference to the pixmap cache object
219 </dd> 279 </dd>
220 </dl><dl> 280 </dl>
281 <dl>
221 <dt>Returns:</dt> 282 <dt>Returns:</dt>
222 <dd> 283 <dd>
223 the requested pixmap 284 the requested pixmap
224 </dd> 285 </dd>
225 </dl><dl> 286 </dl>
287 <dl>
226 <dt>Return Type:</dt> 288 <dt>Return Type:</dt>
227 <dd> 289 <dd>
228 QPixmap 290 QPixmap
229 </dd> 291 </dd>
230 </dl> 292 </dl>
231 <div align="right"><a href="#top">Up</a></div> 293 <div align="right"><a href="#top">Up</a></div>
232 <hr /><hr /> 294 <hr />
295 <hr />
233 <a NAME="getSymlinkIcon" ID="getSymlinkIcon"></a> 296 <a NAME="getSymlinkIcon" ID="getSymlinkIcon"></a>
234 <h2>getSymlinkIcon</h2> 297 <h2>getSymlinkIcon</h2>
235 <b>getSymlinkIcon</b>(<i>key, size=None, cache=pixCache</i>) 298 <b>getSymlinkIcon</b>(<i>key, size=None, cache=pixCache</i>)
299
236 <p> 300 <p>
237 Module function to retrieve a symbolic link icon. 301 Module function to retrieve a symbolic link icon.
238 </p><dl> 302 </p>
303 <dl>
304
239 <dt><i>key</i> (str)</dt> 305 <dt><i>key</i> (str)</dt>
240 <dd> 306 <dd>
241 name of the wanted pixmap 307 name of the wanted pixmap
242 </dd><dt><i>size</i> (QSize)</dt> 308 </dd>
309 <dt><i>size</i> (QSize)</dt>
243 <dd> 310 <dd>
244 requested size 311 requested size
245 </dd><dt><i>cache</i> (PixmapCache)</dt> 312 </dd>
313 <dt><i>cache</i> (PixmapCache)</dt>
246 <dd> 314 <dd>
247 reference to the pixmap cache object 315 reference to the pixmap cache object
248 </dd> 316 </dd>
249 </dl><dl> 317 </dl>
318 <dl>
250 <dt>Returns:</dt> 319 <dt>Returns:</dt>
251 <dd> 320 <dd>
252 the requested icon 321 the requested icon
253 </dd> 322 </dd>
254 </dl><dl> 323 </dl>
324 <dl>
255 <dt>Return Type:</dt> 325 <dt>Return Type:</dt>
256 <dd> 326 <dd>
257 QIcon 327 QIcon
258 </dd> 328 </dd>
259 </dl> 329 </dl>

Mercurial Repository: eric

eric ide

mercurial