Class EikBubbleHelp

class EikBubbleHelp;

Description

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.

Members

Defined in EikBubbleHelp:

• Cancel()Cancels any outstanding help message whether being displayed or waiting to be di...
• CancelTrigger()Cancels any outstanding help message that is waiting to be displayed.
• IsDisplaying(TInt)Tests if bubble help is currently being displayed.
• Trigger(const TDesC &,const TRect &,TInt)Starts bubble help displaying the help message text descriptor after a fixed tim...

IMPORT_C static void Trigger(const TDesC &aDes, const TRect &aRect, TInt aHandle=-1);

Description

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.

Parameters

const TDesC16 &aDes The help message text descriptor. const TRect &aRect The rectangle used to anchor the bubble help. TInt aHandle The handle used to identify this trigger request.

IMPORT_C static void Cancel();

Description

Cancels any outstanding help message whether being displayed or waiting to be displayed.

IMPORT_C static void CancelTrigger();

Description

Cancels any outstanding help message that is waiting to be displayed.

IMPORT_C static TBool IsDisplaying(TInt aHandle);

Description

Tests if bubble help is currently being displayed.

Parameters

TInt aHandle ETrue if bubble help is currently being displayed due to the trigger request identified by the handle aHandle. An optional handle aHandle can be supplied to identify the trigger request.

Return value

TBool