PixelLightAPI  .
Public Member Functions | Protected Attributes
PLGui::FontInfo Class Reference

Font information. More...

#include <FontInfo.h>

List of all members.

Public Member Functions

PLGUI_API FontInfo ()
 Constructor.
PLGUI_API FontInfo (const PLCore::String &sFilename, const PLCore::String &sFamily, PLCore::uint32 nHeight, EFontWeight nWeight, EFontStyle nStyle)
 Constructor.
PLGUI_API FontInfo (const FontInfo &cFontInfo)
 Copy constructor.
PLGUI_API ~FontInfo ()
 Destructor.
PLGUI_API FontInfooperator= (const FontInfo &cFontInfo)
 Assignment operator.
PLGUI_API bool operator== (const FontInfo &cFontInfo) const
 Comparison operator.
PLGUI_API PLCore::String GetFilename () const
 Get font file name.
PLGUI_API PLCore::String GetFamily () const
 Get font family.
PLGUI_API PLCore::uint32 GetHeight () const
 Get font height.
PLGUI_API EFontWeight GetWeight () const
 Get font weight.
PLGUI_API EFontStyle GetStyle () const
 Get font style.

Protected Attributes

PLCore::String m_sFilename
PLCore::String m_sFamily
PLCore::uint32 m_nHeight
EFontWeight m_nWeight
EFontStyle m_nStyle

Detailed Description

Font information.


Constructor & Destructor Documentation

Constructor.

PLGUI_API PLGui::FontInfo::FontInfo ( const PLCore::String sFilename,
const PLCore::String sFamily,
PLCore::uint32  nHeight,
EFontWeight  nWeight,
EFontStyle  nStyle 
)

Constructor.

Parameters:
[in]sFilenameFont file name
[in]sFamilyFont family name
[in]nHeightFont height
[in]nWeightFont weight (
See also:
EFontWeight)
Parameters:
[in]nStyleFont style
PLGUI_API PLGui::FontInfo::FontInfo ( const FontInfo cFontInfo)

Copy constructor.

Parameters:
[in]cFontInfoFont info that is copied

Destructor.


Member Function Documentation

PLGUI_API FontInfo& PLGui::FontInfo::operator= ( const FontInfo cFontInfo)

Assignment operator.

Parameters:
[in]cFontInfoFont info that is copied
PLGUI_API bool PLGui::FontInfo::operator== ( const FontInfo cFontInfo) const

Comparison operator.

Parameters:
[in]cFontInfoFont info that is compared
Returns:
'true' if fonts are equal, else 'false'

Get font file name.

Returns:
File name
Remarks:
Will only return a file name if the font file has been added manually

Get font family.

Returns:
Font family name
PLGUI_API PLCore::uint32 PLGui::FontInfo::GetHeight ( ) const

Get font height.

Returns:
Font height

Get font weight.

Returns:
Font weight

Get font style.

Returns:
Font style

Member Data Documentation

Filename for directly loaded fonts

Font family

PLCore::uint32 PLGui::FontInfo::m_nHeight [protected]

Font height

Font weight

Font style (normal, italics, ...)


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


PixelLight PixelLight 0.9.11-R1
Copyright (C) 2002-2012 by The PixelLight Team
Last modified Thu Feb 23 2012 14:09:32
The content of this PixelLight document is published under the
Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported