OpenRoadCode
Public API reference for OpenRoadCode
Loading...
Searching...
No Matches
poi.poi_search_controller_if.PoiSearchControllerIf Class Reference

Coordinate POI search and selection independently of any frontend. More...

Inherits ABC.

Public Member Functions

None search (self, PoiCategory category, TransitMode transit_mode=TransitMode.ALL)
 Request discovery of nearby places, optionally filtering public transit.
 
PointOfInterest|None poll_selected (self)
 Return the latest selected POI, if one is available.
 
bool poll_camera_interaction (self)
 Consume a manual map gesture when supported by the source.
 
PoiSearchResult|None poll_search_result (self)
 Return the latest completed POI search result, if available.
 
None clear (self)
 Clear active POI search presentation.
 
None close (self)
 Release resources owned by the controller.
 

Detailed Description

Coordinate POI search and selection independently of any frontend.

Member Function Documentation

◆ poll_camera_interaction()

bool poi.poi_search_controller_if.PoiSearchControllerIf.poll_camera_interaction (   self)

Consume a manual map gesture when supported by the source.

Returns
True when a native camera gesture occurred.

◆ poll_search_result()

PoiSearchResult | None poi.poi_search_controller_if.PoiSearchControllerIf.poll_search_result (   self)

Return the latest completed POI search result, if available.

Returns
Latest completed search result, or None when none is pending.

◆ poll_selected()

PointOfInterest | None poi.poi_search_controller_if.PoiSearchControllerIf.poll_selected (   self)

Return the latest selected POI, if one is available.

Returns
Latest selected POI, or None when no selection is pending.

◆ search()

None poi.poi_search_controller_if.PoiSearchControllerIf.search (   self,
PoiCategory  category,
TransitMode   transit_mode = TransitMode.ALL 
)

Request discovery of nearby places, optionally filtering public transit.

Parameters
categoryPOI category to discover.
transit_modeTransit subtype filter for transit searches.

The documentation for this class was generated from the following file: