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

Public Types

enum  { kDefaultIID = IID_ISHAREDCONTENTFACADE }
 
enum  LinkPageItemOption {
  kPIUpdateOnSave, kPIWarnOnUpdateOfEditedPageItem, kPIStyleMappingExceptions, kPIPathgeometryOverride,
  kPIGraphicAttributesOverride, kPIInteractiveAttributesOverride, kPIContentOverride, kPIOtherAttributesOverride
}
 
enum  LinkStoryOption { kUpdateOnSave, kWarnOnUpdateOfEditedStory, kRemoveForcedLineBreaks, kMapStyles }
 

Public Member Functions

virtual ErrorCode CreateSharedContentLink (const UIDRef &sourceRef, const UIDRef &targetRef, UID &outLinkUID) const =0
 
virtual bool16 CanCreateSharedContentLink (const UIDRef &sourceRef, const UIDRef &targetRef) const =0
 
virtual UIDRef GetLinkForSharedContentLinkObject (const UIDRef &linkObj) const =0
 
virtual UIDRef GetResourceObjectForSharedContentLink (const UIDRef &linkResourceRef, const URI &linkedContentURI) const =0
 
virtual bool16 IsSharedContentLink (const ILink *link) const =0
 
virtual bool16 IsSharedContentInternalLink (const ILink *link) const =0
 
virtual bool16 IsSharedContentExternalLink (const ILink *link) const =0
 
virtual bool16 IsSharedContentLinkResource (const ILinkResource *linkResource) const =0
 
virtual bool16 IsSharedContentExternalLinkResource (const ILinkResource *linkResource) const =0
 
virtual bool16 IsSharedStoryLinkObject (const UIDRef &textModelRef) const =0
 
virtual bool16 IsSharedPageItemLinkObject (const UIDRef &pageItemRef) const =0
 
virtual bool16 IsSharedPageItemLink (const ILink *link) const =0
 
virtual bool16 IsSharedStoryLink (const ILink *link) const =0
 
virtual bool16 IsSharedPageItemLinkResource (const ILinkResource *linkResource) const =0
 
virtual bool16 IsSharedStoryLinkResource (const ILinkResource *linkResource) const =0
 
virtual bool16 IsSharedPageItemOptionSet (ILink *link, LinkPageItemOption option) const =0
 
virtual bool16 IsSharedStoryOptionSet (ILink *link, LinkStoryOption option)=0
 
virtual bool16 IsSharedStoryOptionSet (const UIDRef &textModel, LinkStoryOption option)=0
 
virtual ErrorCode CopySharedPageItemOptions (const UIDRef &sourceRef, const UIDRef &targetRef)=0
 
virtual ErrorCode CopySharedStoryOptions (const UIDRef &sourceModel, const UIDRef &targetModel)=0
 
virtual ErrorCode SetSharedStoryOption (const UIDRef &textModel, LinkStoryOption option, const bool16 newValue)=0
 
virtual ErrorCode SetSharedPageItemOption (const UIDRef &pageItem, LinkPageItemOption option, const bool16 newValue)=0
 
virtual UIDRef GetResourceObjectForSharedStoryLink (const UIDRef &linkRef) const =0
 
virtual bool16 ContainsSharedStoryLink (const UIDList &linkList) 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
 

Member Enumeration Documentation

enum Facade::ISharedContentFacade::LinkPageItemOption

Link Options available for page item Links

enum Facade::ISharedContentFacade::LinkStoryOption

Link Options available for Story Links

Member Function Documentation

virtual bool16 Facade::ISharedContentFacade::CanCreateSharedContentLink (const UIDRef & sourceRef,
const UIDRef & targetRef 
) const
pure virtual

Return kTrue is a shared content link can be created between two existing (already placed) objects.

Parameters
sourceRef[IN] the source object for the content being shared.
targetRef[IN] the target object for the shared content.
Returns
kTrue if a shared content link can be created betrween these two objects, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::ContainsSharedStoryLink (const UIDList & linkList) const
pure virtual

Internal Use. Used by LinksUI project. Checks if atleast one Shared Content link exists in the list of Link UIDs passed..

Parameters
linkList[IN] list of Link UIDs to be checked.
Returns
kTrue if atleast one Shared Content link is found
virtual ErrorCode Facade::ISharedContentFacade::CopySharedPageItemOptions (const UIDRef & sourceRef,
const UIDRef & targetRef 
)
pure virtual

Copies link options from source page item to target page item.

Parameters
sourceRef[IN] the source object from which options have to be copied.
targetRef[IN] the target object to which options will be copied.
virtual ErrorCode Facade::ISharedContentFacade::CopySharedStoryOptions (const UIDRef & sourceModel,
const UIDRef & targetModel 
)
pure virtual

Copies link options from source Text model to target text Model

Parameters
sourceModel[IN] the source text model from which options have to be copied.
targetModel[IN] the target text model to which options will be copied.
virtual ErrorCode Facade::ISharedContentFacade::CreateSharedContentLink (const UIDRef & sourceRef,
const UIDRef & targetRef,
UID & outLinkUID 
) const
pure virtual

Creates a Shared Content link between two existing (already placed) objects.

Parameters
sourceRef[IN] the source object for the content being shared.
targetRef[IN] the target object for the shared content.
outLinkUID[OUT] the link UID of the ILink object in target database.
Returns
kSuccess if link gets created.
virtual UIDRef Facade::ISharedContentFacade::GetLinkForSharedContentLinkObject (const UIDRef & linkObj) const
pure virtual

