3.1.11 InfoPopup Type

An instance of InfoPopup type encapsulates an UI tip widget. This widget can be placed on top of other widgets to provide e.g. usage information to the user. The widget disappears as soon as the device's user presses any key or when the timer behind the InfoPopup is triggered.

class InfoPopup( ): Creates an InfoPopup.

show( text, [(x_coord, y_coord), time_shown, time_before, alignment])

Show text (Unicode) in the InfoPopup. The optional parameters are the location (a tuple from the upper left corner), the time the popup is visible, time_shown (in milliseconds), the time before the popup, time_before (in milliseconds) and the alignment of the popup.

The default values are: the coordinates (0, 0), time_shown 5 seconds, time_before 0 seconds and for the alignment appuifw.EHLeftVTop.

The alignment can be one of the constants defined in module appuifw^3.2:

EHLeftVTop: Object is left and top aligned.

EHLeftVCenter: Object is left aligned and centred vertically.

EHLeftVBottom: Object is left aligned and at the bottom.

EHCenterVTop: Object is centre aligned horizontally and at the top.

EHCenterVCenter: Object is centred horizontally and vertically.

EHCenterVBottom: Object is centred horizontally and at the bottom.

EHRightVTop: Object is right and top aligned.

EHRightVCenter: Object is right aligned and centred vertically.

EHRightVBottom: Object is right aligned and at the bottom.

hide( ): Hides the popup immediately.

Example:

>>> import appuifw
>>> i=appuifw.InfoPopup()
>>> i.show(u"Here is the tip.", (0, 0), 5000, 0, appuifw.EHRightVCenter)
>>>

Footnotes

...appuifw ^3.2: Descriptions of the values are from the S60 SDK documentation [4].

See About this document... for information on suggesting changes.