initial commit
[rofl0r-KOL.git] / main_timagelist.htm
bloba191c74aae232205d70731de197ccee92e1c46c9
1 <html>
2 <head>
3 <title>KOL Help: TImageList object (main frame)</title>
4 <base target="_top">
5 </head>
7 <body bgcolor="#FFFFEF" text="#000000" link="#008080" vlink="#008000" alink="#808000">
8 <p><font face="Courier" color="#800080"><b>TImageList( unit <a href=kol_pas.htm>KOL.pas</a> )
9 <font face="Wingdings">ï</font> <a href=tobj.htm>TObj</a>
10 <font face="Wingdings">ï</font> <a href=_tobj.htm>_TObj</a>
11 </b></font></p>
12 <p><b>
13 TImageList = object( <a href=tobj.htm target="_top">TObj</a> )
14 </b></p>
15 ImageList incapsulation.
16 <h3 align="center"><font color="#FF8080">TImageList properties</font></h3>
17 <a name="handle"></a>
18 <p>
19 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Handle</b></font>: THandle;</font>
20 <br>
21 Handle of ImageList object.
22 </p>
23 <a name="shareimages"></a>
24 <p>
25 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>ShareImages</b></font>: <b>Boolean</b>;</font>
26 <br>
27 True if images are shared between processes (it is set to True,
28 if its <a href=#handle target="main">Handle</a> is assigned to given value, which is a handle of
29 already existing ImageList object).
30 </p>
31 <a name="colors"></a>
32 <p>
33 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Colors</b></font>: <a href=kol_pas.htm#timagelistcolors target="_top">TImageListColors</a>;</font>
34 <br>
35 Colors used to represent images.
36 </p>
37 <a name="masked"></a>
38 <p>
39 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Masked</b></font>: <b>Boolean</b>;</font>
40 <br>
41 True, if mask is used. It is set to True, if first added image
42 is icon, e.g.
43 </p>
44 <a name="imgwidth"></a>
45 <p>
46 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>ImgWidth</b></font>: <b>Integer</b>;</font>
47 <br>
48 Width of every image in list. If change, ImageList is cleared.
49 </p>
50 <a name="imgheight"></a>
51 <p>
52 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>ImgHeight</b></font>: <b>Integer</b>;</font>
53 <br>
54 Height of every image in list. If change, ImageList is cleared.
55 </p>
56 <a name="count"></a>
57 <p>
58 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Count</b></font>: <b>Integer</b>;</font>
59 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#209;</font>&nbsp;&nbsp;&nbsp;
60 <br>
61 Number of images in list.
62 </p>
63 <a name="allocby"></a>
64 <p>
65 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>AllocBy</b></font>: <b>Integer</b>;</font>
66 <br>
67 Allocation factor. Default is 1. Set it to size of ImageList if this
68 value is known - to optimize speed of allocation.
69 </p>
70 <a name="bkcolor"></a>
71 <p>
72 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>BkColor</b></font>: TColor;</font>
73 <br>
74 Background color.
75 </p>
76 <a name="blendcolor"></a>
77 <p>
78 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>BlendColor</b></font>: TColor;</font>
79 <br>
80 Blend color.
81 </p>
82 <a name="bitmap"></a>
83 <p>
84 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Bitmap</b></font>: HBitmap;</font>
85 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#209;</font>&nbsp;&nbsp;&nbsp;
86 <br>
87 Bitmap, containing all ImageList images (tiled horizontally).
88 </p>
89 <a name="mask"></a>
90 <p>
91 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Mask</b></font>: HBitmap;</font>
92 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#209;</font>&nbsp;&nbsp;&nbsp;
93 <br>
94 Monochrome bitmap, containing masks for all images in list (if not
95 <a href=#masked target="main">Masked</a>, always returns nil).
96 </p>
97 <a name="drawingstyle"></a>
98 <p>
99 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>DrawingStyle</b></font>: <a href=kol_pas.htm#tdrawingstyle target="_top">TDrawingStyle</a>;</font>
100 <br>
101 Drawing style.
102 </p>
103 <a name="overlay"></a>
105 <font face="Courier" color="#800080"><b>property</b> <font color="#808000"><b>Overlay</b></font>[ Idx: TImgLOVrlayIdx ]: <b>Integer</b>;</font>
106 <br>
107 Overlay images for image list (images, used as overlay images to draw over
108 other images from the image list). These overalay images can be used in
109 listview and treeview as overlaying images (up to four masks at the same
110 time).
111 </p>
112 <h4 align="center"><font color="black">Properties, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
113 <h3 align="center"><font color="#FF8080">TImageList methods</font></h3>
114 <a name="sethandle"></a>
116 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>SetHandle</b></font>( <b>const</b> Value: THandle );</font>
117 &nbsp;&nbsp;&nbsp;<font face="Webdings" size=7>&#78;</font>&nbsp;&nbsp;&nbsp;
118 <br>
119 </p>
120 <a name="destroy"></a>
122 <font face="Courier" color="#800080"><b>destructor</b> <font color="#808000"><b>Destroy</b></font>; <b>virtual</b>;</font>
123 <br>
124 </p>
125 <a name="imgrect"></a>
127 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>ImgRect</b></font>( Idx: <b>Integer</b> ): TRect;</font>
128 <br>
129 Rectangle occupied of given image in ImageList.
130 </p>
131 <a name="add"></a>
133 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>Add</b></font>( Bmp, Msk: HBitmap ): <b>Integer</b>;</font>
134 <br>
135 Adds bitmap and given mask to ImageList.
136 </p>
137 <a name="addmasked"></a>
139 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>AddMasked</b></font>( Bmp: HBitmap; Color: TColor ): <b>Integer</b>;</font>
140 <br>
141 Adds bitmap to ImageList, using given color to create mask.
142 </p>
143 <a name="addicon"></a>
145 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>AddIcon</b></font>( Ico: HIcon ): <b>Integer</b>;</font>
146 <br>
147 Adds icon to ImageList (always masked).
148 </p>
149 <a name="delete"></a>
151 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>Delete</b></font>( Idx: <b>Integer</b> );</font>
152 <br>
153 Deletes given image from ImageList.
154 </p>
155 <a name="clear"></a>
157 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>Clear</b></font>;</font>
158 <br>
159 Makes ImageList empty.
160 </p>
161 <a name="replace"></a>
163 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>Replace</b></font>( Idx: <b>Integer</b>; Bmp, Msk: HBitmap ): <b>Boolean</b>;</font>
164 <br>
165 Replaces given (by index) image with bitmap and its mask with mask bitmap.
166 </p>
167 <a name="replaceicon"></a>
169 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>ReplaceIcon</b></font>( Idx: <b>Integer</b>; Ico: HIcon ): <b>Boolean</b>;</font>
170 <br>
171 Replaces given (by index) image with an icon.
172 </p>
173 <a name="merge"></a>
175 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>Merge</b></font>( Idx: <b>Integer</b>; ImgList2: <a href=kol_pas.htm#pimagelist target="_top">PImageList</a>; Idx2: <b>Integer</b>; X, Y: <b>Integer</b> ): <a href=kol_pas.htm#pimagelist target="_top">PImageList</a>;</font>
176 <br>
177 Merges two ImageList objects, returns resulting ImageList.
178 </p>
179 <a name="extracticon"></a>
181 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>ExtractIcon</b></font>( Idx: <b>Integer</b> ): HIcon;</font>
182 <br>
183 Extracts icon by index.
184 </p>
185 <a name="extracticonex"></a>
187 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>ExtractIconEx</b></font>( Idx: <b>Integer</b> ): HIcon;</font>
188 <br>
189 Extracts icon (is created using current drawing style).
190 </p>
191 <a name="draw"></a>
193 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>Draw</b></font>( Idx: <b>Integer</b>; DC: HDC; X, Y: <b>Integer</b> );</font>
194 <br>
195 Draws given (by index) image from ImageList onto passed Device Context.
196 </p>
197 <a name="stretchdraw"></a>
199 <font face="Courier" color="#800080"><b>procedure</b> <font color="#808000"><b>StretchDraw</b></font>( Idx: <b>Integer</b>; DC: HDC; <b>const</b> Rect: TRect );</font>
200 <br>
201 Draws given image with stratching.
202 </p>
203 <a name="loadbitmap"></a>
205 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>LoadBitmap</b></font>( ResourceName: <b>PChar</b>; TranspColor: TColor ): <b>Boolean</b>;</font>
206 <br>
207 Loads ImageList from resource.
208 </p>
209 <a name="loadfromfile"></a>
211 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>LoadFromFile</b></font>( FileName: <b>PChar</b>; TranspColor: TColor; ImgType: <a href=kol_pas.htm#timagetype target="_top">TImageType</a> ): <b>Boolean</b>;</font>
212 <br>
213 Loads ImageList from file.
214 </p>
215 <a name="loadsystemicons"></a>
217 <font face="Courier" color="#800080"><b>function</b> <font color="#808000"><b>LoadSystemIcons</b></font>( SmallIcons: <b>Boolean</b> ): <b>Boolean</b>;</font>
218 <br>
219 Assigns ImageList to system icons list (big or small).
220 </p>
221 <h4 align="center"><font color="black">Methods, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
222 <h3 align="center"><font color="#FF8080">TImageList events</font></h3>
223 <h4 align="center"><font color="black">Events, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
224 <h3 align="center"><font color="#FF8080">TImageList fields</font></h3>
225 <h4 align="center"><font color="black">Fields, inherited from <a href="tobj.htm" target="_top">TObj</a></font></h4>
226 <hr>
227 <p align="center">[&nbsp;<a href=index.htm>Index</a>&nbsp;]</p>
228 <p align="center"><font face="Comic Sans MS"><small>This help is generated 22-Sep-2005 by KOL Help generator, (C) 2000-2001 by Vladimir Kladov<br>Modified (C) 2003 by Alexander Bartov</small></font></p>
229 </body>
230 </html>