
DEVELOPER LIBRARY

» Developer Library » API Reference » C++ API reference » Help Model » CHlpTopic

Location: HLPMODEL.h
Link against: HLPMODEL.LIB

Class `CHlpTopic`

class CHlpTopic : public CBase

Support

Supported from 6.0

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

Defined in CHlpTopic:
Category(), CharFormatLayer(), ConstructL(), NewL(), NewLC(), ParaFormatLayer(), RestoreL(), TopicText(), TopicTitle(), iCategory, iGlobalCharFormatLayer, iGlobalParaFormatLayer, iTopicId, iTopicText, iTopicTitle, ~CHlpTopic()

Inherited from CBase:
operator new()

Construction and destruction

`NewL()`

static CHlpTopic* NewL();

Description

Allocates and creates a new help topic object.

Return value

CHlpTopic*

New help topic object

`NewLC()`

static 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

Member functions

`RestoreL()`

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

`TopicText()`

CRichText* TopicText();

Description

Gets the topic text.

Return value


CRichText*

Topic text

`TopicTitle()`

TDesC& TopicTitle();

Description

Gets the topic title.

Return value


TDesC&

Topic title

`Category()`

TDesC& Category();

Description

Gets the topic category.

Return value


TDesC&

Topic category

`ParaFormatLayer()`

inline CParaFormatLayer* ParaFormatLayer() const;

Description

Gets the topic paragraph formatting.

Return value


CParaFormatLayer*

Topic paragraph formatting

`CharFormatLayer()`

inline CCharFormatLayer* CharFormatLayer() const;

Description

Gets the topic character formatting.

Return value


CCharFormatLayer*

Topic character formatting