| The Information Overlaid Toolkit: ; Referance Manual Edition 2.2, for Information Overlaid Version 2.3; 25th October 2002 |  | ||
|---|---|---|---|
| Prev | Next | ||
| The Information Overlaid Toolkit: ; Referance Manual Edition 2.2, for Information Overlaid Version 2.3; 25th October 2002 | | ||
|---|---|---|---|
| Prev | Next | ||
The search library provides functions useful for building search interfaces where selection of an area from an image (for instance a map) is combine with information entered on a form to select results which are displayed on the image.
A scale factor by which coordinates which come from the database should be multiplied to give coordianes suitable for ploting on the image. Useful, for instance, if a set of maps uses 6 figure grid coordiantes but the database only holds 4 figure coordinates.
The class used fro marers created for search results. By default result.
You should call this when your search form is in place. It records the URL so that the system can step back to that form at any time.
Show the form if it has been replacd by another page.
This is the main search call which you would use on a button or link.
Call at the start of your result list.
This should be called to put a resrult onto the image. The arguments are as for markers_add except that the class is allways search_marker_class and the coordinates will be scaled according to the search_map_data_scale.
Highlights the result named name.
You can define the following callback functions to customise how the search system works:
Called when a result is highlighted.
Called just before a search so you can take note of which image is being shown to the user.
Called just before a search so you can take note of whether a rectangle is selected. Rect is not null only if the user has selected a region.
You must define this function, which should return the window where the search form is loaded.