OpenCPN Partial API docs
Loading...
Searching...
No Matches
ocpn_frame.h File Reference

OpenCPN top window. More...

#include <wx/print.h>
#include <wx/power.h>
#include <wx/artprov.h>
#include <wx/socket.h>
#include <wx/html/htmlwin.h>
#include <wx/aui/aui.h>
#include <wx/aui/dockart.h>
#include <memory>
#include "model/ais_target_data.h"
#include "model/ocpn_types.h"
#include "model/track.h"
#include "model/comm_appmsg_bus.h"
#include "bbox.h"
#include "chartbase.h"
#include "chartdbs.h"
#include "chcanv.h"
#include "color_handler.h"
#include "connections_dlg.h"
#include "data_monitor.h"
#include "displays.h"
#include "gui_lib.h"
#include "load_errors_dlg.h"
#include "observable_evtvar.h"
#include "options.h"
#include "pluginmanager.h"
#include "s52s57.h"
#include "s57registrar_mgr.h"
#include "senc_manager.h"
#include "toolbar.h"

Go to the source code of this file.

Classes

class  MyFrame
 Main application frame. More...
 

Macros

#define TIMER_GFRAME_1   999
 
#define ID_CM93ZOOMG   102
 
#define ID_CMD_APPLY_SETTINGS   300
 
#define ID_CMD_NULL_REFRESH   301
 
#define ID_CMD_TRIGGER_RESIZE   302
 
#define ID_CMD_SETVP   303
 
#define ID_CMD_POST_JSON_TO_PLUGINS   304
 
#define ID_CMD_SOUND_FINISHED   306
 
#define STAT_FIELD_COUNT   5
 
#define STAT_FIELD_TICK   0
 
#define STAT_FIELD_SOGCOG   1
 
#define STAT_FIELD_CURSOR_LL   2
 
#define STAT_FIELD_CURSOR_BRGRNG   3
 
#define STAT_FIELD_SCALE   4
 
#define GPS_TIMEOUT_SECONDS   10
 
#define MAX_COG_AVERAGE_SECONDS   60
 
#define MAX_COGSOG_FILTER_SECONDS   60
 

Functions

bool ShowNavWarning ()
 
bool isSingleChart (ChartBase *chart)
 
wxColour GetGlobalColor (wxString colorName)
 
wxColour GetDialogColor (DialogColor color)
 Retrieves a dialog color based on its role in the application's dialogs.
 
wxString _menuText (wxString name, wxString shortcut)
 
double AnchorDistFix (double const d, double const AnchorPointMinDist, double const AnchorPointMaxDist)
 
bool TestGLCanvas (wxString prog_dir)
 
bool ReloadLocale ()
 
void ApplyLocale (void)
 
void LoadS57 ()
 

Variables

MyFramegFrame
 Global instance.
 

Detailed Description

OpenCPN top window.

Definition in file ocpn_frame.h.

Macro Definition Documentation

◆ GPS_TIMEOUT_SECONDS

#define GPS_TIMEOUT_SECONDS   10

Definition at line 100 of file ocpn_frame.h.

◆ ID_CM93ZOOMG

#define ID_CM93ZOOMG   102

Definition at line 69 of file ocpn_frame.h.

◆ ID_CMD_APPLY_SETTINGS

#define ID_CMD_APPLY_SETTINGS   300

Definition at line 75 of file ocpn_frame.h.

◆ ID_CMD_NULL_REFRESH

#define ID_CMD_NULL_REFRESH   301

Definition at line 76 of file ocpn_frame.h.

◆ ID_CMD_POST_JSON_TO_PLUGINS

#define ID_CMD_POST_JSON_TO_PLUGINS   304

Definition at line 79 of file ocpn_frame.h.

◆ ID_CMD_SETVP

#define ID_CMD_SETVP   303

Definition at line 78 of file ocpn_frame.h.

◆ ID_CMD_SOUND_FINISHED

#define ID_CMD_SOUND_FINISHED   306

Definition at line 80 of file ocpn_frame.h.

◆ ID_CMD_TRIGGER_RESIZE

#define ID_CMD_TRIGGER_RESIZE   302

Definition at line 77 of file ocpn_frame.h.

◆ MAX_COG_AVERAGE_SECONDS

#define MAX_COG_AVERAGE_SECONDS   60

Definition at line 102 of file ocpn_frame.h.

◆ MAX_COGSOG_FILTER_SECONDS

#define MAX_COGSOG_FILTER_SECONDS   60

Definition at line 103 of file ocpn_frame.h.

◆ STAT_FIELD_COUNT

#define STAT_FIELD_COUNT   5

Definition at line 91 of file ocpn_frame.h.

◆ STAT_FIELD_CURSOR_BRGRNG

#define STAT_FIELD_CURSOR_BRGRNG   3

Definition at line 95 of file ocpn_frame.h.

◆ STAT_FIELD_CURSOR_LL

#define STAT_FIELD_CURSOR_LL   2

Definition at line 94 of file ocpn_frame.h.

◆ STAT_FIELD_SCALE

#define STAT_FIELD_SCALE   4

Definition at line 96 of file ocpn_frame.h.

◆ STAT_FIELD_SOGCOG

#define STAT_FIELD_SOGCOG   1

Definition at line 93 of file ocpn_frame.h.

◆ STAT_FIELD_TICK

#define STAT_FIELD_TICK   0

Definition at line 92 of file ocpn_frame.h.

◆ TIMER_GFRAME_1

#define TIMER_GFRAME_1   999

Definition at line 67 of file ocpn_frame.h.

Function Documentation

◆ _menuText()

wxString _menuText ( wxString  name,
wxString  shortcut 
)

Definition at line 3523 of file ocpn_frame.cpp.

◆ AnchorDistFix()

double AnchorDistFix ( double const  d,
double const  AnchorPointMinDist,
double const  AnchorPointMaxDist 
)

Definition at line 7524 of file ocpn_frame.cpp.

◆ ApplyLocale()

void ApplyLocale ( void  )

Definition at line 7641 of file ocpn_frame.cpp.

◆ GetDialogColor()

wxColour GetDialogColor ( DialogColor  color)

Retrieves a dialog color based on its role in the application's dialogs.

Definition at line 59 of file color_handler.cpp.

◆ GetGlobalColor()

wxColour GetGlobalColor ( wxString  colorName)

Definition at line 40 of file color_handler.cpp.

◆ isSingleChart()

bool isSingleChart ( ChartBase chart)

Definition at line 412 of file ocpn_frame.cpp.

◆ LoadS57()

void LoadS57 ( )

??? g_SData_Locn = tentative_SData_Locn;

Definition at line 7735 of file ocpn_frame.cpp.

◆ ReloadLocale()

bool ReloadLocale ( )

Definition at line 7630 of file ocpn_frame.cpp.

◆ ShowNavWarning()

bool ShowNavWarning ( )

Definition at line 376 of file ocpn_frame.cpp.

Variable Documentation

◆ gFrame

MyFrame* gFrame
extern

Global instance.

Definition at line 165 of file ocpn_frame.cpp.