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

#include <ISetUserColorsCmdData.h>

Inheritance diagram for ISetUserColorsCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISETUSERCOLORSCMDDATA }
 
enum  { kInvalidColorIndex = -1 }
 

Public Member Functions

virtual void Set (PMString newName, int32 newColorIndex)=0
 
virtual PMString UserName () const =0
 
virtual int32 UserColorIndex () const =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

Member Function Documentation

virtual void ISetUserColorsCmdData::Set (PMString newName,
int32 newColorIndex 
)
pure virtual

Set the current user name and color.

Parameters
INnewName new user name
INnewColorIndex new color index for this user
Returns
void
virtual int32 ISetUserColorsCmdData::UserColorIndex () const
pure virtual

Gets the current user color.

Returns
int32 index of the current user color
virtual PMString ISetUserColorsCmdData::UserName () const
pure virtual

Gets the current user name.

Returns
PMString name of the current user