PIGetFileListSuite.h File Reference

This file contains all the public definitions and structures for GetFileList Suite. More...

#include "PIGeneral.h"

Go to the source code of this file.


Data Structures

struct  PSGetFileListSuite1
 The set of routines available in Version 1 of the Get File List Suite. More...
struct  PSGetFileListSuite2
 The set of routines available in Version 2 of the Get File List Suite. More...
struct  PSGetFileListSuite3
 The set of routines available in Version 3 of the Get File List Suite. More...
struct  PSGetFileListSuite4
 The set of routines available in Version 4 of the Get File List Suite. More...
struct  PSGetFileListSuite5
 The set of routines available in Version 5 of the Get File List Suite. More...
struct  PSGetFileListSuite6
 The set of routines available in Version 6 of the Get File List Suite. More...

Defines

#define kPSGetFileListSuite   "Photoshop GetFileList Suite for Plug-ins"
 Unique identifier for the Get File List Suite.
#define kPSGetFileListSuiteVersion1   1
 Get File List Suite Version 1.
#define kPSGetFileListSuiteVersion2   2
 Get File List Suite Version 2.
#define kPSGetFileListSuiteVersion3   3
 Get File List Suite Version 3.
#define kPSGetFileListSuiteVersion4   4
 Get File List Suite Version 4.
#define kPSGetFileListSuiteVersion5   5
 Get File List Suite Version 5.
#define kPSGetFileListSuiteVersion6   6
 Get File List Suite Version 6.

Typedefs

typedef FSSpec PIGetFileListHandleType
 Gets a list of file handles from fileSpec.
typedef SPAPI SPErr(*) GetFileHandleListProc (PIActionDescriptor &des, PIGetFileListHandleType *fileSpec, bool recurse)
typedef SPAPI SPErr(*) GetBrowserNameListProc (PIActionDescriptor &des)
 Gets a list of browser names in the Helper\Preview In folder.
typedef SPAPI SPErr(*) BrowseUrlWithIndexBrowserProc (uint16 index, const char *url)
 Browses a URL with a browser from the "Preview In" folder; the browser is chosen based on index.
typedef SPAPI SPErr(*) BrowseUrlProc (const char *url)
 Browses a url with the default browser.
typedef SPAPI SPErr(*) GetBrowserFileSpecProc (uint16 index, SPPlatformFileSpecification *fileSpec)
 Gets the SPPlatformFileSpecification for a browser.
typedef SPAPI SPErr(*) GetDefaultSystemScriptProc (int16 &script)
typedef SPAPI SPErr(*) HasDoubleByteInStringProc (const char *charString, bool &hasDoubleByte)
typedef SPAPI SPErr(*) GetWebTemplateFolderSpecProc (SPPlatformFileSpecification *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(*) InvalidateFileBrowserCacheProc (const SPPlatformFileSpecification *fileSpec)
typedef SPAPI SPErr(*) GetChewableFolderSpecProc (SPPlatformFileSpecification *folderSpec)
typedef SPAPI SPErr(*) GetChewableFreeSpaceProc (int64 &freeSpace)

Detailed Description

This file contains all the public definitions and structures for GetFileList Suite.

Use the GetFileList Suite : 1) To get a list of file handles from FSSpec. If the second parameter is true (recursive ), it will go through all the folders and subfolders and put all the files in a list and sort them and remove the duplicate entries. The return value PIActionDescriptor will have PIActionList which contains all the file handles in the right order. 2) To get a list of browser names in the Helper\Preview In folder. All the browser names will be ZStrings in PIActionList. 3) Browse a given url with a given index for the browsers in the "Preview In" folder. The index parameter is zero based. 4) Browse a url with the default browser. 5) Get the browser's SPPlatformFileSpecification using GetBrowserFileSpec method. The method takes the zero_based index for the browser.

Distribution: PUBLIC