InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ITrackChangeAppSettings Class Referenceabstract

#include <ITrackChangesSettings.h>

Inheritance diagram for ITrackChangeAppSettings:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ITRACKCHANGEAPPSETTINGS }
 
enum  ChangeBarLocation { kLeftMargin, kRightMargin }
 
enum  ChangeMarking { kNone, kStrikethrough, kUnderline, kOutline }
 
enum  ChangeTextColorChoice { kUseGalleyColor, kUseChangePrefColor }
 
enum  ChangeBackgroundColorChoice { kUseGalleyColorBG, kUseUserColorBG, kUseChangePrefColorBG }
 

Public Member Functions

virtual bool16 GetShowDeletedText () const =0
 
virtual void SetShowDeletedText (bool16 showDeletedText)=0
 
virtual bool16 GetShowAddedText () const =0
 
virtual void SetShowAddedText (bool16 showAddedText)=0
 
virtual bool16 GetShowMovedText () const =0
 
virtual void SetShowMovedText (bool16 showMovedText)=0
 
virtual bool16 GetShowChangeBars () const =0
 
virtual void SetShowChangeBars (bool16 showChangeBars)=0
 
virtual int32 GetChangeBarColorIndex () const =0
 
virtual void SetChangeBarColorIndex (int32 colorIndex)=0
 
virtual bool16 GetUserCanTurnOnOffTrackChanges () const =0
 
virtual void SetUserCanTurnOnOffTrackChanges (bool16 canTOO)=0
 
virtual bool16 GetUserCanAcceptRejectChanges () const =0
 
virtual void SetUserCanAcceptRejectChanges (bool16 canAR)=0
 
virtual bool16 GetTrackingState () const =0
 
virtual void SetTrackingState (bool16 trackingState)=0
 
virtual bool16 GetSpellChkDeletedText () const =0
 
virtual void SetSpellChkDeletedText (bool16 spellchkState)=0
 
virtual bool16 GetPreventDupeColor () const =0
 
virtual void SetPreventDupeColor (bool16 preventDupeColor)=0
 
virtual int32 GetAddedTextColorIndex () const =0
 
virtual void SetAddedTextColorIndex (int32 colorIndex)=0
 
virtual int32 GetAddedBGColorIndex () const =0
 
virtual void SetAddedBGColorIndex (int32 colorIndex)=0
 
virtual int32 GetDeletedTextColorIndex () const =0
 
virtual void SetDeletedTextColorIndex (int32 colorIndex)=0
 
virtual int32 GetDeletedBGColorIndex () const =0
 
virtual void SetDeletedBGColorIndex (int32 colorIndex)=0
 
virtual int32 GetMovedTextColorIndex () const =0
 
virtual void SetMovedTextColorIndex (int32 colorIndex)=0
 
virtual int32 GetMovedBGColorIndex () const =0
 
virtual void SetMovedBGColorIndex (int32 colorIndex)=0
 
virtual int32 GetAddedTextMarking () const =0
 
virtual void SetAddedTextMarking (int32 marking)=0
 
virtual int32 GetDeletedTextMarking () const =0
 
virtual void SetDeletedTextMarking (int32 marking)=0
 
virtual int32 GetMovedTextMarking () const =0
 
virtual void SetMovedTextMarking (int32 marking)=0
 
virtual int32 GetChangeBarLocation () const =0
 
virtual void SetChangeBarLocation (int32 location)=0
 
virtual ChangeTextColorChoice GetAddedTextColorChoice () const =0
 
virtual void SetAddedTextColorChoice (ChangeTextColorChoice colorChoice)=0
 
virtual ChangeBackgroundColorChoice GetAddedBGColorChoice () const =0
 
virtual void SetAddedBGColorChoice (ChangeBackgroundColorChoice colorChoice)=0
 
virtual ChangeTextColorChoice GetDeletedTextColorChoice () const =0
 
virtual void SetDeletedTextColorChoice (ChangeTextColorChoice colorChoice)=0
 
virtual ChangeBackgroundColorChoice GetDeletedBGColorChoice () const =0
 
virtual void SetDeletedBGColorChoice (ChangeBackgroundColorChoice colorChoice)=0
 
virtual ChangeTextColorChoice GetMovedTextColorChoice () const =0
 
virtual void SetMovedTextColorChoice (ChangeTextColorChoice colorChoice)=0
 
virtual ChangeBackgroundColorChoice GetMovedBGColorChoice () const =0
 
virtual void SetMovedBGColorChoice (ChangeBackgroundColorChoice colorChoice)=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

ITrackChangeAppSettings

Represents information about the track changes settings for the application.

Member Enumeration Documentation

