Overview

The Icon Utilities allow your application (and system software) to manipulate and draw icons of any standard resource type in windows and if necessary in menus or dialog boxes. You need to use these routines only if you wish to draw icons in your application’s windows or to draw icons whose resource types are not recognized by the Menu Manager and Dialog Manager in menus and dialog boxes.

To display an icon most effectively at a variety of sizes and bit depths, you should provide an icon family. You can then draw the appropriate member of the family for a given size and bit depth either by passing the family’s resource ID to an Icon Utilities routine or by reading the family’s icon resources into memory as an icon suite and passing the suite’s handle to Icon Utilities routines.

Icon Services provides icon data to multiple Mac OS clients, including the Finder, extensions and applications. Using Icon Services to obtain icon data means you can provide efficient icon caching and release memory when you don't need icon data any longer. Icon Services provides the appropriate icon for any file object (file, folder, or volume), as well as other commonly used icons such as caution, note, or help icons in alert boxes, for example. The icons provided by Icon Services support a much larger palette of colors: up to 24 bits per pixel and an eight-bit mask. Icons are Appearance-compliant and appropriate to the active theme.

Functions by Task

Converting an Icon Mask to a Region

• IconIDToRgn Deprecated in OS X v10.5
• IconMethodToRgn Deprecated in OS X v10.5
• IconSuiteToRgn Deprecated in OS X v10.5

Creating an Icon Suite

• AddIconToSuite Deprecated in OS X v10.5
• GetIconSuite Deprecated in OS X v10.5
• NewIconSuite Deprecated in OS X v10.5

Determining Whether a Point Is Within an Icon

• PtInIconID Deprecated in OS X v10.5
• PtInIconMethod Deprecated in OS X v10.5
• PtInIconSuite Deprecated in OS X v10.5

Determining Whether a Rectangle Intersects an Icon

• RectInIconID Deprecated in OS X v10.5
• RectInIconMethod Deprecated in OS X v10.5
• RectInIconSuite Deprecated in OS X v10.5

Disposing of Icon Suites

• DisposeIconSuite Deprecated in OS X v10.5

Disposing of Icons

• DisposeCIcon Deprecated in OS X v10.5

Drawing Icons From an Icon Suite

• PlotIconSuite Deprecated in OS X v10.5

Drawing Icons From Resources

• PlotCIcon Deprecated in OS X v10.5
• PlotCIconHandle Deprecated in OS X v10.5
• PlotIcon Deprecated in OS X v10.5
• PlotIconHandle Deprecated in OS X v10.5
• PlotIconID Deprecated in OS X v10.5
• PlotIconMethod Deprecated in OS X v10.5
• PlotSICNHandle Deprecated in OS X v10.5

Enabling and Disabling Custom Icons

• GetCustomIconsEnabled
• SetCustomIconsEnabled

Flushing IconRef Data

• FlushIconRefs Deprecated in OS X v10.3
• FlushIconRefsByVolume Deprecated in OS X v10.3

Getting and Setting the Label for an Icon Suite

• GetSuiteLabel Deprecated in OS X v10.5
• SetSuiteLabel Deprecated in OS X v10.5

Getting Label Information

• GetLabel Deprecated in OS X v10.5

Getting Icons From an Icon Suite

• GetIconFromSuite Deprecated in OS X v10.5

Getting Icons From Resources That Don’t Belong to an Icon Family

• GetCIcon Deprecated in OS X v10.5
• GetIcon Deprecated in OS X v10.5

IconRef Reference Counting

• AcquireIconRef
• GetIconRefOwners
• ReleaseIconRef

Modifying IconRef Data

• OverrideIconRef
• RemoveIconRefOverride
• UpdateIconRef
• OverrideIconRefFromResource Deprecated in OS X v10.5

Obtaining Icon Data

• IsDataAvailableInIconRef
• IsIconRefComposite
• IsIconRefMaskEmpty
• IsValidIconRef
• GetIconSizesFromIconRef Deprecated in OS X v10.3

Obtaining IconRef Values

• GetIconRef
• GetIconRefFromFolder
• GetIconRefFromFileInfo
• GetIconRefFromTypeInfo
• GetIconRefFromIconFamilyPtr
• GetIconRefFromComponent
• GetIconRefFromFile Deprecated in OS X v10.5

Performing Operations on Icons in an Icon Suite

• ForEachIconDo Deprecated in OS X v10.5

Reading, Copying, and Converting Icon Data

• GetIconFamilyData
• IconRefToIconFamily
• ReadIconFromFSRef
• SetIconFamilyData
• IconFamilyToIconSuite Deprecated in OS X v10.5
• IconSuiteToIconFamily Deprecated in OS X v10.5
• ReadIconFile Deprecated in OS X v10.5
• WriteIconFile Deprecated in OS X v10.5

Registering and Unregistering IconRef Values

• RegisterIconRefFromFSRef
• RegisterIconRefFromIconFamily
• UnregisterIconRef
• RegisterIconRefFromIconFile Deprecated in OS X v10.5
• RegisterIconRefFromResource Deprecated in OS X v10.5

Using IconRef Data

