Class: TAbstractBooleanParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractParagraphStyle

Inherited By:

None.

Purpose:

TAbstractBooleanParagraphStyle is an abstract class used to build paragraph styles containing a Boolean value.

Instantiation:

Abstract class; do not instantiate directly.

Deriving Classes:

Derive a paragraph style class from TAbstractBooleanParagraphStyle when the class needs to contain a value of type Boolean.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TAbstractBooleanParagraphStyle::Value

virtual bool Value () const

Interface Category:

API.

Purpose:

Access function that returns the value of type Boolean that is stored by this class.

Calling Context:

Called to check the value.

Parameters:

Takes no parameters.

Return Value:

The bool value that is stored by this class.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractBooleanParagraphStyle::operator==

bool operator ==(const TStyle & style) const

Interface Category:

API.

Purpose:

Tests whether this object is equivalent to the argument object.

Calling Context:

Called to test equivalence of the two objects on either side of the ==symbol.

Parameters:

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

Return Value:

Returns true if the objects are equivalent.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractBooleanParagraphStyle::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:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractBooleanParagraphStyle::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:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractBooleanParagraphStyle::TAbstractBooleanParagraphStyle

TAbstractBooleanParagraphStyle (const TAbstractBooleanParagraphStyle & that)
TAbstractBooleanParagraphStyle (const bool value)
TAbstractBooleanParagraphStyle ()

Interface Category:

API.

Purpose:

Copy constructor. This constructor is protected.
Constructor for creating a TAbstractBooleanParagraphStyle with the specified Boolean value. This constructor is protected.
Default constructor. This constructor is protected.

Calling Context:

Called to copy an object.
Called to create a TAbstractBooleanParagraphStyle with the specified Boolean value.
Called by the stream-in operators.

Parameters:

const TAbstractBooleanParagraphStyle & that -The object to copy.
const bool value -The Boolean value to be stored by this object.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TAbstractBooleanParagraphStyle::~TAbstractBooleanParagraphStyle

virtual ~ TAbstractBooleanParagraphStyle ()

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:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAbstractBooleanParagraphStyle::operator=

TAbstractBooleanParagraphStyle & operator =(const TAbstractBooleanParagraphStyle &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TAbstractParagraphStyle & that -The source object for the assignment.

Return Value:

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TAbstractBooleanParagraphStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

Returns the style name.

Calling Context:

Called to determine the name of this style.

Parameters:

Takes no parameters.

Return Value:

The style name.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This is a protected pure virtual function and needs to be overridden.

Member Function: TAbstractBooleanParagraphStyle::Set

virtual void Set (bool)

Interface Category:

API.

Purpose:

Sets the Boolean value stored by this object to the specified value.

Calling Context:

Protected member function: to be called only by derived classes to initialize or change the value.

Parameters:

bool -The Boolean value to be stored.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

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