CFx SDK Documentation  2023 SP0
Public Member Functions | List of all members
OdTtfDescriptor Class Reference

#include <TtfDescriptor.h>

Public Member Functions

 OdTtfDescriptor ()
 
 OdTtfDescriptor (const OdString &typeface, bool bold, bool italic, int charset, int pitchAndFamily)
 
const OdString & fileName () const
 
const OdString & typeface () const
 
OdUInt32 getTtfFlags () const
 
void clearFileName ()
 
void clearTypeface ()
 
void addTypeface (OdChar typeface)
 
void getTtfFlags (bool &bold, bool &italic, int &charset, int &pitchAndFamily) const
 
void setFileName (const OdString &filename)
 
void setTypeFace (const OdString &typeface)
 
void setTtfFlags (OdUInt32 flags)
 
void setTtfFlags (bool bold, bool italic, int charset, int pitchAndFamily)
 
void setBold (bool bold)
 
void setItalic (bool italic)
 
void setCharSet (int charset)
 
void setPitchAndFamily (int pitchAndFamily)
 
bool isBold () const
 
bool isItalic () const
 
OdUInt16 charSet () const
 
int pitchAndFamily () const
 
int getPitch () const
 
int getFamily () const
 
TextRenderingMode textRenderingMode () const
 
void setTextRenderingMode (TextRenderingMode renderingMode)
 

Detailed Description

This class implements TrueType Descriptor objects which provide an interface to the characteristics of a TrueType font.

<group Other_Classes>

Definition at line 45 of file TtfDescriptor.h.

Constructor & Destructor Documentation

◆ OdTtfDescriptor() [1/2]

OdTtfDescriptor::OdTtfDescriptor ( )
inline

Definition at line 57 of file TtfDescriptor.h.

◆ OdTtfDescriptor() [2/2]

OdTtfDescriptor::OdTtfDescriptor ( const OdString &  typeface,
bool  bold,
bool  italic,
int  charset,
int  pitchAndFamily 
)
inline
Parameters
typeface[in] Typeface.
bold[in] True if and only if a bold font.
italic[in] True if and only if an italic font.
charset[in] Character set.
pitchAndFamily[in] Pitch and Family.
Remarks
The two low-order bits of pitchAndFamily specify the pitch of the font. Bits 4 through 7 of pitchAndFamily specify the font family.

Definition at line 72 of file TtfDescriptor.h.

Member Function Documentation

◆ addTypeface()

void OdTtfDescriptor::addTypeface ( OdChar  typeface)
inline

Adds the specified typeface to this TtfDescriptor object.

Definition at line 112 of file TtfDescriptor.h.

◆ charSet()

OdUInt16 OdTtfDescriptor::charSet ( ) const
inline

Returns the character set for this TtfDescriptor object.

Definition at line 207 of file TtfDescriptor.h.

◆ clearFileName()

void OdTtfDescriptor::clearFileName ( )
inline

Clears the filename of this TtfDescriptor object.

Definition at line 98 of file TtfDescriptor.h.

◆ clearTypeface()

void OdTtfDescriptor::clearTypeface ( )
inline

Clears the typeface of this TtfDescriptor object.

Definition at line 105 of file TtfDescriptor.h.

◆ fileName()

const OdString& OdTtfDescriptor::fileName ( ) const
inline

Returns the filename of this TtfDescriptor object.

Definition at line 83 of file TtfDescriptor.h.

◆ getFamily()

int OdTtfDescriptor::getFamily ( ) const
inline

Returns the family of this TtfDescriptor object.

Definition at line 224 of file TtfDescriptor.h.

◆ getPitch()

int OdTtfDescriptor::getPitch ( ) const
inline

Returns the pitch of this TtfDescriptor object.

Definition at line 220 of file TtfDescriptor.h.

◆ getTtfFlags() [1/2]

OdUInt32 OdTtfDescriptor::getTtfFlags ( ) const
inline

Returns the flags of this TtfDescriptor object.

Definition at line 93 of file TtfDescriptor.h.

◆ getTtfFlags() [2/2]

void OdTtfDescriptor::getTtfFlags ( bool &  bold,
bool &  italic,
int &  charset,
int &  pitchAndFamily 
) const
inline

Returns the flags of this TtfDescriptor object.

