
DEVELOPER LIBRARY

» Developer Library » API Reference » C++ API reference » Help Model » Help Model search types enum

Location: HLPMODEL.h

Help model search types

Enum `(anonymous)`

N/A

Support

Supported from 6.0

Description

Defines search types for use with CHlpModel::SearchL().

`EIndexList`	Gets a list of index entries for all help files. Success is indicated by a `EIndexListAvailable` event; failure by `EIndexListNoneFound`. The list can be retrieved using `CHlpModel::LoadListL()`.
`ECategoryList`	Gets a list of categories for all help files. Success is indicated by a `ECategoryListAvailable` event; failure by `ECategoryListNoneFound`. The list can be retrieved using `CHlpModel::CategoryListL()`.
`ETopicListForCategory`	Gets a list of topics for a specified category. Success is indicated by a `ETopicListAvailable` event; failure by `ETopicListNoneFound`. The list can be retrieved using `CHlpModel::LoadListL()`.
`ETopicListForCategoryUID`	Gets a list of topics for a specified category UID. Success is indicated by a `ETopicListAvailable` event; failure by `ETopicListNoneFound`. The list can be retrieved using `CHlpModel::LoadListL()`.
`EContextSearch`	Searches for a topic with the specified help context. A successful search generates a `ETopicAvailable` event. The topic can then be retrieved using `CHlpModel::LoadTopicL()`. A unsuccessful search generates a `ETopicNotFound` event.
`EIndexSearch`	Searches for index entries for the specified help item. A successful search generates a `ETopicListAvailable` event. The list can then be retrieved using `CHlpModel::LoadListL()`. An unsuccessful search generates a `ETopicListNoneFound` event.
`EQuickSearch`	Searches topic titles for the specified text. A successful search generates a `ESearchListAvailable` event. The list can then be retrieved using `CHlpModel::LoadListL()`. An unsuccessful search generates a `ESearchListNoneFound` event.
`EFullTextSearch`	Searches full text of topics for the specified text. A successful search generates a `ESearchListAvailable` event. The list can then be retrieved using `CHlpModel::LoadListL()`. An unsuccessful search generates a `ESearchListNoneFound` event.
`ETopicIdSearch`	Searches for a topic with the specified ID. A successful search generates a `ETopicAvailable` event. The topic can then be retrieved using `CHlpModel::LoadTopicL()`. A unsuccessful search generates a `ETopicNotFound` event.