IPanelControlData.h

//========================================================================================
// 
// $File$
// 
// Owner: Frits Habermann
// 
// $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 __IPanelControlData__
#define __IPanelControlData__

#include "PMTypes.h"
#include "widgetid.h"
#include "IControlView.h"

class INTERFACE_DECL IPanelControlData : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IPANELCONTROLDATA };

 // -----------------------

 virtual void AddWidget(IControlView *w, int32 at = -1, bool16 invalidate = kTrue) = 0;
 
 virtual void RemoveWidget(IControlView *w, bool16 invalidate = kTrue, bool16 deleteUID = kFalse) = 0;
 
 virtual void MoveWidget(IControlView *w, int32 at, bool16 invalidate = kTrue) = 0;

 virtual void RemoveWidget(int32 index, bool16 invalidate = kTrue, bool16 deleteUID = kFalse) = 0;
 
 virtual void ReleaseAll(bool16 deleteUID = kTrue) = 0;
 
 
 // -----------------------

 virtual IControlView* GetWidget(int32 index) const = 0;
 
 enum {
 kSearchLevel_Invalid = 0,
 kSearchLevel_Self = 1,
 kSearchLevel_SelfAndChildren = 2,
 kSearchLevel_SelfChildrenAndGrandchildren = 3,
 kSearchLevel_SelfChildrenGrandchildrenAndGreatgrandchildren = 4,
 
 kSearchLevel_AllDescendants = 9999,
 };
 
 
 virtual IControlView* FindWidget(const WidgetID& widgetId, int16 searchLevels = kSearchLevel_AllDescendants) const = 0;
 
 virtual IControlView* FindWidget(const SysPoint& windowPt, int16 searchLevels = kSearchLevel_AllDescendants) const = 0;
 
 virtual bool16 GetWidgetVisibleState(int32 index) const = 0;
 
 virtual bool16 IsWidgetInstantiated(int32 index) const = 0;
 
 virtual int32 GetIndex(const IControlView *w) const = 0;
 
 virtual int32 Length() const = 0;
 

 // -----------------------

 virtual void WidgetAttributeChanged(IControlView* view, const WidgetAttributeID& id) = 0;
 
 // -----------------------

 virtual void SetKeyboardFocus(const WidgetID& widgetId) = 0;

 // -----------------------

 virtual void SetKeyboardFocus(const IControlView* widget) = 0;

};

#endif