IFrameTagManager Class Reference

Search for all occurrences

---

Detailed Description

Description:

IFrameTagManager exposes the FrameTagManager

#include <IFrameTagManager.h>

Inheritance diagram for IFrameTagManager:

List of all members.

Public Member Functions
virtual int	GetTagCount ()=0
	Get number of frame tags.
virtual DWORD	GetTagID (int i)=0
	Get ID for the i'th frame tag in the list of frame tags.
virtual TimeValue	GetTimeByID (DWORD id, BOOL relative)=0
	Get the tag's time value.
virtual void	SetTimeByID (DWORD id, TimeValue newTime, BOOL relative)=0
	Set the tag's time value.
virtual DWORD	GetLockIDByID (DWORD id)=0
	get the tag this tag is locked to.
virtual BOOL	SetLockIDByID (DWORD id, DWORD newLockID)=0
	set the tag this tag is locked to.
virtual MSTR	GetNameByID (DWORD id)=0
	get the tag's name
virtual void	SetNameByID (DWORD id, MSTR &newName)=0
	set the tag's name
virtual BOOL	GetScaleByID (DWORD id)=0
	get whether to scale the tag's time when time is scaled
virtual void	SetScaleByID (DWORD id, BOOL newScale)=0
	set whether to scale the tag's time when time is scaled
virtual int	FindItem (DWORD id)=0
	get the index of the tag in the sorted tag list.
virtual int	FindItemByTime (TimeValue t)=0
	finds the first tag in the sorted list, if any, for the given absolute time value
virtual DWORD	CreateNewTag (MCHAR *name, TimeValue t, DWORD lockID, BOOL scale)=0
	creates a new tag.
virtual void	DeleteTag (DWORD id)=0
	deletes the specified tag
virtual void	ResetFrameTags ()=0
	deletes all the tags
virtual BOOL	CheckForLoop (DWORD testID, DWORD id)=0
	returns true if tag testID is dependent on tag id

---

Member Function Documentation

virtual int GetTagCount

(

)

[pure virtual]

Search for all occurrences

Get number of frame tags.

virtual DWORD GetTagID

(

int

i

)

[pure virtual]

Search for all occurrences

Get ID for the i'th frame tag in the list of frame tags.

Remarks:

the list is maintained in sorted order, so a given tag can move around in the list. Each tag has a unique ID, so all access to the tag is via this ID

Returns:

The ID of the tag at index i

virtual TimeValue GetTimeByID	(	DWORD	id,
		BOOL	relative
	)		[pure virtual]

Search for all occurrences

Get the tag's time value.

Parameters:

id	- The id of the tag to query
relative	- if TRUE, time is relative to the tag this tag is locked to, if any. If false, or this tag is not locked to another tag, the time is absolute

virtual void SetTimeByID	(	DWORD	id,
		TimeValue	newTime,
		BOOL	relative
	)		[pure virtual]

Search for all occurrences

Set the tag's time value.

Parameters:

id	- The id of the tag to set
newTime	- The new time value to set on the Tag
relative	- if TRUE, time is relative to the tag this tag is locked to, if any. If false, or this tag is not locked to another tag, the time is absolute

virtual DWORD GetLockIDByID

(

DWORD

id

)

[pure virtual]

Search for all occurrences

get the tag this tag is locked to.

Parameters:

id	- The ID of the tag to query on

Returns:

The ID of the tag id is locked to, or 0 if not locked

virtual BOOL SetLockIDByID	(	DWORD	id,
		DWORD	newLockID
	)		[pure virtual]

Search for all occurrences

set the tag this tag is locked to.

Remarks:

If you attempt to set a lock that would cause a circular dependency, the current lock will not be changed and the method will return FALSE. See CheckForLoop for testing for loops

Parameters:

id	- The ID of the tag to query on
newLockID	- value of 0 means not tagged

Returns:

TRUE if the lock was set.

virtual MSTR GetNameByID

(

DWORD

id

)

[pure virtual]

Search for all occurrences

get the tag's name

virtual void SetNameByID	(	DWORD	id,
		MSTR &	newName
	)		[pure virtual]

Search for all occurrences

set the tag's name

virtual BOOL GetScaleByID

(

DWORD

id

)

[pure virtual]

Search for all occurrences

get whether to scale the tag's time when time is scaled

virtual void SetScaleByID	(	DWORD	id,
		BOOL	newScale
	)		[pure virtual]

Search for all occurrences

set whether to scale the tag's time when time is scaled

virtual int FindItem

(

DWORD

id

)

[pure virtual]

Search for all occurrences

get the index of the tag in the sorted tag list.

Returns:

The index of the tag with the given ID, or -1 if a tag with the given ID was not found

virtual int FindItemByTime

(

TimeValue

t

)

[pure virtual]

Search for all occurrences

finds the first tag in the sorted list, if any, for the given absolute time value

virtual DWORD CreateNewTag	(	MCHAR *	name,
		TimeValue	t,
		DWORD	lockID,
		BOOL	scale
	)		[pure virtual]

Search for all occurrences

creates a new tag.

Parameters:

name	- The name of the tag
t	- The tags absolute time
lockID	- The ID of the tag this new tag is locked too. if 0, the tag is not locked to another tag
scale	- Whether or not to scale the tags time when time is scaled

Returns:

The ID of the created flag

virtual void DeleteTag

(

DWORD

id

)

[pure virtual]

Search for all occurrences

deletes the specified tag

virtual void ResetFrameTags

(

)

[pure virtual]

Search for all occurrences

deletes all the tags

virtual BOOL CheckForLoop	(	DWORD	testID,
		DWORD	id
	)		[pure virtual]

Search for all occurrences

returns true if tag testID is dependent on tag id