ui.navigation.route_request_handler_if.RouteRequestHandlerIf Class Reference

Handle route planning and guidance requests. More...

Inheritance diagram for ui.navigation.route_request_handler_if.RouteRequestHandlerIf:

Public Member Functions
None	request_start_route (self, GeoPoint destination, Sequence[GeoPoint] waypoints, TravelMode travel_mode)
	Request route calculation and guidance.
None	request_cancel_route (self)
	Request cancellation of active route guidance.
None	request_add_waypoint (self, GeoPoint waypoint)
	Request addition of an intermediate route location.
None	request_remove_waypoint (self, int waypoint_index)
	Request removal of a waypoint by its displayed index.
None	request_select_alternative (self, int alternative_index)
	Request selection of an alternative route.
None	request_recalculate_route (self)
	Request immediate route recalculation from current position.
None	request_travel_mode (self, TravelMode travel_mode)
	Request a new route costing mode.
None	request_voice_guidance_muted (self, bool muted)
	Request spoken route guidance mute state.

Detailed Description

Handle route planning and guidance requests.

Member Function Documentation

request_add_waypoint()

None ui.navigation.route_request_handler_if.RouteRequestHandlerIf.request_add_waypoint	(		self,
		GeoPoint	waypoint
	)

Request addition of an intermediate route location.

Parameters

waypoint

Geographic waypoint to add.

Reimplemented in navigation.navigation_route_request_handler.NavigationRouteRequestHandler, and ui.navigation.route_request_handler_stub.RouteRequestHandlerStub.

request_remove_waypoint()

None ui.navigation.route_request_handler_if.RouteRequestHandlerIf.request_remove_waypoint	(		self,
		int	waypoint_index
	)

Request removal of a waypoint by its displayed index.

Parameters

waypoint_index

Zero-based waypoint index.

Reimplemented in navigation.navigation_route_request_handler.NavigationRouteRequestHandler, and ui.navigation.route_request_handler_stub.RouteRequestHandlerStub.

request_select_alternative()

None ui.navigation.route_request_handler_if.RouteRequestHandlerIf.request_select_alternative	(		self,
		int	alternative_index
	)

Request selection of an alternative route.

Parameters

alternative_index

Zero-based alternative-route index.

Reimplemented in navigation.navigation_route_request_handler.NavigationRouteRequestHandler, and ui.navigation.route_request_handler_stub.RouteRequestHandlerStub.

request_start_route()

None ui.navigation.route_request_handler_if.RouteRequestHandlerIf.request_start_route	(		self,
		GeoPoint	destination,
		Sequence[GeoPoint]	waypoints,
		TravelMode	travel_mode
	)

Request route calculation and guidance.

Parameters

destination	Requested final destination.
waypoints	Ordered intermediate route locations.
travel_mode	Requested route costing mode.

Reimplemented in navigation.navigation_route_request_handler.NavigationRouteRequestHandler, and ui.navigation.route_request_handler_stub.RouteRequestHandlerStub.

request_travel_mode()

None ui.navigation.route_request_handler_if.RouteRequestHandlerIf.request_travel_mode	(		self,
		TravelMode	travel_mode
	)

Request a new route costing mode.

Parameters

travel_mode

Requested travel mode.

Reimplemented in navigation.navigation_route_request_handler.NavigationRouteRequestHandler, and ui.navigation.route_request_handler_stub.RouteRequestHandlerStub.

request_voice_guidance_muted()

None ui.navigation.route_request_handler_if.RouteRequestHandlerIf.request_voice_guidance_muted	(		self,
		bool	muted
	)

Request spoken route guidance mute state.

Parameters

muted

True to mute spoken route guidance.

Reimplemented in navigation.navigation_route_request_handler.NavigationRouteRequestHandler, and ui.navigation.route_request_handler_stub.RouteRequestHandlerStub.

---

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

• ui/navigation/route_request_handler_if.py