Returns the ILink UIDRef of Shared Content link object passed.

Parameters
linkObj[IN] UIDRef of the link object.
Returns
UIDRef of the ILink, if found. Invalid UIDRef otherwise
virtual UIDRef Facade::ISharedContentFacade::GetResourceObjectForSharedContentLink (const UIDRef & linkResourceRef,
const URI & linkedContentURI 
) const
pure virtual

Returns the UIDRef of Resource Object for the link given its URI and Link Resource.

Parameters
linkResourceRef[IN] UIDRef of the link resource.
linkedContentURI[IN] URI of the link.
Returns
UIDRef of the Resource Object
virtual UIDRef Facade::ISharedContentFacade::GetResourceObjectForSharedStoryLink (const UIDRef & linkRef) const
pure virtual

Internal Use. Used by LinksUI project. Returns the UIDRef of Resource Object for the link

Parameters
linkRef[IN] the UIDRef of the link.
Returns
UIDRef of the Resource Object
virtual bool16 Facade::ISharedContentFacade::IsSharedContentExternalLink (const ILink * link) const
pure virtual

Checks if the link is a shared content external link. (external link mean across document link)

Parameters
link[IN] the link to be checked.
Returns
kTrue if it is a Shared Content external link, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::IsSharedContentExternalLinkResource (const ILinkResource * linkResource) const
pure virtual

Checks if the link is a shared content external link resource. (external link mean across document link)

Parameters
linkResource[IN] the link resource to be checked.
Returns
kTrue if it is a Shared Content external link, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::IsSharedContentInternalLink (const ILink * link) const
pure virtual

Checks if the link is a shared content internal link (internal links mean link within same file).

Parameters
link[IN] the link to be checked.
Returns
kTrue if it is a Shared Content internal link, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::IsSharedContentLink (const ILink * link) const
pure virtual

Checks if the link is a shared content link.

Parameters
link[IN] the link to be checked.
Returns
kTrue if it is a Shared Content link, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::IsSharedContentLinkResource (const ILinkResource * linkResource) const
pure virtual

Checks if the link is a shared content link resource.

Parameters
linkResource[IN] the link resource to be checked.
Returns
kTrue if it is a Shared Content link resource, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::IsSharedPageItemLink (const ILink * link) const
pure virtual

Checks if the link is a shared Article link.

Parameters
link[IN] the link to be checked.
Returns
kTrue if it is a Shared Article link, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::IsSharedPageItemLinkObject (const UIDRef & pageItemRef) const
pure virtual

Checks whether this particular object is a page item link object

Parameters
pageItemRef[IN] the page item reference.
virtual bool16 Facade::ISharedContentFacade::IsSharedPageItemLinkResource (const ILinkResource * linkResource) const
pure virtual

Checks if the link resource is a shared Article link.

Parameters
linkResource[IN] the link resource to be checked.
Returns
kTrue if it is a Shared Article link, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::IsSharedPageItemOptionSet (ILink * link,
LinkPageItemOption option 
) const
pure virtual

Returns true if a particular option ( parameter ) is turned on for the link.

Parameters
link[IN] the link to be checked.
option[IN] which option to be checked.
virtual bool16 Facade::ISharedContentFacade::IsSharedStoryLink (const ILink * link) const
pure virtual

Checks if the link is a shared story link.

Parameters
link[IN] the link to be checked.
Returns
kTrue if it is a Shared story link, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::IsSharedStoryLinkObject (const UIDRef & textModelRef) const
pure virtual

Checks whether this particular text model is a story link object

Parameters
textModelRef[IN] the text model reference.
virtual bool16 Facade::ISharedContentFacade::IsSharedStoryLinkResource (const ILinkResource * linkResource) const
pure virtual

Checks if the link resource is a shared story link resource.

Parameters
linkResource[IN] the link resource to be checked.
Returns
kTrue if it is a Shared story link, kFalse otherwise.
virtual bool16 Facade::ISharedContentFacade::IsSharedStoryOptionSet (ILink * link,
LinkStoryOption option 
)
pure virtual

Returns true if a particular option ( parameter ) is turned on for the Story link.

Parameters
link[IN] the link to be checked.
option[IN] which option to be get status of.
virtual bool16 Facade::ISharedContentFacade::IsSharedStoryOptionSet (const UIDRef & textModel,
LinkStoryOption option 
)
pure virtual

Returns true if a particular option ( parameter ) is turned on for the Story link object.

Parameters
textModel[IN] the target object for the shared content.
option[IN] which option to be get status of.
virtual ErrorCode Facade::ISharedContentFacade::SetSharedPageItemOption (const UIDRef & pageItem,
LinkPageItemOption option,
const bool16 newValue 
)
pure virtual

Sets the link option on the page item

Parameters
pageItem[IN] the target object for the shared content.
option[IN] which option to be set
newValue[IN] the new value of the option.
Returns
kSuccess if option was successfully set.
virtual ErrorCode Facade::ISharedContentFacade::SetSharedStoryOption (const UIDRef & textModel,
LinkStoryOption option,
const bool16 newValue 
)
pure virtual

Sets the link option on the story

Parameters
textModel[IN] the target object for the shared content.
option[IN] which option to be set
newValue[IN] the new value of the option.
Returns
kSuccess if option was successfully set.