InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ILinkCaptionPrefs Class Referenceabstract

#include <ILinkCaptionPrefs.h>

Inheritance diagram for ILinkCaptionPrefs:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ILINKCAPTIONPREFS }
 
enum  CaptionAlignment { kAlignAbove, kAlignBelow, kAlignLeft, kAlignRight }
 

Public Member Functions

virtual int32 GetNumCaptionLines () const =0
 
virtual PMString GetNthBeforeString (int32 index) const =0
 
virtual PMString GetNthLinkInfoProviderName (int32 index) const =0
 
virtual PMString GetNthAfterString (int32 index) const =0
 
virtual void ClearAllCaptionLines ()=0
 
virtual void AddNewCaptionLine (const PMString &beforeString, const PMString &linkInfoProviderName, const PMString &afterString)=0
 
virtual void SetFrameOffset (const PMReal &offset)=0
 
virtual PMReal GetFrameOffset () const =0
 
virtual void SetCaptionParagraphStyleUID (UID styleUID)=0
 
virtual UID GetCaptionParagraphStyleUID () const =0
 
virtual void SetGroupCaptionWithImage (bool shouldGroup)=0
 
virtual bool GetGroupCaptionWithImage () const =0
 
virtual void SetCaptionLayerName (const PMString &layerName)=0
 
virtual PMString GetCaptionLayerName () const =0
 
virtual void SetCaptionAlignment (CaptionAlignment newAlign)=0
 
virtual CaptionAlignment GetCaptionAlignment () const =0
 
virtual void CopyFrom (const ILinkCaptionPrefs *src)=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 interface provides access to the preferences for generating captions for links.

Member Enumeration Documentation

anonymous enum

Default IID to be used by UseDefaultIID()

Member Function Documentation

virtual void ILinkCaptionPrefs::AddNewCaptionLine (const PMString & beforeString,
const PMString & linkInfoProviderName,
const PMString & afterString 
)
pure virtual

Add one new caption line. New line is appended after existing lines

virtual void ILinkCaptionPrefs::ClearAllCaptionLines ()
pure virtual

clear all the caption lines

virtual void ILinkCaptionPrefs::CopyFrom (const ILinkCaptionPrefs * src)
pure virtual

copy settings from a different instance of this interface

virtual PMString ILinkCaptionPrefs::GetNthAfterString (int32 index) const
pure virtual

Ask for the nth 'after' caption string

virtual PMString ILinkCaptionPrefs::GetNthBeforeString (int32 index) const
pure virtual

Ask for the nth 'before' caption string

virtual PMString ILinkCaptionPrefs::GetNthLinkInfoProviderName (int32 index) const
pure virtual

Ask for the link info provider for the nth line

virtual int32 ILinkCaptionPrefs::GetNumCaptionLines () const
pure virtual

Ask how many caption lines there are

virtual void ILinkCaptionPrefs::SetCaptionAlignment (CaptionAlignment newAlign)
pure virtual

Get and set the alignment to use for the caption

virtual void ILinkCaptionPrefs::SetCaptionLayerName (const PMString & layerName)
pure virtual

Get and set the layer to use for the caption

virtual void ILinkCaptionPrefs::SetCaptionParagraphStyleUID (UID styleUID)
pure virtual

Get and set the paragraph style to use for the caption

virtual void ILinkCaptionPrefs::SetFrameOffset (const PMReal & offset)
pure virtual

Get and set the amount of frame offset

virtual void ILinkCaptionPrefs::SetGroupCaptionWithImage (bool shouldGroup)
pure virtual

Get and set the flag which says to group the caption and image together