IMenuUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Bernd Paradies
// 
// $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 __IMenuUtils__
#define __IMenuUtils__

// ----- Interfaces -----

#include "IInterfaceColors.h"
#include "IPMUnknown.h"

// ----- Includes -----

#include "InterfaceFontInfo.h"
#include "LocaleSetting.h"
#include "PMString.h"

// ----- Utility files -----

#include "Utils.h"

// ----- ID.h files -----

#include "AppFrameworkID.h"

class IGraphicsContext;

class IMenuUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IMENUUTILS };


 virtual void PlatformStripMenuAccelerator(PMString* inOutString, int16 uiLocale = LocaleSetting::GetLocale().GetUserInterfaceId()) = 0;

 virtual void StripMenuAccelerator(PMString* inOutString, int16 uiLocale) = 0;
 
 virtual void InsertAmpersandForDisplay(PMString* inOutString, int16 uiLocale = LocaleSetting::GetLocale().GetUserInterfaceId()) = 0;

 virtual bool16 RemoveLastMenuPart(PMString *inOutString) = 0;
 
 virtual bool16 RemoveAllButLastMenuPart(PMString *inOutString) = 0; 
 
 virtual int32 GetNumMenuParts(const PMString& menuPath) = 0;
 
 virtual PMString GetNthMenuPart(const PMString& menuPath,int32 index) = 0;

 virtual void DrawMenuString(SysPort port, const PMString& menuString, const SysRect& bounds, int16 alignment, bool16 hilited, bool16 disabled ) = 0;

 virtual void DrawMenuString(IGraphicsContext* gc, const PMPoint& startPt, const PMString& str, const InterfaceFontInfo& fontInfo,
 IInterfaceColors::InterfaceColor color = kInterfaceBlack, bool16 convertAmpersandToUnderline = kFalse, bool16 disabled = kFalse) = 0;

 virtual void TranslateMenuName(PMString& untranslatedName) = 0 ;
 
 virtual PMString GetMenuNameFromFileName(const PMString &fileName, int32 position) = 0;
};

#endif // __IMenuUtils__