OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
BasePlatform Class Reference
Inheritance diagram for BasePlatform:
OCPNPlatform

Public Member Functions

wxString & GetPrivateDataDir ()
 
wxString * GetPluginDirPtr ()
 
wxString * GetSharedDataDirPtr ()
 
wxString * GetPrivateDataDirPtr ()
 
wxString & GetPluginDir ()
 The original in-tree plugin directory, sometimes not user-writable. More...
 
wxStandardPaths & GetStdPaths ()
 
wxString GetWinPluginBaseDir ()
 Base directory for user writable windows plugins, reflects winPluginDir option, defaults to LOCALAPPDATA%/opencpn. More...
 
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_OSDetail * GetOSDetail ()
 
void CloseLogFile (void)
 
bool InitializeLogFile (void)
 
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)
 
void ShowBusySpinner ()
 
void HideBusySpinner ()
 

Protected Member Functions

bool DetectOSDetail (OCPN_OSDetail *detail)
 

Protected Attributes

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_OSDetail * m_osDetail
 
FILE * flog
 
wxLog * m_Oldlogger
 
wxString large_log_message
 
wxSize m_displaySize
 
wxSize m_displaySizeMM
 
int m_displaySizeMMOverride
 
int m_monitorWidth
 
int m_monitorHeight
 
bool m_bdisableWindowsDisplayEnum
 

Detailed Description

Definition at line 68 of file base_platform.h.

Constructor & Destructor Documentation

◆ BasePlatform()

BasePlatform::BasePlatform ( )

Definition at line 149 of file base_platform.cpp.

◆ ~BasePlatform()

virtual BasePlatform::~BasePlatform ( )
inlinevirtual

Definition at line 71 of file base_platform.h.

Member Function Documentation

◆ CloseLogFile()

void BasePlatform::CloseLogFile ( void  )

Definition at line 674 of file base_platform.cpp.

◆ DetectOSDetail()

bool BasePlatform::DetectOSDetail ( OCPN_OSDetail *  detail)
protected

Definition at line 462 of file base_platform.cpp.

◆ GetConfigFileName()

wxString & BasePlatform::GetConfigFileName ( )

Definition at line 552 of file base_platform.cpp.

◆ GetDisplayDIPMult()

double BasePlatform::GetDisplayDIPMult ( wxWindow *  win)

Definition at line 809 of file base_platform.cpp.

◆ GetDisplayDPmm()

double BasePlatform::GetDisplayDPmm ( )
virtual

Definition at line 802 of file base_platform.cpp.

◆ getDisplaySize()

wxSize BasePlatform::getDisplaySize ( )
virtual

Definition at line 748 of file base_platform.cpp.

◆ GetDisplaySizeMM()

double BasePlatform::GetDisplaySizeMM ( )
virtual

Definition at line 761 of file base_platform.cpp.

◆ GetExePath()

wxString & BasePlatform::GetExePath ( )

Definition at line 222 of file base_platform.cpp.

◆ GetHomeDir()

wxString & BasePlatform::GetHomeDir ( )

Definition at line 183 of file base_platform.cpp.

◆ GetLargeLogMessage()

wxString & BasePlatform::GetLargeLogMessage ( void  )
inline

Definition at line 114 of file base_platform.h.

◆ GetLogFileName()

wxString & BasePlatform::GetLogFileName ( )
inline

Definition at line 105 of file base_platform.h.

◆ GetLogFilePtr()

FILE * BasePlatform::GetLogFilePtr ( )
inline

Definition at line 115 of file base_platform.h.

◆ GetOSDetail()

OCPN_OSDetail * BasePlatform::GetOSDetail ( )
inline

Definition at line 110 of file base_platform.h.

◆ GetPluginDataPath()

wxString BasePlatform::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 681 of file base_platform.cpp.

◆ GetPluginDir()

wxString & BasePlatform::GetPluginDir ( )

The original in-tree plugin directory, sometimes not user-writable.

Definition at line 393 of file base_platform.cpp.

◆ GetPluginDirPtr()

wxString * BasePlatform::GetPluginDirPtr ( )

Definition at line 418 of file base_platform.cpp.

◆ GetPrivateDataDir()

wxString & BasePlatform::GetPrivateDataDir ( )

Definition at line 294 of file base_platform.cpp.

◆ GetPrivateDataDirPtr()

wxString * BasePlatform::GetPrivateDataDirPtr ( )

Definition at line 236 of file base_platform.cpp.

