CLinkInfoProvider Class Reference

Inheritance diagram for CLinkInfoProvider:

Public Member Functions
	CLinkInfoProvider (IPMUnknown *boss)
virtual bool16	IsLinkInfoDynamic () const
virtual PMRsrcID	GetInfoDescriptionIcon () const
virtual int32	GetDefaultColumnWidth () const
virtual int16	GetInfoTextAlignment () const
virtual PMRsrcID	GetUpdatedIconForLink (const ILink *, const ILinkResource *) const
virtual void	AttachToDocument (IObserver *observer, const IDocument *newDoc)
virtual void	DetachFromDocument (IObserver *observer, const IDocument *oldDoc)
virtual bool16	ShouldCauseRefreshOfInfo (const PMIID &protocol) const
virtual bool16	CanDoSingleClickAction (const ILink *, const ILinkResource *) const
virtual void	DoSingleClickAction (const ILink *link, const ILinkResource *linkResource)
virtual bool16	CanDoDoubleClickAction (const ILink *, const ILinkResource *) const
virtual void	DoDoubleClickAction (const ILink *link, const ILinkResource *linkResource)
virtual PMString	GetDoubleClickDescription (const ILink *link, const ILinkResource *linkResource) const
virtual int32	Compare (const ILink *link1, const ILinkResource *linkResource1, const ILink *link2, const ILinkResource *linkResource2) const
Public Member Functions inherited from CPMUnknown< ILinkInfoProvider >
IPMUnknown *	QueryInterface (PMIID interfaceID) const
void	AddRef () const
void	Release () const
void	PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
void	PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
	CPMUnknown (const CPMUnknown &)=delete
CPMUnknown &	operator= (const CPMUnknown &)=delete
Public Member Functions inherited from ILinkInfoProvider
virtual PMString	GetInfoDescriptionString () const =0
virtual PMString	GetUpdatedInfoForLink (const ILink *link, const ILinkResource *linkResource, bool shortForm) const =0

Additional Inherited Members
Public Types inherited from ILinkInfoProvider
enum	{ kDefaultIID = IID_ILINKINFOPROVIDER }
Protected Member Functions inherited from CPMUnknown< ILinkInfoProvider >
	CPMUnknown (IPMUnknown *boss)
Protected Attributes inherited from CPMUnknown< ILinkInfoProvider >
HelperInterface	fHelperInterface

Member Function Documentation

virtual void CLinkInfoProvider::AttachToDocument ( IObserver *  observer, const IDocument *  newDoc  )

virtual

will only be called for info providers which indicate they are dynamic. The ILinkInfoProvider implementation should attach the observer to whatever they need to watch

Implements ILinkInfoProvider.

virtual bool16 CLinkInfoProvider::CanDoDoubleClickAction ( const ILink *  link, const ILinkResource *  linkResource  ) const

inlinevirtual

returns whether or not the double click action is available for this item in this column

Implements ILinkInfoProvider.

virtual bool16 CLinkInfoProvider::CanDoSingleClickAction ( const ILink *  link, const ILinkResource *  linkResource  ) const

inlinevirtual

returns whether or not the single click action is available for this item in this column

Implements ILinkInfoProvider.

virtual int32 CLinkInfoProvider::Compare ( const ILink *  link1, const ILinkResource *  linkResource1, const ILink *  link2, const ILinkResource *  linkResource2  ) const

virtual

compare the values of these 2 links. Used for sorting. 0 indicates equality. -1 indicates first is < second, 1 indicates second > first

Implements ILinkInfoProvider.

virtual void CLinkInfoProvider::DetachFromDocument ( IObserver *  observer, const IDocument *  oldDoc  )

virtual

will only be called for info providers which indicate they are dynamic. The ILinkInfoProvider implementation should attach the observer to whatever they need to watch

Implements ILinkInfoProvider.

virtual void CLinkInfoProvider::DoDoubleClickAction ( const ILink *  link, const ILinkResource *  linkResource  )

virtual

Some columns provide an action when the user double clicks on the displayed info. For example, the status column will update a modified link on double click.

Implements ILinkInfoProvider.

virtual void CLinkInfoProvider::DoSingleClickAction ( const ILink *  link, const ILinkResource *  linkResource  )

virtual

Some columns provide an action when the user single clicks on the displayed info. For example, the page number field will 'goto link' on a single click.

Implements ILinkInfoProvider.

virtual int32 CLinkInfoProvider::GetDefaultColumnWidth ( ) const

inlinevirtual

Default num pixels for column width. Some columns make sense wide, others narrow.

Implements ILinkInfoProvider.

virtual PMString CLinkInfoProvider::GetDoubleClickDescription ( const ILink *  link, const ILinkResource *  linkResource  ) const

virtual

Get string describing the double click behavior. Might be used in a tool tip.

Implements ILinkInfoProvider.

virtual PMRsrcID CLinkInfoProvider::GetInfoDescriptionIcon ( ) const

inlinevirtual

This returns an icon description of the info itself, like a little page. The returned PMRsrcID is expected to refer to a PNG icon resource

Implements ILinkInfoProvider.

virtual int16 CLinkInfoProvider::GetInfoTextAlignment ( ) const

inlinevirtual

Get the alignment of the text for this column

Returns

one of {kAlignLeft,kAlignCenter,kAlignRight}, defined in WidgetDefs.h

Implements ILinkInfoProvider.

virtual PMRsrcID CLinkInfoProvider::GetUpdatedIconForLink ( const ILink *  link, const ILinkResource *  linkResource  ) const

inlinevirtual

This returns an icon representing the info for this ILink or ILinkResource. The returned PMRsrcID is expected to refer to a PNG icon resource

Implements ILinkInfoProvider.

Reimplemented in CusDtLnkLinkInfoProvider.

virtual bool16 CLinkInfoProvider::IsLinkInfoDynamic ( ) const

inlinevirtual

This method should return true if this info is calculated based on something in the InDesign document. Return false if your data depends only on the file on disk.

Implements ILinkInfoProvider.

Reimplemented in CusDtLnkLinkInfoProvider.

virtual bool16 CLinkInfoProvider::ShouldCauseRefreshOfInfo ( const PMIID &  protocol ) const

virtual

will only be called for info providers which indicate they are dynamic. The ILinkInfoProvider implementation should return true if this message might change its data.

Implements ILinkInfoProvider.