IPathStrokerUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Greg St. Pierre
// 
// $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.
// 
// 
// ADOBE CONFIDENTIAL
// 
//========================================================================================

#ifndef __IPathStrokerUtils__
#define __IPathStrokerUtils__

#include "InstStrokeFillID.h"
#include "RequestContext.h"
#include "Utils.h"

class IDataBase;
class IDocument;
class IPathStroker;
class IPathStrokerList;
class IGraphicStyleDescriptor;
class IGraphicAttrClassID;
class IGraphicStyleAttributeBossList;
class ICommand;
class IPathStrokerMetadata;
class IDialog;
class IScript;
class IScriptRequestData;
class SortedUIDList;

class IPathStrokerUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPATHSTROKERUTILS };

 virtual uint32 GetPathStrokerCount(IDocument const *document) const = 0;

 virtual IPathStroker *QueryNthPathStroker(IDocument const *document, uint32 index) const = 0;

 virtual IPathStrokerList *QueryPathStrokerList(IDataBase *db) const = 0;

 virtual IPathStrokerList *QueryPathStrokerList(IDocument const *document) const = 0;

 virtual IPathStrokerList *_QueryActivePathStrokerList() const = 0;

 virtual bool16 FindNamedPathStroker(
 IPathStrokerList const *strokerList, 
 PMString const &name, 
 uint32 &index,
 bool16 useTranslatedNames = kTrue
 ) const = 0;

 virtual bool16 FindPathStroker(
 IPathStrokerList const *strokerList, 
 ClassID const &classId, 
 UID const &uid, 
 uint32 &index
 ) const = 0;

 virtual IPathStroker *QueryPathStroker(
 IPathStrokerList const *strokerList, 
 ClassID const &classId, 
 UID const &uid
 ) const = 0;

 virtual IPathStroker *QueryPathStrokerFromGSDesc(
 IPathStrokerList const *strokerList,
 IGraphicStyleDescriptor *gsDesc
 ) const = 0;

 virtual bool16 IsCustomStroker(IPathStroker const *stroker) const = 0;

 virtual bool16 IsCustomStroker(ClassID const &classId, UID const &uid) const = 0;

 virtual PMString GetPathStrokerName(IPathStroker const *stroker, bool16 translateName = kTrue) const = 0;

 virtual PMString GetUniqueStrokerName(
 IPathStrokerList const *list, 
 PMString const &basename
 ) const = 0;

 virtual IPathStrokerMetadata *QueryPathStrokerMetadata(IPathStroker const *stroker) const = 0;

 virtual IPathStrokerMetadata *QueryPathStrokerMetadata(
 IPathStrokerList const *strokerList, 
 ClassID const &classId, 
 UID const &uid
 ) const = 0;

 virtual uint32 GetMetadataCount() const = 0;

 virtual IPathStrokerMetadata *QueryNthMetadata(uint32 index) const = 0;

 virtual IPathStrokerMetadata *QueryPathStrokerMetadataByClass(ClassID const &metadataClass) const = 0;

 virtual IPathStrokerMetadata *QueryPathStrokerMetadataByName(PMString const &name) const = 0;

 virtual bool16 CanStrokerBeDuplicated(
 IPathStrokerList const *strokerList, 
 ClassID const &classId, 
 UID const &uid
 ) const = 0;

 virtual IPathStroker *DuplicatePathStroker(
 IPathStrokerList const *strokerList, 
 ClassID const &classId, 
 UID const &uid, 
 IDataBase *db, 
 bool16 addToList
 ) const = 0;

 virtual IPathStroker *DuplicatePathStroker(
 IPathStroker const *source, 
 IDataBase *db, 
 bool16 addToList
 ) const = 0;

 virtual IPathStroker *NewPathStroker(
 IPathStrokerMetadata const *metadata, 
 IDataBase *db, 
 bool16 addToList
 ) const = 0;

 virtual ErrorCode GetLineStyleUID(UID &uid, IGraphicStyleDescriptor *styleDesc) const = 0;

 virtual IGraphicAttrClassID *CreateLineStyleAttribute(UID const &styleUID) const = 0;

 virtual ErrorCode AddLineStyleAttribute(
 UID const &styleUID, 
 IGraphicStyleAttributeBossList *attributeList
 ) const = 0;

 virtual ICommand *CreateLineStyleCommand(
 UID const &styleUID,
 const UIDList *targetItemList,
 bool16 doPrePost,
 bool16 enableDoNotify
 ) const = 0;

 virtual ErrorCode ReplacePathStrokers(
 UIDList const &strokerList, 
 ClassID const &replaceClass,
 UID const &replaceUID
 ) const = 0;

 virtual void GetReferencedPathStrokers(
 IPathStrokerList const *strokerList, 
 SortedUIDList &refdStrokers
 ) const = 0;

 virtual ErrorCode SetPathStrokerName(IPathStroker *pathStroker, PMString const &name) const = 0;

 virtual ErrorCode DeleteAndReplacePathStroker(
 UIDList const &deleteList, 
 ClassID const &replaceClass, 
 UID const &replaceUID
 ) const = 0;

 enum StrokeStyleImportError
 {
 kErrorSuccess,
 kErrorFileDamaged,
 kFailedToCopyStroke,
 kErrorUnknown
 };

 virtual IPathStrokerUtils::StrokeStyleImportError ImportStyles(
 IDFile const &file, 
 IDataBase *destination
 ) const = 0;

 virtual IPathStrokerUtils::StrokeStyleImportError ExportStyles(
 IDFile const &file, 
 IDataBase *source, 
 UIDList const &styles, 
 SysOSType const &creator, 
 SysOSType const &fileType
 ) const = 0;

 virtual IScript* CreateStrokeStyleScriptObject( const ScriptInfo::RequestContext& context, IScript* parent, const ClassID& clsID ) const = 0 ;

 virtual ErrorCode GetStrokeStyleForGetProperty( IScriptRequestData* data, IScript* script, const ScriptID& propID, IDataBase* db, const ClassID& classID, const UID& uid, bool16 returnName = kFalse ) const = 0 ;

 virtual ErrorCode GetStrokeStyleForSetProperty( const IScriptRequestData* data, const ScriptID& propID, IDataBase*& db, ClassID& classID, UID& uid, bool16 allowNone = kFalse ) const = 0 ;
};

#endif