Class TCoeHelpContext

class TCoeHelpContext;

Description

Help context.

This class contains the information required to link the control and the appropriate context sensitive help topic. This information includes the UID of the help file and the literal descriptor for the appropriate help topic context.

Members

Defined in TCoeHelpContext:

• IsNull()constTests if the TCoeHelpContext is NULL.
• TCoeHelpContext()Default constructor.
• TCoeHelpContext(TUid,const TDesC &)Constructor specifying a Help file and a topic context descriptor.
• iContextThe name of the help context. This is the literal descriptor generated from a co...
• iMajorThe UID of the context sensitive help file containing the topic information.
• operator!=(const TCoeHelpContext &)constTests for inequality.
• operator==(const TCoeHelpContext &)constTests for equality.

See also:

• CCoeControl::GetHelpContext(TCoeHelpContext &)constGets the control's help context.

IMPORT_C TCoeHelpContext();

Description

Default constructor.

Constructs a default TCoeHelpContext object, identifying a null CS Help file UID and context.

IMPORT_C TCoeHelpContext(TUid aMajor, const TDesC &aContext);

Description

Constructor specifying a Help file and a topic context descriptor.

Parameters

TUid aMajor The UID of a Help file containing a set of related help topics. const TDesC16 &aContext The literal descriptor for a particular Help topic. This is generated from a context string by the CS Help compiler

IMPORT_C TBool IsNull() const;

Description

Tests if the TCoeHelpContext is NULL.

Return value

TBool ETrue if the object is NULL, EFalse if either the context or Help file UID have been set.

IMPORT_C TBool operator==(const TCoeHelpContext &aContext) const;

Description

Tests for equality.

Parameters

const TCoeHelpContext &aContext The Help context to compare to this object.

Return value

TBool ETrue if aContext has the same data member values as this object, otherwise EFalse.

IMPORT_C TBool operator!=(const TCoeHelpContext &aContext) const;

Description

Tests for inequality.

Parameters

const TCoeHelpContext &aContext The Help context to compare to this object.

Return value

TBool ETrue if aContext has any different data member values as this object, otherwise EFalse.

TUid iMajor;

Description

The UID of the context sensitive help file containing the topic information.

TCoeContextName iContext;

Description

The name of the help context. This is the literal descriptor generated from a context string by the context sensitive help compiler.