• CompositeIconRef
• GetIconRefVariant
• IconRefContainsCGPoint
• IconRefIntersectsCGRect
• IconRefToHIShape
• PlotIconRefInContext
• IconRefToRgn Deprecated in OS X v10.5
• PlotIconRef Deprecated in OS X v10.5
• PtInIconRef Deprecated in OS X v10.5
• RectInIconRef Deprecated in OS X v10.5

Working With Icon Caches

• GetIconCacheData Deprecated in OS X v10.5
• GetIconCacheProc Deprecated in OS X v10.5
• LoadIconCache Deprecated in OS X v10.5
• MakeIconCache Deprecated in OS X v10.5
• SetIconCacheData Deprecated in OS X v10.5
• SetIconCacheProc Deprecated in OS X v10.5

Creating and Managing Universal Procedure Pointers

• NewIconActionUPP
• NewIconGetterUPP
• DisposeIconActionUPP
• DisposeIconGetterUPP
• InvokeIconActionUPP
• InvokeIconGetterUPP

Functions

AcquireIconRef

Increments the reference count for an IconRef.

OSErr AcquireIconRef (
   IconRef theIconRef
);

CompositeIconRef

Superimposes one IconRef onto another.

OSErr CompositeIconRef (
   IconRef backgroundIconRef,
   IconRef foregroundIconRef,
   IconRef *compositeIconRef
);

DisposeIconActionUPP

Disposes of the universal procedure pointer (UPP) to your icon action callback function.

void DisposeIconActionUPP (
   IconActionUPP userUPP
);

DisposeIconGetterUPP

Disposes of the universal procedure pointer (UPP) to your icon getter callback function.

void DisposeIconGetterUPP (
   IconGetterUPP userUPP
);

GetCustomIconsEnabled

Determines whether custom icons are enabled or disabled on a specified volume.

OSErr GetCustomIconsEnabled (
   SInt16 vRefNum,
   Boolean *customIconsEnabled
);

GetIconFamilyData

Obtains a copy of the raw icon data for an individual element in an icon family.

OSErr GetIconFamilyData (
   IconFamilyHandle iconFamily,
   OSType iconType,
   Handle h
);

GetIconRef

Provides an IconRef object for an icon in the desktop database or for a registered icon.

OSErr GetIconRef (
   SInt16 vRefNum,
   OSType creator,
   OSType iconType,
   IconRef *theIconRef
);

GetIconRefFromComponent

Provides an IconRef object based on a specified component.

OSStatus GetIconRefFromComponent (
   Component inComponent,
   IconRef *outIconRef
);

GetIconRefFromFileInfo

Provides an IconRef object for a file with minimal file I/O.

OSStatus GetIconRefFromFileInfo (
   const FSRef *inRef,
   UniCharCount inFileNameLength,
   const UniChar *inFileName,
   FSCatalogInfoBitmap inWhichInfo,
   const FSCatalogInfo *inCatalogInfo,
   IconServicesUsageFlags inUsageFlags,
   IconRef *outIconRef,
   SInt16 *outLabel
);

GetIconRefFromFolder

Provides an IconRef object for a folder with no custom icon.

OSErr GetIconRefFromFolder (
   SInt16 vRefNum,
   SInt32 parentFolderID,
   SInt32 folderID,
   SInt8 attributes,
   SInt8 accessPrivileges,
   IconRef *theIconRef
);

GetIconRefFromIconFamilyPtr

Provides an IconRef object from a specified icon family.

OSStatus GetIconRefFromIconFamilyPtr (
   const IconFamilyResource *inIconFamilyPtr,
   Size inSize,
   IconRef *outIconRef
);

GetIconRefFromTypeInfo

Provides an IconRef object with the specified type information.

OSErr GetIconRefFromTypeInfo (
   OSType inCreator,
   OSType inType,
   CFStringRef inExtension,
   CFStringRef inMIMEType,
   IconServicesUsageFlags inUsageFlags,
   IconRef *outIconRef
);

GetIconRefOwners

Provides the current reference count for an IconRef.

OSErr GetIconRefOwners (
   IconRef theIconRef,
   UInt16 *owners
);

GetIconRefVariant

Specifies a transformation for a given IconRef.

IconRef GetIconRefVariant (
   IconRef inIconRef,
   OSType inVariant,
   IconTransformType *outTransform
);

IconRefContainsCGPoint

Returns a Boolean value indicating whether an icon contains a specified point.

Boolean IconRefContainsCGPoint (
   const CGPoint *testPt,
   const CGRect *iconRect,
   IconAlignmentType align,
   IconServicesUsageFlags iconServicesUsageFlags,
   IconRef theIconRef
);

IconRefIntersectsCGRect

Returns a Boolean value indicating whether an icon intersects a specified rectangle.

Boolean IconRefIntersectsCGRect (
   const CGRect *testRect,
   const CGRect *iconRect,
   IconAlignmentType align,
   IconServicesUsageFlags iconServicesUsageFlags,
   IconRef theIconRef
);

IconRefToHIShape

Converts an icon into an HIShape object.

