CFx SDK Documentation 2024 SP0
Loading...
Searching...
No Matches
Public Types | Public Member Functions | Public Attributes | List of all members
OdTextProperties Struct Reference

#include <OdFont.h>

Public Types

enum  {
  kNormalText = 0x01 , kVerticalText = 0x02 , kUnderlined = 0x04 , kOverlined = 0x08 ,
  kLastChar = 0x10 , kInBigFont = 0x20 , kInclPenups = 0x40 , kZeroNormals = 0x80 ,
  kBezierCurves = 0x100 , kStriked = 0x200 , kLastPosOnly = 0x400 , kTriangleCache = 0x800 ,
  kIsGlyph = 0x1000 , kExtentsCalculation = 0x4000
}
 

Public Member Functions

 OdTextProperties ()
 
bool isNormalText () const
 
void setNormalText (bool value)
 
bool isVerticalText () const
 
void setVerticalText (bool value)
 
bool isUnderlined () const
 
void setUnderlined (bool value)
 
bool isOverlined () const
 
void setOverlined (bool value)
 
bool isStriked () const
 
void setStriked (bool value)
 
bool isLastChar () const
 
void setLastChar (bool value)
 
bool isInBigFont () const
 
void setInBigFont (bool value)
 
bool isIncludePenups () const
 
void setIncludePenups (bool value)
 
bool isZeroNormals () const
 
void setZeroNormals (bool value)
 
bool ttfPolyDraw () const
 
void setTtfPolyDraw (bool bFlag)
 
double trackingPercent () const
 
void setTrackingPercent (double trackingPercent)
 
OdUInt32 textQuality () const
 
void setTextQuality (OdUInt32 val)
 
bool isTriangleCache () const
 
void setSetTriangleCache (bool value)
 
bool isLastPosOnly () const
 
void setLastPosOnly (bool value)
 
bool isGlyph () const
 
void setGlyph (bool value)
 

Public Attributes

double m_trackingPercent
 
OdUInt16 m_flags
 
OdUInt16 m_textQuality
 
OdChar m_prevChar
 

Detailed Description

This structure implements text properties in an OdGi context. Corresponding C++ library: TD_Root <group !!RECORDS_tkernel_apiref>

Definition at line 99 of file OdFont.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum
Enumerator
kNormalText 

Normal text

kVerticalText 

Vertical text

kUnderlined 

Underlined text

kOverlined 

Overlined text

kLastChar 

Last character in text

kInBigFont 

Character in Big Font

kInclPenups 

Include pen ups in extents for SHX font

kZeroNormals 

Zero normals

kBezierCurves 

Bezier curves for TrueType font

kStriked 

Striked text

kLastPosOnly 

Last position only. For internal use only.

kTriangleCache 

Use triangle cache for TrueType font. For internal use only.

kIsGlyph 

Symbol code is glyph. For internal use only.

kExtentsCalculation 

Definition at line 107 of file OdFont.h.

Constructor & Destructor Documentation

◆ OdTextProperties()

OdTextProperties::OdTextProperties ( )
inline

Definition at line 140 of file OdFont.h.

Member Function Documentation

◆ isGlyph()

bool OdTextProperties::isGlyph ( ) const
inline

Checks whether the kIsGlyph flag is set for this TextProperties object.

Returns
The true value if the kIsGlyph flag is set for this TextProperties object, or false otherwise.

Definition at line 350 of file OdFont.h.

◆ isInBigFont()

bool OdTextProperties::isInBigFont ( ) const
inline

Checks whether the inBigFont flag is set for this TextProperties object.

Returns
The true value if the inBigFont flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 231 of file OdFont.h.

◆ isIncludePenups()

bool OdTextProperties::isIncludePenups ( ) const
inline

Checks whether the includePenups flag is set for this TextProperties object.

Returns
The true value if the includePenups flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 245 of file OdFont.h.

◆ isLastChar()

bool OdTextProperties::isLastChar ( ) const
inline

Checks whether the lastChar flag is set for this TextProperties object.

Returns
The true value if the lastChar flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 217 of file OdFont.h.

◆ isLastPosOnly()

bool OdTextProperties::isLastPosOnly ( ) const
inline

Checks whether the kLastPosOnly flag is set for this TextProperties object.

Returns
The true value if the kLastPosOnly flag is set for this TextProperties object, or false otherwise.

Definition at line 336 of file OdFont.h.

◆ isNormalText()

bool OdTextProperties::isNormalText ( ) const
inline

Checks whether the normal text flag is set for this TextProperties object.

Returns
The true value if the normal text flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 147 of file OdFont.h.

◆ isOverlined()

bool OdTextProperties::isOverlined ( ) const
inline

Checks whether the overlined flag is set for this TextProperties object.

Returns
The true value if the overlined flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 189 of file OdFont.h.

◆ isStriked()

bool OdTextProperties::isStriked ( ) const
inline

Checks whether the striked flag is set for this TextProperties object.

Returns
The true value if the striked flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 203 of file OdFont.h.

◆ isTriangleCache()

bool OdTextProperties::isTriangleCache ( ) const
inline

