epoc32/include/coehelp.h
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
--- a/epoc32/include/coehelp.h	Tue Nov 24 13:55:44 2009 +0000
+++ b/epoc32/include/coehelp.h	Tue Mar 16 16:12:26 2010 +0000
@@ -1,1 +1,55 @@
-coehelp.h
+// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
+// which accompanies this distribution, and is available
+// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+//
+
+#ifndef __COEHELP_H__
+#define __COEHELP_H__
+
+#include <e32std.h>
+
+/** Holds the name of the help context.
+
+@publishedAll
+@released */
+typedef TBuf<30> TCoeContextName;
+
+
+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.
+
+@see CCoeControl::GetHelpContext() 
+@publishedAll
+@released */
+	{
+public:
+	IMPORT_C TCoeHelpContext();
+	IMPORT_C TCoeHelpContext(TUid aMajor,const TDesC& aContext);
+	IMPORT_C TBool IsNull() const;
+	IMPORT_C TBool operator==(const TCoeHelpContext& aContext) const;
+	IMPORT_C TBool operator!=(const TCoeHelpContext& aContext) const;
+public:
+	/** The UID of the context sensitive help file containing the topic information. */
+	TUid iMajor;
+	/** The name of the help context. This is the literal descriptor generated from 
+	a context string by the context sensitive help compiler. */
+	TCoeContextName iContext;
+private:
+    TInt iTCoeHelpContext_Reserved1;
+	};
+
+#endif	// __COEHELP_H__