#include <ITrackChangesPrefsCmdData.h>

Inheritance diagram for ITrackChangesPrefsCmdData:

Public Member Functions
virtual void	Set (bool16 showAddedText, bool16 showDeletedText, bool16 showMovedText, bool16 showChangeBar, int32 cbColorIndex, bool16 spellchkDeletedText, bool16 preventDupeColor, int32 addedTextColorIndex, int32 addedBGColorIndex, int32 deletedTextColorIndex, int32 deletedBGColorIndex, int32 movedTextColorIndex, int32 movedBGColorIndex, int32 addedTextMarking, int32 deletedTextMarking, int32 movedTextMarking, int32 cbLocation, ITrackChangeAppSettings::ChangeTextColorChoice addedTextColorChoice, ITrackChangeAppSettings::ChangeBackgroundColorChoice addedBGColorChoice, ITrackChangeAppSettings::ChangeTextColorChoice deletedTextColorChoice, ITrackChangeAppSettings::ChangeBackgroundColorChoice deletedBGColorChoice, ITrackChangeAppSettings::ChangeTextColorChoice movedTextColorChoice, ITrackChangeAppSettings::ChangeBackgroundColorChoice movedBGColorChoice)=0

virtual void	SetShowAddedText (const bool16 showAdded)=0

virtual void	SetShowDeletedText (const bool16 showDeleted)=0

virtual void	SetShowMovedText (const bool16 showMoved)=0

virtual void	SetShowChangeBars (const bool16 showChangeBars)=0

virtual void	SetChangeBarColorIndex (const int32 val)=0

virtual void	SetSpellChkDeletedText (const bool16 val)=0

virtual void	SetPreventDupeColor (const bool16 val)=0

virtual void	SetAddedTextColorIndex (const int32 colorIndex)=0

virtual void	SetAddedBGColorIndex (const int32 colorIndex)=0

virtual void	SetDeletedTextColorIndex (const int32 colorIndex)=0

virtual void	SetDeletedBGColorIndex (const int32 colorIndex)=0

virtual void	SetMovedTextColorIndex (const int32 colorIndex)=0

virtual void	SetMovedBGColorIndex (const int32 colorIndex)=0

virtual void	SetAddedTextMarking (const int32 marking)=0

virtual void	SetDeletedTextMarking (const int32 marking)=0

virtual void	SetMovedTextMarking (const int32 marking)=0

virtual void	SetChangeBarLocation (const int32 location)=0

virtual void	SetAddedTextColorChoice (const ITrackChangeAppSettings::ChangeTextColorChoice colorChoice)=0

virtual void	SetAddedBGColorChoice (const ITrackChangeAppSettings::ChangeBackgroundColorChoice colorChoice)=0

virtual void	SetDeletedTextColorChoice (const ITrackChangeAppSettings::ChangeTextColorChoice colorChoice)=0

virtual void	SetDeletedBGColorChoice (const ITrackChangeAppSettings::ChangeBackgroundColorChoice colorChoice)=0

virtual void	SetMovedTextColorChoice (const ITrackChangeAppSettings::ChangeTextColorChoice colorChoice)=0

virtual void	SetMovedBGColorChoice (const ITrackChangeAppSettings::ChangeBackgroundColorChoice colorChoice)=0

virtual const bool16	GetShowAddedText () const =0

virtual const bool16	GetShowDeletedText () const =0

virtual const bool16	GetShowMovedText () const =0

virtual const bool16	GetShowChangeBars () const =0

virtual const int32	GetChangeBarColorIndex () const =0

virtual const bool16	GetSpellChkDeletedText () const =0

virtual const bool16	GetPreventDupeColor () const =0

virtual const int32	GetAddedTextColorIndex () const =0

virtual const int32	GetAddedBGColorIndex () const =0

virtual const int32	GetDeletedTextColorIndex () const =0

virtual const int32	GetDeletedBGColorIndex () const =0

virtual const int32	GetMovedTextColorIndex () const =0

virtual const int32	GetMovedBGColorIndex () const =0

