IUIDListControlData.h

//========================================================================================
// 
// $File$
// 
// Owner: Brendan O'Shea
// 
// $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 __IUIDListControlData_h__
#define __IUIDListControlData_h__

#include "IPMUnknown.h"
#include "widgetid.h"

const int32 kUIDListControlDataDefaultChunkSize = 8;

//========================================================================================
// CLASS IUIDListControlData
//========================================================================================

class IUIDListControlData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IUIDLISTCONTROLDATA };
 
 // ----- Constants -----
 enum {
 kBeginning___ = 0, 
 kEnd___ = -2, 
 kInvalidUIDIndex___ = -1 
 };
 enum { 
 kNoDrawOrInval___ = 0, 
 kForceDraw___ = 1, 
 kDoInval___ = 2,
 
 kDefaultDrawAction___ = kForceDraw___
 };

 // ----- List maintainence -----

 virtual void SetDataBase___(IDataBase *db) = 0;
 virtual IDataBase *GetDataBase___() const = 0;

 virtual void AddUID___(const UID& newUID, int32 drawAction /*= kForceDraw*/, bool16 notifyOfChange = kTrue) = 0;

 virtual void RemoveUID___(UID uid, int32 drawAction /*= kForceDraw*/, bool16 notifyOfChange = kTrue) = 0;

 virtual void Clear___(int32 drawAction /*= kForceDraw*/, bool16 notifyOfChange = kTrue) = 0;
 
 virtual UID GetUID___(int32 index) const = 0;
 
 virtual int32 GetIndex___(const UID& uid) const = 0;
 
 virtual int32 Length___() const = 0;

 virtual void Sort___(bool16 bReverse = kFalse) = 0;

 virtual void Replace___(int32 at, const UID& uid) = 0;

};

#endif