PlugInManager Class Reference

Inheritance diagram for PlugInManager:

Public Member Functions
	PlugInManager (MyFrame *parent)
bool	RenderAllCanvasOverlayPlugIns (ocpnDC &dc, const ViewPort &vp, int canvasIndex, int priority)
bool	RenderAllGLCanvasOverlayPlugIns (wxGLContext *pcontext, const ViewPort &vp, int canvasIndex, int priority)
void	SendCursorLatLonToAllPlugIns (double lat, double lon)
void	SendViewPortToRequestingPlugIns (ViewPort &vp)
void	PrepareAllPluginContextMenus ()
void	NotifySetupOptions ()
void	ClosePlugInPanel (PlugInContainer *pic, int ix)
void	CloseAllPlugInPanels (int)
ArrayOfPlugInToolbarTools &	GetPluginToolbarToolArray ()
int	AddToolbarTool (wxString label, wxBitmap *bitmap, wxBitmap *bmpRollover, wxItemKind kind, wxString shortHelp, wxString longHelp, wxObject *clientData, int position, int tool_sel, opencpn_plugin *pplugin)
void	RemoveToolbarTool (int tool_id)
void	SetToolbarToolViz (int tool_id, bool viz)
void	SetToolbarItemState (int tool_id, bool toggle)
void	SetToolbarItemBitmaps (int item, wxBitmap *bitmap, wxBitmap *bmpDisabled)
int	AddToolbarTool (wxString label, wxString SVGfile, wxString SVGRolloverfile, wxString SVGToggledfile, wxItemKind kind, wxString shortHelp, wxString longHelp, wxObject *clientData, int position, int tool_sel, opencpn_plugin *pplugin)
void	SetToolbarItemBitmaps (int item, wxString SVGfile, wxString SVGfileRollover, wxString SVGfileToggled)
opencpn_plugin *	FindToolOwner (const int id)
wxString	GetToolOwnerCommonName (const int id)
void	ShowDeferredBlacklistMessages ()
ArrayOfPlugInMenuItems &	GetPluginContextMenuItemArray ()
int	AddCanvasContextMenuItem (wxMenuItem *pitem, opencpn_plugin *pplugin, const char *name="")
void	RemoveCanvasContextMenuItem (int item, const char *name="")
void	SetCanvasContextMenuItemViz (int item, bool viz, const char *name="")
void	SetCanvasContextMenuItemGrey (int item, bool grey, const char *name="")
void	SendNMEASentenceToAllPlugIns (const wxString &sentence)
void	SendPositionFixToAllPlugIns (GenericPosDatEx *ppos)
void	SendActiveLegInfoToAllPlugIns (const ActiveLegDat *infos)
void	SendAISSentenceToAllPlugIns (const wxString &sentence)
void	SendJSONMessageToAllPlugins (const wxString &message_id, wxJSONValue v)
void	SendMessageToAllPlugins (const wxString &message_id, const wxString &message_body)
bool	UpDateChartDataTypes ()
void	FinalizePluginLoadall ()
int	GetJSONMessageTargetCount ()
bool	UpdateConfig ()
void	SendResizeEventToAllPlugIns (int x, int y)
void	SetColorSchemeForAllPlugIns (ColorScheme cs)
void	NotifyAuiPlugIns (void)
bool	CallLateInit (void)
bool	IsAnyPlugInChartEnabled ()
void	SendVectorChartObjectInfo (const wxString &chart, const wxString &feature, const wxString &objname, double &lat, double &lon, double &scale, int &nativescale)
bool	SendMouseEventToPlugins (wxMouseEvent &event)
bool	SendKeyEventToPlugins (wxKeyEvent &event)
void	SendBaseConfigToAllPlugIns ()
void	SendS52ConfigToAllPlugIns (bool bReconfig=false)
void	SendSKConfigToAllPlugIns ()
void	UpdateManagedPlugins ()
bool	CheckBlacklistedPlugin (const PluginMetadata plugin)
void	InitCommListeners (void)
void	HandleN0183 (std::shared_ptr< const Nmea0183Msg > n0183_msg)
void	HandleSignalK (std::shared_ptr< const SignalkMsg > sK_msg)
wxArrayString	GetPlugInChartClassNameArray (void)
ListOfPI_S57Obj *	GetPlugInObjRuleListAtLatLon (ChartPlugInWrapper *target, float zlat, float zlon, float SelectRadius, const ViewPort &vp)
wxString	CreateObjDescriptions (ChartPlugInWrapper *target, ListOfPI_S57Obj *rule_list)
wxString	GetLastError ()
MyFrame *	GetParentFrame ()
void	DimeWindow (wxWindow *win)
pluginUtilHandler *	GetUtilHandler ()
void	SetListPanelPtr (PluginListPanel *ptr)
ListOfPI_S57Obj *	GetLightsObjRuleListVisibleAtLatLon (ChartPlugInWrapper *target, float zlat, float zlon, const ViewPort &vp)