HIShapeRef IconRefToHIShape (
   const CGRect *iconRect,
   IconAlignmentType align,
   IconServicesUsageFlags iconServicesUsageFlags,
   IconRef theIconRef
);

IconRefToIconFamily

Provides icon family data for a given IconRef.

OSErr IconRefToIconFamily (
   IconRef theIconRef,
   IconSelectorValue whichIcons,
   IconFamilyHandle *iconFamily
);

InvokeIconActionUPP

Calls your icon action callback function.

OSErr InvokeIconActionUPP (
   ResType theType,
   Handle *theIcon,
   void *yourDataPtr,
   IconActionUPP userUPP
);

InvokeIconGetterUPP

Calls your icon getter callback function.

Handle InvokeIconGetterUPP (
   ResType theType,
   void *yourDataPtr,
   IconGetterUPP userUPP
);

IsDataAvailableInIconRef

Indicates whether an IconRef has the specified data.

Boolean IsDataAvailableInIconRef (
   OSType inIconKind,
   IconRef inIconRef
);

IsIconRefComposite

Reports whether a specified IconRef has been composited.

OSErr IsIconRefComposite (
   IconRef compositeIconRef,
   IconRef *backgroundIconRef,
   IconRef *foregroundIconRef
);

IsIconRefMaskEmpty

Reports whether a specified mask is empty.

Boolean IsIconRefMaskEmpty (
   IconRef iconRef
);

IsValidIconRef

Reports whether a specified IconRef is valid.

Boolean IsValidIconRef (
   IconRef theIconRef
);

NewIconActionUPP

Creates a new universal procedure pointer (UPP) to an icon action callback function.

IconActionUPP NewIconActionUPP (
   IconActionProcPtr userRoutine
);

NewIconGetterUPP

Creates a new universal procedure pointer (UPP) to an icon getter callback function.

IconGetterUPP NewIconGetterUPP (
   IconGetterProcPtr userRoutine
);

OverrideIconRef

Replaces the bitmaps of one IconRef with those of another IconRef.

OSErr OverrideIconRef (
   IconRef oldIconRef,
   IconRef newIconRef
);

PlotIconRefInContext

Plots an IconRef using Quartz.

OSStatus PlotIconRefInContext (
   CGContextRef inContext,
   const CGRect *inRect,
   IconAlignmentType inAlign,
   IconTransformType inTransform,
   const RGBColor *inLabelColor,
   PlotIconRefFlags inFlags,
   IconRef inIconRef
);

ReadIconFromFSRef

Reads an icon ('icns') file into memory.

OSStatus ReadIconFromFSRef (
   const FSRef *ref,
   IconFamilyHandle *iconFamily
);

RegisterIconRefFromFSRef

Registers an IconRef from a .icns file and associates it with a creator and type pair.

OSStatus RegisterIconRefFromFSRef (
   OSType creator,
   OSType iconType,
   const FSRef *iconFile,
   IconRef *theIconRef
);

RegisterIconRefFromIconFamily

Adds an iconFamily-derived IconRef to the Icon Services registry.

OSErr RegisterIconRefFromIconFamily (
   OSType creator,
   OSType iconType,
   IconFamilyHandle iconFamily,
   IconRef *theIconRef
);

ReleaseIconRef

Decrements the reference count for an IconRef.

OSErr ReleaseIconRef (
   IconRef theIconRef
);

RemoveIconRefOverride

Restores the original bitmaps of an overridden IconRef.

OSErr RemoveIconRefOverride (
   IconRef theIconRef
);

SetCustomIconsEnabled

Enables or disables custom icons on a specified volume.

OSErr SetCustomIconsEnabled (
   SInt16 vRefNum,
   Boolean enableCustomIcons
);

SetIconFamilyData

Provides new raw icon data for an individual element of an icon family.

OSErr SetIconFamilyData (
   IconFamilyHandle iconFamily,
   OSType iconType,
   Handle h
);

UnregisterIconRef

Removes the specified icon data from the icon registry.

OSErr UnregisterIconRef (
   OSType creator,
   OSType iconType
);

UpdateIconRef

Forces an update of IconRef data.

OSErr UpdateIconRef (
   IconRef theIconRef
);

Callbacks

IconActionProcPtr

Defines a pointer to an icon action callback function, which performs an action on a single icon.

typedef OSErr (*IconActionProcPtr) (
   ResType theType,
   Handle *theIcon,
   void *yourDataPtr
);

If you name your function MyIconActionProc, you would declare it like this:

OSErr MyIconActionProc (
   ResType theType,
   Handle *theIcon,
   void *yourDataPtr
);

IconActionUPP MyIconActionUPP;

MyIconActionUPP = NewIconActionUPP(&MyIconActionProc)

IconGetterProcPtr

Defines a pointer to an icon getter callback function, which retrieves a handle to an icon of the requested type.

typedef Handle (*IconGetterProcPtr) (
   ResType theType,
   void *yourDataPtr
);

If you name your function MyIconGetterProc, you would declare it like this:

Handle MyIconGetterProc (
   ResType theType,
   void *yourDataPtr
);

IconGetterUPP MyIconGetterUPP;

