EikBubbleHelp Class Reference

#include <mw/eikbhelp.h>

Link against: eikcore.lib

class EikBubbleHelp

Public Member Functions
IMPORT_C void	Cancel()
IMPORT_C void	CancelTrigger()
IMPORT_C TBool	IsDisplaying(TInt)
IMPORT_C void	Trigger(const TDesC &, const TRect &, TInt)

Detailed 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.

Member Function Documentation

Cancel ( )

IMPORT_C void

Cancel

(

)

[static]

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

CancelTrigger ( )

IMPORT_C void

CancelTrigger

(

)

[static]

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

IsDisplaying ( TInt )

IMPORT_C TBool

IsDisplaying

(

TInt

aHandle

)

[static]

Tests if bubble help is currently being displayed.

Parameters
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.

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

IMPORT_C void	Trigger	(	const TDesC &	aDes,
			const TRect &	aRect,
			TInt	aHandle = -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
aDes	The help message text descriptor.
aRect	The rectangle used to anchor the bubble help.
aHandle	The handle used to identify this trigger request.