Detailed Description

Definition at line 183 of file pluginmanager.h.

Constructor & Destructor Documentation

PlugInManager()

PlugInManager::PlugInManager

(

MyFrame *

parent

)

Definition at line 1053 of file pluginmanager.cpp.

~PlugInManager()

PlugInManager::~PlugInManager ( )

virtual

Definition at line 1111 of file pluginmanager.cpp.

Member Function Documentation

AddCanvasContextMenuItem()

int PlugInManager::AddCanvasContextMenuItem	(	wxMenuItem *	pitem,
		opencpn_plugin *	pplugin,
		const char *	name = ""
	)

Definition at line 2188 of file pluginmanager.cpp.

AddToolbarTool() [1/2]

int PlugInManager::AddToolbarTool	(	wxString	label,
		wxBitmap *	bitmap,
		wxBitmap *	bmpRollover,
		wxItemKind	kind,
		wxString	shortHelp,
		wxString	longHelp,
		wxObject *	clientData,
		int	position,
		int	tool_sel,
		opencpn_plugin *	pplugin
	)

Definition at line 2628 of file pluginmanager.cpp.

AddToolbarTool() [2/2]

int PlugInManager::AddToolbarTool	(	wxString	label,
		wxString	SVGfile,
		wxString	SVGRolloverfile,
		wxString	SVGToggledfile,
		wxItemKind	kind,
		wxString	shortHelp,
		wxString	longHelp,
		wxObject *	clientData,
		int	position,
		int	tool_sel,
		opencpn_plugin *	pplugin
	)

Definition at line 2679 of file pluginmanager.cpp.

CallLateInit()

bool PlugInManager::CallLateInit

(

void

)

Definition at line 1371 of file pluginmanager.cpp.

CheckBlacklistedPlugin()

bool PlugInManager::CheckBlacklistedPlugin

(

const PluginMetadata

plugin

)

Definition at line 1757 of file pluginmanager.cpp.

CloseAllPlugInPanels()

void PlugInManager::CloseAllPlugInPanels

(

int

ok_apply_cancel

)

Definition at line 2178 of file pluginmanager.cpp.

ClosePlugInPanel()

void PlugInManager::ClosePlugInPanel	(	PlugInContainer *	pic,
		int	ix
	)

Definition at line 2168 of file pluginmanager.cpp.

CreateObjDescriptions()

wxString PlugInManager::CreateObjDescriptions	(	ChartPlugInWrapper *	target,
		ListOfPI_S57Obj *	rule_list
	)

Definition at line 6416 of file pluginmanager.cpp.

FinalizePluginLoadall()

void PlugInManager::FinalizePluginLoadall

(

)

Definition at line 1693 of file pluginmanager.cpp.

FindToolOwner()

opencpn_plugin * PlugInManager::FindToolOwner

(

const int

id

)

Definition at line 2828 of file pluginmanager.cpp.

GetJSONMessageTargetCount()

int PlugInManager::GetJSONMessageTargetCount

(

)

Definition at line 2296 of file pluginmanager.cpp.

GetLastError()

wxString PlugInManager::GetLastError

(

)

Definition at line 2850 of file pluginmanager.cpp.

GetLightsObjRuleListVisibleAtLatLon()

ListOfPI_S57Obj * PlugInManager::GetLightsObjRuleListVisibleAtLatLon	(	ChartPlugInWrapper *	target,
		float	zlat,
		float	zlon,
		const ViewPort &	vp
	)

Definition at line 8025 of file pluginmanager.cpp.

GetParentFrame()

MyFrame * PlugInManager::GetParentFrame ( )

inline

Definition at line 283 of file pluginmanager.h.

GetPlugInChartClassNameArray()

wxArrayString PlugInManager::GetPlugInChartClassNameArray

(

void

)

Definition at line 2897 of file pluginmanager.cpp.

GetPluginContextMenuItemArray()

