OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | List of all members
DashboardInstrument_Moon Class Reference

A dashboard instrument that displays current moon phase information. More...

#include <clock.h>

Inheritance diagram for DashboardInstrument_Moon:
DashboardInstrument_Clock DashboardInstrument_Single DashboardInstrument

Public Member Functions

 DashboardInstrument_Moon (wxWindow *parent, wxWindowID id, wxString title, InstrumentProperties *Properties)
 
wxSize GetSize (int orient, wxSize hint)
 
void SetData (DASH_CAP, double, wxString)
 
void Draw (wxGCDC *dc)
 
void SetUtcTime (wxDateTime value)
 
- 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=_T("%02i:%02i:%02i UTC"))
 
wxString GetDisplayTime (wxDateTime UTCtime)
 
bool getUTC ()
 
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)
 
void SetData (DASH_CAP st, double data, wxString unit)
 
- Public Member Functions inherited from DashboardInstrument
 DashboardInstrument (wxWindow *pparent, wxWindowID id, wxString title, DASH_CAP cap_flag, InstrumentProperties *Properties=NULL)
 
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)
 
- 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 current moon phase information.

Calculates and displays:

  • Visual moon phase representation
  • Current lunar phase
  • Hemisphere information

Definition at line 82 of file clock.h.

Constructor & Destructor Documentation

◆ DashboardInstrument_Moon()

DashboardInstrument_Moon::DashboardInstrument_Moon ( wxWindow *  parent,
wxWindowID  id,
wxString  title,
InstrumentProperties *  Properties 
)

Definition at line 102 of file clock.cpp.

◆ ~DashboardInstrument_Moon()

DashboardInstrument_Moon::~DashboardInstrument_Moon ( )
inline

Definition at line 86 of file clock.h.

Member Function Documentation

◆ Draw()

void DashboardInstrument_Moon::Draw ( wxGCDC *  dc)
virtual

Implements DashboardInstrument.

Definition at line 134 of file clock.cpp.

◆ GetSize()

wxSize DashboardInstrument_Moon::GetSize ( int  orient,
wxSize  hint 
)
virtual

Implements DashboardInstrument.

Definition at line 113 of file clock.cpp.

◆ SetData()

void DashboardInstrument_Moon::SetData ( DASH_CAP  st,
double  value,
wxString  format 
)
virtual

Reimplemented from DashboardInstrument_Clock.

Definition at line 127 of file clock.cpp.

◆ SetUtcTime()

void DashboardInstrument_Moon::SetUtcTime ( wxDateTime  value)
virtual

Reimplemented from DashboardInstrument_Clock.

Definition at line 217 of file clock.cpp.

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