iuicolorutils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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.
// 
//========================================================================================

#ifndef __IUIColorUtils__
#define __IUIColorUtils__

#include "AppFrameworkID.h"
#include "IPMUnknown.h"
#include "Utils.h"

#include "IColorData.h"

#include "PMString.h"

class IScript;
class IScriptRequestData;
class IStringListControlData;
class IDocument;

// Constant used to adjust ui colors for handle shape drawing.
// Used in AdjustUIColorValue.
const PMReal kDefaultUIColorAdjust = 0.5;

class IUIColorUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IUICOLORUTILS };

 enum {
 kStockUILightBlue,
 kFirstUIColor = kStockUILightBlue,
 kStockUIRed,
 kStockUIGreen,
 kStockUIBlue,
 kStockUIYellow,
 kStockUIMagenta,
 kStockUICyan,
 kStockUIGray,
 kStockUIBlack,
 kStockUIOrange,
 kStockUIDarkGreen,
 kStockUITeal,
 kStockUITan,
 kStockUIBrown,
 kStockUIViolet,
 kStockUIGold,
 kStockUIDarkBlue,
 kStockUIPink,
 kStockUILavender,
 kStockUIBrickRed,
 kStockUIOlive,
 kStockUIPeach,
 kStockUIBurgundy,
 kStockUIGrassGreen,
 kStockUIOchre,
 kStockUIPurple,
 kStockUILightGray,

 kLastRomanUIColor = kStockUILightGray,

 kStockUICharcoal,
 kFirstJUIColor = kStockUICharcoal,
 kStockUIGridBlue,
 kStockUIGridOrange,
 kStockUIFiesta,
 kStockUILightOlive,
 kStockUILipstick,
 kStockUICuteTeal,
 kStockUISulfur,
 kStockUIGridGreen,
 kStockUIWhite,
 
 kLastJUIColor = kStockUIWhite,
 kLastUIColor = kStockUIWhite,
 
 kStockBaselineGrid = kStockUILightBlue,
 kStockMarginGuide = kStockUIMagenta,
 kStockRulerGuide = kStockUICyan,
 kStockColumnGuide = kStockUIViolet,
 kStockDocumentGrid = kStockUILightGray,
 kStockFloor = kStockUILightGray,
 kStockDynamicSpell = kStockUIRed,
 kStockDynamicSpellGrammar = kStockUIGreen,
 kStockJBaselineGrid = kStockUILightBlue,
 kStockJMarginGuide = kStockUILipstick,
 kStockJColumnGuide = kStockUILavender,
 kStockLayoutGrid = kStockUIGridGreen,
 kStockReferencePoint = kStockUITeal,
 kStockPasteboard = kStockUIWhite,
 kStockXMLTag = kStockUIGray,
 kStockPreviewBackground = kStockUILightGray

 };
 
 enum {
 kNumUIColors = kLastUIColor - kFirstUIColor + 1
 };
 
 
 enum
 {
 kRed = 0,
 kGreen,
 kBlue
 };


 virtual void BuildUIColorNameList(IStringListControlData *stringData, bool16 bAddOther = kTrue) = 0;
 
 virtual int32 GetUIColorNum( ) = 0;

 virtual PMString GetUIColorName(int32 index) = 0;

 virtual UIDRef GetUIColor(int32 stockColor, IDocument* doc) = 0;
 
 virtual int32 GetUIColorIndex(UID stockColorUID, IDocument* doc) = 0;
 
 virtual ColorArray GetStockUIColorRGBValue( int32 stockColor ) = 0;
 
 virtual ColorArray GetRGBColorValue( IDataBase* db, UID colorUID ) = 0;

 virtual ColorArray GetAdjustedUIColorValue(ColorArray& color, PMReal adjustFactor) = 0;

 //FOR SCRIPTING -----------------------------------------------------------------------

 virtual int32 GetUIColor( IScriptRequestData* data, IScript* script, const ScriptID& propID, UID colorUID = kInvalidUID, int32 colorIndex = -1 ) = 0 ;
 virtual int32 SetUIColor( IScriptRequestData* data, IScript* script, const ScriptID& propID, UID* colorUID ) = 0 ;
 
#if MACINTOSH
 // FOR INTERNAL USE ONLY
 virtual uchar* QueryPNGImageBuffer(IPMStream* stream, size_t& outLength) = 0;
#endif
};


#endif // __IUIColorUtils__