ArrayOfPlugInMenuItems & PlugInManager::GetPluginContextMenuItemArray ( )

inline

Definition at line 227 of file pluginmanager.h.

GetPlugInObjRuleListAtLatLon()

ListOfPI_S57Obj * PlugInManager::GetPlugInObjRuleListAtLatLon	(	ChartPlugInWrapper *	target,
		float	zlat,
		float	zlon,
		float	SelectRadius,
		const ViewPort &	vp
	)

Definition at line 6390 of file pluginmanager.cpp.

GetPluginToolbarToolArray()

ArrayOfPlugInToolbarTools & PlugInManager::GetPluginToolbarToolArray ( )

inline

Definition at line 201 of file pluginmanager.h.

GetToolOwnerCommonName()

wxString PlugInManager::GetToolOwnerCommonName

(

const int

id

)

Definition at line 2837 of file pluginmanager.cpp.

GetUtilHandler()

pluginUtilHandler * PlugInManager::GetUtilHandler ( )

inline

Definition at line 286 of file pluginmanager.h.

HandleN0183()

void PlugInManager::HandleN0183

(

std::shared_ptr< const Nmea0183Msg >

n0183_msg

)

Definition at line 1140 of file pluginmanager.cpp.

HandleSignalK()

void PlugInManager::HandleSignalK

(

std::shared_ptr< const SignalkMsg >

sK_msg

)

Definition at line 1177 of file pluginmanager.cpp.

InitCommListeners()

void PlugInManager::InitCommListeners

(

void

)

Definition at line 1117 of file pluginmanager.cpp.

IsAnyPlugInChartEnabled()

bool PlugInManager::IsAnyPlugInChartEnabled

(

)

Definition at line 1476 of file pluginmanager.cpp.

NotifyAuiPlugIns()

void PlugInManager::NotifyAuiPlugIns

(

void

)

Definition at line 2618 of file pluginmanager.cpp.

NotifySetupOptions()

void PlugInManager::NotifySetupOptions

(

)

Definition at line 2160 of file pluginmanager.cpp.

PrepareAllPluginContextMenus()

void PlugInManager::PrepareAllPluginContextMenus

(

)

Definition at line 2504 of file pluginmanager.cpp.

RemoveCanvasContextMenuItem()

void PlugInManager::RemoveCanvasContextMenuItem	(	int	item,
		const char *	name = ""
	)

Definition at line 2207 of file pluginmanager.cpp.

RemoveToolbarTool()

void PlugInManager::RemoveToolbarTool

(

int

tool_id

)

Definition at line 2724 of file pluginmanager.cpp.

RenderAllCanvasOverlayPlugIns()

bool PlugInManager::RenderAllCanvasOverlayPlugIns	(	ocpnDC &	dc,
		const ViewPort &	vp,
		int	canvasIndex,
		int	priority
	)

Definition at line 1788 of file pluginmanager.cpp.

RenderAllGLCanvasOverlayPlugIns()

bool PlugInManager::RenderAllGLCanvasOverlayPlugIns	(	wxGLContext *	pcontext,
		const ViewPort &	vp,
		int	canvasIndex,
		int	priority
	)

Definition at line 1968 of file pluginmanager.cpp.

SendActiveLegInfoToAllPlugIns()

void PlugInManager::SendActiveLegInfoToAllPlugIns

(

const ActiveLegDat *

infos

)

Definition at line 2448 of file pluginmanager.cpp.

SendAISSentenceToAllPlugIns()

void PlugInManager::SendAISSentenceToAllPlugIns

(

const wxString &

sentence

)

Definition at line 2373 of file pluginmanager.cpp.

SendBaseConfigToAllPlugIns()

void PlugInManager::SendBaseConfigToAllPlugIns

(

)

Definition at line 2542 of file pluginmanager.cpp.

SendCursorLatLonToAllPlugIns()

void PlugInManager::SendCursorLatLonToAllPlugIns	(	double	lat,
		double	lon
	)

Definition at line 2120 of file pluginmanager.cpp.

SendJSONMessageToAllPlugins()

void PlugInManager::SendJSONMessageToAllPlugins	(	const wxString &	message_id,
		wxJSONValue	v
	)

Definition at line 2308 of file pluginmanager.cpp.

SendKeyEventToPlugins()

bool PlugInManager::SendKeyEventToPlugins

(

wxKeyEvent &

event

)

Definition at line 2075 of file pluginmanager.cpp.

SendMessageToAllPlugins()