Parameters
bold[out] Receives true if and only if this is a bold font.
italic[out] Receives true if and only if this is an italic font.
charset[out] Receives the character set.
pitchAndFamily[out] Receives the Pitch and Family.
Remarks
The two low-order bits of pitchAndFamily specify the pitch of the font. Bits 4 through 7 of pitchAndFamily specify the font family.

Definition at line 128 of file TtfDescriptor.h.

◆ isBold()

bool OdTtfDescriptor::isBold ( ) const
inline

Returns true if and only if this TtfDescriptor is a bold font.

Definition at line 199 of file TtfDescriptor.h.

◆ isItalic()

bool OdTtfDescriptor::isItalic ( ) const
inline

Returns true if and only if this TtfDescriptor is an italic font.

Definition at line 203 of file TtfDescriptor.h.

◆ pitchAndFamily()

int OdTtfDescriptor::pitchAndFamily ( ) const
inline

Returns the pitch and family of this TtfDescriptor object.

Remarks
The two low-order bits of pitchAndFamily specify the pitch of the font. Bits 4 through 7 of pitchAndFamily specify the font family.

Definition at line 215 of file TtfDescriptor.h.

◆ setBold()

void OdTtfDescriptor::setBold ( bool  bold)
inline

Sets the bold flag of this TtfDescriptor object.

Parameters
bold[in] True if and only if a bold font.

Definition at line 175 of file TtfDescriptor.h.

◆ setCharSet()

void OdTtfDescriptor::setCharSet ( int  charset)
inline

Sets the character set of this TtfDescriptor object.

Parameters
charset[in] Character set.

Definition at line 185 of file TtfDescriptor.h.

◆ setFileName()

void OdTtfDescriptor::setFileName ( const OdString &  filename)
inline

Sets the filename of this TtfDescriptor object.

Parameters
filename[in] Filename.

Definition at line 140 of file TtfDescriptor.h.

◆ setItalic()

void OdTtfDescriptor::setItalic ( bool  italic)
inline

Sets the italic flag of this TtfDescriptor object.

Parameters
italic[in] True if and only if an italic font.

Definition at line 180 of file TtfDescriptor.h.

◆ setPitchAndFamily()

void OdTtfDescriptor::setPitchAndFamily ( int  pitchAndFamily)
inline

Sets the pitch and family of this TtfDescriptor object.

Parameters
pitchAndFamily[in] Pitch and Family.
Remarks
The two low-order bits of pitchAndFamily specify the pitch of the font. Bits 4 through 7 of pitchAndFamily specify the font family.

Definition at line 194 of file TtfDescriptor.h.

◆ setTextRenderingMode()

void OdTtfDescriptor::setTextRenderingMode ( TextRenderingMode  renderingMode)
inline

Sets text rendering mode (BasedA/BasedM) of this TtfDescriptor object.

Definition at line 234 of file TtfDescriptor.h.

◆ setTtfFlags() [1/2]

void OdTtfDescriptor::setTtfFlags ( bool  bold,
bool  italic,
int  charset,
int  pitchAndFamily 
)
inline

Sets the flags of this TtfDescriptor object.

Parameters
bold[in] True if and only if a bold font.
italic[in] True if and only if an italic font.
charset[in] Character set.
pitchAndFamily[in] Pitch and Family.
Remarks
The two low-order bits of pitchAndFamily specify the pitch of the font. Bits 4 through 7 of pitchAndFamily specify the font family.

Definition at line 163 of file TtfDescriptor.h.

◆ setTtfFlags() [2/2]

void OdTtfDescriptor::setTtfFlags ( OdUInt32  flags)
inline

Sets the flags of this TtfDescriptor object.

Parameters
flags[in] Flags.

Definition at line 150 of file TtfDescriptor.h.

◆ setTypeFace()

void OdTtfDescriptor::setTypeFace ( const OdString &  typeface)
inline

Sets the typeface of this TtfDescriptor object.

Parameters
typeface[in] Typeface.

Definition at line 145 of file TtfDescriptor.h.

◆ textRenderingMode()

TextRenderingMode OdTtfDescriptor::textRenderingMode ( ) const
inline

Returns text rendering mode (BasedA/BasedM) of this TtfDescriptor object.

Definition at line 229 of file TtfDescriptor.h.

◆ typeface()

const OdString& OdTtfDescriptor::typeface ( ) const
inline

Returns the typeface of this TtfDescriptor object.

Definition at line 88 of file TtfDescriptor.h.

The documentation for this class was generated from the following file:
Generated on Thu Feb 24 2022 15:11:12