Public Member Functions | Public Attributes | List of all members
Celartem::DjVu::FontConfig Struct Reference

#include <djv_common.h>

Public Member Functions

 FontConfig (const String &inFontName=NullString, size_t inSize=0)
 
 FontConfig (const FontConfig &inFontConfig)
 
FontConfig & operator= (const FontConfig &inFontConfig)
 
bool operator== (const FontConfig &inFontConfig) const
 
bool operator!= (const FontConfig &inFontConfig) const
 
bool isValid () const
 

Public Attributes

String fontName
 
size_t size
 

Detailed Description

This structure preserves font configuration.

Constructor & Destructor Documentation

Celartem::DjVu::FontConfig::FontConfig ( const String &  inFontName = NullString,
size_t  inSize = 0 
)
inline

Initialize the instance.

Parameters
inFontNameFont name. See fontName.
inSizeFont size in points.
Celartem::DjVu::FontConfig::FontConfig ( const FontConfig &  inFontConfig)
inline

Duplicate a FontConfig instance.

Parameters
inFontConfigAn instance to duplicate.

Member Function Documentation

bool Celartem::DjVu::FontConfig::isValid ( ) const
inline

Determines whether the instance is valid or not.

Returns
ture if the instance has valid font-face information; otherwise false.
bool Celartem::DjVu::FontConfig::operator!= ( const FontConfig &  inFontConfig) const
inline

Compare this instance with another (check inequality).

Parameters
inFontConfigAnother FontConfig instance to compare with.
Returns
true if there're any differences between the instances.
FontConfig& Celartem::DjVu::FontConfig::operator= ( const FontConfig &  inFontConfig)
inline

Duplicate a FontConfig instance.

Parameters
inFontConfigAn instance to duplicate.
Returns
Reference to this instance.
bool Celartem::DjVu::FontConfig::operator== ( const FontConfig &  inFontConfig) const
inline

Compare this instance with another (check equality).

Parameters
inFontConfigAnother FontConfig instance to compare with.
Returns
true if no difference between the instances.

Member Data Documentation

String Celartem::DjVu::FontConfig::fontName

Font name; so called font-family.
Please note that fonts on a machine may not be installed on another machine and you had better specify very common font-family name. The following is a list of such very common font-families: -helvetica (Helvetica, Arial, ...) -typewriter (Lucida Console, Consolas, -courier (Courier New, ...) -times (Times New Romain, ...) -gothic (Japanese Gothic Font; MS P Gothic, ...) -mincho (Japanese Mincho Font; MS P Mincho, ...) -default (Platform, OS, Locale dependent but GUI default font)

Referenced by isValid(), operator=(), and operator==().

size_t Celartem::DjVu::FontConfig::size

Font size in points.
1 point is corresponding to 1/72 inch.

Referenced by isValid(), operator=(), and operator==().


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

Cuminas DjVu SDK 3.0.33103
This document is made with doxygen 1.8.5 at Sun Dec 15 2013 19:38:07.
Cuminas Logo