epoc32/include/mw/coehelp.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/coehelp.h@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// 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
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef __COEHELP_H__
williamr@2
    17
#define __COEHELP_H__
williamr@2
    18
williamr@2
    19
#include <e32std.h>
williamr@2
    20
williamr@2
    21
/** Holds the name of the help context.
williamr@2
    22
williamr@2
    23
@publishedAll
williamr@2
    24
@released */
williamr@2
    25
typedef TBuf<30> TCoeContextName;
williamr@2
    26
williamr@2
    27
williamr@2
    28
class TCoeHelpContext
williamr@2
    29
/** Help context.
williamr@2
    30
williamr@2
    31
This class contains the information required to link the control and the appropriate 
williamr@2
    32
context sensitive help topic. This information includes the UID of the help 
williamr@2
    33
file and the literal descriptor for the appropriate help topic context.
williamr@2
    34
williamr@2
    35
@see CCoeControl::GetHelpContext() 
williamr@2
    36
@publishedAll
williamr@2
    37
@released */
williamr@2
    38
	{
williamr@2
    39
public:
williamr@2
    40
	IMPORT_C TCoeHelpContext();
williamr@2
    41
	IMPORT_C TCoeHelpContext(TUid aMajor,const TDesC& aContext);
williamr@2
    42
	IMPORT_C TBool IsNull() const;
williamr@2
    43
	IMPORT_C TBool operator==(const TCoeHelpContext& aContext) const;
williamr@2
    44
	IMPORT_C TBool operator!=(const TCoeHelpContext& aContext) const;
williamr@2
    45
public:
williamr@2
    46
	/** The UID of the context sensitive help file containing the topic information. */
williamr@2
    47
	TUid iMajor;
williamr@2
    48
	/** The name of the help context. This is the literal descriptor generated from 
williamr@2
    49
	a context string by the context sensitive help compiler. */
williamr@2
    50
	TCoeContextName iContext;
williamr@2
    51
private:
williamr@2
    52
    TInt iTCoeHelpContext_Reserved1;
williamr@2
    53
	};
williamr@2
    54
williamr@2
    55
#endif	// __COEHELP_H__