Text Viewer: _getRegisteredHotspots

Text Viewer: _getRegisteredHotspots

Returns a list of all of the currently registered hotspots

Syntax
Details
Example

Syntax

CALL NOTIFY (viewer-name, '_getRegisteredHotspots', hotspot-list);

Argument Type Description

hotspot-list
N returns the identifier of an SCL list containing a sublist of all registered hotspots

Argument	Type	Description
hotspot-list	N	returns the identifier of an SCL list containing a sublist of all registered hotspots

Details

Hotspots are defined via the _registerHotspots method. The hotspot list contains a named sublist for each registered hotspot. The name of the sublist is the name of the hotspot. Each sublist contains row and column boundaries of the hotspot area listed in this order:

starting row number
starting column number
ending row number
ending column number.

Example

This example creates two hotspots and returns their positions:

   /* register two hotspots */
call notify ('textview', '_register_hotspots_',
             'one', 1, 1, 3, 3,
            'two', 6, 6, 9, 9);

   /* retrieve the position of the registered
      hotspots */
hotspots = makelist();
call notify ('textview',
             '_get_registered_hotspots_',
               hotspots );

   /* display the list of registered
      hotspots */
call putlist(hotspots);

_getRegisteredHotspots returns the list:

HOTSPOTS=( one = (1, 1, 3, 3)

two = (6, 6, 9, 9))

Chapter Contents
Previous
Next
Top of Page