1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 // Description:

    14 //

    15 

    16 #ifndef __COEHELP_H__

    17 #define __COEHELP_H__

    18 

    19 #include <e32std.h>

    20 

    21 /** Holds the name of the help context.

    22 

    23 @publishedAll

    24 @released */

    25 typedef TBuf<30> TCoeContextName;

    26 

    27 

    28 class TCoeHelpContext

    29 /** Help context.

    30 

    31 This class contains the information required to link the control and the appropriate 

    32 context sensitive help topic. This information includes the UID of the help 

    33 file and the literal descriptor for the appropriate help topic context.

    34 

    35 @see CCoeControl::GetHelpContext() 

    36 @publishedAll

    37 @released */

    38 	{

    39 public:

    40 	IMPORT_C TCoeHelpContext();

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

    42 	IMPORT_C TBool IsNull() const;

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

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

    45 public:

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

    47 	TUid iMajor;

    48 	/** The name of the help context. This is the literal descriptor generated from 

    49 	a context string by the context sensitive help compiler. */

    50 	TCoeContextName iContext;

    51 private:

    52     TInt iTCoeHelpContext_Reserved1;

    53 	};

    54 

    55 #endif	// __COEHELP_H__