1 {
2 File: HIServices/Icons.h
3
4 Contains: Icon Utilities and Icon Services Interfaces.
5
6 Version: HIServices-416~44
7
8 Copyright: � 1990-2008 by Apple Computer, Inc. All rights reserved
9
10 Bugs?: For bug reports, consult the following page on
11 the World Wide Web:
12
13 http://bugs.freepascal.org
14
15 }
16
17 { Pascal Translation Updated: Gale R Paeper, <gpaeper@empirenet.com>, 2006 }
18 { Pascal Translation Updated: Jonas Maebe, <jonas@freepascal.org>, October 2009 }
19 { Pascal Translation Updated: Gorazd Krosl, <gorazd_1957@yahoo.ca>, October 2009 }
20 { Pascal Translation Updated: Jonas Maebe, <jonas@freepascal.org>, October 2012 }
21
22 {
23 Modified for use with Free Pascal
24 Version 308
25 Please report any bugs to <gpc@microbizz.nl>
26 }
27
28 {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE}
29 {$mode macpas}
30 {$modeswitch cblocks}
31 {$packenum 1}
32 {$macro on}
33 {$inline on}
34 {$calling mwpascal}
35
36 unit Icons;
37 interface
38 {$setc UNIVERSAL_INTERFACES_VERSION := $0400}
39 {$setc GAP_INTERFACES_VERSION := $0308}
40
41 {$ifc not defined USE_CFSTR_CONSTANT_MACROS}
42 {$setc USE_CFSTR_CONSTANT_MACROS := TRUE}
43 {$endc}
44
45 {$ifc defined CPUPOWERPC and defined CPUI386}
46 {$error Conflicting initial definitions for CPUPOWERPC and CPUI386}
47 {$endc}
48 {$ifc defined FPC_BIG_ENDIAN and defined FPC_LITTLE_ENDIAN}
49 {$error Conflicting initial definitions for FPC_BIG_ENDIAN and FPC_LITTLE_ENDIAN}
50 {$endc}
51
52 {$ifc not defined __ppc__ and defined CPUPOWERPC32}
53 {$setc __ppc__ := 1}
54 {$elsec}
55 {$setc __ppc__ := 0}
56 {$endc}
57 {$ifc not defined __ppc64__ and defined CPUPOWERPC64}
58 {$setc __ppc64__ := 1}
59 {$elsec}
60 {$setc __ppc64__ := 0}
61 {$endc}
62 {$ifc not defined __i386__ and defined CPUI386}
63 {$setc __i386__ := 1}
64 {$elsec}
65 {$setc __i386__ := 0}
66 {$endc}
67 {$ifc not defined __x86_64__ and defined CPUX86_64}
68 {$setc __x86_64__ := 1}
69 {$elsec}
70 {$setc __x86_64__ := 0}
71 {$endc}
72 {$ifc not defined __arm__ and defined CPUARM}
73 {$setc __arm__ := 1}
74 {$elsec}
75 {$setc __arm__ := 0}
76 {$endc}
77 {$ifc not defined __arm64__ and defined CPUAARCH64}
78 {$setc __arm64__ := 1}
79 {$elsec}
80 {$setc __arm64__ := 0}
81 {$endc}
82
83 {$ifc defined cpu64}
84 {$setc __LP64__ := 1}
85 {$elsec}
86 {$setc __LP64__ := 0}
87 {$endc}
88
89
90 {$ifc defined __ppc__ and __ppc__ and defined __i386__ and __i386__}
91 {$error Conflicting definitions for __ppc__ and __i386__}
92 {$endc}
93
94 {$ifc defined __ppc__ and __ppc__}
95 {$setc TARGET_CPU_PPC := TRUE}
96 {$setc TARGET_CPU_PPC64 := FALSE}
97 {$setc TARGET_CPU_X86 := FALSE}
98 {$setc TARGET_CPU_X86_64 := FALSE}
99 {$setc TARGET_CPU_ARM := FALSE}
100 {$setc TARGET_CPU_ARM64 := FALSE}
101 {$setc TARGET_OS_MAC := TRUE}
102 {$setc TARGET_OS_IPHONE := FALSE}
103 {$setc TARGET_IPHONE_SIMULATOR := FALSE}
104 {$setc TARGET_OS_EMBEDDED := FALSE}
105 {$elifc defined __ppc64__ and __ppc64__}
106 {$setc TARGET_CPU_PPC := FALSE}
107 {$setc TARGET_CPU_PPC64 := TRUE}
108 {$setc TARGET_CPU_X86 := FALSE}
109 {$setc TARGET_CPU_X86_64 := FALSE}
110 {$setc TARGET_CPU_ARM := FALSE}
111 {$setc TARGET_CPU_ARM64 := FALSE}
112 {$setc TARGET_OS_MAC := TRUE}
113 {$setc TARGET_OS_IPHONE := FALSE}
114 {$setc TARGET_IPHONE_SIMULATOR := FALSE}
115 {$setc TARGET_OS_EMBEDDED := FALSE}
116 {$elifc defined __i386__ and __i386__}
117 {$setc TARGET_CPU_PPC := FALSE}
118 {$setc TARGET_CPU_PPC64 := FALSE}
119 {$setc TARGET_CPU_X86 := TRUE}
120 {$setc TARGET_CPU_X86_64 := FALSE}
121 {$setc TARGET_CPU_ARM := FALSE}
122 {$setc TARGET_CPU_ARM64 := FALSE}
123 {$ifc defined iphonesim}
124 {$setc TARGET_OS_MAC := FALSE}
125 {$setc TARGET_OS_IPHONE := TRUE}
126 {$setc TARGET_IPHONE_SIMULATOR := TRUE}
127 {$elsec}
128 {$setc TARGET_OS_MAC := TRUE}
129 {$setc TARGET_OS_IPHONE := FALSE}
130 {$setc TARGET_IPHONE_SIMULATOR := FALSE}
131 {$endc}
132 {$setc TARGET_OS_EMBEDDED := FALSE}
133 {$elifc defined __x86_64__ and __x86_64__}
134 {$setc TARGET_CPU_PPC := FALSE}
135 {$setc TARGET_CPU_PPC64 := FALSE}
136 {$setc TARGET_CPU_X86 := FALSE}
137 {$setc TARGET_CPU_X86_64 := TRUE}
138 {$setc TARGET_CPU_ARM := FALSE}
139 {$setc TARGET_CPU_ARM64 := FALSE}
140 {$ifc defined iphonesim}
141 {$setc TARGET_OS_MAC := FALSE}
142 {$setc TARGET_OS_IPHONE := TRUE}
143 {$setc TARGET_IPHONE_SIMULATOR := TRUE}
144 {$elsec}
145 {$setc TARGET_OS_MAC := TRUE}
146 {$setc TARGET_OS_IPHONE := FALSE}
147 {$setc TARGET_IPHONE_SIMULATOR := FALSE}
148 {$endc}
149 {$setc TARGET_OS_EMBEDDED := FALSE}
150 {$elifc defined __arm__ and __arm__}
151 {$setc TARGET_CPU_PPC := FALSE}
152 {$setc TARGET_CPU_PPC64 := FALSE}
153 {$setc TARGET_CPU_X86 := FALSE}
154 {$setc TARGET_CPU_X86_64 := FALSE}
155 {$setc TARGET_CPU_ARM := TRUE}
156 {$setc TARGET_CPU_ARM64 := FALSE}
157 {$setc TARGET_OS_MAC := FALSE}
158 {$setc TARGET_OS_IPHONE := TRUE}
159 {$setc TARGET_IPHONE_SIMULATOR := FALSE}
160 {$setc TARGET_OS_EMBEDDED := TRUE}
161 {$elifc defined __arm64__ and __arm64__}
162 {$setc TARGET_CPU_PPC := FALSE}
163 {$setc TARGET_CPU_PPC64 := FALSE}
164 {$setc TARGET_CPU_X86 := FALSE}
165 {$setc TARGET_CPU_X86_64 := FALSE}
166 {$setc TARGET_CPU_ARM := FALSE}
167 {$setc TARGET_CPU_ARM64 := TRUE}
168 {$ifc defined ios}
169 {$setc TARGET_OS_MAC := FALSE}
170 {$setc TARGET_OS_IPHONE := TRUE}
171 {$setc TARGET_OS_EMBEDDED := TRUE}
172 {$elsec}
173 {$setc TARGET_OS_MAC := TRUE}
174 {$setc TARGET_OS_IPHONE := FALSE}
175 {$setc TARGET_OS_EMBEDDED := FALSE}
176 {$endc}
177 {$setc TARGET_IPHONE_SIMULATOR := FALSE}
178 {$elsec}
179 {$error __ppc__ nor __ppc64__ nor __i386__ nor __x86_64__ nor __arm__ nor __arm64__ is defined.}
180 {$endc}
181
182 {$ifc defined __LP64__ and __LP64__ }
183 {$setc TARGET_CPU_64 := TRUE}
184 {$elsec}
185 {$setc TARGET_CPU_64 := FALSE}
186 {$endc}
187
188 {$ifc defined FPC_BIG_ENDIAN}
189 {$setc TARGET_RT_BIG_ENDIAN := TRUE}
190 {$setc TARGET_RT_LITTLE_ENDIAN := FALSE}
191 {$elifc defined FPC_LITTLE_ENDIAN}
192 {$setc TARGET_RT_BIG_ENDIAN := FALSE}
193 {$setc TARGET_RT_LITTLE_ENDIAN := TRUE}
194 {$elsec}
195 {$error Neither FPC_BIG_ENDIAN nor FPC_LITTLE_ENDIAN are defined.}
196 {$endc}
197 {$setc ACCESSOR_CALLS_ARE_FUNCTIONS := TRUE}
198 {$setc CALL_NOT_IN_CARBON := FALSE}
199 {$setc OLDROUTINENAMES := FALSE}
200 {$setc OPAQUE_TOOLBOX_STRUCTS := TRUE}
201 {$setc OPAQUE_UPP_TYPES := TRUE}
202 {$setc OTCARBONAPPLICATION := TRUE}
203 {$setc OTKERNEL := FALSE}
204 {$setc PM_USE_SESSION_APIS := TRUE}
205 {$setc TARGET_API_MAC_CARBON := TRUE}
206 {$setc TARGET_API_MAC_OS8 := FALSE}
207 {$setc TARGET_API_MAC_OSX := TRUE}
208 {$setc TARGET_CARBON := TRUE}
209 {$setc TARGET_CPU_68K := FALSE}
210 {$setc TARGET_CPU_MIPS := FALSE}
211 {$setc TARGET_CPU_SPARC := FALSE}
212 {$setc TARGET_OS_UNIX := FALSE}
213 {$setc TARGET_OS_WIN32 := FALSE}
214 {$setc TARGET_RT_MAC_68881 := FALSE}
215 {$setc TARGET_RT_MAC_CFM := FALSE}
216 {$setc TARGET_RT_MAC_MACHO := TRUE}
217 {$setc TYPED_FUNCTION_POINTERS := TRUE}
218 {$setc TYPE_BOOL := FALSE}
219 {$setc TYPE_EXTENDED := FALSE}
220 {$setc TYPE_LONGLONG := TRUE}
221 uses MacTypes,CFBase,CGGeometry,QuickdrawTypes,IconStorage,IconsCore,Files,CGContext,HIShape;
222 {$endc} {not MACOSALLINCLUDE}
223
224
225 {$ifc TARGET_OS_MAC}
226
227 {$ALIGN MAC68K}
228
229 { Alignment type values. }
230 const
231 kAlignNone = $00;
232 kAlignVerticalCenter = $01;
233 kAlignTop = $02;
234 kAlignBottom = $03;
235 kAlignHorizontalCenter = $04;
236 kAlignAbsoluteCenter = kAlignVerticalCenter or kAlignHorizontalCenter;
237 kAlignCenterTop = kAlignTop or kAlignHorizontalCenter;
238 kAlignCenterBottom = kAlignBottom or kAlignHorizontalCenter;
239 kAlignLeft = $08;
240 kAlignCenterLeft = kAlignVerticalCenter or kAlignLeft;
241 kAlignTopLeft = kAlignTop or kAlignLeft;
242 kAlignBottomLeft = kAlignBottom or kAlignLeft;
243 kAlignRight = $0C;
244 kAlignCenterRight = kAlignVerticalCenter or kAlignRight;
245 kAlignTopRight = kAlignTop or kAlignRight;
246 kAlignBottomRight = kAlignBottom or kAlignRight;
247
248 { Obsolete. Use names defined above. }
249 const
250 atNone = kAlignNone;
251 atVerticalCenter = kAlignVerticalCenter;
252 atTop = kAlignTop;
253 atBottom = kAlignBottom;
254 atHorizontalCenter = kAlignHorizontalCenter;
255 atAbsoluteCenter = kAlignAbsoluteCenter;
256 atCenterTop = kAlignCenterTop;
257 atCenterBottom = kAlignCenterBottom;
258 atLeft = kAlignLeft;
259 atCenterLeft = kAlignCenterLeft;
260 atTopLeft = kAlignTopLeft;
261 atBottomLeft = kAlignBottomLeft;
262 atRight = kAlignRight;
263 atCenterRight = kAlignCenterRight;
264 atTopRight = kAlignTopRight;
265 atBottomRight = kAlignBottomRight;
266
267 type
268 IconAlignmentType = SInt16;
269 { Transform type values. }
270 const
271 kTransformNone = $00;
272 kTransformDisabled = $01;
273 kTransformOffline = $02;
274 kTransformOpen = $03;
275 kTransformLabel1 = $0100;
276 kTransformLabel2 = $0200;
277 kTransformLabel3 = $0300;
278 kTransformLabel4 = $0400;
279 kTransformLabel5 = $0500;
280 kTransformLabel6 = $0600;
281 kTransformLabel7 = $0700;
282 kTransformSelected = $4000;
283 kTransformSelectedDisabled = kTransformSelected or kTransformDisabled;
284 kTransformSelectedOffline = kTransformSelected or kTransformOffline;
285 kTransformSelectedOpen = kTransformSelected or kTransformOpen;
286
287 { Obsolete. Use names defined above. }
288 const
289 ttNone = kTransformNone;
290 ttDisabled = kTransformDisabled;
291 ttOffline = kTransformOffline;
292 ttOpen = kTransformOpen;
293 ttLabel1 = kTransformLabel1;
294 ttLabel2 = kTransformLabel2;
295 ttLabel3 = kTransformLabel3;
296 ttLabel4 = kTransformLabel4;
297 ttLabel5 = kTransformLabel5;
298 ttLabel6 = kTransformLabel6;
299 ttLabel7 = kTransformLabel7;
300 ttSelected = kTransformSelected;
301 ttSelectedDisabled = kTransformSelectedDisabled;
302 ttSelectedOffline = kTransformSelectedOffline;
303 ttSelectedOpen = kTransformSelectedOpen;
304
305 type
306 IconTransformType = SInt16;
307 { Selector mask values. }
308 const
309 kSelectorLarge1Bit = $00000001;
310 kSelectorLarge4Bit = $00000002;
311 kSelectorLarge8Bit = $00000004;
312 kSelectorLarge32Bit = $00000008;
313 kSelectorLarge8BitMask = $00000010;
314 kSelectorSmall1Bit = $00000100;
315 kSelectorSmall4Bit = $00000200;
316 kSelectorSmall8Bit = $00000400;
317 kSelectorSmall32Bit = $00000800;
318 kSelectorSmall8BitMask = $00001000;
319 kSelectorMini1Bit = $00010000;
320 kSelectorMini4Bit = $00020000;
321 kSelectorMini8Bit = $00040000;
322 kSelectorHuge1Bit = $01000000;
323 kSelectorHuge4Bit = $02000000;
324 kSelectorHuge8Bit = $04000000;
325 kSelectorHuge32Bit = $08000000;
326 kSelectorHuge8BitMask = $10000000;
327 kSelectorAllLargeData = $000000FF;
328 kSelectorAllSmallData = $0000FF00;
329 kSelectorAllMiniData = $00FF0000;
330 kSelectorAllHugeData = $FF000000;
331 kSelectorAll1BitData = kSelectorLarge1Bit or kSelectorSmall1Bit or kSelectorMini1Bit or kSelectorHuge1Bit;
332 kSelectorAll4BitData = kSelectorLarge4Bit or kSelectorSmall4Bit or kSelectorMini4Bit or kSelectorHuge4Bit;
333 kSelectorAll8BitData = kSelectorLarge8Bit or kSelectorSmall8Bit or kSelectorMini8Bit or kSelectorHuge8Bit;
334 kSelectorAll32BitData = kSelectorLarge32Bit or kSelectorSmall32Bit or kSelectorHuge32Bit;
335 kSelectorAllAvailableData = $FFFFFFFF;
336
337 type
338 IconSelectorValue = UInt32;
339 { Obsolete. Use names defined above. }
340 const
341 svLarge1Bit = kSelectorLarge1Bit;
342 svLarge4Bit = kSelectorLarge4Bit;
343 svLarge8Bit = kSelectorLarge8Bit;
344 svSmall1Bit = kSelectorSmall1Bit;
345 svSmall4Bit = kSelectorSmall4Bit;
346 svSmall8Bit = kSelectorSmall8Bit;
347 svMini1Bit = kSelectorMini1Bit;
348 svMini4Bit = kSelectorMini4Bit;
349 svMini8Bit = kSelectorMini8Bit;
350 svAllLargeData = kSelectorAllLargeData;
351 svAllSmallData = kSelectorAllSmallData;
352 svAllMiniData = kSelectorAllMiniData;
353 svAll1BitData = kSelectorAll1BitData;
354 svAll4BitData = kSelectorAll4BitData;
355 svAll8BitData = kSelectorAll8BitData;
356 svAllAvailableData = kSelectorAllAvailableData;
357
358 type
theTypenull359 IconActionProcPtr = function( theType: ResType; var theIcon: Handle; yourDataPtr: UnivPtr ): OSErr;
theTypenull360 IconGetterProcPtr = function( theType: ResType; yourDataPtr: UnivPtr ): Handle;
361 IconActionUPP = IconActionProcPtr;
362 IconGetterUPP = IconGetterProcPtr;
363 {
364 * NewIconActionUPP()
365 *
366 * Availability:
367 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
368 * CarbonLib: in CarbonLib 1.0 and later
369 * Non-Carbon CFM: available as macro/inline
370 }
NewIconActionUPPnull371 function NewIconActionUPP( userRoutine: IconActionProcPtr ): IconActionUPP; external name '_NewIconActionUPP';
372 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
373
374 {
375 * NewIconGetterUPP()
376 *
377 * Availability:
378 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
379 * CarbonLib: in CarbonLib 1.0 and later
380 * Non-Carbon CFM: available as macro/inline
381 }
382 { old name was NewIconGetterProc }
NewIconGetterUPPnull383 function NewIconGetterUPP( userRoutine: IconGetterProcPtr ): IconGetterUPP; external name '_NewIconGetterUPP';
384 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
385
386 {
387 * DisposeIconActionUPP()
388 *
389 * Availability:
390 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
391 * CarbonLib: in CarbonLib 1.0 and later
392 * Non-Carbon CFM: available as macro/inline
393 }
394 procedure DisposeIconActionUPP( userUPP: IconActionUPP ); external name '_DisposeIconActionUPP';
395 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
396
397 {
398 * DisposeIconGetterUPP()
399 *
400 * Availability:
401 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
402 * CarbonLib: in CarbonLib 1.0 and later
403 * Non-Carbon CFM: available as macro/inline
404 }
405 procedure DisposeIconGetterUPP( userUPP: IconGetterUPP ); external name '_DisposeIconGetterUPP';
406 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
407
408 {
409 * InvokeIconActionUPP()
410 *
411 * Availability:
412 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
413 * CarbonLib: in CarbonLib 1.0 and later
414 * Non-Carbon CFM: available as macro/inline
415 }
416 { old name was CallIconActionProc }
InvokeIconActionUPPnull417 function InvokeIconActionUPP( theType: ResType; var theIcon: Handle; yourDataPtr: UnivPtr; userUPP: IconActionUPP ): OSErr; external name '_InvokeIconActionUPP';
418 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
419
420 {
421 * InvokeIconGetterUPP()
422 *
423 * Availability:
424 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
425 * CarbonLib: in CarbonLib 1.0 and later
426 * Non-Carbon CFM: available as macro/inline
427 }
InvokeIconGetterUPPnull428 function InvokeIconGetterUPP( theType: ResType; yourDataPtr: UnivPtr; userUPP: IconGetterUPP ): Handle; external name '_InvokeIconGetterUPP';
429 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
430
431 {$ifc not TARGET_CPU_64}
432 type
433 IconGetter = IconGetterProcPtr;
434 IconAction = IconActionProcPtr;
435 { CIconHandle, GetCIcon(), PlotCIcon(), and DisposeCIcon() moved here from Quickdraw.h }
436 CIcon = record
437 iconPMap: PixMap; {the icon's pixMap}
438 iconMask: BitMap; {the icon's mask}
439 iconBMap: BitMap; {the icon's bitMap}
440 iconData: Handle; {the icon's data}
441 iconMaskData: array [0..0] of SInt16; {icon's mask and BitMap data}
442 end;
443 CIconPtr = ^CIcon;
444 type
445 CIconHandle = ^CIconPtr;
446 CIconHandle_fix = ^CIconPtr; { used as field type when a record declaration contains a CIconHandle field identifier }
447 {
448 Note: IconSuiteRef and IconCacheRef should be an abstract types,
449 but too much source code already relies on them being of type Handle.
450 }
451 type
452 IconSuiteRef = Handle;
453 IconCacheRef = Handle;
454
455 {$endc} {not TARGET_CPU_64}
456
457 {$ifc not TARGET_CPU_64}
458
459 {
460 * GetCIcon() *** DEPRECATED ***
461 *
462 * Mac OS X threading:
463 * Not thread safe
464 *
465 * Availability:
466 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
467 * CarbonLib: in CarbonLib 1.0 and later
468 * Non-Carbon CFM: in InterfaceLib 7.1 and later
469 }
GetCIconnull470 function GetCIcon( iconID: SInt16 ): CIconHandle; external name '_GetCIcon';
471 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
472
473
474 {
475 * PlotCIcon() *** DEPRECATED ***
476 *
477 * Mac OS X threading:
478 * Not thread safe
479 *
480 * Availability:
481 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
482 * CarbonLib: in CarbonLib 1.0 and later
483 * Non-Carbon CFM: in InterfaceLib 7.1 and later
484 }
485 procedure PlotCIcon( const (*var*) theRect: Rect; theIcon: CIconHandle ); external name '_PlotCIcon';
486 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
487
488
489 {
490 * DisposeCIcon() *** DEPRECATED ***
491 *
492 * Mac OS X threading:
493 * Not thread safe
494 *
495 * Availability:
496 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
497 * CarbonLib: in CarbonLib 1.0 and later
498 * Non-Carbon CFM: in InterfaceLib 7.1 and later
499 }
500 procedure DisposeCIcon( theIcon: CIconHandle ); external name '_DisposeCIcon';
501 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
502
503
504 {
505 * GetIcon() *** DEPRECATED ***
506 *
507 * Mac OS X threading:
508 * Not thread safe
509 *
510 * Availability:
511 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
512 * CarbonLib: in CarbonLib 1.0 and later
513 * Non-Carbon CFM: in InterfaceLib 7.1 and later
514 }
GetIconnull515 function GetIcon( iconID: SInt16 ): Handle; external name '_GetIcon';
516 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
517
518
519 {
520 * PlotIcon() *** DEPRECATED ***
521 *
522 * Mac OS X threading:
523 * Not thread safe
524 *
525 * Availability:
526 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
527 * CarbonLib: in CarbonLib 1.0 and later
528 * Non-Carbon CFM: in InterfaceLib 7.1 and later
529 }
530 procedure PlotIcon( const (*var*) theRect: Rect; theIcon: Handle ); external name '_PlotIcon';
531 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
532
533
534 {
535 * PlotIconID() *** DEPRECATED ***
536 *
537 * Mac OS X threading:
538 * Not thread safe
539 *
540 * Availability:
541 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
542 * CarbonLib: in CarbonLib 1.0 and later
543 * Non-Carbon CFM: in InterfaceLib 7.1 and later
544 }
PlotIconIDnull545 function PlotIconID( const (*var*) theRect: Rect; align: IconAlignmentType; transform: IconTransformType; theResID: SInt16 ): OSErr; external name '_PlotIconID';
546 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
547
548
549 {
550 * NewIconSuite() *** DEPRECATED ***
551 *
552 * Mac OS X threading:
553 * Not thread safe
554 *
555 * Availability:
556 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
557 * CarbonLib: in CarbonLib 1.0 and later
558 * Non-Carbon CFM: in InterfaceLib 7.1 and later
559 }
NewIconSuitenull560 function NewIconSuite( var theIconSuite: IconSuiteRef ): OSErr; external name '_NewIconSuite';
561 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
562
563
564 {
565 * AddIconToSuite() *** DEPRECATED ***
566 *
567 * Mac OS X threading:
568 * Not thread safe
569 *
570 * Availability:
571 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
572 * CarbonLib: in CarbonLib 1.0 and later
573 * Non-Carbon CFM: in InterfaceLib 7.1 and later
574 }
AddIconToSuitenull575 function AddIconToSuite( theIconData: Handle; theSuite: IconSuiteRef; theType: ResType ): OSErr; external name '_AddIconToSuite';
576 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
577
578
579 {
580 * GetIconFromSuite() *** DEPRECATED ***
581 *
582 * Mac OS X threading:
583 * Not thread safe
584 *
585 * Availability:
586 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
587 * CarbonLib: in CarbonLib 1.0 and later
588 * Non-Carbon CFM: in InterfaceLib 7.1 and later
589 }
GetIconFromSuitenull590 function GetIconFromSuite( var theIconData: Handle; theSuite: IconSuiteRef; theType: ResType ): OSErr; external name '_GetIconFromSuite';
591 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
592
593
594 {
595 * ForEachIconDo() *** DEPRECATED ***
596 *
597 * Mac OS X threading:
598 * Not thread safe
599 *
600 * Availability:
601 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
602 * CarbonLib: in CarbonLib 1.0 and later
603 * Non-Carbon CFM: in InterfaceLib 7.1 and later
604 }
ForEachIconDonull605 function ForEachIconDo( theSuite: IconSuiteRef; selector: IconSelectorValue; action: IconActionUPP; yourDataPtr: UnivPtr ): OSErr; external name '_ForEachIconDo';
606 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
607
608
609 {
610 * GetIconSuite() *** DEPRECATED ***
611 *
612 * Mac OS X threading:
613 * Not thread safe
614 *
615 * Availability:
616 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
617 * CarbonLib: in CarbonLib 1.0 and later
618 * Non-Carbon CFM: in InterfaceLib 7.1 and later
619 }
GetIconSuitenull620 function GetIconSuite( var theIconSuite: IconSuiteRef; theResID: SInt16; selector: IconSelectorValue ): OSErr; external name '_GetIconSuite';
621 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
622
623
624 {
625 * DisposeIconSuite() *** DEPRECATED ***
626 *
627 * Mac OS X threading:
628 * Not thread safe
629 *
630 * Availability:
631 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
632 * CarbonLib: in CarbonLib 1.0 and later
633 * Non-Carbon CFM: in InterfaceLib 7.1 and later
634 }
DisposeIconSuitenull635 function DisposeIconSuite( theIconSuite: IconSuiteRef; disposeData: Boolean ): OSErr; external name '_DisposeIconSuite';
636 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
637
638
639 {
640 * PlotIconSuite() *** DEPRECATED ***
641 *
642 * Mac OS X threading:
643 * Not thread safe
644 *
645 * Availability:
646 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
647 * CarbonLib: in CarbonLib 1.0 and later
648 * Non-Carbon CFM: in InterfaceLib 7.1 and later
649 }
PlotIconSuitenull650 function PlotIconSuite( const (*var*) theRect: Rect; align: IconAlignmentType; transform: IconTransformType; theIconSuite: IconSuiteRef ): OSErr; external name '_PlotIconSuite';
651 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
652
653
654 {
655 * MakeIconCache() *** DEPRECATED ***
656 *
657 * Mac OS X threading:
658 * Not thread safe
659 *
660 * Availability:
661 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
662 * CarbonLib: in CarbonLib 1.0 and later
663 * Non-Carbon CFM: in InterfaceLib 7.1 and later
664 }
MakeIconCachenull665 function MakeIconCache( var theCache: IconCacheRef; makeIcon: IconGetterUPP; yourDataPtr: UnivPtr ): OSErr; external name '_MakeIconCache';
666 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
667
668
669 {
670 * LoadIconCache() *** DEPRECATED ***
671 *
672 * Mac OS X threading:
673 * Not thread safe
674 *
675 * Availability:
676 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
677 * CarbonLib: in CarbonLib 1.0 and later
678 * Non-Carbon CFM: in InterfaceLib 7.1 and later
679 }
LoadIconCachenull680 function LoadIconCache( const (*var*) theRect: Rect; align: IconAlignmentType; transform: IconTransformType; theIconCache: IconCacheRef ): OSErr; external name '_LoadIconCache';
681 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
682
683
684 {
685 * PlotIconMethod() *** DEPRECATED ***
686 *
687 * Mac OS X threading:
688 * Not thread safe
689 *
690 * Availability:
691 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
692 * CarbonLib: in CarbonLib 1.0 and later
693 * Non-Carbon CFM: in InterfaceLib 7.1 and later
694 }
PlotIconMethodnull695 function PlotIconMethod( const (*var*) theRect: Rect; align: IconAlignmentType; transform: IconTransformType; theMethod: IconGetterUPP; yourDataPtr: UnivPtr ): OSErr; external name '_PlotIconMethod';
696 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
697
698
699 {
700 * GetLabel() *** DEPRECATED ***
701 *
702 * Mac OS X threading:
703 * Thread safe since version 10.3
704 *
705 * Availability:
706 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
707 * CarbonLib: in CarbonLib 1.0 and later
708 * Non-Carbon CFM: in InterfaceLib 7.1 and later
709 }
GetLabelnull710 function GetLabel( labelNumber: SInt16; var labelColor: RGBColor; var labelString: Str255 ): OSErr; external name '_GetLabel';
711 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
712
713
714 {
715 * PtInIconID() *** DEPRECATED ***
716 *
717 * Mac OS X threading:
718 * Not thread safe
719 *
720 * Availability:
721 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
722 * CarbonLib: in CarbonLib 1.0 and later
723 * Non-Carbon CFM: in InterfaceLib 7.1 and later
724 }
PtInIconIDnull725 function PtInIconID( testPt: Point; const (*var*) iconRect: Rect; align: IconAlignmentType; iconID: SInt16 ): Boolean; external name '_PtInIconID';
726 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
727
728
729 {
730 * PtInIconSuite() *** DEPRECATED ***
731 *
732 * Mac OS X threading:
733 * Not thread safe
734 *
735 * Availability:
736 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
737 * CarbonLib: in CarbonLib 1.0 and later
738 * Non-Carbon CFM: in InterfaceLib 7.1 and later
739 }
PtInIconSuitenull740 function PtInIconSuite( testPt: Point; const (*var*) iconRect: Rect; align: IconAlignmentType; theIconSuite: IconSuiteRef ): Boolean; external name '_PtInIconSuite';
741 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
742
743
744 {
745 * PtInIconMethod() *** DEPRECATED ***
746 *
747 * Mac OS X threading:
748 * Not thread safe
749 *
750 * Availability:
751 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
752 * CarbonLib: in CarbonLib 1.0 and later
753 * Non-Carbon CFM: in InterfaceLib 7.1 and later
754 }
PtInIconMethodnull755 function PtInIconMethod( testPt: Point; const (*var*) iconRect: Rect; align: IconAlignmentType; theMethod: IconGetterUPP; yourDataPtr: UnivPtr ): Boolean; external name '_PtInIconMethod';
756 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
757
758
759 {
760 * RectInIconID() *** DEPRECATED ***
761 *
762 * Mac OS X threading:
763 * Not thread safe
764 *
765 * Availability:
766 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
767 * CarbonLib: in CarbonLib 1.0 and later
768 * Non-Carbon CFM: in InterfaceLib 7.1 and later
769 }
RectInIconIDnull770 function RectInIconID( const (*var*) testRect: Rect; const (*var*) iconRect: Rect; align: IconAlignmentType; iconID: SInt16 ): Boolean; external name '_RectInIconID';
771 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
772
773
774 {
775 * RectInIconSuite() *** DEPRECATED ***
776 *
777 * Mac OS X threading:
778 * Not thread safe
779 *
780 * Availability:
781 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
782 * CarbonLib: in CarbonLib 1.0 and later
783 * Non-Carbon CFM: in InterfaceLib 7.1 and later
784 }
RectInIconSuitenull785 function RectInIconSuite( const (*var*) testRect: Rect; const (*var*) iconRect: Rect; align: IconAlignmentType; theIconSuite: IconSuiteRef ): Boolean; external name '_RectInIconSuite';
786 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
787
788
789 {
790 * RectInIconMethod() *** DEPRECATED ***
791 *
792 * Mac OS X threading:
793 * Not thread safe
794 *
795 * Availability:
796 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
797 * CarbonLib: in CarbonLib 1.0 and later
798 * Non-Carbon CFM: in InterfaceLib 7.1 and later
799 }
RectInIconMethodnull800 function RectInIconMethod( const (*var*) testRect: Rect; const (*var*) iconRect: Rect; align: IconAlignmentType; theMethod: IconGetterUPP; yourDataPtr: UnivPtr ): Boolean; external name '_RectInIconMethod';
801 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
802
803
804 {
805 * IconIDToRgn() *** DEPRECATED ***
806 *
807 * Mac OS X threading:
808 * Not thread safe
809 *
810 * Availability:
811 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
812 * CarbonLib: in CarbonLib 1.0 and later
813 * Non-Carbon CFM: in InterfaceLib 7.1 and later
814 }
IconIDToRgnnull815 function IconIDToRgn( theRgn: RgnHandle; const (*var*) iconRect: Rect; align: IconAlignmentType; iconID: SInt16 ): OSErr; external name '_IconIDToRgn';
816 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
817
818
819 {
820 * IconSuiteToRgn() *** DEPRECATED ***
821 *
822 * Mac OS X threading:
823 * Not thread safe
824 *
825 * Availability:
826 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
827 * CarbonLib: in CarbonLib 1.0 and later
828 * Non-Carbon CFM: in InterfaceLib 7.1 and later
829 }
IconSuiteToRgnnull830 function IconSuiteToRgn( theRgn: RgnHandle; const (*var*) iconRect: Rect; align: IconAlignmentType; theIconSuite: IconSuiteRef ): OSErr; external name '_IconSuiteToRgn';
831 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
832
833
834 {
835 * IconMethodToRgn() *** DEPRECATED ***
836 *
837 * Mac OS X threading:
838 * Not thread safe
839 *
840 * Availability:
841 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
842 * CarbonLib: in CarbonLib 1.0 and later
843 * Non-Carbon CFM: in InterfaceLib 7.1 and later
844 }
IconMethodToRgnnull845 function IconMethodToRgn( theRgn: RgnHandle; const (*var*) iconRect: Rect; align: IconAlignmentType; theMethod: IconGetterUPP; yourDataPtr: UnivPtr ): OSErr; external name '_IconMethodToRgn';
846 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
847
848
849 {
850 * SetSuiteLabel() *** DEPRECATED ***
851 *
852 * Mac OS X threading:
853 * Not thread safe
854 *
855 * Availability:
856 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
857 * CarbonLib: in CarbonLib 1.0 and later
858 * Non-Carbon CFM: in InterfaceLib 7.1 and later
859 }
SetSuiteLabelnull860 function SetSuiteLabel( theSuite: IconSuiteRef; theLabel: SInt16 ): OSErr; external name '_SetSuiteLabel';
861 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
862
863
864 {
865 * GetSuiteLabel() *** DEPRECATED ***
866 *
867 * Mac OS X threading:
868 * Not thread safe
869 *
870 * Availability:
871 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
872 * CarbonLib: in CarbonLib 1.0 and later
873 * Non-Carbon CFM: in InterfaceLib 7.1 and later
874 }
GetSuiteLabelnull875 function GetSuiteLabel( theSuite: IconSuiteRef ): SInt16; external name '_GetSuiteLabel';
876 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
877
878
879 {
880 * GetIconCacheData() *** DEPRECATED ***
881 *
882 * Mac OS X threading:
883 * Not thread safe
884 *
885 * Availability:
886 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
887 * CarbonLib: in CarbonLib 1.0 and later
888 * Non-Carbon CFM: in InterfaceLib 7.1 and later
889 }
GetIconCacheDatanull890 function GetIconCacheData( theCache: IconCacheRef; var theData: UnivPtr ): OSErr; external name '_GetIconCacheData';
891 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
892
893
894 {
895 * SetIconCacheData() *** DEPRECATED ***
896 *
897 * Mac OS X threading:
898 * Not thread safe
899 *
900 * Availability:
901 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
902 * CarbonLib: in CarbonLib 1.0 and later
903 * Non-Carbon CFM: in InterfaceLib 7.1 and later
904 }
SetIconCacheDatanull905 function SetIconCacheData( theCache: IconCacheRef; theData: UnivPtr ): OSErr; external name '_SetIconCacheData';
906 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
907
908
909 {
910 * GetIconCacheProc() *** DEPRECATED ***
911 *
912 * Mac OS X threading:
913 * Not thread safe
914 *
915 * Availability:
916 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
917 * CarbonLib: in CarbonLib 1.0 and later
918 * Non-Carbon CFM: in InterfaceLib 7.1 and later
919 }
GetIconCacheProcnull920 function GetIconCacheProc( theCache: IconCacheRef; var theProc: IconGetterUPP ): OSErr; external name '_GetIconCacheProc';
921 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
922
923
924 {
925 * SetIconCacheProc() *** DEPRECATED ***
926 *
927 * Mac OS X threading:
928 * Not thread safe
929 *
930 * Availability:
931 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
932 * CarbonLib: in CarbonLib 1.0 and later
933 * Non-Carbon CFM: in InterfaceLib 7.1 and later
934 }
SetIconCacheProcnull935 function SetIconCacheProc( theCache: IconCacheRef; theProc: IconGetterUPP ): OSErr; external name '_SetIconCacheProc';
936 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
937
938
939 {
940 * PlotIconHandle() *** DEPRECATED ***
941 *
942 * Mac OS X threading:
943 * Not thread safe
944 *
945 * Availability:
946 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
947 * CarbonLib: in CarbonLib 1.0 and later
948 * Non-Carbon CFM: in InterfaceLib 7.1 and later
949 }
PlotIconHandlenull950 function PlotIconHandle( const (*var*) theRect: Rect; align: IconAlignmentType; transform: IconTransformType; theIcon: Handle ): OSErr; external name '_PlotIconHandle';
951 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
952
953
954 {
955 * PlotSICNHandle() *** DEPRECATED ***
956 *
957 * Mac OS X threading:
958 * Not thread safe
959 *
960 * Availability:
961 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
962 * CarbonLib: in CarbonLib 1.0 and later
963 * Non-Carbon CFM: in InterfaceLib 7.1 and later
964 }
PlotSICNHandlenull965 function PlotSICNHandle( const (*var*) theRect: Rect; align: IconAlignmentType; transform: IconTransformType; theSICN: Handle ): OSErr; external name '_PlotSICNHandle';
966 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
967
968
969 {
970 * PlotCIconHandle() *** DEPRECATED ***
971 *
972 * Mac OS X threading:
973 * Not thread safe
974 *
975 * Availability:
976 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
977 * CarbonLib: in CarbonLib 1.0 and later
978 * Non-Carbon CFM: in InterfaceLib 7.1 and later
979 }
PlotCIconHandlenull980 function PlotCIconHandle( const (*var*) theRect: Rect; align: IconAlignmentType; transform: IconTransformType; theCIcon: CIconHandle ): OSErr; external name '_PlotCIconHandle';
981 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
982
983
984 {$endc} {not TARGET_CPU_64}
985
986
987 {
988 * PlotIconRefFlags
989 *
990 * Discussion:
991 * Flags that can be passed to the PlotIconRefInContext routine.
992 }
993 type
994 PlotIconRefFlags = UInt32;
995 const
996 {
997 * Draw the icon image and alpha channel.
998 }
999 kPlotIconRefNormalFlags = 0;
1000
1001 {
1002 * Only draw the alpha channel.
1003 }
1004 kPlotIconRefNoImage = 1 shl 1;
1005
1006 {
1007 * Only draw the image.
1008 }
1009 kPlotIconRefNoMask = 1 shl 2;
1010
1011
1012 {
1013 ==============================================================================
1014 Converting data structures
1015 ==============================================================================
1016 }
1017
1018
1019 {
1020 IconRefToIconFamily
1021 This routines returns a new IconFamily that contains the data corresponding
1022 to the specified IconRef.
1023 }
1024
1025 {
1026 * IconRefToIconFamily()
1027 *
1028 * Mac OS X threading:
1029 * Not thread safe
1030 *
1031 * Availability:
1032 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
1033 * CarbonLib: in CarbonLib 1.0 and later
1034 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1035 }
IconRefToIconFamilynull1036 function IconRefToIconFamily( theIconRef: IconRef; whichIcons: IconSelectorValue; var iconFamily: IconFamilyHandle ): OSErr; external name '_IconRefToIconFamily';
1037 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
1038
1039
1040 {
1041 IconFamilyToIconSuite
1042 This routine transfers the data from an icon family handle into an icon suite.
1043 }
1044
1045 {$ifc not TARGET_CPU_64}
1046 {
1047 * IconFamilyToIconSuite() *** DEPRECATED ***
1048 *
1049 * Mac OS X threading:
1050 * Not thread safe
1051 *
1052 * Availability:
1053 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
1054 * CarbonLib: in CarbonLib 1.0 and later
1055 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1056 }
IconFamilyToIconSuitenull1057 function IconFamilyToIconSuite( iconFamily: IconFamilyHandle; whichIcons: IconSelectorValue; var iconSuite: IconSuiteRef ): OSErr; external name '_IconFamilyToIconSuite';
1058 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
1059
1060
1061 {
1062 IconSuiteToIconFamily
1063 This routine transfers the data in an icon suite into an icon family.
1064 }
1065
1066 {
1067 * IconSuiteToIconFamily() *** DEPRECATED ***
1068 *
1069 * Mac OS X threading:
1070 * Not thread safe
1071 *
1072 * Availability:
1073 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
1074 * CarbonLib: in CarbonLib 1.0 and later
1075 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1076 }
IconSuiteToIconFamilynull1077 function IconSuiteToIconFamily( iconSuite: IconSuiteRef; whichIcons: IconSelectorValue; var iconFamily: IconFamilyHandle ): OSErr; external name '_IconSuiteToIconFamily';
1078 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
1079
1080
1081 {
1082 SetIconFamilyData
1083 Change the data of an icon family. The data is copied.
1084 The type can be one of the icon type, or 'PICT'.
1085 The data will be compressed if needed.
1086 }
1087
1088 {$endc} {not TARGET_CPU_64}
1089
1090 {
1091 * SetIconFamilyData()
1092 *
1093 * Mac OS X threading:
1094 * Not thread safe
1095 *
1096 * Availability:
1097 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
1098 * CarbonLib: in CarbonLib 1.0 and later
1099 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1100 }
SetIconFamilyDatanull1101 function SetIconFamilyData( iconFamily: IconFamilyHandle; iconType: OSType; h: Handle ): OSErr; external name '_SetIconFamilyData';
1102 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
1103
1104
1105 {
1106 GetIconFamilyData
1107 Return a copy of the data in the icon family.
1108 The type can be one of the icon type, or 'PICT'
1109 The data will be returned uncompressed.
1110 The handle (h) will be resized as appropriate. If no data of the
1111 requested type is present, the handle size will be set to 0.
1112 }
1113
1114 {
1115 * GetIconFamilyData()
1116 *
1117 * Mac OS X threading:
1118 * Not thread safe
1119 *
1120 * Availability:
1121 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
1122 * CarbonLib: in CarbonLib 1.0 and later
1123 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1124 }
GetIconFamilyDatanull1125 function GetIconFamilyData( iconFamily: IconFamilyHandle; iconType: OSType; h: Handle ): OSErr; external name '_GetIconFamilyData';
1126 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
1127
1128
1129 {
1130 PlotIconRef
1131
1132 This routine plots the IconRef. It mostly takes the same parameters as
1133 PlotIconSuite. Pass kIconServicesNormalUsageFlag as a default value for
1134 IconServicesUsageFlags.
1135 }
1136
1137 {$ifc not TARGET_CPU_64}
1138 {
1139 * PlotIconRef() *** DEPRECATED ***
1140 *
1141 * Mac OS X threading:
1142 * Not thread safe
1143 *
1144 * Availability:
1145 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
1146 * CarbonLib: in CarbonLib 1.0 and later
1147 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1148 }
PlotIconRefnull1149 function PlotIconRef( const (*var*) theRect: Rect; align: IconAlignmentType; transform: IconTransformType; theIconServicesUsageFlags: IconServicesUsageFlags; theIconRef: IconRef ): OSErr; external name '_PlotIconRef';
1150 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
1151
1152
1153 { PlotIconRefInContext}
1154 {$endc} {not TARGET_CPU_64}
1155
1156 {
1157 * PlotIconRefInContext()
1158 *
1159 * Discussion:
1160 * This routines plots an IconRef using Quartz/CoreGraphics.
1161 *
1162 * Mac OS X threading:
1163 * Thread safe since version 10.4
1164 *
1165 * Parameters:
1166 *
1167 * inContext:
1168 * The graphics context to use.
1169 *
1170 * inRect:
1171 * The rect to plot the icon in.
1172 *
1173 * inAlign:
1174 * The icon alignment.
1175 *
1176 * inTransform:
1177 * The icon transform.
1178 *
1179 * inLabelColor:
1180 * The icon label color.
1181 *
1182 * inFlags:
1183 * The drawing flags to use (usually kPlotIconRefNormalFlags).
1184 *
1185 * inIconRef:
1186 * The IconRef to plot.
1187 *
1188 * Availability:
1189 * Mac OS X: in version 10.1 and later in ApplicationServices.framework
1190 * CarbonLib: not available in CarbonLib 1.x, is available on Mac OS X version 10.1 and later
1191 * Non-Carbon CFM: not available
1192 }
PlotIconRefInContextnull1193 function PlotIconRefInContext( inContext: CGContextRef; const (*var*) inRect: CGRect; inAlign: IconAlignmentType; inTransform: IconTransformType; inLabelColor: RGBColorPtr; inFlags: PlotIconRefFlags; inIconRef: IconRef ): OSStatus; external name '_PlotIconRefInContext';
1194 (* AVAILABLE_MAC_OS_X_VERSION_10_1_AND_LATER *)
1195
1196
1197 {
1198 PtInIconRef
1199
1200 This routine indicates if testPt would hit the icon designated by iconRef.
1201 It mostly takes the same parameters as PtInIconSuite.
1202 Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
1203 This call is deprecated. Please use IconRefContainsCGPoint() instead.
1204 }
1205
1206
1207 {$ifc not TARGET_CPU_64}
1208 {
1209 * PtInIconRef() *** DEPRECATED ***
1210 *
1211 * Mac OS X threading:
1212 * Not thread safe
1213 *
1214 * Availability:
1215 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
1216 * CarbonLib: in CarbonLib 1.0 and later
1217 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1218 }
PtInIconRefnull1219 function PtInIconRef( const (*var*) testPt: Point; const (*var*) iconRect: Rect; align: IconAlignmentType; theIconServicesUsageFlags: IconServicesUsageFlags; theIconRef: IconRef ): Boolean; external name '_PtInIconRef';
1220 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
1221
1222
1223 {
1224 RectInIconRef
1225
1226 This routine indicates if testRect would intersect the icon designated by iconRef.
1227 It mostly takes the same parameters as RectInIconSuite.
1228 Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
1229 This call is deprecated. Please use IconRefIntersectsCGRect() instead.
1230 }
1231
1232
1233 {
1234 * RectInIconRef() *** DEPRECATED ***
1235 *
1236 * Mac OS X threading:
1237 * Not thread safe
1238 *
1239 * Availability:
1240 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
1241 * CarbonLib: in CarbonLib 1.0 and later
1242 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1243 }
RectInIconRefnull1244 function RectInIconRef( const (*var*) testRect: Rect; const (*var*) iconRect: Rect; align: IconAlignmentType; theIconServicesUsageFlags: IconServicesUsageFlags; theIconRef: IconRef ): Boolean; external name '_RectInIconRef';
1245 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
1246
1247
1248 {
1249 IconRefToRgn
1250
1251 This routine returns a region for the icon.
1252 It mostly takes the same parameters as IconSuiteToRgn.
1253 Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
1254 This call is deprecated. Please use IconRefToHIShape() instead.
1255 }
1256
1257 {
1258 * IconRefToRgn() *** DEPRECATED ***
1259 *
1260 * Mac OS X threading:
1261 * Not thread safe
1262 *
1263 * Availability:
1264 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.5
1265 * CarbonLib: in CarbonLib 1.0 and later
1266 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1267 }
IconRefToRgnnull1268 function IconRefToRgn( theRgn: RgnHandle; const (*var*) iconRect: Rect; align: IconAlignmentType; theIconServicesUsageFlags: IconServicesUsageFlags; theIconRef: IconRef ): OSErr; external name '_IconRefToRgn';
1269 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_5 *)
1270
1271
1272 {$endc} {not TARGET_CPU_64}
1273
1274 {
1275 * IconRefContainsCGPoint()
1276 *
1277 * Discussion:
1278 * Tests whether a specified point falls within an icon�s mask.
1279 *
1280 * Mac OS X threading:
1281 * Thread safe since version 10.5
1282 *
1283 * Parameters:
1284 *
1285 * testPt:
1286 * A pointer to the location that IconServices tests to see
1287 * whether is falls within the mask of indicated icon.
1288 *
1289 * iconRect:
1290 * A pointer to the rectangle defining the area that Icon Services
1291 * uses to determine which icon is hit-tested. Use the same CGRect
1292 * value as when the icon was last drawn.
1293 *
1294 * align:
1295 * A value that specifies how the indicated icon is aligned within
1296 * the rectangle specified in the iconRect parameter. Use the same
1297 * IconAlignmentType value as when the icon was last drawn.
1298 *
1299 * iconServicesUsageFlags:
1300 * Reserved for future use. Pass the kIconServicesNormalUsageFlag
1301 * constant in this parameter.
1302 *
1303 * theIconRef:
1304 * The icon to be tested.
1305 *
1306 * Availability:
1307 * Mac OS X: in version 10.5 and later in ApplicationServices.framework
1308 * CarbonLib: not available
1309 * Non-Carbon CFM: not available
1310 }
IconRefContainsCGPointnull1311 function IconRefContainsCGPoint( const (*var*) testPt: CGPoint; const (*var*) iconRect: CGRect; align: IconAlignmentType; theIconServicesUsageFlags: IconServicesUsageFlags; theIconRef: IconRef ): Boolean; external name '_IconRefContainsCGPoint';
1312 (* AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER *)
1313
1314
1315 {
1316 * IconRefIntersectsCGRect()
1317 *
1318 * Discussion:
1319 * Tests whether a specified rectangle falls within an icon�s mask.
1320 *
1321 * Mac OS X threading:
1322 * Thread safe since version 10.5
1323 *
1324 * Parameters:
1325 *
1326 * testRect:
1327 * A pointer to the rectangle that IconServices tests to see
1328 * whether is falls within the mask of indicated icon.
1329 *
1330 * iconRect:
1331 * A pointer to the rectangle defining the area that Icon Services
1332 * uses to determine which icon is hit-tested. Use the same CGRect
1333 * value as when the icon was last drawn.
1334 *
1335 * align:
1336 * A value that specifies how the indicated icon is aligned within
1337 * the rectangle specified in the iconRect parameter. Use the same
1338 * IconAlignmentType value as when the icon was last drawn.
1339 *
1340 * iconServicesUsageFlags:
1341 * Reserved for future use. Pass the kIconServicesNormalUsageFlag
1342 * constant in this parameter.
1343 *
1344 * theIconRef:
1345 * The icon to be tested.
1346 *
1347 * Availability:
1348 * Mac OS X: in version 10.5 and later in ApplicationServices.framework
1349 * CarbonLib: not available
1350 * Non-Carbon CFM: not available
1351 }
IconRefIntersectsCGRectnull1352 function IconRefIntersectsCGRect( const (*var*) testRect: CGRect; const (*var*) iconRect: CGRect; align: IconAlignmentType; theIconServicesUsageFlags: IconServicesUsageFlags; theIconRef: IconRef ): Boolean; external name '_IconRefIntersectsCGRect';
1353 (* AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER *)
1354
1355 {
1356 * IconRefToHIShape()
1357 *
1358 * Discussion:
1359 * Converts an IconRef-derived icon into an HIShape.
1360 *
1361 * Mac OS X threading:
1362 * Thread safe since version 10.5
1363 *
1364 * Parameters:
1365 *
1366 * iconRect:
1367 * A pointer to the rectangle defining the area that Icon Services
1368 * uses as the bounding box of the region.
1369 *
1370 * align:
1371 * The value which determines how Icon Services aligns the region
1372 * within the rectangle.
1373 *
1374 * iconServicesUsageFlags:
1375 * Reserved for future use. Pass the kIconServicesNormalUsageFlag
1376 * constant in this parameter.
1377 *
1378 * theIconRef:
1379 * The icon to be tested.
1380 *
1381 * Availability:
1382 * Mac OS X: in version 10.5 and later in ApplicationServices.framework
1383 * CarbonLib: not available
1384 * Non-Carbon CFM: not available
1385 }
IconRefToHIShapenull1386 function IconRefToHIShape( const (*var*) iconRect: CGRect; align: IconAlignmentType; theIconServicesUsageFlags: IconServicesUsageFlags; theIconRef: IconRef ): HIShapeRef; external name '_IconRefToHIShape';
1387 (* AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER *)
1388
1389
1390 {
1391 GetIconSizesFromIconRef
1392
1393 This routine returns an IconSelectorValue indicating the depths and sizes of
1394 icon data which are actually available. It takes an IconSelectorValue
1395 indicating which sizes/depths the caller is interested and returns an
1396 IconSelectorValue indicating which sizes/depths exist.
1397
1398 Caution:
1399
1400 This is potentially an extremely expensive call as IconServices may be forced
1401 to attempt fetching the data for the IconRef's sizes/depths which may result
1402 in hitting the local disk or even the network to obtain the data to determine
1403 which sizes/depths actually exist.
1404 Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
1405
1406 This call is deprecated. Please use IsDataAvailableInIconRef() instead.
1407 }
1408
1409 {$ifc not TARGET_CPU_64}
1410 {
1411 * GetIconSizesFromIconRef() *** DEPRECATED ***
1412 *
1413 * Mac OS X threading:
1414 * Not thread safe
1415 *
1416 * Availability:
1417 * Mac OS X: in version 10.0 and later in ApplicationServices.framework [32-bit only] but deprecated in 10.3
1418 * CarbonLib: in CarbonLib 1.0 and later
1419 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1420 }
GetIconSizesFromIconRefnull1421 function GetIconSizesFromIconRef( iconSelectorInput: IconSelectorValue; var iconSelectorOutputPtr: IconSelectorValue; iconServicesUsageFlags_: IconServicesUsageFlags; theIconRef: IconRef ): OSErr; external name '_GetIconSizesFromIconRef';
1422 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER_BUT_DEPRECATED_IN_MAC_OS_X_VERSION_10_3 *)
1423
1424
1425 {
1426 IsIconRefMaskEmpty
1427 Returns true if the mask for this icon is blank
1428 }
1429
1430 {$endc} {TARGET_CPU_64}
1431
1432 {
1433 * IsIconRefMaskEmpty()
1434 *
1435 * Mac OS X threading:
1436 * Not thread safe
1437 *
1438 * Availability:
1439 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
1440 * CarbonLib: in CarbonLib 1.0 and later
1441 * Non-Carbon CFM: in IconServicesLib 8.5 and later
1442 }
IsIconRefMaskEmptynull1443 function IsIconRefMaskEmpty( iconRef_: IconRef ): Boolean; external name '_IsIconRefMaskEmpty';
1444 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
1445
1446
1447 {
1448 GetIconRefVariant
1449 Icon variants allows different images to be used with different icon state.
1450 For example, the 'open' variant for a folder could be represented with
1451 an open folder.
1452 Given an icon ref and a desired variant, this routine returns an icon
1453 ref (which may be the same as the input icon ref) and a transformation
1454 which should be used with PlotIconRef() to render the icon appropriately.
1455 The returned icon ref should be used to do hit-testing.
1456 }
1457
1458 {
1459 * GetIconRefVariant()
1460 *
1461 * Mac OS X threading:
1462 * Not thread safe
1463 *
1464 * Availability:
1465 * Mac OS X: in version 10.0 and later in ApplicationServices.framework
1466 * CarbonLib: in CarbonLib 1.0 and later
1467 * Non-Carbon CFM: in IconServicesLib 9.0 and later
1468 }
GetIconRefVariantnull1469 function GetIconRefVariant( inIconRef: IconRef; inVariant: OSType; var outTransform: IconTransformType ): IconRef; external name '_GetIconRefVariant';
1470 (* AVAILABLE_MAC_OS_X_VERSION_10_0_AND_LATER *)
1471
1472 {$endc} {TARGET_OS_MAC}
1473
1474 {$ifc not defined MACOSALLINCLUDE or not MACOSALLINCLUDE}
1475
1476 end.
1477 {$endc} {not MACOSALLINCLUDE}
1478