ILinkedPageItemPrefs Class Reference

#include <ILinkedPageItemPrefs.h>

Inheritance diagram for ILinkedPageItemPrefs:

Public Types
enum	{ kDefaultIID = IID_ILINKEDPAGEITEMPREFS }

Public Member Functions
virtual void	Clear ()=0
virtual void	CopyData (const ILinkedPageItemPrefs *pCopyFrom)=0
virtual void	AddInterfaceIDToOverride (PMIID id)=0
virtual void	RemoveInterfaceIDToOverride (PMIID id)=0
virtual int32	CountOverridenInterfaceID () const =0
virtual PMIID	GetInterfaceID (int32 n) const =0
virtual bool16	IsInterfaceIDAdded (PMIID id) const =0
virtual void	SetUpdateLinkWhileSaving (bool16 bUpdate)=0
virtual bool16	GetUpdateLinkWhileSaving () const =0
virtual void	SetShowWarningOnUpdateOfEditedPageItem (bool16 bWarn)=0
virtual bool16	GetShowWarningOnUpdateOfEditedPageItem () 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

Data interface that stores the linked page items preferences.

Member Function Documentation

virtual void ILinkedPageItemPrefs::AddInterfaceIDToOverride ( PMIID  id )

pure virtual

ILinkedPageItemPrefs maintains a list of PMIID's which are need to be overriden while updation of page item Link

Below are the API's to add, Remove & count PMIID's in the list.Add an interface ID to the list, if it does not already exists.

Parameters

id	PMIID to add.

virtual void ILinkedPageItemPrefs::Clear ( )

pure virtual

Clear the preferences. Set to default.

virtual int32 ILinkedPageItemPrefs::CountOverridenInterfaceID ( ) const

pure virtual

Return the number of PMIIDs in the list.

Returns

the number of PMIIDs.

virtual PMIID ILinkedPageItemPrefs::GetInterfaceID ( int32  n ) const

pure virtual

Return the nth interface ID.

Returns

The interfaceID

virtual bool16 ILinkedPageItemPrefs::GetShowWarningOnUpdateOfEditedPageItem ( ) const

pure virtual

Method to get preference for showing warning on update of edited page item links.

Returns

kTrue if warning on update is enabled else kFalse.

virtual bool16 ILinkedPageItemPrefs::GetUpdateLinkWhileSaving ( ) const

pure virtual

Method to get preference for updating all out of date page item links on document save.

Returns

kTrue if update on save is enabled else kFalse.

virtual bool16 ILinkedPageItemPrefs::IsInterfaceIDAdded ( PMIID  id ) const

pure virtual

Return whether a given interface ID exists in the list or not.

Returns

kTrue if id exists in the list, else return kFalse.

virtual void ILinkedPageItemPrefs::RemoveInterfaceIDToOverride ( PMIID  id )

pure virtual

Remove an interface ID from the list, if it exists.

Parameters

id	PMIID to remove.

virtual void ILinkedPageItemPrefs::SetShowWarningOnUpdateOfEditedPageItem ( bool16  bWarn )

pure virtual

Method to set preference for showing warning on update of edited page item links.

Parameters

bWarn

[IN] kTrue if you want to show warning else kFalse.

virtual void ILinkedPageItemPrefs::SetUpdateLinkWhileSaving ( bool16  bUpdate )

pure virtual

Method to set preference for updating all out of date page item links on document save.

Parameters

bUpdate

[IN] kTrue if you want update on save else kFalse.