virtual const int32	GetAddedTextMarking () const =0

virtual const int32	GetDeletedTextMarking () const =0

virtual const int32	GetMovedTextMarking () const =0

virtual const int32	GetChangeBarLocation () const =0

virtual const ITrackChangeAppSettings::ChangeTextColorChoice	GetAddedTextColorChoice () const =0

virtual const ITrackChangeAppSettings::ChangeBackgroundColorChoice	GetAddedBGColorChoice () const =0

virtual const ITrackChangeAppSettings::ChangeTextColorChoice	GetDeletedTextColorChoice () const =0

virtual const ITrackChangeAppSettings::ChangeBackgroundColorChoice	GetDeletedBGColorChoice () const =0

virtual const ITrackChangeAppSettings::ChangeTextColorChoice	GetMovedTextColorChoice () const =0

virtual const ITrackChangeAppSettings::ChangeBackgroundColorChoice	GetMovedBGColorChoice () 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

ITrackChangesPrefsCmdData is a data interface for the kSetTrackChangesPrefsCmdBoss. It is used to specify the options for the track changes preferences.

See Also: ITrackChangeAppSettings in ITrackChangesSettings.h

Member Function Documentation

virtual const ITrackChangeAppSettings::ChangeBackgroundColorChoice ITrackChangesPrefsCmdData::GetAddedBGColorChoice ( ) const

pure virtual

background color choice for added text

Returns: color choice

virtual const int32 ITrackChangesPrefsCmdData::GetAddedBGColorIndex ( ) const

pure virtual

background color for added text

Returns: color index

virtual const ITrackChangeAppSettings::ChangeTextColorChoice ITrackChangesPrefsCmdData::GetAddedTextColorChoice ( ) const

pure virtual

text color choice for added text

Returns: color choice

virtual const int32 ITrackChangesPrefsCmdData::GetAddedTextColorIndex ( ) const

pure virtual

text color for added text

Returns: color index

virtual const int32 ITrackChangesPrefsCmdData::GetAddedTextMarking ( ) const

pure virtual

marking for added text

Returns: marking

virtual const int32 ITrackChangesPrefsCmdData::GetChangeBarColorIndex ( ) const

pure virtual

change bar color

Returns: color index

virtual const int32 ITrackChangesPrefsCmdData::GetChangeBarLocation ( ) const

pure virtual

location for change bar

Returns: location

virtual const ITrackChangeAppSettings::ChangeBackgroundColorChoice ITrackChangesPrefsCmdData::GetDeletedBGColorChoice ( ) const

pure virtual

background color choice for Deleted text

Returns: color choice

virtual const int32 ITrackChangesPrefsCmdData::GetDeletedBGColorIndex ( ) const

pure virtual

background color for deleted text

Returns: color index

virtual const ITrackChangeAppSettings::ChangeTextColorChoice ITrackChangesPrefsCmdData::GetDeletedTextColorChoice ( ) const

pure virtual

text color choice for Deleted text

Returns: color choice

virtual const int32 ITrackChangesPrefsCmdData::GetDeletedTextColorIndex ( ) const

pure virtual

text color for deleted text

Returns: color index

virtual const int32 ITrackChangesPrefsCmdData::GetDeletedTextMarking ( ) const

pure virtual

marking for deleted text

Returns: marking

virtual const ITrackChangeAppSettings::ChangeBackgroundColorChoice ITrackChangesPrefsCmdData::GetMovedBGColorChoice ( ) const

pure virtual

background color choice for Moved text

Returns: color choice

virtual const int32 ITrackChangesPrefsCmdData::GetMovedBGColorIndex ( ) const

pure virtual

background color for moved text

Returns: color index

virtual const ITrackChangeAppSettings::ChangeTextColorChoice ITrackChangesPrefsCmdData::GetMovedTextColorChoice ( ) const

pure virtual

text color choice for Moved text

Returns: color choice

virtual const int32 ITrackChangesPrefsCmdData::GetMovedTextColorIndex ( ) const

pure virtual

text color for moved text

Returns: color index

