hlpmodel.h File Reference

Enum anonymous

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

Enumerator	Value	Description
EIndexList		Gets a list of index entries for all help files. Success is indicated by an 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 an 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 an 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 an 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 an ETopicAvailable event. The topic can then be retrieved using CHlpModel::LoadTopicL(). An unsuccessful search generates an ETopicNotFound event.
EIndexSearch		Searches for index entries for the specified help item. A successful search generates an ETopicListAvailable event. The list can then be retrieved using CHlpModel::LoadListL(). An unsuccessful search generates an ETopicListNoneFound event.
EQuickSearch		Searches the topic titles for the specified text. A successful search generates an ESearchListAvailable event. The list can then be retrieved using CHlpModel::LoadListL(). An unsuccessful search generates an ESearchListNoneFound event.
EFullTextSearch		Searches the full text of topics for the specified text. A successful search generates an ESearchListAvailable event. The list can then be retrieved using CHlpModel::LoadListL(). An unsuccessful search generates an ESearchListNoneFound event.
ETopicIdSearch		Searches for a topic with the specified ID. A successful search generates an ETopicAvailable event. The topic can then be retrieved using CHlpModel::LoadTopicL(). An unsuccessful search generates an ETopicNotFound event.

Enum anonymous

Search progress responses

Enumerator	Value	Description
ENoRecordsFound
ESearchInProgress
ESearchComplete

Enum anonymous

Help model search result events

Enumerator	Value	Description
ECategoryListAvailable		The search returned a category list. The list can be retrieved using CHlpModel::CategoryListL().
ECategoryListNoneFound		The search did not return a category list.
ESearchListAvailable		The search returned a results list. The list can be retrieved using CHlpModel::LoadListL().
ESearchListNoneFound		The search did not return a results list.
ETopicListAvailable		The search returned a topic list. The list can be retrieved using CHlpModel::LoadListL().
ETopicListNoneFound		The search did not return a topic list.
EIndexListAvailable		The search returned an index item list. The list can be retrieved using CHlpModel::LoadListL().
EIndexListNoneFound		The search did not return an index item list.
EIndexSearchListAvailable		The search returned a topic list from an index phrase search. The list can be retrieved using CHlpModel::LoadListL().
EIndexSearchListNoneFound		The search did not return a topic list from an index phrase search.
ETopicAvailable		The search returned a topic. The topic can be retrieved using CHlpModel::LoadTopicL().
ETopicNotFound		The search did not return a topic.
EModelSearchInProgress		The search is in progress.
EHlpSearchCancelled		The search has been cancelled.

Enum THlpZoomState

Defines help model zoom sizes.

Enumerator	Value	Description
EHlpZoomStateSmall	0	Small zoom.
EHlpZoomStateMedium	1	Medium zoom.
EHlpZoomStateLarge	2	Large zoom.