Class: TFlushParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractParagraphStyle

Inherited By:

None.

Purpose:

TFlushParagraphStyle, derived from TAbstractParagraphStyle, is used to set the text alignment between margins (or between margins plus indents for indented lines).The alignment can be flush to the leading margin (or margin+indent), flush to the trailing margin (or margin+indent), or centered between margins (or margins+indents). If unspecified, the default is flush leading. A flush direction, either relative or absolute, may be specified. The default, relative, means that leading and trailing are defined using the panel's line orientation and the paragraph's TSegmentHorizontalSequenceParagraphStyle or TSegmentVerticalSequenceParagraphStyle. Absolute means that leading is interpreted as left-to-right for horizontal lines, and top-to-bottom for vertical lines, and trailing is interpreted as right-to-left for horizontal lines, and bottom-to-top for vertical lines. TJustifyParagraphStyle may be used to override TFlushParagraphStyle for all lines in the paragraph, for all lines but the last (or only) line in the paragraph, or for 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: TFlushParagraphStyle::TFlushParagraphStyle

TFlushParagraphStyle (TFlushParagraphStyle :: EFlushOption flushOption, TSingleLineOrientation :: ESequenceRelativity flushDirectionOption =TSingleLineOrientation :: kUseRelativeSequence)
TFlushParagraphStyle (const TFlushParagraphStyle &)
TFlushParagraphStyle ()

Interface Category:

API.

Purpose:

Constructor for creating a TFlushParagraphStyle with the specified flush option and flush direction option.
Copy constructor.
Default constructor.

Calling Context:

Called to construct a TFlushParagraphStyle with the specified flush option and flush direction option.
Called to copy an object.
Called by the stream-in operators.

Parameters:

TFlushParagraphStyle :: EFlushOption flushOption -The flush option (kFlushLeading, kCentered, or kFlushTrailing).
TSingleLineOrientation :: ESequenceRelativity flushDirectionOption =TSingleLineOrientation :: kUseRelativeSequence -The flush direction option (the default kUseRelativeSequence, or kUseAbsoluteSequence). If it's kUseRelativeSequence, leading and trailing are defined for the flush option using the panel's orientation and the paragraph's SegmentHorizontalSequenceParagraphStyle (left-to-right or right-to-left) or TSegmentVerticalSequenceParagraphStyle (top-to-bottom or bottom-to-top). If it's kUseAbsoluteSequence, leading is interpreted as left-to-right for horizontal lines, and top-to-bottom for vertical lines, and trailing is interpreted as right-to-left for horizontal lines, and bottom-to-top for vertical lines.
const TFlushParagraphStyle & -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: TFlushParagraphStyle::~TFlushParagraphStyle

virtual ~ TFlushParagraphStyle ()

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: TFlushParagraphStyle::GetName

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

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

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 TFlushParagraphStyle.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TAbstractParagraphStyle function.

Member Function: TFlushParagraphStyle::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: TFlushParagraphStyle::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: TFlushParagraphStyle::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: TFlushParagraphStyle::GetFlushOption

virtual EFlushOption GetFlushOption () const

Interface Category:

API.

Purpose:

Returns the flush option. If it's kFlushLeading, all flush lines in the paragraph are aligned flush with the leading edge of the paragraph (where leading is defined according to the flushDirectionOption), after adjusting that edge position for all margins plus indents. If it's kCentered, all flush lines in the paragraph are centered between the current margins plus indents. Finally, if it's kFlushTrailing, all flush lines in the paragraph are aligned flush with the trailing edge of the paragraph (where trailing is defined according to the flushDirectionOption), after adjusting that edge position for all margins plus indents.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The flush option (kFlushLeading, kCentered, or kFlushTrailing).

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFlushParagraphStyle::GetFlushDirectionOption

virtual TSingleLineOrientation::ESequenceRelativity GetFlushDirectionOption () const

Interface Category:

API.

Purpose:

Returns the flush direction option. If it's kUseRelativeSequence, leading and trailing are defined for the flush option using the panel's orientation and the paragraph's SegmentHorizontalSequenceParagraphStyle (left-to-right or right-to-left) or TSegmentVerticalSequenceParagraphStyle (top-to-bottom or bottom-to-top). If it's kUseAbsoluteSequence, leading is interpreted as left-to-right for horizontal lines, and top-to-bottom for vertical lines, and trailing is interpreted as right-to-left for horizontal lines, and bottom-to-top for vertical lines.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The flush direction option (kUseRelativeSequence or kUseAbsoluteSequence).

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFlushParagraphStyle::SetFlushOption

virtual void SetFlushOption (EFlushOption flushOption)

Interface Category:

API.

Purpose:

Sets the flush option. If it's kFlushLeading, all flush lines in the paragraph are aligned flush with the leading edge of the paragraph (where leading is defined according to the flushDirectionOption), after adjusting that edge position for all margins plus indents. If it's kCentered, all flush lines in the paragraph are centered between the current margins plus indents. Finally, if it's kFlushTrailing, all flush lines in the paragraph are aligned flush with the trailing edge of the paragraph (where trailing is defined according to the flushDirectionOption), after adjusting that edge position for all margins plus indents.

Calling Context:

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

Parameters:

EFlushOption flushOption -The flush option (kFlushLeading, kCentered, or kFlushTrailing).

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TFlushParagraphStyle::SetFlushDirectionOption

virtual void SetFlushDirectionOption (TSingleLineOrientation :: ESequenceRelativity flushDirectionOption)

Interface Category:

API.

Purpose:

Sets the flush direction option. If it's set to kUseRelativeSequence, leading and trailing are defined for the flush option using the panel's orientation and the paragraph's TSegmentHorizontalSequenceParagraphStyle or TSegmentVerticalSequenceParagraphStyle. If it's set to kUseAbsoluteSequence, the direction is assumed to be left-to-right for horizontal lines, and top-to-bottom for vertical lines.

Calling Context:

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

Parameters:

TSingleLineOrientation :: ESequenceRelativity flushDirectionOption -The flush direction option, either kUseRelativeSequence or kUseAbsoluteSequence.

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.