TCoeHelpContext Class Reference

#include <mw/coehelp.h>

Link against: cone.lib

class TCoeHelpContext

Public Attributes
TCoeContextName	iContext
TUid	iMajor

Public Member Functions
	TCoeHelpContext()
	TCoeHelpContext(TUid, const TDesC &)
IMPORT_C TBool	IsNull()
IMPORT_C TBool	operator!=(const TCoeHelpContext &)
IMPORT_C TBool	operator==(const TCoeHelpContext &)

Detailed 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.

Member Attribute Documentation

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.

iMajor

TUid

iMajor

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

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
aMajor	The UID of a Help file containing a set of related help topics.
aContext	The literal descriptor for a particular Help topic. This is generated from a context string by the CS Help compiler

Member Function Documentation

IsNull ( )

IMPORT_C TBool

IsNull

(

)

const

Tests if the TCoeHelpContext is NULL.

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

operator!= ( const TCoeHelpContext & )

IMPORT_C TBool

operator!=

(

const TCoeHelpContext &

aContext

)

const

Tests for inequality.

Parameters
aContext	The Help context to compare to this object.

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

operator== ( const TCoeHelpContext & )

IMPORT_C TBool

operator==

(

const TCoeHelpContext &

aContext

)

const

Tests for equality.

Parameters
aContext	The Help context to compare to this object.

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