void PlugInManager::SendMessageToAllPlugins	(	const wxString &	message_id,
		const wxString &	message_body
	)

Definition at line 2318 of file pluginmanager.cpp.

SendMouseEventToPlugins()

bool PlugInManager::SendMouseEventToPlugins

(

wxMouseEvent &

event

)

Definition at line 2044 of file pluginmanager.cpp.

SendNMEASentenceToAllPlugIns()

void PlugInManager::SendNMEASentenceToAllPlugIns

(

const wxString &

sentence

)

Definition at line 2246 of file pluginmanager.cpp.

SendPositionFixToAllPlugIns()

void PlugInManager::SendPositionFixToAllPlugIns

(

GenericPosDatEx *

ppos

)

Definition at line 2387 of file pluginmanager.cpp.

SendResizeEventToAllPlugIns()

void PlugInManager::SendResizeEventToAllPlugIns	(	int	x,
		int	y
	)

Definition at line 2486 of file pluginmanager.cpp.

SendS52ConfigToAllPlugIns()

void PlugInManager::SendS52ConfigToAllPlugIns

(

bool

bReconfig = false

)

Definition at line 2573 of file pluginmanager.cpp.

SendSKConfigToAllPlugIns()

void PlugInManager::SendSKConfigToAllPlugIns

(

)

Definition at line 2532 of file pluginmanager.cpp.

SendVectorChartObjectInfo()

void PlugInManager::SendVectorChartObjectInfo	(	const wxString &	chart,
		const wxString &	feature,
		const wxString &	objname,
		double &	lat,
		double &	lon,
		double &	scale,
		int &	nativescale
	)

Definition at line 1439 of file pluginmanager.cpp.

SendViewPortToRequestingPlugIns()

void PlugInManager::SendViewPortToRequestingPlugIns

(

ViewPort &

vp

)

Definition at line 2107 of file pluginmanager.cpp.

SetCanvasContextMenuItemGrey()

void PlugInManager::SetCanvasContextMenuItemGrey	(	int	item,
		bool	grey,
		const char *	name = ""
	)

Definition at line 2233 of file pluginmanager.cpp.

SetCanvasContextMenuItemViz()

void PlugInManager::SetCanvasContextMenuItemViz	(	int	item,
		bool	viz,
		const char *	name = ""
	)

Definition at line 2220 of file pluginmanager.cpp.

SetColorSchemeForAllPlugIns()

void PlugInManager::SetColorSchemeForAllPlugIns

(

ColorScheme

cs

)

Definition at line 2495 of file pluginmanager.cpp.

SetListPanelPtr()

void PlugInManager::SetListPanelPtr ( PluginListPanel *  ptr )

inline

Definition at line 287 of file pluginmanager.h.

SetToolbarItemBitmaps() [1/2]

void PlugInManager::SetToolbarItemBitmaps	(	int	item,
		wxBitmap *	bitmap,
		wxBitmap *	bmpDisabled
	)

Definition at line 2768 of file pluginmanager.cpp.

SetToolbarItemBitmaps() [2/2]

void PlugInManager::SetToolbarItemBitmaps	(	int	item,
		wxString	SVGfile,
		wxString	SVGfileRollover,
		wxString	SVGfileToggled
	)

Definition at line 2809 of file pluginmanager.cpp.

SetToolbarItemState()

void PlugInManager::SetToolbarItemState	(	int	tool_id,
		bool	toggle
	)

Definition at line 2755 of file pluginmanager.cpp.

SetToolbarToolViz()

void PlugInManager::SetToolbarToolViz	(	int	tool_id,
		bool	viz
	)

Definition at line 2739 of file pluginmanager.cpp.

ShowDeferredBlacklistMessages()

void PlugInManager::ShowDeferredBlacklistMessages

(

)

Definition at line 1753 of file pluginmanager.cpp.

UpDateChartDataTypes()

bool PlugInManager::UpDateChartDataTypes

(

)

Definition at line 1673 of file pluginmanager.cpp.

UpdateConfig()

bool PlugInManager::UpdateConfig

(

)

Definition at line 1734 of file pluginmanager.cpp.

UpdateManagedPlugins()

void PlugInManager::UpdateManagedPlugins

(

)

Definition at line 1491 of file pluginmanager.cpp.

---

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

• /home/mk/src/OpenCPN/include/pluginmanager.h
• /home/mk/src/OpenCPN/src/pluginmanager.cpp