InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IXPAttributeFacade.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 // TODO: Add Get methods for each transparency attribute.
24 //
25 //========================================================================================
26 
27 #ifndef __IXPAttributeFacade__
28 #define __IXPAttributeFacade__
29 #include "IXPAttributeFacade.h"
30 
31 #include "IPMUnknown.h"
32 #include "IXPAttributeSuite.h"
33 #include "IXPSetVignetteCmdData.h"
34 #include "IXPSetBasicAttributesCmdData.h"
35 #include "IXPSetDropShadowCmdData.h"
36 #include "GraphicTypes.h"
37 #include "K2Vector.h"
38 #include "Utils.h"
39 
40 #include "XPID.h"
41 
43 class AutomationContext;
44 
50 {
51 public:
52  enum { kDefaultIID = IID_IXPATTRIBUTEFACADE };
53 
54 public:
55 
62  virtual ErrorCode SetBlendMode (const UIDList& itemList, PMBlendingMode blendMode) = 0;
63 
70  virtual ErrorCode GetBlendMode (const UIDList& itemList, K2Vector<int32>& blendModeList) = 0;
71 
78  virtual ErrorCode SetOpacity (const UIDList& itemList, PMReal opacity) = 0;
79 
86  virtual ErrorCode GetOpacity (const UIDList& itemList, K2Vector<PMReal>& opacityList) = 0;
87 
94  virtual ErrorCode SetKnockoutGroup(const UIDList& itemList, bool16 knockoutGroup) = 0;
95 
102  virtual ErrorCode GetKnockoutGroup(const UIDList& itemList, K2Vector<bool16>& knockoutGroupList) = 0;
103 
110  virtual ErrorCode SetIsolateBlending (const UIDList& itemList, bool16 isolateBlending) = 0;
111 
118  virtual ErrorCode GetIsolateBlending (const UIDList& itemList, K2Vector<bool16>& isolateBlendingList) = 0;
119 
126  virtual ErrorCode SetShadowMode (const UIDList& itemList, PMDropShadowMode shadowMode) = 0;
127 
134  virtual ErrorCode GetShadowMode (const UIDList& itemList, K2Vector<int32>& shadowModeList) = 0;
135 
142  virtual ErrorCode SetShadowBlendMode(const UIDList& itemList, PMBlendingMode shadowBlendMode) = 0;
143 
150  virtual ErrorCode GetShadowBlendMode(const UIDList& itemList, K2Vector<int32>& shadowBlendModeList) = 0;
151 
159  virtual ErrorCode SetShadowXOffset (const UIDList& itemList, PMReal shadowXOffset) = 0;
160 
167  virtual ErrorCode GetShadowXOffset (const UIDList& itemList, K2Vector<PMReal>& shadowXOffsetList) = 0;
168 
176  virtual ErrorCode SetShadowYOffset (const UIDList& itemList, PMReal shadowYOffset) = 0;
177 
184  virtual ErrorCode GetShadowYOffset (const UIDList& itemList, K2Vector<PMReal>& shadowYOffsetList) = 0;
185 
193  virtual ErrorCode SetShadowBlurRadius (const UIDList& itemList, PMReal shadowBlurRadius) = 0;
194 
202  virtual ErrorCode GetShadowBlurRadius (const UIDList& itemList, K2Vector<PMReal>& shadowBlurRadiusList) = 0;
203 
211  virtual ErrorCode SetShadowColor (const UIDList& itemList, UID shadowColor) = 0;
212 
219  virtual ErrorCode GetShadowColor (const UIDList& itemList, K2Vector<UID>& shadowColorList) = 0;
220 
228  virtual ErrorCode SetShadowOpacity (const UIDList& itemList, PMReal shadowOpacity) = 0;
229 
236  virtual ErrorCode GetShadowOpacity (const UIDList& itemList, K2Vector<PMReal>& shadowOpacityList) = 0;
237 
245  virtual ErrorCode SetShadowSpread (const UIDList& itemList, PMReal shadowSpread) = 0;
246 
253  virtual ErrorCode GetShadowSpread (const UIDList& itemList, K2Vector<PMReal>& shadowSpreadList) = 0;
254 
262  virtual ErrorCode SetShadowNoise (const UIDList& itemList, PMReal shadowNoise) = 0;
263 
270  virtual ErrorCode GetShadowNoise (const UIDList& itemList, K2Vector<PMReal>& shadowNoiseList) = 0;
271 
279  virtual ErrorCode SetFeatherMode (const UIDList& itemList, PMVignetteMode featherMode) = 0;
280 
288  virtual ErrorCode GetFeatherMode (const UIDList& itemList, K2Vector<int32>& featherModeList) = 0;
289 
297  virtual ErrorCode SetFeatherWidth (const UIDList& itemList, PMReal featherWidth) = 0;
298 
306  virtual ErrorCode GetFeatherWidth (const UIDList& itemList, K2Vector<PMReal>& featherWidthList) = 0;
307 
315  virtual ErrorCode SetFeatherNoise (const UIDList& itemList, PMReal noise) = 0;
316 
324  virtual ErrorCode GetFeatherNoise (const UIDList& itemList, K2Vector<PMReal>& noiseList) = 0;
325 
333  virtual ErrorCode SetFeatherInnerOpacity (const UIDList& itemList, PMReal featherInnerOpacity) = 0;
334 
342  virtual ErrorCode GetFeatherInnerOpacity (const UIDList& itemList, K2Vector<PMReal>& featherInnerOpacityList) = 0;
343 
351  virtual ErrorCode SetFeatherOuterOpacity (const UIDList& itemList, PMReal featherOuterOpacity) = 0;
352 
360  virtual ErrorCode GetFeatherOuterOpacity (const UIDList& itemList, K2Vector<PMReal>& featherOuterOpacityList) = 0;
361 
369  virtual ErrorCode SetFeatherCornerType (const UIDList& itemList, PMVignetteCorners featherCornerType) = 0;
370 
377  virtual ErrorCode GetFeatherCornerType (const UIDList& itemList, K2Vector<int32>& featherCornerTypeList) = 0;
378 
384  virtual ErrorCode ApplyAttributes (const UIDList& itemList, IGraphicStyleAttributeBossList* iAttrList) = 0;
385 
391  virtual ErrorCode ApplyAttributes (const UIDList& itemList, const IXPAttributeSuite::AttributeList& attrList) = 0;
392 
400  virtual ErrorCode ApplyBasicAttributes
401  (
402  const UIDList& itemList,
403  BasicAttributesData* basicData,
405  ) = 0;
406 
414  virtual ErrorCode ApplyDropShadowAttributes
415  (
416  const UIDList& itemList,
417  DropShadowData* dropshadowData,
419  ) = 0;
427  virtual ErrorCode ApplyVignetteAttributes
428  (
429  const UIDList& itemList,
430  VignetteData* featherData,
432  ) = 0;
433 
440  virtual void RecordApplyAttributes
441  (
442  AutomationContext* pAutomationContext,
443  IDataBase* iDataBase,
445  ) = 0;
446 
453  virtual void RecordApplyAttributes
454  (
455  AutomationContext* pAutomationContext,
456  IDataBase* iDataBase,
457  const IXPAttributeSuite::AttributeList& attrList
458  ) = 0;
459 
466  virtual void RecordApplyBasicAttributes
467  (
468  AutomationContext* pAutomationContext,
469  BasicAttributesData* basicData,
471  ) = 0;
472 
480  virtual void RecordApplyDropShadowAttributes (AutomationContext* pAutomationContext, IDataBase*, DropShadowData* dropshadowData, const K2Vector<IXPAttributeSuite::AttributeType>& attrTypeList) = 0;
481 
488  virtual void RecordApplyVignetteAttributes (AutomationContext* pAutomationContext, VignetteData* featherData, const K2Vector<IXPAttributeSuite::AttributeType>& attrTypeList) = 0;
489 
490 };
491 
492 
493 #endif // __IXPAttributeSuite__
494