ISwatchLibraryPanelHelper.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.
// 
//========================================================================================

#ifndef __ISwatchLibraryPanelHelper__
#define __ISwatchLibraryPanelHelper__

#include "SwatchLibPanelID.h"
#include "IPMUnknown.h"

class IPanelControlData;

class ISwatchLibraryPanelHelper : public IPMUnknown
{
public:
 //___________________________________________________________________________________
 // DataType
 //___________________________________________________________________________________
 enum { kDefaultIID = IID_ISWATCHLIBRARYPANELHELPER };
 
 virtual ErrorCode PreLoadLibraryList (void) = 0;
 
 virtual IControlView* NewPanel (PMString* pPanelName= nil) = 0;


 virtual ErrorCode BuildPanel (IControlView* iLibPanelView) = 0;

 virtual bool16 ValidatePanel (IControlView* iLibPanelView) = 0;

 virtual IControlView* LoadOtherLibrary (WidgetID& widgetID, PMString* pPanelName= nil) = 0;

 virtual bool16 RescanLibraryList (IPanelControlData* iPanelData, K2Vector<WidgetID>* pInvalPanelList = nil) = 0;


 virtual PMString GetLibraryNameFromCreatorID (IPanelControlData* iPanelData, int32 creatorID) = 0;
 virtual PMString GetLibraryNameFromCreatorID (int32) = 0;

 virtual void SelectLibraryPanelSwatch (IControlView* iLibPanel, const PMString& swatchName) = 0;
 
 /* Return kTrue if the specified library swatch selection list is valid.
 @param iLibPanel specifies a library panel.
 @param selectList is the list of library swatch selection to check.
 @param validList A list of valid swatches in returned in the validList.
 @param conflictList A list of pantone conflict list is returned in pantoneList. 
 The UIDs in this list matches in position to UID in the validList which caused 
 the PANTONE conflicts. In position where swatch is not a PANTONE swatch, 
 it is set to kInvalidUID.
 */
 virtual ErrorCode IsLibraryPanelSwatchSelectionValid (IControlView* iLibPanel, const UIDList& selectList, UIDList& validList, UIDList& conflictList) = 0;
 
 virtual void GetLibraryPanelSwatchSelections (IControlView* iLibPanel, UIDList& selectList) = 0;
};

#endif