IStrokeFillControlData.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael_Martz
// 
// $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 _IStrokeFillControlData_
#define _IStrokeFillControlData_
//========================================================================================
//________________________________________________________________________________________
// INCLUDES
//________________________________________________________________________________________
 #include "IPMUnknown.h"
 #include "ToolboxProxyTypes.h"
 #include "ColorSystemID.h"
//========================================================================================
//________________________________________________________________________________________
// CLASS DECLARATION
//________________________________________________________________________________________

 class IStrokeFillControlData : public IPMUnknown
 { 
 //________________________________________________________________________________
 // Widget Layout
 //________________________________________________________________________________
 public:
 enum { kDefaultIID = IID_ISTROKEFILLCONTROLDATA };

 virtual int16 GetStrokeFillWidth (void) = 0;
 virtual void SetStrokeFillWidth (int16 width) = 0;

 virtual int16 GetStrokeFillHeight (void) = 0;
 virtual void SetStrokeFillHeight (int16 height) = 0;

 virtual int16 GetStrokeFillOverlap (void) = 0;
 virtual void SetStrokeFillOverlap (int16 overlapAmount) = 0;

 virtual int16 GetStrokeFillHiliteBorder(void) = 0;
 virtual void SetStrokeFillHiliteBorder(int16 border) = 0;

 virtual int16 GetStrokeWidth (void) = 0;
 virtual void SetStrokeWidth (int16 strokeWidth) = 0;

 virtual bool16 GetDraggable (void) = 0;
 virtual void SetDraggable (bool16 isDraggable) = 0;

 typedef enum
 {
 kNoOption = 0,
 kOptionDialog,
 kRenderObjectPanel
 } DisplayOptionType;
 
 virtual IStrokeFillControlData::DisplayOptionType GetDisplayOption (void) = 0;
 virtual void SetDisplayOption (IStrokeFillControlData::DisplayOptionType displayOption) = 0;

 virtual bool16 GetSwitchable (void) = 0;

 virtual void SetSwitchable (bool16 isSwitchable) = 0;

 //________________________________________________________________________________
 // Active Item
 //________________________________________________________________________________
 public:
 virtual ToolboxProxy::ActiveProxyType GetActive (void) = 0;
 virtual void SetActive (ToolboxProxy::ActiveProxyType activeProxy) = 0;

 //________________________________________________________________________________
 // Format of Data (either UID or meta data)
 //________________________________________________________________________________
 public:
 virtual bool16 UseMetaData (void) = 0;
 virtual void SetUseMetaData (bool16 usingMetaData) = 0;

 virtual bool16 UseFillMetaData (void) = 0;
 virtual void SetFillUseMetaData (bool16 usingMetaData) = 0;

 virtual bool16 UseStrokeMetaData (void) = 0;
 virtual void SetStrokeUseMetaData (bool16) = 0;
 //________________________________________________________________________________
 // Meta Data format
 //________________________________________________________________________________
 public:
 virtual IPMUnknown* GetFillMetaData (void) = 0;
 virtual void SetFillMetaData (IPMUnknown* fillMetaData) = 0;

 virtual IPMUnknown* GetStrokeMetaData (void) = 0;
 virtual void SetStrokeMetaData (IPMUnknown* strokeMetaData) = 0;

 //________________________________________________________________________________
 // UID format
 //________________________________________________________________________________
 public:
 virtual UID GetFillUID (void) = 0;
 virtual void SetFillUID (UID fillUID) = 0;

 virtual UID GetStrokeUID (void) = 0;
 virtual void SetStrokeUID (UID strokeUID) = 0;

 virtual IDataBase* GetDataBase (void) = 0;
 virtual void SetDataBase (IDataBase* iDataBase) = 0;

 virtual bool16 IsFillIndeterminate (void) = 0;
 virtual void SetFillIndeterminate (bool16 setInderminant) = 0;

 virtual bool16 IsStrokeIndeterminate (void) = 0;
 virtual void SetStrokeIndeterminate (bool16 setInderminant) = 0;
 
 virtual PMReal GetFillTint (void) = 0;
 virtual void SetFillUIDAndTint (UID fillUID, const PMReal& fillTint = kInvalidTintPercent) = 0;


 virtual PMReal GetStrokeTint (void) = 0;
 virtual void SetStrokeUIDAndTint (UID strokeUID, const PMReal& strokeTint = kInvalidTintPercent) = 0;

 //________________________________________________________________________________
 // Updating
 //________________________________________________________________________________
 public:
 virtual void InvalidateView (void) = 0;
 virtual void InvalidateStroke (void) = 0;
 virtual void InvalidateFill (void) = 0;
 
 typedef enum
 {
 kNone = -1,
 kStroke,
 kFill
 } PartCode;
 
 virtual IStrokeFillControlData::PartCode GetPartCode (const PMPoint& localPoint) const = 0;
 };
 
#endif // _IStrokeFillControlData_