IAssignedStory Class Reference

#include <IAssignedStory.h>

Inheritance diagram for IAssignedStory:

Public Types
enum	{ kDefaultIID = IID_IASSIGNEDSTORY }

Public Member Functions
virtual UIDRef	GetUIDRef ()=0
virtual void	SetUIDRef (const UIDRef &uidref)=0
virtual const PMString &	GetFile ()=0
virtual void	SetFile (const PMString &file)=0
virtual const PMString &	GetName ()=0
virtual void	SetName (const PMString &name)=0
virtual IAssignment *	GetAssignment ()=0
virtual void	SetAssignment (IAssignment *assignment)=0
virtual bool16	IsDirty ()=0
virtual void	Update ()=0
virtual void	Register ()=0
virtual void	Unregister ()=0
virtual ErrorCode	SetProps (const UIDRef &uidref, const PMString &file, const PMString &name)=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

This class is used to model the assignment of one or more stories to a user.

See Also

IAssignment

IAssignmentMgr

Member Function Documentation

virtual IAssignment* IAssignedStory::GetAssignment ( )

pure virtual

The assignment this story is in.

Returns

A pointer to the assignment, without the refcount incremented.

virtual const PMString& IAssignedStory::GetFile ( )

pure virtual

The file path of the story's linked InCopy file.

Returns

A reference to the story's linked InCopy file path.

virtual const PMString& IAssignedStory::GetName ( )

pure virtual

The assigned story's name which is displayed in the assignment palette.

Returns

The display name.

virtual UIDRef IAssignedStory::GetUIDRef ( )

pure virtual

Return a reference to the story's page item.

Returns

The story's page item. May be a text model or graphic frame.

virtual bool16 IAssignedStory::IsDirty ( )

pure virtual

Return whether a story has been recomposed or not.

virtual void IAssignedStory::Register ( )

pure virtual

Register this story with the assigned frame's IScrapItem interface.

virtual void IAssignedStory::SetAssignment ( IAssignment *  assignment )

pure virtual

Set the assignment. This does not move the assignment and must be called from a command. This is called the IAssignment::MoveStoryCmd.

Parameters

assignment

The new assignment to remember.

virtual void IAssignedStory::SetFile ( const PMString &  file )

pure virtual

Set the story's linked InCopy file path. Does not change the IDataLink. Must be called from a command.

Parameters

file	A file path in the current platform's encoding.

virtual void IAssignedStory::SetName ( const PMString &  name )

pure virtual

Change the name displayed for this story in the assignment palette. Must be called from a command.

Parameters

name	The new name.

virtual ErrorCode IAssignedStory::SetProps ( const UIDRef &  uidref, const PMString &  file, const PMString &  name  )

pure virtual

Process a command to set the properties of this assignment.

Parameters

uidref	The new page item reference
file	The new file path
name	The new assigned story name

Returns

ErrorCode Any error that may have occurred

virtual void IAssignedStory::SetUIDRef ( const UIDRef &  uidref )

pure virtual

Change the story's page item. Must be called from a command.

Parameters

uidref

The new page item for this story.

virtual void IAssignedStory::Unregister ( )

pure virtual

Unregister this story from the assigned frame's IScrapItem interface.

virtual void IAssignedStory::Update ( )

pure virtual

Update the assigned story and frames, making sure they have the proper adornment color and the like. Must be called from a command.