Class: TJustifyParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

TJustifyParagraphStyle
~TJustifyParagraphStyle
GetName
operator==
operator>>=
operator<<=
GetJustifyOption
SetJustifyOption

Interface Category:

API.

Inherits From:

TAbstractParagraphStyle

Inherited By:

None.

Purpose:

TJustifyParagraphStyle, derived from TAbstractParagraphStyle, is used to override the TFlushParagraphStyle flush/centered alignment specification for selected lines in the paragraph, setting them justified to both margins (or margins plus indents for indented lines). The lines to be overridden can be (1) all the lines in the paragraph, (2) all the lines except the last (or only) line in the paragraph, or (3) none of the lines in the paragraph.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

This class is designed to be used directly.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Other Considerations:

None.

Member Function: TJustifyParagraphStyle::TJustifyParagraphStyle

TJustifyParagraphStyle (EJustifyOption justifyOption)
TJustifyParagraphStyle (const TJustifyParagraphStyle &)
TJustifyParagraphStyle ()

Interface Category:

API.

Purpose:

Constructor for creating a TJustifyParagraphStyle with the indicated justification option specifying which lines of the paragraph should be justified.
Copy constructor.
Default constructor.

Calling Context:

Called to create a TJustifyParagraphStyle with the indicated justification option specifying which lines of the paragraph should be justified.
Called to copy an object.
Called by the stream-in operators.

Parameters:

EJustifyOption justifyOption -The justification option (either kJustifyNone, kJustifyAllButLast, or kJustifyAll).
const TJustifyParagraphStyle & -The object to copy.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TJustifyParagraphStyle::~TJustifyParagraphStyle

virtual ~ TJustifyParagraphStyle ()

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:

None.

Member Function: TJustifyParagraphStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

Returns the paragraph style name, which is a token created from the class name TJustifyParagraphStyle.

Calling Context:

Called to determine the name of this style.

Parameters:

Takes no parameters.

Return Value:

A constant reference to the paragraph style name, which is a token created from the class name TJustifyParagraphStyle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TAbstractParagraphStyle function.

Member Function: TJustifyParagraphStyle::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: TJustifyParagraphStyle::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: TJustifyParagraphStyle::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: TJustifyParagraphStyle::GetJustifyOption

virtual EJustifyOption GetJustifyOption () const

Interface Category:

API.

Purpose:

Returns the justification option specifying which lines of the paragraph are to be justified.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The justification option, either kJustifyNone, kJustifyAllButLast, or kJustifyAll.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TJustifyParagraphStyle::SetJustifyOption

virtual void SetJustifyOption (TJustifyParagraphStyle :: EJustifyOption justifyOption)

Interface Category:

API.

Purpose:

Sets the justification option specifying which lines of the paragraph are to be justified.

Calling Context:

Protected member function: to be called only by derived classes.

Parameters:

TJustifyParagraphStyle :: EJustifyOption justifyOption -The justification option, either kJustifyNone, kJustifyAllButLast, or kJustifyAll.

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.