OpenCPN Partial API docs
AbstractPlatform Class Referenceabstract
Inheritance diagram for AbstractPlatform:
BasePlatform CliPlatform OCPNPlatform

Public Member Functions

wxString & GetPrivateDataDir ()
 Return dir path for opencpn.log, etc., respecting -c cli option.
 
wxString & DefaultPrivateDataDir ()
 Return dir path for opencpn.log, etc., does not respect -c option.
 
wxString * GetPluginDirPtr ()
 
wxString * GetSharedDataDirPtr ()
 
wxString * GetPrivateDataDirPtr ()
 Legacy compatibility syntactic sugar for GetPrivateDataDir().
 
wxString & GetPluginDir ()
 The original in-tree plugin directory, sometimes not user-writable.
 
wxStandardPaths & GetStdPaths ()
 
wxString GetWinPluginBaseDir ()
 Base directory for user writable windows plugins, reflects winPluginDir option, defaults to LOCALAPPDATA%/opencpn.
 
wxString & GetSharedDataDir ()
 
wxString & GetExePath ()
 
wxString & GetHomeDir ()
 
wxString GetWritableDocumentsDir ()
 
wxString GetPluginDataPath ()
 Return ';'-separated list of base directories for plugin data. More...
 
wxString & GetConfigFileName ()
 
wxString & GetLogFileName ()
 
bool isFlatpacked ()
 
bool isPlatformCapable (int flag)
 
OCPN_OSDetailGetOSDetail ()
 
void CloseLogFile (void)
 
virtual bool InitializeLogFile (void)=0
 
wxString & GetLargeLogMessage (void)
 
FILE * GetLogFilePtr ()
 
wxString NormalizePath (const wxString &full_path)
 
virtual wxSize getDisplaySize ()
 
virtual double GetDisplaySizeMM ()
 
virtual double GetDisplayDPmm ()
 
virtual unsigned int GetSelectRadiusPix ()
 
double GetDisplayDIPMult (wxWindow *win)
 

Static Public Member Functions

static void ShowBusySpinner ()
 
static void HideBusySpinner ()
 

Protected Member Functions

bool DetectOSDetail (OCPN_OSDetail *detail)
 

Protected Attributes

wxString m_default_private_datadir
 
wxString m_PrivateDataDir
 
wxString m_PluginsDir
 
bool m_isFlatpacked
 
wxString m_homeDir
 
wxString m_exePath
 
wxString m_SData_Dir
 
wxString m_config_file_name
 
wxString m_pluginDataPath
 
wxString mlog_file
 
OCPN_OSDetailm_osDetail
 
FILE * flog
 
wxLog * m_old_logger
 
wxString large_log_message
 
std::vector< int > m_displaySizeMMOverride
 
int m_monitorWidth
 
int m_monitorHeight
 
bool m_bdisableWindowsDisplayEnum
 

Static Protected Attributes

static bool m_isBusy = false
 

Detailed Description

Definition at line 73 of file base_platform.h.

Member Function Documentation

◆ GetPluginDataPath()

wxString AbstractPlatform::GetPluginDataPath ( )

Return ';'-separated list of base directories for plugin data.

The list always includes the main installation directory. Some platforms prepends this with user-writable path(s), each of which ending in "opencpn". All paths are guaranteed to exist.

For Linux, return paths ending in .../share.

Definition at line 708 of file base_platform.cpp.


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