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	SendViewPortToRequestingPlugIns (ViewPort &vp)
void	PrepareAllPluginContextMenus ()
void	NotifySetupOptions ()
void	ClosePlugInPanel (const 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	AddCanvasContextMenuItemPIM (wxMenuItem *pitem, opencpn_plugin *pplugin, const char *name="", bool is_extended=false)
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="")
bool	UpDateChartDataTypes ()
void	FinalizePluginLoadall ()
bool	UpdateConfig ()
void	SendResizeEventToAllPlugIns (int x, int y)
void	SetColorSchemeForAllPlugIns (ColorScheme cs)
void	NotifyAuiPlugIns (void)
bool	CallLateInit (void)
bool	IsAnyPlugInChartEnabled ()
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)
	Process incoming NMEA 0183 messages from the message bus.
void	HandleSignalK (std::shared_ptr< const SignalkMsg > sK_msg)
	Process incoming SignalK messages from the message bus.
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 175 of file pluginmanager.h.

Constructor & Destructor Documentation

PlugInManager()

PlugInManager::PlugInManager

(

MyFrame *

parent

)

Definition at line 896 of file pluginmanager.cpp.

~PlugInManager()

PlugInManager::~PlugInManager ( )

virtual

Definition at line 962 of file pluginmanager.cpp.

Member Function Documentation

AddCanvasContextMenuItemPIM()

int PlugInManager::AddCanvasContextMenuItemPIM	(	wxMenuItem *	pitem,
		opencpn_plugin *	pplugin,
		const char *	name = "",
		bool	is_extended = false
	)

Definition at line 1652 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 1859 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 1910 of file pluginmanager.cpp.

CallLateInit()

bool PlugInManager::CallLateInit

(

void

)

Definition at line 1128 of file pluginmanager.cpp.

CheckBlacklistedPlugin()

bool PlugInManager::CheckBlacklistedPlugin

(

const PluginMetadata

plugin

)

Definition at line 1316 of file pluginmanager.cpp.

CloseAllPlugInPanels()

void PlugInManager::CloseAllPlugInPanels

(

int

ok_apply_cancel

)

Definition at line 1642 of file pluginmanager.cpp.

ClosePlugInPanel()

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

Definition at line 1630 of file pluginmanager.cpp.

CreateObjDescriptions()

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

Definition at line 4351 of file pluginmanager.cpp.

FinalizePluginLoadall()

void PlugInManager::FinalizePluginLoadall

(

)

Definition at line 1252 of file pluginmanager.cpp.

FindToolOwner()

opencpn_plugin * PlugInManager::FindToolOwner

(

const int

id

)

Definition at line 2053 of file pluginmanager.cpp.

GetLastError()

wxString PlugInManager::GetLastError

(

)

Definition at line 2075 of file pluginmanager.cpp.

GetLightsObjRuleListVisibleAtLatLon()

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

Definition at line 1799 of file ocpn_plugin_gui.cpp.

GetParentFrame()

MyFrame * PlugInManager::GetParentFrame ( )

inline

Definition at line 275 of file pluginmanager.h.

GetPlugInChartClassNameArray()

wxArrayString PlugInManager::GetPlugInChartClassNameArray

(

void

)

Definition at line 2121 of file pluginmanager.cpp.

GetPluginContextMenuItemArray()

ArrayOfPlugInMenuItems & PlugInManager::GetPluginContextMenuItemArray ( )

inline

Definition at line 219 of file pluginmanager.h.

GetPlugInObjRuleListAtLatLon()

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

Definition at line 4325 of file pluginmanager.cpp.

GetPluginToolbarToolArray()

ArrayOfPlugInToolbarTools & PlugInManager::GetPluginToolbarToolArray ( )

inline

Definition at line 193 of file pluginmanager.h.

GetToolOwnerCommonName()

wxString PlugInManager::GetToolOwnerCommonName

(

const int

id

)

Definition at line 2062 of file pluginmanager.cpp.

GetUtilHandler()

pluginUtilHandler * PlugInManager::GetUtilHandler ( )

inline

Definition at line 278 of file pluginmanager.h.

HandleN0183()

void PlugInManager::HandleN0183

(

std::shared_ptr< const Nmea0183Msg >

n0183_msg

)

Process incoming NMEA 0183 messages from the message bus.

Filters messages based on their source configuration and distributes valid messages to all interested plugins.

Parameters

n0183_msg

Message container with NMEA 0183 sentence and metadata

