Class: TBooleanStyle

Declaration: LineLayoutStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TLineLayoutStyle

Inherited By:

None.

Purpose:

TBooleanStyle, derived from TLineLayoutStyle, is a style used for associating a Boolean value with text.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

TBooleanStyle is abstract, and must be derived to associate the Boolean value with a higher concept.

Concurrency:

Multithread safe.

Resource Use:

No special requirements.

Member Function: TBooleanStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

Returns the style's internal name. This is not necessarily the class name. For example, there are related underlining styles that are each separate derived classes. However, because they are mutually exclusive, they share the same internal name.

Calling Context:

Called when the name associated with an object is needed; for example, when comparing objects.

Parameters:

Takes no parameters.

Return Value:

The TToken for the associated name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TBooleanStyle::~TBooleanStyle

virtual ~ TBooleanStyle ()

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: TBooleanStyle::TBooleanStyle

TBooleanStyle (const bool value)
TBooleanStyle ()
TBooleanStyle (const TBooleanStyle &)

Interface Category:

API.

Purpose:

Instantiates this style class with a specified value.
Default constructor.
Copy constructor.

Calling Context:

Call to instantiate this style with a particular value.
Called by the stream-in operators.
Called to copy an object.

Parameters:

const bool value -The Boolean value for this style object.
Takes no parameters.
const TBooleanStyle & -The object to copy.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TBooleanStyle::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: TBooleanStyle::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: TBooleanStyle::operator==

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

Interface Category:

API.

Purpose:

Equality operator.

Calling Context:

Called to compare two objects.

Parameters:

const TStyle & thatStyle -The object to compare with this object.

Return Value:

Returns true if the objects are equal.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TBooleanStyle::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: TBooleanStyle::SetValue

virtual void SetValue (bool value)

Interface Category:

API.

Purpose:

Sets the value associated with this style instance.

Calling Context:

Used to set the value associated with this style instance.

Parameters:

bool value -The value with which this style instance is to be associated.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Multithread safe.

Other Considerations:

None.

Member Function: TBooleanStyle::GetValue

virtual bool GetValue () const

Interface Category:

API.

Purpose:

Returns the value associated with this style instance.

Calling Context:

Used to obtain the value associated with this style instance.

Parameters:

Takes no parameters.

Return Value:

The value associated with this style instance.

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.