williamr@2: // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies). williamr@2: // All rights reserved. williamr@2: // This component and the accompanying materials are made available williamr@2: // 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 williamr@2: // which accompanies this distribution, and is available williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". williamr@2: // williamr@2: // Initial Contributors: williamr@2: // Nokia Corporation - initial contribution. williamr@2: // williamr@2: // Contributors: williamr@2: // williamr@2: // Description: williamr@2: // williamr@2: williamr@2: #ifndef __COEHELP_H__ williamr@2: #define __COEHELP_H__ williamr@2: williamr@2: #include williamr@2: williamr@2: /** Holds the name of the help context. williamr@2: williamr@2: @publishedAll williamr@2: @released */ williamr@2: typedef TBuf<30> TCoeContextName; williamr@2: williamr@2: williamr@2: class TCoeHelpContext williamr@2: /** Help context. williamr@2: williamr@2: This class contains the information required to link the control and the appropriate williamr@2: context sensitive help topic. This information includes the UID of the help williamr@2: file and the literal descriptor for the appropriate help topic context. williamr@2: williamr@2: @see CCoeControl::GetHelpContext() williamr@2: @publishedAll williamr@2: @released */ williamr@2: { williamr@2: public: williamr@2: IMPORT_C TCoeHelpContext(); williamr@2: IMPORT_C TCoeHelpContext(TUid aMajor,const TDesC& aContext); williamr@2: IMPORT_C TBool IsNull() const; williamr@2: IMPORT_C TBool operator==(const TCoeHelpContext& aContext) const; williamr@2: IMPORT_C TBool operator!=(const TCoeHelpContext& aContext) const; williamr@2: public: williamr@2: /** The UID of the context sensitive help file containing the topic information. */ williamr@2: TUid iMajor; williamr@2: /** The name of the help context. This is the literal descriptor generated from williamr@2: a context string by the context sensitive help compiler. */ williamr@2: TCoeContextName iContext; williamr@2: private: williamr@2: TInt iTCoeHelpContext_Reserved1; williamr@2: }; williamr@2: williamr@2: #endif // __COEHELP_H__