开通博客赚积分
发布资源赚积分
分类

源码开发语言/平台
当前位置：首页 > 源码/资料 > Windows编程 > 多媒体编程 > 查看源码
Icons.h
资源名称：fullMPCcode.rar　[点击查看]
上传用户：xjjlds
上传日期：2015-12-05
资源大小：22823k
文件大小：62k
源码类别：

多媒体编程

开发平台：

Visual C++

Icons.h：源码内容
  1. /*
  2.      File:       Icons.h
  3.  
  4.      Contains:   Icon Utilities and Icon Services Interfaces.
  5.  
  6.      Version:    Technology: Mac OS 8.5
  7.                  Release:    QuickTime 6.0.2
  8.  
  9.      Copyright:  (c) 1990-2001 by Apple Computer, Inc. All rights reserved
  10.  
  11.      Bugs?:      For bug reports, consult the following page on
  12.                  the World Wide Web:
  13.  
  14.                      http://developer.apple.com/bugreporter/
  15.  
  16. */
  17. #ifndef __ICONS__
  18. #define __ICONS__
  20. #ifndef __MACTYPES__
  21. #include "MacTypes.h"
  22. #endif
  24. #ifndef __QUICKDRAW__
  25. #include "Quickdraw.h"
  26. #endif
  28. #ifndef __FILES__
  29. #include "Files.h"
  30. #endif
  32. #ifndef __CODEFRAGMENTS__
  33. #include "CodeFragments.h"
  34. #endif
  39. #if PRAGMA_ONCE
  40. #pragma once
  41. #endif
  43. #ifdef __cplusplus
  44. extern "C" {
  45. #endif
  47. #if PRAGMA_IMPORT
  48. #pragma import on
  49. #endif
  51. #if PRAGMA_STRUCT_ALIGN
  52.     #pragma options align=mac68k
  53. #elif PRAGMA_STRUCT_PACKPUSH
  54.     #pragma pack(push, 2)
  55. #elif PRAGMA_STRUCT_PACK
  56.     #pragma pack(2)
  57. #endif
  59. /* The following are icons for which there are both icon suites and SICNs. */
  60. /* Avoid using icon resources if possible. Use IconServices instead. */
  61. enum {
  62.     kGenericDocumentIconResource = -4000,
  63.     kGenericStationeryIconResource = -3985,
  64.     kGenericEditionFileIconResource = -3989,
  65.     kGenericApplicationIconResource = -3996,
  66.     kGenericDeskAccessoryIconResource = -3991,
  67.     kGenericFolderIconResource  = -3999,
  68.     kPrivateFolderIconResource  = -3994,
  69.     kFloppyIconResource         = -3998,
  70.     kTrashIconResource          = -3993,
  71.     kGenericRAMDiskIconResource = -3988,
  72.     kGenericCDROMIconResource   = -3987
  73. };
  75. /* The following are icons for which there are SICNs only. */
  76. /* Avoid using icon resources if possible. Use IconServices instead. */
  77. enum {
  78.     kDesktopIconResource        = -3992,
  79.     kOpenFolderIconResource     = -3997,
  80.     kGenericHardDiskIconResource = -3995,
  81.     kGenericFileServerIconResource = -3972,
  82.     kGenericSuitcaseIconResource = -3970,
  83.     kGenericMoverObjectIconResource = -3969
  84. };
  86. /* The following are icons for which there are icon suites only. */
  87. /* Avoid using icon resources if possible. Use IconServices instead. */
  88. enum {
  89.     kGenericPreferencesIconResource = -3971,
  90.     kGenericQueryDocumentIconResource = -16506,
  91.     kGenericExtensionIconResource = -16415,
  92.     kSystemFolderIconResource   = -3983,
  93.     kHelpIconResource           = -20271,
  94.     kAppleMenuFolderIconResource = -3982
  95. };
  97. /* Obsolete. Use named constants defined above. */
  98. enum {
  99.     genericDocumentIconResource = kGenericDocumentIconResource,
  100.     genericStationeryIconResource = kGenericStationeryIconResource,
  101.     genericEditionFileIconResource = kGenericEditionFileIconResource,
  102.     genericApplicationIconResource = kGenericApplicationIconResource,
  103.     genericDeskAccessoryIconResource = kGenericDeskAccessoryIconResource,
  104.     genericFolderIconResource   = kGenericFolderIconResource,
  105.     privateFolderIconResource   = kPrivateFolderIconResource,
  106.     floppyIconResource          = kFloppyIconResource,
  107.     trashIconResource           = kTrashIconResource,
  108.     genericRAMDiskIconResource  = kGenericRAMDiskIconResource,
  109.     genericCDROMIconResource    = kGenericCDROMIconResource,
  110.     desktopIconResource         = kDesktopIconResource,
  111.     openFolderIconResource      = kOpenFolderIconResource,
  112.     genericHardDiskIconResource = kGenericHardDiskIconResource,
  113.     genericFileServerIconResource = kGenericFileServerIconResource,
  114.     genericSuitcaseIconResource = kGenericSuitcaseIconResource,
  115.     genericMoverObjectIconResource = kGenericMoverObjectIconResource,
  116.     genericPreferencesIconResource = kGenericPreferencesIconResource,
  117.     genericQueryDocumentIconResource = kGenericQueryDocumentIconResource,
  118.     genericExtensionIconResource = kGenericExtensionIconResource,
  119.     systemFolderIconResource    = kSystemFolderIconResource,
  120.     appleMenuFolderIconResource = kAppleMenuFolderIconResource
  121. };
  123. /* Avoid using icon resources if possible. Use IconServices instead. */
  124. enum {
  125.     kStartupFolderIconResource  = -3981,
  126.     kOwnedFolderIconResource    = -3980,
  127.     kDropFolderIconResource     = -3979,
  128.     kSharedFolderIconResource   = -3978,
  129.     kMountedFolderIconResource  = -3977,
  130.     kControlPanelFolderIconResource = -3976,
  131.     kPrintMonitorFolderIconResource = -3975,
  132.     kPreferencesFolderIconResource = -3974,
  133.     kExtensionsFolderIconResource = -3973,
  134.     kFontsFolderIconResource    = -3968,
  135.     kFullTrashIconResource      = -3984
  136. };
  138. /* Obsolete. Use named constants defined above. */
  139. enum {
  140.     startupFolderIconResource   = kStartupFolderIconResource,
  141.     ownedFolderIconResource     = kOwnedFolderIconResource,
  142.     dropFolderIconResource      = kDropFolderIconResource,
  143.     sharedFolderIconResource    = kSharedFolderIconResource,
  144.     mountedFolderIconResource   = kMountedFolderIconResource,
  145.     controlPanelFolderIconResource = kControlPanelFolderIconResource,
  146.     printMonitorFolderIconResource = kPrintMonitorFolderIconResource,
  147.     preferencesFolderIconResource = kPreferencesFolderIconResource,
  148.     extensionsFolderIconResource = kExtensionsFolderIconResource,
  149.     fontsFolderIconResource     = kFontsFolderIconResource,
  150.     fullTrashIconResource       = kFullTrashIconResource
  151. };
  153. /* The following icon types can only be used as an icon element */
  154. /* inside a 'icns' icon family */
  155. enum {
  156.     kThumbnail32BitData         = FOUR_CHAR_CODE('it32'),
  157.     kThumbnail8BitMask          = FOUR_CHAR_CODE('t8mk')
  158. };
  160. enum {
  161.     kHuge1BitMask               = FOUR_CHAR_CODE('ich#'),
  162.     kHuge4BitData               = FOUR_CHAR_CODE('ich4'),
  163.     kHuge8BitData               = FOUR_CHAR_CODE('ich8'),
  164.     kHuge32BitData              = FOUR_CHAR_CODE('ih32'),
  165.     kHuge8BitMask               = FOUR_CHAR_CODE('h8mk')
  166. };
  168. /* The following icon types can be used as a resource type */
  169. /* or as an icon element type inside a 'icns' icon family */
  170. enum {
  171.     kLarge1BitMask              = FOUR_CHAR_CODE('ICN#'),
  172.     kLarge4BitData              = FOUR_CHAR_CODE('icl4'),
  173.     kLarge8BitData              = FOUR_CHAR_CODE('icl8'),
  174.     kLarge32BitData             = FOUR_CHAR_CODE('il32'),
  175.     kLarge8BitMask              = FOUR_CHAR_CODE('l8mk'),
  176.     kSmall1BitMask              = FOUR_CHAR_CODE('ics#'),
  177.     kSmall4BitData              = FOUR_CHAR_CODE('ics4'),
  178.     kSmall8BitData              = FOUR_CHAR_CODE('ics8'),
  179.     kSmall32BitData             = FOUR_CHAR_CODE('is32'),
  180.     kSmall8BitMask              = FOUR_CHAR_CODE('s8mk'),
  181.     kMini1BitMask               = FOUR_CHAR_CODE('icm#'),
  182.     kMini4BitData               = FOUR_CHAR_CODE('icm4'),
  183.     kMini8BitData               = FOUR_CHAR_CODE('icm8')
  184. };
  186. /*  Icon Variants */
  187. /* These can be used as an element of an 'icns' icon family */
  188. /* or as a parameter to GetIconRefVariant */
  189. enum {
  190.     kTileIconVariant            = FOUR_CHAR_CODE('tile'),
  191.     kRolloverIconVariant        = FOUR_CHAR_CODE('over'),
  192.     kDropIconVariant            = FOUR_CHAR_CODE('drop'),
  193.     kOpenIconVariant            = FOUR_CHAR_CODE('open'),
  194.     kOpenDropIconVariant        = FOUR_CHAR_CODE('odrp')
  195. };
  197. /* Obsolete. Use names defined above. */
  198. enum {
  199.     large1BitMask               = kLarge1BitMask,
  200.     large4BitData               = kLarge4BitData,
  201.     large8BitData               = kLarge8BitData,
  202.     small1BitMask               = kSmall1BitMask,
  203.     small4BitData               = kSmall4BitData,
  204.     small8BitData               = kSmall8BitData,
  205.     mini1BitMask                = kMini1BitMask,
  206.     mini4BitData                = kMini4BitData,
  207.     mini8BitData                = kMini8BitData
  208. };
  210. /* Alignment type values. */
  211. enum {
  212.     kAlignNone                  = 0x00,
  213.     kAlignVerticalCenter        = 0x01,
  214.     kAlignTop                   = 0x02,
  215.     kAlignBottom                = 0x03,
  216.     kAlignHorizontalCenter      = 0x04,
  217.     kAlignAbsoluteCenter        = kAlignVerticalCenter | kAlignHorizontalCenter,
  218.     kAlignCenterTop             = kAlignTop | kAlignHorizontalCenter,
  219.     kAlignCenterBottom          = kAlignBottom | kAlignHorizontalCenter,
  220.     kAlignLeft                  = 0x08,
  221.     kAlignCenterLeft            = kAlignVerticalCenter | kAlignLeft,
  222.     kAlignTopLeft               = kAlignTop | kAlignLeft,
  223.     kAlignBottomLeft            = kAlignBottom | kAlignLeft,
  224.     kAlignRight                 = 0x0C,
  225.     kAlignCenterRight           = kAlignVerticalCenter | kAlignRight,
  226.     kAlignTopRight              = kAlignTop | kAlignRight,
  227.     kAlignBottomRight           = kAlignBottom | kAlignRight
  228. };
  230. /* Obsolete. Use names defined above. */
  231. enum {
  232.     atNone                      = kAlignNone,
  233.     atVerticalCenter            = kAlignVerticalCenter,
  234.     atTop                       = kAlignTop,
  235.     atBottom                    = kAlignBottom,
  236.     atHorizontalCenter          = kAlignHorizontalCenter,
  237.     atAbsoluteCenter            = kAlignAbsoluteCenter,
  238.     atCenterTop                 = kAlignCenterTop,
  239.     atCenterBottom              = kAlignCenterBottom,
  240.     atLeft                      = kAlignLeft,
  241.     atCenterLeft                = kAlignCenterLeft,
  242.     atTopLeft                   = kAlignTopLeft,
  243.     atBottomLeft                = kAlignBottomLeft,
  244.     atRight                     = kAlignRight,
  245.     atCenterRight               = kAlignCenterRight,
  246.     atTopRight                  = kAlignTopRight,
  247.     atBottomRight               = kAlignBottomRight
  248. };
  250. typedef SInt16                          IconAlignmentType;
  251. /* Transform type values. */
  252. enum {
  253.     kTransformNone              = 0x00,
  254.     kTransformDisabled          = 0x01,
  255.     kTransformOffline           = 0x02,
  256.     kTransformOpen              = 0x03,
  257.     kTransformLabel1            = 0x0100,
  258.     kTransformLabel2            = 0x0200,
  259.     kTransformLabel3            = 0x0300,
  260.     kTransformLabel4            = 0x0400,
  261.     kTransformLabel5            = 0x0500,
  262.     kTransformLabel6            = 0x0600,
  263.     kTransformLabel7            = 0x0700,
  264.     kTransformSelected          = 0x4000,
  265.     kTransformSelectedDisabled  = kTransformSelected | kTransformDisabled,
  266.     kTransformSelectedOffline   = kTransformSelected | kTransformOffline,
  267.     kTransformSelectedOpen      = kTransformSelected | kTransformOpen
  268. };
  270. /* Obsolete. Use names defined above. */
  271. enum {
  272.     ttNone                      = kTransformNone,
  273.     ttDisabled                  = kTransformDisabled,
  274.     ttOffline                   = kTransformOffline,
  275.     ttOpen                      = kTransformOpen,
  276.     ttLabel1                    = kTransformLabel1,
  277.     ttLabel2                    = kTransformLabel2,
  278.     ttLabel3                    = kTransformLabel3,
  279.     ttLabel4                    = kTransformLabel4,
  280.     ttLabel5                    = kTransformLabel5,
  281.     ttLabel6                    = kTransformLabel6,
  282.     ttLabel7                    = kTransformLabel7,
  283.     ttSelected                  = kTransformSelected,
  284.     ttSelectedDisabled          = kTransformSelectedDisabled,
  285.     ttSelectedOffline           = kTransformSelectedOffline,
  286.     ttSelectedOpen              = kTransformSelectedOpen
  287. };
  289. typedef SInt16                          IconTransformType;
  290. /* Selector mask values. */
  291. enum {
  292.     kSelectorLarge1Bit          = 0x00000001,
  293.     kSelectorLarge4Bit          = 0x00000002,
  294.     kSelectorLarge8Bit          = 0x00000004,
  295.     kSelectorLarge32Bit         = 0x00000008,
  296.     kSelectorLarge8BitMask      = 0x00000010,
  297.     kSelectorSmall1Bit          = 0x00000100,
  298.     kSelectorSmall4Bit          = 0x00000200,
  299.     kSelectorSmall8Bit          = 0x00000400,
  300.     kSelectorSmall32Bit         = 0x00000800,
  301.     kSelectorSmall8BitMask      = 0x00001000,
  302.     kSelectorMini1Bit           = 0x00010000,
  303.     kSelectorMini4Bit           = 0x00020000,
  304.     kSelectorMini8Bit           = 0x00040000,
  305.     kSelectorHuge1Bit           = 0x01000000,
  306.     kSelectorHuge4Bit           = 0x02000000,
  307.     kSelectorHuge8Bit           = 0x04000000,
  308.     kSelectorHuge32Bit          = 0x08000000,
  309.     kSelectorHuge8BitMask       = 0x10000000,
  310.     kSelectorAllLargeData       = 0x000000FF,
  311.     kSelectorAllSmallData       = 0x0000FF00,
  312.     kSelectorAllMiniData        = 0x00FF0000,
  313.     kSelectorAllHugeData        = (long)0xFF000000,
  314.     kSelectorAll1BitData        = kSelectorLarge1Bit | kSelectorSmall1Bit | kSelectorMini1Bit | kSelectorHuge1Bit,
  315.     kSelectorAll4BitData        = kSelectorLarge4Bit | kSelectorSmall4Bit | kSelectorMini4Bit | kSelectorHuge4Bit,
  316.     kSelectorAll8BitData        = kSelectorLarge8Bit | kSelectorSmall8Bit | kSelectorMini8Bit | kSelectorHuge8Bit,
  317.     kSelectorAll32BitData       = kSelectorLarge32Bit | kSelectorSmall32Bit | kSelectorHuge32Bit,
  318.     kSelectorAllAvailableData   = (long)0xFFFFFFFF
  319. };
  322. /* Obsolete. Use names defined above. */
  323. enum {
  324.     svLarge1Bit                 = kSelectorLarge1Bit,
  325.     svLarge4Bit                 = kSelectorLarge4Bit,
  326.     svLarge8Bit                 = kSelectorLarge8Bit,
  327.     svSmall1Bit                 = kSelectorSmall1Bit,
  328.     svSmall4Bit                 = kSelectorSmall4Bit,
  329.     svSmall8Bit                 = kSelectorSmall8Bit,
  330.     svMini1Bit                  = kSelectorMini1Bit,
  331.     svMini4Bit                  = kSelectorMini4Bit,
  332.     svMini8Bit                  = kSelectorMini8Bit,
  333.     svAllLargeData              = kSelectorAllLargeData,
  334.     svAllSmallData              = kSelectorAllSmallData,
  335.     svAllMiniData               = kSelectorAllMiniData,
  336.     svAll1BitData               = kSelectorAll1BitData,
  337.     svAll4BitData               = kSelectorAll4BitData,
  338.     svAll8BitData               = kSelectorAll8BitData,
  339.     svAllAvailableData          = kSelectorAllAvailableData
  340. };
  342. typedef UInt32                          IconSelectorValue;
  343. typedef CALLBACK_API( OSErr , IconActionProcPtr )(ResType theType, Handle *theIcon, void *yourDataPtr);
  344. typedef CALLBACK_API( Handle , IconGetterProcPtr )(ResType theType, void *yourDataPtr);
  345. typedef STACK_UPP_TYPE(IconActionProcPtr)                       IconActionUPP;
  346. typedef STACK_UPP_TYPE(IconGetterProcPtr)                       IconGetterUPP;
  347. #if OPAQUE_UPP_TYPES
  348.     EXTERN_API(IconActionUPP)
  349.     NewIconActionUPP               (IconActionProcPtr       userRoutine);
  351.     EXTERN_API(IconGetterUPP)
  352.     NewIconGetterUPP               (IconGetterProcPtr       userRoutine);
  354.     EXTERN_API(void)
  355.     DisposeIconActionUPP           (IconActionUPP           userUPP);
  357.     EXTERN_API(void)
  358.     DisposeIconGetterUPP           (IconGetterUPP           userUPP);
  360.     EXTERN_API(OSErr)
  361.     InvokeIconActionUPP            (ResType                 theType,
  362.                                     Handle *                theIcon,
  363.                                     void *                  yourDataPtr,
  364.                                     IconActionUPP           userUPP);
  366.     EXTERN_API(Handle)
  367.     InvokeIconGetterUPP            (ResType                 theType,
  368.                                     void *                  yourDataPtr,
  369.                                     IconGetterUPP           userUPP);
  371. #else
  372.     enum { uppIconActionProcInfo = 0x00000FE0 };                    /* pascal 2_bytes Func(4_bytes, 4_bytes, 4_bytes) */
  373.     enum { uppIconGetterProcInfo = 0x000003F0 };                    /* pascal 4_bytes Func(4_bytes, 4_bytes) */
  374.     #define NewIconActionUPP(userRoutine)                           (IconActionUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppIconActionProcInfo, GetCurrentArchitecture())
  375.     #define NewIconGetterUPP(userRoutine)                           (IconGetterUPP)NewRoutineDescriptor((ProcPtr)(userRoutine), uppIconGetterProcInfo, GetCurrentArchitecture())
  376.     #define DisposeIconActionUPP(userUPP)                           DisposeRoutineDescriptor(userUPP)
  377.     #define DisposeIconGetterUPP(userUPP)                           DisposeRoutineDescriptor(userUPP)
  378.     #define InvokeIconActionUPP(theType, theIcon, yourDataPtr, userUPP)  (OSErr)CALL_THREE_PARAMETER_UPP((userUPP), uppIconActionProcInfo, (theType), (theIcon), (yourDataPtr))
  379.     #define InvokeIconGetterUPP(theType, yourDataPtr, userUPP)      (Handle)CALL_TWO_PARAMETER_UPP((userUPP), uppIconGetterProcInfo, (theType), (yourDataPtr))
  380. #endif
  381. /* support for pre-Carbon UPP routines: NewXXXProc and CallXXXProc */
  382. #define NewIconActionProc(userRoutine)                          NewIconActionUPP(userRoutine)
  383. #define NewIconGetterProc(userRoutine)                          NewIconGetterUPP(userRoutine)
  384. #define CallIconActionProc(userRoutine, theType, theIcon, yourDataPtr) InvokeIconActionUPP(theType, theIcon, yourDataPtr, userRoutine)
  385. #define CallIconGetterProc(userRoutine, theType, yourDataPtr)   InvokeIconGetterUPP(theType, yourDataPtr, userRoutine)
  386. typedef IconGetterProcPtr               IconGetter;
  387. typedef IconActionProcPtr               IconAction;
  388. /* CIconHandle, GetCIcon(), PlotCIcon(), and DisposeCIcon() moved here from Quickdraw.h*/
  390. struct CIcon {
  391.     PixMap                          iconPMap;                   /*the icon's pixMap*/
  392.     BitMap                          iconMask;                   /*the icon's mask*/
  393.     BitMap                          iconBMap;                   /*the icon's bitMap*/
  394.     Handle                          iconData;                   /*the icon's data*/
  395.     SInt16                          iconMaskData[1];            /*icon's mask and BitMap data*/
  396. };
  397. typedef struct CIcon                    CIcon;
  398. typedef CIcon *                         CIconPtr;
  399. typedef CIconPtr *                      CIconHandle;
  400. EXTERN_API( CIconHandle )
  401. GetCIcon                        (SInt16                 iconID)                             ONEWORDINLINE(0xAA1E);
  403. EXTERN_API( void )
  404. PlotCIcon                       (const Rect *           theRect,
  405.                                  CIconHandle            theIcon)                            ONEWORDINLINE(0xAA1F);
  407. EXTERN_API( void )
  408. DisposeCIcon                    (CIconHandle            theIcon)                            ONEWORDINLINE(0xAA25);
  411. /* GetIcon and PlotIcon moved here from ToolUtils*/
  412. EXTERN_API( Handle )
  413. GetIcon                         (SInt16                 iconID)                             ONEWORDINLINE(0xA9BB);
  415. EXTERN_API( void )
  416. PlotIcon                        (const Rect *           theRect,
  417.                                  Handle                 theIcon)                            ONEWORDINLINE(0xA94B);
  421. /*
  422.     Note:   IconSuiteRef and IconCacheRef should be an abstract types, 
  423.             but too much source code already relies on them being of type Handle.
  424. */
  426. typedef Handle                          IconSuiteRef;
  427. typedef Handle                          IconCacheRef;
  428. /* IconRefs are 32-bit values identifying cached icon data. IconRef 0 is invalid.*/
  429. typedef struct OpaqueIconRef*           IconRef;
  430. EXTERN_API( OSErr )
  431. PlotIconID                      (const Rect *           theRect,
  432.                                  IconAlignmentType      align,
  433.                                  IconTransformType      transform,
  434.                                  SInt16                 theResID)                           THREEWORDINLINE(0x303C, 0x0500, 0xABC9);
  436. EXTERN_API( OSErr )
  437. NewIconSuite                    (IconSuiteRef *         theIconSuite)                       THREEWORDINLINE(0x303C, 0x0207, 0xABC9);
  439. EXTERN_API( OSErr )
  440. AddIconToSuite                  (Handle                 theIconData,
  441.                                  IconSuiteRef           theSuite,
  442.                                  ResType                theType)                            THREEWORDINLINE(0x303C, 0x0608, 0xABC9);
  444. EXTERN_API( OSErr )
  445. GetIconFromSuite                (Handle *               theIconData,
  446.                                  IconSuiteRef           theSuite,
  447.                                  ResType                theType)                            THREEWORDINLINE(0x303C, 0x0609, 0xABC9);
  449. EXTERN_API( OSErr )
  450. ForEachIconDo                   (IconSuiteRef           theSuite,
  451.                                  IconSelectorValue      selector,
  452.                                  IconActionUPP          action,
  453.                                  void *                 yourDataPtr)                        THREEWORDINLINE(0x303C, 0x080A, 0xABC9);
  455. EXTERN_API( OSErr )
  456. GetIconSuite                    (IconSuiteRef *         theIconSuite,
  457.                                  SInt16                 theResID,
  458.                                  IconSelectorValue      selector)                           THREEWORDINLINE(0x303C, 0x0501, 0xABC9);
  460. EXTERN_API( OSErr )
  461. DisposeIconSuite                (IconSuiteRef           theIconSuite,
  462.                                  Boolean                disposeData)                        THREEWORDINLINE(0x303C, 0x0302, 0xABC9);
  464. EXTERN_API( OSErr )
  465. PlotIconSuite                   (const Rect *           theRect,
  466.                                  IconAlignmentType      align,
  467.                                  IconTransformType      transform,
  468.                                  IconSuiteRef           theIconSuite)                       THREEWORDINLINE(0x303C, 0x0603, 0xABC9);
  470. EXTERN_API( OSErr )
  471. MakeIconCache                   (IconCacheRef *         theCache,
  472.                                  IconGetterUPP          makeIcon,
  473.                                  void *                 yourDataPtr)                        THREEWORDINLINE(0x303C, 0x0604, 0xABC9);
  475. EXTERN_API( OSErr )
  476. LoadIconCache                   (const Rect *           theRect,
  477.                                  IconAlignmentType      align,
  478.                                  IconTransformType      transform,
  479.                                  IconCacheRef           theIconCache)                       THREEWORDINLINE(0x303C, 0x0606, 0xABC9);
  481. EXTERN_API( OSErr )
  482. PlotIconMethod                  (const Rect *           theRect,
  483.                                  IconAlignmentType      align,
  484.                                  IconTransformType      transform,
  485.                                  IconGetterUPP          theMethod,
  486.                                  void *                 yourDataPtr)                        THREEWORDINLINE(0x303C, 0x0805, 0xABC9);
  488. EXTERN_API( OSErr )
  489. GetLabel                        (SInt16                 labelNumber,
  490.                                  RGBColor *             labelColor,
  491.                                  Str255                 labelString)                        THREEWORDINLINE(0x303C, 0x050B, 0xABC9);
  493. EXTERN_API( Boolean )
  494. PtInIconID                      (Point                  testPt,
  495.                                  const Rect *           iconRect,
  496.                                  IconAlignmentType      align,
  497.                                  SInt16                 iconID)                             THREEWORDINLINE(0x303C, 0x060D, 0xABC9);
  499. EXTERN_API( Boolean )
  500. PtInIconSuite                   (Point                  testPt,
  501.                                  const Rect *           iconRect,
  502.                                  IconAlignmentType      align,
  503.                                  IconSuiteRef           theIconSuite)                       THREEWORDINLINE(0x303C, 0x070E, 0xABC9);
  505. EXTERN_API( Boolean )
  506. PtInIconMethod                  (Point                  testPt,
  507.                                  const Rect *           iconRect,
  508.                                  IconAlignmentType      align,
  509.                                  IconGetterUPP          theMethod,
  510.                                  void *                 yourDataPtr)                        THREEWORDINLINE(0x303C, 0x090F, 0xABC9);
  512. EXTERN_API( Boolean )
  513. RectInIconID                    (const Rect *           testRect,
  514.                                  const Rect *           iconRect,
  515.                                  IconAlignmentType      align,
  516.                                  SInt16                 iconID)                             THREEWORDINLINE(0x303C, 0x0610, 0xABC9);
  518. EXTERN_API( Boolean )
  519. RectInIconSuite                 (const Rect *           testRect,
  520.                                  const Rect *           iconRect,
  521.                                  IconAlignmentType      align,
  522.                                  IconSuiteRef           theIconSuite)                       THREEWORDINLINE(0x303C, 0x0711, 0xABC9);
  524. EXTERN_API( Boolean )
  525. RectInIconMethod                (const Rect *           testRect,
  526.                                  const Rect *           iconRect,
  527.                                  IconAlignmentType      align,
  528.                                  IconGetterUPP          theMethod,
  529.                                  void *                 yourDataPtr)                        THREEWORDINLINE(0x303C, 0x0912, 0xABC9);
  531. EXTERN_API( OSErr )
  532. IconIDToRgn                     (RgnHandle              theRgn,
  533.                                  const Rect *           iconRect,
  534.                                  IconAlignmentType      align,
  535.                                  SInt16                 iconID)                             THREEWORDINLINE(0x303C, 0x0613, 0xABC9);
  537. EXTERN_API( OSErr )
  538. IconSuiteToRgn                  (RgnHandle              theRgn,
  539.                                  const Rect *           iconRect,
  540.                                  IconAlignmentType      align,
  541.                                  IconSuiteRef           theIconSuite)                       THREEWORDINLINE(0x303C, 0x0714, 0xABC9);
  543. EXTERN_API( OSErr )
  544. IconMethodToRgn                 (RgnHandle              theRgn,
  545.                                  const Rect *           iconRect,
  546.                                  IconAlignmentType      align,
  547.                                  IconGetterUPP          theMethod,
  548.                                  void *                 yourDataPtr)                        THREEWORDINLINE(0x303C, 0x0915, 0xABC9);
  550. EXTERN_API( OSErr )
  551. SetSuiteLabel                   (IconSuiteRef           theSuite,
  552.                                  SInt16                 theLabel)                           THREEWORDINLINE(0x303C, 0x0316, 0xABC9);
  554. EXTERN_API( SInt16 )
  555. GetSuiteLabel                   (IconSuiteRef           theSuite)                           THREEWORDINLINE(0x303C, 0x0217, 0xABC9);
  557. EXTERN_API( OSErr )
  558. GetIconCacheData                (IconCacheRef           theCache,
  559.                                  void **                theData)                            THREEWORDINLINE(0x303C, 0x0419, 0xABC9);
  561. EXTERN_API( OSErr )
  562. SetIconCacheData                (IconCacheRef           theCache,
  563.                                  void *                 theData)                            THREEWORDINLINE(0x303C, 0x041A, 0xABC9);
  565. EXTERN_API( OSErr )
  566. GetIconCacheProc                (IconCacheRef           theCache,
  567.                                  IconGetterUPP *        theProc)                            THREEWORDINLINE(0x303C, 0x041B, 0xABC9);
  569. EXTERN_API( OSErr )
  570. SetIconCacheProc                (IconCacheRef           theCache,
  571.                                  IconGetterUPP          theProc)                            THREEWORDINLINE(0x303C, 0x041C, 0xABC9);
  573. EXTERN_API( OSErr )
  574. PlotIconHandle                  (const Rect *           theRect,
  575.                                  IconAlignmentType      align,
  576.                                  IconTransformType      transform,
  577.                                  Handle                 theIcon)                            THREEWORDINLINE(0x303C, 0x061D, 0xABC9);
  579. EXTERN_API( OSErr )
  580. PlotSICNHandle                  (const Rect *           theRect,
  581.                                  IconAlignmentType      align,
  582.                                  IconTransformType      transform,
  583.                                  Handle                 theSICN)                            THREEWORDINLINE(0x303C, 0x061E, 0xABC9);
  585. EXTERN_API( OSErr )
  586. PlotCIconHandle                 (const Rect *           theRect,
  587.                                  IconAlignmentType      align,
  588.                                  IconTransformType      transform,
  589.                                  CIconHandle            theCIcon)                           THREEWORDINLINE(0x303C, 0x061F, 0xABC9);
  601. /*
  602.    IconServices is an efficient mechanism to share icon data amongst multiple 
  603.    clients. It avoids duplication of data; it provides efficient caching, 
  604.    releasing memory when the icon data is no longer needed; it can provide
  605.    the appropriate icon for any filesystem object; it can provide commonly 
  606.    used icons (caution, note, help...); it is Appearance-savvy: the icons
  607.    are switched when appropriate.
  608.    IconServices refer to cached icon data using IconRef, a 32-bit opaque
  609.    value. IconRefs are reference counted. When there are no more "owners" 
  610.    of an IconRef, the memory used by the icon bitmap is disposed of.
  611.    Two files of same type and creator with no custom icon will have the same IconRef.
  612.    Files with custom icons will have their own IconRef.
  613. */
  615. /*
  616.    Use the special creator kSystemIconsCreator to get "standard" icons 
  617.    that are not associated with a file, such as the help icon.
  618.    Note that all lowercase creators are reserved by Apple.
  619. */
  620. enum {
  621.     kSystemIconsCreator         = FOUR_CHAR_CODE('macs')
  622. };
  625. /*
  626.    Type of the predefined/generic icons. For example, the call:
  627.       err = GetIconRef(kOnSystemDisk, kSystemIconsCreator, kHelpIcon, &iconRef);
  628.    will retun in iconRef the IconRef for the standard help icon.
  629. */
  631. /* Generic Finder icons */
  632. enum {
  633.     kClipboardIcon              = FOUR_CHAR_CODE('CLIP'),
  634.     kClippingUnknownTypeIcon    = FOUR_CHAR_CODE('clpu'),
  635.     kClippingPictureTypeIcon    = FOUR_CHAR_CODE('clpp'),
  636.     kClippingTextTypeIcon       = FOUR_CHAR_CODE('clpt'),
  637.     kClippingSoundTypeIcon      = FOUR_CHAR_CODE('clps'),
  638.     kDesktopIcon                = FOUR_CHAR_CODE('desk'),
  639.     kFinderIcon                 = FOUR_CHAR_CODE('FNDR'),
  640.     kFontSuitcaseIcon           = FOUR_CHAR_CODE('FFIL'),
  641.     kFullTrashIcon              = FOUR_CHAR_CODE('ftrh'),
  642.     kGenericApplicationIcon     = FOUR_CHAR_CODE('APPL'),
  643.     kGenericCDROMIcon           = FOUR_CHAR_CODE('cddr'),
  644.     kGenericControlPanelIcon    = FOUR_CHAR_CODE('APPC'),
  645.     kGenericControlStripModuleIcon = FOUR_CHAR_CODE('sdev'),
  646.     kGenericComponentIcon       = FOUR_CHAR_CODE('thng'),
  647.     kGenericDeskAccessoryIcon   = FOUR_CHAR_CODE('APPD'),
  648.     kGenericDocumentIcon        = FOUR_CHAR_CODE('docu'),
  649.     kGenericEditionFileIcon     = FOUR_CHAR_CODE('edtf'),
  650.     kGenericExtensionIcon       = FOUR_CHAR_CODE('INIT'),
  651.     kGenericFileServerIcon      = FOUR_CHAR_CODE('srvr'),
  652.     kGenericFontIcon            = FOUR_CHAR_CODE('ffil'),
  653.     kGenericFontScalerIcon      = FOUR_CHAR_CODE('sclr'),
  654.     kGenericFloppyIcon          = FOUR_CHAR_CODE('flpy'),
  655.     kGenericHardDiskIcon        = FOUR_CHAR_CODE('hdsk'),
  656.     kGenericRemovableMediaIcon  = FOUR_CHAR_CODE('rmov'),
  657.     kGenericMoverObjectIcon     = FOUR_CHAR_CODE('movr'),
  658.     kGenericPCCardIcon          = FOUR_CHAR_CODE('pcmc'),
  659.     kGenericPreferencesIcon     = FOUR_CHAR_CODE('pref'),
  660.     kGenericQueryDocumentIcon   = FOUR_CHAR_CODE('qery'),
  661.     kGenericRAMDiskIcon         = FOUR_CHAR_CODE('ramd'),
  662.     kGenericSharedLibaryIcon    = FOUR_CHAR_CODE('shlb'),
  663.     kGenericStationeryIcon      = FOUR_CHAR_CODE('sdoc'),
  664.     kGenericSuitcaseIcon        = FOUR_CHAR_CODE('suit'),
  665.     kGenericWORMIcon            = FOUR_CHAR_CODE('worm'),
  666.     kInternationResourcesIcon   = FOUR_CHAR_CODE('ifil'),
  667.     kKeyboardLayoutIcon         = FOUR_CHAR_CODE('kfil'),
  668.     kSoundFileIcon              = FOUR_CHAR_CODE('sfil'),
  669.     kSystemSuitcaseIcon         = FOUR_CHAR_CODE('zsys'),
  670.     kTrashIcon                  = FOUR_CHAR_CODE('trsh'),
  671.     kTrueTypeFontIcon           = FOUR_CHAR_CODE('tfil'),
  672.     kTrueTypeFlatFontIcon       = FOUR_CHAR_CODE('sfnt'),
  673.     kTrueTypeMultiFlatFontIcon  = FOUR_CHAR_CODE('ttcf')
  674. };
  676. /* Internet locations */
  677. enum {
  678.     kInternetLocationHTTPIcon   = FOUR_CHAR_CODE('ilht'),
  679.     kInternetLocationFTPIcon    = FOUR_CHAR_CODE('ilft'),
  680.     kInternetLocationAppleShareIcon = FOUR_CHAR_CODE('ilaf'),
  681.     kInternetLocationAppleTalkZoneIcon = FOUR_CHAR_CODE('ilat'),
  682.     kInternetLocationFileIcon   = FOUR_CHAR_CODE('ilfi'),
  683.     kInternetLocationMailIcon   = FOUR_CHAR_CODE('ilma'),
  684.     kInternetLocationNewsIcon   = FOUR_CHAR_CODE('ilnw'),
  685.     kInternetLocationNSLNeighborhoodIcon = FOUR_CHAR_CODE('ilns'),
  686.     kInternetLocationGenericIcon = FOUR_CHAR_CODE('ilge')
  687. };
  689. /* Folders */
  690. enum {
  691.     kGenericFolderIcon          = FOUR_CHAR_CODE('fldr'),
  692.     kDropFolderIcon             = FOUR_CHAR_CODE('dbox'),
  693.     kMountedFolderIcon          = FOUR_CHAR_CODE('mntd'),
  694.     kOpenFolderIcon             = FOUR_CHAR_CODE('ofld'),
  695.     kOwnedFolderIcon            = FOUR_CHAR_CODE('ownd'),
  696.     kPrivateFolderIcon          = FOUR_CHAR_CODE('prvf'),
  697.     kSharedFolderIcon           = FOUR_CHAR_CODE('shfl')
  698. };
  700. /* Sharing Privileges icons */
  701. enum {
  702.     kSharingPrivsNotApplicableIcon = FOUR_CHAR_CODE('shna'),
  703.     kSharingPrivsReadOnlyIcon   = FOUR_CHAR_CODE('shro'),
  704.     kSharingPrivsReadWriteIcon  = FOUR_CHAR_CODE('shrw'),
  705.     kSharingPrivsUnknownIcon    = FOUR_CHAR_CODE('shuk'),
  706.     kSharingPrivsWritableIcon   = FOUR_CHAR_CODE('writ')
  707. };
  710. /* Users and Groups icons */
  711. enum {
  712.     kUserFolderIcon             = FOUR_CHAR_CODE('ufld'),
  713.     kWorkgroupFolderIcon        = FOUR_CHAR_CODE('wfld'),
  714.     kGuestUserIcon              = FOUR_CHAR_CODE('gusr'),
  715.     kUserIcon                   = FOUR_CHAR_CODE('user'),
  716.     kOwnerIcon                  = FOUR_CHAR_CODE('susr'),
  717.     kGroupIcon                  = FOUR_CHAR_CODE('grup')
  718. };
  720. /* Special folders */
  721. enum {
  722.     kAppleExtrasFolderIcon      = FOUR_CHAR_CODE('aex'),
  723.     kAppleMenuFolderIcon        = FOUR_CHAR_CODE('amnu'),
  724.     kApplicationsFolderIcon     = FOUR_CHAR_CODE('apps'),
  725.     kApplicationSupportFolderIcon = FOUR_CHAR_CODE('asup'),
  726.     kAssistantsFolderIcon       = FOUR_CHAR_CODE('ast'),
  727.     kContextualMenuItemsFolderIcon = FOUR_CHAR_CODE('cmnu'),
  728.     kControlPanelDisabledFolderIcon = FOUR_CHAR_CODE('ctrD'),
  729.     kControlPanelFolderIcon     = FOUR_CHAR_CODE('ctrl'),
  730.     kControlStripModulesFolderIcon = FOUR_CHAR_CODE('sdv'),
  731.     kDocumentsFolderIcon        = FOUR_CHAR_CODE('docs'),
  732.     kExtensionsDisabledFolderIcon = FOUR_CHAR_CODE('extD'),
  733.     kExtensionsFolderIcon       = FOUR_CHAR_CODE('extn'),
  734.     kFavoritesFolderIcon        = FOUR_CHAR_CODE('favs'),
  735.     kFontsFolderIcon            = FOUR_CHAR_CODE('font'),
  736.     kHelpFolderIcon             = FOUR_CHAR_CODE('膆lp'),
  737.     kInternetFolderIcon         = FOUR_CHAR_CODE('int'),
  738.     kInternetPlugInFolderIcon   = FOUR_CHAR_CODE('膎et'),
  739.     kLocalesFolderIcon          = FOUR_CHAR_CODE('膌oc'),
  740.     kMacOSReadMeFolderIcon      = FOUR_CHAR_CODE('mor'),
  741.     kPreferencesFolderIcon      = FOUR_CHAR_CODE('prf'),
  742.     kPrinterDescriptionFolderIcon = FOUR_CHAR_CODE('ppdf'),
  743.     kPrinterDriverFolderIcon    = FOUR_CHAR_CODE('膒rd'),
  744.     kPrintMonitorFolderIcon     = FOUR_CHAR_CODE('prnt'),
  745.     kRecentApplicationsFolderIcon = FOUR_CHAR_CODE('rapp'),
  746.     kRecentDocumentsFolderIcon  = FOUR_CHAR_CODE('rdoc'),
  747.     kRecentServersFolderIcon    = FOUR_CHAR_CODE('rsrv'),
  748.     kScriptingAdditionsFolderIcon = FOUR_CHAR_CODE('膕cr'),
  749.     kSharedLibrariesFolderIcon  = FOUR_CHAR_CODE('膌ib'),
  750.     kScriptsFolderIcon          = FOUR_CHAR_CODE('scr'),
  751.     kShutdownItemsDisabledFolderIcon = FOUR_CHAR_CODE('shdD'),
  752.     kShutdownItemsFolderIcon    = FOUR_CHAR_CODE('shdf'),
  753.     kSpeakableItemsFolder       = FOUR_CHAR_CODE('spki'),
  754.     kStartupItemsDisabledFolderIcon = FOUR_CHAR_CODE('strD'),
  755.     kStartupItemsFolderIcon     = FOUR_CHAR_CODE('strt'),
  756.     kSystemExtensionDisabledFolderIcon = FOUR_CHAR_CODE('macD'),
  757.     kSystemFolderIcon           = FOUR_CHAR_CODE('macs'),
  758.     kTextEncodingsFolderIcon    = FOUR_CHAR_CODE('膖ex'),
  759.     kAppearanceFolderIcon       = FOUR_CHAR_CODE('appr'),
  760.     kUtilitiesFolderIcon        = FOUR_CHAR_CODE('uti'),
  761.     kVoicesFolderIcon           = FOUR_CHAR_CODE('fvoc'),
  762.     kColorSyncFolderIcon        = FOUR_CHAR_CODE('prof'),
  763.     kInternetSearchSitesFolderIcon = FOUR_CHAR_CODE('issf'),
  764.     kUsersFolderIcon            = FOUR_CHAR_CODE('usr')
  765. };
  767. /* Badges */
  768. enum {
  769.     kAppleScriptBadgeIcon       = FOUR_CHAR_CODE('scrp'),
  770.     kLockedBadgeIcon            = FOUR_CHAR_CODE('lbdg'),
  771.     kMountedBadgeIcon           = FOUR_CHAR_CODE('mbdg'),
  772.     kSharedBadgeIcon            = FOUR_CHAR_CODE('sbdg'),
  773.     kAliasBadgeIcon             = FOUR_CHAR_CODE('abdg')
  774. };
  776. /* Alert icons */
  777. enum {
  778.     kAlertNoteIcon              = FOUR_CHAR_CODE('note'),
  779.     kAlertCautionIcon           = FOUR_CHAR_CODE('caut'),
  780.     kAlertStopIcon              = FOUR_CHAR_CODE('stop')
  781. };
  783. /* Networking icons */
  784. enum {
  785.     kAppleTalkIcon              = FOUR_CHAR_CODE('atlk'),
  786.     kAppleTalkZoneIcon          = FOUR_CHAR_CODE('atzn'),
  787.     kAFPServerIcon              = FOUR_CHAR_CODE('afps'),
  788.     kFTPServerIcon              = FOUR_CHAR_CODE('ftps'),
  789.     kHTTPServerIcon             = FOUR_CHAR_CODE('htps'),
  790.     kGenericNetworkIcon         = FOUR_CHAR_CODE('gnet'),
  791.     kIPFileServerIcon           = FOUR_CHAR_CODE('isrv')
  792. };
  794. /* Other icons */
  795. enum {
  796.     kAppleLogoIcon              = FOUR_CHAR_CODE('capl'),
  797.     kAppleMenuIcon              = FOUR_CHAR_CODE('sapl'),
  798.     kBackwardArrowIcon          = FOUR_CHAR_CODE('baro'),
  799.     kFavoriteItemsIcon          = FOUR_CHAR_CODE('favr'),
  800.     kForwardArrowIcon           = FOUR_CHAR_CODE('faro'),
  801.     kGridIcon                   = FOUR_CHAR_CODE('grid'),
  802.     kHelpIcon                   = FOUR_CHAR_CODE('help'),
  803.     kKeepArrangedIcon           = FOUR_CHAR_CODE('arng'),
  804.     kLockedIcon                 = FOUR_CHAR_CODE('lock'),
  805.     kNoFilesIcon                = FOUR_CHAR_CODE('nfil'),
  806.     kNoFolderIcon               = FOUR_CHAR_CODE('nfld'),
  807.     kNoWriteIcon                = FOUR_CHAR_CODE('nwrt'),
  808.     kProtectedApplicationFolderIcon = FOUR_CHAR_CODE('papp'),
  809.     kProtectedSystemFolderIcon  = FOUR_CHAR_CODE('psys'),
  810.     kRecentItemsIcon            = FOUR_CHAR_CODE('rcnt'),
  811.     kShortcutIcon               = FOUR_CHAR_CODE('shrt'),
  812.     kSortAscendingIcon          = FOUR_CHAR_CODE('asnd'),
  813.     kSortDescendingIcon         = FOUR_CHAR_CODE('dsnd'),
  814.     kUnlockedIcon               = FOUR_CHAR_CODE('ulck'),
  815.     kConnectToIcon              = FOUR_CHAR_CODE('cnct')
  816. };
  820. /*  IconServicesUsageFlags */
  821. typedef UInt32                          IconServicesUsageFlags;
  822. enum {
  823.     kIconServicesNormalUsageFlag = 0
  824. };
  827. /*
  828.     IconFamily 'icns' resources contain an entire IconFamily (all sizes and depths).  
  829.    For custom icons, icns IconFamily resources of the custom icon resource ID are fetched first before
  830.    the classic custom icons (individual 'ics#, ICN#, etc) are fetched.  If the fetch of the icns resource
  831.    succeeds then the icns is looked at exclusively for the icon data.
  832.    For custom icons, new icon features such as 32-bit deep icons are only fetched from the icns resource.
  833.    This is to avoid incompatibilities with cut & paste of new style icons with an older version of the
  834.    MacOS Finder.
  835.    DriverGestalt is called with code kdgMediaIconSuite by IconServices after calling FSM to determine a
  836.    driver icon for a particular device.  The result of the kdgMediaIconSuite call to DriverGestalt should
  837.    be a pointer an an IconFamily.  In this manner driver vendors can provide rich, detailed drive icons
  838.    instead of the 1-bit variety previously supported.
  839. */
  840. enum {
  841.     kIconFamilyType             = FOUR_CHAR_CODE('icns')
  842. };
  846. struct IconFamilyElement {
  847.     OSType                          elementType;                /* 'ICN#', 'icl8', etc...*/
  848.     Size                            elementSize;                /* Size of this element*/
  849.     unsigned char                   elementData[1];
  850. };
  851. typedef struct IconFamilyElement        IconFamilyElement;
  853. struct IconFamilyResource {
  854.     OSType                          resourceType;               /* Always 'icns'*/
  855.     Size                            resourceSize;               /* Total size of this resource*/
  856.     IconFamilyElement               elements[1];
  858. };
  859. typedef struct IconFamilyResource       IconFamilyResource;
  861. typedef IconFamilyResource *            IconFamilyPtr;
  862. typedef IconFamilyPtr *                 IconFamilyHandle;
  863. /*
  864.   ==============================================================================
  865.    Initialization and Termination
  866.   ==============================================================================
  867. */
  869. /*
  870.    IconServicesInit
  871.    
  872.    Call this routine once per classic 68K application initialization.
  873.    This routine does not need to be called at boot time.
  874. */
  876. #if CALL_NOT_IN_CARBON
  877. EXTERN_API( OSErr )
  878. IconServicesInit                (CFragInitBlockPtr      initBlockPtr)                       TWOWORDINLINE(0x7015, 0xAA75);
  881. /*
  882.    IconServicesTerminate:
  883.    
  884.    Call this routine once from the termination of a classic 68K application.
  885.    This routine does not need to be called at boot time.
  886. */
  888. EXTERN_API( void )
  889. IconServicesTerminate           (void)                                                      TWOWORDINLINE(0x7016, 0xAA75);
  891. #endif  /* CALL_NOT_IN_CARBON */
  893. /*
  894.   ==============================================================================
  895.    Converting data structures
  896.   ==============================================================================
  897. */
  900. /*
  901.    IconRefToIconFamily
  902.    This routines returns a new IconFamily that contains the data corresponding
  903.    to the specified IconRef.
  904. */
  906. EXTERN_API( OSErr )
  907. IconRefToIconFamily             (IconRef                theIconRef,
  908.                                  IconSelectorValue      whichIcons,
  909.                                  IconFamilyHandle *     iconFamily)                         TWOWORDINLINE(0x7024, 0xAA75);
  912. /*
  913.    IconFamilyToIconSuite
  914.    This routine transfers the data from an icon family handle into an icon suite.
  915. */
  917. EXTERN_API( OSErr )
  918. IconFamilyToIconSuite           (IconFamilyHandle       iconFamily,
  919.                                  IconSelectorValue      whichIcons,
  920.                                  IconSuiteRef *         iconSuite)                          TWOWORDINLINE(0x7025, 0xAA75);
  923. /*
  924.    IconSuiteToIconFamily
  925.    This routine transfers the data in an icon suite into an icon family.
  926. */
  928. EXTERN_API( OSErr )
  929. IconSuiteToIconFamily           (IconSuiteRef           iconSuite,
  930.                                  IconSelectorValue      whichIcons,
  931.                                  IconFamilyHandle *     iconFamily)                         TWOWORDINLINE(0x7026, 0xAA75);
  934. /*
  935.    SetIconFamilyData
  936.    Change the data of an icon family. The data is copied.
  937.    The type can be one of the icon type, or 'PICT'.
  938.    The data will be compressed if needed.
  939. */
  941. EXTERN_API( OSErr )
  942. SetIconFamilyData               (IconFamilyHandle       iconFamily,
  943.                                  OSType                 iconType,
  944.                                  Handle                 h)                                  TWOWORDINLINE(0x7030, 0xAA75);
  947. /*
  948.    GetIconFamilyData
  949.    Return a copy of the data in the icon family.
  950.    The type can be one of the icon type, or 'PICT'
  951.    The data will be returned uncompressed.
  952.    The handle (h) will be resized as appropriate. If no data of the 
  953.    requested type is present, the handle size will be set to 0.
  954. */
  956. EXTERN_API( OSErr )
  957. GetIconFamilyData               (IconFamilyHandle       iconFamily,
  958.                                  OSType                 iconType,
  959.                                  Handle                 h)                                  TWOWORDINLINE(0x7031, 0xAA75);
  962. /*
  963.   ==============================================================================
  964.    Reference counting
  965.   ==============================================================================
  966. */
  969. /*
  970.    GetIconRefOwners
  971.    
  972.    This routine returns the reference count for the IconRef, or number of owners.
  973.    
  974.    A valid IconRef always has at least one owner.
  975. */
  977. EXTERN_API( OSErr )
  978. GetIconRefOwners                (IconRef                theIconRef,
  979.                                  UInt16 *               owners)                             TWOWORDINLINE(0x700B, 0xAA75);
  982. /*
  983.    AcquireIconRef
  984.    This routine increments the reference count for the IconRef
  985. */
  987. EXTERN_API( OSErr )
  988. AcquireIconRef                  (IconRef                theIconRef)                         TWOWORDINLINE(0x7027, 0xAA75);
  992. /*
  993.    ReleaseIconRef
  994.    
  995.    This routine decrements the reference count for the IconRef.
  996.    
  997.    When the reference count reaches 0, all memory allocated for the icon
  998.    is disposed. Any subsequent use of the IconRef is invalid.
  999. */
  1001. EXTERN_API( OSErr )
  1002. ReleaseIconRef                  (IconRef                theIconRef)                         TWOWORDINLINE(0x7028, 0xAA75);
  1006. /*
  1007.   ==============================================================================
  1008.    Getting an IconRef
  1009.   ==============================================================================
  1010. */
  1013. /*
  1014.    GetIconRefFromFile
  1015.    
  1016.    This routine returns an icon ref for the specified file, folder or volume.
  1017.    The label information is provided separately, since two files with the same icon 
  1018.    but a different label would share the same iconRef. The label can be used in 
  1019.    PlotIconRef() for example.
  1020.    
  1021.    Use this routine if you have no information about the file system object. If 
  1022.    you have already done a GetCatInfo on the file and want to save some I/O, 
  1023.    call GetIconRefFromFolder() if you know it's a folder with no custom icon or 
  1024.    call GetIconRef() if it's a file with no custom icon.
  1025.    This routine increments the reference count of the returned IconRef. Call 
  1026.    ReleaseIconRef() when you're done with it.
  1027. */
  1029. EXTERN_API( OSErr )
  1030. GetIconRefFromFile              (const FSSpec *         theFile,
  1031.                                  IconRef *              theIconRef,
  1032.                                  SInt16 *               theLabel)                           TWOWORDINLINE(0x7002, 0xAA75);
  1036. /*
  1037.    GetIconRef
  1038.    
  1039.    This routine returns an icon ref for an icon in the desktop database or
  1040.    for a registered icon.
  1041.    The system registers a set of icon such as the help icon with the creator 
  1042.    code kSystemIconsCreator. See above for a list of the registered system types.
  1043.    The vRefNum is used as a hint on where to look for the icon first. Use 
  1044.    kOnSystemDisk if you don't know what to pass.
  1045.    This routine increments the reference count of the returned IconRef. Call 
  1046.    ReleaseIconRef() when you're done with it.
  1047. */
  1049. EXTERN_API( OSErr )
  1050. GetIconRef                      (SInt16                 vRefNum,
  1051.                                  OSType                 creator,
  1052.                                  OSType                 iconType,
  1053.                                  IconRef *              theIconRef)                         TWOWORDINLINE(0x7021, 0xAA75);
  1057. /*
  1058.    GetIconRefFromFolder
  1059.    
  1060.    This routine returns an icon ref for a folder with no custom icon.
  1061.    Use the more generic, but slightly slower, GetIconRefFromFile() if
  1062.    you don't already have the necessary info about the file.
  1063.    Attributes should be CInfoPBRec.dirInfo.ioFlAttrib for this folder.
  1064.    Access privileges should be CInfoPBRec.dirInfo.ioACUser for this folder.
  1065.    This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1066.    when you're done with it.
  1067. */
  1069. EXTERN_API( OSErr )
  1070. GetIconRefFromFolder            (SInt16                 vRefNum,
  1071.                                  SInt32                 parentFolderID,
  1072.                                  SInt32                 folderID,
  1073.                                  SInt8                  attributes,
  1074.                                  SInt8                  accessPrivileges,
  1075.                                  IconRef *              theIconRef)                         TWOWORDINLINE(0x7022, 0xAA75);
  1079. /*
  1080.   ==============================================================================
  1081.    Adding and modifying IconRef
  1082.   ==============================================================================
  1083. */
  1086. /*
  1087.    RegisterIconRefFromIconFamily
  1088.    This routine adds a new entry to the IconRef registry. Other clients will be 
  1089.    able to access it using the (creator, iconType) pair specified here.
  1090.    Lower-case creators are reserved for the system.
  1091.    Consider using RegisterIconRefFromResource() if possible, since the data 
  1092.    registered using RegisterIconRefFromFamily() cannot be purged.
  1093.    The iconFamily data is copied and the caller is reponsible for disposing of it.
  1094.    This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1095.    when you're done with it.
  1096. */
  1098. EXTERN_API( OSErr )
  1099. RegisterIconRefFromIconFamily   (OSType                 creator,
  1100.                                  OSType                 iconType,
  1101.                                  IconFamilyHandle       iconFamily,
  1102.                                  IconRef *              theIconRef)                         TWOWORDINLINE(0x701C, 0xAA75);
  1105. /*
  1106.    RegisterIconRefFromResource
  1107.    
  1108.    Registers an IconRef from a resouce file.  
  1109.    Lower-case creators are reserved for the system.
  1110.    The icon data to be fetched is either classic icon data or an icon family.  
  1111.    The 'icns' icon family is searched for before the classic icon data.
  1112.    This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1113.    when you're done with it.
  1114. */
  1116. EXTERN_API( OSErr )
  1117. RegisterIconRefFromResource     (OSType                 creator,
  1118.                                  OSType                 iconType,
  1119.                                  const FSSpec *         resourceFile,
  1120.                                  SInt16                 resourceID,
  1121.                                  IconRef *              theIconRef)                         TWOWORDINLINE(0x7023, 0xAA75);
  1124. /*
  1125.    UnregisterIconRef
  1126.    
  1127.    Removes the specified icon from the icon cache (if there are no users of it).  
  1128.    If some clients are using this iconRef, then the IconRef will be removed when the 
  1129.    last user calls ReleaseIconRef.
  1130. */
  1132. EXTERN_API( OSErr )
  1133. UnregisterIconRef               (OSType                 creator,
  1134.                                  OSType                 iconType)                           TWOWORDINLINE(0x7008, 0xAA75);
  1138. /*
  1139.    UpdateIconRef
  1140.    
  1141.    Call this routine to force an update of the data for iconRef.
  1142.    
  1143.    For example after changing an icon in the desktop database or changing the custom 
  1144.    icon of a file. Note that after _adding_ a custom icon to file or folder, you 
  1145.    need to call GetIconRefFromFile() to get a new IconRef specific to this file. 
  1146.    
  1147.    This routine does nothing if the IconRef is a registered icon.
  1148. */
  1150. EXTERN_API( OSErr )
  1151. UpdateIconRef                   (IconRef                theIconRef)                         TWOWORDINLINE(0x7009, 0xAA75);
  1155. /*
  1156.    OverrideIconRefFromResource
  1157.    
  1158.    This routines replaces the bitmaps of the specified IconRef with the ones
  1159.    in the specified resource file.
  1160. */
  1162. EXTERN_API( OSErr )
  1163. OverrideIconRefFromResource     (IconRef                theIconRef,
  1164.                                  const FSSpec *         resourceFile,
  1165.                                  SInt16                 resourceID)                         TWOWORDINLINE(0x702A, 0xAA75);
  1169. /*
  1170.    OverrideIconRef
  1171.    
  1172.    This routines replaces the bitmaps of the specified IconRef with the ones
  1173.    from the new IconRef.
  1174. */
  1176. EXTERN_API( OSErr )
  1177. OverrideIconRef                 (IconRef                oldIconRef,
  1178.                                  IconRef                newIconRef)                         TWOWORDINLINE(0x702B, 0xAA75);
  1181. /*
  1182.    RemoveIconRefOverride
  1183.    This routine remove an override if one was applied to the icon and 
  1184.    reverts back to the original bitmap data.
  1185. */
  1187. EXTERN_API( OSErr )
  1188. RemoveIconRefOverride           (IconRef                theIconRef)                         TWOWORDINLINE(0x701E, 0xAA75);
  1192. /*
  1193.   ==============================================================================
  1194.    Creating composite IconRef
  1195.   ==============================================================================
  1196. */
  1199. /*
  1200.    CompositeIconRef
  1201.    
  1202.    Superimposes an IconRef on top of another one
  1203. */
  1205. EXTERN_API( OSErr )
  1206. CompositeIconRef                (IconRef                backgroundIconRef,
  1207.                                  IconRef                foregroundIconRef,
  1208.                                  IconRef *              compositeIconRef)                   TWOWORDINLINE(0x7014, 0xAA75);
  1211. /*
  1212.    IsIconRefComposite
  1213.    Indicates if a given icon ref is a composite of two other icon refs (and which ones)
  1214.    If it isn't a composite, backgroundIconRef and foreGroundIconRef will be 0.
  1215. */
  1217. EXTERN_API( OSErr )
  1218. IsIconRefComposite              (IconRef                compositeIconRef,
  1219.                                  IconRef *              backgroundIconRef,
  1220.                                  IconRef *              foregroundIconRef)                  TWOWORDINLINE(0x701A, 0xAA75);
  1224. /*
  1225.   ==============================================================================
  1226.    Using IconRef
  1227.   ==============================================================================
  1228. */
  1230. /*
  1231.    IsValidIconRef
  1232.    Return true if the iconRef passed in is a valid icon ref
  1233. */
  1235. EXTERN_API( Boolean )
  1236. IsValidIconRef                  (IconRef                theIconRef)                         TWOWORDINLINE(0x7032, 0xAA75);
  1239. /*
  1240.    PlotIconRef
  1241.    
  1242.    This routine plots the IconRef.  It mostly takes the same parameters as 
  1243.    PlotIconSuite. Pass kIconServicesNormalUsageFlag as a default value for 
  1244.    IconServicesUsageFlags.
  1245. */
  1247. EXTERN_API( OSErr )
  1248. PlotIconRef                     (const Rect *           theRect,
  1249.                                  IconAlignmentType      align,
  1250.                                  IconTransformType      transform,
  1251.                                  IconServicesUsageFlags  theIconServicesUsageFlags,
  1252.                                  IconRef                theIconRef)                         TWOWORDINLINE(0x700E, 0xAA75);
  1255. /*
  1256.    PtInIconRef
  1257.    
  1258.    This routine indicates if testPt would hit the icon designated by iconRef.
  1259.    It mostly takes the same parameters as PtInIconSuite.
  1260.    Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1261. */
  1264. EXTERN_API( Boolean )
  1265. PtInIconRef                     (const Point *          testPt,
  1266.                                  const Rect *           iconRect,
  1267.                                  IconAlignmentType      align,
  1268.                                  IconServicesUsageFlags  theIconServicesUsageFlags,
  1269.                                  IconRef                theIconRef)                         TWOWORDINLINE(0x700F, 0xAA75);
  1272. /*
  1273.    RectInIconRef
  1274.    
  1275.    This routine indicates if testRect would intersect the icon designated by iconRef.
  1276.    It mostly takes the same parameters as RectInIconSuite.
  1277.    Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1278. */
  1281. EXTERN_API( Boolean )
  1282. RectInIconRef                   (const Rect *           testRect,
  1283.                                  const Rect *           iconRect,
  1284.                                  IconAlignmentType      align,
  1285.                                  IconServicesUsageFlags  iconServicesUsageFlags,
  1286.                                  IconRef                theIconRef)                         TWOWORDINLINE(0x7010, 0xAA75);
  1289. /*
  1290.    IconRefToRgn
  1291.    
  1292.    This routine returns a region for the icon.
  1293.    It mostly takes the same parameters as IconSuiteToRgn.
  1294.    Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1295. */
  1297. EXTERN_API( OSErr )
  1298. IconRefToRgn                    (RgnHandle              theRgn,
  1299.                                  const Rect *           iconRect,
  1300.                                  IconAlignmentType      align,
  1301.                                  IconServicesUsageFlags  iconServicesUsageFlags,
  1302.                                  IconRef                theIconRef)                         TWOWORDINLINE(0x7011, 0xAA75);
  1305. /*
  1306.    GetIconSizesFromIconRef
  1307.    
  1308.    This routine returns an IconSelectorValue indicating the depths and sizes of 
  1309.    icon data which are actually available.  It takes an IconSelectorValue 
  1310.    indicating which sizes/depths the caller is interested and returns an 
  1311.    IconSelectorValue indicating which sizes/depths exist.
  1312.    
  1313.    Caution:
  1314.    
  1315.    This is potentially an extremely expensive call as IconServices may be forced 
  1316.    to attempt fetching the data for the IconRef's sizes/depths which may result 
  1317.    in hitting the local disk or even the network to obtain the data to determine 
  1318.    which sizes/depths actually exist.
  1319.    Pass kIconServicesNormalUsageFlag as a default value for IconServicesUsageFlags.
  1320. */
  1322. EXTERN_API( OSErr )
  1323. GetIconSizesFromIconRef         (IconSelectorValue      iconSelectorInput,
  1324.                                  IconSelectorValue *    iconSelectorOutputPtr,
  1325.                                  IconServicesUsageFlags  iconServicesUsageFlags,
  1326.                                  IconRef                theIconRef)                         TWOWORDINLINE(0x7012, 0xAA75);
  1330. /*
  1331.   ==============================================================================
  1332.    Flushing IconRef data
  1333.   ==============================================================================
  1334. */
  1337. /*
  1338.    FlushIconRefs
  1339.    
  1340.    Making this call will dispose of all the data for the specified icons if 
  1341.    the data can be reacquired, for example if the data is provided from a resource.
  1342.    '****' is a wildcard for all types or all creators.
  1343. */
  1345. EXTERN_API( OSErr )
  1346. FlushIconRefs                   (OSType                 creator,
  1347.                                  OSType                 iconType)                           TWOWORDINLINE(0x7029, 0xAA75);
  1350. /*
  1351.    FlushIconRefsByVolume
  1352.    
  1353.    This routine disposes of the data for the icons related to the indicated volume
  1354.    if this data can be reacquired, for example if the data is provided from a 
  1355.    resource.
  1356. */
  1358. EXTERN_API( OSErr )
  1359. FlushIconRefsByVolume           (SInt16                 vRefNum)                            TWOWORDINLINE(0x7018, 0xAA75);
  1363. /*
  1364.   ==============================================================================
  1365.    Controling custom icons
  1366.   ==============================================================================
  1367. */
  1370. /*
  1371.    SetCustomIconsEnabled
  1372.    
  1373.    Enable or disable custom icons on the specified volume.
  1374. */
  1376. EXTERN_API( OSErr )
  1377. SetCustomIconsEnabled           (SInt16                 vRefNum,
  1378.                                  Boolean                enableCustomIcons)                  TWOWORDINLINE(0x701F, 0xAA75);
  1381. /*
  1382.    GetCustomIconsEnabled
  1383.    
  1384.    Return true if custom icons are enabled on the specified volume, false otherwise.
  1385. */
  1387. EXTERN_API( OSErr )
  1388. GetCustomIconsEnabled           (SInt16                 vRefNum,
  1389.                                  Boolean *              customIconsEnabled)                 TWOWORDINLINE(0x7020, 0xAA75);
  1392. /*
  1393.    IsIconRefMaskEmpty
  1394.    Returns true if the mask for this icon is blank
  1395. */
  1397. EXTERN_API( Boolean )
  1398. IsIconRefMaskEmpty              (IconRef                iconRef)                            TWOWORDINLINE(0x7033, 0xAA75);
  1401. /*
  1402.    GetIconRefVariant
  1403.    Icon variants allows different images to be used with different icon state.
  1404.    For example, the 'open' variant for a folder could be represented with
  1405.    an open folder.
  1406.    Given an icon ref and a desired variant, this routine returns an icon
  1407.    ref (which may be the same as the input icon ref) and a transformation 
  1408.    which should be used with PlotIconRef() to render the icon appropriately.
  1409.    The returned icon ref should be used to do hit-testing.
  1410. */
  1411. EXTERN_API( IconRef )
  1412. GetIconRefVariant               (IconRef                inIconRef,
  1413.                                  OSType                 inVariant,
  1414.                                  IconTransformType *    outTransform)                       TWOWORDINLINE(0x7034, 0xAA75);
  1418. /*
  1419.   ==============================================================================
  1420.    Icon files (.icns files)
  1421.   ==============================================================================
  1422. */
  1425. /*
  1426.    RegisterIconRefFromIconFile
  1427.    This routine adds a new entry to the IconRef registry. Other clients will be 
  1428.    able to access it using the (creator, iconType) pair specified here.
  1429.    Lower-case creators are reserved for the system.
  1430.    If the creator is kSystemIconsCreator and the iconType is 0, a new IconRef
  1431.    is always returned. Otherwise, if the creator and type have already been
  1432.    registered, the previously registered IconRef is returned.
  1433.    This routine increments the reference count of the IconRef. Call ReleaseIconRef() 
  1434.    when you're done with it.
  1435. */
  1437. EXTERN_API( OSErr )
  1438. RegisterIconRefFromIconFile     (OSType                 creator,
  1439.                                  OSType                 iconType,
  1440.                                  const FSSpec *         iconFile,
  1441.                                  IconRef *              theIconRef)                         TWOWORDINLINE(0x7035, 0xAA75);
  1444. /*
  1445.    ReadIconFile
  1446.    Read the specified icon file into the icon family handle.
  1447.    The caller is responsible for disposing the iconFamily
  1448. */
  1450. EXTERN_API( OSErr )
  1451. ReadIconFile                    (const FSSpec *         iconFile,
  1452.                                  IconFamilyHandle *     iconFamily)                         TWOWORDINLINE(0x7036, 0xAA75);
  1455. /*
  1456.    WriteIconFile
  1457.    Write the iconFamily handle to the specified file
  1458. */
  1460. EXTERN_API( OSErr )
  1461. WriteIconFile                   (IconFamilyHandle       iconFamily,
  1462.                                  const FSSpec *         iconFile)                           TWOWORDINLINE(0x7037, 0xAA75);
  1465. #if PRAGMA_STRUCT_ALIGN
  1466.     #pragma options align=reset
  1467. #elif PRAGMA_STRUCT_PACKPUSH
  1468.     #pragma pack(pop)
  1469. #elif PRAGMA_STRUCT_PACK
  1470.     #pragma pack()
  1471. #endif
  1473. #ifdef PRAGMA_IMPORT_OFF
  1474. #pragma import off
  1475. #elif PRAGMA_IMPORT
  1476. #pragma import reset
  1477. #endif
  1479. #ifdef __cplusplus
  1480. }
  1481. #endif
  1483. #endif /* __ICONS__ */