MyIconGetterUPP = NewIconGetterUPP(&MyIconGetterProc)

Data Types

CIcon

Defines a color icon structure.

struct CIcon {
   PixMap iconPMap;
   BitMap iconMask;
   BitMap iconBMap;
   Handle iconData;
   SInt16 iconMaskData[1];
};
typedef struct CIcon CIcon;
   typedef CIcon * CIconPtr;

Fields

iconPMap

The pixel map describing the icon. Note that this is a pixel map record, not a handle to a pixel map record.

iconMask

A bitmap of the icon’s mask.

iconBMap

A bitmap of the icon.

iconData

A handle to the icon’s pixel image.

iconMaskData

An array containing the icon’s mask data followed by the icon’s bitmap data. This is used only when the icon is stored as a resource.

IconRef

Defines an icon reference.

typedef struct OpaqueIconRef * IconRef;

IconActionUPP

Defines a universal procedure pointer (UPP) to an icon action callback function.

typedef IconActionProcPtr IconActionUPP;

IconGetterUPP

Defines a universal procedure pointer to an icon getter callback function.

typedef IconGetterProcPtr IconGetterUPP;

IconCacheRef

Defines a reference to an icon cache.

typedef Handle IconCacheRef;

IconSuiteRef

Defines a reference to an icon suite.

typedef Handle IconSuiteRef;

Constants

Icon Alignment Constants

Define constants that allow you to specify how to align an icon within its rectangle.

enum {
   kAlignNone = 0x00,
   kAlignVerticalCenter = 0x01,
   kAlignTop = 0x02,
   kAlignBottom = 0x03,
   kAlignHorizontalCenter = 0x04,
   kAlignAbsoluteCenter = kAlignVerticalCenter | kAlignHorizontalCenter,
   kAlignCenterTop = kAlignTop | kAlignHorizontalCenter,
   kAlignCenterBottom = kAlignBottom | kAlignHorizontalCenter,
   kAlignLeft = 0x08,
   kAlignCenterLeft = kAlignVerticalCenter | kAlignLeft,
   kAlignTopLeft = kAlignTop | kAlignLeft,
   kAlignBottomLeft = kAlignBottom | kAlignLeft,
   kAlignRight = 0x0C,
   kAlignCenterRight = kAlignVerticalCenter | kAlignRight,
   kAlignTopRight = kAlignTop | kAlignRight,
   kAlignBottomRight = kAlignBottom | kAlignRight
};
typedef SInt16 IconAlignmentType;

Constants

kAlignNone

Use this value if you do not wish to specify a particular alignment.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignVerticalCenter

Use this value to center the icon vertically within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignTop

Use this value to top align the icon within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignBottom

Use this value to bottom align the icon within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignHorizontalCenter

Use this value to center the icon horizontally within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignAbsoluteCenter

Use this value to center the icon horizontally and vertically within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignCenterTop

Use this value to top align the icon and center it horizontally within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignCenterBottom

Use this value to bottom align the icon and center it horizontally within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignLeft

Use this value to left align the icon within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignCenterLeft

Use this value to left align the icon and center it vertically within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignTopLeft

Use this value to left and top align the icon within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignBottomLeft

Use this value to left and bottom align the icon within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignRight

Use this value to right align the icon within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignCenterRight

Use this value to right align the icon and center it vertically within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignTopRight

Use this value to right and top align the icon within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

kAlignBottomRight

Use this value to right and bottom align the icon within the rectangle.

Available in OS X v10.0 and later.

Declared in Icons.h.

Icon Transformation Constants

Define values that Icon Services uses to report how an icon has been transformed after you call the function GetIconRefVariant.

enum {
   kTransformNone = 0x00,
   kTransformDisabled = 0x01,
   kTransformOffline = 0x02,
   kTransformOpen = 0x03,
   kTransformLabel1 = 0x0100,
   kTransformLabel2 = 0x0200,
   kTransformLabel3 = 0x0300,
   kTransformLabel4 = 0x0400,
   kTransformLabel5 = 0x0500,
   kTransformLabel6 = 0x0600,
   kTransformLabel7 = 0x0700,
   kTransformSelected = 0x4000,
   kTransformSelectedDisabled = kTransformSelected | kTransformDisabled,
   kTransformSelectedOffline = kTransformSelected | kTransformOffline,
   kTransformSelectedOpen = kTransformSelected | kTransformOpen
};
typedef SInt16 IconTransformType;

Icon Selector Constants

Describe values that you can use to obtain information about the sizes and depths of icons available in a given icon family.

