InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ILinkedStoryPlacePrefsData Class Referenceabstract
Inheritance diagram for ILinkedStoryPlacePrefsData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILINKEDSTORYPLACEPREFSDATA }
 
enum  OptionState { kValueNotSet = 0, kValueSet, kValueMixed }
 

Public Member Functions

virtual void SetUpdateLinkWhileSaving (bool16 bUpdate)=0
 
virtual bool16 GetUpdateLinkWhileSaving () const =0
 
virtual OptionState GetUpdateLinkWhileSavingState () const =0
 
virtual void SetStyleMappingExceptions (bool16 bUpdate)=0
 
virtual bool16 GetStyleMappingExceptions () const =0
 
virtual OptionState GetStyleMappingExceptionsState () const =0
 
virtual void SetShowWarningOnUpdateOfEditedStory (bool16 bWarn)=0
 
virtual bool16 GetShowWarningOnUpdateOfEditedStory () const =0
 
virtual OptionState GetShowWarningOnUpdateOfEditedStoryState () const =0
 
virtual void SetRemoveForcedLineBreaks (bool16 bRemove)=0
 
virtual bool16 GetRemoveForcedLineBreaks () const =0
 
virtual OptionState GetRemoveForcedLineBreaksState () const =0
 
virtual void SetShowLinkOptionsWhenCreatingLink (bool16 bShow)=0
 
virtual bool16 GetShowLinkOptionsWhenCreatingLink () const =0
 
virtual OptionState GetShowLinkOptionsWhenCreatingLinkState () const =0
 
virtual void CopyData (const ILinkedStoryPlacePrefsData *pCopyFrom)=0
 
virtual void CopyPrefs (const ILinkedStoryPlacePrefs *pCopyFrom)=0
 
virtual void ResetState ()=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknown * QueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual void ILinkedStoryPlacePrefsData::CopyData (const ILinkedStoryPlacePrefsData * pCopyFrom)
pure virtual

Method which copies ILinkedStoryPlacePrefsData in input parameter to ILinkedStoryPlacePrefsData on which this method is called.

Parameters
pCopyFrom[IN] input to copy from.
virtual void ILinkedStoryPlacePrefsData::CopyPrefs (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 ILinkedStoryPlacePrefsData::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 OptionState ILinkedStoryPlacePrefsData::GetRemoveForcedLineBreaksState () const
pure virtual

Method to know whether preference for removing forced line breaks(soft returns) while creating a shared content(Linked Text) story is meaningful or not.

Returns
kValueMixed if this preference is different across selections. kValueSet if it's same across selection & is also set else kValueNotSet.
virtual bool16 ILinkedStoryPlacePrefsData::GetShowLinkOptionsWhenCreatingLink () const
pure virtual

Method to get preference for showing dialog while creating a shared content(Linked Text) story.

Returns
kTrue if remove soft returns is enabled else kFalse.
virtual OptionState ILinkedStoryPlacePrefsData::GetShowLinkOptionsWhenCreatingLinkState () const
pure virtual

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

Returns
kTrue if link options will be shown while creating link else kFalse.
virtual bool16 ILinkedStoryPlacePrefsData::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 OptionState ILinkedStoryPlacePrefsData::GetShowWarningOnUpdateOfEditedStoryState () const
pure virtual

Method to know whether preference for showing warning on update of edited shared content(Linked Text) story is meaningful or not.

Returns
kValueMixed if this preference is different across selections. kValueSet if it's same across selection & is also set else kValueNotSet.
virtual bool16 ILinkedStoryPlacePrefsData::GetStyleMappingExceptions () const
pure virtual

Method to get preference for setting style mapping exceptions.

Returns
kTrue if style mapping exceptions are set.
virtual OptionState ILinkedStoryPlacePrefsData::GetStyleMappingExceptionsState () const
pure virtual

Method to know whether preference for setting style mapping exceptions is meaningful or not.

Returns
kValueMixed if this preference is different across selections. kValueSet if it's same across selection & is also set else kValueNotSet.
virtual bool16 ILinkedStoryPlacePrefsData::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 OptionState ILinkedStoryPlacePrefsData::GetUpdateLinkWhileSavingState () const
pure virtual

Method to know whether preference for updating all out of date shared content (Linked Text) links on document save is meaningful or not.

Returns
kValueMixed if this preference is different across selections. kValueSet if it's same across selection & is also set else kValueNotSet.
virtual void ILinkedStoryPlacePrefsData::ResetState ()
pure virtual

Method to set shared content(Linked Text) preferences to default value.

virtual void ILinkedStoryPlacePrefsData::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 ILinkedStoryPlacePrefsData::SetShowLinkOptionsWhenCreatingLink (bool16 bShow)
pure virtual

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

Parameters
bShow[IN] kTrue if you want to showing link options else kFalse.
virtual void ILinkedStoryPlacePrefsData::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 ILinkedStoryPlacePrefsData::SetStyleMappingExceptions (bool16 bUpdate)
pure virtual

Method to set preference for setting style mapping exceptions, is set.

Parameters
bUpdate[IN] kTrue if you want to set style mapping exceptions.
virtual void ILinkedStoryPlacePrefsData::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.