Class: TFontFamilyStyle

Declaration: FontStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TFontStyle

Inherited By:

None.

Purpose:

TFontFamilyStyle derives from TFontStyle and specifies the font family.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Derive a class from this class for any specialization. The value returned from GetCategory should be preserved and the pure virtual function GetName must be overridden to return an unique name.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TFontFamilyStyle::TFontFamilyStyle

TFontFamilyStyle ()
TFontFamilyStyle (const TToken & familyIdentifier)
TFontFamilyStyle (const TFontFamilyStyle &)

Interface Category:

API.

Purpose:

Default constructor.
Creates a new TFontFamilyStyle object and initializes the family name to be that which is contained in the given identifying token.
Copy constructor.

Calling Context:

Called by the stream-in operators and directly.
Call this function directly.
Called to copy an object.

Parameters:

Takes no parameters.
const TToken & familyIdentifier -The token containing the name of the font family to initialize the new object with.
const TFontFamilyStyle & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFontFamilyStyle::~TFontFamilyStyle

virtual ~ TFontFamilyStyle ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFontFamilyStyle::operator=

TFontFamilyStyle & operator =(const TFontFamilyStyle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TFontFamilyStyle & -The object to be assigned.

Return Value:

A non-const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFontFamilyStyle::operator==

virtual bool operator ==(const TStyle &) const

Interface Category:

API.

Purpose:

Tests whether two objects are equal.

Calling Context:

Call this function by using the operator in an expression.

Parameters:

const TStyle & -The object to be compared to this object.

Return Value:

Returns true if the two objects are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFontFamilyStyle::operator>>=

virtual TStream & operator >>=(TStream & toWhere) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & toWhere -The stream to which the object streams itself out.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFontFamilyStyle::operator<<=

virtual TStream & operator <<= (TStream & fromWhere)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & fromWhere -The stream from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFontFamilyStyle::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns the hash value of this object.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

The hash value of this object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFontFamilyStyle::GetDefaultFontFamilyStyle

static const TFontFamilyStyle & GetDefaultFontFamilyStyle ()

Interface Category:

API.

Purpose:

Returns an empty font family identifier. This empty TFontStyle object is used as a key for finding other TFontStyles objects in a TStyleSet by using the search functions of TStyleSet.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns an empty font family style object.

Exceptions:

Throws TGraphicsInternalException when FontServer is not accessible, passes all other exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TFontFamilyStyle::GetFamilyToken

virtual void GetFamilyToken (TToken &) const

Interface Category:

API.

Purpose:

Returns the font family as a token.

Calling Context:

Call this function directly.

Parameters:

TToken & -The font family returned by this function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.