IStringListControlData.h

//========================================================================================
// 
// $File$
// 
// Owner: Michael Burbidge
// 
// $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 __IStringListControlData_h__
#define __IStringListControlData_h__

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

//========================================================================================
// CLASS IStringListControlData
//========================================================================================

class IStringListControlData : public IPMUnknown
{
public:

 enum { kDefaultIID = IID_ISTRINGLISTCONTROLDATA }; // for UseDefaultIID()

 // ----- Constants -----
 enum {
 kBeginning = 0, 
 kEnd = -2, 
 kInvalidStringIndex = -1 
 };

 // ----- List maintainence -----
 virtual void AddString(const PMString& newString, int32 at = kEnd, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual void RemoveString(int32 index, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual void Clear(bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;
 
 virtual PMString GetString(int32 index) const = 0;

 virtual void SetString(int32 index, const PMString& replaceString, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;
 
 virtual int32 GetIndex(const PMString& string, bool16 skipIfDisabled = kFalse) const = 0;

 virtual int32 GetIndexOfPartialString(const PMString& stringBeginning, bool16 caseSensitive, bool16 skipIfDisabled = kFalse) const = 0;

 virtual int32 Length() const = 0;

 // Enable/Disable 
 virtual void Enable(int32 index, bool16 doEnable = kTrue, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual void Disable(int32 index, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;

 virtual bool16 IsEnabled(int32 index) const = 0;
};

#endif