OpenCPN Partial API docs
Loading...
Searching...
No Matches
PlugInData Class Reference

Basic data for a loaded plugin, trivially copyable. More...

#include <plugin_loader.h>

Inheritance diagram for PlugInData:
PlugInContainer

Public Member Functions

 PlugInData (const PluginMetadata &md)
 Create a container with applicable fields defined from metadata.
 
std::string Key () const
 sort key.
 

Public Attributes

bool m_has_setup_options
 Has run NotifySetupOptionsPlugin()
 
bool m_enabled
 
bool m_init_state
 
bool m_toolbox_panel
 
int m_cap_flag
 PlugIn Capabilities descriptor.
 
wxString m_plugin_file
 The full file path.
 
wxString m_plugin_filename
 The short file path.
 
wxDateTime m_plugin_modification
 used to detect upgraded plugins
 
wxString m_common_name
 A common name string for the plugin.
 
wxString m_short_description
 
wxString m_long_description
 
int m_api_version
 
int m_version_major
 
int m_version_minor
 
PluginStatus m_status
 
PluginMetadata m_managed_metadata
 
wxBitmap m_bitmap
 
wxString m_version_str
 Complete version as of semantic_vers.
 
std::string m_manifest_version
 As detected from manifest.
 

Detailed Description

Basic data for a loaded plugin, trivially copyable.

Definition at line 65 of file plugin_loader.h.

Constructor & Destructor Documentation

◆ PlugInData() [1/2]

PlugInData::PlugInData ( const PluginMetadata md)
explicit

Create a container with applicable fields defined from metadata.

Definition at line 206 of file plugin_loader.cpp.

◆ PlugInData() [2/2]

PlugInData::PlugInData ( )

Definition at line 195 of file plugin_loader.cpp.

Member Function Documentation

◆ Key()

std::string PlugInData::Key ( ) const

sort key.

Definition at line 216 of file plugin_loader.cpp.

Member Data Documentation

◆ m_api_version

int PlugInData::m_api_version

Definition at line 83 of file plugin_loader.h.

◆ m_bitmap

wxBitmap PlugInData::m_bitmap

Definition at line 88 of file plugin_loader.h.

◆ m_cap_flag

int PlugInData::m_cap_flag

PlugIn Capabilities descriptor.

Definition at line 76 of file plugin_loader.h.

◆ m_common_name

wxString PlugInData::m_common_name

A common name string for the plugin.

Definition at line 80 of file plugin_loader.h.

◆ m_enabled

bool PlugInData::m_enabled

Definition at line 73 of file plugin_loader.h.

◆ m_has_setup_options

bool PlugInData::m_has_setup_options

Has run NotifySetupOptionsPlugin()

Definition at line 72 of file plugin_loader.h.

◆ m_init_state

bool PlugInData::m_init_state

Definition at line 74 of file plugin_loader.h.

◆ m_long_description

wxString PlugInData::m_long_description

Definition at line 82 of file plugin_loader.h.

◆ m_managed_metadata

PluginMetadata PlugInData::m_managed_metadata

Definition at line 87 of file plugin_loader.h.

◆ m_manifest_version

std::string PlugInData::m_manifest_version

As detected from manifest.

Definition at line 90 of file plugin_loader.h.

◆ m_plugin_file

wxString PlugInData::m_plugin_file

The full file path.

Definition at line 77 of file plugin_loader.h.

◆ m_plugin_filename

wxString PlugInData::m_plugin_filename

The short file path.

Definition at line 78 of file plugin_loader.h.

◆ m_plugin_modification

wxDateTime PlugInData::m_plugin_modification

used to detect upgraded plugins

Definition at line 79 of file plugin_loader.h.

◆ m_short_description

wxString PlugInData::m_short_description

Definition at line 81 of file plugin_loader.h.

◆ m_status

PluginStatus PlugInData::m_status

Definition at line 86 of file plugin_loader.h.

◆ m_toolbox_panel

bool PlugInData::m_toolbox_panel

Definition at line 75 of file plugin_loader.h.

◆ m_version_major

int PlugInData::m_version_major

Definition at line 84 of file plugin_loader.h.

◆ m_version_minor

int PlugInData::m_version_minor

Definition at line 85 of file plugin_loader.h.

◆ m_version_str

wxString PlugInData::m_version_str

Complete version as of semantic_vers.

Definition at line 89 of file plugin_loader.h.


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