enum ITrackChangeAppSettings::ChangeBackgroundColorChoice
Enumerator
kUseGalleyColorBG 

change background uses galley background color

kUseUserColorBG 

change background uses user color

kUseChangePrefColorBG 

change background uses change preference color

enum ITrackChangeAppSettings::ChangeBarLocation
Enumerator
kLeftMargin 

Left

kRightMargin 

Right

enum ITrackChangeAppSettings::ChangeMarking
Enumerator
kNone 

No marking

kStrikethrough 

Text has strikethrough

kUnderline 

Text has underline

kOutline 

Text has outline

enum ITrackChangeAppSettings::ChangeTextColorChoice
Enumerator
kUseGalleyColor 

change text uses galley text color

kUseChangePrefColor 

change text uses change preference color

Member Function Documentation

virtual ChangeBackgroundColorChoice ITrackChangeAppSettings::GetAddedBGColorChoice () const
pure virtual

background color choice for added text

Returns
color choice
virtual int32 ITrackChangeAppSettings::GetAddedBGColorIndex () const
pure virtual

background color for added text

Returns
color index
virtual ChangeTextColorChoice ITrackChangeAppSettings::GetAddedTextColorChoice () const
pure virtual

text color choice for added text

Returns
color choice
virtual int32 ITrackChangeAppSettings::GetAddedTextColorIndex () const
pure virtual

text color for added text

Returns
color index
virtual int32 ITrackChangeAppSettings::GetAddedTextMarking () const
pure virtual

marking for added text

Returns
marking
virtual int32 ITrackChangeAppSettings::GetChangeBarColorIndex () const
pure virtual

change bar color

Returns
color index
virtual int32 ITrackChangeAppSettings::GetChangeBarLocation () const
pure virtual

location for change bar

Returns
location
virtual ChangeBackgroundColorChoice ITrackChangeAppSettings::GetDeletedBGColorChoice () const
pure virtual

background color choice for Deleted text

Returns
color choice
virtual int32 ITrackChangeAppSettings::GetDeletedBGColorIndex () const
pure virtual

background color for deleted text

Returns
color index
virtual ChangeTextColorChoice ITrackChangeAppSettings::GetDeletedTextColorChoice () const
pure virtual

text color choice for Deleted text

Returns
color choice
virtual int32 ITrackChangeAppSettings::GetDeletedTextColorIndex () const
pure virtual

text color for deleted text

Returns
color index
virtual int32 ITrackChangeAppSettings::GetDeletedTextMarking () const
pure virtual

marking for deleted text

Returns
marking
virtual ChangeBackgroundColorChoice ITrackChangeAppSettings::GetMovedBGColorChoice () const
pure virtual

background color choice for Moved text

Returns
color choice
virtual int32 ITrackChangeAppSettings::GetMovedBGColorIndex () const
pure virtual

background color for moved text

Returns
color index
virtual ChangeTextColorChoice ITrackChangeAppSettings::GetMovedTextColorChoice () const
pure virtual

text color choice for Moved text

Returns
color choice
virtual int32 ITrackChangeAppSettings::GetMovedTextColorIndex () const
pure virtual

text color for moved text

Returns
color index
virtual int32 ITrackChangeAppSettings::GetMovedTextMarking () const
pure virtual

marking for moved text

Returns
marking
virtual bool16 ITrackChangeAppSettings::GetPreventDupeColor () const
pure virtual

prevent duplicate user color or not for tracked changes background color

Returns
kTrue to prevent duplicate user color
virtual bool16 ITrackChangeAppSettings::GetShowAddedText () const
pure virtual

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

Returns
kTrue if deleted text is showing
virtual bool16 ITrackChangeAppSettings::GetShowChangeBars () const
pure virtual

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

Returns
kTrue if deleted text is showing
virtual bool16 ITrackChangeAppSettings::GetShowDeletedText () const
pure virtual

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

Returns
kTrue if deleted text is showing
virtual bool16 ITrackChangeAppSettings::GetShowMovedText () const
pure virtual

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

Returns
kTrue if deleted text is showing
virtual bool16 ITrackChangeAppSettings::GetSpellChkDeletedText () const
pure virtual

deleted text should be included in spell checking or not

Returns
kTrue if deleted text is included
virtual bool16 ITrackChangeAppSettings::GetTrackingState () const
pure virtual

the application tracking state; used to initialize new stories tracking state in incopy

Returns
kTrue if tracking is enabled
virtual bool16 ITrackChangeAppSettings::GetUserCanAcceptRejectChanges () const
pure virtual

user can accept/reject track changes; for system integrators to modify the app default behavior

Returns
kTrue is user can accept or reject
virtual bool16 ITrackChangeAppSettings::GetUserCanTurnOnOffTrackChanges () const
pure virtual