enum {
   kSelectorLarge1Bit = 0x00000001,
   kSelectorLarge4Bit = 0x00000002,
   kSelectorLarge8Bit = 0x00000004,
   kSelectorLarge32Bit = 0x00000008,
   kSelectorLarge8BitMask = 0x00000010,
   kSelectorSmall1Bit = 0x00000100,
   kSelectorSmall4Bit = 0x00000200,
   kSelectorSmall8Bit = 0x00000400,
   kSelectorSmall32Bit = 0x00000800,
   kSelectorSmall8BitMask = 0x00001000,
   kSelectorMini1Bit = 0x00010000,
   kSelectorMini4Bit = 0x00020000,
   kSelectorMini8Bit = 0x00040000,
   kSelectorHuge1Bit = 0x01000000,
   kSelectorHuge4Bit = 0x02000000,
   kSelectorHuge8Bit = 0x04000000,
   kSelectorHuge32Bit = 0x08000000,
   kSelectorHuge8BitMask = 0x10000000,
   kSelectorAllLargeData = 0x000000FF,
   kSelectorAllSmallData = 0x0000FF00,
   kSelectorAllMiniData = 0x00FF0000,
   kSelectorAllHugeData = 0xFF000000,
   kSelectorAll1BitData = kSelectorLarge1Bit | kSelectorSmall1Bit
| kSelectorMini1Bit | kSelectorHuge1Bit,
   kSelectorAll4BitData = kSelectorLarge4Bit | kSelectorSmall4Bit
| kSelectorMini4Bit | kSelectorHuge4Bit,
   kSelectorAll8BitData = kSelectorLarge8Bit | kSelectorSmall8Bit
| kSelectorMini8Bit | kSelectorHuge8Bit,
   kSelectorAll32BitData = kSelectorLarge32Bit | kSelectorSmall32Bit
| kSelectorHuge32Bit,
   kSelectorAllAvailableData = 0xFFFFFFFF
};
typedef UInt32 IconSelectorValue;

Constants

kSelectorLarge1Bit

Specify to include 'ICN#' resource.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorLarge4Bit

Specify to include 'icl4' resource.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorLarge8Bit

Specify to include 'icl8' resource.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorLarge32Bit

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorLarge8BitMask

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorSmall1Bit

Specify to include 'ics#' resource.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorSmall4Bit

Specify to include 'ics4' resource.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorSmall8Bit

Specify to include 'ics8' resource.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorSmall32Bit

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorSmall8BitMask

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorMini1Bit

Specify to include 'icm#' resource.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorMini4Bit

Specify to include 'icm4' resource.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorMini8Bit

Specify to include 'icm8' resource.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorHuge1Bit

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorHuge4Bit

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorHuge8Bit

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorHuge32Bit

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorHuge8BitMask

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorAllLargeData

Specify to include 'ICN#', 'icl4', and 'icl8' resources.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorAllSmallData

Specify to include 'ics#', 'ics4', and 'ics8' resources.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorAllMiniData

Specify to include 'icm#', 'icm4', and 'icm8' resources.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorAllHugeData

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorAll1BitData

Specify to include 'ICN#', 'ics#', and 'icm#' resources.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorAll4BitData

Specify to include 'icl4', 'ics4', and 'icm4' resources.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorAll8BitData

Specify to include 'icl8', 'ics8', and 'icm8' resources.

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorAll32BitData

Available in OS X v10.0 and later.

Declared in Icons.h.

kSelectorAllAvailableData

Specify to include all resources of given ID.

Available in OS X v10.0 and later.

Declared in Icons.h.

Catalog Information Bitmask

Defines a minimal bitmask for use with the GetIconRefFromFileInfo function.

enum {
   kIconServicesCatalogInfoMask =
   (kFSCatInfoNodeID | kFSCatInfoParentDirID | kFSCatInfoVolume
   | kFSCatInfoNodeFlags | kFSCatInfoFinderInfo |
   kFSCatInfoFinderXInfo | kFSCatInfoUserAccess)
};

Constants

kIconServicesCatalogInfoMask

Use this mask with the File Manager function FSGetCatalogInfo before calling GetIconRefFromFileInfo.

Available in OS X v10.1 and later.

Declared in IconsCore.h.

System Icon Constant

Defines a creator type for all system–defined icons.

enum {
   kSystemIconsCreator = 'macs'
};

Icon Services Usage Flag

typedef UInt32 IconServicesUsageFlags;
enum {
   kIconServicesNormalUsageFlag = 0
};

Alert Icon Constants

Specify standard alert icons.

enum {
   kAlertNoteIcon = 'note',
   kAlertCautionIcon = 'caut',
   kAlertStopIcon = 'stop'
};

Filesharing Privilege Icon Constants

Identify standard filesharing privilege icons.

enum {
   kSharingPrivsNotApplicableIcon = 'shna',
   kSharingPrivsReadOnlyIcon = 'shro',
   kSharingPrivsReadWriteIcon = 'shrw',
   kSharingPrivsUnknownIcon = 'shuk',
   kSharingPrivsWritableIcon = 'writ'
};

Folder Icon Constants

Identify standard folder icons.

enum {
   kGenericFolderIcon = 'fldr',
   kDropFolderIcon = 'dbox',
   kMountedFolderIcon = 'mntd',
   kOpenFolderIcon = 'ofld',
   kOwnedFolderIcon = 'ownd',
   kPrivateFolderIcon = 'prvf',
   kSharedFolderIcon = 'shfl'
};

Internet Icon Constants

Identify standard Internet icons.

