Provides platform-specific support utilities for OpenCPN. More...

#include <ocpn_platform.h>

Inheritance diagram for OCPNPlatform:

Public Member Functions
bool	startBluetoothScan ()

wxArrayString	getBluetoothScanResults ()

bool	stopBluetoothScan ()

void	Initialize_2 (void)

void	Initialize_3 (void)

void	SetDefaultOptions (void)

void	SetUpgradeOptions (wxString vString, wxString vStringConfig)

void	applyExpertMode (bool mode)

virtual void	ShowBusySpinner (void)

virtual void	HideBusySpinner (void)

double	getFontPointsperPixel (void)

wxSize	getDisplaySize ()
	Get the display size in logical pixels.

double	GetDisplaySizeMM ()
	Get the width of the screen in millimeters.

double	GetDisplayAreaCM2 ()

virtual double	GetDisplayDPmm ()

void	SetDisplaySizeMM (size_t monitor, double size)
	Set the width of the monitor in millimeters.

unsigned int	GetSelectRadiusPix ()

double	GetToolbarScaleFactor (int GUIScaleFactor)

double	GetCompassScaleFactor (int GUIScaleFactor)

wxFileDialog *	AdjustFileDialogFont (wxWindow container, wxFileDialog dlg)

wxDirDialog *	AdjustDirDialogFont (wxWindow container, wxDirDialog dlg)

void	PositionAISAlert (wxWindow *alert_window)

float	GetChartScaleFactorExp (float scale_linear)

float	GetMarkScaleFactorExp (float scale_linear)

int	GetStatusBarFieldCount ()

bool	GetFullscreen ()

bool	SetFullscreen (bool bFull)

bool	AllowAlertDialog (const wxString &class_name)

double	GetDisplayDensityFactor ()

long	GetDefaultToolbarOrientation ()

MyConfig *	GetConfigObject ()

int	DoFileSelectorDialog (wxWindow parent, wxString file_spec, wxString Title, wxString initDir, wxString suggestedName, wxString wildcard)

int	DoDirSelectorDialog (wxWindow parent, wxString file_spec, wxString Title, wxString initDir, bool b_addFiles=true)

void	setChartTypeMaskSel (int mask, wxString &indicator)

bool	isPlatformCapable (int flag)

int	platformApplyPrivateSettingsString (wxString settings, ArrayOfCDI *pDirArray)

void	platformLaunchDefaultBrowser (wxString URL)

void	SetLocaleSearchPrefixes (void)

wxString	GetDefaultSystemLocale ()

bool	BuildGLCaps (void *pbuf)

bool	IsGLCapable ()

Public Member Functions inherited from BasePlatform
bool	InitializeLogFile () override

int	GetSvgStdIconSize (const wxWindow *w, bool touch) override
	Return icon size roughly corresponding to height of a char in w, tweaked to be "big enough" for touch screens if touch is true.

Public Member Functions inherited from AbstractPlatform
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.

wxString	GetSupplementalLicenseString ()
	Android license details, otherwise "".

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.

wxString &	GetConfigFileName ()

wxString &	GetLogFileName ()

bool	isFlatpacked ()

bool	isPlatformCapable (int flag)

OCPN_OSDetail *	GetOSDetail ()

void	CloseLogFile (void)

wxString &	GetLargeLogMessage (void)

FILE *	GetLogFilePtr ()

wxString	NormalizePath (const wxString &full_path)

double	GetDisplayDIPMult (wxWindow *win)
	Get the display scaling factor for DPI-aware rendering.

Static Public Member Functions
static bool	hasInternalGPS (wxString profile="")

static bool	hasInternalBT (wxString profile="")

static void	Initialize_1 (void)

static void	Initialize_4 (void)

static void	OnExit_1 (void)

static void	OnExit_2 (void)

Static Public Member Functions inherited from AbstractPlatform
static void	ShowBusySpinner ()

static void	HideBusySpinner ()

Public Attributes
double	m_pt_per_pixel

Additional Inherited Members
Protected Member Functions inherited from AbstractPlatform
bool	DetectOSDetail (OCPN_OSDetail *detail)

Protected Attributes inherited from AbstractPlatform
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_OSDetail *	m_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 inherited from AbstractPlatform
static bool	m_isBusy = false

Detailed Description

Provides platform-specific support utilities for OpenCPN.

Extends BasePlatform to implement platform-specific functionality for various aspects of the application, including device support, initialization, display handling, and file operations, and more.

Definition at line 87 of file ocpn_platform.h.

Constructor & Destructor Documentation

◆ OCPNPlatform()

OCPNPlatform::OCPNPlatform ( )

Definition at line 156 of file ocpn_platform.cpp.

◆ ~OCPNPlatform()

OCPNPlatform::~OCPNPlatform ( )

virtual

Definition at line 167 of file ocpn_platform.cpp.

Member Function Documentation

◆ AdjustDirDialogFont()

wxDirDialog * OCPNPlatform::AdjustDirDialogFont	(	wxWindow *	container,
		wxDirDialog *	dlg
	)

Definition at line 1792 of file ocpn_platform.cpp.

◆ AdjustFileDialogFont()

wxFileDialog * OCPNPlatform::AdjustFileDialogFont	(	wxWindow *	container,
		wxFileDialog *	dlg
	)

Definition at line 1829 of file ocpn_platform.cpp.

◆ AllowAlertDialog()

bool OCPNPlatform::AllowAlertDialog ( const wxString & class_name )

Definition at line 2089 of file ocpn_platform.cpp.

◆ applyExpertMode()

void OCPNPlatform::applyExpertMode ( bool mode )

Definition at line 1475 of file ocpn_platform.cpp.

◆ DoDirSelectorDialog()

int OCPNPlatform::DoDirSelectorDialog	(	wxWindow *	parent,
		wxString *	file_spec,
		wxString	Title,
		wxString	initDir,
		bool	b_addFiles = `true`
	)

Definition at line 1540 of file ocpn_platform.cpp.

◆ DoFileSelectorDialog()

int OCPNPlatform::DoFileSelectorDialog	(	wxWindow *	parent,
		wxString *	file_spec,
		wxString	Title,
		wxString	initDir,
		wxString	suggestedName,
		wxString	wildcard
	)

Definition at line 1489 of file ocpn_platform.cpp.

◆ getBluetoothScanResults()

wxArrayString OCPNPlatform::getBluetoothScanResults ( )

Definition at line 2071 of file ocpn_platform.cpp.

◆ GetChartScaleFactorExp()

float OCPNPlatform::GetChartScaleFactorExp ( float scale_linear )

Definition at line 2003 of file ocpn_platform.cpp.

◆ GetCompassScaleFactor()

double OCPNPlatform::GetCompassScaleFactor ( int GUIScaleFactor )

Definition at line 1941 of file ocpn_platform.cpp.

◆ GetConfigObject()

MyConfig * OCPNPlatform::GetConfigObject ( )

Definition at line 1590 of file ocpn_platform.cpp.

◆ GetDefaultSystemLocale()

wxString OCPNPlatform::GetDefaultSystemLocale ( )

Definition at line 939 of file ocpn_platform.cpp.

◆ GetDefaultToolbarOrientation()

long OCPNPlatform::GetDefaultToolbarOrientation ( )

Definition at line 1630 of file ocpn_platform.cpp.

◆ GetDisplayAreaCM2()

double OCPNPlatform::GetDisplayAreaCM2 ( )

Definition at line 1723 of file ocpn_platform.cpp.

◆ GetDisplayDensityFactor()

double OCPNPlatform::GetDisplayDensityFactor ( )

Definition at line 1622 of file ocpn_platform.cpp.

◆ GetDisplayDPmm()

double OCPNPlatform::GetDisplayDPmm ( )

virtual

Reimplemented from BasePlatform.

Definition at line 1743 of file ocpn_platform.cpp.

◆ getDisplaySize()

wxSize OCPNPlatform::getDisplaySize ( )

virtual

Get the display size in logical pixels.

Returns the display dimensions in logical pixels, which may differ from physical pixels on high-DPI displays. For example:

On a MacBook Pro 16" Retina: returns 1792x1120 (logical) rather than 4096x2560 (physical).
On standard displays: logical pixels equal physical pixels.

Note: On Retina/HiDPI displays, multiply by GetContentScaleFactor() to get physical pixels.

Returns: wxSize containing the width and height in logical pixels.

Reimplemented from BasePlatform.

Definition at line 1698 of file ocpn_platform.cpp.

◆ GetDisplaySizeMM()

double OCPNPlatform::GetDisplaySizeMM ( )

virtual

Get the width of the screen in millimeters.

Reimplemented from BasePlatform.

Definition at line 1707 of file ocpn_platform.cpp.

◆ getFontPointsperPixel()

double OCPNPlatform::getFontPointsperPixel ( void )

Definition at line 1667 of file ocpn_platform.cpp.

◆ GetFullscreen()

bool OCPNPlatform::GetFullscreen ( )

Definition at line 1757 of file ocpn_platform.cpp.

◆ GetMarkScaleFactorExp()

float OCPNPlatform::GetMarkScaleFactorExp ( float scale_linear )

Definition at line 2021 of file ocpn_platform.cpp.

◆ GetSelectRadiusPix()

unsigned int OCPNPlatform::GetSelectRadiusPix ( )

virtual

Reimplemented from AbstractPlatform.

Definition at line 1752 of file ocpn_platform.cpp.

◆ GetStatusBarFieldCount()

int OCPNPlatform::GetStatusBarFieldCount ( )

Definition at line 1638 of file ocpn_platform.cpp.

◆ GetToolbarScaleFactor()

double OCPNPlatform::GetToolbarScaleFactor ( int GUIScaleFactor )

Definition at line 1868 of file ocpn_platform.cpp.

◆ hasInternalBT()

bool OCPNPlatform::hasInternalBT ( wxString profile = "" )

static

Definition at line 2042 of file ocpn_platform.cpp.

◆ hasInternalGPS()

bool OCPNPlatform::hasInternalGPS ( wxString profile = "" )

static

Definition at line 1602 of file ocpn_platform.cpp.

◆ HideBusySpinner()

void OCPNPlatform::HideBusySpinner ( void )

virtual

Definition at line 1620 of file ocpn_platform.cpp.

◆ Initialize_1()

void OCPNPlatform::Initialize_1 ( void )

static

Definition at line 242 of file ocpn_platform.cpp.

◆ Initialize_2()

void OCPNPlatform::Initialize_2 ( void )

Definition at line 465 of file ocpn_platform.cpp.

◆ Initialize_3()

void OCPNPlatform::Initialize_3 ( void )

Definition at line 516 of file ocpn_platform.cpp.

◆ Initialize_4()

void OCPNPlatform::Initialize_4 ( void )

static

Definition at line 573 of file ocpn_platform.cpp.

◆ IsGLCapable()

bool OCPNPlatform::IsGLCapable ( )

Definition at line 818 of file ocpn_platform.cpp.

◆ isPlatformCapable()

bool OCPNPlatform::isPlatformCapable ( int flag )

Definition at line 2143 of file ocpn_platform.cpp.

◆ OnExit_1()

void OCPNPlatform::OnExit_1 ( void )

static

Definition at line 590 of file ocpn_platform.cpp.

◆ OnExit_2()

void OCPNPlatform::OnExit_2 ( void )

static

Definition at line 592 of file ocpn_platform.cpp.

◆ platformApplyPrivateSettingsString()

int OCPNPlatform::platformApplyPrivateSettingsString	(	wxString	settings,
		ArrayOfCDI *	pDirArray
	)

Definition at line 1465 of file ocpn_platform.cpp.

◆ platformLaunchDefaultBrowser()

void OCPNPlatform::platformLaunchDefaultBrowser ( wxString URL )

Definition at line 2165 of file ocpn_platform.cpp.

◆ PositionAISAlert()

