Location:
TXTSTYLE.H
Link against: etext.lib
class CParagraphStyle : public CParaFormatLayer;
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.
CBase
- Base class for all classes to be instantiated on the heap
CFormatLayer
- Abstract base class for the paragraph and character format layers
CParaFormatLayer
- A paragraph format layer
CParagraphStyle
- Defines a paragraph style
Defined in CParagraphStyle
:
CharFormatLayer()
, CloneL()
, DoCloneL()
, EAddNewStyles
, EConvertNewStyles
, EIgnoreNewStyles
, ERetainAllSpecificFormats
, ERetainNoSpecificFormats
, ERetainSpecificCharFormat
, ERetainSpecificParaFormat
, ExternalizeL()
, InternalizeL()
, NewL()
, OutlineLevel()
, SetOutlineLevel()
, SetType()
, TApplyParaStyleMode
, TStylePasteMode
, Type()
, iName
, ~CParagraphStyle()
Inherited from CBase
:
Delete()
,
Extension_()
,
operator new()
Inherited from CFormatLayer
:
ChainCount()
,
ExternalizeChainL()
,
InternalizeChainL()
,
IsEmpty()
,
Reset()
,
SenseBase()
,
SetBase()
,
iBasedOn
,
iStore
Inherited from CParaFormatLayer
:
IsIdentical()
,
IsIdenticalL()
,
Ptr()
,
RestoreNewL()
,
SenseEffectiveL()
,
SenseL()
,
SetL()
static IMPORT_C CParagraphStyle *NewL(const CParaFormatLayer &aGlobalParaFormatLayer, const CCharFormatLayer &aGlobalCharFormatLayer);
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.
|
|
IMPORT_C ~CParagraphStyle();
The destructor frees all resources owned by the object, prior to its destruction.
inline CCharFormatLayer *CharFormatLayer() const;
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.
|
inline TInt OutlineLevel() const;
Gets the style's outline level.
|
inline void SetOutlineLevel(TInt aOutlineLevel);
Sets the style's outline level.
|
virtual IMPORT_C TUid Type() const;
Gets the style's type UID.
|
inline void SetType(TUid aType);
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.
|
inline CParagraphStyle *CloneL() const;
Creates and returns a CParagraphStyle object which is a clone of the current style.
|
private: virtual void InternalizeL(RReadStream &aStream, const CFormatLayer *aParaLayerBase, const CFormatLayer *aCharLayerBase);
|
private: virtual void ExternalizeL(RWriteStream &aStream) const;
Externalises the paragraph format layer but not its based-on link to a write stream. The presence of this function means that
the standard templated operator<<()
(defined in s32strm.h
) is available to externalise objects of this class.
|
TStylePasteMode
Controls what happens to the styles when styled rich text is pasted into another rich text object.
|
TApplyParaStyleMode
Retention of specific formatting
|
TParagraphStyleName iName;
Unique style name, with a maximum of 32 characters.