virtual const int32 ITrackChangesPrefsCmdData::GetMovedTextMarking ( ) const

pure virtual

marking for moved text

Returns: marking

virtual const bool16 ITrackChangesPrefsCmdData::GetPreventDupeColor ( ) const

pure virtual

prevent duplicate user color or not

Returns: kTrue to prevent duplicate user color

virtual const bool16 ITrackChangesPrefsCmdData::GetShowAddedText ( ) const

pure virtual

added text should show or not (when changes are showing)

Returns: kTrue if deleted text is showing

virtual const bool16 ITrackChangesPrefsCmdData::GetShowChangeBars ( ) const

pure virtual

change bars should show or not (when changes are showing)

Returns: kTrue if deleted text is showing

virtual const bool16 ITrackChangesPrefsCmdData::GetShowDeletedText ( ) const

pure virtual

deleted text should show or not (when changes are showing)

Returns: kTrue if deleted text is showing

virtual const bool16 ITrackChangesPrefsCmdData::GetShowMovedText ( ) const

pure virtual

moved text should show or not (when changes are showing)

Returns: kTrue if deleted text is showing

virtual const bool16 ITrackChangesPrefsCmdData::GetSpellChkDeletedText ( ) const

pure virtual

deleted text should be included in spell checking or not

Returns: kTrue if deleted text is included

virtual void ITrackChangesPrefsCmdData::Set	(	bool16	showAddedText,
		bool16	showDeletedText,
		bool16	showMovedText,
		bool16	showChangeBar,
		int32	cbColorIndex,
		bool16	spellchkDeletedText,
		bool16	preventDupeColor,
		int32	addedTextColorIndex,
		int32	addedBGColorIndex,
		int32	deletedTextColorIndex,
		int32	deletedBGColorIndex,
		int32	movedTextColorIndex,
		int32	movedBGColorIndex,
		int32	addedTextMarking,
		int32	deletedTextMarking,
		int32	movedTextMarking,
		int32	cbLocation,
		ITrackChangeAppSettings::ChangeTextColorChoice	addedTextColorChoice,
		ITrackChangeAppSettings::ChangeBackgroundColorChoice	addedBGColorChoice,
		ITrackChangeAppSettings::ChangeTextColorChoice	deletedTextColorChoice,
		ITrackChangeAppSettings::ChangeBackgroundColorChoice	deletedBGColorChoice,
		ITrackChangeAppSettings::ChangeTextColorChoice	movedTextColorChoice,
		ITrackChangeAppSettings::ChangeBackgroundColorChoice	movedBGColorChoice
	)

pure virtual

use this to set all track changes prefs command data in one call

Parameters

showAddedText	whether or not to show added text
showDeletedText	whether or not to show deleted text
showMovedText	whether or not to show moved text
showChangeBar	whether or not to show change bars
cbColorIndex	change bar color index
spellchkDeletedText	whether or not to spell check deleted text
addedTextColorIndex	added text color index
addedBGColorIndex	added text background color index
deletedTextColorIndex	deleted text color index
deletedBGColorIndex	deleted text background color index
movedTextColorIndex	moved text color index
movedBGColorIndex	moved text background color index
addedTextMarking	added text marking
deletedTextMarking	deleted text marking
movedTextMarking	moved text marking
cbLocation	change bar location
addedTextColorChoice	added text color choice
addedBGColorChoice	added text background color choice
deletedTextColorChoice	deleted text color choice
deletedBGColorChoice	deleted text background color choice
movedTextColorChoice	moved text color choice
movedBGColorChoice	moved text background color choice

virtual void ITrackChangesPrefsCmdData::SetAddedBGColorChoice ( const ITrackChangeAppSettings::ChangeBackgroundColorChoice colorChoice )

pure virtual

background color choice for added text

Parameters

colorChoice

virtual void ITrackChangesPrefsCmdData::SetAddedBGColorIndex ( const int32 colorIndex )

pure virtual

background color for added text

Parameters

colorIndex

virtual void ITrackChangesPrefsCmdData::SetAddedTextColorChoice ( const ITrackChangeAppSettings::ChangeTextColorChoice colorChoice )

