IPreflightResultNodeInfo.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 "PackageAndPreflightID.h"
#include "IPreflightResultNodeInfo.h"

class IPreflightResultNodeInfo : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPREFLIGHTRESULTNODEINFO };

 typedef enum
 {
 kInvalid,

 kGeneric,

 kCriteria,

 kStatus,

 kViolation

 } NodeType;

public:

 virtual NodeType GetType() const = 0;

 virtual PMString GetName() const = 0;

 virtual PMString GetDescription() const = 0;

 class DescriptionPair
 {
 public:
 DescriptionPair(const PMString& sLabel, const PMString& sValue) : fLabel(sLabel), fValue(sValue) {}
 typedef object_type data_type;
 PMString fLabel;
 PMString fValue;
 };

 typedef K2Vector<DescriptionPair> DescriptionPairVector;

 virtual void GetDescriptionPairs(DescriptionPairVector& pairs) const = 0;

 virtual PMString GetSortValue() const = 0;

 virtual WideString GetUniqueString() const = 0;

 typedef enum
 {
 kSupportsNothing,

 kSupportsShow,

 kSupportsSelect,
 
 kSupportsShowAndSelect,

 kCantShowRightNow

 } GoToSupport;

 virtual GoToSupport GetGoToSupport(PMString* pFailStr = nil) const = 0;

 virtual bool DoGoTo() const = 0;

 virtual PMString GetPageNumber() const = 0;
};