IGenStlEdtListMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Phillips
// 
// $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 __IGenStlEdtListMgr__
#define __IGenStlEdtListMgr__

#include "K2Vector.h"
#include "UIDList.h"
#include "DBUtils.h"

class IGenStlEdtListMgr : public IPMUnknown

{ 
public:

 virtual int32 GetNumStyles() = 0;

 virtual ErrorCode GetNthStyleName(int32 index, PMString *pName) = 0;

 virtual ErrorCode GetNthStyleDescription(int32 index, PMString *pDesc) = 0;

 virtual bool32 IsNthStyleEditable(int32 index) = 0;

 virtual bool32 IsNthStyleDeleteable(int32 index) = 0;

 virtual int32 GetStyleIndexByName(const PMString& pName) = 0;

 typedef enum
 {
 kDialogTitle, // Title of the Edit Style dialog, def = "Define Styles"
 kStyleListTitle, // String appearing above list; def = "Styles:"
 kNewStyleNameTitle, // Title of new-style name dlg; def = "New Style"
 kRenameStyleTitle, // Title of rename-style name dlg; def = "Rename Style"
 kNameConflictPrompt, // Prompt when a name conflicts
 kNameRequiredPrompt, // Prompt when user enters blank name
 kImportTitle, // Title of import dialog
 kExportTitle, // Title of export dialog
 kExportFileClassName, // Name of export document type, e.g., "Style File"
 kExportDefaultFileName, // Name of export document, e.g., "Exported Printer Styles"
 kAlertCannotLoadStyles, // Error to display when file isn't of right type.
 kNameReservedPrompt, // Prompt when a user enters a reserved name (i.e., "[Custom]")
 kLastGenStlEdtUIStringID
 } GenStlEdtUIStringID;
 
 virtual bool32 GetUIString(GenStlEdtUIStringID whichString, PMString *pName) = 0;
 
 virtual ClassID GetExportFileRootBossClassID() = 0;
 
 virtual void GetExportFileCreatorAndType(OSType *pCreator, OSType *pType) = 0;
 
 virtual void GetImportExportFileMagicByte(DBUtils::MagicBytes magicBytes) = 0;

 virtual void GetExportFileExtension(PMString *pExt) = 0;
 
 virtual bool32 CustomImport(const IDFile* theFile) = 0;

 virtual bool32 CustomExport(const IDFile* theFile, K2Vector<int32>& indexList) = 0;

 virtual ErrorCode ImportStyles(UIDRef uidrefFrom) = 0;
 
 virtual ErrorCode ExportStyles(UIDRef uidrefTo, K2Vector<int32>& indexList) = 0;

 virtual ErrorCode SetNthStyleName(int32 index, PMString& name) = 0;
 
 virtual PMString GetUniqueStyleName(PMString& baseName) = 0;
 
 virtual ErrorCode AddStyle(PMString& name) = 0;
 
 virtual ErrorCode CopyNthStyle(int32 srcIndex, PMString& newName) = 0;
 
 virtual ErrorCode DeleteNthStyle(int32 index) = 0;
 
 virtual bool32 EditNthStyle(int32 index, bool16 bNew) = 0;

 virtual void ListInsert(UID uid, int32 index = -1) = 0;

 virtual void ListRemove(int32 index) = 0;

 virtual void ListReplace(UID uid, int32 index) = 0;

 virtual ErrorCode CopyStyleData(UIDRef srcStyle, UIDRef dstStyle) = 0;

 virtual UIDRef GetNthStyleRef(int32 index) = 0;

 virtual ErrorCode InvokeNthStyle(int32 index, bool32 displayUI = kTrue) = 0;

 virtual bool16 ReferencesFlattenerStyle() = 0;

 virtual UIDRef GetReferencedFlattenerStyle( int32 nIndex ) = 0;

 virtual PMString GetFlattenerStyleName( int32 nIndex ) = 0;

 virtual void SetFlattenerStyleName( int32 nIndex, const PMString& strName ) = 0;

 virtual bool16 EnabledInNoPubState() = 0;

};

#endif // __IGenStlEdtListMgr__