dashboard_pi Class Reference

Inheritance diagram for dashboard_pi:

Public Member Functions
	dashboard_pi (void *ppimgr)
int	Init (void)
bool	DeInit (void)
void	Notify ()
int	GetAPIVersionMajor ()
int	GetAPIVersionMinor ()
int	GetPlugInVersionMajor ()
int	GetPlugInVersionMinor ()
wxBitmap *	GetPlugInBitmap ()
	FIXME static wxBitmap* LoadSVG(const wxString filename, unsigned int width, unsigned int height) { if (!gFrame) return new wxBitmap(width, height); // We are headless.
wxString	GetCommonName ()
wxString	GetShortDescription ()
wxString	GetLongDescription ()
void	SetNMEASentence (wxString &sentence)
	Receive all NMEA 0183 sentences from OpenCPN.
void	SetPositionFixEx (PlugIn_Position_Fix_Ex &pfix)
void	SetCursorLatLon (double lat, double lon)
int	GetToolbarToolCount (void)
void	OnToolbarToolCallback (int id)
void	ShowPreferencesDialog (wxWindow *parent)
void	SetColorScheme (PI_ColorScheme cs)
void	OnPaneClose (wxAuiManagerEvent &event)
void	UpdateAuiStatus (void)
bool	SaveConfig (void)
void	PopulateContextMenu (wxMenu *menu)
void	ShowDashboard (size_t id, bool visible)
int	GetToolbarItemId ()
int	GetDashboardWindowShownCount ()
void	SetPluginMessage (wxString &message_id, wxString &message_body)

Detailed Description

Definition at line 209 of file dashboard_pi.h.

Constructor & Destructor Documentation

dashboard_pi()

dashboard_pi::dashboard_pi

(

void *

ppimgr

)

Definition at line 488 of file dashboard_pi.cpp.

~dashboard_pi()

dashboard_pi::~dashboard_pi

(

void

)

Definition at line 495 of file dashboard_pi.cpp.

Member Function Documentation

DeInit()

bool dashboard_pi::DeInit ( void  )

virtual

Reimplemented from opencpn_plugin.

Definition at line 698 of file dashboard_pi.cpp.

GetAPIVersionMajor()

int dashboard_pi::GetAPIVersionMajor ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 940 of file dashboard_pi.cpp.

GetAPIVersionMinor()

int dashboard_pi::GetAPIVersionMinor ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 942 of file dashboard_pi.cpp.

GetCommonName()

wxString dashboard_pi::GetCommonName ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 950 of file dashboard_pi.cpp.

GetDashboardWindowShownCount()

int dashboard_pi::GetDashboardWindowShownCount

(

)

Definition at line 3325 of file dashboard_pi.cpp.

GetLongDescription()

wxString dashboard_pi::GetLongDescription ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 956 of file dashboard_pi.cpp.

GetPlugInBitmap()

wxBitmap * dashboard_pi::GetPlugInBitmap ( )

virtual

FIXME static wxBitmap* LoadSVG(const wxString filename, unsigned int width, unsigned int height) { if (!gFrame) return new wxBitmap(width, height); // We are headless.

#ifdef ANDROID return loadAndroidSVG(filename, width, height); #elif defined(ocpnUSE_SVG) wxSVGDocument svgDoc; if (svgDoc.Load(filename)) return new wxBitmap(svgDoc.Render(width, height, NULL, true, true)); else return new wxBitmap(width, height); #else return new wxBitmap(width, height); #endif }

wxBitmap* opencpn_plugin::GetPlugInBitmap() { auto bitmap = PluginLoader::getInstance()->GetPluginDefaultIcon(); return const_cast<wxBitmap*>(bitmap); }

Reimplemented from opencpn_plugin.

Definition at line 948 of file dashboard_pi.cpp.

GetPlugInVersionMajor()

int dashboard_pi::GetPlugInVersionMajor ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 944 of file dashboard_pi.cpp.

GetPlugInVersionMinor()

int dashboard_pi::GetPlugInVersionMinor ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 946 of file dashboard_pi.cpp.

GetShortDescription()

wxString dashboard_pi::GetShortDescription ( )

virtual

Reimplemented from opencpn_plugin.

Definition at line 952 of file dashboard_pi.cpp.

GetToolbarItemId()

int dashboard_pi::GetToolbarItemId ( )

inline

Definition at line 242 of file dashboard_pi.h.

GetToolbarToolCount()

int dashboard_pi::GetToolbarToolCount ( void  )

virtual

Reimplemented from opencpn_plugin.

Definition at line 3243 of file dashboard_pi.cpp.

Init()

int dashboard_pi::Init ( void  )

virtual

Reimplemented from opencpn_plugin.

Definition at line 504 of file dashboard_pi.cpp.

Notify()

void dashboard_pi::Notify

(

)

Definition at line 740 of file dashboard_pi.cpp.

OnPaneClose()

void dashboard_pi::OnPaneClose

(

wxAuiManagerEvent &

event

)

Definition at line 3339 of file dashboard_pi.cpp.

OnToolbarToolCallback()

void dashboard_pi::OnToolbarToolCallback ( int  id )

virtual

Reimplemented from opencpn_plugin.

Definition at line 3361 of file dashboard_pi.cpp.

PopulateContextMenu()

void dashboard_pi::PopulateContextMenu

(

wxMenu *

menu

)

Definition at line 4068 of file dashboard_pi.cpp.

SaveConfig()

bool dashboard_pi::SaveConfig

(

void

)

Definition at line 3797 of file dashboard_pi.cpp.

SetColorScheme()

void dashboard_pi::SetColorScheme ( PI_ColorScheme  cs )

virtual

Reimplemented from opencpn_plugin.

Definition at line 3316 of file dashboard_pi.cpp.

SetCursorLatLon()

void dashboard_pi::SetCursorLatLon ( double  lat, double  lon  )

virtual

Reimplemented from opencpn_plugin.

Definition at line 3206 of file dashboard_pi.cpp.

SetNMEASentence()

void dashboard_pi::SetNMEASentence ( wxString &  sentence )

virtual

Receive all NMEA 0183 sentences from OpenCPN.

Plugins can implement this method to receive all NMEA 0183 sentences. They must set the WANTS_NMEA_SENTENCES capability flag to receive updates.

Parameters

sentence

The NMEA 0183 sentence

Note

For handling NMEA/SignalK messages, a newer recommended message API is available: Plugin Message API Documentation

Reimplemented from opencpn_plugin.

Definition at line 1000 of file dashboard_pi.cpp.

SetPluginMessage()

void dashboard_pi::SetPluginMessage ( wxString &  message_id, wxString &  message_body  )

virtual

Reimplemented from opencpn_plugin_18.

Definition at line 3211 of file dashboard_pi.cpp.

SetPositionFixEx()

void dashboard_pi::SetPositionFixEx ( PlugIn_Position_Fix_Ex &  pfix )

virtual

Reimplemented from opencpn_plugin_18.

Definition at line 3131 of file dashboard_pi.cpp.

ShowDashboard()

void dashboard_pi::ShowDashboard	(	size_t	id,
		bool	visible
	)

Definition at line 4083 of file dashboard_pi.cpp.

ShowPreferencesDialog()

void dashboard_pi::ShowPreferencesDialog ( wxWindow *  parent )

virtual

Reimplemented from opencpn_plugin.

Definition at line 3245 of file dashboard_pi.cpp.

UpdateAuiStatus()

void dashboard_pi::UpdateAuiStatus ( void  )

virtual

Reimplemented from opencpn_plugin.

Definition at line 3449 of file dashboard_pi.cpp.

---

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

• /home/runner/work/main/main/opencpn/plugins/dashboard_pi/src/dashboard_pi.h
• /home/runner/work/main/main/opencpn/plugins/dashboard_pi/src/dashboard_pi.cpp