enum {
   kInternetLocationHTTPIcon = 'ilht',
   kInternetLocationFTPIcon = 'ilft',
   kInternetLocationAppleShareIcon = 'ilaf',
   kInternetLocationAppleTalkZoneIcon = 'ilat',
   kInternetLocationFileIcon = 'ilfi',
   kInternetLocationMailIcon = 'ilma',
   kInternetLocationNewsIcon = 'ilnw',
   kInternetLocationNSLNeighborhoodIcon = 'ilns',
   kInternetLocationGenericIcon = 'ilge'
};

Toolbar Icons

Identify standard toolbar icons.

enum {
   kToolbarCustomizeIcon = 'tcus',
   kToolbarDeleteIcon = 'tdel',
   kToolbarFavoritesIcon = 'tfav',
   kToolbarHomeIcon = 'thom'
};

Miscellaneous Icon Constants

Identify miscellaneous icons.

enum {
   kAppleLogoIcon = 'capl',
   kAppleMenuIcon = 'sapl',
   kBackwardArrowIcon = 'baro',
   kFavoriteItemsIcon = 'favr',
   kForwardArrowIcon = 'faro',
   kGridIcon = 'grid',
   kHelpIcon = 'help',
   kKeepArrangedIcon = 'arng',
   kLockedIcon = 'lock',
   kNoFilesIcon = 'nfil',
   kNoFolderIcon = 'nfld',
   kNoWriteIcon = 'nwrt',
   kProtectedApplicationFolderIcon = 'papp',
   kProtectedSystemFolderIcon = 'psys',
   kRecentItemsIcon = 'rcnt',
   kShortcutIcon = 'shrt',
   kSortAscendingIcon = 'asnd',
   kSortDescendingIcon = 'dsnd',
   kUnlockedIcon = 'ulck',
   kConnectToIcon = 'cnct',
   kGenericWindowIcon = 'gwin',
   kQuestionMarkIcon = 'ques',
   kDeleteAliasIcon = 'dali',
   kEjectMediaIcon = 'ejec',
   kBurningIcon = 'burn',
   kRightContainerArrowIcon = 'rcar'
};

Networking Icon Constants

Identify standard networking icons.

enum {
   kAppleTalkIcon = 'atlk',
   kAppleTalkZoneIcon = 'atzn',
   kAFPServerIcon = 'afps',
   kFTPServerIcon = 'ftps',
   kHTTPServerIcon = 'htps',
   kGenericNetworkIcon = 'gnet',
   kIPFileServerIcon = 'isrv'
};

Special Folder Icon Constants

Identify special folder icons.

enum {
   kAppearanceFolderIcon = 'appr',
   kAppleExtrasFolderIcon = 'aexƒ',
   kAppleMenuFolderIcon = 'amnu',
   kApplicationsFolderIcon = 'apps',
   kApplicationSupportFolderIcon = 'asup',
   kAssistantsFolderIcon = 'astƒ',
   kColorSyncFolderIcon = 'prof',
   kContextualMenuItemsFolderIcon = 'cmnu',
   kControlPanelDisabledFolderIcon = 'ctrD',
   kControlPanelFolderIcon = 'ctrl',
   kControlStripModulesFolderIcon = 'sdvƒ',
   kDocumentsFolderIcon = 'docs',
   kExtensionsDisabledFolderIcon = 'extD',
   kExtensionsFolderIcon = 'extn',
   kFavoritesFolderIcon = 'favs',
   kFontsFolderIcon = 'font',
   kHelpFolderIcon = 'ƒhlp',
   kInternetFolderIcon = 'intƒ',
   kInternetPlugInFolderIcon = 'ƒnet',
   kInternetSearchSitesFolderIcon = 'issf',
   kLocalesFolderIcon = 'ƒloc',
   kMacOSReadMeFolderIcon = 'morƒ',
   kPublicFolderIcon = 'pubf',
   kPreferencesFolderIcon = 'prfƒ',
   kPrinterDescriptionFolderIcon = 'ppdf',
   kPrinterDriverFolderIcon = 'ƒprd',
   kPrintMonitorFolderIcon = 'prnt',
   kRecentApplicationsFolderIcon = 'rapp',
   kRecentDocumentsFolderIcon = 'rdoc',
   kRecentServersFolderIcon = 'rsrv',
   kScriptingAdditionsFolderIcon = 'ƒscr',
   kSharedLibrariesFolderIcon = 'ƒlib',
   kScriptsFolderIcon = 'scrƒ',
   kShutdownItemsDisabledFolderIcon = 'shdD',
   kShutdownItemsFolderIcon = 'shdf',
   kSpeakableItemsFolder = 'spki',
   kStartupItemsDisabledFolderIcon = 'strD',
   kStartupItemsFolderIcon = 'strt',
   kSystemExtensionDisabledFolderIcon = 'macD',
   kSystemFolderIcon = 'macs',
   kTextEncodingsFolderIcon = 'ƒtex',
   kUsersFolderIcon = 'usrƒ',
   kUtilitiesFolderIcon = 'utiƒ',
   kVoicesFolderIcon = 'fvoc'
};

Standard Finder Icon Constants

Identify standard Finder icons.

