IDVOwnerDrawMenu.h

//========================================================================================
// 
// $File$
// 
// Owner: Matt Joss
// 
// $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 __IDVOwnerDrawMenu__
#define __IDVOwnerDrawMenu__

#include "PMTypes.h"
#include "DV_WidgetID.h"
#include "IActionStateList.h"
#include "IGraphicsContext.h"

#include "DVAForwardDeclarations.h"

class IControlView;
class IViewPort;

//========================================================================================
// CLASS IOwnerDrawMenu
//========================================================================================

class IDVOwnerDrawMenu : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IDVOWNERDRAWMENU };
 
 // Action states are defined in IActionStateList.h
 // kDisabled_Unselected, kEnabledAction, kSelectedAction, kMultiSelectedAction, kAltSelectedAction
 
 // -----------------------------------------------------------

 virtual void DrawMenuItem(IGraphicsContext *oc, ActionID menuActionID, const SysRect& itemRect, bool16 isCurrentlySelectedItem, int16 actionState) = 0;

 virtual void MeasureItem(ActionID menuActionID, uint16* outItemWidth, uint16* outItemHeight) = 0;


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

 virtual void AddMenuWidget( ActionID menuActionID, IControlView* widget ) = 0;
 virtual void RemoveMenuWidget( ActionID menuActionID, bool16 deleteUID = kTrue ) = 0;
 virtual void RemoveAllMenuWidgets( bool16 deleteUID = kTrue ) = 0;

 virtual bool16 IsValidActionID(ActionID actionID) = 0;
 
 virtual PMReal GetMenuViewScale() = 0;
 
 virtual void SetMenuViewScale(PMReal scale) = 0;

};

#endif // __IDVOwnerDrawMenu__