◆ GetSelectRadiusPix()

unsigned int BasePlatform::GetSelectRadiusPix ( )
virtual

Definition at line 818 of file base_platform.cpp.

◆ GetSharedDataDir()

wxString & BasePlatform::GetSharedDataDir ( )

Definition at line 241 of file base_platform.cpp.

◆ GetSharedDataDirPtr()

wxString * BasePlatform::GetSharedDataDirPtr ( )

Definition at line 231 of file base_platform.cpp.

◆ GetStdPaths()

wxStandardPaths & BasePlatform::GetStdPaths ( )

Definition at line 160 of file base_platform.cpp.

◆ GetWinPluginBaseDir()

wxString BasePlatform::GetWinPluginBaseDir ( )

Base directory for user writable windows plugins, reflects winPluginDir option, defaults to LOCALAPPDATA%/opencpn.

Definition at line 334 of file base_platform.cpp.

◆ GetWritableDocumentsDir()

wxString BasePlatform::GetWritableDocumentsDir ( )

Definition at line 450 of file base_platform.cpp.

◆ HideBusySpinner()

void BasePlatform::HideBusySpinner ( void  )

Definition at line 736 of file base_platform.cpp.

◆ InitializeLogFile()

bool BasePlatform::InitializeLogFile ( void  )

Definition at line 598 of file base_platform.cpp.

◆ isFlatpacked()

bool BasePlatform::isFlatpacked ( )
inline

Definition at line 107 of file base_platform.h.

◆ isPlatformCapable()

bool BasePlatform::isPlatformCapable ( int  flag)

Definition at line 423 of file base_platform.cpp.

◆ NormalizePath()

wxString BasePlatform::NormalizePath ( const wxString &  full_path)

Definition at line 169 of file base_platform.cpp.

◆ ShowBusySpinner()

void BasePlatform::ShowBusySpinner ( void  )

Definition at line 728 of file base_platform.cpp.

Member Data Documentation

◆ flog

FILE* BasePlatform::flog
protected

Definition at line 143 of file base_platform.h.

◆ large_log_message

wxString BasePlatform::large_log_message
protected

Definition at line 145 of file base_platform.h.

◆ m_bdisableWindowsDisplayEnum

bool BasePlatform::m_bdisableWindowsDisplayEnum
protected

Definition at line 156 of file base_platform.h.

◆ m_config_file_name

wxString BasePlatform::m_config_file_name
protected

Definition at line 137 of file base_platform.h.

◆ m_displaySize

wxSize BasePlatform::m_displaySize
protected

Definition at line 147 of file base_platform.h.

◆ m_displaySizeMM

wxSize BasePlatform::m_displaySizeMM
protected

Definition at line 148 of file base_platform.h.

◆ m_displaySizeMMOverride

int BasePlatform::m_displaySizeMMOverride
protected

Definition at line 149 of file base_platform.h.

◆ m_exePath

wxString BasePlatform::m_exePath
protected

Definition at line 135 of file base_platform.h.

◆ m_homeDir

wxString BasePlatform::m_homeDir
protected

Definition at line 134 of file base_platform.h.

◆ m_isFlatpacked

bool BasePlatform::m_isFlatpacked
protected

Definition at line 133 of file base_platform.h.

◆ m_monitorHeight

int BasePlatform::m_monitorHeight
protected

Definition at line 155 of file base_platform.h.

◆ m_monitorWidth

int BasePlatform::m_monitorWidth
protected

Definition at line 155 of file base_platform.h.

◆ m_Oldlogger

wxLog* BasePlatform::m_Oldlogger
protected

Definition at line 144 of file base_platform.h.

◆ m_osDetail

OCPN_OSDetail* BasePlatform::m_osDetail
protected

Definition at line 141 of file base_platform.h.

◆ m_pluginDataPath

wxString BasePlatform::m_pluginDataPath
protected

Definition at line 138 of file base_platform.h.

◆ m_PluginsDir

wxString BasePlatform::m_PluginsDir
protected

Definition at line 132 of file base_platform.h.

◆ m_PrivateDataDir

wxString BasePlatform::m_PrivateDataDir
protected

Definition at line 131 of file base_platform.h.

◆ m_SData_Dir

wxString BasePlatform::m_SData_Dir
protected

Definition at line 136 of file base_platform.h.

◆ mlog_file

wxString BasePlatform::mlog_file
protected

Definition at line 139 of file base_platform.h.

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