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

#include <IHyperlinkCmdData.h>

Inheritance diagram for IHyperlinkCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IHYPERLINKCMDDATA }
 

Public Member Functions

virtual void Set (const UIDRef &hyperLinkDestination, const PMString *name=nil)=0
 
virtual void InitializeToDefaultAppearance (IDataBase *db)=0
 
virtual void SetHyperlinkName (const PMString *name=nil)=0
 
virtual const PMString & GetHyperlinkName () const =0
 
virtual bool16 ChangingHyperlinkName () const =0
 
virtual void SetHyperlinkDestination (const UIDRef &hyperLinkDestination)=0
 
virtual const UIDRef & GetHyperlinkDestination () const =0
 
virtual void SetHyperlinkDestinationUniqueKey (int32 uniqueKey)=0
 
virtual int32 GetHyperlinkDestinationUniqueKey () const =0
 
virtual bool16 ChangingHyperlinkDestination () const =0
 
virtual void SetVisible (const bool16 bIsVisible)=0
 
virtual bool16 GetVisible () const =0
 
virtual bool16 ChangingVisibleAttribute () const =0
 
virtual void SetBorderLineWidth (const int32 strokeWidthInPixels)=0
 
virtual int32 GetBorderLineWidth () const =0
 
virtual bool16 ChangingBorderLineWidth () const =0
 
virtual void SetHyperlinkHilight (IHyperlinkAppearanceData::HyperlinkHilight hilightType)=0
 
virtual
IHyperlinkAppearanceData::HyperlinkHilight 		GetHyperlinkHilight () const =0
 
virtual bool16 ChangingHyperlinkHilight () const =0
 
virtual void SetBorderColorUID (const UID interfaceColorUID)=0
 
virtual const UID GetBorderColorUID () const =0
 
virtual bool16 ChangingBorderColor () const =0
 
virtual void SetHyperlinkOutlineLineStyle (IHyperlinkAppearanceData::HyperlinkOutlineLineStyle style)=0
 
virtual
IHyperlinkAppearanceData::HyperlinkOutlineLineStyle 		GetHyperlinkOutlineLineStyle () const =0
 
virtual bool16 ChangingHyperlinkOutlineLineStyle () const =0
 
virtual void SetFileMissing (bool16 fileMissing)=0
 
virtual bool16 GetFileMissing () const =0
 
virtual bool16 ChangingFileMissing () const =0
 
virtual bool16 IsFromDuplicate () const =0
 
virtual void SetFromDuplicate (bool16 fromDup)=0
 
virtual bool16 ChangingHyperlinkAltText () const =0
 
virtual void SetHyperlinkAltText (const PMString altText)=0
 
virtual const PMString GetHyperlinkAltText ()=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

Command data interface associated with commands that modify hyperlinks (kHyperlinkBoss).

See Also
kHyperlinkBoss
IHyperlink
kNewHyperlinkCmdBoss
kChangeHyperlinkCmdBoss
kDuplicateHyperlinkCmdBoss

Member Function Documentation

virtual bool16 IHyperlinkCmdData::ChangingBorderColor () const
pure virtual

Are we actually changing the color of the hyperlink?

Parameters
none
Returns
bool16 - kTrue == Yes
virtual bool16 IHyperlinkCmdData::ChangingBorderLineWidth () const
pure virtual

Are we actually changing the border width of the hyperlink?

Parameters
none
Returns
bool16 - kTrue == Yes
virtual bool16 IHyperlinkCmdData::ChangingFileMissing () const
pure virtual

Are we actually changing the hyperlink destination file missing flag?

Returns
bool16 - kTrue = Yes
virtual bool16 IHyperlinkCmdData::ChangingHyperlinkAltText () const
pure virtual
Are we actually changing the hyperlink altenate text?
Returns
bool16 - kTrue = Yes
virtual bool16 IHyperlinkCmdData::ChangingHyperlinkDestination () const
pure virtual

Are we actually changing the destination of the hyperlink?

Parameters
none
Returns
bool16 - kTrue == Yes
virtual bool16 IHyperlinkCmdData::ChangingHyperlinkHilight () const
pure virtual

Are we actually changing the hilight of the hyperlink?

Parameters
none
Returns
bool16 - kTrue == Yes
virtual bool16 IHyperlinkCmdData::ChangingHyperlinkName () const
pure virtual

Are we actually changing the name of the hyperlink?

Parameters
none
Returns
bool16 - kTrue == Yes
virtual bool16 IHyperlinkCmdData::ChangingHyperlinkOutlineLineStyle () const
pure virtual

Are we actually changing the outline line style of the hyperlink?

Parameters
none
Returns
bool16 - kTrue == Yes
virtual bool16 IHyperlinkCmdData::ChangingVisibleAttribute () const
pure virtual

Are we actually changing the visible attribute of the hyperlink?

Parameters
none
Returns
bool16 - kTrue == Yes
virtual const UID IHyperlinkCmdData::GetBorderColorUID () const
pure virtual

Get Hyperlink border color

Parameters
none
Returns
const UID - UID of color to use in the border
virtual int32 IHyperlinkCmdData::GetBorderLineWidth () const
pure virtual

Get Hyperlink line width

Parameters
none
Returns
int23 - 1 == Thin, 2 == Medium, 3 == Thick
virtual bool16 IHyperlinkCmdData::GetFileMissing () const
pure virtual

Get hyperlink destination file missing flag

Returns
bool16
virtual const PMString IHyperlinkCmdData::GetHyperlinkAltText ()
pure virtual

Get Hyperlink alternate text.

Parameters
none
Returns
const PMString - Alternate text of hyperlink
virtual const UIDRef& IHyperlinkCmdData::GetHyperlinkDestination () const
pure virtual

Get the hyperlink destination UIDRef

Parameters
none
Returns
const UIDRef& - UIDRef of the required destination
virtual int32 IHyperlinkCmdData::GetHyperlinkDestinationUniqueKey () const
pure virtual

Get the hyperlink destination unique key

Parameters
none
Returns
int32 - unique key of the required destination
virtual IHyperlinkAppearanceData::HyperlinkHilight IHyperlinkCmdData::GetHyperlinkHilight () const
pure virtual

Get Hyperlink hilight

Parameters
none
Returns
IHyperlinkAppearanceData::HyperlinkHilight - Used for Acrobat
virtual const PMString& IHyperlinkCmdData::GetHyperlinkName () const
pure virtual

Get Hyperlink name

Parameters
none
Returns
const PMString& - Name of the new hyperlink
virtual IHyperlinkAppearanceData::HyperlinkOutlineLineStyle IHyperlinkCmdData::GetHyperlinkOutlineLineStyle () const
pure virtual

Get Hyperlink outline line style

Parameters
none
Returns
IHyperlinkAppearanceData::HyperlinkOutlineLineStyle kHyperlinkSolidOutline == solid line, kHyperlinkDashedOutline == dashed line
virtual bool16 IHyperlinkCmdData::GetVisible () const
pure virtual

Get Hyperlink visible rectangle state

Parameters
none
Returns
bool16 - kTrue == Visible rectangle
virtual void IHyperlinkCmdData::InitializeToDefaultAppearance (IDataBase * db)
pure virtual

Initialize the hyperlink to the standard default appearance

Parameters
*db- DataBase (to get the UID of the color)
virtual bool16 IHyperlinkCmdData::IsFromDuplicate () const
pure virtual

Is this from a duplicate command.

Returns
bool16 kTrue is we are creating a new text destination from a dupplicate command.
virtual void IHyperlinkCmdData::Set (const UIDRef & hyperLinkDestination,
const PMString * name = nil 
)
pure virtual

Set the required information by calling this single method

Parameters
&hyperLinkDestination- The destination to point to
name- The name of the hyperlink
virtual void IHyperlinkCmdData::SetBorderColorUID (const UID interfaceColorUID)
pure virtual

Set Hyperlink border color

Parameters
interfaceColorUID- UID of color to use in the border
virtual void IHyperlinkCmdData::SetBorderLineWidth (const int32 strokeWidthInPixels)
pure virtual

Set Hyperlink line width

Parameters
strokeWidthInPixels- 1 == Thin, 2 == Medium, 3 == Thick
virtual void IHyperlinkCmdData::SetFileMissing (bool16 fileMissing)
pure virtual

Set hyperlink destination file missing flag

Parameters
fileMising- kTrue if file is missing, kFalse otherwise.
virtual void IHyperlinkCmdData::SetFromDuplicate (bool16 fromDup)
pure virtual

Set whether it is from a duplicate command.

Parameters
fromDup- kTrue if from duplicate command.
virtual void IHyperlinkCmdData::SetHyperlinkAltText (const PMString altText)
pure virtual

Set Hyperlink alternate text.

Parameters
altText- Alternate text of hyperlink.
virtual void IHyperlinkCmdData::SetHyperlinkDestination (const UIDRef & hyperLinkDestination)
pure virtual

Set the hyperlink destination UIDRef

Parameters
&hyperLinkDestination- UIDRef of the destination
virtual void IHyperlinkCmdData::SetHyperlinkDestinationUniqueKey (int32 uniqueKey)
pure virtual

Set the hyperlink destination unique key

Parameters
uniqueKey- unique key of the destination
virtual void IHyperlinkCmdData::SetHyperlinkHilight (IHyperlinkAppearanceData::HyperlinkHilight hilightType)
pure virtual

Set Hyperlink hilight

Parameters
hilightType- Used for Acrobat
virtual void IHyperlinkCmdData::SetHyperlinkName (const PMString * name = nil)
pure virtual

Set Hyperlink name

Parameters
name- Name to use
virtual void IHyperlinkCmdData::SetHyperlinkOutlineLineStyle (IHyperlinkAppearanceData::HyperlinkOutlineLineStyle style)
pure virtual

Set Hyperlink outline line style

Parameters
stylekHyperlinkSolidOutline == solid line, kHyperlinkDashedOutline == dashed line
virtual void IHyperlinkCmdData::SetVisible (const bool16 bIsVisible)
pure virtual

Set Hyperlink visible rectangle state

Parameters
bIsVisible- kTrue == Visible rectangle