user can turn on/off track changes; for system integrators to modify the app default behavior

Returns
kTrue is user can turn on or off
virtual void ITrackChangeAppSettings::SetAddedBGColorChoice (ChangeBackgroundColorChoice colorChoice)
pure virtual

background color choice for added text

Parameters
colorchoice
virtual void ITrackChangeAppSettings::SetAddedBGColorIndex (int32 colorIndex)
pure virtual

background color for added text

Parameters
colorindex
virtual void ITrackChangeAppSettings::SetAddedTextColorChoice (ChangeTextColorChoice colorChoice)
pure virtual

text color choice for added text

Parameters
colorchoice
virtual void ITrackChangeAppSettings::SetAddedTextColorIndex (int32 colorIndex)
pure virtual

text color for added text

Parameters
colorindex
virtual void ITrackChangeAppSettings::SetAddedTextMarking (int32 marking)
pure virtual

marking for added text

Parameters
marking
virtual void ITrackChangeAppSettings::SetChangeBarColorIndex (int32 colorIndex)
pure virtual

change bar color

Parameters
colorindex
virtual void ITrackChangeAppSettings::SetChangeBarLocation (int32 location)
pure virtual

location for change bar

Parameters
location
virtual void ITrackChangeAppSettings::SetDeletedBGColorChoice (ChangeBackgroundColorChoice colorChoice)
pure virtual

background color choice for Deleted text

Parameters
colorchoice
virtual void ITrackChangeAppSettings::SetDeletedBGColorIndex (int32 colorIndex)
pure virtual

background color for deleted text

Parameters
colorindex
virtual void ITrackChangeAppSettings::SetDeletedTextColorChoice (ChangeTextColorChoice colorChoice)
pure virtual

text color choice for Deleted text

Parameters
colorchoice
virtual void ITrackChangeAppSettings::SetDeletedTextColorIndex (int32 colorIndex)
pure virtual

text color for deleted text

Parameters
colorindex
virtual void ITrackChangeAppSettings::SetDeletedTextMarking (int32 marking)
pure virtual

marking for deleted text

Parameters
marking
virtual void ITrackChangeAppSettings::SetMovedBGColorChoice (ChangeBackgroundColorChoice colorChoice)
pure virtual

background color choice for Moved text

Parameters
colorchoice
virtual void ITrackChangeAppSettings::SetMovedBGColorIndex (int32 colorIndex)
pure virtual

background color for moved text

Parameters
colorindex
virtual void ITrackChangeAppSettings::SetMovedTextColorChoice (ChangeTextColorChoice colorChoice)
pure virtual

text color choice for Moved text

Parameters
colorchoice
virtual void ITrackChangeAppSettings::SetMovedTextColorIndex (int32 colorIndex)
pure virtual

text color for moved text

Parameters
colorindex
virtual void ITrackChangeAppSettings::SetMovedTextMarking (int32 marking)
pure virtual

marking for moved text

Parameters
marking
virtual void ITrackChangeAppSettings::SetPreventDupeColor (bool16 preventDupeColor)
pure virtual

prevent duplicate user color or not for tracked changes background color

Parameters
whetheror not to prevent duplicate user color
virtual void ITrackChangeAppSettings::SetShowAddedText (bool16 showAddedText)
pure virtual

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

Parameters
whetheror not to show added text
virtual void ITrackChangeAppSettings::SetShowChangeBars (bool16 showChangeBars)
pure virtual

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

Parameters
whetheror not to show change bars
virtual void ITrackChangeAppSettings::SetShowDeletedText (bool16 showDeletedText)
pure virtual

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

Parameters
whetheror not to show deleted text
virtual void ITrackChangeAppSettings::SetShowMovedText (bool16 showMovedText)
pure virtual

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

Parameters
whetheror not to show moved text
virtual void ITrackChangeAppSettings::SetSpellChkDeletedText (bool16 spellchkState)
pure virtual

deleted text should be included in spell checking or not

Parameters
whetheror not to show change bars
virtual void ITrackChangeAppSettings::SetTrackingState (bool16 trackingState)
pure virtual

the application tracking state; used to initialize new stories tracking state in incopy

Parameters
whetheror not to track changes
virtual void ITrackChangeAppSettings::SetUserCanAcceptRejectChanges (bool16 canAR)
pure virtual

user can accept/reject track changes; for system integrators to modify the app default behavior

Parameters
whetheror not user can accept/reject
virtual void ITrackChangeAppSettings::SetUserCanTurnOnOffTrackChanges (bool16 canTOO)
pure virtual

user can turn on/off track changes; for system integrators to modify the app default behavior

Parameters
whetheror not user can turn on/off