forked from khchen/wNim
-
Notifications
You must be signed in to change notification settings - Fork 0
/
wIconImage.html
453 lines (365 loc) · 50.8 KB
/
wIconImage.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<!-- This file is generated by Nim. -->
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<!-- Favicon -->
<link rel="shortcut icon" href="data:image/x-icon;base64,AAABAAEAEBAAAAEAIABoBAAAFgAAACgAAAAQAAAAIAAAAAEAIAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAUAAAAF////AP///wD///8A////AP///wD///8A////AP///wD///8A////AAAAAAIAAABbAAAAlQAAAKIAAACbAAAAmwAAAKIAAACVAAAAWwAAAAL///8A////AP///wD///8A////AAAAABQAAADAAAAAYwAAAA3///8A////AP///wD///8AAAAADQAAAGMAAADAAAAAFP///wD///8A////AP///wAAAACdAAAAOv///wD///8A////AP///wD///8A////AP///wD///8AAAAAOgAAAJ3///8A////AP///wAAAAAnAAAAcP///wAAAAAoAAAASv///wD///8A////AP///wAAAABKAAAAKP///wAAAABwAAAAJ////wD///8AAAAAgQAAABwAAACIAAAAkAAAAJMAAACtAAAAFQAAABUAAACtAAAAkwAAAJAAAACIAAAAHAAAAIH///8A////AAAAAKQAAACrAAAAaP///wD///8AAAAARQAAANIAAADSAAAARf///wD///8AAAAAaAAAAKsAAACk////AAAAADMAAACcAAAAnQAAABj///8A////AP///wAAAAAYAAAAGP///wD///8A////AAAAABgAAACdAAAAnAAAADMAAAB1AAAAwwAAAP8AAADpAAAAsQAAAE4AAAAb////AP///wAAAAAbAAAATgAAALEAAADpAAAA/wAAAMMAAAB1AAAAtwAAAOkAAAD/AAAA/wAAAP8AAADvAAAA3gAAAN4AAADeAAAA3gAAAO8AAAD/AAAA/wAAAP8AAADpAAAAtwAAAGUAAAA/AAAA3wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAAD/AAAA/wAAAP8AAADfAAAAPwAAAGX///8A////AAAAAEgAAADtAAAAvwAAAL0AAADGAAAA7wAAAO8AAADGAAAAvQAAAL8AAADtAAAASP///wD///8A////AP///wD///8AAAAAO////wD///8A////AAAAAIcAAACH////AP///wD///8AAAAAO////wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A////AP///wD///8A//8AAP//AAD4HwAA7/cAAN/7AAD//wAAoYUAAJ55AACf+QAAh+EAAAAAAADAAwAA4AcAAP5/AAD//wAA//8AAA=="/>
<link rel="icon" type="image/png" sizes="32x32" href="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAYAAABzenr0AAAABmJLR0QA/wD/AP+gvaeTAAAACXBIWXMAAA3XAAAN1wFCKJt4AAAAB3RJTUUH4QQQEwksSS9ZWwAAAk1JREFUWMPtll2ITVEUx39nn/O7Y5qR8f05wtCUUr6ZIS++8pEnkZInPImneaCQ5METNdOkeFBKUhMPRIkHKfEuUZSUlGlKPN2TrgfncpvmnntnmlEyq1Z7t89/rf9a6+y99oZxGZf/XeIq61EdtgKXgdXA0xrYAvBjOIF1AI9zvjcC74BSpndrJPkBWDScTF8Aa4E3wDlgHbASaANmVqlcCnwHvgDvgVfAJ+AikAAvgfVZwLnSVZHZaOuKoQi3ZOMi4NkYkpe1p4J7A8BpYAD49hfIy/oqG0+hLomiKP2L5L+1ubn5115S+3OAn4EnwBlgMzCjyt6ZAnQCJ4A7wOs88iRJHvw50HoujuPBoCKwHWiosy8MdfZnAdcHk8dxXFJ3VQbQlCTJvRBCGdRbD4M6uc5glpY3eAihpN5S5w12diSEcCCEcKUO4ljdr15T76ur1FDDLIQQ3qv71EdDOe3Kxj3leRXyk+pxdWnFWod6Wt2bY3de3aSuUHcPBVimHs7mK9WrmeOF6lR1o9qnzskh2ar2qm1qizpfXaPeVGdlmGN5pb09qMxz1Xb1kLqgzn1RyH7JUXW52lr5e/Kqi9qpto7V1atuUzfnARrV7jEib1T76gG2qxdGmXyiekkt1GswPTtek0aBfJp6YySGBfWg2tPQ0FAYgf1stUfdmdcjarbYJEniKIq6gY/Aw+zWHAC+p2labGpqiorFYgGYCEzN7oQdQClN07O1/EfDyGgC0ALMBdYAi4FyK+4H3gLPsxfR1zRNi+NP7nH5J+QntnXe5B5mpfQAAAAASUVORK5CYII=">
<!-- Google fonts -->
<link href='https://fonts.googleapis.com/css?family=Lato:400,600,900' rel='stylesheet' type='text/css'/>
<link href='https://fonts.googleapis.com/css?family=Source+Code+Pro:400,500,600' rel='stylesheet' type='text/css'/>
<!-- CSS -->
<title>wIconImage</title>
<link rel="stylesheet" type="text/css" href="nimdoc.out.css">
<script type="text/javascript" src="dochack.js"></script>
<script type="text/javascript">
function main() {
var pragmaDots = document.getElementsByClassName("pragmadots");
for (var i = 0; i < pragmaDots.length; i++) {
pragmaDots[i].onclick = function(event) {
// Hide tease
event.target.parentNode.style.display = "none";
// Show actual
event.target.parentNode.nextElementSibling.style.display = "inline";
}
}
const toggleSwitch = document.querySelector('.theme-switch input[type="checkbox"]');
function switchTheme(e) {
if (e.target.checked) {
document.documentElement.setAttribute('data-theme', 'dark');
localStorage.setItem('theme', 'dark');
} else {
document.documentElement.setAttribute('data-theme', 'light');
localStorage.setItem('theme', 'light');
}
}
toggleSwitch.addEventListener('change', switchTheme, false);
if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
document.documentElement.setAttribute('data-theme', "dark");
toggleSwitch.checked = true;
} else if (window.matchMedia && window.matchMedia('(prefers-color-scheme: light)').matches) {
document.documentElement.setAttribute('data-theme', "light");
toggleSwitch.checked = false;
} else {
const currentTheme = localStorage.getItem('theme') ? localStorage.getItem('theme') : null;
if (currentTheme) {
document.documentElement.setAttribute('data-theme', currentTheme);
if (currentTheme === 'dark') {
toggleSwitch.checked = true;
}
}
}
}
</script>
</head>
<body onload="main()">
<div class="document" id="documentId">
<div class="container">
<h1 class="title">wIconImage</h1>
<div class="row">
<div class="three columns">
<div class="theme-switch-wrapper">
<label class="theme-switch" for="checkbox">
<input type="checkbox" id="checkbox" />
<div class="slider round"></div>
</label>
<em>Dark Mode</em>
</div>
<div id="global-links">
<ul class="simple">
<li>
<a href="https://github.com/khchen/wNim">Github Project</a>
</li>
<li>
<a href="wNim.html">Main Page</a>
</li>
</ul>
</div>
<ul class="simple simple-toc" id="toc-list">
<li>
<a class="reference reference-toplevel" href="#7" id="57">Types</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#wIconImageError"
title="wIconImageError = object of wError"><wbr />w<wbr />Icon<wbr />Image<wbr />Error<span class="attachedType"></span></a></li>
</ul>
</li>
<li>
<a class="reference reference-toplevel" href="#12" id="62">Procs</a>
<ul class="simple simple-toc-section">
<li><a class="reference" href="#init%2CwIconImage%2CwIcon"
title="init(self: wIconImage; icon: wIcon)"><wbr />init<span class="attachedType"></span></a></li>
<li><a class="reference" href="#IconImage%2CwIcon"
title="IconImage(icon: wIcon): wIconImage"><wbr />Icon<wbr />Image<span class="attachedType"></span></a></li>
<li><a class="reference" href="#init%2CwIconImage%2CwCursor"
title="init(self: wIconImage; cursor: wCursor)"><wbr />init<span class="attachedType"></span></a></li>
<li><a class="reference" href="#IconImage%2CwCursor"
title="IconImage(cursor: wCursor): wIconImage"><wbr />Icon<wbr />Image<span class="attachedType"></span></a></li>
<li><a class="reference" href="#init%2CwIconImage%2CwBitmap"
title="init(self: wIconImage; bmp: wBitmap)"><wbr />init<span class="attachedType"></span></a></li>
<li><a class="reference" href="#IconImage%2CwBitmap"
title="IconImage(bmp: wBitmap): wIconImage"><wbr />Icon<wbr />Image<span class="attachedType"></span></a></li>
<li><a class="reference" href="#init%2CwIconImage%2CwImage"
title="init(self: wIconImage; image: wImage)"><wbr />init<span class="attachedType"></span></a></li>
<li><a class="reference" href="#IconImage%2CwImage"
title="IconImage(image: wImage): wIconImage"><wbr />Icon<wbr />Image<span class="attachedType"></span></a></li>
<li><a class="reference" href="#init%2CwIconImage%2Cpointer%2Cint"
title="init(self: wIconImage; data: pointer; length: int; size = wDefaultSize)"><wbr />init<span class="attachedType"></span></a></li>
<li><a class="reference" href="#IconImage%2Cpointer%2Cint"
title="IconImage(data: pointer; length: int; size = wDefaultSize): wIconImage"><wbr />Icon<wbr />Image<span class="attachedType"></span></a></li>
<li><a class="reference" href="#init%2CwIconImage%2Cstring"
title="init(self: wIconImage; str: string; size = wDefaultSize)"><wbr />init<span class="attachedType"></span></a></li>
<li><a class="reference" href="#IconImage%2Cstring"
title="IconImage(str: string; size = wDefaultSize): wIconImage"><wbr />Icon<wbr />Image<span class="attachedType"></span></a></li>
<li><a class="reference" href="#init%2CwIconImage%2CwIconImage"
title="init(self: wIconImage; iconImage: wIconImage)"><wbr />init<span class="attachedType"></span></a></li>
<li><a class="reference" href="#IconImage%2CwIconImage"
title="IconImage(iconImage: wIconImage): wIconImage"><wbr />Icon<wbr />Image<span class="attachedType"></span></a></li>
<li><a class="reference" href="#isPng%2CwIconImage"
title="isPng(self: wIconImage): bool"><wbr />is<wbr />Png<span class="attachedType"></span></a></li>
<li><a class="reference" href="#isBmp%2CwIconImage"
title="isBmp(self: wIconImage): bool"><wbr />is<wbr />Bmp<span class="attachedType"></span></a></li>
<li><a class="reference" href="#toPng%2CwIconImage"
title="toPng(self: wIconImage)"><wbr />to<wbr />Png<span class="attachedType"></span></a></li>
<li><a class="reference" href="#toBmp%2CwIconImage"
title="toBmp(self: wIconImage)"><wbr />to<wbr />Bmp<span class="attachedType"></span></a></li>
<li><a class="reference" href="#getWidth%2CwIconImage"
title="getWidth(self: wIconImage): int"><wbr />get<wbr />Width<span class="attachedType"></span></a></li>
<li><a class="reference" href="#getHeight%2CwIconImage"
title="getHeight(self: wIconImage): int"><wbr />get<wbr />Height<span class="attachedType"></span></a></li>
<li><a class="reference" href="#getSize%2CwIconImage"
title="getSize(self: wIconImage): wSize"><wbr />get<wbr />Size<span class="attachedType"></span></a></li>
<li><a class="reference" href="#getBitCount%2CwIconImage"
title="getBitCount(self: wIconImage): int"><wbr />get<wbr />Bit<wbr />Count<span class="attachedType"></span></a></li>
<li><a class="reference" href="#getHotspot%2CwIconImage"
title="getHotspot(self: wIconImage): wPoint"><wbr />get<wbr />Hotspot<span class="attachedType"></span></a></li>
<li><a class="reference" href="#setHotspot%2CwIconImage%2CwPoint"
title="setHotspot(self: wIconImage; hotspot: wPoint)"><wbr />set<wbr />Hotspot<span class="attachedType"></span></a></li>
<li><a class="reference" href="#IconImages%2Cpointer%2Cint"
title="IconImages(data: pointer; length: int): seq[wIconImage]"><wbr />Icon<wbr />Images<span class="attachedType"></span></a></li>
<li><a class="reference" href="#IconImages%2Cstring"
title="IconImages(str: string): seq[wIconImage]"><wbr />Icon<wbr />Images<span class="attachedType"></span></a></li>
<li><a class="reference" href="#save%2CopenArray%5BwIconImage%5D"
title="save(icons: openArray[wIconImage]; isIcon = true): string"><wbr />save<span class="attachedType"></span></a></li>
<li><a class="reference" href="#save%2CwIconImage"
title="save(self: wIconImage; isIcon = true): string"><wbr />save<span class="attachedType"></span></a></li>
<li><a class="reference" href="#save%2CopenArray%5BwIconImage%5D%2Cstring"
title="save(icons: openArray[wIconImage]; filename: string; isIcon = true)"><wbr />save<span class="attachedType"></span></a></li>
<li><a class="reference" href="#save%2CwIconImage%2Cstring"
title="save(self: wIconImage; filename: string; isIcon = true)"><wbr />save<span class="attachedType"></span></a></li>
</ul>
</li>
</ul>
</div>
<div class="nine columns" id="content">
<div id="tocRoot"></div>
<p class="module-desc"><p>This class encapsulates a Windows icon image. Unlike wImage, wBitmap, wIcon, wCursor, etc., wIconImage doesn't store any Windows resource handle, but only an icon image in binary format. In addition to the binary image data, wIconImage also stores the hotspot for cursor if the icon image is created from a cursor resource.</p>
<p>A wIconImage object can be created from Windows PE files (.exe or .dll) or icon files (.ico or .cur). It also can be created by wImage, wBitmap, wIcon, or wCursor. Furthermore, wIconImage can be converted to wImage, wBitmap, wIcon, wCursor, or .ico/.cur files. In summary, it is easy to deal with Windows' image-like resource and image files by wIconImage.</p>
<p>The wIconImage class use the same binary format as an image inside the icon files. So there are two possible format of wIconImage object: BMP or PNG. Since Windows XP don't support PNG format icon files, it is recommend to use toBmp() before saving a wIconImage object to icon file if the icon file will be used under Windows XP.</p>
<table class="docinfo" frame="void" rules="none"><col class="docinfo-name" /><col class="docinfo-content" /><tbody valign="top"><tr><th class="docinfo-name">Seealso:</th><td><a class="reference external" href="wImage.html">wImage</a> <a class="reference external" href="wBitmap.html">wBitmap</a> <a class="reference external" href="wIcon.html">wIcon</a> <a class="reference external" href="wCursor.html">wCursor</a></td></tr>
</tbody></table></p>
<div class="section" id="7">
<h1><a class="toc-backref" href="#7">Types</a></h1>
<dl class="item">
<a id="wIconImageError"></a>
<dt><pre><a href="wIconImage.html#wIconImageError"><span class="Identifier">wIconImageError</span></a> <span class="Other">=</span> <span class="Keyword">object</span> <span class="Keyword">of</span> <a href="wTypes.html#wError"><span class="Identifier">wError</span></a>
</pre></dt>
<dd>
An error raised when wIconImage creation or operation failure.
</dd>
</dl></div>
<div class="section" id="12">
<h1><a class="toc-backref" href="#12">Procs</a></h1>
<dl class="item">
<a id="init,wIconImage,wIcon"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CwIconImage%2CwIcon"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">icon</span><span class="Other">:</span> <a href="wTypes.html#wIcon"><span class="Identifier">wIcon</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Initializes an icon image from a wIcon object.
</dd>
<a id="IconImage,wIcon"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#IconImage%2CwIcon"><span class="Identifier">IconImage</span></a><span class="Other">(</span><span class="Identifier">icon</span><span class="Other">:</span> <a href="wTypes.html#wIcon"><span class="Identifier">wIcon</span></a><span class="Other">)</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span>
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Constructor.
</dd>
<a id="init,wIconImage,wCursor"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CwIconImage%2CwCursor"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">cursor</span><span class="Other">:</span> <a href="wTypes.html#wCursor"><span class="Identifier">wCursor</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Initializes an icon image from a wCursor object.
</dd>
<a id="IconImage,wCursor"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#IconImage%2CwCursor"><span class="Identifier">IconImage</span></a><span class="Other">(</span><span class="Identifier">cursor</span><span class="Other">:</span> <a href="wTypes.html#wCursor"><span class="Identifier">wCursor</span></a><span class="Other">)</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span>
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Constructor.
</dd>
<a id="init,wIconImage,wBitmap"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CwIconImage%2CwBitmap"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">bmp</span><span class="Other">:</span> <a href="wTypes.html#wBitmap"><span class="Identifier">wBitmap</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Initializes an icon image from a wBitmap object.
</dd>
<a id="IconImage,wBitmap"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#IconImage%2CwBitmap"><span class="Identifier">IconImage</span></a><span class="Other">(</span><span class="Identifier">bmp</span><span class="Other">:</span> <a href="wTypes.html#wBitmap"><span class="Identifier">wBitmap</span></a><span class="Other">)</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">discardable</span><span class="Other">,</span>
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Constructor.
</dd>
<a id="init,wIconImage,wImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CwIconImage%2CwImage"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">image</span><span class="Other">:</span> <a href="wTypes.html#wImage"><span class="Identifier">wImage</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Initializes an icon image from a wImage object.
</dd>
<a id="IconImage,wImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#IconImage%2CwImage"><span class="Identifier">IconImage</span></a><span class="Other">(</span><span class="Identifier">image</span><span class="Other">:</span> <a href="wTypes.html#wImage"><span class="Identifier">wImage</span></a><span class="Other">)</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">discardable</span><span class="Other">,</span>
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Constructor.
</dd>
<a id="init,wIconImage,pointer,int"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CwIconImage%2Cpointer%2Cint"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">length</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">size</span> <span class="Other">=</span> <span class="Identifier">wDefaultSize</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
<p>Initializes an icon image from binary data of .ico or .cur file. The extra <em>size</em> parameter can be used to specified the desired display size. The function uses Windows API to search and return the best fits icon, or uses the SM_CXICON/SM_CXCURSOR system metric value as default value.</p>
<p><strong>Notice: The function will not resize the image, so the real size of retruned icon image may not equal to your desired size.</strong></p>
</dd>
<a id="IconImage,pointer,int"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#IconImage%2Cpointer%2Cint"><span class="Identifier">IconImage</span></a><span class="Other">(</span><span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">length</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">;</span> <span class="Identifier">size</span> <span class="Other">=</span> <span class="Identifier">wDefaultSize</span><span class="Other">)</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span>
<span class="Identifier">discardable</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Constructor.
</dd>
<a id="init,wIconImage,string"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CwIconImage%2Cstring"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">str</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">size</span> <span class="Other">=</span> <span class="Identifier">wDefaultSize</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
<p>Initializes an icon image from a file. The file should be in format of .ico, .cur, or Windows PE file (.exe or .dll, etc). If str is not a valid file path, it will be regarded as the binary data of .ico or .cur file.</p>
<p>For Windows PE file (.exe or .dll), you should use string like "shell32.dll,-10" to specifies the icon index or "shell32.dll:-1001" to to specifies the cursor index. Use zero-based index to specified the resource position, and negative value to specified the resource identifier. Empty filename (e.g. ",-1") to specified the current executable file.</p>
<p>If the resource is an icon/cursor group, the extra <em>size</em> parameter can be used to specified the desired display size. The function uses Windows API to search and return the best fits icon, or uses the SM_CXICON/SM_CXCURSOR system metric value as default value.</p>
<p><strong>Notice: The function will not resize the image, so the real size of retruned icon image may not equal to your desired size.</strong></p>
</dd>
<a id="IconImage,string"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#IconImage%2Cstring"><span class="Identifier">IconImage</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">size</span> <span class="Other">=</span> <span class="Identifier">wDefaultSize</span><span class="Other">)</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">discardable</span><span class="Other">,</span>
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Constructor.
</dd>
<a id="init,wIconImage,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#init%2CwIconImage%2CwIconImage"><span class="Identifier">init</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">iconImage</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span>
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Initializes an icon image from wIconImage object, aka. copy.
</dd>
<a id="IconImage,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#IconImage%2CwIconImage"><span class="Identifier">IconImage</span></a><span class="Other">(</span><span class="Identifier">iconImage</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">discardable</span><span class="Other">,</span>
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">wIconImageError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Constructor.
</dd>
<a id="isPng,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#isPng%2CwIconImage"><span class="Identifier">isPng</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Returns true if this is a PNG format icon image.
</dd>
<a id="isBmp,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#isBmp%2CwIconImage"><span class="Identifier">isBmp</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">bool</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Returns true if this is a bitmap format icon image.
</dd>
<a id="toPng,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#toPng%2CwIconImage"><span class="Identifier">toPng</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">wImageError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Convert this icon image to PNG format.
</dd>
<a id="toBmp,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#toBmp%2CwIconImage"><span class="Identifier">toBmp</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">wNilAccess</span><span class="Other">,</span> <span class="Identifier">Exception</span><span class="Other">,</span> <span class="Identifier">wImageError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">RootEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Convert this icon image to bitmap format.
</dd>
<a id="getWidth,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#getWidth%2CwIconImage"><span class="Identifier">getWidth</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Gets the width of the icon image in pixels.
</dd>
<a id="getHeight,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#getHeight%2CwIconImage"><span class="Identifier">getHeight</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Gets the height of the icon image in pixels.
</dd>
<a id="getSize,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#getSize%2CwIconImage"><span class="Identifier">getSize</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span><span class="Other">:</span> <a href="wTypes.html#wSize"><span class="Identifier">wSize</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">inline</span><span class="Other">,</span> <span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Returns the size of the icon image in pixels.
</dd>
<a id="getBitCount,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#getBitCount%2CwIconImage"><span class="Identifier">getBitCount</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">int</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Returns the bit count of the icon image.
</dd>
<a id="getHotspot,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#getHotspot%2CwIconImage"><span class="Identifier">getHotspot</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">)</span><span class="Other">:</span> <a href="wTypes.html#wPoint"><span class="Identifier">wPoint</span></a> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Returns the cursor's hotspot. If this icon image is created from icon resource instead of cursor resource, the value is wDefaultPoint.
</dd>
<a id="setHotspot,wIconImage,wPoint"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#setHotspot%2CwIconImage%2CwPoint"><span class="Identifier">setHotspot</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">hotspot</span><span class="Other">:</span> <a href="wTypes.html#wPoint"><span class="Identifier">wPoint</span></a><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Set the coordinates of the cursor's hotspot.
</dd>
<a id="IconImages,pointer,int"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#IconImages%2Cpointer%2Cint"><span class="Identifier">IconImages</span></a><span class="Other">(</span><span class="Identifier">data</span><span class="Other">:</span> <span class="Identifier">pointer</span><span class="Other">;</span> <span class="Identifier">length</span><span class="Other">:</span> <span class="Identifier">int</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">]</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Similar to IconImage() for binary data, but this function loads all image in the group and returns a seq.
</dd>
<a id="IconImages,string"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#IconImages%2Cstring"><span class="Identifier">IconImages</span></a><span class="Other">(</span><span class="Identifier">str</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">seq</span><span class="Other">[</span><a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">]</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">ReadIOEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Similar to IconImage(), but this function loads all image in the group and returns a seq.
</dd>
<a id="save,openArray[wIconImage]"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#save%2CopenArray%5BwIconImage%5D"><span class="Identifier">save</span></a><span class="Other">(</span><span class="Identifier">icons</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">isIcon</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Stores multiple icon images to a .ico or .cur format data depends on <em>isIcon</em>.
</dd>
<a id="save,wIconImage"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#save%2CwIconImage"><span class="Identifier">save</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">isIcon</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span><span class="Other">:</span> <span class="Identifier">string</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Stores single icon image to a .ico or .cur format data depends on <em>isIcon</em>.
</dd>
<a id="save,openArray[wIconImage],string"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#save%2CopenArray%5BwIconImage%5D%2Cstring"><span class="Identifier">save</span></a><span class="Other">(</span><span class="Identifier">icons</span><span class="Other">:</span> <span class="Identifier">openArray</span><span class="Other">[</span><a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">]</span><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">isIcon</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma">
<span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span> <span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Stores multiple icon images to a .ico or .cur format file depends on <em>isIcon</em>.
</dd>
<a id="save,wIconImage,string"></a>
<dt><pre><span class="Keyword">proc</span> <a href="#save%2CwIconImage%2Cstring"><span class="Identifier">save</span></a><span class="Other">(</span><span class="Identifier">self</span><span class="Other">:</span> <a href="wTypes.html#wIconImage"><span class="Identifier">wIconImage</span></a><span class="Other">;</span> <span class="Identifier">filename</span><span class="Other">:</span> <span class="Identifier">string</span><span class="Other">;</span> <span class="Identifier">isIcon</span> <span class="Other">=</span> <span class="Identifier">true</span><span class="Other">)</span> <span><span class="Other">{</span><span class="Other pragmadots">...</span><span class="Other">}</span></span><span class="pragmawrap"><span class="Other">{.</span><span class="pragma"><span class="Identifier">raises</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">IOError</span><span class="Other">]</span><span class="Other">,</span>
<span class="Identifier">tags</span><span class="Other">:</span> <span class="Other">[</span><span class="Identifier">WriteIOEffect</span><span class="Other">]</span></span><span class="Other">.}</span></span></pre></dt>
<dd>
Stores single icon image to a .ico or .cur format file depends on <em>isIcon</em>.
</dd>
</dl></div>
</div>
</div>
<div class="row">
<div class="twelve-columns footer">
<span class="nim-sprite"></span>
<br/>
<small style="color: var(--hint);">Made with Nim.</small>
</div>
</div>
</div>
</div>
</body>
</html>