Location:
eikbhelp.h
Link against: eikcore.lib
EikBubbleHelp
Supported from 6.1
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.
Defined in EikBubbleHelp
:
Cancel()
, CancelTrigger()
, IsDisplaying()
, Trigger()
static void Trigger(const TDesC& aDes,const TRect& aRect,TInt aHandle=-1);
Starts bubble help displaying the help message text descriptor after a fixed time delay.
The bubble help is not displayed if it is cancelled during the waiting period.
Replaces any outstanding request to show a help message. The screen rectangle aRect
is used to anchor the bubble help.
An optional handle aHandle
can be supplied to identify the trigger request. This allows a client to later enquire if the bubble help is being displayed due to this request.
|
static void Cancel();
Cancels any outstanding help message whether being displayed or waiting to be displayed.
static void CancelTrigger();
Cancels any outstanding help message that is waiting to be displayed.
static TBool IsDisplaying(TInt aHandle);
Tests if bubble help is currently being displayed.
|