Difference between revisions of "Internal GUI"

From Navit's Wiki
Jump to: navigation, search
(Menu Configuration)
(Moved custom menu to new page)
Line 263: Line 263:
==Alternative Menu Configurations==
All contents of this menu can be easily changed via navit.xml to suit personal preferences:
- Order
- Commands and their parameters
- Icons and names
- Subfolders
===WVGA version 1===
Features of this menu:
- some default settings on startup: full screen and menu colors
- [added spaces for better readability]
- Main menu:        Actions, Settings, Route (if a route is active), and Quit
- Actions submenu:  Bookmarks, Town selection, Map and GPS position
- Settings submenu:  Fullscreen yes/no, Card Selection, 3D/2D, About
- Route submenu:    Vehicle Selection, Route Description, Route Height Profile, Route Removal
        <gui type="internal" enabled="yes" menubar="1" toolbar="1" statusbar="1"
            fullscreen="1" text_color="#10184aFF"  background_color="#b0c0ffFF">
            <a name='Main Menu'><text>Main menu</text>
                <a href='#Actions'>  <img src='gui_actions'>                    <text>Actions</text></img></a>
                <a href='#Settings'>  <img src='gui_rules'>                      <text>Settings</text></img></a>
                                      <img src='gui_quit'    onclick='quit()'>  <text>Quit</text></img>
                <a cond='navit.route.route_status&amp;52' href='#Route'>
                                      <img src='gui_vehicle'>                    <text>Route</text></img></a>
            <a name='Actions'><text>Actions</text>
                <img src='gui_bookmark'                          onclick='bookmarks()'> <text>Bookmarks</text></img>
                <img src='gui_town'                              onclick='town()'>      <text>Town</text></img>
                <img cond='click_coord_geo'    src='gui_map'    onclick='position(click_coord_geo,_("Map Point"),8|32|48|128)'>            <script>write(click_coord_geo)</script> </img>
                <img cond='position_coord_geo' src='gui_vehicle' onclick='position(position_coord_geo,_("Vehicle Position"),8|32|48|128)'>  <script>write(position_coord_geo)</script> </img>
            <a name='Settings'><text>Settings</text>
                <img cond='fullscreen==0'  src='gui_fullscreen'      onclick='fullscreen=1'>      <text>Fullscreen</text></img>
                <img cond='fullscreen==1'  src='gui_leave_fullscreen' onclick='fullscreen=0'>      <text>Window Mode</text></img>
                <img                      src='gui_maps'            onclick='setting_maps()'>    <text>Maps</text></img>
                <img cond='navit.pitch==0' src='gui_map'              onclick='navit.pitch=24;  redraw_map();back_to_map()'> <text>3D</text> </img>
                <img cond='navit.pitch!=0' src='gui_map'              onclick='navit.pitch=0;  redraw_map();back_to_map()'> <text>2D</text> </img>
                <img                      src='gui_about'            onclick='about()'>          <text>About</text></img>
            <a name='Route'><text>Route</text>
                <img src='gui_vehicle_pedestrian'  onclick='setting_vehicle();back()'>          <text>Vehicle</text></img>
                <img src='gui_town'    onclick='route_description()'>                          <text>Description</text></img>
                <img src='gui_zoom_in'  onclick='route_height_profile()'>                        <text>Height Profile</text></img>
                <img src='gui_stop'    onclick='abort_navigation();redraw_map();back_to_map()'> <text>Stop Navigation</text></img>

Revision as of 18:35, 8 January 2011

The Internal GUI is designed to be used on touch screen devices, but also work very well on other devices such as netbooks and laptops. It is under continual development and as such features are constantly being added and improved upon. If you think that a particular feature is missing or poorly implemented, come talk to us in the irc channel or open up a feature request on the trac system.

Configuring Internal GUI

Enabling Internal GUI

The Internal GUI is configured as the default GUI for Navit, so if you're reading this after a first install no further configuration is required.

If the configuration has changed since first install, the Internal GUI can be chosen by setting the type attribute in the <gui> tag.

<gui type="internal" enabled="yes">

Ensure that any other gui tags are disabled by setting their enabled attribute to "no".

Keyboard Preferences

Some options inside the Internal GUI menu require keyboard input - for example, Town search. By default, Navit provides a custom on-screen keyboard to enter text. If your device has it's own keyboard which you'd prefer to use, and you'd like to conserve some screen space then set the keyboard attribute to "false" inside the <gui> tag.

<gui type="internal" enabled="yes" keyboard="false">

Menu Configuration

Using Internal GUI, the menu can be brought up by clicking (almost) anywhere on the map, or pressing the Enter (Return) key on the device's keyboard.

The menu is configured using a html-like syntax inside the <gui> ... </gui> tags. Of course, this configuration can be customised - alternative configurations can be found in Internal GUI/Menu configurations.

Initial Start-up


When Navit is first started using the Internal GUI one should see (depending on the skin you have selected to use) something similar to the image to the right. The layout of the internal GUI is controlled by the OSD tags located in the navit.xml file. These tags should be located within the first 100 lines of the file. For information on how to modify the appearance of the OSD layout please reference this link. OSD Layout

