IMergeStoriesSignalData Class Reference

#include <IMergeStoriesSignalData.h>

Inheritance diagram for IMergeStoriesSignalData:

Public Types
enum	{ kDefaultIID = IID_IMERGESTORIESSIGNALDATA }
enum	State { kBeforeDoMerge, kAfterDoMerge, kMergeError }

Public Member Functions
virtual void	Set (const UIDRef &targetStory, const UIDRef &appendingStory, TextIndex destIndex, int32 length, bool16 useAppendingStoryOptions)=0
virtual void	SetState (State state)=0
virtual UIDRef	GetTargetStory () const =0
virtual UIDRef	GetAppendingStory () const =0
virtual TextIndex	GetDestinationTextIndex () const =0
virtual int32	GetAppendingStoryLength () const =0
virtual bool16	UseAppendingStoryOptions () const =0
virtual State	GetState () const =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 receiver of a kMergeStoriesSignalService can look at this interface to find out which two stories have been merged, whether this is pre or post merge or if there was an error doing the merge. Note this signal will only happen on the Do() of the command. This interface cannot be used to change the behavior of the command it is for information only.

Member Enumeration Documentation

enum IMergeStoriesSignalData::State

State enum that can be retrieved by with the GetState() method.

Enumerator
kBeforeDoMerge	Before merge has been done
kAfterDoMerge	After merge is done
kMergeError	No merge was done error occurred

Member Function Documentation

virtual UIDRef IMergeStoriesSignalData::GetAppendingStory ( ) const

pure virtual

Get reference of the story to be appended to the target story.

Returns

UIDRef reference of the story to be appended to the target story.

virtual int32 IMergeStoriesSignalData::GetAppendingStoryLength ( ) const

pure virtual

Refers to the length of the appending story.

Returns

number of primary story characters in the appended story

virtual TextIndex IMergeStoriesSignalData::GetDestinationTextIndex ( ) const

pure virtual

Indicates the index in the target story where the appending story will begin. Last original primary story index of the original target story.

Returns

text index where the appending story begins in the target story.

virtual State IMergeStoriesSignalData::GetState ( ) const

pure virtual

What is the state of the command (i.e. before or after completion).

Returns

State enum which describes current state of command doing the merge.

virtual UIDRef IMergeStoriesSignalData::GetTargetStory ( ) const

pure virtual

This story will have the data from the other story (AppendingStory) append to it when the command is complete.

Returns

UIDRef reference of the target story.

virtual void IMergeStoriesSignalData::Set ( const UIDRef &  targetStory, const UIDRef &  appendingStory, TextIndex  destIndex, int32  length, bool16  useAppendingStoryOptions  )

pure virtual

Set the data for this interface, when the two stories merge, the source story will be appended to the destination story. Source story will be appended to the destination story. INTERNAL USE ONLY

Parameters

targetStory	same as destination story this story will contain the text of the source and destination story when command is complete.
appendingStory	story to be appended to the destination (targetStory).
destIndex	indicates the index in the destination story where the source story will begin. It is the last index in the original destStory.
length	refers to the length of the source story before the merge.
useAppendingStoryOptions	(J feature) if true then the frame grid of the source story will be used for the merged stories.

Returns

void

virtual void IMergeStoriesSignalData::SetState ( State  state )

pure virtual

Used to set the state that the command was in when this signal was sent. INTERNAL USE ONLY

Parameters

state

see comments on the State enum.

Returns

void

virtual bool16 IMergeStoriesSignalData::UseAppendingStoryOptions ( ) const

pure virtual

Use the frame grid of the appending story will be used for the merged story result

Returns

if true the target storise frame grid will be used instead of the target stories.