Dbus

From Navit's Wiki
Revision as of 14:15, 18 March 2009 by Singesang (talk | contribs)
Jump to: navigation, search

This Document displays the requirements and implementation details of the navit dbus interface.

Navit Dbus details:

DBUS Service: "org.navit_project.navit"
DBUS Object Path: "/org/navit_project/navit"
DBUS Interface: "org.navit_project.navit.navit"
DBUS Bus: Session bus

Navit Dbus Methods:

Set destination

Sets the destination. coord is a string containing the coordinates in a special format. pro contains the map projection while x and y define the position. descr is a description for the target

coord can be formatted like this:

[Proj:]-0xX [-]0xX
 - where Proj can be mg/garmin, defaults to mg
[Proj:][D][D]Dmm.ss[S][S] N/S [D][D]DMM.ss[S][S]... E/W
[Proj:][-][D]D.d[d]... [-][D][D]D.d[d]
 - where Proj can be geo

Name: set_destination
Args: string coord, string descr
Args: (int pro, string coord), string descr
Args: (int pro, int x, int y), string descr
Returns: (none)

Zoom

Zooms into the map if f is positive, otherwise it zooms out. f is the zoom factor and has to be bigger than 1 or smaller than -1. Values between 1 and -1 have no effect. In addition, x and y can be set to zoom into a special point on the screen.

Name: zoom
Args: int f[, (int x, int y)]
Returns: (none)

Set position

Sets the current position. See Set destination.

Name: set_destination
Args: string coord
Args: (int pro, string coord)
Args: (int pro, int x, int y)
Returns: (none)

Center map (coordinates)

Centers the view to a absolute position on the map. Useful when looking up for some coordinates (e.g. for bookmarks). See Set destination.

Name: set_center
Args: string coord
Args: (int pro, string coord)
Args: (int pro, int x, int y)
Returns: (none)

Center map (pixel)

Centers the map to a specific position on the screen. x and y contain the pixel coordinates on the current map section starting from the upper left.

Name: set_center
Args: (int x, int y)
Returns: (none)

Set layout

Sets the map layout

Name: set_layout
Args: string layout_name
Returns: (none)

Add message

Adds a message to the messages label.

Name: add_message
Args: string message
Returns: (none)

Redraw

Forces a redraw of the current map section

Name: draw
Args: (none)
Return: (none)