CParagraphStyle Class Reference

#include <txtstyle.h>

Link against: etext.lib

class CParagraphStyle : public CParaFormatLayer

Inherits from

CParagraphStyle
- CParaFormatLayer
  - CFormatLayer

Public Attributes
TParagraphStyleName	iName

Public Member Enumerations
enum	TApplyParaStyleMode { ERetainAllSpecificFormats, ERetainNoSpecificFormats, ERetainSpecificParaFormat, ERetainSpecificCharFormat }
enum	TStylePasteMode { EAddNewStyles, EConvertNewStyles, EIgnoreNewStyles }

Public Member Functions
	~CParagraphStyle()
CCharFormatLayer *	CharFormatLayer()
CParagraphStyle *	CloneL()
IMPORT_C CParagraphStyle *	NewL(const CParaFormatLayer &, const CCharFormatLayer &)
TInt	OutlineLevel()
void	SetOutlineLevel(TInt)
void	SetType(TUid)
virtual IMPORT_C TUid	Type()

Inherited Attributes
	CFormatLayer::__DECLARE_TEST
	CFormatLayer::iBasedOn
	CFormatLayer::iStore

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()
	CFormatLayer::CFormatLayer()
	CFormatLayer::ChainCount()const
	CFormatLayer::CloneLayerL(CFormatLayer *)const
	CFormatLayer::ExternalizeChainL(RWriteStream &,TInt)const
	CFormatLayer::ExternalizeLayersRecurseL(RWriteStream &,TInt)const
	CFormatLayer::InternalizeChainL(RReadStream &,const CFormatLayer *)
	CFormatLayer::IsEmpty()const
	CFormatLayer::IsIdentical(const TUint8 *,TInt)const
	CFormatLayer::Reset()
	CFormatLayer::SenseBase()const
	CFormatLayer::SetBase(const CFormatLayer *)
	CFormatLayer::Swap(CFormatLayer &)
	CFormatLayer::~CFormatLayer()
	CParaFormatLayer::CParaFormatLayer()
	CParaFormatLayer::InternalizeL(RReadStream &,const CFormatLayer *)
	CParaFormatLayer::IsIdentical(CFormatLayer *,TBool)const
	CParaFormatLayer::IsIdenticalL(const CParaFormat *,const TParaFormatMask &)const
	CParaFormatLayer::NewCopyBaseL(const CParaFormatLayer *)
	CParaFormatLayer::NewL()
	CParaFormatLayer::NewL(RReadStream &)
	CParaFormatLayer::NewL(const CParaFormat *,const TParaFormatMask &)
	CParaFormatLayer::NewL(const CParaFormatLayer *)
	CParaFormatLayer::Ptr(TInt &)const
	CParaFormatLayer::RestoreNewL(RReadStream &)
	CParaFormatLayer::SenseEffectiveL(CParaFormat *,CParaFormat::TParaFormatGetMode)const
	CParaFormatLayer::SenseL(CParaFormat *,TParaFormatMask &,CParaFormat::TParaFormatGetMode)const
	CParaFormatLayer::SetL(const CParaFormat *,const TParaFormatMask &)

Detailed Description

Defines a paragraph style.

A paragraph style is a named paragraph format layer which owns a set of character format attributes, has an outline level and a type UID. The outline level controls which headings should be shown when in document outline view. The type UID is used to differentiate between a word processor's built-in styles, which cannot be deleted, and user-defined styles, which can be deleted.

The style's paragraph format attributes can be set using the functions derived from the base class CParaFormatLayer. Its character format attributes can be set through the owned CCharFormatLayer*. The style's character and paragraph format attributes are based on the global format layers specified on construction.

Member Attribute Documentation

iName

TParagraphStyleName

iName

Unique style name, with a maximum of 32 characters.

Member Enumeration Documentation

Enum TApplyParaStyleMode

Retention of specific formatting