pure virtual

text color choice for added text

Parameters

colorChoice

virtual void ITrackChangesPrefsCmdData::SetAddedTextColorIndex ( const int32 colorIndex )

pure virtual

text color for added text

Parameters

colorIndex

virtual void ITrackChangesPrefsCmdData::SetAddedTextMarking ( const int32 marking )

pure virtual

marking for added text

Parameters

marking

virtual void ITrackChangesPrefsCmdData::SetChangeBarColorIndex ( const int32 val )

pure virtual

change bar color

Parameters

val	color index

virtual void ITrackChangesPrefsCmdData::SetChangeBarLocation ( const int32 location )

pure virtual

location for change bar

Parameters

location

virtual void ITrackChangesPrefsCmdData::SetDeletedBGColorChoice ( const ITrackChangeAppSettings::ChangeBackgroundColorChoice colorChoice )

pure virtual

background color choice for Deleted text

Parameters

colorChoice

virtual void ITrackChangesPrefsCmdData::SetDeletedBGColorIndex ( const int32 colorIndex )

pure virtual

background color for deleted text

Parameters

colorIndex

virtual void ITrackChangesPrefsCmdData::SetDeletedTextColorChoice ( const ITrackChangeAppSettings::ChangeTextColorChoice colorChoice )

pure virtual

text color choice for Deleted text

Parameters

colorChoice

virtual void ITrackChangesPrefsCmdData::SetDeletedTextColorIndex ( const int32 colorIndex )

pure virtual

text color for deleted text

Parameters

colorIndex

virtual void ITrackChangesPrefsCmdData::SetDeletedTextMarking ( const int32 marking )

pure virtual

marking for deleted text

Parameters

marking

virtual void ITrackChangesPrefsCmdData::SetMovedBGColorChoice ( const ITrackChangeAppSettings::ChangeBackgroundColorChoice colorChoice )

pure virtual

background color choice for Moved text

Parameters

colorChoice

virtual void ITrackChangesPrefsCmdData::SetMovedBGColorIndex ( const int32 colorIndex )

pure virtual

background color for moved text

Parameters

colorIndex

virtual void ITrackChangesPrefsCmdData::SetMovedTextColorChoice ( const ITrackChangeAppSettings::ChangeTextColorChoice colorChoice )

pure virtual

text color choice for Moved text

Parameters

colorChoice

virtual void ITrackChangesPrefsCmdData::SetMovedTextColorIndex ( const int32 colorIndex )

pure virtual

text color for moved text

Parameters

colorIndex

virtual void ITrackChangesPrefsCmdData::SetMovedTextMarking ( const int32 marking )

pure virtual

marking for moved text

Parameters

marking

virtual void ITrackChangesPrefsCmdData::SetPreventDupeColor ( const bool16 val )

pure virtual

prevent duplicate user color or not

Parameters

val	whether or not to prevent duplicate user color

virtual void ITrackChangesPrefsCmdData::SetShowAddedText ( const bool16 showAdded )

pure virtual

added text should show or not (when changes are showing)

Parameters

showAdded whether or not to show added text

virtual void ITrackChangesPrefsCmdData::SetShowChangeBars ( const bool16 showChangeBars )

pure virtual

change bars should show or not (when changes are showing)

Parameters

showChangeBars whether or not to show change bars

virtual void ITrackChangesPrefsCmdData::SetShowDeletedText ( const bool16 showDeleted )

pure virtual

deleted text should show or not (when changes are showing)

Parameters

showDeleted whether or not to show deleted text

virtual void ITrackChangesPrefsCmdData::SetShowMovedText ( const bool16 showMoved )

pure virtual

moved text should show or not (when changes are showing)

Parameters

showMoved whether or not to show moved text

virtual void ITrackChangesPrefsCmdData::SetSpellChkDeletedText ( const bool16 val )

pure virtual

deleted text should be included in spell checking or not

Parameters

val	whether or not to spell check deleted text

Public Member Functions

Detailed Description

Member Function Documentation