Mac OS 9
Data Structures | Macros | Typedefs | Enumerations | Functions
Translation.h File Reference
Translation

Translation Manager (Macintosh Easy Open) Interfaces. More...

#include <MacTypes.h>
#include <Files.h>
#include <Components.h>
#include <TranslationExtensions.h>

Go to the source code of this file.

Data Structures

struct  FileTranslationSpec
 

Macros

#define NewGetScrapDataUPP(userRoutine)
 
#define DisposeGetScrapDataUPP(userUPP)   DisposeRoutineDescriptor(userUPP)
 
#define InvokeGetScrapDataUPP(requestedFormat, dataH, srcDataGetterRefCon, userUPP)
 
#define NewGetScrapDataProc(userRoutine)   NewGetScrapDataUPP(userRoutine)
 
#define CallGetScrapDataProc(userRoutine, requestedFormat, dataH, srcDataGetterRefCon)
 

Typedefs

typedef short DocOpenMethod
 
typedef OSType TypesBlock[64]
 
typedef OSType * TypesBlockPtr
 
typedef struct FileTranslationSpec FileTranslationSpec
 
typedef FileTranslationSpec * FileTranslationSpecArrayPtr
 
typedef FileTranslationSpecArrayPtr * FileTranslationSpecArrayHandle
 
typedef Handle dataH
 
typedef Handle void * srcDataGetterRefCon
 
typedef GetScrapDataUPP GetScrapData
 

Enumerations

enum  { domCannot = 0 , domNative = 1 , domTranslateFirst = 2 , domWildcard = 3 }
 
enum  { kTranslationScrapProgressDialogID = -16555 }
 
enum  { uppGetScrapDataProcInfo = 0x00000FE0 }
 

Functions

OSErr GetFileTypesThatAppCanNativelyOpen (short appVRefNumHint, OSType appSignature, FileType *nativeTypes)
 
OSErr ExtendFileTypeList (const FileType *originalTypeList, short numberOriginalTypes, FileType *extendedTypeList, short *numberExtendedTypes)
 
OSErr CanDocBeOpened (const FSSpec *targetDocument, short appVRefNumHint, OSType appSignature, const FileType *nativeTypes, Boolean onlyNative, DocOpenMethod *howToOpen, FileTranslationSpec *howToTranslate)
 
short GetFileTranslationPaths (const FSSpec *srcDocument, FileType dstDocType, unsigned short maxResultCount, FileTranslationSpecArrayPtr resultBuffer)
 
OSErr GetPathFromTranslationDialog (const FSSpec *theDocument, const FSSpec *theApplication, TypesBlockPtr typeList, DocOpenMethod *howToOpen, FileTranslationSpec *howToTranslate)
 
OSErr TranslateFile (const FSSpec *sourceDocument, const FSSpec *destinationDocument, const FileTranslationSpec *howToTranslate)
 
OSErr GetDocumentKindString (short docVRefNum, OSType docType, OSType docCreator, Str63 kindString)
 
OSErr GetTranslationExtensionName (const FileTranslationSpec *translationMethod, Str31 extensionName)
 
typedef CALLBACK_API (OSErr, GetScrapDataProcPtr)(ScrapType requestedFormat
 
typedef STACK_UPP_TYPE (GetScrapDataProcPtr) GetScrapDataUPP
 
GetScrapDataUPP NewGetScrapDataUPP (GetScrapDataProcPtr userRoutine)
 
void DisposeGetScrapDataUPP (GetScrapDataUPP userUPP)
 
OSErr InvokeGetScrapDataUPP (ScrapType requestedFormat, Handle dataH, void *srcDataGetterRefCon, GetScrapDataUPP userUPP)
 
OSErr TranslateScrap (GetScrapDataUPP sourceDataGetter, void *sourceDataGetterRefCon, ScrapType destinationFormat, Handle destinationData, short progressDialogID)
 

Detailed Description

Translation Manager (Macintosh Easy Open) Interfaces.

Introduced In: Macintosh Easy Open 1.1
Avaliable From: Universal Interfaces 3.4.1
Copyright: © 1991-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/

Macro Definition Documentation

◆ CallGetScrapDataProc

#define CallGetScrapDataProc (   userRoutine,
  requestedFormat,
  dataH,
  srcDataGetterRefCon 
)
Value:
InvokeGetScrapDataUPP(requestedFormat, dataH, srcDataGetterRefCon, \
userRoutine)
InvokeGetScrapDataUPP
OSErr InvokeGetScrapDataUPP(ScrapType requestedFormat, Handle dataH, void *srcDataGetterRefCon, GetScrapDataUPP userUPP)

◆ InvokeGetScrapDataUPP

#define InvokeGetScrapDataUPP (   requestedFormat,
  dataH,
  srcDataGetterRefCon,
  userUPP 
)
Value:
(OSErr) CALL_THREE_PARAMETER_UPP((userUPP), uppGetScrapDataProcInfo, \
(requestedFormat), (dataH), \
(srcDataGetterRefCon))

◆ NewGetScrapDataUPP

#define NewGetScrapDataUPP (   userRoutine)
Value:
(GetScrapDataUPP) \
NewRoutineDescriptor((ProcPtr)(userRoutine), uppGetScrapDataProcInfo, \
GetCurrentArchitecture())
NewRoutineDescriptor
UniversalProcPtr NewRoutineDescriptor(ProcPtr theProc, ProcInfoType theProcInfo, ISAType theISA)

Function Documentation

◆ CanDocBeOpened()

OSErr CanDocBeOpened ( const FSSpec *  targetDocument,
short  appVRefNumHint,
OSType  appSignature,
const FileType *  nativeTypes,
Boolean  onlyNative,
DocOpenMethod *  howToOpen,
FileTranslationSpec *  howToTranslate 
)

CanDocBeOpened()

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ DisposeGetScrapDataUPP()

void DisposeGetScrapDataUPP ( GetScrapDataUPP  userUPP)

DisposeGetScrapDataUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ ExtendFileTypeList()

OSErr ExtendFileTypeList ( const FileType *  originalTypeList,
short  numberOriginalTypes,
FileType *  extendedTypeList,
short *  numberExtendedTypes 
)

ExtendFileTypeList()

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetDocumentKindString()

OSErr GetDocumentKindString ( short  docVRefNum,
OSType  docType,
OSType  docCreator,
Str63  kindString 
)

GetDocumentKindString()

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetFileTranslationPaths()

short GetFileTranslationPaths ( const FSSpec *  srcDocument,
FileType  dstDocType,
unsigned short  maxResultCount,
FileTranslationSpecArrayPtr  resultBuffer 
)

GetFileTranslationPaths()

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetFileTypesThatAppCanNativelyOpen()

OSErr GetFileTypesThatAppCanNativelyOpen ( short  appVRefNumHint,
OSType  appSignature,
FileType *  nativeTypes 
)

GetFileTypesThatAppCanNativelyOpen()

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetPathFromTranslationDialog()

OSErr GetPathFromTranslationDialog ( const FSSpec *  theDocument,
const FSSpec *  theApplication,
TypesBlockPtr  typeList,
DocOpenMethod *  howToOpen,
FileTranslationSpec *  howToTranslate 
)

GetPathFromTranslationDialog()

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ GetTranslationExtensionName()

OSErr GetTranslationExtensionName ( const FileTranslationSpec *  translationMethod,
Str31  extensionName 
)

GetTranslationExtensionName()

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ InvokeGetScrapDataUPP()

OSErr InvokeGetScrapDataUPP ( ScrapType  requestedFormat,
Handle  dataH,
void *  srcDataGetterRefCon,
GetScrapDataUPP  userUPP 
)

InvokeGetScrapDataUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ NewGetScrapDataUPP()

GetScrapDataUPP NewGetScrapDataUPP ( GetScrapDataProcPtr  userRoutine)

NewGetScrapDataUPP()

Non-Carbon CFM: available as macro/inline
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TranslateFile()

OSErr TranslateFile ( const FSSpec *  sourceDocument,
const FSSpec *  destinationDocument,
const FileTranslationSpec *  howToTranslate 
)

TranslateFile()

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later

◆ TranslateScrap()

OSErr TranslateScrap ( GetScrapDataUPP  sourceDataGetter,
void *  sourceDataGetterRefCon,
ScrapType  destinationFormat,
Handle  destinationData,
short  progressDialogID 
)

TranslateScrap()

Non-Carbon CFM: in Translation 1.0 and later
Carbon Lib: in CarbonLib 1.0 and later
Mac OS X: in version 10.0 and later