IMenuCustomizationData.h

//========================================================================================
// 
// $File$
// 
// Owner: lance bushore
// 
// $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 __IMenuCustomizationData__
#define __IMenuCustomizationData__

#include "AppUIID.h"
#include "IPMUnknown.h"
#include "ActionID.h"
#include "K2Vector.h"
#include "BravoForwardDecl.h"

class IXMLOutStream;

class IMenuCustomizationData : public IPMUnknown
{
 public:
 enum { kDefaultIID = IID_IMENUCUSTOMIZATIONDATA };
 
 typedef enum {
 kNoMenuColor = -1,
 kBlueMenuColor = 0,
 kGrayMenuColor = 1,
 kGreenMenuColor = 2,
 kOrangeMenuColor = 3,
 kRedMenuColor = 4,
 kVioletMenuColor = 5,
 kYellowMenuColor = 6,
 
 kNumberOfMenuColors = 7 // It's intentional that the number of colors is 7 and not 8. "kNoMenuColor" isn't considered a real color.
 } tMenuColor;
 
 typedef enum {
 kNormal = 0,
 kSelected,
 kDisabled,
 
 kNumberOfStates
 } tMenuState;
 
 struct CustomizedSubMenuPath
 { 
 typedef object_type data_type;
 PMString fSubMenuPath;
 };
 
 struct MenuColorStruct
 {
 typedef base_type data_type;
 MenuColorStruct(ActionID id, tMenuColor index) : fActionID(id), fColorIndex(index){}
 
 ActionID fActionID;
 tMenuColor fColorIndex;
 };
 
 struct SubMenuColorStruct
 {
 typedef object_type data_type;
 SubMenuColorStruct(IMenuCustomizationData::CustomizedSubMenuPath menuPath, tMenuColor index) : fColorizedSubMenuPath(menuPath), fColorIndex(index){}
 
 IMenuCustomizationData::CustomizedSubMenuPath fColorizedSubMenuPath;
 tMenuColor fColorIndex;
 };

 virtual const PMString& GetDefaultMenuSetName() const = 0;
 
 virtual bool16 SetCurrentMenuSetInfo(const PMString& menuSetName,bool16 isModified,bool16 isPreset,bool16 readShortcutSetFromDisk)= 0;

 virtual const PMString& GetCurrentMenuSetName() const= 0;
 
 virtual bool16 IsCurrentMenuSetModified() const= 0;
 
 virtual bool16 IsCurrentMenuSetPreset() const= 0;

 virtual void HideSubMenu(const PMString& menuPath) = 0;
 
 virtual void ShowSubMenu(const PMString& menuPath) = 0;
 
 virtual bool16 IsSubMenuHidden(const PMString& menuPath) const= 0;

 virtual const K2Vector<CustomizedSubMenuPath>& GetHiddenSubMenus() const = 0;
 
 virtual void SetHiddenSubMenus(const K2Vector<CustomizedSubMenuPath>& hiddenSubMenuList) = 0;

 virtual void ClearAllHiddenSubMenus() = 0;
 
 /* Hides a menu by action id. This may hide multiple menu items that share an ActionID */
 virtual void HideMenuAction(const ActionID action) = 0;
 
 virtual void ShowMenuAction(const ActionID action) = 0;
 virtual bool16 IsMenuActionHidden(ActionID action) const = 0;

 virtual const K2Vector<ActionID>& GetHiddenMenuActions() const = 0;

 virtual void SetHiddenMenuActions(const K2Vector<ActionID>& hiddenActionList) = 0;

 virtual void ClearAllHiddenActions() = 0;
 
 virtual void SetSubMenuColor(const PMString& menuPath, tMenuColor colorIndex) = 0;
 
 virtual tMenuColor GetSubMenuColor(const PMString& menuPath) const = 0;

 virtual const K2Vector<SubMenuColorStruct>& GetColoredSubMenus() const = 0;

 virtual void SetColoredSubMenus(const K2Vector<SubMenuColorStruct>& coloredSubMenuList) = 0;

 virtual void ClearAllColoredSubMenus() = 0;


 virtual void SetMenuActionColor(const ActionID action, tMenuColor colorIndex) = 0;
 virtual tMenuColor GetMenuActionColor(ActionID action) const = 0;

 virtual const K2Vector<MenuColorStruct>& GetColoredMenuActions() const = 0;

 virtual void SetColoredMenuActions(const K2Vector<MenuColorStruct>& coloredActionList) = 0;

 virtual void ClearAllColoredMenuActions() = 0;

 virtual bool16 GetMenusAreHiddenOrColorized() const = 0;

 virtual void ClearAllMenusAndColorization() = 0;

 virtual bool16 WriteXMLMenuFile(IXMLOutStream* s) const = 0;

 virtual bool16 SaveCurrentMenuSetToFile(const PMString& menuSetName) const = 0;
 typedef enum {
 kMenuReadFileNoError = 0, 
 kMenuFileNotFound, 
 kMenuFileWrongPlatform, 
 kMenuFileFormatWrongOrCorrupt, 
 kMenuFileFormatIncompatible
 } MenuSetReadFileError; 

 virtual MenuSetReadFileError ReadXMLMenuFile(IPMStream* s) = 0;
};

#endif // __IMenuCustomizationData__