DrawStringUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Paul Sorrick
// 
// $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 __DRAWSTRINGUTILS__
#define __DRAWSTRINGUTILS__

#include "IPMUnknown.h"
#include "PMString.h"
#include "IInterfaceColors.h"
#include "InterfaceFontInfo.h"
#include "WidgetDefs.h"
#include <string>

#include "DVAForwardDeclarations.h"
#include "DVPublicUtilities.h"

class IGraphicsContext;


namespace StringUtils
{
 DV_ void PMDrawString(IGraphicsContext* gc, const PMRect& textBBox, int16 alignment, const PMString& str, const InterfaceFontInfo& fontInfo,
 IInterfaceColors::InterfaceColor color = kInterfaceTextColor, bool16 convertAmpersandToUnderline = kFalse, bool16 centerVertically = kTrue, bool16 underlineText = kFalse);

 DV_ void PMDrawString(IGraphicsContext* gc, const PMPoint& startPt, const PMString& str, const InterfaceFontInfo& fontInfo,
 IInterfaceColors::InterfaceColor color = kInterfaceTextColor, bool16 convertAmpersandToUnderline = kFalse, bool16 underlineText = kFalse);
 
 DV_ void PMDrawStringRGB (IGraphicsContext* gc, const PMRect& textBBox, int16 alignment, const PMString& str,
 const InterfaceFontInfo& fontInfo, const RealAGMColor & rgbColor, bool16 convertAmpersandToUnderline = kFalse, bool16 centerVertically = kTrue, bool16 underlineText = kFalse, dv_utils::AntiAliasPolicy aa_policy = dv_utils::kAntiAliasPolicy_Med);
 DV_ void PMDrawStringRGB (IGraphicsContext* gc, const PMPoint& startPt, const PMString& str,
 const InterfaceFontInfo& fontInfo, const RealAGMColor & rgbColor, bool16 convertAmpersandToUnderline = kFalse, bool16 underlineText = kFalse, dv_utils::AntiAliasPolicy aa_policy = dv_utils::kAntiAliasPolicy_Med);

 DV_ void PostTransformPMDrawStringRGB (IGraphicsContext* gc, const PMRect& textBBox, int16 alignment, const PMString& str,
 const InterfaceFontInfo& fontInfo, const RealAGMColor & rgbColor, bool16 convertAmpersandToUnderline = kFalse, bool16 centerVertically = kFalse, bool16 underlineText = kFalse);

 DV_ PMPoint PMMeasureString(IGraphicsContext* gc, const PMString& str, const InterfaceFontInfo& fontInfo,
 bool16 convertAmpersandToUnderline = kTrue);
 DV_ PMPoint PMMeasureString(const PMString& str, const InterfaceFontInfo& fontInfo,
 bool16 convertAmpersandToUnderline = kTrue);

 DV_ PMString PMEllipsizeString(IGraphicsContext* gc, PMReal width, const PMString& str, const InterfaceFontInfo& fontInfo,
 bool16* didTruncate = nil, bool16 convertAmpersandToUnderline = kTrue);
 DV_ PMString PMEllipsizeString(IGraphicsContext* gc, PMReal width, const PMString& str, const InterfaceFontInfo& fontInfo, 
 EllipsizeStyle truncateWhere, bool16* didTruncate = nil, bool16 convertAmpersandToUnderline = kTrue);
 DV_ PMString PMEllipsizeString(PMReal width, const PMString& str, const InterfaceFontInfo& fontInfo, EllipsizeStyle truncateWhere, 
 bool16* didTruncate, bool16 convertAmpersand = kTrue);
 
 //========================================================================================
 // PMDrawStringRGB
 //
 // Drawbot based utility function to draw the text at the specified draw point using specified
 // color and font information. Also draws underline if specified.
 //========================================================================================
 DV_ void PMDrawStringRGB (
 dvaui::drawbot::Drawbot* pDrawbot,
 const PMPoint & drawPt,
 int16 alignment, 
 const PMString & str,
 const InterfaceFontInfo & fontInfo, 
 const RealAGMColor & realColor,
 bool16 convertAmpersandToUnderline,
 bool16 drawUnderline, 
 dv_utils::AntiAliasPolicy aa_policy = dv_utils::kAntiAliasPolicy_Med);

 DV_ void PMDrawStringRGB (
 dvaui::drawbot::Drawbot* pDrawbot,
 const PMRect& textBBox,
 int16 alignment, 
 const PMString & str,
 const InterfaceFontInfo & fontInfo, 
 const RealAGMColor & realColor,
 bool16 convertAmpersandToUnderline,
 bool16 centerVertically,
 bool16 underlineText,
 dv_utils::AntiAliasPolicy aa_policy = dv_utils::kAntiAliasPolicy_Med);
 
 //========================================================================================
 // PMMeasureStringDroverized
 //
 // Drawbot based utility function to obtain text dimension based on specified font info.
 //========================================================================================
 DV_ PMPoint PMMeasureStringDroverized(
 const PMString & str,
 const InterfaceFontInfo & fontInfo,
 bool16 convertAmpersandToUnderline);
} 


#endif