epoc32/include/mw/coehelp.h
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 2fe1408b6811
child 4 837f303aceeb
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/mw/coehelp.h	Wed Mar 31 12:27:01 2010 +0100
     1.3 @@ -0,0 +1,55 @@
     1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// 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
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __COEHELP_H__
    1.20 +#define __COEHELP_H__
    1.21 +
    1.22 +#include <e32std.h>
    1.23 +
    1.24 +/** Holds the name of the help context.
    1.25 +
    1.26 +@publishedAll
    1.27 +@released */
    1.28 +typedef TBuf<30> TCoeContextName;
    1.29 +
    1.30 +
    1.31 +class TCoeHelpContext
    1.32 +/** Help context.
    1.33 +
    1.34 +This class contains the information required to link the control and the appropriate 
    1.35 +context sensitive help topic. This information includes the UID of the help 
    1.36 +file and the literal descriptor for the appropriate help topic context.
    1.37 +
    1.38 +@see CCoeControl::GetHelpContext() 
    1.39 +@publishedAll
    1.40 +@released */
    1.41 +	{
    1.42 +public:
    1.43 +	IMPORT_C TCoeHelpContext();
    1.44 +	IMPORT_C TCoeHelpContext(TUid aMajor,const TDesC& aContext);
    1.45 +	IMPORT_C TBool IsNull() const;
    1.46 +	IMPORT_C TBool operator==(const TCoeHelpContext& aContext) const;
    1.47 +	IMPORT_C TBool operator!=(const TCoeHelpContext& aContext) const;
    1.48 +public:
    1.49 +	/** The UID of the context sensitive help file containing the topic information. */
    1.50 +	TUid iMajor;
    1.51 +	/** The name of the help context. This is the literal descriptor generated from 
    1.52 +	a context string by the context sensitive help compiler. */
    1.53 +	TCoeContextName iContext;
    1.54 +private:
    1.55 +    TInt iTCoeHelpContext_Reserved1;
    1.56 +	};
    1.57 +
    1.58 +#endif	// __COEHELP_H__