williamr@2: // Copyright (c) 2000-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 __EIKBHELP_H__
williamr@2: #define __EIKBHELP_H__
williamr@2: 
williamr@2: #include <coemain.h>
williamr@2: 
williamr@2: const TUid KEikBubbleHelpUid={0x10008E48};
williamr@2: 
williamr@2: class CCoeControl;
williamr@2: 
williamr@2: /**
williamr@2: @publishedPartner
williamr@2: @deprecated
williamr@2: */
williamr@2: class MEikTriggeredHelp	
williamr@2: 	{
williamr@2: // The MEikTriggeredHelp class defines an interface for UI classes 
williamr@2: // to implement triggered, transient help message display.
williamr@2: public:
williamr@2: 	virtual void TriggerHelp(const TDesC& aDes,const TRect& aRect,TInt aHandle)=0;
williamr@2: 	virtual void CancelHelp()=0;
williamr@2: 	virtual void CancelHelpTrigger()=0;
williamr@2: 	virtual TBool IsDisplayingHelp(TInt aHandle)=0;
williamr@2: 	virtual void Release()=0;
williamr@2: protected:
williamr@2: 	IMPORT_C virtual void MEikTriggeredHelp_Reserved_1();
williamr@2: 	IMPORT_C virtual void MEikTriggeredHelp_Reserved_2();
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: /** Provides the static functions that control bubble help.
williamr@2: 
williamr@2: Bubble help is a feature that enables short help messages to be displayed 
williamr@2: for controls in transient windows which pop up close to the control bodies. 
williamr@2: 
williamr@2: @publishedAll 
williamr@2: @released */
williamr@2: class EikBubbleHelp
williamr@2: 	{
williamr@2: public:
williamr@2: 	IMPORT_C static void Trigger(const TDesC& aDes,const TRect& aRect,TInt aHandle=-1);
williamr@2: 	IMPORT_C static void Cancel();
williamr@2: 	IMPORT_C static void CancelTrigger();
williamr@2: 	IMPORT_C static TBool IsDisplaying(TInt aHandle);
williamr@2: 	};
williamr@2: 
williamr@2: 
williamr@2: /**
williamr@2: @publishedPartner
williamr@2: @deprecated
williamr@2: */
williamr@2: class CEikBubbleHelp : public CCoeStatic
williamr@2: // The CEikBubbleHelp class implements global static storage and access to the object providing bubble help
williamr@2: // for the application.  
williamr@2: 	{
williamr@2: 	~CEikBubbleHelp();
williamr@2: public: 
williamr@2: 	IMPORT_C static void SetTriggeredHelpL(MEikTriggeredHelp* aTriggeredHelp);
williamr@2: public:
williamr@2: 	static void Trigger(const TDesC& aDes,const TRect& aRect,TInt aHandle=-1);
williamr@2: 	static void Cancel();
williamr@2: 	static void CancelTrigger();
williamr@2: 	static TBool IsDisplaying(TInt aHandle);
williamr@2: private:
williamr@2: 	inline CEikBubbleHelp();
williamr@2: 	inline static CEikBubbleHelp* Self();
williamr@2: private:
williamr@2: 	MEikTriggeredHelp* iHelp;
williamr@2: 	};
williamr@2: 
williamr@2: inline CEikBubbleHelp::CEikBubbleHelp()
williamr@2: 	: CCoeStatic(KEikBubbleHelpUid)
williamr@2: 	{}
williamr@2: 
williamr@2: inline CEikBubbleHelp* CEikBubbleHelp::Self()
williamr@2: 	{return STATIC_CAST(CEikBubbleHelp*,CCoeEnv::Static(KEikBubbleHelpUid));}
williamr@2: 
williamr@2: #endif