SDKFileHelper.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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 __SDKFileHelper_H_DEFINED__
#define __SDKFileHelper_H_DEFINED__

#include "IOpenFileCmdData.h"
#include "SysFileList.h"
class IOpenManager;
class IImportManagerOptions;
class IImportManager;

class SDKFileHelper {

friend class SDKFileHelperUnitTest;

public:


 SDKFileHelper(const PMString& path);

 SDKFileHelper(const IDFile& file);

 virtual ~SDKFileHelper();
 
 bool16 IsExisting() const;

 bool16 IsChosen() const;

 PMString GetPath() const;

 IDFile GetIDFile() const;

 IDFile GetAbsoluteFromRelative(const PMString& relativePath) const;
 
 PMString GetParentFolderAsString() const;
 
 static bool16 isMacPosixPathEnabled();
 
protected:
 SDKFileHelper();
 

 void initFromString();


 void initFromSysFile();


 void traceInitializeDiagnostics(int32 e) const;
 
 PMString calcDefaultFileName() const;
 
 void setChosen(bool16 chsen);
 
 void setIDFile(const IDFile& file);

 void setPath(const PMString& path);

 PMString absoluteFromRelative(const PMString& folder, const PMString& path) const;
 
 
 bool16 isAbsolutePath(const PMString& path) const;
 
 bool16 isUnixPath(const PMString& path) const;

 bool16 isMacPath(const PMString& path) const;

 bool16 isWinPath(const PMString& path) const;

 PMString getMinusLastElement(const PMString& path) const;

 PMString getMinusFirstElement(const PMString& path) const;
 
 PMString getAsMacPath(const PMString& path) const;

 PMString getAsWinPath(const PMString& path) const;

private:
 PMString fPath;
 IDFile fSysFile;
 bool16 fChosen;
};


class SDKFileOpenChooser : public SDKFileHelper {
public:

 SDKFileOpenChooser();
 
 virtual ~SDKFileOpenChooser();

 void AddFilter(const FileTypeInfoID& fileTypeInfoID, const PMString& filterName);
 
 void AddFilter(const SysOSType& macFileType, const PMString& extension, const PMString& filterName);
 
 void AddAllFiles();
 
 void SetTitle(const PMString& title);
 
 void ShowDialog();

protected:
 class Filter {
 public:
 typedef object_type data_type; 
 public:
 Filter(const SysOSType& macFileType, 
 const PMString& extension, 
 const PMString& filterName);
 virtual ~Filter();
 SysOSType fMacFileType;
 PMString fExtension;
 PMString fFilterName; 
 };

 typedef K2Vector<Filter> Filters;

 Filters fFilters;
 PMString fTitle;
 bool16 fIsAllFilesEnabled;
 IOpenFileCmdData::OpenFlags fOpenFlags;
};

class SDKFileDocumentChooser : public SDKFileHelper {
public:

 SDKFileDocumentChooser();
 
 virtual ~SDKFileDocumentChooser();
 
 void ShowDialog();
 
 IOpenFileCmdData::OpenFlags GetOpenFlags();

 IOpenManager* QueryOpenManager();

private:
 IOpenFileCmdData::OpenFlags fOpenFlags;
};

class SDKFileSaveChooser : public SDKFileHelper {
public:
 SDKFileSaveChooser();
 
 virtual ~SDKFileSaveChooser();
 
 void AddFilter(const FileTypeInfoID& fileTypeInfoID, const PMString& filterName);

 void AddFilter(const SysOSType& macFileCreator, const SysOSType& macFileType, const PMString& extension, const PMString& filterName);
 
 void SetTitle(const PMString& title);
 
 void SetFilename(const PMString& filename);

 int32 GetFilterIndex();

 void ShowDialog();

private:
 class Filter {
 public:
 typedef object_type data_type; 
 public:
 Filter(const SysOSType& macFileCreator, 
 const SysOSType& macFileType, 
 const PMString& extension, 
 const PMString& filterName);
 virtual ~Filter();
 SysOSType fMacFileCreator;
 SysOSType fMacFileType;
 PMString fExtension;
 PMString fFilterName; 
 };

 typedef K2Vector<Filter> Filters;

private:

 Filters fFilters;
 PMString fTitle;
 PMString fFilename;
 int32 fFilterIndex;
};

class SDKFilePlaceChooser : public SDKFileHelper {
public:
 SDKFilePlaceChooser();
 virtual ~SDKFilePlaceChooser();

public:
 void ShowDialog();

public:
 // Mutators for the place file dialog options.

 void SetShowFilterPrefs(bool16 showFilterPrefs);
 
 void SetRetainFormat(bool16 retainFormat);
 
 void SetConvertQuotes(bool16 convertQuotes);

 void SetReplaceSelectedItem(bool16 replaceSelectedItem);
 
 void SetApplyCJKGrid(bool16 applyGrid);
 
 void SetShowPreview(bool16 showPreview);

public:
 // Accessors for the place file dialog options.

 bool16 GetShowFilterPrefs() const;
 
 bool16 GetRetainFormat() const;
 
 bool16 GetConvertQuotes() const; 
 
 bool16 GetReplaceSelectedItem() const;
 
 bool16 GetApplyCJKGrid() const;
 
 bool16 GetShowPreview() const;

protected:
 IImportManager* queryImportManager();

 IImportManagerOptions* queryImportManagerOptions();

private:
 // IImportManagerOptions cached by this object so that the caller
 // can set the options before the dialog is opened and find out the
 // options the user specified once the dialog is dismissed.
 bool16 fShowFilterPrefs;
 bool16 fRetainFormat;
 bool16 fConvertQuotes; 
 bool16 fReplaceSelectedItem;
 bool16 fApplyCJKGrid;
 bool16 fShowPreview;
};

class SDKFolderChooser : public SDKFileHelper {
public:
 SDKFolderChooser();

 virtual ~SDKFolderChooser();

 void ShowDialog();

 void SetTitle(const PMString& title);

protected:
 void initFromSysFile();

private:
 PMString fTitle;

};

class SDKFileOpenMultipleFileChooser : public SDKFileOpenChooser {

public:
 
 void ShowDialog();

 int32 GetFileCount() const;

 IDFile* GetNthFile(int32 n) const;

private: 
 SysFileList fFileList; 
};

#endif // __SDKFile_H_DEFINED__


// Code generated by DollyXS code generator