1.1 --- a/epoc32/include/eikbhelp.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/eikbhelp.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,92 @@
1.4 -eikbhelp.h
1.5 +// Copyright (c) 2000-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +// All rights reserved.
1.7 +// This component and the accompanying materials are made available
1.8 +// 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
1.9 +// which accompanies this distribution, and is available
1.10 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.11 +//
1.12 +// Initial Contributors:
1.13 +// Nokia Corporation - initial contribution.
1.14 +//
1.15 +// Contributors:
1.16 +//
1.17 +// Description:
1.18 +//
1.19 +
1.20 +#ifndef __EIKBHELP_H__
1.21 +#define __EIKBHELP_H__
1.22 +
1.23 +#include <coemain.h>
1.24 +
1.25 +const TUid KEikBubbleHelpUid={0x10008E48};
1.26 +
1.27 +class CCoeControl;
1.28 +
1.29 +/**
1.30 +@publishedPartner
1.31 +@deprecated
1.32 +*/
1.33 +class MEikTriggeredHelp
1.34 + {
1.35 +// The MEikTriggeredHelp class defines an interface for UI classes
1.36 +// to implement triggered, transient help message display.
1.37 +public:
1.38 + virtual void TriggerHelp(const TDesC& aDes,const TRect& aRect,TInt aHandle)=0;
1.39 + virtual void CancelHelp()=0;
1.40 + virtual void CancelHelpTrigger()=0;
1.41 + virtual TBool IsDisplayingHelp(TInt aHandle)=0;
1.42 + virtual void Release()=0;
1.43 +protected:
1.44 + IMPORT_C virtual void MEikTriggeredHelp_Reserved_1();
1.45 + IMPORT_C virtual void MEikTriggeredHelp_Reserved_2();
1.46 + };
1.47 +
1.48 +
1.49 +/** Provides the static functions that control bubble help.
1.50 +
1.51 +Bubble help is a feature that enables short help messages to be displayed
1.52 +for controls in transient windows which pop up close to the control bodies.
1.53 +
1.54 +@publishedAll
1.55 +@released */
1.56 +class EikBubbleHelp
1.57 + {
1.58 +public:
1.59 + IMPORT_C static void Trigger(const TDesC& aDes,const TRect& aRect,TInt aHandle=-1);
1.60 + IMPORT_C static void Cancel();
1.61 + IMPORT_C static void CancelTrigger();
1.62 + IMPORT_C static TBool IsDisplaying(TInt aHandle);
1.63 + };
1.64 +
1.65 +
1.66 +/**
1.67 +@publishedPartner
1.68 +@deprecated
1.69 +*/
1.70 +class CEikBubbleHelp : public CCoeStatic
1.71 +// The CEikBubbleHelp class implements global static storage and access to the object providing bubble help
1.72 +// for the application.
1.73 + {
1.74 + ~CEikBubbleHelp();
1.75 +public:
1.76 + IMPORT_C static void SetTriggeredHelpL(MEikTriggeredHelp* aTriggeredHelp);
1.77 +public:
1.78 + static void Trigger(const TDesC& aDes,const TRect& aRect,TInt aHandle=-1);
1.79 + static void Cancel();
1.80 + static void CancelTrigger();
1.81 + static TBool IsDisplaying(TInt aHandle);
1.82 +private:
1.83 + inline CEikBubbleHelp();
1.84 + inline static CEikBubbleHelp* Self();
1.85 +private:
1.86 + MEikTriggeredHelp* iHelp;
1.87 + };
1.88 +
1.89 +inline CEikBubbleHelp::CEikBubbleHelp()
1.90 + : CCoeStatic(KEikBubbleHelpUid)
1.91 + {}
1.92 +
1.93 +inline CEikBubbleHelp* CEikBubbleHelp::Self()
1.94 + {return STATIC_CAST(CEikBubbleHelp*,CCoeEnv::Static(KEikBubbleHelpUid));}
1.95 +
1.96 +#endif