IInCopyUIColors.h

//========================================================================================
// 
// $File$
// 
// Owner: Kevin Van Wiel
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
// 
// (November 9 2000) IInCopyUIColors2 interface is added in InCopy v1.1 to provide
// different shades of a user's chosen Note & Track Changes color for their note versus
// their track change hilite. This was necessary in order to be able to see the note
// anchors within inserted text without having to hide the track change hilite. This
// interface and the corresponding GetNoteColor() and GetTrackChangeColor() methods
// should be used instead of the GetColor() method. GetColor() is still supported for
// backward compatibility but will return the InCopy v1.0 color values.
// 
// Used to store and retrieve some rgb colors for use in the notes and 
// track changes UI. List is non-editable. The ordering of the list must
// correspond to the color menu pop up list the notechangesprefs panel.
// 
//========================================================================================

#ifndef __IInCopyUIColors__
#define __IInCopyUIColors__

#include "IPMUnknown.h"
#include "IInterfaceColors.h"
#include "InCopySharedID.h"

class IInCopyUIColors : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IINCOPYUICOLORS };

 virtual int32 GetColorCount() const = 0;

 virtual RealAGMColor GetColorValue(int32 index) const = 0;

 virtual RealAGMColor GetColorValue(PMString name) const = 0;

 virtual PMString GetColorName(int32 index) const = 0;

 virtual PMString GetColorName(RealAGMColor agmColor) const = 0;

 virtual bool SetDefault(int32 index) = 0;

 virtual RealAGMColor GetDefaultColor() const = 0;
 
 virtual ScriptID GetEnumeration(int32 index) const = 0;
 
 virtual int32 GetEnumerationIndex(ScriptID enumeration) const = 0;

 virtual int32 GetColorIndex(const PMString & colorName) const = 0;
};

#endif // __IInCopyUIColors__