IPreflightRuleInfo Class Reference

#include <IPreflightRuleInfo.h>

Inheritance diagram for IPreflightRuleInfo:

Public Types
enum	{ kDefaultIID = IID_IPREFLIGHTRULEINFO }
enum	AlertStatus { kDisabled, kInfo, kWarning, kError }

Public Member Functions
virtual void	SetParentProfile (IPreflightProfile *iParent)=0
virtual IPreflightProfile *	QueryParentProfile () const =0
virtual void	SetRuleID (PreflightRuleID ruleID)=0
virtual PreflightRuleID	GetRuleID () const =0
virtual void	SetAlertStatus (AlertStatus newStatus)=0
virtual AlertStatus	GetAlertStatus () const =0
virtual void	SetIsFullPreflightModeOnly (bool isFullOnly)=0
virtual bool	IsFullPreflightModeOnly () const =0
virtual void	SetRuleDescription (const PMString &desc)=0
virtual PMString	GetRuleDescription () const =0
virtual void	SetPluginDescription (const PMString &desc)=0
virtual PMString	GetPluginDescription () const =0
virtual void	CopyFrom (const IPreflightRuleInfo *iSrc)=0
virtual bool	IsEqual (const IPreflightRuleInfo *iOther) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

This interface maintains the high-level information about a rule. Other interfaces on the same boss provide other critical information and functionality.

See Also

IPreflightRuleData which defines the rule's parameters (if any) in a dictionary format.

IPreflightRuleVisitor which is the functional part of the rule, performing checks against document data.

IPreflightRuleUtilities is an interface that provides additional rule services such as life cycle callbacks, duplication, and so on.

Member Enumeration Documentation

enum IPreflightRuleInfo::AlertStatus

Alert status. Note that at this time only kDisabled and kError are used/honored. We may use the other options in a future version of the feature.

Member Function Documentation

virtual void IPreflightRuleInfo::CopyFrom ( const IPreflightRuleInfo *  iSrc )

pure virtual

Utility: copy the settings from another interface (except the parent link).

Parameters

iSrc	IN The source data from which to copy.

virtual AlertStatus IPreflightRuleInfo::GetAlertStatus ( ) const

pure virtual

Get the alert status. At the moment this only uses two values: kDisabled and kError. kDisabled means the rule is not active; kError means it is.

Returns

The current active status of the rule.

virtual PMString IPreflightRuleInfo::GetPluginDescription ( ) const

pure virtual

Get the backup plugin string we'll display if the plugin is missing later.

Returns

The backup plugin description string.

virtual PMString IPreflightRuleInfo::GetRuleDescription ( ) const

pure virtual

Get the backup string we'll display if the plugin is missing later.

Returns

The backup description string.

virtual PreflightRuleID IPreflightRuleInfo::GetRuleID ( ) const

pure virtual

Get the unique ID for this rule.

Returns

The ID.

virtual bool IPreflightRuleInfo::IsEqual ( const IPreflightRuleInfo *  iOther ) const

pure virtual

Determines whether the properties are the same as another (not including the parent link).

Parameters

iOther

IN The other info interface to compare against.

Returns

kTrue if they're equal; kFalse otherwise.

virtual bool IPreflightRuleInfo::IsFullPreflightModeOnly ( ) const

pure virtual

Not currently used but might be in future.

Returns

Full preflight flag.

virtual IPreflightProfile* IPreflightRuleInfo::QueryParentProfile ( ) const

pure virtual

Get the parent profile for this rule.

Returns

The parent profile. This DOES refcount the interface (thus Query).

virtual void IPreflightRuleInfo::SetAlertStatus ( AlertStatus  newStatus )

pure virtual

Set the alert status. At the moment this only uses two values: kDisabled and kError. kDisabled means the rule is not active; kError means it is.

Parameters

newStatus

IN The new status.

virtual void IPreflightRuleInfo::SetIsFullPreflightModeOnly ( bool  isFullOnly )

pure virtual

Not currently used but might be in future.

Parameters

isFullOnly

IN Full preflight flag.

virtual void IPreflightRuleInfo::SetParentProfile ( IPreflightProfile *  iParent )

pure virtual

Establish a link to the parent profile, since we need to walk the tree from time to time.. plus the child needs to be able to tell the parent about changes to the rule and plugin descriptions.

Parameters

iParent

IN The parent. Note that we do NOT refcount this interface to avoid circular references.

virtual void IPreflightRuleInfo::SetPluginDescription ( const PMString &  desc )

pure virtual

Set the backup plugin string we'll display if the plugin is missing later.

Parameters

desc	IN The backup plugin description string.

virtual void IPreflightRuleInfo::SetRuleDescription ( const PMString &  desc )

pure virtual

Set the backup string we'll display if the plugin is missing later.

Parameters

desc	IN The new description.

virtual void IPreflightRuleInfo::SetRuleID ( PreflightRuleID  ruleID )

pure virtual

Set the ID for this rule. The ID is a unique string that identifies the rule. (The string does not appear in the UI anywhere.)

Parameters

ruleID

IN The new ID.