Class CHlpTopic

class CHlpTopic : public CBase;

Description

Encapsulates a help topic.

A help topic has text, a title, a category, and paragraph and character formatting.

Derivation

• CBase - Base class for all classes to be instantiated on the heap

• CHlpTopic - Encapsulates a help topic

Members

Defined in CHlpTopic:
Category(), CharFormatLayer(), NewL(), NewLC(), ParaFormatLayer(), RestoreL(), TopicText(), TopicTitle(), ~CHlpTopic()

Inherited from CBase:
Delete(), Extension_(), operator new()

static IMPORT_C CHlpTopic *NewL();

Description

Allocates and creates a new help topic object.

Return value

CHlpTopic * New help topic object

static IMPORT_C CHlpTopic *NewLC();

Description

Allocates and creates a new help topic object, leaving the object on the cleanup stack.

Return value

CHlpTopic * New help topic object

IMPORT_C ~CHlpTopic();

Description

IMPORT_C void RestoreL(RDbView *aView);

Description

Restores the object from a database view.

This only restores text and markup, not pictures. Help application authors should use CHlpModel::LoadTopicL() instead.

Parameters

RDbView *aView Database view

IMPORT_C CRichText *TopicText();

Description

Gets the topic text.

Return value

CRichText * Topic text

IMPORT_C TDesC &TopicTitle();

Description

Gets the topic title.

Return value

TDesC & Topic title

IMPORT_C TDesC &Category();

Description

Gets the topic category.

Return value

TDesC & Topic category

inline CParaFormatLayer *ParaFormatLayer() const;

Description

Gets the topic paragraph formatting.

Return value

CParaFormatLayer * Topic paragraph formatting

inline CCharFormatLayer *CharFormatLayer() const;

Description

Gets the topic character formatting.

Return value

CCharFormatLayer * Topic character formatting