IStoryThreadData Class Reference

#include <IStoryThreadData.h>

Inheritance diagram for IStoryThreadData:

Public Types
enum	{ kDefaultIID = IID_ISTORYTHREADDATA }

Public Member Functions
virtual UID	GetStoryThreadDictUID ()=0
virtual int32	GetStoryThreadKey ()=0
virtual IDataBase *	GetStoryThreadDatabase ()=0
virtual void	Set (UID storyThreadDict, int32 storyThreadKey, IDataBase *storyThreadDB)=0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Detailed Description

A specific type storage interface, used in a story related view to story information about what text story thread is currently displayed (as the primary text) in the view. For a view that display's the primary story as it's main text GetStoryThreadDictUID() will be kInvalidUID and GetStoryThreadKey() will be -1. These views may in fact display text from other story threads for instance inline notes may be displayed but it's the primary text a view displays that is relevant. May be reused as a generic container for story thread information if desired.

Member Function Documentation

virtual IDataBase* IStoryThreadData::GetStoryThreadDatabase ( )

pure virtual

Database the story lives in

Returns

database story thread lives in.

virtual UID IStoryThreadData::GetStoryThreadDictUID ( )

pure virtual

Get a story thread uid

Returns

uid of the story thread (see ITextModel)

virtual int32 IStoryThreadData::GetStoryThreadKey ( )

pure virtual

Get a story thread key

Returns

story thread key (see ITextModel)

virtual void IStoryThreadData::Set ( UID  storyThreadDict, int32  storyThreadKey, IDataBase *  storyThreadDB  )

pure virtual

Set up information returned in the above information

Parameters

storyThreadDict	- uid of story thread (see ITextModel)
storyThreadKey	- key of story thread (see ITextModel)
storyThreadDB	- database story thread live in

Returns

none