#include <ITextModelCmds.h>

Inheritance diagram for ITextModelCmds:

Public Types
enum	{ kDefaultIID = IID_ITEXTMODELCMDS }

Public Member Functions
virtual ICommand *	PasteCmd (TextIndex position, const boost::shared_ptr< PasteData > &data, bool16 ignoreAttributes=kFalse)=0

virtual ICommand *	PasteCmd (const RangeData &r, const boost::shared_ptr< PasteData > &data, bool16 ignoreAttributes=kFalse)=0

virtual ICommand *	InsertCmd (TextIndex position, const boost::shared_ptr< WideString > &data, const ILanguage *language=nil)=0

virtual ICommand *	InsertCmd (const RangeData &r, const boost::shared_ptr< WideString > &data, const ILanguage *language=nil)=0

virtual ICommand *	DeleteCmd (TextIndex start, int32 length, bool16 ignoreLock=kFalse)=0

virtual ICommand *	DeleteCmd (const RangeData &range, bool16 ignoreLock=kFalse)=0

virtual ICommand *	ReplaceCmd (TextIndex start, int32 length, const boost::shared_ptr< WideString > &insert, const ILanguage *language=nil, bool16 clearNonContinuingAttrs=kTrue)=0

virtual ICommand *	TypeTextCmd (TextIndex startPosition, TextIndex endPosition, const boost::shared_ptr< WideString > &insert, const ILanguage *language=nil)=0

virtual ICommand *	TypeTextCmd (const RangeData &range, const boost::shared_ptr< WideString > &insert, const ILanguage *language=nil)=0

virtual ICommand *	ApplyCmd (TextIndex start, int32 length, const boost::shared_ptr< AttributeBossList > &list, ClassID whichStrand)=0

virtual ICommand *	ApplyCmd (const RangeData &range, const boost::shared_ptr< AttributeBossList > &list, ClassID whichStrand)=0

virtual ICommand *	ApplyStyleCmd (TextIndex start, int32 length, UID stylerefid, ClassID whichStrand, bool16 replaceOverrides=kTrue, bool16 autoNextStyle=kFalse, bool16 keepOldStyleAsOverrides=kTrue)=0

virtual ICommand *	UnapplyStyleCmd (TextIndex start, int32 length, ClassID whichStrand)=0

virtual ICommand *	ClearOverridesCmd (TextIndex start, int32 length, const boost::shared_ptr< AttributeBossList > &these, ClassID whichStrand)=0

virtual ICommand *	UserApplyCmd (TextIndex start, int32 length, const boost::shared_ptr< AttributeBossList > &list, ClassID whichStrand)=0

virtual ICommand *	RegisterStrandCmd (UID strand)=0

virtual ICommand *	UnregisterStrandCmd (UID strand)=0

virtual ICommand *	ReplaceCmd (const boost::shared_ptr< ITextModel::ReplacementList > &replacementList, const ILanguage *language=nil, bool16 clearNonContinuingAttrs=kTrue)=0

virtual TextEditAction *	GetApplyTextStyle_Action (TextIndex start, int32 len, UID style, const boost::shared_ptr< AttributeBossList > &overrides, ClassID which, bool16 destroyOverrides, bool16 autoNextStyle, bool16 keepOldStyleAsOverrides=kTrue)=0

virtual TextEditAction *	GetReplaceText_Action (TextIndex start, int32 oldLen, const boost::shared_ptr< WideString > &insertData, ILanguage *pLanguage, bool16 clearNonContinuingAttrs=kTrue)=0

virtual TextEditAction *	GetUserApplyAttr_Action (TextIndex start, int32 len, UID style, const boost::shared_ptr< AttributeBossList > &over, ClassID which, bool16 destroyLocalOverrides, bool16 autoNextStyle, bool16 keepOldStyleAsOverrides=kTrue, IFontLockingData::FontLockLevel fontLocking=IFontLockingData::kAllowFontLockingWithOverride)=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 is a Text story interface. It serves to query for text edit commands to operate on the story. The functions in this interface used to be part of the ITextModel interface.

Member Function Documentation

