Class: TLanguageStyle

Declaration: LanguageStyle.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TStyle

Inherited By:

None.

Purpose:

Derived from TStyle, it is used to tag text with a natural (not computer) language. This style should be used by other classes that parse text which need to perform language-sensitive analysis. For example, a spell checker needs to know the language of the word being checked.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

There are no special requirements for deriving this class beyond those pertaining to its parent class, TStyle.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TLanguageStyle::TLanguageStyle

TLanguageStyle (const TToken & language)
TLanguageStyle (const TLanguageStyle & language)

Interface Category:

API.

Purpose:

Creates a language style from a token representing the language's name.
Copy constructor.

Calling Context:

Called to create a new language style for a language if one is not already available.
Called to copy an object.

Parameters:

const TToken & language -A token representing the name of the language.
const TLanguageStyle & language -The TLanguageStyle to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLanguageStyle::GetLanguage

virtual void GetLanguage (TToken &) const

Interface Category:

API.

Purpose:

Gets a token representing the name of the language represented by the style.

Calling Context:

Used to determine the specific language with which text is tagged.

Parameters:

TToken & -A token to fill in representing the name of the language of the style.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLanguageStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

Returns the name of class as an instance of TStyleName.

Calling Context:

Used to distinguish TLanguageStyle from other styles.

Parameters:

Takes no parameters.

Return Value:

The name of the class as an instance of TStyleName.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLanguageStyle::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 the object streams itself in from.

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: TLanguageStyle::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 the object streams itself out to.

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: TLanguageStyle::operator==

virtual bool operator ==(const TStyle & thatStyle) const

Interface Category:

API.

Purpose:

Equality operator.

Calling Context:

Call to compare two objects of this class.

Parameters:

const TTextLineLayoutHyphenationInfo & -The object of this class to compare with this object.

Return Value:

Returns false if the objects are equal, true if they are not.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLanguageStyle::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Overrides inherited MCollectible function.

Calling Context:

Same as for base class.

Parameters:

Takes no parameters.

Return Value:

The numeric value of the hash.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TLanguageStyle::~TLanguageStyle

virtual ~ TLanguageStyle ()

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.

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