IWaxLineShape.h

//========================================================================================
// 
// $File$
// 
// Owner: zwilliam
// 
// $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 __IWaxLineShape__
#define __IWaxLineShape__

#include "IPMUnknown.h"
#include "TextID.h"
#include "GraphicsData.h"
#include "DrawPassInfo.h"

class PMRect;
class PMLineSeg;

class IWaxLineShape : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_IWAXLINESHAPE };

 virtual void Draw(GraphicsData* gd, int32 iShapeFlags, Text::DrawPassInfo::Pass pass, const PMRect* areaToDraw = nil) = 0;

 virtual void GetInkBounds(PMRect * pInkBounds) = 0;

 virtual int32 GetPassCount() = 0;

 virtual Text::DrawPassInfo GetNthPass(int32 n) = 0;

 enum SelectionFlags {
 kFlag_SelectionAscToDesc = 0x00000000,
 kFlag_SelectionAscToBase = 0x00000001,
 kFlag_SelectionLeadToBase = 0x00000002, // all other flags ignored
 kFlag_SelectionJapanese = 0x00000004, // Embox based

 kFlag_SelectionRangeMask = 0x0000000f,

 kFlag_SelectionRespectShift = 0x00000010,
 kFlag_SelectionSkipThisYTop = 0x00000020,
 kFlag_SelectionSkipLineYTop = 0x00000040,
 kFlag_SelectionSkipThisYBottom = 0x00000080,
 kFlag_SelectionSkipLineYBottom = 0x00000100,

 kFlag_SelectionMask = 0x000001ff,

 kFlag_ReservedForImplementors = 0xffff0000
 };

 enum SelectionMode {
 kSelectionMode_AscToDesc = kFlag_SelectionAscToDesc,
 kSelectionMode_DropCap = (kFlag_SelectionAscToBase | kFlag_SelectionRespectShift | kFlag_SelectionSkipThisYTop |
 kFlag_SelectionSkipThisYBottom | kFlag_SelectionSkipLineYBottom),
 kSelectionMode_Anchor = kFlag_SelectionLeadToBase,
 kSelectionMode_Japanese = kFlag_SelectionJapanese,

 kSelectionMode_Default = kSelectionMode_AscToDesc
 };

 virtual int32 GetSelectionMode() const = 0;
 virtual void SetSelectionMode(int32 mode) = 0;

 virtual bool16 GetHasOverlappingHiliteRects() = 0;

 virtual void GetSelectionLine(PMLineSeg* pSelectionLine) = 0;
 virtual void GetCaretLineAt(int32 offset, PMLineSeg* pCaretLine, const PMLineSeg& pMaxTopBottom) const = 0;

 /* Cached data type related enumerators */
 enum CachedDataType {
 /* Flag depicting cached Ink bounds and PassInfo etc. */
 kCachedDataType_Ink = 0,
 
 /* Flag depicting cached Shading related data like shading height mode, shading bounds etc. */
 kCachedDataType_Shading = 1,
 
 /* Flag depicting cached Shading related data like border height mode, border bounds etc. */
 kCachedDataType_Border = 2,

 /* Flag depicting cached Column Rule related data like column rule height mode, bounds etc. */
 kCachedDataType_ColumnRule = 4
 };
 
 virtual void InvalCachedData(const bool16 invalAll = kTrue, const IWaxLineShape::CachedDataType cachedDataType = IWaxLineShape::kCachedDataType_Ink) = 0;

 virtual bool16 GetHasCachedData(const IWaxLineShape::CachedDataType cachedDataType = IWaxLineShape::kCachedDataType_Ink) const = 0;

 virtual void UpdateInkBounds(const PMRect* pInitialBounds = nil) = 0;

 /* Paragraph shading height determination flags */

 enum ShadingHeightFlags {
 /* Top Edge Ascent */
 kFlag_ShadingTopFlag_Ascent = 0x00000001,
 /* Top Edge Leading */
 kFlag_ShadingTopFlag_Leading = 0x00000002, 
 /* Top Edge Baseline */
 kFlag_ShadingTopFlag_Baseline = 0x00000004,
 /* Top Edge Cap Height */
 kFlag_ShadingTopFlag_CapHeight = 0x00000008,
 /* Top Edge Em Box - Useful for CJK feature set */
 kFlag_ShadingTopFlag_EmBox = 0x00000010,
 /* Top Edge x Height */
 kFlag_ShadingTopFlag_xHeight = 0x00000020,
 /* Top Edge Em Box center - Useful for CJK feature set */
 kFlag_ShadingTopFlag_EmBoxCenter = 0x00000040,
 /* Mask for Top Edge */
 kFlag_ShadingTopRangeMask = 0x000000ff,

 /* Bottom Edge Baseline*/
 kFlag_ShadingBottomFlag_Baseline = 0x00000100,
 /* Bottom Edge Descent */
 kFlag_ShadingBottomFlag_Descent = 0x00000200,
 /* Bottom Edge Em Box - Useful for CJK feature set */
 kFlag_ShadingBottomFlag_EmBox = 0x00000400,
 /* Bottom Edge Em Box center - Useful for CJK feature set */
 kFlag_ShadingBottomFlag_EmBoxCenter = 0x00000800,
 /* Mask for Bottom Edge */
 kFlag_ShadingBottomRangeMask = 0x00000f00,
 };

 enum ShadingHeightMode
 {
 kFlag_ShadingHeightAscToDesc = kFlag_ShadingTopFlag_Ascent | kFlag_ShadingBottomFlag_Descent,
 kFlag_ShadingHeightAscToBase = kFlag_ShadingTopFlag_Ascent | kFlag_ShadingBottomFlag_Baseline,
 kFlag_ShadingHeightAscToEmBox = kFlag_ShadingTopFlag_Ascent | kFlag_ShadingBottomFlag_EmBox,
 kFlag_ShadingHeightAscToEmBoxCenter = kFlag_ShadingTopFlag_Ascent | kFlag_ShadingBottomFlag_EmBoxCenter,

 kFlag_ShadingHeightLeadToDesc = kFlag_ShadingTopFlag_Leading | kFlag_ShadingBottomFlag_Descent,
 kFlag_ShadingHeightLeadToBase = kFlag_ShadingTopFlag_Leading | kFlag_ShadingBottomFlag_Baseline,
 kFlag_ShadingHeightLeadToEmBox = kFlag_ShadingTopFlag_Leading | kFlag_ShadingBottomFlag_EmBox,
 kFlag_ShadingHeightLeadToEmBoxCenter = kFlag_ShadingTopFlag_Leading | kFlag_ShadingBottomFlag_EmBoxCenter,

 kFlag_ShadingHeightBaseToDesc = kFlag_ShadingTopFlag_Baseline | kFlag_ShadingBottomFlag_Descent,
 kFlag_ShadingHeightBaseToBase = kFlag_ShadingTopFlag_Baseline | kFlag_ShadingBottomFlag_Baseline,
 kFlag_ShadingHeightBaseToEmBox = kFlag_ShadingTopFlag_Baseline | kFlag_ShadingBottomFlag_EmBox,
 kFlag_ShadingHeightBaseToEmBoxCenter = kFlag_ShadingTopFlag_Baseline | kFlag_ShadingBottomFlag_EmBoxCenter,

 kFlag_ShadingHeightEmBoxToDesc = kFlag_ShadingTopFlag_EmBox | kFlag_ShadingBottomFlag_Descent,
 kFlag_ShadingHeightEmBoxToBase = kFlag_ShadingTopFlag_EmBox | kFlag_ShadingBottomFlag_Baseline,
 kFlag_ShadingHeightEmBoxToEmBox = kFlag_ShadingTopFlag_EmBox | kFlag_ShadingBottomFlag_EmBox,
 kFlag_ShadingHeightEmBoxToEmBoxCenter = kFlag_ShadingTopFlag_EmBox | kFlag_ShadingBottomFlag_EmBoxCenter,

 kFlag_ShadingHeightxHeightToDesc = kFlag_ShadingTopFlag_xHeight | kFlag_ShadingBottomFlag_Descent,
 kFlag_ShadingHeightxHeightToBase = kFlag_ShadingTopFlag_xHeight | kFlag_ShadingBottomFlag_Baseline,
 kFlag_ShadingHeightxHeightToEmBox = kFlag_ShadingTopFlag_xHeight | kFlag_ShadingBottomFlag_EmBox,
 kFlag_ShadingHeightxHeightToEmBoxCenter = kFlag_ShadingTopFlag_xHeight | kFlag_ShadingBottomFlag_EmBoxCenter,

 kFlag_ShadingHeightCapHeightToDesc = kFlag_ShadingTopFlag_CapHeight | kFlag_ShadingBottomFlag_Descent,
 kFlag_ShadingHeightCapHeightToBase = kFlag_ShadingTopFlag_CapHeight | kFlag_ShadingBottomFlag_Baseline,
 kFlag_ShadingHeightCapHeightToEmBox = kFlag_ShadingTopFlag_CapHeight | kFlag_ShadingBottomFlag_EmBox,
 kFlag_ShadingHeightCapHeightToEmBoxCenter = kFlag_ShadingTopFlag_CapHeight | kFlag_ShadingBottomFlag_EmBoxCenter,

 kFlag_ShadingHeightEmBoxCenterToDesc = kFlag_ShadingTopFlag_EmBoxCenter | kFlag_ShadingBottomFlag_Descent,
 kFlag_ShadingHeightEmBoxCenterToBase = kFlag_ShadingTopFlag_EmBoxCenter | kFlag_ShadingBottomFlag_Baseline,
 kFlag_ShadingHeightEmBoxCenterToEmBox = kFlag_ShadingTopFlag_EmBoxCenter | kFlag_ShadingBottomFlag_EmBox,
 kFlag_ShadingHeightEmBoxCenterToEmBoxCenter = kFlag_ShadingTopFlag_EmBoxCenter | kFlag_ShadingBottomFlag_EmBoxCenter,
 };

 virtual void GetShadingHeight(ShadingHeightMode shadingHeightMode, PMLineSeg* pShadingHeight, const PMReal & romanBaseline) = 0;

 virtual void GetBorderHeight(ShadingHeightMode borderHeightMode, PMLineSeg* pBorderHeight, const PMReal & romanBaseline) = 0;

 virtual bool16 GetShadingBounds(PMRect& shadingBounds)const = 0;

 virtual bool16 GetBorderBounds(PMRect& borderBounds)const = 0;

 virtual void SetShadingBounds(const PMRect& shadingBounds) = 0;

 virtual void SetBorderBounds(const PMRect& borderBounds) = 0;

 virtual void GetColumnRuleHeight(ShadingHeightMode columnHeightMode, PMLineSeg* pColumnHeight, const PMReal & romanBaseline) = 0;
};

#endif