#include <ILinkState.h>

Inheritance diagram for ILinkState:

Public Types
enum	{ kDefaultIID = IID_ILINKSTATE }

Public Member Functions
virtual void	ReadWrite (IPMStream *iPMStream, ImplementationID id)=0

virtual bool16	HasChanged ()=0

virtual bool16	IsLinkNeeded ()=0

virtual void	SetHasChanged (bool16 value)=0

virtual void	SetIsLinkNeeded (bool16 value)=0

virtual uint32	GetEmbedSize ()=0

virtual void	SetIsLinkWanted (bool16 value)=0

virtual bool16	IsLinkWanted ()=0

virtual void	SetProviderClass (ClassID id)=0

virtual ClassID	GetProviderClass ()=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 class defines the interface for obtaining or setting link state information.

Member Function Documentation

virtual uint32 ILinkState::GetEmbedSize ( )

pure virtual

Get the size threshold used to determine whether to store the complete image in the publication or to subsample.

Returns: the file size limit for auto-embedding

virtual ClassID ILinkState::GetProviderClass ( )

pure virtual

Get and Set the provider used to import the page item.

Returns: the ClassID of the provider used to import the page item.

virtual bool16 ILinkState::HasChanged ( )

pure virtual

Returns the edit status of the internal data associated with the page item. The link information dialog shows this state in the Edited field. The user is prompted before updating since updating will blow away their changes.

Returns: true when the internal data associated with the page item has been edited.

virtual bool16 ILinkState::IsLinkNeeded ( )

pure virtual

This method is deprecated in CS3. The ILinkResource reports whether the data for the page item is local (cached or embedded). See ILinkResource::GetStoreState.

Returns the status of if the link is necessary or if the internal data keeps all the information necessary for the page item. It is always false for text since all the data is stored internal. When the link is not needed, the user can unlink without storing anything else in the publication.

Returns: false when the external data associated with the page item is not needed.

virtual bool16 ILinkState::IsLinkWanted ( )

pure virtual

Return link wanted state.

Returns: false if the link should not be created with the page item.

virtual void ILinkState::ReadWrite	(	IPMStream *	iPMStream,
		ImplementationID	id
	)

pure virtual

Persistence related method; reads from or writes to given stream

Parameters

iPMStream	[IN] the persistent in and out stream.
id	[IN] the implementation ID

virtual void ILinkState::SetHasChanged ( bool16 value )

pure virtual

Set link changed state.

Parameters

value [IN] set to true if the link has been changed.

virtual void ILinkState::SetIsLinkNeeded ( bool16 value )

pure virtual

Set link needed state.

Parameters

value [IN] set to false if the internal data keeps all the information for the link and the link is not needed.

virtual void ILinkState::SetIsLinkWanted ( bool16 value )

pure virtual

Set link wanted state.

Parameters

value [IN] set to false if you do not want a link created with the page item.

virtual void ILinkState::SetProviderClass ( ClassID id )

pure virtual

Set the provider used to import the page item.

Parameters

id[in]- the ClassID of the provider used to import the page item.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation