ISnipRunSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Adobe Developer Technologies
// 
// $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 __ISNIPRUNSUITE__
#define __ISNIPRUNSUITE__

#include "IPMUnknown.h"

class PMString;

class ISnipRunSuite : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISNIPRUNSUITE };

 typedef enum { 
 kSnpRunNoContext,

 kSnpRunWorkspaceContext, 
 kSnpRunFrontDocContext, 
 kSnpRunLayoutTargetContext, 
 kSnpRunTextTargetContext, 
 kSnpRunTextSelectionTargetContext, 
 kSnpRunTableTargetContext,

 kSnpRunCustomContext} eSnpRunContextType;

 typedef PMString SnippetName;

 typedef K2Vector<SnippetName> SnippetNames;

 typedef PMString Category;

 typedef K2Vector<Category> Categories;

 virtual void GetSnippetNames(SnippetNames& snippetNames) const = 0;

 virtual bool16 IsRegistered(const SnippetName& snippetName) const = 0;

 virtual void GetCategories(const SnippetName& snippetName, Categories& categories) const = 0;

 virtual void GetDescription(const SnippetName& snippetName, PMString& description) const = 0;

 virtual void GetPreconditions(const SnippetName& snippetName, PMString& preconditions) const = 0;

 virtual bool16 CanRun(const SnippetName& snippetName) const = 0;

 virtual ErrorCode Run(const SnippetName& snippetName, PMString& parameters, bool16 enableParameterDialog = kFalse) const = 0;

 virtual ErrorCode SetupContext(const SnippetName& snippetName) = 0;

}; 

#endif // __ISNIPRUNSUITE__