IGradientSliderControlData.h

//========================================================================================
// 
// $File$
// 
// Owner: Thanh Nguyen
// 
// $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 __IGradientSliderControlData__
#define __IGradientSliderControlData__

#include "IPMUnknown.h"
#include "PMRect.h"
#include "IControlView.h"
#include "IRenderingObject.h"
#include "IColorData.h"
#include "K2Vector.h"

class IRenderingObject;
class IControlView;
class PMRect;
class IColorData;
class IGradientFill;

const int32 kMaxGradientStopNum = 100;

class IGradientSliderControlData : public IPMUnknown
{
 public:
 typedef enum
 {
 kMidPointThumb = 0,

 kStopThumb
 }thumbType;
 
 typedef enum
 {
 kNormal = 0,

 kSelectThumb,

 kInsertThumbStop,

 kDragThumb,

 kDeactivatePanel, // Don't use?

 kActivatePanel, // Don't use?

 kIndeterminate,

 kNone
 }updateType;
 
 virtual void DoNotify() = 0;

 virtual void UpdateSliderData (const IGradientFill* newGradientData) = 0;

 virtual void SetNumberOfStop(int16 stopNum) = 0;

 virtual void SetNthThumbPosition(int16 index, PMReal thumbPosition) = 0;

 virtual void InsertThumb(int16 index, PMReal thumbPosition) = 0;

 virtual void SetSelectedThumbIndex(int16 thumbSelectedIndex, bool16 updateBlockIndex = kTrue) = 0;
 
 virtual void SetDragDropHitThumbIndex(int16 thumbIndex) = 0;

 virtual void SetLastEventValue(PMReal value) = 0;

 virtual void SetLastUpdateType(int16 updateType) = 0;

 virtual void SetLastUpdateBool(bool16 update) = 0;

 virtual void SetLastHitPoint(PMPoint hitPoint) = 0;

 virtual void SetNthMidPointRatio(int16 index, PMReal ratio) = 0;

 virtual void InsertNthMidPointRatio(int16 index, PMReal ratio) = 0;

 virtual void SetIsDragging(bool16 isDragging) = 0;

 virtual void SetRemovedColorSave(bool16 bColorSave)=0;

 virtual void SetDeactivatePanel(bool16 panelDeactivate) = 0;

 virtual void SetInGradientDialog(bool16 inDialog) = 0;

 // For pageItem rendering & graphic state interaction

 virtual IRenderingObject* GetGradientRenderingObject() = 0;

 virtual IRenderingObject* GetSliderRenderingObject() = 0;

 virtual K2Vector<PMReal> GetThumbList() = 0;

 virtual int16 GetTotalThumbNum() = 0;

 virtual int16 GetNumberOfStop() = 0;

 virtual PMReal GetNthThumbPosition(int16 index) = 0;

 virtual int16 GetNthThumbType(int16 index) = 0;

 virtual IColorData* QueryNthColorMetaData(int16 index) = 0;

 virtual PMRect GetSliderRect(IControlView* sliderView) = 0;

 virtual void RemoveThumbStop(int16 index) = 0;

 virtual int16 GetSelectedThumbIndex() = 0;

 virtual int16 GetDragDropHitThumbIndex() = 0;

 virtual int16 GetHitThumb(IControlView* view, PMPoint hitPoint, int16 tolerance) = 0;

 virtual PMReal GetLastEventValue() = 0;

 virtual int16 GetLastUpdateType() = 0;

 virtual bool16 GetLastUpdateBool() = 0;

 virtual PMPoint GetLastHitPoint() = 0;

 virtual void GetMidPointRatio(K2Vector<PMReal>* thumbList) = 0;

 virtual PMReal GetNthMidPointRatio(int16 index) = 0;

 virtual bool16 IsDragging() = 0;

 virtual void RelocateNthThumb(int16 thumbIndex, PMReal toPosition) = 0;
 
 virtual void UpdateSlider(int16 updateType, int16 hitIndex, PMPoint hitPoint, bool16 bUpdate = kTrue) = 0;
 
 virtual int16 GetPosibleThumbIndex(PMReal thumbPosition) = 0;
 
 virtual PMReal MapThumbIndexToSliderPosition(int16 index, PMRect& frame) = 0;

 virtual PMReal MapSliderPositionToThumbPosition(PMReal sliderPosition) = 0;

 virtual PMReal MapLocalPointToSliderPosition(const PMPoint& localPoint) = 0;

 virtual bool16 IsPanelDeactivate()=0;
 
 virtual bool16 IsRemovedColorSave()=0;

 virtual bool16 IsInDialog() = 0;
};

#endif // __IGradientSliderControlData__