Class: TIndentParagraphStyle

Declaration: TextParagraphStyles.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TAbstractParagraphStyle

Inherited By:

None.

Purpose:

TIndentParagraphStyle, derived from TAbstractParagraphStyle, is used to override the margins on the leading side (specified by TLeadingMarginParagraphStyle), the trailing side (specified by TTrailingMarginParagraphStyle), or on both sides of the paragraph, where leading and trailing are interpreted according to TMarginAndIndentDirectionParagraphStyle. TIndentParagraphStyle allows you to set the leading paragraph indent (hanging or conventional) for a specified number of lines, the trailing paragraph indent for a specified number of lines, or both. A leading/trailing indent is the amount the specified lines are indented from the leading/trailing paragraph margin. Note that the negative value specified for hanging indents may not exceed the value of the corresponding margin, or the behavior is unpredictable, and some text may be clipped.

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

TIndentParagraphStyle (GTextCoordinate leadingIndentAmount, long leadingIndentCount =1, GTextCoordinate trailingIndentAmount =0.0, long trailingIndentCount =0)
TIndentParagraphStyle (const TIndentParagraphStyle &)
TIndentParagraphStyle ()

Interface Category:

API.

Purpose:

Constructor for creating a TIndentParagraphStyle with the specified leading indent amount, leading indent count (the number of lines with the leading indent amount), trailing indent amount, and trailing indent count.
Copy constructor.
Default constructor.

Calling Context:

Called to construct a TIndentParagraphStyle with the specified values.
Called to copy an object.
Called by the stream-in operators.

Parameters:

GTextCoordinate leadingIndentAmount -The leading indent amount, in units of 1/72 of an inch. A positive value is the amount the leading lines selected by leadingIndentCount are indented from the leading paragraph margin. A negative amount specifies the amount the same lines would hang outside that margin. A zero value disables leading indent.
long leadingIndentCount =1 -The number of lines to which the leading indent amount is applied. A zero value disables leading indent. The value may not be negative.
GTextCoordinate trailingIndentAmount =0.0 -The trailing indent amount, in units of 1/72 of an inch. A positive value is the amount the trailing lines selected by trailingIndentCount are indented from the trailing paragraph margin. A negative amount specifies the amount the same lines would hang outside that margin. A zero value disables trailing indent.
long trailingIndentCount =0 -The number of lines to which the trailing indent amount is applied. A zero value disables trailing indent. The value may not be negative.
const TIndentParagraphStyle & -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: TIndentParagraphStyle::~TIndentParagraphStyle

virtual ~ TIndentParagraphStyle ()

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

virtual const TStyleName & GetName () const

Interface Category:

API.

Purpose:

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

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

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Overrides inherited TAbstractParagraphStyle function.

Member Function: TIndentParagraphStyle::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: TIndentParagraphStyle::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: TIndentParagraphStyle::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: TIndentParagraphStyle::GetLeadingIndentAmount

virtual GTextCoordinate GetLeadingIndentAmount () const

Interface Category:

API.

Purpose:

Returns the leading indent amount. A positive value is the amount the leading lines selected by leadingIndentCount are indented from the leading paragraph margin. A negative amount specifies the amount the same lines would hang outside that margin. A zero value means leading indent is disabled.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The leading indent amount.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TIndentParagraphStyle::GetLeadingIndentCount

virtual long GetLeadingIndentCount () const

Interface Category:

API.

Purpose:

Returns the leading indent count, which is the number of lines to which the leading indent amount is applied. A zero value disables leading indent. The value may not be negative.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The leading indent count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TIndentParagraphStyle::GetTrailingIndentAmount

virtual GTextCoordinate GetTrailingIndentAmount () const

Interface Category:

API.

Purpose:

Returns the trailing indent amount. A positive value is the amount the trailing lines selected by trailingIndentCount are indented from the trailing paragraph margin. A negative amount specifies the amount the same lines would hang outside that margin. A zero value means trailing indent is disabled.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The trailing indent amount.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TIndentParagraphStyle::GetTrailingIndentCount

virtual long GetTrailingIndentCount () const

Interface Category:

API.

Purpose:

Returns the trailing indent count, which is the number of lines to which the trailing indent amount is applied. A zero value disables trailing indent. The value may not be negative.

Calling Context:

May be called directly by client.

Parameters:

Takes no parameters.

Return Value:

The trailing indent count.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TIndentParagraphStyle::SetLeadingIndentAmount

virtual void SetLeadingIndentAmount (GTextCoordinate leadingIndentAmount)

Interface Category:

API.

Purpose:

Sets the leading indent amount. A positive value is the amount the leading lines selected by leadingIndentCount will be indented from the leading paragraph margin. A negative amount specifies the amount the same lines would hang outside that margin. A zero value disables means leading indent.

Calling Context:

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

Parameters:

GTextCoordinate leadingIndentAmount -The leading indent amount set by this function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TIndentParagraphStyle::SetLeadingIndentCount

virtual void SetLeadingIndentCount (long leadingIndentCount)

Interface Category:

API.

Purpose:

Sets the leading indent count, which is the number of lines to which the leading indent amount is applied. A zero value disables leading indent. The value may not be negative.

Calling Context:

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

Parameters:

long leadingIndentCount -The leading indent count set by this function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TIndentParagraphStyle::SetTrailingIndentAmount

virtual void SetTrailingIndentAmount (GTextCoordinate trailingIndentAmount)

Interface Category:

API.

Purpose:

Sets the trailing indent amount. A positive value is the amount the trailing lines selected by trailingIndentCount are indented from the trailing paragraph margin. A negative amount specifies the amount the same lines would hang outside that margin. A zero value means trailing indent is disabled.

Calling Context:

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

Parameters:

GTextCoordinate trailingIndentAmount -The trailing indent amount set by this function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This function is protected.

Member Function: TIndentParagraphStyle::SetTrailingIndentCount

virtual void SetTrailingIndentCount (long trailingIndentCount)

Interface Category:

API.

Purpose:

Sets the trailing indent count, which is the number of lines to which the trailing indent amount is applied. A zero value disables trailing indent. The value may not be negative.

Calling Context:

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

Parameters:

long trailingIndentCount -The trailing indent count set by this function.

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.