enum {
   kClipboardIcon = 'CLIP',
   kClippingUnknownTypeIcon = 'clpu',
   kClippingPictureTypeIcon = 'clpp',
   kClippingTextTypeIcon = 'clpt',
   kClippingSoundTypeIcon = 'clps',
   kDesktopIcon = 'desk',
   kFinderIcon = 'FNDR',
   kFontSuitcaseIcon = 'FFIL',
   kFullTrashIcon = 'ftrh',
   kGenericApplicationIcon = 'APPL',
   kGenericCDROMIcon = 'cddr',
   kGenericControlPanelIcon = 'APPC',
   kGenericControlStripModuleIcon = 'sdev',
   kGenericComponentIcon = 'thng',
   kGenericDeskAccessoryIcon = 'APPD',
   kGenericDocumentIcon = 'docu',
   kGenericEditionFileIcon = 'edtf',
   kGenericExtensionIcon = 'INIT',
   kGenericFileServerIcon = 'srvr',
   kGenericFontIcon = 'ffil',
   kGenericFontScalerIcon = 'sclr',
   kGenericFloppyIcon = 'flpy',
   kGenericHardDiskIcon = 'hdsk',
   kGenericIDiskIcon = 'idsk',
   kGenericRemovableMediaIcon = 'rmov',
   kGenericMoverObjectIcon = 'movr',
   kGenericPCCardIcon = 'pcmc',
   kGenericPreferencesIcon = 'pref',
   kGenericQueryDocumentIcon = 'qery',
   kGenericRAMDiskIcon = 'ramd',
   kGenericSharedLibaryIcon = 'shlb',
   kGenericStationeryIcon = 'sdoc',
   kGenericSuitcaseIcon = 'suit',
   kGenericURLIcon = 'gurl',
   kGenericWORMIcon = 'worm',
   kInternationalResourcesIcon = 'ifil',
   kKeyboardLayoutIcon = 'kfil',
   kSoundFileIcon = 'sfil',
   kSystemSuitcaseIcon = 'zsys',
   kTrashIcon = 'trsh',
   kTrueTypeFontIcon = 'tfil',
   kTrueTypeFlatFontIcon = 'sfnt',
   kTrueTypeMultiFlatFontIcon = 'ttcf',
   kUserIDiskIcon = 'udsk',
   kUnknownFSObjectIcon = 'unfs',
   kInternationResourcesIcon = kInternationalResourcesIcon
};

Standard Icon Badge Constants

Identify standard badges.

enum {
   kAppleScriptBadgeIcon = 'scrp',
   kLockedBadgeIcon = 'lbdg',
   kMountedBadgeIcon = 'mbdg',
   kSharedBadgeIcon = 'sbdg',
   kAliasBadgeIcon = 'abdg',
   kAlertCautionBadgeIcon = 'cbdg'
};

Users and Groups Icon Constants

Identify icons used in the Users and Groups control panel.

enum {
   kUserFolderIcon = 'ufld',
   kWorkgroupFolderIcon = 'wfld',
   kGuestUserIcon = 'gusr',
   kUserIcon = 'user',
   kOwnerIcon = 'susr',
   kGroupIcon = 'grup'
};

genericDocumentIconResource

Use the constants listed in "Standard Icon Resources" instead.

enum {
   genericDocumentIconResource = kGenericDocumentIconResource,
   genericStationeryIconResource = kGenericStationeryIconResource,
   genericEditionFileIconResource = kGenericEditionFileIconResource,
   genericApplicationIconResource = kGenericApplicationIconResource,
   genericDeskAccessoryIconResource = kGenericDeskAccessoryIconResource,
   genericFolderIconResource = kGenericFolderIconResource,
   privateFolderIconResource = kPrivateFolderIconResource,
   floppyIconResource = kFloppyIconResource,
   trashIconResource = kTrashIconResource,
   genericRAMDiskIconResource = kGenericRAMDiskIconResource,
   genericCDROMIconResource = kGenericCDROMIconResource,
   desktopIconResource = kDesktopIconResource,
   openFolderIconResource = kOpenFolderIconResource,
   genericHardDiskIconResource = kGenericHardDiskIconResource,
   genericFileServerIconResource = kGenericFileServerIconResource,
   genericSuitcaseIconResource = kGenericSuitcaseIconResource,
   genericMoverObjectIconResource = kGenericMoverObjectIconResource,
   genericPreferencesIconResource = kGenericPreferencesIconResource,
   genericQueryDocumentIconResource = kGenericQueryDocumentIconResource,
   genericExtensionIconResource = kGenericExtensionIconResource,
   systemFolderIconResource = kSystemFolderIconResource,
   appleMenuFolderIconResource = kAppleMenuFolderIconResource
};

Standard Icon Resources

Identify standard icon resources.

