EikBubbleHelp Class Reference

class EikBubbleHelp

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.

Public Member Functions
IMPORT_C voidCancel()
IMPORT_C voidCancelTrigger()
IMPORT_C TBoolIsDisplaying(TInt)
IMPORT_C voidTrigger(const TDesC &, const TRect &, TInt)

Member Functions Documentation

Cancel()

IMPORT_C voidCancel()[static]

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

CancelTrigger()

IMPORT_C voidCancelTrigger()[static]

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

IsDisplaying(TInt)

IMPORT_C TBoolIsDisplaying(TIntaHandle)[static]

Tests if bubble help is currently being displayed.

Parameters

TInt aHandleETrue 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.

Trigger(const TDesC &, const TRect &, TInt)

IMPORT_C voidTrigger(const TDesC &aDes,
const TRect &aRect,
TIntaHandle = -1
)[static]

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 TDesC & aDesThe help message text descriptor.
const TRect & aRectThe rectangle used to anchor the bubble help.
TInt aHandle = -1The handle used to identify this trigger request.