Definition at line 997 of file pluginmanager.cpp.

HandleSignalK()

void PlugInManager::HandleSignalK

(

std::shared_ptr< const SignalkMsg >

sK_msg

)

Process incoming SignalK messages from the message bus.

Validates and forwards SignalK data to plugins that have registered interest in SignalK messages.

Parameters

sK_msg

Message container with SignalK data and metadata

Definition at line 1020 of file pluginmanager.cpp.

InitCommListeners()

void PlugInManager::InitCommListeners

(

void

)

Definition at line 969 of file pluginmanager.cpp.

IsAnyPlugInChartEnabled()

bool PlugInManager::IsAnyPlugInChartEnabled

(

)

Definition at line 1208 of file pluginmanager.cpp.

NotifyAuiPlugIns()

void PlugInManager::NotifyAuiPlugIns

(

void

)

Definition at line 1849 of file pluginmanager.cpp.

NotifySetupOptions()

void PlugInManager::NotifySetupOptions

(

)

Definition at line 1622 of file pluginmanager.cpp.

PrepareAllPluginContextMenus()

void PlugInManager::PrepareAllPluginContextMenus

(

)

Definition at line 1730 of file pluginmanager.cpp.

RemoveCanvasContextMenuItem()

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

Definition at line 1673 of file pluginmanager.cpp.

RemoveToolbarTool()

void PlugInManager::RemoveToolbarTool

(

int

tool_id

)

Definition at line 1953 of file pluginmanager.cpp.

RenderAllCanvasOverlayPlugIns()

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

Definition at line 1348 of file pluginmanager.cpp.

RenderAllGLCanvasOverlayPlugIns()

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

Definition at line 1527 of file pluginmanager.cpp.

SendBaseConfigToAllPlugIns()

void PlugInManager::SendBaseConfigToAllPlugIns

(

)

Definition at line 1769 of file pluginmanager.cpp.

SendResizeEventToAllPlugIns()

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

Definition at line 1712 of file pluginmanager.cpp.

SendS52ConfigToAllPlugIns()

void PlugInManager::SendS52ConfigToAllPlugIns

(

bool

bReconfig = false

)

Definition at line 1801 of file pluginmanager.cpp.

SendSKConfigToAllPlugIns()

void PlugInManager::SendSKConfigToAllPlugIns

(

)

Definition at line 1759 of file pluginmanager.cpp.

SendViewPortToRequestingPlugIns()

void PlugInManager::SendViewPortToRequestingPlugIns

(

ViewPort &

vp

)

Definition at line 1605 of file pluginmanager.cpp.

SetCanvasContextMenuItemGrey()

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

Definition at line 1699 of file pluginmanager.cpp.

SetCanvasContextMenuItemViz()

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

Definition at line 1686 of file pluginmanager.cpp.

SetColorSchemeForAllPlugIns()

void PlugInManager::SetColorSchemeForAllPlugIns

(

ColorScheme

cs

)

Definition at line 1721 of file pluginmanager.cpp.

SetListPanelPtr()

void PlugInManager::SetListPanelPtr ( PluginListPanel *  ptr )

inline

Definition at line 279 of file pluginmanager.h.

SetToolbarItemBitmaps() [1/2]

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

Definition at line 1993 of file pluginmanager.cpp.

SetToolbarItemBitmaps() [2/2]

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

Definition at line 2034 of file pluginmanager.cpp.

SetToolbarItemState()

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

Definition at line 1980 of file pluginmanager.cpp.

SetToolbarToolViz()

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

Definition at line 1967 of file pluginmanager.cpp.

ShowDeferredBlacklistMessages()

void PlugInManager::ShowDeferredBlacklistMessages

(

)

Definition at line 1312 of file pluginmanager.cpp.

UpDateChartDataTypes()

bool PlugInManager::UpDateChartDataTypes

(

)

Definition at line 1231 of file pluginmanager.cpp.

UpdateConfig()

bool PlugInManager::UpdateConfig

(

)

Definition at line 1293 of file pluginmanager.cpp.

UpdateManagedPlugins()

void PlugInManager::UpdateManagedPlugins

(

)

Definition at line 1223 of file pluginmanager.cpp.

---

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

• /home/runner/work/main/main/opencpn/gui/include/gui/pluginmanager.h
• /home/runner/work/main/main/opencpn/gui/src/ocpn_plugin_gui.cpp
• /home/runner/work/main/main/opencpn/gui/src/pluginmanager.cpp