ITrapStyleListMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: James Jardee-Borquist
// 
// $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 __ITrapStyleListMgr__
#define __ITrapStyleListMgr__

#if PRAGMA_ONCE
#endif

//#include "IGenStlEdtListMgr.h"

#include "PrintID.h"
#include "K2Vector.h"

class ITrapStyle;
class UIDList;
class RangeProgressBar;

//========================================================================================
// CLASS ITrapStyleListMgr
//========================================================================================
class ITrapStyleListMgr : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ITRAPSTYLELISTMGR };
 
 enum {kInvalidStyleIndex = -1, kNoStyleIndex = 0, kDefaultStyleIndex };
 
 //___________________________________________________________________________________
 // Initialize method
 // NOTE: This hould be called only if the list is empty. If the list is already populated
 // this method will assert and do nothing.
 //___________________________________________________________________________________

 virtual ErrorCode Init (bool16 doCreateBasicStylesOnly = kTrue) = 0;
 
 //___________________________________________________________________________________
 // There are basic accessors
 //___________________________________________________________________________________

 virtual int32 GetNumStyles (void) = 0;

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

 virtual bool32 IsNthStyleEditable (int32 index) = 0;

 virtual bool32 IsNthStyleDeleteable (int32 index) = 0;

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

 virtual int32 GetStyleIndexByUID (UID styleUID) = 0;

 virtual PMString GetUniqueStyleName (PMString& baseName) = 0;
 
 virtual UIDRef GetNthStyleRef (int32 index) = 0;
 
 virtual PMString GetNoStyleName (void) = 0;

 virtual UIDRef GetNoStyleUIDRef (void) = 0;
 
 virtual PMString GetDefaultStyleName (void) = 0;

 virtual UIDRef GetDefaultStyleUIDRef (void) = 0;
 
 virtual int32 GetNumReservedStyles (void) = 0;
 
 //___________________________________________________________________________________
 // These methods process a command to add, copy, delete, and change a style.
 //___________________________________________________________________________________

 virtual ErrorCode SetNthStyleName (int32 index, PMString& name) = 0;

 virtual ErrorCode AddStyle (PMString& name, bool16 nameLocked = kFalse, bool16 editLocked = kFalse, bool16 deleteLocked = kFalse) = 0;
 
 virtual ErrorCode CopyNthStyle (int32 srcIndex, PMString& newName) = 0;

 virtual ErrorCode DeleteNthStyle (int32 index) = 0;

 virtual ErrorCode EditNthStyle (int32 index, ITrapStyle* iStyleSetting, bool16 updateLockInfo = kFalse, bool16 nameLocked = kFalse, bool16 editLocked = kFalse, bool16 deleteLocked = kFalse) = 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 ErrorCode ImportStyles (const UIDRef&, RangeProgressBar* = nil) = 0;

 virtual ErrorCode ExportStyles (const UIDRef&, K2Vector<int32>& indexList, RangeProgressBar* = nil) = 0;
 
 //___________________________________________________________________________________
 // These methods facilitate application of styles to the document.
 //___________________________________________________________________________________
 
 enum { kExcludeDefault = (1L<<0) };
 enum { kExcludeEditLocked = (1L<<1) };
 enum { kExcludeDeleteLocked = (1L<<2) };

 virtual UIDList GetReferencedStyles (const UIDList& styeList, int32 flag) = 0;
};

#endif // __ITrapStyleListMgr__

// End, ITrapStyleListMgr.h.