CTextEnum.h

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


namespace Text {

 enum FirstLineOffsetMetric {
 // Roman
 kFLOLeading = 0,
 kFLOAscent,
 kFLOCapHeight,
 kFLOEmBoxHeight,
 kFLOxHeight,
 kFLOFixedHeight,

 // More J only stuff...
 kFLOEmBoxDepth, // offset from bottom
 kFLOICFBottomInset, // offset from bottom
 kFLOICFTopInset, // offset from top

//>>>>> new values must be inserted here, i.e., just above kFLOCount <<<<<<<
 kFLOCount, //the number of actually defined enumerators

 kFLO_NoShuffleTop = kFLOCount, // prevents the line set with this value to shuffle to the top of a parcel

 // The last value. The maximum number of members is limited by
 // the specification of WaxLineImpl::TOFAlignment:5
 kFLOInvalid = 31
 };


 enum GridAlignmentMetric {
 kGANone = 0,
 kGABaseline,
 kGAEmTop,
 kGAEmCenter,
 kGAEmBottom,
 kGAICFTop,
 kGAICFBottom,
 kGACapHeight
 };


 enum LeadingModel { // Leading is measured from the:
 kRomanLeadingModel = 0, // Current Roman baseline to previous Roman baseline

 kJAkiBelow, // Current embox top to next embox top
 // (InDesign-J 1.0 Gyou-okuri model)

 kJAkiAbove, // Current embox top to previous embox top
 // (Opposite of ID-J: Aki is above the line)

 kCenterLeadingModel, // Current embox center to previous embox center

 kForcedSpaceAfter, // Similar to kJAkiBelow except that when
 // lines with this leading model are next
 // a different leading model no proportional
 // adjustments are made, this line "wins".

 kCenterDown // Current embox center to next embox center
 };


 enum VerticalJustification {
 kVJTop = 0,
 kVJCenter,
 kVJBottom,
 kVJJustify,

 // The last value. The maximum number of members is limited by this
 // value and if you wish to change it you will have to track down all
 // the code that assumes that they can represent this in 4 bits. See
 // TextCellData.cpp for starters.
 //
 kVJInvalid = 15,

 kVJNumValues
 };
 
 enum AutoSizeDimension {
 kASOff = 0,
 kASHeightOnly,
 kASWidthOnly,
 kASHeightAndWidth,
 kASHeightAndWidthProportional,

 // The last value. The maximum number of members is limited by this
 // value and if you wish to change it you will have to track down all
 // the code that assumes that they can represent this in 4 bits. 
 //
 kASInvalid = 15,
 }; 


 enum StartBreakLocation {
 kNoForcedBreak = 0,
 kStartAnywhere = 0,
 kAtColumn,
 kAtPage,
 kAtFrameBox,
 kAtOddPage,
 kAtEvenPage
 };

 enum DropCapDetailedSettings {

 kDCD_OpticalSettings = 0x00FF,
 kDropCapDetail_None = 0,
 kHonorLeftGlyphEdge = 1,
 kHonorDescenders = 2,
// kHonorTopGlyphEdge = 4,
// Contoured right edge settings would go here...

 kDCD_JapaneseSettings = 0xFF00,
 kFitDropCapOnJapaneseGrid = 0x0F00,
 kPadWidth4JapaneseGrid = 0x0100,
 kScaleUp4JapaneseGrid = 0x0200,
 kScaleDn4JapaneseGrid = 0x0400,

 kDCD_DefaultOnState = 0x0101 // left, padding
 };

 typedef int32 GlyphID;
}

const Text::GlyphID kInvalidGlyphID = -1;

// Used by underline and strikethrough, means use the font to calculate the weight/offset for the line
const PMReal kUseFontForULSTWeightOffset = -9999;



#endif // __CTextEnum__