epoc32/include/eikbhelp.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     1 // Copyright (c) 2000-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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef __EIKBHELP_H__
    17 #define __EIKBHELP_H__
    18 
    19 #include <coemain.h>
    20 
    21 const TUid KEikBubbleHelpUid={0x10008E48};
    22 
    23 class CCoeControl;
    24 
    25 /**
    26 @publishedPartner
    27 @deprecated
    28 */
    29 class MEikTriggeredHelp	
    30 	{
    31 // The MEikTriggeredHelp class defines an interface for UI classes 
    32 // to implement triggered, transient help message display.
    33 public:
    34 	virtual void TriggerHelp(const TDesC& aDes,const TRect& aRect,TInt aHandle)=0;
    35 	virtual void CancelHelp()=0;
    36 	virtual void CancelHelpTrigger()=0;
    37 	virtual TBool IsDisplayingHelp(TInt aHandle)=0;
    38 	virtual void Release()=0;
    39 protected:
    40 	IMPORT_C virtual void MEikTriggeredHelp_Reserved_1();
    41 	IMPORT_C virtual void MEikTriggeredHelp_Reserved_2();
    42 	};
    43 
    44 
    45 /** Provides the static functions that control bubble help.
    46 
    47 Bubble help is a feature that enables short help messages to be displayed 
    48 for controls in transient windows which pop up close to the control bodies. 
    49 
    50 @publishedAll 
    51 @released */
    52 class EikBubbleHelp
    53 	{
    54 public:
    55 	IMPORT_C static void Trigger(const TDesC& aDes,const TRect& aRect,TInt aHandle=-1);
    56 	IMPORT_C static void Cancel();
    57 	IMPORT_C static void CancelTrigger();
    58 	IMPORT_C static TBool IsDisplaying(TInt aHandle);
    59 	};
    60 
    61 
    62 /**
    63 @publishedPartner
    64 @deprecated
    65 */
    66 class CEikBubbleHelp : public CCoeStatic
    67 // The CEikBubbleHelp class implements global static storage and access to the object providing bubble help
    68 // for the application.  
    69 	{
    70 	~CEikBubbleHelp();
    71 public: 
    72 	IMPORT_C static void SetTriggeredHelpL(MEikTriggeredHelp* aTriggeredHelp);
    73 public:
    74 	static void Trigger(const TDesC& aDes,const TRect& aRect,TInt aHandle=-1);
    75 	static void Cancel();
    76 	static void CancelTrigger();
    77 	static TBool IsDisplaying(TInt aHandle);
    78 private:
    79 	inline CEikBubbleHelp();
    80 	inline static CEikBubbleHelp* Self();
    81 private:
    82 	MEikTriggeredHelp* iHelp;
    83 	};
    84 
    85 inline CEikBubbleHelp::CEikBubbleHelp()
    86 	: CCoeStatic(KEikBubbleHelpUid)
    87 	{}
    88 
    89 inline CEikBubbleHelp* CEikBubbleHelp::Self()
    90 	{return STATIC_CAST(CEikBubbleHelp*,CCoeEnv::Static(KEikBubbleHelpUid));}
    91 
    92 #endif