IDropDownListController.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 __IDropDownListController_h__
#define __IDropDownListController_h__

#include "widgetid.h"

//========================================================================================
// CLASS TEMPLATE IDropDownListController
//========================================================================================

class IDropDownListController : public IPMUnknown
{
public: 
 enum { kDefaultIID = IID_IDROPDOWNLISTCONTROLLER };
 enum { kBeginning = 0, kNoSelection = -1, kEnd = -2, kDefaultSelection = -3 };

 // Selection 
 virtual void Select(int32 index, bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;
 virtual void Deselect(bool16 invalidate = kTrue, bool16 notifyOfChange = kTrue) = 0;
 virtual bool16 IsSelected(int32 index) const = 0;
 virtual int32 GetSelected() const = 0;
 virtual void SetDefaultSelection(int32 index) = 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;


 //Utility
 virtual bool16 IsDropDownOpen() const = 0;
};

#endif