diff -r 666f914201fb -r 2fe1408b6811 epoc32/include/eikbhelp.h --- a/epoc32/include/eikbhelp.h Tue Nov 24 13:55:44 2009 +0000 +++ b/epoc32/include/eikbhelp.h Tue Mar 16 16:12:26 2010 +0000 @@ -1,1 +1,92 @@ -eikbhelp.h +// Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies). +// All rights reserved. +// This component and the accompanying materials are made available +// 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 +// which accompanies this distribution, and is available +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". +// +// Initial Contributors: +// Nokia Corporation - initial contribution. +// +// Contributors: +// +// Description: +// + +#ifndef __EIKBHELP_H__ +#define __EIKBHELP_H__ + +#include + +const TUid KEikBubbleHelpUid={0x10008E48}; + +class CCoeControl; + +/** +@publishedPartner +@deprecated +*/ +class MEikTriggeredHelp + { +// The MEikTriggeredHelp class defines an interface for UI classes +// to implement triggered, transient help message display. +public: + virtual void TriggerHelp(const TDesC& aDes,const TRect& aRect,TInt aHandle)=0; + virtual void CancelHelp()=0; + virtual void CancelHelpTrigger()=0; + virtual TBool IsDisplayingHelp(TInt aHandle)=0; + virtual void Release()=0; +protected: + IMPORT_C virtual void MEikTriggeredHelp_Reserved_1(); + IMPORT_C virtual void MEikTriggeredHelp_Reserved_2(); + }; + + +/** Provides the static functions that control bubble help. + +Bubble help is a feature that enables short help messages to be displayed +for controls in transient windows which pop up close to the control bodies. + +@publishedAll +@released */ +class EikBubbleHelp + { +public: + IMPORT_C static void Trigger(const TDesC& aDes,const TRect& aRect,TInt aHandle=-1); + IMPORT_C static void Cancel(); + IMPORT_C static void CancelTrigger(); + IMPORT_C static TBool IsDisplaying(TInt aHandle); + }; + + +/** +@publishedPartner +@deprecated +*/ +class CEikBubbleHelp : public CCoeStatic +// The CEikBubbleHelp class implements global static storage and access to the object providing bubble help +// for the application. + { + ~CEikBubbleHelp(); +public: + IMPORT_C static void SetTriggeredHelpL(MEikTriggeredHelp* aTriggeredHelp); +public: + static void Trigger(const TDesC& aDes,const TRect& aRect,TInt aHandle=-1); + static void Cancel(); + static void CancelTrigger(); + static TBool IsDisplaying(TInt aHandle); +private: + inline CEikBubbleHelp(); + inline static CEikBubbleHelp* Self(); +private: + MEikTriggeredHelp* iHelp; + }; + +inline CEikBubbleHelp::CEikBubbleHelp() + : CCoeStatic(KEikBubbleHelpUid) + {} + +inline CEikBubbleHelp* CEikBubbleHelp::Self() + {return STATIC_CAST(CEikBubbleHelp*,CCoeEnv::Static(KEikBubbleHelpUid));} + +#endif