void OCPNPlatform::PositionAISAlert ( wxWindow * alert_window )

Definition at line 1778 of file ocpn_platform.cpp.

◆ setChartTypeMaskSel()

void OCPNPlatform::setChartTypeMaskSel	(	int	mask,
		wxString &	indicator
	)

Definition at line 2113 of file ocpn_platform.cpp.

◆ SetDefaultOptions()

void OCPNPlatform::SetDefaultOptions ( void )

Definition at line 1124 of file ocpn_platform.cpp.

◆ SetDisplaySizeMM()

void OCPNPlatform::SetDisplaySizeMM	(	size_t	monitor,
		double	size
	)

Set the width of the monitor in millimeters.

Definition at line 1737 of file ocpn_platform.cpp.

◆ SetFullscreen()

bool OCPNPlatform::SetFullscreen ( bool bFull )

Definition at line 1768 of file ocpn_platform.cpp.

◆ SetLocaleSearchPrefixes()

void OCPNPlatform::SetLocaleSearchPrefixes ( void )

Definition at line 874 of file ocpn_platform.cpp.

◆ SetUpgradeOptions()

void OCPNPlatform::SetUpgradeOptions	(	wxString	vString,
		wxString	vStringConfig
	)

Definition at line 1341 of file ocpn_platform.cpp.

◆ ShowBusySpinner()

void OCPNPlatform::ShowBusySpinner ( void )

virtual

Definition at line 1618 of file ocpn_platform.cpp.

◆ startBluetoothScan()

bool OCPNPlatform::startBluetoothScan ( )

Definition at line 2053 of file ocpn_platform.cpp.

◆ stopBluetoothScan()

bool OCPNPlatform::stopBluetoothScan ( )

Definition at line 2062 of file ocpn_platform.cpp.

Member Data Documentation

◆ m_pt_per_pixel

double OCPNPlatform::m_pt_per_pixel

Definition at line 170 of file ocpn_platform.h.

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

/home/runner/work/main/main/opencpn/gui/include/gui/ocpn_platform.h
/home/runner/work/main/main/opencpn/gui/src/ocpn_platform.cpp

Public Member Functions

Static Public Member Functions

Public Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OCPNPlatform()

◆ ~OCPNPlatform()

Member Function Documentation

◆ AdjustDirDialogFont()

◆ AdjustFileDialogFont()

◆ AllowAlertDialog()

◆ applyExpertMode()

◆ DoDirSelectorDialog()

◆ DoFileSelectorDialog()

◆ getBluetoothScanResults()

◆ GetChartScaleFactorExp()

◆ GetCompassScaleFactor()

◆ GetConfigObject()

◆ GetDefaultSystemLocale()

◆ GetDefaultToolbarOrientation()

◆ GetDisplayAreaCM2()

◆ GetDisplayDensityFactor()

◆ GetDisplayDPmm()

◆ getDisplaySize()

◆ GetDisplaySizeMM()

◆ getFontPointsperPixel()

◆ GetFullscreen()

◆ GetMarkScaleFactorExp()

◆ GetSelectRadiusPix()

◆ GetStatusBarFieldCount()

◆ GetToolbarScaleFactor()

◆ hasInternalBT()

◆ hasInternalGPS()

◆ HideBusySpinner()

◆ Initialize_1()

◆ Initialize_2()

◆ Initialize_3()

◆ Initialize_4()

◆ IsGLCapable()

◆ isPlatformCapable()

◆ OnExit_1()

◆ OnExit_2()

◆ platformApplyPrivateSettingsString()

◆ platformLaunchDefaultBrowser()

◆ PositionAISAlert()

◆ setChartTypeMaskSel()

◆ SetDefaultOptions()

◆ SetDisplaySizeMM()

◆ SetFullscreen()

◆ SetLocaleSearchPrefixes()

◆ SetUpgradeOptions()

◆ ShowBusySpinner()

◆ startBluetoothScan()

◆ stopBluetoothScan()

Member Data Documentation

◆ m_pt_per_pixel