IFileUtility.h

//========================================================================================
// 
// $File$
// 
// Owner: Robin_Briggs
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 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 __IFILEUTILITY__
#define __IFILEUTILITY__

#include "IDFile.h"

class PMString;

class IFileUtility
{
public:
 virtual ~IFileUtility() {}

 virtual void DeleteFile() = 0;
 
 enum SetTemporaryFileFlags {
 kNone = 0x0,

 // -- Mac Flags -- //
 kUserDomainMac = 0x1, /* Finds a folder in the user domain. 
 See kUserDomain in Folders.h on Mac. */
 kPreferencesFolderTypeMac = 0x2, /* Sets the temporary file to a file in the 
 Preferences folder, instead of a folder
 that is deleted on startup. */

 // -- Windows Flags -- //
 
 };
 virtual bool16 SetTemporaryFile(int32 flags = kNone) = 0;
 
 virtual void SetUniqueName() = 0;
 
 virtual void GetPathName(PMString *pathName) = 0;
 
 virtual void GetFileName(PMString* fileName) = 0;
 
 virtual const IDFile& GetSysFile() = 0;
 
 virtual void GetDirectory(IDFile& fileSpec) = 0;
 
 virtual bool16 CopyFile(const IDFile& destSpec) = 0;

 virtual bool16 FileExists() = 0;

 virtual bool16 IsFolder() = 0;

 typedef enum {
 kRead,
 kWrite,
 kReadWrite
 } Access;

 virtual bool8 CanOpen(Access access = kReadWrite) = 0;
 
 virtual void GetFileCreatorType(SysOSType* fileType, SysOSType* creator) = 0;

 virtual void SetFileCreatorType(SysOSType fileType, SysOSType creator) = 0;
 
 virtual bool16 IsStationery() = 0;
 
 virtual void SetFileAsStationery(bool16 asStationery) = 0;
 
 virtual uint32 GetModificationDate() = 0;
 
 virtual uint32 GetCreationDate() = 0;

 virtual PMString GetExtension() = 0;
 
 virtual uint32 GetFileSize() = 0;
 
 virtual void CreateDirectory() = 0;
 
 virtual bool16 DirIsReadOnly() = 0;
 
 virtual bool16 IsAliasFile() = 0;
 
 virtual ErrorCode ResolveAliasFile(bool16 suppressUI = kTrue) = 0;
 
 virtual bool16 SetFileReadOnly(bool16 readOnly = kTrue) = 0;

 virtual bool16 GetFileVisibility() = 0;

 virtual bool16 SetFileVisibility(bool16 show) = 0; 
};



#endif // __IFILEUTILITY__