TCoeHelpContext Class Reference

class TCoeHelpContext

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.

CCoeControl::GetHelpContext()

Constructor & Destructor Documentation

TCoeHelpContext()

IMPORT_C TCoeHelpContext ( )

Default constructor.

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

TCoeHelpContext(TUid, const TDesC &)

IMPORT_C TCoeHelpContext ( TUid aMajor,
const TDesC & aContext
)

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 TDesC & aContext The literal descriptor for a particular Help topic. This is generated from a context string by the CS Help compiler

Member Functions Documentation

IsNull()

IMPORT_C TBool IsNull ( ) const

Tests if the TCoeHelpContext is NULL.

operator!=(const TCoeHelpContext &)

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

Tests for inequality.

Parameters

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

operator==(const TCoeHelpContext &)

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

Tests for equality.

Parameters

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

Member Data Documentation

TCoeContextName iContext

TCoeContextName iContext

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

TUid iMajor

TUid iMajor

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

TInt iTCoeHelpContext_Reserved1

TInt iTCoeHelpContext_Reserved1 [private]