Class TCoeHelpContext

TCoeHelpContext

Support

Supported from 5.1

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.

Defined in TCoeHelpContext:
IsNull(), TCoeHelpContext(), iContext, iMajor, operator!=(), operator==()

See also:

• CCoeControl::GetHelpContext()

TCoeHelpContext();

Description

Default constructor.

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

identifying the major grouping of related help topics with aMajor and a particular topic with aContext.

TCoeHelpContext(TUid aMajor,const TCoeContextName& aContext);

Support

Withdrawn in 6.0

Description

Constructor specifying a Help file and a topic context.

Note:

• This constructor was replaced with a version taking a TDesC after ER5u.

Parameters

TUid aMajor The UID of a Help file containing a set of related help topics. const TCoeContextName& aContext The name of a particular context.

TCoeHelpContext(TUid aMajor,const TDesC& aContext);

Support

Supported from 6.0

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

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.

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.

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.

TCoeContextName iContext

Description

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

TUid iMajor

Description

The UID of the CS Help file containing the topic information.