IQuickApplyService.h

//========================================================================================
// 
// $File$
// 
// Owner: Kevin Van Wiel
// 
// $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 __IQuickApplyService__
#define __IQuickApplyService__

#include <list>

#include "IIdleTask.h" // for IdleTimer include
#include "QuickApplyFindListNode.h"

#include "FindChangeID.h"
#include "IPMUnknown.h"

class IActiveContext;
class IEvent;


class QuickApplyItemRecord
{
public:
 PMString fItemUIName;
 
 PMString fPrefixKeyString;
 
 uint32 fItemID;
 
 bool16 fActive;
};

typedef std::list<QuickApplyItemRecord> TypesHandledList;

typedef std::list<uint32> TypesIDList;


class IQuickApplyService : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IQUICKAPPLYSERVICE };
 
 virtual void BeginServiceSession() = 0;
 
 virtual void EndServiceSession() = 0;
 
 virtual TypesHandledList GetItemTypesHandled(const TypesHandledList &existingItemTypes) = 0;

 virtual void LoadItems(IActiveContext *ac, K2Vector<QuickApplyFindListNode> *masterList, IdleTimer *timeCheck, uint32 itemTypeToLoad) = 0;
 
 virtual bool16 LoadItemsIsComplete(uint32 idType) = 0;
 
 virtual bool16 ApplyItem(IActiveContext *ac, const QuickApplyFindListNode &itemToApply, IEvent *e, bool16 edit) = 0;
 
 virtual void ResetProvider() = 0;
};


#endif // __IQuickApplyService__