Enumerator	Value	Description
ERetainAllSpecificFormats		Specific character and paragraph formatting which has been applied to the paragraph is retained when a style is applied. If the style's formatting conflicts with the specific formatting, the specific formatting overrides the style.
ERetainNoSpecificFormats		Specific character and paragraph formatting which has been applied to the paragraph is removed when a style is applied, regardless of whether or not it conflicts with the style.
ERetainSpecificParaFormat		Specific paragraph formatting which has been applied to the paragraph is retained when a style is applied. If the style's formatting conflicts with the specific paragraph formatting, the specific formatting overrides the style. Specific character formatting which has been applied to the paragraph is removed, regardless of whether or not it conflicts with the style.
ERetainSpecificCharFormat		Specific character formatting which has been applied to the paragraph is retained when a style is applied. If the style's formatting conflicts with the specific character formatting, the specific formatting overrides the style. Specific paragraph formatting which has been applied to the paragraph is removed, regardless of whether or not it conflicts with the style.

Enum TStylePasteMode

Controls what happens to the styles when styled rich text is pasted into another rich text object.

Enumerator	Value	Description
EAddNewStyles		The pasted rich text retains all formatting and any new style definitions are added to the style list of the rich text object into which it is pasted.
EConvertNewStyles		The pasted rich text retains all formatting, including that specified in the styles, but the new style definitions are not added to the style list of the rich text object into which it is pasted. The formatting specified in the styles becomes specific formatting.
EIgnoreNewStyles		The pasted rich text loses all formatting specified in the styles.

Constructor & Destructor Documentation

~CParagraphStyle ( )

IMPORT_C

~CParagraphStyle

(

)

The destructor frees all resources owned by the object, prior to its destruction.

Member Function Documentation

CharFormatLayer ( )

CCharFormatLayer *

CharFormatLayer

(

)

const [inline]

Gets a pointer to the character format layer owned by the object.

Note

The style's character formatting is set and retrieved using this pointer.

Returns: Pointer to the style's global character format layer.

CloneL ( )

CParagraphStyle *

CloneL

(

)

const [inline]

Reimplemented from CParaFormatLayer::CloneL()const

Creates and returns a CParagraphStyle object which is a clone of the current style.

Returns: Pointer to a clone of the current style.

NewL ( const CParaFormatLayer &, const CCharFormatLayer & )

IMPORT_C CParagraphStyle *	NewL	(	const CParaFormatLayer &	aGlobalParaFormatLayer,
			const CCharFormatLayer &	aGlobalCharFormatLayer
		)	[static]

Allocates and constructs a CParagraphStyle object whose formatting is based on a global paragraph and character format layer. The type UID is initialised to KUserDefinedParagraphStyleUid. The outline level is not initialised.

Parameter	Description
aGlobalParaFormatLayer	The paragraph format layer on which the style's paragraph formatting is based.
aGlobalCharFormatLayer	The character format layer on which the style's character formatting is based.

Returns: Pointer to the new CParagraphStyle object.

OutlineLevel ( )

TInt

OutlineLevel

(

)

const [inline]

Gets the style's outline level.

Returns: The style's outline level.

SetOutlineLevel ( TInt )

void

SetOutlineLevel

(

TInt

aOutlineLevel

)

[inline]

Sets the style's outline level.

Parameter	Description
aOutlineLevel	The style's new outline level.

SetType ( TUid )

void

SetType

(

TUid

aType

)

[inline]

Sets the style's type UID. On construction, the style's type UID is initialized to KUserDefinedParagraphStyleUid to distinguish it from ordinary paragraph format layers, which have a type of KNormalParagraphStyleUid. This function can be used to change it to another value.

Parameter	Description
aType	The style's type UID.

Type ( )

IMPORT_C TUid

Type

(

)

const [virtual]

Reimplemented from CParaFormatLayer::Type()const

Gets the style's type UID.

Returns: The style's type UID.