ISnipRunParameterUtils.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 _ISnipRunParameterUtils_
#define _ISnipRunParameterUtils_

class PMString;

class ISnipRunParameterUtils : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_ISNIPRUNPARAMETERUTILS };

 virtual PMString GetPMString(const PMString& prompt, const PMString& defaultValue = "") const = 0;

 virtual int32 GetInt32(const PMString& prompt, const int32 defaultValue = 0, const int32 lowerLimit = 0, const int32 upperLimit = 0) const = 0;

 virtual PMReal GetPMReal(const PMString& prompt, const PMReal& defaultValue = 0, const PMReal& lowerLimit = 0, const PMReal& upperLimit = 0) const = 0;

 virtual int32 GetChoice(const PMString& prompt, const K2Vector<PMString>& choices, const int32 defaultChoiceIndex = 0) const = 0;

 virtual bool16 WasDialogCancelled() const = 0;

 public:
 // The methods in this section are for the use of the SnippetRunner framework
 // and should be avoided.

 virtual void EnableDialog(const bool16 enable) = 0;
 
 virtual bool16 IsDialogEnabled() const = 0;

 virtual void EnableTranslation(const bool16 enable) = 0;
 
 virtual bool16 IsTranslationEnabled() const = 0;

 virtual void SetParameters(const PMString& params) = 0;

 virtual PMString GetParameters() = 0;

};

#endif // _ISnipRunParameterUtils_