OpenCPN Partial API docs
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
DashboardInstrument Class Referenceabstract
Inheritance diagram for DashboardInstrument:
DashboardInstrument_Altitude DashboardInstrument_BaroHistory DashboardInstrument_Depth DashboardInstrument_Dial DashboardInstrument_FromOwnship DashboardInstrument_GPS DashboardInstrument_Position DashboardInstrument_Single DashboardInstrument_WindDirHistory

Public Member Functions

 DashboardInstrument (wxWindow *pparent, wxWindowID id, wxString title, DASH_CAP cap_flag, InstrumentProperties *Properties=NULL)
 
CapType GetCapacity ()
 
void OnEraseBackground (wxEraseEvent &WXUNUSED(evt))
 
virtual wxSize GetSize (int orient, wxSize hint)=0
 
void OnPaint (wxPaintEvent &WXUNUSED(event))
 
virtual void SetData (DASH_CAP st, double data, wxString unit)=0
 
void SetDrawSoloInPane (bool value)
 
void MouseEvent (wxMouseEvent &event)
 
void OnLeftUp (wxMouseEvent &event)
 
void SetCapFlag (DASH_CAP val)
 
bool HasCapFlag (DASH_CAP val)
 

Public Attributes

int instrumentTypeId
 
InstrumentProperties * m_Properties
 

Protected Member Functions

virtual void Draw (wxGCDC *dc)=0
 
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

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

Definition at line 199 of file instrument.h.

Constructor & Destructor Documentation

◆ DashboardInstrument()

DashboardInstrument::DashboardInstrument ( wxWindow * pparent,
wxWindowID id,
wxString title,
DASH_CAP cap_flag,
InstrumentProperties * Properties = NULL )

Definition at line 125 of file instrument.cpp.

◆ ~DashboardInstrument()

DashboardInstrument::~DashboardInstrument ( )
inline

Definition at line 204 of file instrument.h.

Member Function Documentation

◆ GetCapacity()

CapType DashboardInstrument::GetCapacity ( )

Definition at line 206 of file instrument.cpp.

◆ GetDataBottom()

int DashboardInstrument::GetDataBottom ( int clientHeight)
protectedvirtual

Definition at line 273 of file instrument.cpp.

◆ GetFullHeight()

int DashboardInstrument::GetFullHeight ( int drawHeight)
protectedvirtual

Definition at line 264 of file instrument.cpp.

◆ HasCapFlag()

bool DashboardInstrument::HasCapFlag ( DASH_CAP val)
inline

Definition at line 218 of file instrument.h.

◆ InitDataTextHeight()

void DashboardInstrument::InitDataTextHeight ( const wxString & sampleText,
int & sampleWidth )
protectedvirtual

Definition at line 214 of file instrument.cpp.

◆ InitTitleAndDataPosition()

void DashboardInstrument::InitTitleAndDataPosition ( int drawHeight)
protectedvirtual

Definition at line 244 of file instrument.cpp.

◆ InitTitleSize()

void DashboardInstrument::InitTitleSize ( )
protectedvirtual

Definition at line 228 of file instrument.cpp.

◆ MouseEvent()

void DashboardInstrument::MouseEvent ( wxMouseEvent & event)

Definition at line 197 of file instrument.cpp.

◆ OnEraseBackground()

void DashboardInstrument::OnEraseBackground ( wxEraseEvent & WXUNUSEDevt)

Definition at line 210 of file instrument.cpp.

◆ OnLeftUp()

void DashboardInstrument::OnLeftUp ( wxMouseEvent & event)

Definition at line 179 of file instrument.cpp.

◆ OnPaint()

void DashboardInstrument::OnPaint ( wxPaintEvent & WXUNUSEDevent)

Definition at line 295 of file instrument.cpp.

◆ SetCapFlag()

void DashboardInstrument::SetCapFlag ( DASH_CAP val)
inline

Definition at line 217 of file instrument.h.

◆ SetDataFont()

void DashboardInstrument::SetDataFont ( wxGCDC * dc)
protectedvirtual

Definition at line 280 of file instrument.cpp.

◆ SetDrawSoloInPane()

void DashboardInstrument::SetDrawSoloInPane ( bool value)

Definition at line 207 of file instrument.cpp.

Member Data Documentation

◆ instrumentTypeId

int DashboardInstrument::instrumentTypeId

Definition at line 219 of file instrument.h.

◆ m_cap_flag

CapType DashboardInstrument::m_cap_flag
protected

Definition at line 223 of file instrument.h.

◆ m_DataMargin

int DashboardInstrument::m_DataMargin
protected

Definition at line 226 of file instrument.h.

◆ m_DataRightAlign

bool DashboardInstrument::m_DataRightAlign
protected

Definition at line 231 of file instrument.h.

◆ m_DataTextHeight

int DashboardInstrument::m_DataTextHeight
protected

Definition at line 225 of file instrument.h.

◆ m_DataTop

int DashboardInstrument::m_DataTop
protected

Definition at line 229 of file instrument.h.

◆ m_InstrumentSpacing

int DashboardInstrument::m_InstrumentSpacing
protected

Definition at line 224 of file instrument.h.

◆ m_Properties

InstrumentProperties* DashboardInstrument::m_Properties

Definition at line 220 of file instrument.h.

◆ m_title

wxString DashboardInstrument::m_title
protected

Definition at line 233 of file instrument.h.

◆ m_TitleHeight

int DashboardInstrument::m_TitleHeight
protected

Definition at line 228 of file instrument.h.

◆ m_TitleRightAlign

bool DashboardInstrument::m_TitleRightAlign
protected

Definition at line 232 of file instrument.h.

◆ m_TitleTop

int DashboardInstrument::m_TitleTop
protected

Definition at line 230 of file instrument.h.

◆ m_TitleWidth

int DashboardInstrument::m_TitleWidth
protected

Definition at line 227 of file instrument.h.

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