/*Icons for which both icon suites and 'SICN' resources exist*/
enum {
   kGenericDocumentIconResource = -4000,
   kGenericStationeryIconResource = -3985,
   kGenericEditionFileIconResource = -3989,
   kGenericApplicationIconResource = -3996,
   kGenericDeskAccessoryIconResource = -3991,
   kGenericFolderIconResource = -3999,
   kPrivateFolderIconResource = -3994,
   kFloppyIconResource = -3998,
   kTrashIconResource = -3993,
   kGenericRAMDiskIconResource = -3988,
   kGenericCDROMIconResource = -3987
};
/* Icons for which only 'SICN' resources exist*/
enum {
   kDesktopIconResource = -3992,
   kOpenFolderIconResource = -3997,
   kGenericHardDiskIconResource = -3995,
   kGenericFileServerIconResource = -3972,
   kGenericSuitcaseIconResource = -3970,
   kGenericMoverObjectIconResource = -3969
};
/*Icons for which only icon suites exist*/
enum {
   kGenericPreferencesIconResource = -3971,
   kGenericQueryDocumentIconResource = -16506,
   kGenericExtensionIconResource = -16415,
   kSystemFolderIconResource = -3983,
   kHelpIconResource = -20271,
   kAppleMenuFolderIconResource = -3982
};
enum {
   kStartupFolderIconResource = -3981,
   kOwnedFolderIconResource = -3980,
   kDropFolderIconResource = -3979,
   kSharedFolderIconResource = -3978,
   kMountedFolderIconResource = -3977,
   kControlPanelFolderIconResource = -3976,
   kPrintMonitorFolderIconResource = -3975,
   kPreferencesFolderIconResource = -3974,
   kExtensionsFolderIconResource = -3973,
   kFontsFolderIconResource = -3968,
   kFullTrashIconResource = -3984
};

startupFolderIconResource

Use the constants described in "Standard Icon Resources" instead.

enum {
   startupFolderIconResource = kStartupFolderIconResource,
   ownedFolderIconResource = kOwnedFolderIconResource,
   dropFolderIconResource = kDropFolderIconResource,
   sharedFolderIconResource = kSharedFolderIconResource,
   mountedFolderIconResource = kMountedFolderIconResource,
   controlPanelFolderIconResource = kControlPanelFolderIconResource,
   printMonitorFolderIconResource = kPrintMonitorFolderIconResource,
   preferencesFolderIconResource = kPreferencesFolderIconResource,
   extensionsFolderIconResource = kExtensionsFolderIconResource,
   fontsFolderIconResource = kFontsFolderIconResource,
   fullTrashIconResource = kFullTrashIconResource
};

atNone

Use the constants described in "Icon Alignment Constants" instead.

enum {
   atNone = kAlignNone,
   atVerticalCenter = kAlignVerticalCenter,
   atTop = kAlignTop,
   atBottom = kAlignBottom,
   atHorizontalCenter = kAlignHorizontalCenter,
   atAbsoluteCenter = kAlignAbsoluteCenter,
   atCenterTop = kAlignCenterTop,
   atCenterBottom = kAlignCenterBottom,
   atLeft = kAlignLeft,
   atCenterLeft = kAlignCenterLeft,
   atTopLeft = kAlignTopLeft,
   atBottomLeft = kAlignBottomLeft,
   atRight = kAlignRight,
   atCenterRight = kAlignCenterRight,
   atTopRight = kAlignTopRight,
   atBottomRight = kAlignBottomRight
};

svLarge1Bit

Use the constants described in "Icon Selector Constants" instead.

enum {
   svLarge1Bit = kSelectorLarge1Bit,
   svLarge4Bit = kSelectorLarge4Bit,
   svLarge8Bit = kSelectorLarge8Bit,
   svSmall1Bit = kSelectorSmall1Bit,
   svSmall4Bit = kSelectorSmall4Bit,
   svSmall8Bit = kSelectorSmall8Bit,
   svMini1Bit = kSelectorMini1Bit,
   svMini4Bit = kSelectorMini4Bit,
   svMini8Bit = kSelectorMini8Bit,
   svAllLargeData = kSelectorAllLargeData,
   svAllSmallData = kSelectorAllSmallData,
   svAllMiniData = kSelectorAllMiniData,
   svAll1BitData = kSelectorAll1BitData,
   svAll4BitData = kSelectorAll4BitData,
   svAll8BitData = kSelectorAll8BitData,
   svAllAvailableData = kSelectorAllAvailableData
};

ttNone

Use the constants described in "Icon Transformation Constants" instead.

enum {
   ttNone = kTransformNone,
   ttDisabled = kTransformDisabled,
   ttOffline = kTransformOffline,
   ttOpen = kTransformOpen,
   ttLabel1 = kTransformLabel1,
   ttLabel2 = kTransformLabel2,
   ttLabel3 = kTransformLabel3,
   ttLabel4 = kTransformLabel4,
   ttLabel5 = kTransformLabel5,
   ttLabel6 = kTransformLabel6,
   ttLabel7 = kTransformLabel7,
   ttSelected = kTransformSelected,
   ttSelectedDisabled = kTransformSelectedDisabled,
   ttSelectedOffline = kTransformSelectedOffline,
   ttSelectedOpen = kTransformSelectedOpen
};

Result Codes

The table below shows the most common result codes returned by Icon Services and Utilities.

Gestalt Constants

You can check for version and feature availability information by using the Icon Services selectors defined in the Gestalt Manager. For more information, see Gestalt Manager Reference.