IPreflightRuleUI.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Phillips
// 
// $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.
// 
//========================================================================================


#include "IPMUnknown.h"
#include "PackageAndPreflightUIID.h"
#include "IPreflightRuleData.h"
#include <map>

class IControlView;
class IDataBase;

class IPreflightRuleUI : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPREFLIGHTRULEUI };

public:
 virtual bool HasUI() const = 0;

 virtual IControlView* CreateCustomUI (IDataBase* iUIDataBase) const = 0;

 virtual bool ApplyDataToCustomUI (IControlView* iCustomUI, IPreflightRuleData* iRuleDataToApply) const = 0;

 virtual bool GetDataFromCustomUI (IControlView* iCustomUI, IPreflightRuleData* iRuleData) const = 0;

 virtual PMString GetDataParemeterDescription (const IPreflightRuleData::Key& key) const = 0;

 enum UnitType
 {
 kDefaultUnit = -1,
 kXCoordinate,
 kYCoordinate,
 kPoints,
 kTextUnits,
 kTextSizeUnits,
 kLineUnits,
 
 kPercent,
 kCoordinateGroupWithConstrain,
 kCoordinateGroupNoConstrain,
 
 kEnumerator,

 kStaticText
 };
 virtual UnitType GetDataParemeterUnitType (const IPreflightRuleData::Key& key) const = 0;

 virtual bool GetDataParemeterRange (const IPreflightRuleData::Key& key, ScriptData& maxData, ScriptData& minData) const = 0;

 virtual bool ValidateParameterData (const IPreflightRuleData::Key& key, const ScriptData& newData, PMString& errorString) const = 0;

 virtual bool GetDataParemeterMapping (const IPreflightRuleData::Key& key, ScriptListData& enumData, ScriptListData& stringData) const = 0;
 
 virtual IPreflightRuleData::Key GetDataParamRoot () const = 0;

 virtual void GetDataParamParent (const IPreflightRuleData::Key& key, IPreflightRuleData::Key& keyParent) const = 0;
 
 virtual bool GetDataParamDirectChildren (const IPreflightRuleData::Key& key, std::vector<IPreflightRuleData::Key>& keyList) const = 0;

};