IPanelMgr.h

//========================================================================================
// 
// $File$
// 
// Owner: Dave Burnard
// 
// $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 __IPanelMgr__
#define __IPanelMgr__

#include "PMTypes.h"
#include "PMString.h"
#include "ShuksanID.h"
#include "AppUIID.h"

#include "PaletteRef.h"

class IResourceAccess;
class IControlView;

//========================================================================================
// CLASS IPanelMgr
//========================================================================================

class IPanelMgr : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IPANELMGR };
 
 virtual void Startup() = 0;
 virtual void ShutDown() = 0;

 virtual void UpdatePanelIcon(const WidgetID& widgetId, PluginID pluginId = kInvalidPlugin, RsrcID resourceId = kInvalidRsrcID) = 0;
 
 virtual IControlView* CreatePanel(const PMLocaleId& localeId, RsrcID panelID, const PluginID& pluginID) = 0;
 
 // similar to old AdoptPanel
 virtual void RegisterPanel(PaletteRefType paletteType, IControlView* panel, bool16 isResizable, const PMString& panelName, ActionID actionID, const PMString& altMenu, PMReal altPos, const ScriptID& scriptID, PluginID paletteIconPluginID, RsrcID paletteIconRsrcID) = 0;
 
 
 virtual void MovePanel(PaletteRef parentPalette, IControlView* panel) = 0;
 

 virtual void DestroyPanel(const UID& panelUID) = 0;
 
 virtual IControlView* GetPanelFromWidgetID(const WidgetID& widgetId) const = 0;
 virtual IControlView* GetPanelFromActionID(const ActionID& actionId) const = 0;

 virtual IControlView* GetVisiblePanel(const WidgetID& widgetId) const = 0;
 virtual IControlView* GetVisiblePanelFromActionID(const ActionID& actionId) const = 0;

 virtual bool16 DoesPanelExist(const WidgetID& widgetId) const = 0;
 virtual bool16 DoesPanelExistFromActionID(const ActionID& actionId) const = 0;

 virtual void ShowPanelByMenuID(const ActionID& id, bool16 giveKeyFocus = kTrue) = 0;
 virtual void ShowPanelByWidgetID(const WidgetID& widgetId, bool16 giveKeyFocus = kTrue) = 0;


 virtual void HidePanelByMenuID(const ActionID& id) = 0;
 virtual void HidePanelByWidgetID(const WidgetID& widgetId) = 0;

 virtual bool16 IsPanelWithMenuIDShown(const ActionID& id) const = 0;
 virtual bool16 IsPanelWithWidgetIDShown(const WidgetID& widgetId) const = 0;

 virtual void ArePanelsWithMenuIDMostlyVisible(const K2Vector<ActionID> & inActionList, K2Vector<bool16>& outMostlyVisibleList) const = 0;
 virtual bool16 IsPanelWithMenuIDMostlyVisible(const ActionID& id) const = 0;
 
#ifdef ID_DEPRECATED

 virtual PMString GetPanelName(const ActionID& id) const {return GetPanelMenuName(id);} //Deprecated. 
#endif

 virtual PMString GetPanelMenuName(const ActionID& id) const = 0;
 virtual void SetPanelMenuName(const ActionID& id, const PMString& menustr) = 0;

 virtual IControlView* GetPanelFromPaletteContainer(PaletteRef palette) const = 0; 
 
 virtual PaletteRef GetPaletteRefContainingPanel( const IPMUnknown* panel ) const = 0; 
 
 virtual uint32 GetPanelCount() const = 0;
 virtual bool16 GetNthPanelInfo(uint32 index, UID& panelUID, ActionID* actionID = nil, WidgetID* widgetID = nil, PMString* panelName = nil, ScriptID* scriptID = nil) const = 0;
 
 virtual void SetPanelResizabilityByWidgetID(const WidgetID& widgetId, bool16 isResizable) = 0;

 virtual bool16 IsPanelWithWidgetIDResizable(const WidgetID& widgetId) const = 0;
 
 virtual void FitPaletteToPanel(const IControlView* panel) = 0;

 virtual void FixupPanelOrigin(IControlView* panel, PaletteRef parentPalette) const = 0;

 virtual void SetPanelPopupMenuName( IControlView* panel, const PMString& popupMenuName ) = 0 ;

 virtual PMString GetPanelPopupMenuName( IControlView* panel ) const = 0 ;
 #ifdef MACINTOSH

 virtual void AddViewForRedrawingWhileAMenuIsOpen(IControlView* view) = 0;
 virtual void RemoveViewForRedrawingWhileAMenuIsOpen(IControlView* view) = 0;
 #endif
 virtual IControlView* GetPanelFromPanelName(const PMString& panelName) const = 0;

 virtual void UsageTracking_PanelClosed(const PaletteRef& paletteRef) const = 0;

 virtual void LogPanelUsage() const = 0;
 
 virtual void ShowPanelByExtensionID(const PMString& extensionId, const PMString& panelId, bool16 giveKeyFocus = kTrue) = 0;

};

#endif