Checks whether the kTringleCache flag is set for this TextProperties object.

Returns
The true value if the kTringleCache flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 321 of file OdFont.h.

◆ isUnderlined()

bool OdTextProperties::isUnderlined ( ) const
inline

Checks whether the underlined flag is set for this TextProperties object.

Returns
The true value if the underlined flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 175 of file OdFont.h.

◆ isVerticalText()

bool OdTextProperties::isVerticalText ( ) const
inline

Checks whether the vertical text flag is set for this TextProperties object.

Returns
The true value if the vertical text flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 161 of file OdFont.h.

◆ isZeroNormals()

bool OdTextProperties::isZeroNormals ( ) const
inline

Checks whether the kZeroNormals flag is set for this TextProperties object.

Returns
The true value if the zeroNormals flag is set for this TextProperties object successfully, or false otherwise.

Definition at line 259 of file OdFont.h.

◆ setGlyph()

void OdTextProperties::setGlyph ( bool  value)
inline

Controls the kIsGlyph flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 357 of file OdFont.h.

◆ setInBigFont()

void OdTextProperties::setInBigFont ( bool  value)
inline

Controls the inBigFont flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 238 of file OdFont.h.

◆ setIncludePenups()

void OdTextProperties::setIncludePenups ( bool  value)
inline

Controls the includePenups flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 252 of file OdFont.h.

◆ setLastChar()

void OdTextProperties::setLastChar ( bool  value)
inline

Controls the lastChar flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 224 of file OdFont.h.

◆ setLastPosOnly()

void OdTextProperties::setLastPosOnly ( bool  value)
inline

Controls the kLastPosOnly flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 343 of file OdFont.h.

◆ setNormalText()

void OdTextProperties::setNormalText ( bool  value)
inline

Controls the normal text flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 154 of file OdFont.h.

◆ setOverlined()

void OdTextProperties::setOverlined ( bool  value)
inline

Controls the overlined flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 196 of file OdFont.h.

◆ setSetTriangleCache()

void OdTextProperties::setSetTriangleCache ( bool  value)
inline

Controls the kTringleCache flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 328 of file OdFont.h.

◆ setStriked()

void OdTextProperties::setStriked ( bool  value)
inline

Controls the striked flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 210 of file OdFont.h.

◆ setTextQuality()

void OdTextProperties::setTextQuality ( OdUInt32  val)
inline

Sets the text quality percent for this vectorization process.

Parameters
val[in] Property value to set.
Remarks
Sets a value in the range [0,100]. The default is 50.

Definition at line 314 of file OdFont.h.

◆ setTrackingPercent()

void OdTextProperties::setTrackingPercent ( double  trackingPercent)
inline

Sets the tracking percent for this TextProperties object.

Parameters
trackingPercent[in] Tracking percent to set.

Definition at line 294 of file OdFont.h.

◆ setTtfPolyDraw()

void OdTextProperties::setTtfPolyDraw ( bool  bFlag)
inline

Sets the smooth TrueType font text contour output flag.

Parameters
bFlag[in] New flag value.

Definition at line 280 of file OdFont.h.

◆ setUnderlined()

void OdTextProperties::setUnderlined ( bool  value)
inline

Controls the underlined flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 182 of file OdFont.h.

◆ setVerticalText()

void OdTextProperties::setVerticalText ( bool  value)
inline

Controls the vertical text flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 168 of file OdFont.h.

◆ setZeroNormals()

void OdTextProperties::setZeroNormals ( bool  value)
inline

Controls the kZeroNormals flag for this TextProperties object.

Parameters
value[in] Property value to control the flag.

Definition at line 266 of file OdFont.h.

◆ textQuality()

OdUInt32 OdTextProperties::textQuality ( ) const
inline

Gets the text quality percent for this vectorization process.

Returns
The text quality percent for this vectorization process.
Remarks
Returns a value in the range [0,100]. The default is 50.

Definition at line 304 of file OdFont.h.

◆ trackingPercent()

double OdTextProperties::trackingPercent ( ) const
inline

Gets the tracking percent for this TextProperties object.

Returns
The tracking percent for this TextProperties object.

Definition at line 287 of file OdFont.h.

◆ ttfPolyDraw()

bool OdTextProperties::ttfPolyDraw ( ) const
inline

Gets the smooth TrueType font text contour output flag.

Returns
The smooth TrueType font text contour output flag.

Definition at line 273 of file OdFont.h.

Member Data Documentation

◆ m_flags

OdUInt16 OdTextProperties::m_flags

Text flags

Definition at line 104 of file OdFont.h.

◆ m_prevChar

OdChar OdTextProperties::m_prevChar

Previous character

Definition at line 138 of file OdFont.h.

◆ m_textQuality

OdUInt16 OdTextProperties::m_textQuality

Text quality in the range [0,100]

Definition at line 106 of file OdFont.h.

◆ m_trackingPercent

double OdTextProperties::m_trackingPercent

Tracking percent

Definition at line 102 of file OdFont.h.


The documentation for this struct was generated from the following file: