ILinkedStoryPlacePrefs Class Reference

#include <ILinkedStoryPlacePrefs.h>

Inheritance diagram for ILinkedStoryPlacePrefs:

Public Types
enum	{ kDefaultIID = IID_ILINKEDSTORYPLACEPREFS }

Public Member Functions
virtual void	SetUpdateLinkWhileSaving (bool16 bUpdate)=0
virtual bool16	GetUpdateLinkWhileSaving () const =0
virtual void	SetShowWarningOnUpdateOfEditedStory (bool16 bWarn)=0
virtual bool16	GetShowWarningOnUpdateOfEditedStory () const =0
virtual void	SetRemoveForcedLineBreaks (bool16 bRemove)=0
virtual bool16	GetRemoveForcedLineBreaks () const =0
virtual void	SetStyleMappingExceptions (bool16 bMapStyles)=0
virtual bool16	GetStyleMappingExceptions () const =0
virtual void	CopyData (const ILinkedStoryPlacePrefs *pCopyFrom)=0
virtual void	SetShowLinkOptionsWhenCreatingLink (bool16 bShow)=0
virtual bool16	GetShowLinkOptionsWhenCreatingLink () 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

Interface used to manage preference used for creating and managing shared content (Linked Text).

Member Function Documentation

virtual void ILinkedStoryPlacePrefs::CopyData ( const ILinkedStoryPlacePrefs *  pCopyFrom )

pure virtual

Method which copies preferences set in input parameter to shared content(Linked Text) preferences.

Parameters

pCopyFrom

[IN] input preferences to copy from.

virtual bool16 ILinkedStoryPlacePrefs::GetRemoveForcedLineBreaks ( ) const

pure virtual

Method to get preference for removing forced line breaks(soft returns) while creating a shared content(Linked Text) story.

Returns

kTrue if remove soft returns is enabled else kFalse.

virtual bool16 ILinkedStoryPlacePrefs::GetShowLinkOptionsWhenCreatingLink ( ) const

pure virtual

Method to get preference for showing link options when creating linked page items.

Returns

kTrue if link options will be shown while creating link else kFalse.

virtual bool16 ILinkedStoryPlacePrefs::GetShowWarningOnUpdateOfEditedStory ( ) const

pure virtual

Method to get preference for showing warning on update of edited shared content(Linked Text) story.

Returns

kTrue if warning on update is enabled else kFalse.

virtual bool16 ILinkedStoryPlacePrefs::GetStyleMappingExceptions ( ) const

pure virtual

Method to get preference for Style Mapping (used during link update)

Returns

kTrue if styles mapping is enabled else kFalse.

virtual bool16 ILinkedStoryPlacePrefs::GetUpdateLinkWhileSaving ( ) const

pure virtual

Method to get preference for updating all out of date shared content (Linked Text) links on document save.

Returns

kTrue if update on save is enabled else kFalse.

virtual void ILinkedStoryPlacePrefs::SetRemoveForcedLineBreaks ( bool16  bRemove )

pure virtual

Method to set preference for removing forced line breaks(soft returns) while creating a shared content(Linked Text) story.

Parameters

bRemove

[IN] kTrue if you want to remove soft returns else kFalse.

virtual void ILinkedStoryPlacePrefs::SetShowLinkOptionsWhenCreatingLink ( bool16  bShow )

pure virtual

Method to set preference for showing link options when creating linked page items.

Parameters

bShow

[IN] kTrue if you want to showing link options else kFalse.

virtual void ILinkedStoryPlacePrefs::SetShowWarningOnUpdateOfEditedStory ( bool16  bWarn )

pure virtual

Method to set preference for showing warning on update of edited shared content(Linked Text) story.

Parameters

bWarn

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

virtual void ILinkedStoryPlacePrefs::SetStyleMappingExceptions ( bool16  bMapStyles )

pure virtual

Method to set preference for Style Mapping (used during link update)

Parameters

bMapStyles

[IN] kTrue if you want to map styles during link update else kFalse.

virtual void ILinkedStoryPlacePrefs::SetUpdateLinkWhileSaving ( bool16  bUpdate )

pure virtual

Method to set preference for updating all out of date shared content (Linked Text) links on document save.

Parameters

bUpdate

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