ICJKGridUtils.h

//========================================================================================
// 
// $File$
// 
// Owner: Heath Lynn, (Bernd Paradies: generalized from BookUtils.h).
// 
// $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 __ICJKGRIDUTILS__
#define __ICJKGRIDUTILS__

#include "CJKGridID.h"
#include "IPMUnknown.h"
#include "Utils.h"
#include "PMPoint.h"
#include "AttributeBossList.h"

class ICJKGridData;
class ICJKLayoutGridData;
class ICJKGridManager;
class IGraphicsPort;
class IPMFont;
class IStoryOptions;
class PMRect;
class UIDList;
class IDocument;


class ICJKGridUtils : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICJKGRIDUTILS };

 enum WhichAttributes
 {
 kParaAttributes = 1,
 kCharAttributes = 2,
 kAllAttributes = 3
 };

 virtual IPMUnknown* QueryLayoutGrid(const IPMUnknown* thePage, PMIID iid = IID_ICJKLAYOUTGRIDDATA) = 0;

 virtual ICJKGridManager* QueryLayoutGridManager(const IPMUnknown *thePage) = 0;


 virtual void DrawCirclePath(IGraphicsPort* gPort, const PMRect& bounds) = 0;


 virtual bool16 MoveAcrossSingleColumn(PMReal& newCord, 
 PMReal colStart, 
 const PMReal& colEnd,
 const PMReal& spacing, 
 bool16 onlyAdvance,
 const PMReal& extra) = 0;


 virtual UID ConvertFontUID(UID sourceUID, IDataBase * srcDB, IDataBase * destDB) = 0;

 virtual PMPoint MeasureString(const PMString& str, const PMReal& fontSize, const PMReal& scaleX, const PMReal& scaleY) = 0;

 virtual PMReal CJKGridGetQTextSize() = 0;
 

 virtual bool16 TextFrameDrawsCJKCharCount(const IPMUnknown * obj) = 0;

 virtual void ApplyAttributesToGridData(const AttributeBossList &attributeBossList, ICJKGridData *cjkGridData, bool16 isVertical) = 0;

 virtual void ApplyGridLeadingToAttributes(const ICJKGridData* gridData, AttributeBossList *attrBossList, bool16 isVertical ) = 0;

 virtual void ApplyGridDataToAttributes(const ICJKGridData* cjkGridData, AttributeBossList* attributeBossList , ICJKGridUtils::WhichAttributes whichAttributes = ICJKGridUtils::kAllAttributes) = 0;

 virtual ErrorCode ApplyGridDataToAttributeLists(const UIDList & itemList ) = 0;

 virtual IPMFont * QueryCharacterCountFont() = 0;

 virtual void SetupSetCJKGridDataCmd(UID namedGridUID, ICJKGridData* gridData, UIDList & itemList, ICommand * cmd) = 0;

 virtual void AdjustFrameEndPoint(const UIDRef& parent, const bool16& bVertical, const PMPoint& location, PMPoint& defaultEndPoint, int32& xUnits, int32& yUnits) = 0;

 virtual void CalcCJKGridMetrics(const UIDRef& parent, const PBPMPoint& pt, const bool16& bVertical, PMReal& lineOkuri, PMReal& charOkuri, PMReal& lineAki, PMReal& charAki) = 0;

 virtual void GetCJKGridMetrics(const UIDRef& parent,
 const PBPMPoint& pt,
 PMReal& textSize,
 PMReal& charAki,
 PMReal& lineAki,
 PMReal& hScale,
 PMReal& vScale) = 0;

};


#endif // __ICJKGridUtils__