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

A dashboard instrument that displays the current computer time. More...

#include <clock.h>

Inheritance diagram for DashboardInstrument_CPUClock:
DashboardInstrument_Clock DashboardInstrument_Single DashboardInstrument

Public Member Functions

 DashboardInstrument_CPUClock (wxWindow *parent, wxWindowID id, wxString title, InstrumentProperties *Properties, wxString format="%02i:%02i:%02i UTC")
void SetData (DASH_CAP, double, wxString) override
void SetUtcTime (wxDateTime value) override
Public Member Functions inherited from DashboardInstrument_Clock
 DashboardInstrument_Clock (wxWindow *parent, wxWindowID id, wxString title, InstrumentProperties *Properties, DASH_CAP cap_flag=OCPN_DBP_STC_CLK, wxString format="%02i:%02i:%02i UTC")
wxString GetDisplayTime (wxDateTime UTCtime)
bool GetUtc () const
void SetUtc (bool flag)
Public Member Functions inherited from DashboardInstrument_Single
 DashboardInstrument_Single (wxWindow *pparent, wxWindowID id, wxString title, InstrumentProperties *Properties, DASH_CAP cap, wxString format)
wxSize GetSize (int orient, wxSize hint) override
void SetData (DASH_CAP st, double data, wxString unit) override
Public Member Functions inherited from DashboardInstrument
 DashboardInstrument (wxWindow *pparent, wxWindowID id, wxString title, DASH_CAP cap_flag, InstrumentProperties *Properties=nullptr)
CapType GetCapacity ()
void OnEraseBackground (wxEraseEvent &WXUNUSED(evt))
void OnPaint (wxPaintEvent &WXUNUSED(event))
void SetDrawSoloInPane (bool value)
void MouseEvent (wxMouseEvent &event)
void OnLeftUp (wxMouseEvent &event)
void SetCapFlag (DASH_CAP val)
bool HasCapFlag (DASH_CAP val)

Additional Inherited Members

Public Attributes inherited from DashboardInstrument_Clock
InstrumentProperties * m_Properties
Public Attributes inherited from DashboardInstrument
int instrumentTypeId
InstrumentProperties * m_Properties
Protected Member Functions inherited from DashboardInstrument_Single
void Draw (wxGCDC *dc) override
Protected Member Functions inherited from DashboardInstrument
virtual void InitDataTextHeight (const wxString &sampleText, int &sampleWidth)
virtual void InitTitleSize ()
virtual void InitTitleAndDataPosition (int drawHeight)
virtual int GetFullHeight (int drawHeight)
virtual int GetDataBottom (int clientHeight)
virtual void SetDataFont (wxGCDC *dc)
Protected Attributes inherited from DashboardInstrument_Single
wxString m_data
wxString m_format
Protected Attributes inherited from DashboardInstrument
CapType m_cap_flag
int m_InstrumentSpacing
int m_DataTextHeight
int m_DataMargin
int m_TitleWidth
int m_TitleHeight
int m_DataTop
int m_TitleTop
bool m_DataRightAlign
bool m_TitleRightAlign
wxString m_title

Detailed Description

A dashboard instrument that displays the current computer time.

Definition at line 128 of file clock.h.

Constructor & Destructor Documentation

◆ DashboardInstrument_CPUClock()

DashboardInstrument_CPUClock::DashboardInstrument_CPUClock ( wxWindow * parent,
wxWindowID id,
wxString title,
InstrumentProperties * Properties,
wxString format = "%02i:%02i:%02i UTC" )

Definition at line 74 of file clock.cpp.

Member Function Documentation

◆ SetData()

void DashboardInstrument_CPUClock::SetData ( DASH_CAP ,
double ,
wxString  )
overridevirtual

Reimplemented from DashboardInstrument_Clock.

Definition at line 83 of file clock.cpp.

◆ SetUtcTime()

void DashboardInstrument_CPUClock::SetUtcTime ( wxDateTime value)
overridevirtual

Reimplemented from DashboardInstrument_Clock.

Definition at line 87 of file clock.cpp.


The documentation for this class was generated from the following files:
  • /home/runner/work/main/main/opencpn/plugins/dashboard_pi/src/clock.h
  • /home/runner/work/main/main/opencpn/plugins/dashboard_pi/src/clock.cpp