
Public Member Functions | |
| virtual MCCOMErr MCCOMAPI | RegisterFileFamily (IDType inFamily, const TMCString &fileFamilyName)=0 |
| virtual MCCOMErr MCCOMAPI | GetFileFamilies (TMCArray< APITypeAndName > &outFamilies, boolean inForOpen)=0 |
| virtual MCCOMErr MCCOMAPI | GetFileTypes (TMCArray< APITypeAndName > &outFileTypes, IDType inFamily, boolean inForOpen)=0 |
| virtual MCCOMErr MCCOMAPI | GetFileTypes (TMCArray< IDType > &outFileTypes, IDType inFamily, boolean inForOpen)=0 |
| virtual void MCCOMAPI | AddFileType (const TMCFileType &inFileType)=0 |
| virtual void MCCOMAPI | AddFileTypes (const TMCFileTypeList &inTypesList)=0 |
| virtual void MCCOMAPI | LoadResourceFTYP (IDType inCompFamilyID, IDType inCompClassID, ResourceID inResID, MCTypeFamilyID inFileFamily, TMCFileTypeList &outTypeList)=0 |
| virtual MCCOMErr MCCOMAPI | OpenFolderDialog (const TMCString &inTitle, IMCFile *file)=0 |
| virtual MCCOMErr MCCOMAPI | OpenFileDialog (const TMCString &inTitle, IMCFile *file, TMCArray< IDType > &inFileTypes, IDType &inOutPopupSelection, IDType &outFormat)=0 |
| virtual MCCOMErr MCCOMAPI | SaveFileDialog (const TMCString &inTitle, IMCFile *file, TMCArray< IDType > &inFileTypes, IDType &inOutFormat)=0 |
| virtual MCCOMErr MCCOMAPI | OpenDocument (const IMCFile *inFile, MCFileTypeID fileType, IMFDocument **outDocument)=0 |
| virtual MCCOMErr MCCOMAPI | GetMultipleFiles (const TMCString &inPropmt, IMCFile *startingPath, TMCCountedPtrArray< IMCFile > &outFileList, TMCArray< IDType > &inFileTypes, IDType &inOutPopupSelection)=0 |
| virtual const TMCFileType *MCCOMAPI | GetFileTypeByID (MCFileTypeID fileID)=0 |
| virtual void MCCOMAPI | GetFileTypesByFamilyID (TMCFileTypeList &fileTypeList, MCTypeFamilyID familyID)=0 |
| virtual MCCOMErr MCCOMAPI IShFileFormatUtilities::RegisterFileFamily | ( | IDType | inFamily, | |
| const TMCString & | fileFamilyName | |||
| ) | [pure virtual] |
Registers a new file family
| inFamily | ID type of the family to register (ie 'imag') | |
| fileFamilyName | String with the name of the file family (ie "Image Files") |
| virtual MCCOMErr MCCOMAPI IShFileFormatUtilities::GetFileFamilies | ( | TMCArray< APITypeAndName > & | outFamilies, | |
| boolean | inForOpen | |||
| ) | [pure virtual] |
Returns the list of available file families
| outFamilies | Returns the list | |
| inForOpen |
| virtual MCCOMErr MCCOMAPI IShFileFormatUtilities::GetFileTypes | ( | TMCArray< APITypeAndName > & | outFileTypes, | |
| IDType | inFamily, | |||
| boolean | inForOpen | |||
| ) | [pure virtual] |
Returns a list of file API types and names
| outFileTypes | Returns the list of file types in the specified family | |
| inFamily | The family of file types to get. (0 for all available families) Call GetFileFamilies() for a list of available file families. | |
| inForOpen | Not used at this time. |
| virtual MCCOMErr MCCOMAPI IShFileFormatUtilities::GetFileTypes | ( | TMCArray< IDType > & | outFileTypes, | |
| IDType | inFamily, | |||
| boolean | inForOpen | |||
| ) | [pure virtual] |
Returns a list of file type IDs
| outFileTypes | Returns the list of file types in the specified family | |
| inFamily | The family of file types to get. (0 for all available families) Call GetFileFamilies() for a list of available file families. | |
| inForOpen | Not used at this time. |
| virtual void MCCOMAPI IShFileFormatUtilities::AddFileType | ( | const TMCFileType & | inFileType | ) | [pure virtual] |
Adds a new file type to the list of types the application handles
| inFileType | The file type to add. |
| virtual void MCCOMAPI IShFileFormatUtilities::AddFileTypes | ( | const TMCFileTypeList & | inTypesList | ) | [pure virtual] |
Adds a a list of file types to the list of types the application handles. Note: Use LoadResourceFTYP() to load your type list.
| inTypesList | The list of file types to add. |
| virtual void MCCOMAPI IShFileFormatUtilities::LoadResourceFTYP | ( | IDType | inCompFamilyID, | |
| IDType | inCompClassID, | |||
| ResourceID | inResID, | |||
| MCTypeFamilyID | inFileFamily, | |||
| TMCFileTypeList & | outTypeList | |||
| ) | [pure virtual] |
Loads a FTYP resource into a TMCFileTypeList.
| inCompFamilyID | ID of the component family owning the FTYP resource | |
| inCompClassID | ID of the component class owning the FTYP resource | |
| inResID | Resource ID of the FTYP to load | |
| inFileFamily | ID of the file family to load | |
| outTypeList | Returns the list of file types in the family |
| virtual MCCOMErr MCCOMAPI IShFileFormatUtilities::OpenFolderDialog | ( | const TMCString & | inTitle, | |
| IMCFile * | file | |||
| ) | [pure virtual] |
Opens a system folder-open dialog and returns the file selected by the user.
| inTitle | The title of the dialog box that will be opened | |
| file | Pointer to the folder selected by the user |
| virtual MCCOMErr MCCOMAPI IShFileFormatUtilities::OpenFileDialog | ( | const TMCString & | inTitle, | |
| IMCFile * | file, | |||
| TMCArray< IDType > & | inFileTypes, | |||
| IDType & | inOutPopupSelection, | |||
| IDType & | outFormat | |||
| ) | [pure virtual] |
Opens a system file-open dialog and returns the file selected by the user. Note that the file types can be '****' for all files, a file family ID (ie 'imag'), or a file type ID (ie 'JPEG')
| inTitle | The title of the dialog box that will be opened | |
| file | Pointer to the file selected by the user | |
| inFileTypes | An array of file types that will be selectable. | |
| inOutPopupSelection | The file type selected by the user. On entry, it can contain '****' for all files, the family ID (for instance 'imag') for FileTypeFamily to be used or the ID of the FileType to be used | |
| outFormat | The type of the file selected by the user |
| virtual MCCOMErr MCCOMAPI IShFileFormatUtilities::SaveFileDialog | ( | const TMCString & | inTitle, | |
| IMCFile * | file, | |||
| TMCArray< IDType > & | inFileTypes, | |||
| IDType & | inOutFormat | |||
| ) | [pure virtual] |
Opens a system file-save dialog and returns the file and format selected by the user. Note that the file types can be '****' for all files, a file family ID (ie 'imag'), or a file type ID (ie 'JPEG')
| inTitle | The title of the dialog box that will be opened | |
| file | Pointer to the file selected by the user | |
| inFileTypes | An array of file types that will be selectable. | |
| inOutFormat | Default file format to present to the user. This parameter will return the file format actually chosen by the user. |
| virtual MCCOMErr MCCOMAPI IShFileFormatUtilities::OpenDocument | ( | const IMCFile * | inFile, | |
| MCFileTypeID | fileType, | |||
| IMFDocument ** | outDocument | |||
| ) | [pure virtual] |
Given a file and file type ID, opens a document.
| inFile | Pointer to the file containing the document to open | |
| fileType | File type ID of the file | |
| outDocument | Returns a pointer to the document opened. |
| virtual MCCOMErr MCCOMAPI IShFileFormatUtilities::GetMultipleFiles | ( | const TMCString & | inPropmt, | |
| IMCFile * | startingPath, | |||
| TMCCountedPtrArray< IMCFile > & | outFileList, | |||
| TMCArray< IDType > & | inFileTypes, | |||
| IDType & | inOutPopupSelection | |||
| ) | [pure virtual] |
Gets a list of one or more file(s) by popping up a multiple file chooser system dialog. Note that the file types can be '****' for all files, a file family ID (ie 'imag'), or a file type ID (ie 'JPEG')
| inPropmt | Prompt to display in the title of | |
| startingPath | Pointer to an IMCFile providing the initial directory in which to start the dialog | |
| outFileList | An array of pointers to the selected files. | |
| inFileTypes | An array of types of files that should be selectable | |
| inOutPopupSelection | Default file format to present to the user. This parameter will return the file format actually chosen by the user. |
| virtual const TMCFileType* MCCOMAPI IShFileFormatUtilities::GetFileTypeByID | ( | MCFileTypeID | fileID | ) | [pure virtual] |
Returns a pointer to a TMCFileType by the ID of the file type.
| fileID | ID of a file type (See TMCFileType) |
| virtual void MCCOMAPI IShFileFormatUtilities::GetFileTypesByFamilyID | ( | TMCFileTypeList & | fileTypeList, | |
| MCTypeFamilyID | familyID | |||
| ) | [pure virtual] |
Returns a list of file types that match a given family
| fileTypeList | Returns a list of file types | |
| familyID | The ID of the family to query |
1.5.3