PhWidgets::Drawing::FontFamily Class Reference

Defines a group of type faces having a similar basic design and certain variations in styles. This class cannot be inherited. More...

#include <Font.h>

Public Member Functions
	FontFamily (GenericFontFamilies::eGenericFontFamilies ffamily)
	(constructor) More...
	FontFamily (const FontDetails &fdetails)
	(constructor) More...
	FontFamily (std::string name)
	(constructor) More...
	FontFamily (std::string name, const FontCollection &fcollection)
	(constructor) More...
	FontFamily (const FontFamily &other)
	(copy constructor) More...
FontFamily &	operator= (const FontFamily &other)
	Assigns value in FontFamily. More...
bool	operator== (const FontFamily &other) const
	Compares FontFamilys. More...
bool	operator!= (const FontFamily &other) const
	Compares FontFamilys. More...
bool	operator< (const FontFamily &other) const
	Compares FontFamilys. More...
int	GetLineSpacing (typedefs::font_style_bitmask fstyle) const
bool	IsStyleAvailable (typedefs::font_style_bitmask fstyle) const
	Indicates whether the specified FontStyle::eFontStyle enumeration is available. More...

Public Attributes
const std::string &	Name
	Gets the name of this FontFamily. More...

Detailed Description

Defines a group of type faces having a similar basic design and certain variations in styles. This class cannot be inherited.

Constructor & Destructor Documentation

FontFamily() [1/5]

PhWidgets::Drawing::FontFamily::FontFamily

(

GenericFontFamilies::eGenericFontFamilies

ffamily

)

(constructor)

Initializes a new FontFamily from the specified generic font family.

Parameters

[in]

ffamily

The GenericFontFamilies::eGenericFontFamilies from which to create the new FontFamily.

Exceptions

std::invalid_argument

FontFamily() [2/5]

PhWidgets::Drawing::FontFamily::FontFamily

(

const FontDetails &

fdetails

)

(constructor)

Initializes a new FontFamily from the specified photon FontDetails.

Parameters

[in]

fdetails

The FontDetails from which to create the new FontFamily.

Exceptions

std::invalid_argument

FontFamily() [3/5]

PhWidgets::Drawing::FontFamily::FontFamily

(

std::string

name

)

(constructor)

Initializes a new FontFamily with the specified name.

Parameters

[in]

name

The name of the new FontFamily.

Exceptions

std::invalid_argument

FontFamily() [4/5]

PhWidgets::Drawing::FontFamily::FontFamily	(	std::string	name,
		const FontCollection &	fcollection
	)

(constructor)

Initializes a new FontFamily with the specified name.

Parameters

[in]	name	A std::string that represents the name of the new FontFamily.
[in]	fcollection	The FontCollection that contains this FontFamily.

Exceptions

std::invalid_argument

FontFamily() [5/5]

PhWidgets::Drawing::FontFamily::FontFamily

(

const FontFamily &

other

)

(copy constructor)

Constructs a FontFamily by copy.

Parameters

[in]

other

another FontFamily to be used as source to initialize the elements of the container with.

Member Function Documentation

GetLineSpacing()

int PhWidgets::Drawing::FontFamily::GetLineSpacing

(

typedefs::font_style_bitmask

fstyle

)

const

Returns the line spacing, in design units, of the FontFamily of the specified style. The line spacing is the vertical distance between the base lines of two consecutive lines of text.

Parameters

[in]

fstyle

The FontStyle::eFontStyle to apply.

IsStyleAvailable()

bool PhWidgets::Drawing::FontFamily::IsStyleAvailable

(

typedefs::font_style_bitmask

fstyle

)

const

Indicates whether the specified FontStyle::eFontStyle enumeration is available.

Parameters

[in]

fstyle

The FontStyle::eFontStyle to test.

operator!=()

bool PhWidgets::Drawing::FontFamily::operator!=

(

const FontFamily &

other

)

const

Compares FontFamilys.

Compares the FontFamilys by their Photon FontDetails.

Parameters

[in]

other

FontFamily whose contents to compare.

operator<()

bool PhWidgets::Drawing::FontFamily::operator<

(

const FontFamily &

other

)

const

Compares FontFamilys.

Compares the FontFamilys by their Photon FontDetails.

Parameters

[in]

other

FontFamily whose contents to compare.

operator=()

FontFamily & PhWidgets::Drawing::FontFamily::operator=

(

const FontFamily &

other

)

Assigns value in FontFamily.

Replaces the contents of the FontFamily.

Parameters

[in]

other

another FontFamily to use as data source.

operator==()

bool PhWidgets::Drawing::FontFamily::operator==

(

const FontFamily &

other

)

const

Compares FontFamilys.

Compares the FontFamilys by their Photon FontDetails.

Parameters

[in]

other

FontFamily whose contents to compare.

Member Data Documentation

Name

const std::string& PhWidgets::Drawing::FontFamily::Name

Gets the name of this FontFamily.

Property Value

‍std::string

A std::string that represents the name of this FontFamily.

---

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

• src/Drawing/Font.h