#include <IFrameTagManager.h>

Inheritance diagram for IFrameTagManager:

Public Member Functions
virtual int	GetTagCount ()=0
	Get number of frame tags. More...

virtual DWORD	GetTagID (int i)=0
	Get ID for the i'th frame tag in the list of frame tags. More...

virtual TimeValue	GetTimeByID (DWORD id, BOOL relative)=0
	Get the tag's time value. More...

virtual void	SetTimeByID (DWORD id, TimeValue newTime, BOOL relative)=0
	Set the tag's time value. More...

virtual DWORD	GetLockIDByID (DWORD id)=0
	get the tag this tag is locked to. More...

virtual BOOL	SetLockIDByID (DWORD id, DWORD newLockID)=0
	set the tag this tag is locked to. More...

virtual MSTR	GetNameByID (DWORD id)=0
	get the tag's name More...

virtual void	SetNameByID (DWORD id, MSTR &newName)=0
	set the tag's name More...

virtual BOOL	GetScaleByID (DWORD id)=0
	get whether to scale the tag's time when time is scaled More...

virtual void	SetScaleByID (DWORD id, BOOL newScale)=0
	set whether to scale the tag's time when time is scaled More...

virtual int	FindItem (DWORD id)=0
	get the index of the tag in the sorted tag list. More...

virtual int	FindItemByTime (TimeValue t)=0
	finds the first tag in the sorted list, if any, for the given absolute time value More...

virtual DWORD	CreateNewTag (const MCHAR *name, TimeValue t, DWORD lockID, BOOL scale)=0
	creates a new tag. More...

virtual void	DeleteTag (DWORD id)=0
	deletes the specified tag More...

virtual void	ResetFrameTags ()=0
	deletes all the tags More...

virtual BOOL	CheckForLoop (DWORD testID, DWORD id)=0
	returns true if tag testID is dependent on tag id More...

Public Member Functions inherited from FPInterfaceDesc
CoreExport	FPInterfaceDesc ()

CoreExport	FPInterfaceDesc (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, ULONG flag,...)

CoreExport	~FPInterfaceDesc ()

virtual void	Init ()

LifetimeType	LifetimeControl ()

virtual BaseInterface *	GetInterface (Interface_ID id)

CoreExport void	LoadDescriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc pCD, ULONG flag,...)

CoreExport void	AppendFunction (int id,...)
	Add a new function to this interface descriptor. More...

CoreExport void	AppendProperty (int id,...)
	Add a new property to this interface descriptor. More...

CoreExport void	AppendEnum (int id,...)
	Add a new enum to this interface descriptor. More...

CoreExport void	SetClassDesc (ClassDesc *i_cd)

CoreExport va_list	check_fn (va_list ap, int id)

CoreExport va_list	scan_fn (va_list ap, int id, int index)

CoreExport va_list	check_prop (va_list ap, int id)

CoreExport va_list	scan_prop (va_list ap, int id, int index)

CoreExport va_list	check_enum (va_list ap, EnumID id)

CoreExport va_list	scan_enum (va_list ap, EnumID id, int index)

FPInterfaceDesc *	GetDesc ()

Interface_ID	GetID ()

CoreExport FPFunctionDef *	GetFnDef (FunctionID fid)

ActionTable *	GetActionTable ()

CoreExport void	EnableActions (BOOL onOff)

virtual CoreExport HINSTANCE	HInstance ()

virtual CoreExport const MCHAR *	GetRsrcString (StringResID id)

Public Member Functions inherited from FPInterface
virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t=0, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPParams *params)

virtual CoreExport FPStatus	Invoke (FunctionID fid, TimeValue t, FPValue &result, FPParams *params=NULL)

virtual FPStatus	Invoke (FunctionID fid, FPValue &result, FPParams *params=NULL)

virtual CoreExport FunctionID	FindFn (const MCHAR *name)

virtual CoreExport BOOL	IsEnabled (FunctionID actionID)

virtual CoreExport BOOL	IsChecked (FunctionID actionID)

virtual CoreExport BOOL	IsVisible (FunctionID actionID)

virtual CoreExport FunctionID	GetIsEnabled (FunctionID actionID)

virtual CoreExport FunctionID	GetIsChecked (FunctionID actionID)

virtual CoreExport FunctionID	GetIsVisible (FunctionID actionID)

Public Member Functions inherited from BaseInterface
virtual UtilExport	~BaseInterface ()
	Destructor. More...

virtual bool	RegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual void	UnRegisterNotifyCallback (InterfaceNotifyCallback *incb)

virtual BaseInterface *	AcquireInterface ()

virtual void	ReleaseInterface ()

virtual void	DeleteInterface ()

virtual BaseInterface *	CloneInterface (void *remapDir=NULL)

Public Member Functions inherited from InterfaceServer
virtual UtilExport	~InterfaceServer ()
	Destructor. More...

template<class InterfaceType >
InterfaceType *	GetTypedInterface ()

Additional Inherited Members
Public Types inherited from BaseInterface
enum	LifetimeType { noRelease , immediateRelease , wantsRelease , serverControlled }

Static Public Member Functions inherited from MaxHeapOperators
static UtilExport void *	operator new (size_t size)
	Standard new operator used to allocate objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e)
	Standard new operator used to allocate objects if there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate objects that takes the type of memory, filename and line number where the new was called If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate objects that takes the filename and line number where the new was called If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new (size_t size, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate objects that takes extra flags to specify special operations If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, int block_type, const char *filename, int line)
	New operator used to allocate arrays of objects. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, const char *filename, int line)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void *	operator new[] (size_t size, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, an exception will be thrown. More...

static UtilExport void *	operator new[] (size_t size, const std::nothrow_t &e, unsigned long flags)
	New operator used to allocate arrays of objects If there is insufficient memory, NULL will be returned. More...

static UtilExport void	operator delete (void *ptr)
	Standard delete operator used to deallocate an object If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an object If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void ptr, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an object that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an object that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete (void *ptr, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an object that takes extra flags to specify special operations If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e)
	Standard delete operator used to deallocate an array of objects If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void ptr, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, int block_type, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the type of memory, filename and line number where the delete was called If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void ptr, const std::nothrow_t &e, const char filename, int line)
	Delete operator used to deallocate an array of objects that takes the filename and line number where the delete was called If the pointer is invalid, nothing will happen. More...

static UtilExport void	operator delete[] (void *ptr, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void	operator delete[] (void *ptr, const std::nothrow_t &e, unsigned long flags)
	Delete operator used to deallocate an array of objects that takes extra flags to specify special operations If the pointer is invalid, an exception will be thrown. More...

static UtilExport void *	operator new (size_t size, void *placement_ptr)
	Placement new operator. More...

static UtilExport void	operator delete (void ptr, void placement_ptr)
	Placement delete operator. More...

static UtilExport void *	aligned_malloc (size_t size, size_t alignment)
	Allocates memory on a specified alignment boundary. More...

static UtilExport void *	aligned_realloc (void *ptr, size_t size, size_t alignment)
	Reallocates memory on a specified alignment boundary. More...

static UtilExport void	aligned_free (void *ptr)
	Frees a block of memory that was allocated with aligned_malloc/aligned_realloc. More...

Public Attributes inherited from FPInterfaceDesc
Interface_ID	ID

MSTR	internal_name

StringResID	description

ClassDesc *	cd

USHORT	flags

Tab< FPFunctionDef * >	functions

Tab< FPPropDef * >	props

Tab< FPEnum * >	enumerations

MSPluginClass *	pc

Rollout *	rollout

ActionTable *	action_table

Static Public Attributes inherited from FPInterface
static CoreExport FPInterfaceDesc	nullInterface

Protected Member Functions inherited from FPInterfaceDesc
CoreExport void	load_descriptor (Interface_ID id, const MCHAR int_name, StringResID descr, ClassDesc cd, USHORT flag, va_list ap)

Protected Member Functions inherited from FPInterface
virtual FPStatus	_dispatch_fn (FunctionID fid, TimeValue t, FPValue &result, FPParams *p)

Detailed Description

Description:: IFrameTagManager exposes the FrameTagManager

Member Function Documentation

◆ GetTagCount()

virtual int GetTagCount ( )

pure virtual

Get number of frame tags.

◆ GetTagID()

virtual DWORD GetTagID ( int i )

pure virtual

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

◆ GetTimeByID()

virtual TimeValue GetTimeByID	(	DWORD	id,
		BOOL	relative
	)

pure virtual

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

◆ SetTimeByID()

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

pure virtual

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

◆ GetLockIDByID()

virtual DWORD GetLockIDByID ( DWORD id )

pure virtual

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

◆ SetLockIDByID()

virtual BOOL SetLockIDByID	(	DWORD	id,
		DWORD	newLockID
	)

pure virtual

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.

◆ GetNameByID()

virtual MSTR GetNameByID ( DWORD id )

pure virtual

get the tag's name

◆ SetNameByID()

virtual void SetNameByID	(	DWORD	id,
		MSTR &	newName
	)

pure virtual

set the tag's name

◆ GetScaleByID()

virtual BOOL GetScaleByID ( DWORD id )

pure virtual

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

◆ SetScaleByID()

virtual void SetScaleByID	(	DWORD	id,
		BOOL	newScale
	)

pure virtual

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

◆ FindItem()

virtual int FindItem ( DWORD id )

pure virtual

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

◆ FindItemByTime()

virtual int FindItemByTime ( TimeValue t )

pure virtual

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

◆ CreateNewTag()

virtual DWORD CreateNewTag	(	const MCHAR *	name,
		TimeValue	t,
		DWORD	lockID,
		BOOL	scale
	)

pure virtual

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

◆ DeleteTag()

virtual void DeleteTag ( DWORD id )

pure virtual

deletes the specified tag

◆ ResetFrameTags()

virtual void ResetFrameTags ( )

pure virtual

deletes all the tags

◆ CheckForLoop()

virtual BOOL CheckForLoop	(	DWORD	testID,
		DWORD	id
	)

pure virtual

returns true if tag testID is dependent on tag id

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ GetTagCount()

◆ GetTagID()

◆ GetTimeByID()

◆ SetTimeByID()

◆ GetLockIDByID()

◆ SetLockIDByID()

◆ GetNameByID()

◆ SetNameByID()

◆ GetScaleByID()

◆ SetScaleByID()

◆ FindItem()

◆ FindItemByTime()

◆ CreateNewTag()

◆ DeleteTag()

◆ ResetFrameTags()

◆ CheckForLoop()