RVC::HYPERINDEX::LINK Class Reference

#include <rvc/hyperidx.h>

Inheritance diagram for RVC::HYPERINDEX::LINK:

[legend]

List of all members.

Public Types
enum	POSITION { POSITION_Click = 0, POSITION_Center, POSITION_AsSaved, POSITION_Max }
enum	REFTYPE {   REFTYPE_Invalid = 0, REFTYPE_FilePath, REFTYPE_ObjItem, REFTYPE_URL,   REFTYPE_TableField }
enum	SCALE {   SCALE_1X = 0, SCALE_FullView, SCALE_AsSaved, SCALE_Zoomed,   SCALE_ToMap, SCALE_Max }
enum	TYPE {   TYPE_DISP2DWINDOW = 0, TYPE_Raster = 2, TYPE_Vector = 3, TYPE_CAD = 4,   TYPE_Layout = 5, TYPE_Group = 6, TYPE_TIN = 7, TYPE_TextFile = 8,   TYPE_ExternalFile = 9, TYPE_URL = 10, TYPE_FileByAttrib = 11, TYPE_URLByAttrib = 12,   TYPE_Shape = 13, TYPE_SMLScript = 14, TYPE_LAST }
Public Member Functions
	LINK ()
bool	CanUseScalePos () const
void	Clear ()
const MISTRING &	GetDescription () const
TYPE	GetLinkType () const
double	GetMapScale () const
const MISTRING &	GetName () const
OBJTYPE	GetObjType () const
POSITION	GetPosition () const
const FILEPATH &	GetRefFilePath () const
ERRVALUE	GetRefObjItem (RVC::OBJITEM &ObjItem) const
ERRVALUE	GetRefTableField (RVC::OBJECTNAME &TableName, RVC::OBJECTNAME &FieldName) const
REFTYPE	GetRefType () const
const MISTRING &	GetRefURL () const
SCALE	GetScaleType () const
double	GetZoomFactor () const
bool	IsValid () const
bool	ReadLinkFromAttribute (const RVC::DBASE_ELEMENT &DBaseObj, const RVC::ELEMENT &Element)
void	SetDescription (const MISTRING &desc)
void	SetLinkType (TYPE type)
void	SetMapScale (double MapScale)
void	SetPosition (POSITION posn)
ERRVALUE	SetRefFilePath (const FILEPATH &filepath)
ERRVALUE	SetRefObjItem (const RVC::OBJITEM &ObjItem)
ERRVALUE	SetRefTableField (const RVC::OBJECTNAME &TableName, const RVC::OBJECTNAME &FieldName)
ERRVALUE	SetRefURL (const MISTRING &URL)
void	SetScaleType (SCALE scale)
Static Public Member Functions
static OBJTYPE	GetObjType (TYPE Type)

---

Member Enumeration Documentation

enum RVC::HYPERINDEX::LINK::POSITION

Enumerator:

POSITION_Click	Center around mouse click.
POSITION_Center	Center of image.
POSITION_AsSaved	As saved in layout (layouts only.
POSITION_Max

enum RVC::HYPERINDEX::LINK::REFTYPE

Reference type indicating what the link uses for reference.

Enumerator:

REFTYPE_Invalid
REFTYPE_FilePath	File path, use Get/SetRefFilePath to acccess.
REFTYPE_ObjItem	Object, use Get/SetRefObjItem to access.
REFTYPE_URL	URL, use Get/SetRefURL to access.
REFTYPE_TableField	Database table.field, use Get/SetRefTableField to access.

enum RVC::HYPERINDEX::LINK::SCALE

Values for how to scale view after following link.

These do not numerically correspond to the HYPERLINK_Scale... values.

Enumerator:

SCALE_1X	Display at 1X zoom.
SCALE_FullView	Display to fit window.
SCALE_AsSaved	Display at scale saved with layout.
SCALE_Zoomed	Display at specified zoom factor.
SCALE_ToMap	Display at specified "map scale".
SCALE_Max

enum RVC::HYPERINDEX::LINK::TYPE

Type of object or file link is to.

Enumerator:

TYPE_DISP2DWINDOW
TYPE_Raster
TYPE_Vector
TYPE_CAD
TYPE_Layout
TYPE_Group
TYPE_TIN
TYPE_TextFile
TYPE_ExternalFile
TYPE_URL
TYPE_FileByAttrib
TYPE_URLByAttrib
TYPE_Shape
TYPE_SMLScript
TYPE_LAST

---

Constructor & Destructor Documentation

RVC::HYPERINDEX::LINK::LINK

(

)

Default constructor.

---

Member Function Documentation

bool RVC::HYPERINDEX::LINK::CanUseScalePos

(

)

const

Determine if can use scale/position settings.

void RVC::HYPERINDEX::LINK::Clear

(

)

Clear all entries in the instance.

Reimplemented in GRE::HYPERLINK.

const MISTRING& RVC::HYPERINDEX::LINK::GetDescription

(

)

const [inline]

TYPE RVC::HYPERINDEX::LINK::GetLinkType

(

)

const [inline]

double RVC::HYPERINDEX::LINK::GetMapScale

(

)

const [inline]

Map scale if m_ScaleType is SCALE_ToMap.

const MISTRING& RVC::HYPERINDEX::LINK::GetName

(

)

const [inline]

static OBJTYPE RVC::HYPERINDEX::LINK::GetObjType

(

TYPE

Type

)

[static]

Get type of object being linked to.

Will return OBJTYPE_All if not linked to RVC object.

OBJTYPE RVC::HYPERINDEX::LINK::GetObjType

(

)

const [inline]

Get type of object being linked to.

Will return OBJTYPE_All if not linked to RVC object.

POSITION RVC::HYPERINDEX::LINK::GetPosition

(

)

const [inline]

const FILEPATH& RVC::HYPERINDEX::LINK::GetRefFilePath

(

)

const [inline]

Get reference file path, only valid if GetRefType returns REFTYPE_FilePath.

ERRVALUE RVC::HYPERINDEX::LINK::GetRefObjItem

(

RVC::OBJITEM &

ObjItem

)

const

Get reference object item, only valid if GetRefType returns REFTYPE_ObjItem.

Parameters:

ObjItem

Item returned, might not be resolved to actual object

ERRVALUE RVC::HYPERINDEX::LINK::GetRefTableField	(	RVC::OBJECTNAME &	TableName,
		RVC::OBJECTNAME &	FieldName
	)			const

Get reference attribute table and field, only valid if GetRefType returns REFTYPE_TableField.

Parameters:

	TableName	Table name returned
	FieldName	Field name returned

REFTYPE RVC::HYPERINDEX::LINK::GetRefType

(

)

const

Get reference type.

const MISTRING& RVC::HYPERINDEX::LINK::GetRefURL

(

)

const [inline]

Get reference URL, only valid if GetRefType returns REFTYPE_URL.

SCALE RVC::HYPERINDEX::LINK::GetScaleType

(

)

const [inline]

double RVC::HYPERINDEX::LINK::GetZoomFactor

(

)

const [inline]

Zoom factor if m_ScaleType is SCALE_Zoomed.

bool RVC::HYPERINDEX::LINK::IsValid

(

)

const

Determine if link is valid.

Does not necessarily mean that link refers to an existing file/object/url, checks members for reasonable settings only.

bool RVC::HYPERINDEX::LINK::ReadLinkFromAttribute	(	const RVC::DBASE_ELEMENT &	DBaseObj,
		const RVC::ELEMENT &	Element
	)

Obtain link information if the LinkTo is TYPE_FileByAttrib or TYPE_URLByAttrib.

Returns:

'True' if the attribute was read, false if not

void RVC::HYPERINDEX::LINK::SetDescription

(

const MISTRING &

desc

)

[inline]

void RVC::HYPERINDEX::LINK::SetLinkType

(

TYPE

type

)

Set type of object/document to link to Will clear reference members if link type actually changed.

void RVC::HYPERINDEX::LINK::SetMapScale

(

double

MapScale

)

[inline]

void RVC::HYPERINDEX::LINK::SetPosition

(

POSITION

posn

)

[inline]

ERRVALUE RVC::HYPERINDEX::LINK::SetRefFilePath

(

const FILEPATH &

filepath

)

Set reference file path, only valid if GetRefType returns REFTYPE_FilePath.

ERRVALUE RVC::HYPERINDEX::LINK::SetRefObjItem

(

const RVC::OBJITEM &

ObjItem

)

Set reference object item.

Will adjust link type to be appropriate for object type.

ERRVALUE RVC::HYPERINDEX::LINK::SetRefTableField	(	const RVC::OBJECTNAME &	TableName,
		const RVC::OBJECTNAME &	FieldName
	)

Set reference attribute table and field, only valid if GetRefType returns REFTYPE_TableField.

ERRVALUE RVC::HYPERINDEX::LINK::SetRefURL

(

const MISTRING &

URL

)

Set reference URL, only valid if GetRefType returns REFTYPE_URL.

void RVC::HYPERINDEX::LINK::SetScaleType

(

SCALE

scale

)

[inline]

---

The documentation for this class was generated from the following file:

• rvc/hyperidx.h