Public interface to the font access and data management functions of ATS. More...

#include <MacTypes.h>
#include <ATSTypes.h>
#include <CFString.h>
#include <Files.h>
#include <TextCommon.h>
#include <SFNTTypes.h>

Data Structures
struct	ATSFontFilter

Typedefs
typedef UInt32	ATSFontContext

typedef UInt32	ATSFontFormat

typedef void *	iRefCon

typedef struct ATSFontFamilyIterator_ *	ATSFontFamilyIterator

typedef struct ATSFontIterator_ *	ATSFontIterator

typedef enum ATSFontFilterSelector	ATSFontFilterSelector

typedef struct ATSFontFilter	ATSFontFilter

Enumerations
enum	{ kATSOptionFlagsDefault = kNilOptions , kATSOptionFlagsComposeFontPostScriptName , kATSOptionFlagsUseDataForkAsResourceFork , kATSOptionFlagsUseResourceFork = 2 << 8 , kATSOptionFlagsUseDataFork = 3 << 8 }

enum	{ kATSIterationCompleted = -980L , kATSInvalidFontFamilyAccess = -981L , kATSInvalidFontAccess = -982L , kATSIterationScopeModified = -983L , kATSInvalidFontTableAccess = -984L , kATSInvalidFontContainerAccess = -985L }

enum	{ kATSFontContextUnspecified = 0 , kATSFontContextGlobal = 1 }

enum	{ kATSFontFormatUnspecified = 0 }

enum	{ kATSFontFilterCurrentVersion = 0 }

enum	ATSFontFilterSelector { kATSFontFilterSelectorUnspecified = 0 , kATSFontFilterSelectorGeneration = 3 , kATSFontFilterSelectorFontFamily = 7 , kATSFontFilterSelectorFontFamilyApplierFunction = 8 , kATSFontFilterSelectorFontApplierFunction = 9 }