virtual ICommand* ITextModelCmds::ApplyCmd	(	TextIndex	start,
		int32	length,
		const boost::shared_ptr< AttributeBossList > &	list,
		ClassID	whichStrand
	)

pure virtual

Returns: a new apply attributes command.

Parameters

start	IN start of apply range.
length	IN length of apply range.
list	IN shared pointer of attribute boss list to apply.

See Also: K2SmartPtr for usage of shared_ptr.

Parameters

whichStrand IN whether the attributes applied are paragraph or a character attributes.

virtual ICommand* ITextModelCmds::ApplyCmd	(	const RangeData &	range,
		const boost::shared_ptr< AttributeBossList > &	list,
		ClassID	whichStrand
	)

pure virtual

Returns: a new apply attributes command.

Parameters

range	IN apply range.
list	IN shared pointer of attribute boss list to apply.

See Also: K2SmartPtr for usage of shared_ptr.

Parameters

whichStrand IN whether the attributes applied are paragraph or a character attributes.

virtual ICommand* ITextModelCmds::ApplyStyleCmd	(	TextIndex	start,
		int32	length,
		UID	stylerefid,
		ClassID	whichStrand,
		bool16	replaceOverrides = `kTrue`,
		bool16	autoNextStyle = `kFalse`,
		bool16	keepOldStyleAsOverrides = `kTrue`
	)

pure virtual

Returns: a new apply style command which applies a style.

Parameters

start	IN start of apply range.
length	IN length of apply range.
stylerefid	IN style to apply.
whichStrand	IN whether the attributes applied are paragraph or a character attributes.
replaceOverrides	IN whether to clear the overrides.
keepOldStyleAsOverrides	IN whether to apply the old style as overrides before setting new style. This variable is only used if stylerefid is the root style.

virtual ICommand* ITextModelCmds::ClearOverridesCmd	(	TextIndex	start,
		int32	length,
		const boost::shared_ptr< AttributeBossList > &	these,
		ClassID	whichStrand
	)

pure virtual

Returns: a new command which clears specific attributes from a range

Parameters

start	IN start of clear range.
length	IN length of clear range.
these	IN attributes to clear.
whichStrand	IN whether paragraph or character attributes need to be cleared.

virtual ICommand* ITextModelCmds::DeleteCmd	(	TextIndex	start,
		int32	length,
		bool16	ignoreLock = `kFalse`
	)

pure virtual

Returns: a new delete text command.

Parameters

start	IN start of delete range.
length	IN length of delete range.
ignoreLock	IN will bypass checking for locked story

virtual ICommand* ITextModelCmds::DeleteCmd	(	const RangeData &	range,
		bool16	ignoreLock = `kFalse`
	)

pure virtual

Returns: a new delete text command.

Parameters

range	IN delete range.
ignoreLock	IN will bypass checking for locked story

virtual TextEditAction* ITextModelCmds::GetApplyTextStyle_Action	(	TextIndex	start,
		int32	len,
		UID	style,
		const boost::shared_ptr< AttributeBossList > &	overrides,
		ClassID	which,
		bool16	destroyOverrides,
		bool16	autoNextStyle,
		bool16	keepOldStyleAsOverrides = `kTrue`
	)

pure virtual

For internal use only.

virtual ICommand* ITextModelCmds::InsertCmd	(	TextIndex	position,
		const boost::shared_ptr< WideString > &	data,
		const ILanguage *	language = `nil`
	)

pure virtual

Returns: a new command that inserts text into the story.

Parameters

position	IN text index where to insert text.
data	IN text to insert. This is a shared pointer.

See Also: K2SmartPtr for usage of shared_ptr.

Parameters

language IN language of inserted text.

virtual ICommand* ITextModelCmds::InsertCmd	(	const RangeData &	r,
		const boost::shared_ptr< WideString > &	data,
		const ILanguage *	language = `nil`
	)

pure virtual

For internal use only.

virtual ICommand* ITextModelCmds::PasteCmd	(	TextIndex	position,
		const boost::shared_ptr< PasteData > &	data,
		bool16	ignoreAttributes = `kFalse`
	)

pure virtual

Returns: a new command that pastes text into a story.

Parameters

position	IN insert position.
data	IN pasted text data. data is gathered by the caller as the result of calling ITextModel::CopyRange or ITextModel::Cut. This is a shared pointer.

