IKBSCSetsManager.h

//========================================================================================
// 
// $File$
// 
// Owner: Michel hutinel
// 
// $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 __IKBSCSetsManager__
#define __IKBSCSetsManager__

#ifdef ID_DEPRECATED

#include "IPMUnknown.h"
#include "KBSCEditorDlgID.h"
#include "WidgetDefs.h"

#include "PMString.h"


#define kKBSCInvalidSetIndex -1
#define kKBSCDefaultSetIndex 0

#define kKBSCNameMaxCharLength kPMNamedItemMaxChars

class IKBSCSetsManager : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IKBSCSETSMANAGER };

 typedef enum { kDefaultKBSCArea = 0, kUserKBSCArea = 1 } KBSCArea;

 virtual bool16 ReadSetFiles() = 0;
 
 virtual bool16 SaveCurrentSetFile() = 0;
 
 virtual PMString GetCurrentSetName() = 0;

 virtual IKBSCSetsManager::KBSCArea GetCurrentSetKBSCArea() = 0;

 virtual bool16 SwitchToSet(const PMString& setName, KBSCArea area) const = 0;

 virtual bool16 SwitchToSet(const int32 index, KBSCArea area) const = 0;

 virtual int32 GetNumSets(KBSCArea area) const = 0;

 virtual PMString GetSetName(const int32 index, KBSCArea area) const = 0;
 
 virtual int32 GetSetIndex(const PMString& setName, KBSCArea area) const = 0;

 virtual bool16 IsSetEditable(const int32 index, KBSCArea area) const = 0;

 virtual bool16 IsSetEditable(const PMString& setName, KBSCArea area) const = 0;
 
 virtual bool16 IsSetDirty(const int32 index, KBSCArea area) const = 0;

 virtual bool16 IsSetDirty(const PMString& setName, KBSCArea area) const = 0;

 virtual void DirtySet(const int32 index, KBSCArea area) = 0;

 virtual void DirtySet(const PMString& setName, KBSCArea area) = 0;

 virtual bool16 DuplicateSet(const PMString& origName, KBSCArea origArea, const PMString& destName, bool16 desEditable) = 0;

 virtual bool16 DeleteSet(const PMString& setName) = 0;

 virtual bool16 EqualSetNames(const PMString& name1, const PMString& name2) = 0;

 virtual bool16 GetKBSCDirectory(IDFile& folderFileSpec, KBSCArea area) = 0;
};

#endif

#endif
 // __IKBSCSetsManager__