InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IInCopyDocUserList Class Referenceabstract

#include <IInCopyDocUserList.h>

Inheritance diagram for IInCopyDocUserList:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IINCOPYDOCUSERLIST }
 

Public Member Functions

virtual void AppendUser (const PMString &userName, int32 userColor)=0
 
virtual PMString GetUserNameByIndex (int32 index)=0
 
virtual int32 FindUserByName (const PMString &userName)=0
 
virtual int32 GetUserColorIndex (int32 index)=0
 
virtual int32 GetUserColorIndex (const PMString &userName)=0
 
virtual int32 GetUniqueUserColorIndex (int32 index)=0
 
virtual int32 GetUniqueUserColorIndex (const PMString &userName)=0
 
virtual void ReplaceColorIndex (const PMString &userName, int32 newColorIndex)=0
 
virtual void ReplaceColorIndex (const int32 userIndex, int32 newColorIndex)=0
 
virtual bool DeleteUser (int32 index)=0
 
virtual bool DeleteUser (const PMString &userName)=0
 
virtual int32 GetUserCount () const =0
 
virtual PMString GetCurrentUser (bool16 *added=nil)=0
 
virtual void SetUserName (const PMString &oldUserName, const PMString &newUserName)=0
 
virtual void SetUserName (const int32 userIndex, const PMString &newUserName)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Detailed Description

This interface is used to add users to a list this list is used by the track changes and notes features. Every user has a color associated with them. No enforcement of a unique color per user is performed. The index for a color is assumed to be from the IRGBColorList interface.