plugin_comm.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2024 Alec Leamas                                        *
 *                                                                         *
 *   This program 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.                                   *
 *                                                                         *
 *   This program 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 this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,  USA.         *
 **************************************************************************/
 
#ifndef PLUGIN__COMM_H
#define PLUGIN__COMM_H
 
#include <wx/event.h>
#include <wx/jsonval.h>
#include <wx/string.h>
 
#include "model/ocpn_types.h"
 
void SendMessageToAllPlugins(const wxString& message_id,
                             const wxString& message_body);
 
void SendJSONMessageToAllPlugins(const wxString& message_id, wxJSONValue v);
 
void SendAISSentenceToAllPlugIns(const wxString& sentence);
 
void SendPositionFixToAllPlugIns(GenericPosDatEx* ppos);
 
void SendActiveLegInfoToAllPlugIns(const ActiveLegDat* leg_info);
 
bool SendMouseEventToPlugins(wxMouseEvent& event);
 
bool SendKeyEventToPlugins(wxKeyEvent& event);
 
void SendPreShutdownHookToPlugins();
 
void SendCursorLatLonToAllPlugIns(double lat, double lon);
 
void SendNMEASentenceToAllPlugIns(const wxString& sentence);
 
int GetJSONMessageTargetCount();
 
void SendVectorChartObjectInfo(const wxString& chart, const wxString& feature,
                               const wxString& objname, double& lat,
                               double& lon, double& scale, int& nativescale);
 
#endif  //  PLUGIN__COMM_H