IColorPickerPanelHelper.h

//========================================================================================
// 
// $File$
// 
// Owner: SusanCL
// 
// $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.
// 
// 
// Helper interface to access the ColorPicker panels.
// 
//========================================================================================

#ifndef __IColorPickerPanelHelper__
#define __IColorPickerPanelHelper__

#include "ColorPickerID.h"
#include "IColorData.h"
#include "ISliderStateData.h"

class ISubject;
class IControlView;

class IColorPickerPanelHelper : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICOLORPICKERPANELHELPER };
 
 // ----- Query -----
 
 virtual int32 GetPickerIndexFromColorSpace(const int32 colorspace) const = 0;
 virtual int32 GetColorSpaceFromPickerIndex(const int32 pickerIndex) const = 0;

 virtual IColorData* QueryPickerMetaData() = 0;

 virtual ISubject* QueryPickerPanelSubject() = 0;
 
 virtual ISliderStateData::SliderStateType GetPickerControlState( const int32 pickerIndex ) const = 0;
 
 virtual ISliderStateData::SliderStateType GetPickerControlState() const = 0;
 
 virtual IColorData* QueryColorspaceColorData (const int32 colorspace) = 0;

 virtual const UIDList* GetPickerNChannelInkList () = 0;
 
 virtual void SetPickerMetaData(const int32 pickerIndex, ColorArray& components, bool16 doNotify = kFalse) = 0;

 virtual void SetPickerMetaData(IColorData* iColorData, bool16 doNotify = kFalse) = 0;

 virtual void SetPickerMetaData(const UIDRef& colorRef, bool16 doNotify = kFalse) = 0;

 virtual void SetPickerMetaData(const ColorArray& components, const UIDList& inkUIDList, bool16 doNotify = kFalse) = 0;
 
 virtual void SetPickerControlStates(const int32 pickerIndex, const ISliderStateData::SliderStateType controlState, bool16 doNotify = kFalse) = 0;

 virtual void SetPickerControlStates(const ISliderStateData::SliderStateType controlState, bool16 doNotify = kFalse) = 0;

 // ----- Miscellaneous ----
 
 virtual void EnablePanel( const int32 pickerIndex = -1 ) =0;
 virtual void DisablePanel( const int32 pickerIndex = -1 ) =0;

 virtual void UpdatePickerMetaData() = 0;

 virtual void SwitchPickerPanelByIndex( const int32 pickerIndex ) = 0;

 virtual void SwitchPickerPanelByColorspace( const int32 newColorspace ) = 0;
 
 virtual PMIID GetObservedProtocol (void) = 0;

 virtual void BroadcastChange (IControlView* iPickerView = nil) = 0;
 
};

#endif