Functions
typedef	CALLBACK_API_C (OSStatus, ATSFontFamilyApplierFunction)(ATSFontFamilyRef iFamily

typedef	CALLBACK_API_C (OSStatus, ATSFontApplierFunction)(ATSFontRef iFont

ATSGeneration	ATSGetGeneration (void)

OSStatus	ATSFontActivateFromFileSpecification (const FSSpec iFile, ATSFontContext iContext, ATSFontFormat iFormat, void iReserved, ATSOptionFlags iOptions, ATSFontContainerRef *oContainer)

OSStatus	ATSFontActivateFromMemory (LogicalAddress iData, ByteCount iLength, ATSFontContext iContext, ATSFontFormat iFormat, void iReserved, ATSOptionFlags iOptions, ATSFontContainerRef oContainer)

OSStatus	ATSFontDeactivate (ATSFontContainerRef iContainer, void *iRefCon, ATSOptionFlags iOptions)

OSStatus	ATSFontFamilyApplyFunction (ATSFontFamilyApplierFunction iFunction, void *iRefCon)

OSStatus	ATSFontFamilyIteratorCreate (ATSFontContext iContext, const ATSFontFilter iFilter, void iRefCon, ATSOptionFlags iOptions, ATSFontFamilyIterator *ioIterator)

OSStatus	ATSFontFamilyIteratorRelease (ATSFontFamilyIterator *ioIterator)

OSStatus	ATSFontFamilyIteratorReset (ATSFontContext iContext, const ATSFontFilter iFilter, void iRefCon, ATSOptionFlags iOptions, ATSFontFamilyIterator *ioIterator)

OSStatus	ATSFontFamilyIteratorNext (ATSFontFamilyIterator iIterator, ATSFontFamilyRef *oFamily)

ATSFontFamilyRef	ATSFontFamilyFindFromName (CFStringRef iName, ATSOptionFlags iOptions)

ATSGeneration	ATSFontFamilyGetGeneration (ATSFontFamilyRef iFamily)

OSStatus	ATSFontFamilyGetName (ATSFontFamilyRef iFamily, ATSOptionFlags iOptions, CFStringRef *oName)

TextEncoding	ATSFontFamilyGetEncoding (ATSFontFamilyRef iFamily)

OSStatus	ATSFontApplyFunction (ATSFontApplierFunction iFunction, void *iRefCon)

OSStatus	ATSFontIteratorCreate (ATSFontContext iContext, const ATSFontFilter iFilter, void iRefCon, ATSOptionFlags iOptions, ATSFontIterator *ioIterator)

OSStatus	ATSFontIteratorRelease (ATSFontIterator *ioIterator)

OSStatus	ATSFontIteratorReset (ATSFontContext iContext, const ATSFontFilter iFilter, void iRefCon, ATSOptionFlags iOptions, ATSFontIterator *ioIterator)

OSStatus	ATSFontIteratorNext (ATSFontIterator iIterator, ATSFontRef *oFont)

ATSFontRef	ATSFontFindFromName (CFStringRef iName, ATSOptionFlags iOptions)

ATSFontRef	ATSFontFindFromPostScriptName (CFStringRef iName, ATSOptionFlags iOptions)

OSStatus	ATSFontFindFromContainer (ATSFontContainerRef iContainer, ATSOptionFlags iOptions, ItemCount iCount, ATSFontRef ioArray[], ItemCount *oCount)

ATSGeneration	ATSFontGetGeneration (ATSFontRef iFont)

OSStatus	ATSFontGetName (ATSFontRef iFont, ATSOptionFlags iOptions, CFStringRef *oName)

OSStatus	ATSFontGetPostScriptName (ATSFontRef iFont, ATSOptionFlags iOptions, CFStringRef *oName)

OSStatus	ATSFontGetTableDirectory (ATSFontRef iFont, ByteCount iBufferSize, void ioBuffer, ByteCount oSize)

OSStatus	ATSFontGetTable (ATSFontRef iFont, FourCharCode iTag, ByteOffset iOffset, ByteCount iBufferSize, void ioBuffer, ByteCount oSize)

OSStatus	ATSFontGetHorizontalMetrics (ATSFontRef iFont, ATSOptionFlags iOptions, ATSFontMetrics *oMetrics)

OSStatus	ATSFontGetVerticalMetrics (ATSFontRef iFont, ATSOptionFlags iOptions, ATSFontMetrics *oMetrics)

ATSFontFamilyRef	ATSFontFamilyFindFromQuickDrawName (ConstStr255Param iName)

OSStatus	ATSFontFamilyGetQuickDrawName (ATSFontFamilyRef iFamily, Str255 oName)

OSStatus	ATSFontGetFileSpecification (ATSFontRef iFont, FSSpec *oFile)

OSStatus	ATSFontGetFontFamilyResource (ATSFontRef iFont, ByteCount iBufferSize, void ioBuffer, ByteCount oSize)

Detailed Description

Public interface to the font access and data management functions of ATS.

Introduced In: Mac OS

Avaliable From: Universal Interfaces 3.4.1

Copyright: © 2000-2001 by Apple Computer, Inc., all rights reserved.

For bug reports, consult the following page on the World Wide Web:

http://developer.apple.com/bugreporter/

Function Documentation

◆ ATSFontActivateFromFileSpecification()

OSStatus ATSFontActivateFromFileSpecification	(	const FSSpec *	iFile,
		ATSFontContext	iContext,
		ATSFontFormat	iFormat,
		void *	iReserved,
		ATSOptionFlags	iOptions,
		ATSFontContainerRef *	oContainer
	)

ATSFontActivateFromFileSpecification()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontActivateFromMemory()

OSStatus ATSFontActivateFromMemory	(	LogicalAddress	iData,
		ByteCount	iLength,
		ATSFontContext	iContext,
		ATSFontFormat	iFormat,
		void *	iReserved,
		ATSOptionFlags	iOptions,
		ATSFontContainerRef *	oContainer
	)

ATSFontActivateFromMemory()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontApplyFunction()

OSStatus ATSFontApplyFunction	(	ATSFontApplierFunction	iFunction,
		void *	iRefCon
	)

ATSFontApplyFunction()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontDeactivate()

OSStatus ATSFontDeactivate	(	ATSFontContainerRef	iContainer,
		void *	iRefCon,
		ATSOptionFlags	iOptions
	)

ATSFontDeactivate()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyApplyFunction()

OSStatus ATSFontFamilyApplyFunction	(	ATSFontFamilyApplierFunction	iFunction,
		void *	iRefCon
	)

ATSFontFamilyApplyFunction()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyFindFromName()

ATSFontFamilyRef ATSFontFamilyFindFromName	(	CFStringRef	iName,
		ATSOptionFlags	iOptions
	)

ATSFontFamilyFindFromName()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyFindFromQuickDrawName()

ATSFontFamilyRef ATSFontFamilyFindFromQuickDrawName ( ConstStr255Param iName )

ATSFontFamilyFindFromQuickDrawName()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyGetEncoding()

TextEncoding ATSFontFamilyGetEncoding ( ATSFontFamilyRef iFamily )

ATSFontFamilyGetEncoding()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyGetGeneration()

ATSGeneration ATSFontFamilyGetGeneration ( ATSFontFamilyRef iFamily )

ATSFontFamilyGetGeneration()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyGetName()

OSStatus ATSFontFamilyGetName	(	ATSFontFamilyRef	iFamily,
		ATSOptionFlags	iOptions,
		CFStringRef *	oName
	)

ATSFontFamilyGetName()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyGetQuickDrawName()

OSStatus ATSFontFamilyGetQuickDrawName	(	ATSFontFamilyRef	iFamily,
		Str255	oName
	)

ATSFontFamilyGetQuickDrawName()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyIteratorCreate()

OSStatus ATSFontFamilyIteratorCreate	(	ATSFontContext	iContext,
		const ATSFontFilter *	iFilter,
		void *	iRefCon,
		ATSOptionFlags	iOptions,
		ATSFontFamilyIterator *	ioIterator
	)

ATSFontFamilyIteratorCreate()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyIteratorNext()

OSStatus ATSFontFamilyIteratorNext	(	ATSFontFamilyIterator	iIterator,
		ATSFontFamilyRef *	oFamily
	)

ATSFontFamilyIteratorNext()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyIteratorRelease()

OSStatus ATSFontFamilyIteratorRelease ( ATSFontFamilyIterator * ioIterator )

ATSFontFamilyIteratorRelease()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFamilyIteratorReset()

OSStatus ATSFontFamilyIteratorReset	(	ATSFontContext	iContext,
		const ATSFontFilter *	iFilter,
		void *	iRefCon,
		ATSOptionFlags	iOptions,
		ATSFontFamilyIterator *	ioIterator
	)

ATSFontFamilyIteratorReset()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFindFromContainer()

OSStatus ATSFontFindFromContainer	(	ATSFontContainerRef	iContainer,
		ATSOptionFlags	iOptions,
		ItemCount	iCount,
		ATSFontRef	ioArray[],
		ItemCount *	oCount
	)

ATSFontFindFromContainer()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFindFromName()

ATSFontRef ATSFontFindFromName	(	CFStringRef	iName,
		ATSOptionFlags	iOptions
	)

ATSFontFindFromName()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontFindFromPostScriptName()

ATSFontRef ATSFontFindFromPostScriptName	(	CFStringRef	iName,
		ATSOptionFlags	iOptions
	)

ATSFontFindFromPostScriptName()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontGetFileSpecification()

OSStatus ATSFontGetFileSpecification	(	ATSFontRef	iFont,
		FSSpec *	oFile
	)

ATSFontGetFileSpecification()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontGetFontFamilyResource()

OSStatus ATSFontGetFontFamilyResource	(	ATSFontRef	iFont,
		ByteCount	iBufferSize,
		void *	ioBuffer,
		ByteCount *	oSize
	)

ATSFontGetFontFamilyResource()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontGetGeneration()

ATSGeneration ATSFontGetGeneration ( ATSFontRef iFont )

ATSFontGetGeneration()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontGetHorizontalMetrics()

OSStatus ATSFontGetHorizontalMetrics	(	ATSFontRef	iFont,
		ATSOptionFlags	iOptions,
		ATSFontMetrics *	oMetrics
	)

ATSFontGetHorizontalMetrics()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontGetName()

OSStatus ATSFontGetName	(	ATSFontRef	iFont,
		ATSOptionFlags	iOptions,
		CFStringRef *	oName
	)

ATSFontGetName()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontGetPostScriptName()

OSStatus ATSFontGetPostScriptName	(	ATSFontRef	iFont,
		ATSOptionFlags	iOptions,
		CFStringRef *	oName
	)

ATSFontGetPostScriptName()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontGetTable()

OSStatus ATSFontGetTable	(	ATSFontRef	iFont,
		FourCharCode	iTag,
		ByteOffset	iOffset,
		ByteCount	iBufferSize,
		void *	ioBuffer,
		ByteCount *	oSize
	)

ATSFontGetTable()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontGetTableDirectory()

OSStatus ATSFontGetTableDirectory	(	ATSFontRef	iFont,
		ByteCount	iBufferSize,
		void *	ioBuffer,
		ByteCount *	oSize
	)

ATSFontGetTableDirectory()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontGetVerticalMetrics()

OSStatus ATSFontGetVerticalMetrics	(	ATSFontRef	iFont,
		ATSOptionFlags	iOptions,
		ATSFontMetrics *	oMetrics
	)

ATSFontGetVerticalMetrics()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontIteratorCreate()

OSStatus ATSFontIteratorCreate	(	ATSFontContext	iContext,
		const ATSFontFilter *	iFilter,
		void *	iRefCon,
		ATSOptionFlags	iOptions,
		ATSFontIterator *	ioIterator
	)

ATSFontIteratorCreate()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontIteratorNext()

OSStatus ATSFontIteratorNext	(	ATSFontIterator	iIterator,
		ATSFontRef *	oFont
	)

ATSFontIteratorNext()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontIteratorRelease()

OSStatus ATSFontIteratorRelease ( ATSFontIterator * ioIterator )

ATSFontIteratorRelease()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSFontIteratorReset()

OSStatus ATSFontIteratorReset	(	ATSFontContext	iContext,
		const ATSFontFilter *	iFilter,
		void *	iRefCon,
		ATSOptionFlags	iOptions,
		ATSFontIterator *	ioIterator
	)

ATSFontIteratorReset()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

◆ ATSGetGeneration()

ATSGeneration ATSGetGeneration ( void )

ATSGetGeneration()

@par Non-Carbon CFM:   not available
@par Carbon Lib:        not available in CarbonLib 1.x, is available on Mac OS

X version 10.0 and later

Mac OS X: in version 10.0 and later

Data Structures

Typedefs

Enumerations

Functions

Detailed Description

Function Documentation

◆ ATSFontActivateFromFileSpecification()

◆ ATSFontActivateFromMemory()

◆ ATSFontApplyFunction()

◆ ATSFontDeactivate()

◆ ATSFontFamilyApplyFunction()

◆ ATSFontFamilyFindFromName()

◆ ATSFontFamilyFindFromQuickDrawName()

◆ ATSFontFamilyGetEncoding()

◆ ATSFontFamilyGetGeneration()

◆ ATSFontFamilyGetName()

◆ ATSFontFamilyGetQuickDrawName()

◆ ATSFontFamilyIteratorCreate()

◆ ATSFontFamilyIteratorNext()

◆ ATSFontFamilyIteratorRelease()

◆ ATSFontFamilyIteratorReset()

◆ ATSFontFindFromContainer()

◆ ATSFontFindFromName()

◆ ATSFontFindFromPostScriptName()

◆ ATSFontGetFileSpecification()

◆ ATSFontGetFontFamilyResource()

◆ ATSFontGetGeneration()

◆ ATSFontGetHorizontalMetrics()

◆ ATSFontGetName()

◆ ATSFontGetPostScriptName()

◆ ATSFontGetTable()

◆ ATSFontGetTableDirectory()

◆ ATSFontGetVerticalMetrics()

◆ ATSFontIteratorCreate()

◆ ATSFontIteratorNext()

◆ ATSFontIteratorRelease()

◆ ATSFontIteratorReset()

◆ ATSGetGeneration()