PIGetFileListSuite.h

Go to the documentation of this file.

// ADOBE SYSTEMS INCORPORATED
// Copyright  1993 - 2005 Adobe Systems Incorporated
// All Rights Reserved
//
// NOTICE:  Adobe permits you to use, modify, and distribute this 
// file in accordance with the terms of the Adobe license agreement
// accompanying it.  If you have received this file from a source
// other than Adobe, then your use, modification, or distribution
// of it requires the prior written permission of Adobe.
//-------------------------------------------------------------------
#ifndef __PIGetFileListSuite__
#define __PIGetFileListSuite__

//-------------------------------------------------------------------------------
//  Includes.
//-------------------------------------------------------------------------------
#include "PIGeneral.h"

#if MSWindows && defined(__PSWorld__)
#include "Files.h"
#endif


//-------------------------------------------------------------------------------
//  C++ wrapper.
//-------------------------------------------------------------------------------
#ifdef __cplusplus
extern "C" {
#endif

//-------------------------------------------------------------------------------
//  UI GetFileList suite.
//-------------------------------------------------------------------------------

#define kPSGetFileListSuite             "Photoshop GetFileList Suite for Plug-ins"

//-------------------------------------------------------------------------------
//  
//-------------------------------------------------------------------------------

#if Macintosh && __LP64__
typedef FSRef PIGetFileListHandleType;
#else
typedef FSSpec PIGetFileListHandleType;
#endif

typedef SPAPI SPErr (*GetFileHandleListProc) (PIActionDescriptor& des, PIGetFileListHandleType* fileSpec, bool recurse);

typedef SPAPI SPErr (*GetXPlatFileHandleListProc) (PIActionDescriptor& des, XPlatFileSpec* fileSpec, bool recurse);

typedef SPAPI SPErr (*GetBrowserNameListProc) (PIActionDescriptor& des);

typedef SPAPI SPErr (*BrowseUrlWithIndexBrowserProc) (uint16 index, const char* url);

typedef SPAPI SPErr (*BrowseUrlProc) (const char* url);

typedef SPAPI SPErr (*GetBrowserFileSpecProc)(uint16 index, SPPlatformFileSpecification* fileSpec);
typedef SPAPI SPErr (*GetXPlatBrowserFileSpecProc)(uint16 index, XPlatFileSpec* fileSpec);

typedef SPAPI SPErr (*GetDefaultSystemScriptProc)(int16& script);

typedef SPAPI SPErr (*HasDoubleByteInStringProc)(const char* charString, bool& hasDoubleByte);

typedef SPAPI SPErr (*GetWebTemplateFolderSpecProc)(SPPlatformFileSpecification* fileSpec);
typedef SPAPI SPErr (*GetXPlatWebTemplateFolderSpecProc)(XPlatFileSpec* fileSpec);

typedef SPAPI SPErr (*GetWebTemplateListProc) (PIActionDescriptor& styleList, bool recurse);

typedef SPAPI SPErr (*GetWindowsFileTypesProc) (char * fileTypeList, int32 bufferSize);

typedef SPAPI SPErr (*GetMacFileTypesProc) (OSType * typeList, int32 &numTypes, int32 bufferSize);

typedef SPAPI SPErr (*GetPresetsFolderSpecProc) (SPPlatformFileSpecification *fileSpec);
typedef SPAPI SPErr (*GetXPlatPresetsFolderSpecProc) (XPlatFileSpec *fileSpec);

typedef SPAPI SPErr (*InvalidateFileBrowserCacheProc) (const SPPlatformFileSpecification *fileSpec);
typedef SPAPI SPErr (*InvalidateXPlatFileBrowserCacheProc) (const XPlatFileSpec *fileSpec);

typedef SPAPI SPErr (*GetChewableFolderSpecProc) (SPPlatformFileSpecification *folderSpec);
typedef SPAPI SPErr (*GetXPlatChewableFolderSpecProc) (XPlatFileSpec *folderSpec);

typedef SPAPI SPErr (*GetChewableFreeSpaceProc) (int64& freeSpace);

//-------------------------------------------------------------------------------
//   GetFileList suite version 1.
//-------------------------------------------------------------------------------

#define kPSGetFileListSuiteVersion1     1    
#define kPSGetFileListSuiteVersion2     2    
#define kPSGetFileListSuiteVersion3     3    
#define kPSGetFileListSuiteVersion4     4    
#define kPSGetFileListSuiteVersion5     5    
#define kPSGetFileListSuiteVersion6     6    
#define kPSGetFileListSuiteVersion7     7    
typedef struct 
    {
    GetFileHandleListProc           GetFileHandleList;          
    GetBrowserNameListProc          GetBrowserNameList;         
    BrowseUrlWithIndexBrowserProc   BrowseUrlWithIndexBrowser;  
    BrowseUrlProc                   BrowseUrl;                  
    GetBrowserFileSpecProc          GetBrowserFileSpec;         
    } PSGetFileListSuite1;

typedef struct 
    {
    GetFileHandleListProc           GetFileHandleList;          
    GetBrowserNameListProc          GetBrowserNameList;         
    BrowseUrlWithIndexBrowserProc   BrowseUrlWithIndexBrowser;  
    BrowseUrlProc                   BrowseUrl;                  
    GetBrowserFileSpecProc          GetBrowserFileSpec;         
    GetDefaultSystemScriptProc      GetDefaultSystemScript;     
    } PSGetFileListSuite2;

typedef struct 
    {
    GetFileHandleListProc           GetFileHandleList;          
    GetBrowserNameListProc          GetBrowserNameList;         
    BrowseUrlWithIndexBrowserProc   BrowseUrlWithIndexBrowser;  
    BrowseUrlProc                   BrowseUrl;                  
    GetBrowserFileSpecProc          GetBrowserFileSpec;         
    GetDefaultSystemScriptProc      GetDefaultSystemScript;     
    HasDoubleByteInStringProc       HasDoubleByteInString;      
    } PSGetFileListSuite3;

typedef struct 
    {
    GetFileHandleListProc           GetFileHandleList;          
    GetBrowserNameListProc          GetBrowserNameList;         
    BrowseUrlWithIndexBrowserProc   BrowseUrlWithIndexBrowser;  
    BrowseUrlProc                   BrowseUrl;                  
    GetBrowserFileSpecProc          GetBrowserFileSpec;         
    GetDefaultSystemScriptProc      GetDefaultSystemScript;     
    HasDoubleByteInStringProc       HasDoubleByteInString;      
    GetWebTemplateFolderSpecProc    GetWebTemplateFolderSpec;   
    GetWebTemplateListProc          GetWebTemplateList;         
    } PSGetFileListSuite4;

typedef struct 
{
    GetFileHandleListProc           GetFileHandleList;           
    GetBrowserNameListProc          GetBrowserNameList;          
    BrowseUrlWithIndexBrowserProc   BrowseUrlWithIndexBrowser;   
    BrowseUrlProc                   BrowseUrl;                   
    GetBrowserFileSpecProc          GetBrowserFileSpec;          
    GetDefaultSystemScriptProc      GetDefaultSystemScript;      
    HasDoubleByteInStringProc       HasDoubleByteInString;       
    GetWebTemplateFolderSpecProc    GetWebTemplateFolderSpec;    
    GetWebTemplateListProc          GetWebTemplateList;          
    GetWindowsFileTypesProc         GetWindowsFileTypes;         
    GetMacFileTypesProc             GetMacFileTypes;             
    GetPresetsFolderSpecProc        GetPresetsFolderSpec;        
    InvalidateFileBrowserCacheProc  InvalidateFileBrowserCache;  
} PSGetFileListSuite5;

typedef struct 
{
    GetFileHandleListProc           GetFileHandleList;           
    GetBrowserNameListProc          GetBrowserNameList;          
    BrowseUrlWithIndexBrowserProc   BrowseUrlWithIndexBrowser;   
    BrowseUrlProc                   BrowseUrl;                   
    GetBrowserFileSpecProc          GetBrowserFileSpec;          
    GetDefaultSystemScriptProc      GetDefaultSystemScript;      
    HasDoubleByteInStringProc       HasDoubleByteInString;       
    GetWebTemplateFolderSpecProc    GetWebTemplateFolderSpec;    
    GetWebTemplateListProc          GetWebTemplateList;          
    GetWindowsFileTypesProc         GetWindowsFileTypes;         
    GetMacFileTypesProc             GetMacFileTypes;             
    GetPresetsFolderSpecProc        GetPresetsFolderSpec;        
    InvalidateFileBrowserCacheProc  InvalidateFileBrowserCache;  
    GetChewableFolderSpecProc       GetChewableFolderSpec;       
    GetChewableFreeSpaceProc        GetChewableFreeSpace;        
} PSGetFileListSuite6;

typedef struct 
{
    GetXPlatFileHandleListProc          GetXPlatFileHandleList;         
    GetBrowserNameListProc              GetBrowserNameList;             
    BrowseUrlWithIndexBrowserProc       BrowseUrlWithIndexBrowser;      
    BrowseUrlProc                       BrowseUrl;                      
    GetXPlatBrowserFileSpecProc         GetXPlatBrowserFileSpec;        
    GetDefaultSystemScriptProc          GetDefaultSystemScript;         
    HasDoubleByteInStringProc           HasDoubleByteInString;          
    GetXPlatWebTemplateFolderSpecProc   GetXPlatWebTemplateFolderSpec;  
    GetWebTemplateListProc              GetWebTemplateList;             
    GetWindowsFileTypesProc             GetWindowsFileTypes;            
    GetMacFileTypesProc                 GetMacFileTypes;                
    GetXPlatPresetsFolderSpecProc       GetXPlatPresetsFolderSpec;      
    InvalidateXPlatFileBrowserCacheProc InvalidateXPlatFileBrowserCache;
    GetXPlatChewableFolderSpecProc      GetXPlatChewableFolderSpec;     
    GetChewableFreeSpaceProc            GetChewableFreeSpace;           
} PSGetFileListSuite7;

//-------------------------------------------------------------------------------
//  C++ wrapper.
//-------------------------------------------------------------------------------
#ifdef __cplusplus
}
#endif

//-------------------------------------------------------------------------------
#endif  // PIGetFileListSuite