InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IPickerPanelModKeyStateData.h
1 //========================================================================================
2 //
3 // $File$
4 //
5 // Owner: SusanCL
6 //
7 // $Author$
8 //
9 // $DateTime$
10 //
11 // $Revision$
12 //
13 // $Change$
14 //
15 // Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
16 //
17 // NOTICE: Adobe permits you to use, modify, and distribute this file in accordance
18 // with the terms of the Adobe license agreement accompanying it. If you have received
19 // this file from a source other than Adobe, then your use, modification, or
20 // distribution of it requires the prior written permission of Adobe.
21 //
22 //
23 // DESC:
24 // Keep track of some KBSC key state and states of stroke or fill color data for
25 // Color Picker Panel. This is mainly used for processing user action with modifier
26 // keys in the Color Picker panel such as shift-click.
27 //
28 //========================================================================================
29 
30 #ifndef _IPickerPanelModKeyStateData_
31 #define _IPickerPanelModKeyStateData_
32 //___________________________________________________________________________________
33 // INCLUDES
34 //___________________________________________________________________________________
35 #include "ColorPickerID.h"
36 #include "IColorData.h"
37 
38 //===================================================================================
39 //___________________________________________________________________________________
40 // CLASS DECLARATION
41 //___________________________________________________________________________________
46 class IPickerPanelModKeyStateData : public IPMUnknown
47  {
48  public:
49  enum { kDefaultIID = IID_ICOLORPICKERPANELMODKEYSTATEDATA };
50 
51  //___________________________________________________________________________
52  // Set
53  //___________________________________________________________________________
54  enum
55  {
58  kPickerPanel_AltOptKeyPressed = 0x04,
61  kPickerPanel_CmdKeyPressed = 0x02,
64  kPickerPanel_ShiftKeyPressed = 0x01
65  };
66 
71  virtual void SetKeyState (int32 keyState) = 0;
75  virtual void SetStrokeUID (UID strokeColorUID) = 0;
79  virtual void SetStrokeTint (PMReal strokeTint) = 0;
83  virtual void SetStrokeIsGlobal (bool16 isGlobal) = 0;
87  virtual void SetFillUID (UID fillColorUID) = 0;
91  virtual void SetFillTint (PMReal fillTint) = 0;
95  virtual void SetFillIsGlobal (bool16) = 0;
96 
102  virtual void UpdateStrokeColorspaceColorData (int32 colorspace, const ColorArray& colorValues, const PMReal& tint) = 0;
108  virtual void UpdateFillColorspaceColorData (int32 colorspace, const ColorArray& colorValues, const PMReal& tint) = 0;
109 
112  virtual void ResetCachedColorValues () = 0;
113  //___________________________________________________________________________
114  // Acessor
115  //___________________________________________________________________________
119  virtual int32 GetKeyState (void) const = 0;
123  virtual UID GetStrokeUID (void) const = 0;
127  virtual PMReal GetStrokeTint (void) const = 0;
131  virtual bool16 StrokeIsGlobal (void) const = 0;
135  virtual UID GetFillUID (void) const = 0;
139  virtual PMReal GetFillTint (void) const = 0;
143  virtual bool16 FillIsGlobal (void) const = 0;
148  virtual ColorArray GetStrokeColorspaceColorData (int32 colorspace) = 0;
153  virtual ColorArray GetFillColorspaceColorData (int32 colorspace) = 0;
154  };
155 
156 #endif // _IPickerPanelModKeyStateData_