See Also: K2SmartPtr for usage of shared_ptr.

Parameters

ignoreAttributes to indicate ignore attributes when paste

virtual ICommand* ITextModelCmds::PasteCmd	(	const RangeData &	r,
		const boost::shared_ptr< PasteData > &	data,
		bool16	ignoreAttributes = `kFalse`
	)

pure virtual

For internal use only.

virtual ICommand* ITextModelCmds::RegisterStrandCmd ( UID strand )

pure virtual

Returns: a new command which registers a strand with the text model.

Parameters

strand IN strand uid.

virtual ICommand* ITextModelCmds::ReplaceCmd	(	TextIndex	start,
		int32	length,
		const boost::shared_ptr< WideString > &	insert,
		const ILanguage *	language = `nil`,
		bool16	clearNonContinuingAttrs = `kTrue`
	)

pure virtual

Returns: a new Replace Text command.

Parameters

start	IN start of replace range.
length	IN length of replace range.
insert	IN replacement text. This is a shared pointer.

See Also: K2SmartPtr for usage of shared_ptr.

Parameters

language	IN language of inserted text.
clearNonContinuingAttrs	IN clear non continuing attributes after doing the replace.

virtual ICommand* ITextModelCmds::ReplaceCmd	(	const boost::shared_ptr< ITextModel::ReplacementList > &	replacementList,
		const ILanguage *	language = `nil`,
		bool16	clearNonContinuingAttrs = `kTrue`
	)

pure virtual

Returns: a new multiple replacement Text command.

Parameters

replList IN is a shared pointer and constitutes the requested list of replacements. This is an optimized way to do more than one replacement at a time. The replacement list must be in assending order of text indices (

See Also: ITextModel).; K2SmartPtr for usage of shared_ptr.

Parameters

language	IN indicates the language of the replacement text.
clearNonContinuingAttrs	IN clear non continuing attributes after doing each replacement.

virtual ICommand* ITextModelCmds::TypeTextCmd	(	TextIndex	startPosition,
		TextIndex	endPosition,
		const boost::shared_ptr< WideString > &	insert,
		const ILanguage *	language = `nil`
	)

pure virtual

Returns: a new type text command. If the length of the range passed in is greater than zero the text in the range is actually deleted.

Parameters

startPosition	IN start of range.
endPosition	IN end of range.
insert	IN is a shared pointer that constitutes what actually gets inserted into the story.

See Also: K2SmartPtr for usage of shared_ptr.

Parameters

language IN language of inserted text.

virtual ICommand* ITextModelCmds::TypeTextCmd	(	const RangeData &	range,
		const boost::shared_ptr< WideString > &	insert,
		const ILanguage *	language = `nil`
	)

pure virtual

Returns: a new type text command. If the length of the range passed in is greater than zero the text in the range is actually deleted.

Parameters

range	IN range.
insert	IN is a shared pointer that constitutes what actually gets inserted into the story.

See Also: K2SmartPtr for usage of shared_ptr.

Parameters

language IN language of inserted text.

virtual ICommand* ITextModelCmds::UnapplyStyleCmd	(	TextIndex	start,
		int32	length,
		ClassID	whichStrand
	)

pure virtual

Returns: a new command which removes all applied styles within a range.

Parameters

start	IN start of range.
length	IN length of range.
whichStrand	IN whether paragraph or character styles need to be removed.

virtual ICommand* ITextModelCmds::UnregisterStrandCmd ( UID strand )

pure virtual

Returns: a new command which unregisters a strand from the text model.

Parameters

strand IN strand uid

virtual ICommand* ITextModelCmds::UserApplyCmd	(	TextIndex	start,
		int32	length,
		const boost::shared_ptr< AttributeBossList > &	list,
		ClassID	whichStrand
	)

pure virtual

Returns: a new apply attributes command which applies attributes to a range.

Parameters

start	IN start of apply range.
length	IN length of apply range.
list	IN shared pointer of attribute boss list to apply.

See Also: K2SmartPtr for usage of shared_ptr.

Parameters

whichStrand IN whether the attributes applied are paragraph or a character attributes.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation