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

This class provides access to the NMEA log/debug window. More...

#include <NMEALogWindow.h>

Inheritance diagram for NMEALogWindow:
NmeaLog WindowDestroyListener

Public Member Functions

 NMEALogWindow (const NMEALogWindow &)=delete
 
NMEALogWindow & operator= (const NMEALogWindow &)=delete
 
bool Active () const
 Return true if log is visible i.
 
void Create (wxWindow *parent, int num_lines=35)
 
void Add (const wxString &s)
 Add an formatted string to log output.
 
void Refresh (bool do_refresh=false)
 
int GetSizeW ()
 
int GetSizeH ()
 
int GetPosX ()
 
int GetPosY ()
 
void SetSize (int w, int h)
 
void SetSize (const wxSize &size)
 
void SetPos (int x, int y)
 
void SetPos (const wxPoint &pos)
 
void CheckPos (int display_width, int display_height)
 
void Move ()
 
virtual void DestroyWindow ()
 
wxWindow * GetTTYWindow (void)
 

Static Public Member Functions

static NMEALogWindow & GetInstance ()
 
static void Shutdown ()
 

Detailed Description

This class provides access to the NMEA log/debug window.

This provides everything needed to use the single NMEA log window.

Singleton.

Reading geometry information from the window will cache them inside this class. This is used to store them permanently in the configuration file.

Definition at line 48 of file NMEALogWindow.h.

Member Function Documentation

◆ Active()

bool NMEALogWindow::Active ( ) const
virtual

Return true if log is visible i.

e., if it's any point using Add().

Implements NmeaLog.

Definition at line 54 of file NMEALogWindow.cpp.

◆ Add()

void NMEALogWindow::Add ( const wxString &  s)
virtual

Add an formatted string to log output.

Implements NmeaLog.

Definition at line 70 of file NMEALogWindow.cpp.

◆ CheckPos()

void NMEALogWindow::CheckPos ( int  display_width,
int  display_height 
)

Definition at line 128 of file NMEALogWindow.cpp.

◆ Create()

void NMEALogWindow::Create ( wxWindow *  parent,
int  num_lines = 35 
)

Definition at line 56 of file NMEALogWindow.cpp.

◆ DestroyWindow()

void NMEALogWindow::DestroyWindow ( )
virtual

Implements WindowDestroyListener.

Definition at line 133 of file NMEALogWindow.cpp.

◆ GetInstance()

NMEALogWindow & NMEALogWindow::GetInstance ( )
static

Definition at line 37 of file NMEALogWindow.cpp.

◆ GetPosX()

int NMEALogWindow::GetPosX ( )

Definition at line 102 of file NMEALogWindow.cpp.

◆ GetPosY()

int NMEALogWindow::GetPosY ( )

Definition at line 107 of file NMEALogWindow.cpp.

◆ GetSizeH()

int NMEALogWindow::GetSizeH ( )

Definition at line 97 of file NMEALogWindow.cpp.

◆ GetSizeW()

int NMEALogWindow::GetSizeW ( )

Definition at line 92 of file NMEALogWindow.cpp.

◆ GetTTYWindow()

wxWindow * NMEALogWindow::GetTTYWindow ( void  )
inline

Definition at line 69 of file NMEALogWindow.h.

◆ Move()

void NMEALogWindow::Move ( )

Definition at line 141 of file NMEALogWindow.cpp.

◆ Refresh()

void NMEALogWindow::Refresh ( bool  do_refresh = false)

Definition at line 74 of file NMEALogWindow.cpp.

◆ SetPos() [1/2]

void NMEALogWindow::SetPos ( const wxPoint &  pos)

Definition at line 87 of file NMEALogWindow.cpp.

◆ SetPos() [2/2]

void NMEALogWindow::SetPos ( int  x,
int  y 
)

Definition at line 123 of file NMEALogWindow.cpp.

◆ SetSize() [1/2]

void NMEALogWindow::SetSize ( const wxSize &  size)

Definition at line 78 of file NMEALogWindow.cpp.

◆ SetSize() [2/2]

void NMEALogWindow::SetSize ( int  w,
int  h 
)

Definition at line 112 of file NMEALogWindow.cpp.

◆ Shutdown()

void NMEALogWindow::Shutdown ( )
static

Definition at line 47 of file NMEALogWindow.cpp.

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