/* roadmap_trip.h - Manage a trip: destination & waypoints.
 *
 * LICENSE:
 *
 *   Copyright 2002 Pascal F. Martin
 *
 *   This file is part of RoadMap.
 *
 *   RoadMap is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU General Public License as published by
 *   the Free Software Foundation; either version 2 of the License, or
 *   (at your option) any later version.
 *
 *   RoadMap is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU General Public License for more details.
 *
 *   You should have received a copy of the GNU General Public License
 *   along with RoadMap; if not, write to the Free Software
 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef INCLUDE__ROADMAP_TRIP__H
#define INCLUDE__ROADMAP_TRIP__H

#include "roadmap_types.h"
#include "roadmap_gps.h"


void  roadmap_trip_set_point (const char *name, RoadMapPosition *position);
void  roadmap_trip_add_waypoint
    (const char *name, RoadMapPosition *position, int where);
void  roadmap_trip_create_selection_waypoint(void);
void  roadmap_trip_create_gps_waypoint(void);

void  roadmap_trip_set_gps
    (int gps_time, const RoadMapGpsPosition *gps_position);

void  roadmap_trip_copy_focus (const char *name);

void  roadmap_trip_route_waypoint_manage_dialog(void);
void  roadmap_trip_trip_waypoint_manage_dialog(void);
void  roadmap_trip_personal_waypoint_manage_dialog(void);


void  roadmap_trip_restore_focus (void);
void  roadmap_trip_set_focus (const char *name);

int   roadmap_trip_is_focus_changed  (void);
int   roadmap_trip_is_focus_moved    (void);
int   roadmap_trip_is_refresh_needed (void);

int   roadmap_trip_get_orientation (void);
const char *roadmap_trip_get_focus_name (void);

const RoadMapPosition *roadmap_trip_get_focus_position (void);

void  roadmap_trip_route_start   (void);
void  roadmap_trip_route_resume  (void);
void  roadmap_trip_route_stop    (void);
void  roadmap_trip_route_reverse (void);
void  roadmap_trip_route_return  (void);
void  roadmap_trip_new_route     (void);
void  roadmap_trip_set_as_destination (void);


void  roadmap_trip_format_messages (void);
void  roadmap_trip_display (void);

void  roadmap_trip_new (void);

void  roadmap_trip_initialize (void);

/* In the two primitives that follow, the name is either NULL (i.e.
 * open a dialog to let the user enter one), or an explicit name.
 */
int   roadmap_trip_load (int silent, int merge);
int   roadmap_trip_load_ask (int merge);
int  roadmap_trip_save (int force);
void  roadmap_trip_save_as (int force);

void roadmap_trip_save_screenshot (void);

void roadmap_trip_route_manage_dialog (void);

void roadmap_trip_track_to_route (void);
void roadmap_trip_route_simplify (void);
void roadmap_trip_currenttrack_to_route (void);
void roadmap_trip_currenttrack_to_track (void);

#endif // INCLUDE__ROADMAP_TRIP__H