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

Public Member Functions

std::string UserLibdir ()
 The single, user-writable directory for installing .dll files. More...
 
std::string UserBindir ()
 The single, user-writable directory for installing helper binaries. More...
 
std::string UserDatadir ()
 The single, user-writable common parent for plugin data directories, typically ending in 'plugins'. More...
 
std::vector< std::string > Libdirs ()
 List of directories from which we load plugins. More...
 
std::vector< std::string > Bindirs ()
 'List of directories for plugin binary helpers. More...
 
std::vector< std::string > Datadirs ()
 List of directories containing plugin data, each element typically ends in 'plugins'. More...
 
std::string Homedir () const
 home directory, convenience stuff. More...
 

Static Public Member Functions

static PluginPathsgetInstance ()
 Return the singleton instance. More...
 

Detailed Description

Definition at line 8 of file plugin_paths.h.

Member Function Documentation

◆ Bindirs()

std::vector< std::string > PluginPaths::Bindirs ( )
inline

'List of directories for plugin binary helpers.

Definition at line 29 of file plugin_paths.h.

◆ Datadirs()

std::vector< std::string > PluginPaths::Datadirs ( )
inline

List of directories containing plugin data, each element typically ends in 'plugins'.

Definition at line 35 of file plugin_paths.h.

◆ getInstance()

PluginPaths * PluginPaths::getInstance ( )
static

Return the singleton instance.

Definition at line 41 of file plugin_paths.cpp.

◆ Homedir()

std::string PluginPaths::Homedir ( ) const
inline

home directory, convenience stuff.

Definition at line 38 of file plugin_paths.h.

◆ Libdirs()

std::vector< std::string > PluginPaths::Libdirs ( )
inline

List of directories from which we load plugins.

Definition at line 26 of file plugin_paths.h.

◆ UserBindir()

std::string PluginPaths::UserBindir ( )
inline

The single, user-writable directory for installing helper binaries.

Definition at line 17 of file plugin_paths.h.

◆ UserDatadir()

std::string PluginPaths::UserDatadir ( )
inline

The single, user-writable common parent for plugin data directories, typically ending in 'plugins'.

Definition at line 23 of file plugin_paths.h.

◆ UserLibdir()

std::string PluginPaths::UserLibdir ( )
inline

The single, user-writable directory for installing .dll files.

Definition at line 14 of file plugin_paths.h.


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