Main Menu


The main menu is accessed by a single click (or tap for touch screen) anywhere on the map. From here all other sub-menus and actions are accessible. The sub menu items are:

  1. Actions
  2. Settings
  3. Tools
  4. Route



The Actions Menu brings up several sub menus that is focused primarily on routing and location finding. The sub menu items are:

  2. Map Point
  3. Current Location
  4. Town
  5. Quit



Bookmarks provide a convenient way to store often used destinations. At this time since Navit does not fully support entering a complete address using Open Street Maps a user can locate some often used destinations on the map and then adding that point as a bookmark. That way the next time the user would like a route for that particular destination the user only has to select it from the Bookmarks menu and does not have to go through the tedium of panning the map and zooming into the destination location.

Bookmarks can be arranged hierarchical using / as a separator of dir and bookmark name while adding new bookmark. For example, if you name your bookmark Friends/Joe and Friends/Bill, you will have a Folder Friends and Bill and Joe in there. At this time an editor for the bookmarks is unfortunately missing but will one day hopefully be integrated.

Map Point


The world icon brings up the Map Point sub menu for actions that can be performed for the point that was selected on the map. The items contained in this sub menuare:

  • Street Numbers: Item not functioning yet
  • Set as Destination: Will generate a route to that location based off of either current GPS data or where vehicle position is manually set (see Vehicle Position).
  • Set as Position: If no GPS data is available then you can specify your "current" location in order to have a route generated from that position to your desired destination.
  • Add as Bookmark: Brings up a keyboard so a name can be entered for the bookmark. The point can then be easily pulled up in the book mark for usage.
  • POIs: Brings up a list of all known POIs close to that point on the map.


The POIs sub menu shows all of the POIs that are close to the location that was clicked on the map. At the top of the menu there are various filter options that allow for specifying the types of POIs to be displayed. The user can then click on the POI and select to be routed to that location. Navit will then create a route based off of the current position and the location of the POI selected.

Vehicle Position


The vehicle icon brings up the Current Location sub menu. This sub menu allows for various actions to be taken for the GPS position of the device.

  • Street Numbers: Item not functioning yet
  • Set as Destination: Will generate a route to that location based off of either current GPS data or where vehicle position is manually set (see Vehicle Position).
  • Set as Position: If no GPS data is available then you can specify your "current" location in order to have a route generated from that position to your desired destination.
  • Add as Bookmark: Brings up a keyboard so a name can be entered for the bookmark. The point can then be easily pulled up in the book mark for usage.
  • POIs: Brings up a list of all known POIs close to that point on the map.
  • View on Map: Refocuses the map to display the current "known" position based off of GPS data.



The town icon allows for searching for different cities within your map set. Note that Navit attempts to auto complete the town name based off of names available in the mapset being used. On slow devices this can result in a slight pause as each character is typed in. Once a town is located and selected another sub menu will come up allowing for a street to be found within that town.

The icon in the upper left corner (just below the world icon) shows the current country that you would like to search in. To change the country just click on the icon and another menu will come up allowing you to type in the country you would like to search in. Note that this menu also attempts to auto complete as the user types in the name of a country.

Note that if you compiled Navit yourself there can be issues with the icons not being properly generated. This will result in no icon image at all. If you have this problem check your logs to see what is happening during compiling.


Closes Navit.



The settings menu provides several sub menus to allow for certain aspects of how Navit operates to be modified. Note that at this time there is only a limited set of options that can be changed through these sub menus. In order to change settings not currently available in this sub-menu it is necessary to modify the navit.xml file. At some point in the future a more robust settings menu will be implemented that will allow for configuring Navit through a GUI instead of the navit.xml file.

The sub menu items are:

  1. Display
  2. Maps
  3. Vehicle
  4. Rules



The display sub menu provides items to control various display items of Navit.

  1. Layout
  2. Window Mode
  3. 3D


Layout allows for different layout options specified in the navit.xml file to be shown on the map. Different layouts can be used for different reasons including allowing one to see other friends position (if their GPS data specified in the layout tag). Note that layout options MUST be enabled in the navit.xml file before they can be turned on or off in this menu. The three items in the screen shot below are layout options listed in the navit.xml file but are currently disabled in the navit.xml file.

Window Mode (Toggle)

Changes Navit from Windowed Mode to Full Screen and vice versa. Note that this can also be accomplished from the map itself using the "window" icon.

3D (Toggle)

This is a toggle button that enables / disables drawing the map in either a 2D mode or a 3D mode. Currently the only way to modify the "tilt" for the 3D mode is to modify the navit.xml file.



Displays the maps that are specified in the navit.xml file and allows for enabling/disabling those maps.



Brings up a menu showing what GPS device is currently being used for the current vehicle. Tapping the GPS device name opens a menu with available routing profiles.



The rules menu provides for options that change how Navit behaves when there is a satellite lock. Note that some of these items are currently not function and must be changed in the navit.xml file.


Currently a non functional menu item.



The route icon brings up the route menu that will display the active route.

  1. Route Description
  2. Height Profile

Route Description


The route description sub menu displays all of the directions for the currently calculated route.

Height Profile