InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
RIDXReference Class Reference

#include <IRIDX.h>

Public Member Functions

 RIDXReference ()
 
 RIDXReference (RIDXSource source, RIDXTarget target)
 
 RIDXReference (UID sourceUID, ImplementationID sourceImplID, RIDXTarget::Type targetType, uint32 targetValue)
 
 RIDXReference (uint32 sourceUID, uint32 sourceImplID, uint32 targetType, uint32 targetValue)
 
RIDXSource GetSource () const
 
RIDXTarget GetTarget () const
 

Detailed Description

Represents a reference tracked by the reference index. It is a (source,target) pair representing a reference in some particular source UID and some particular implementation of an interface on that source UID to some particular target. Comparison operators ==, !=, and < are defined, and the rest are omitted by design. Ordering for operator < is the lexicographical ordering of the sequence source, target.

See Also
RIDXSource
RIDXTarget
IRIDX

Constructor & Destructor Documentation

RIDXReference::RIDXReference ()
inline

Constructs an uninitialized reference.

RIDXReference::RIDXReference (RIDXSource source,
RIDXTarget target 
)
inline

Constructs a reference.

Parameters
sourceis the source of the reference.
targetis the target of the reference.
RIDXReference::RIDXReference (UID sourceUID,
ImplementationID sourceImplID,
RIDXTarget::Type targetType,
uint32 targetValue 
)
inline

Constructs a reference.

Parameters
sourceUIDis the UID that the reference is from.
sourceImplIDis the implementation on that UID that the reference is from.
targetTypeis the type of the target.
targetValueis the target value, and the interpretation depends upon targetType.
RIDXReference::RIDXReference (uint32 sourceUID,
uint32 sourceImplID,
uint32 targetType,
uint32 targetValue 
)
inline

Constructs a reference.

Parameters
sourceUIDis the UID that the reference is from.
sourceImplIDis the implementation on that UID that the reference is from.
targetTypeis the type of the target.
targetValueis the target value, and the interpretation depends upon targetType.

Member Function Documentation

RIDXSource RIDXReference::GetSource () const
inline

Gets the source of the reference.

Returns
the source of the reference.
RIDXTarget RIDXReference::GetTarget (void ) const
inline

Gets the target of the reference.

Returns
the target of the reference.