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

Thin wrapper for wxSingleInstanceChecker implementing InstanceCheck. More...

#include <wx_instance_chk.h>

Inheritance diagram for WxInstanceCheck:
InstanceCheck

Public Member Functions

bool IsMainInstance () override
 Return true if this process is the primary opencpn instance.
 
void CleanUp () override
 Remove all persistent instance state, including possible lock file and defunct opencpn processes.
 
void OnExit () override
 Do whatever needed before wxWidget's checks triggers.
 
- Public Member Functions inherited from InstanceCheck
virtual void WaitUntilValid ()
 Wait until this object can be used for example for Dbus connection.
 

Additional Inherited Members

- Static Public Member Functions inherited from InstanceCheck
static InstanceCheckGetInstance ()
 

Detailed Description

Thin wrapper for wxSingleInstanceChecker implementing InstanceCheck.

Definition at line 28 of file wx_instance_chk.h.

Constructor & Destructor Documentation

◆ WxInstanceCheck()

WxInstanceCheck::WxInstanceCheck ( )

Definition at line 51 of file wx_instance_chk.cpp.

◆ ~WxInstanceCheck()

WxInstanceCheck::~WxInstanceCheck ( )
inline

Definition at line 32 of file wx_instance_chk.h.

Member Function Documentation

◆ CleanUp()

void WxInstanceCheck::CleanUp ( )
overridevirtual

Remove all persistent instance state, including possible lock file and defunct opencpn processes.

Reimplemented from InstanceCheck.

Definition at line 68 of file wx_instance_chk.cpp.

◆ IsMainInstance()

bool WxInstanceCheck::IsMainInstance ( )
overridevirtual

Return true if this process is the primary opencpn instance.

Implements InstanceCheck.

Definition at line 63 of file wx_instance_chk.cpp.

◆ OnExit()

void WxInstanceCheck::OnExit ( )
overridevirtual

Do whatever needed before wxWidget's checks triggers.

Reimplemented from InstanceCheck.

Definition at line 88 of file wx_instance_chk.cpp.


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