OpenCPN Partial API docs
Loading...
Searching...
No Matches
config_vars.h
Go to the documentation of this file.
1/***************************************************************************
2 * Copyright (C) 2023 - 2025 Alec Leamas *
3 * *
4 * This program is free software; you can redistribute it and/or modify *
5 * it under the terms of the GNU General Public License as published by *
6 * the Free Software Foundation; either version 2 of the License, or *
7 * (at your option) any later version. *
8 * *
9 * This program is distributed in the hope that it will be useful, *
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of *
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
12 * GNU General Public License for more details. *
13 * *
14 * You should have received a copy of the GNU General Public License *
15 * along with this program; if not, see <https://www.gnu.org/licenses/>. *
16 **************************************************************************/
17
28#ifndef CONFIG_VARS_H__
29#define CONFIG_VARS_H__
30
31#include <string>
32#include <vector>
33
34#include <wx/config.h>
35#include <wx/string.h>
36
37extern bool g_allow_arb_system_plugin;
38extern bool g_always_send_rmb_rmc; // See extended docs below
39extern bool g_bAISRolloverShowClass;
40extern bool g_bAISRolloverShowCOG;
41extern bool g_bAISRolloverShowCPA;
42extern bool g_bAllowShipToActive;
43extern bool g_bAutoAnchorMar;
44extern bool g_bAutoAnchorMark;
45extern bool g_bAutoHideToolbar;
46extern bool g_bBasicMenus;
47extern bool g_bConfirmObjectDelete;
48extern bool g_bCourseUp;
49extern bool g_bDebugCM93;
50extern bool g_bDebugGPSD;
51extern bool g_bDebugOGL;
52extern bool g_bDebugS57;
53extern bool g_bDisplayGrid;
54extern bool g_bEmailCrashReport;
55extern bool g_benable_rotate;
56extern bool g_benableUDPNullHeader;
57extern bool g_bEnableZoomToCursor;
58extern bool g_bfilter_cogsog;
59extern bool g_bframemax;
60extern bool g_bFullscreen;
61extern bool g_bFullScreenQuilt;
62extern bool g_bFullscreenToolbar;
63extern bool g_bGarminHostUpload;
64extern bool g_bGDAL_Debug;
65extern bool g_bGLexpert;
66extern bool g_bHighliteTracks;
67extern bool g_bInlandEcdis;
68extern bool g_bLookAhead;
69extern bool g_bMagneticAPB;
70extern bool g_bNavAidRadarRingsShown;
71extern bool g_bopengl;
72extern bool g_bOverruleScaMin;
73extern bool g_bPermanentMOBIcon;
74extern bool g_bPlayShipsBell;
75extern bool g_bPlayShipsBells;
76extern bool g_bPreserveScaleOnX;
77extern bool g_bQuiltEnable;
78extern bool g_bQuiltStart; // Not used
79extern bool g_bresponsive;
80extern bool g_bRollover;
81extern bool g_bShowActiveRouteHighway;
82extern bool g_bShowChartBar;
83extern bool g_bShowCompassWin;
84extern bool g_bShowCurrent;
85extern bool g_bShowDepthUnits;
86extern bool g_bShowDetailSlider;
87extern bool g_bShowLayers;
88extern bool g_bShowLiveETA;
89extern bool g_bShowMag;
90extern bool g_bShowMenuBar;
91extern bool g_bShowMuiZoomButtons;
92extern bool g_bShowOutlines;
93extern bool g_bShowRouteTotal;
94extern bool g_bShowShipToActive;
95extern bool g_bShowStatusBar;
96extern bool g_bShowTide;
97extern bool g_bShowTrackPointTime;
98extern bool g_bShowTrue;
99extern bool g_bShowWptName;
100extern bool g_bsimplifiedScalebar;
101extern bool g_bskew_comp;
102extern bool g_bsmoothpanzoom;
103extern bool g_bsmoothpanzoom; // see extended docs below
104extern bool g_bSoftwareGL;
105extern bool g_bSpaceDropMark;
106extern bool g_btenhertz;
107extern bool g_btouch;
108extern bool g_btrackContinuous;
109extern bool g_bTrackDaily;
110extern bool g_bTransparentToolbar;
111extern bool g_bUIexpert;
112extern bool g_bUseGLL;
113extern bool g_bUseGreenShip;
114extern bool g_bUseOnlyConfirmedAISName;
115extern bool g_bUserIconsFirst;
116extern bool g_bUseWptScaMin;
117extern bool g_bWayPointPreventDragging;
118extern bool g_bWplUsePosition;
119extern bool g_config_display_size_manual;
120extern bool g_declutter_anchorage;
121extern bool g_enable_root_menu_debug;
122extern bool g_fog_overzoom;
123extern bool g_own_ship_sog_cog_calc;
124extern bool g_oz_vector_scale;
125extern bool g_persist_active_route;
126extern bool g_useMUI;
127extern bool s_bSetSystemTime;
128extern bool g_kiosk_startup;
129
130extern double g_COGAvg;
131extern double g_defaultBoatSpeed;
132extern double g_display_size_mm;
133extern double g_mouse_zoom_sensitivity;
134extern double g_n_arrival_circle_radius;
135extern double g_n_gps_antenna_offset_x;
136extern double g_n_gps_antenna_offset_y;
137extern double g_n_ownship_beam_meters;
138extern double g_n_ownship_length_meters;
139extern double g_overzoom_emphasis_base;
140extern double g_ownship_HDTpredictor_miles;
141extern double g_ownship_predictor_minutes;
142extern double g_PlanSpeed;
143extern double g_plus_minus_zoom_factor;
144extern double g_TrackDeltaDistance;
145extern double g_TrackIntervalSeconds;
146extern double g_UserVar;
147
148extern float g_fNavAidRadarRingsStep;
149extern float g_fWaypointRangeRingsStep;
150extern float g_GLMinSymbolLineWidth;
151extern float g_MarkScaleFactorExp;
152extern float g_selection_radius_mm;
153extern float g_selection_radius_touch_mm;
154extern float g_ShipScaleFactorExp;
155
156extern int g_ais_cog_predictor_width;
157extern int g_AndroidVersionCode;
158extern int g_BSBImgDebug;
159extern int g_ChartScaleFactor;
160extern int g_chart_zoom_modifier_raster;
161extern int g_chart_zoom_modifier_vector;
162extern int g_cm93_zoom_factor;
163extern int g_COGAvgSec;
164extern int g_COGFilterSec;
165extern int g_cog_predictor_endmarker;
166extern int g_cog_predictor_style;
167extern int g_cog_predictor_width;
168extern int g_default_font_size;
169extern int g_detailslider_dialog_x;
170extern int g_detailslider_dialog_y;
171extern int g_ENCSoundingScaleFactor;
172extern int g_ENCTextScaleFactor;
173extern int g_GUIScaleFactor;
174
175extern int g_iDistanceFormat; // see extended docs below
176extern int g_iENCToolbarPosX;
177extern int g_iENCToolbarPosY;
178extern int g_iHeightFormat; // see extended docs below
179extern int g_iNavAidRadarRingsNumberVisible;
180extern int g_iSDMMFormat;
181extern int g_iSoundDeviceIndex;
182
183extern int g_iSpeedFormat; // See extended docs below
184extern int g_iTempFormat; // See extended docs below
185extern int g_iWaypointRangeRingsNumber;
186extern int g_iWaypointRangeRingsStepUnits;
187extern int g_iWindSpeedFormat;
188extern int g_iWpt_ScaMin;
189extern int g_lastClientRecth;
190extern int g_lastClientRectw;
191extern int g_lastClientRectx;
192extern int g_lastClientRecty;
193extern int g_maintoolbar_x;
194extern int g_maintoolbar_y;
195extern int g_maxWPNameLength;
196extern int g_maxzoomin;
197extern int g_mbtilesMaxLayers;
198extern int g_memCacheLimit;
199extern int g_MemFootMB;
200extern int g_mouse_zoom_sensitivity_ui;
201extern int g_nAutoHideToolbar;
202extern int g_navobjbackups;
203extern int g_nAWDefault;
204extern int g_nAWMax;
205extern int g_nbrightness;
206extern int g_nCacheLimit;
207extern int g_nCOMPortCheck;
208extern int g_nCPUCount;
209extern int g_nDepthUnitDisplay; // see extended docs below
210extern int g_netmask_bits;
211extern int g_nframewin_posx;
212extern int g_nframewin_posy;
213extern int g_nframewin_x;
214extern int g_nframewin_y;
215extern int g_NMEAAPBPrecision;
216extern int g_nNMEADebug;
217extern int g_n_ownship_min_mm;
218extern int g_nTrackPrecision;
219extern int g_ownship_HDTpredictor_endmarker;
220extern int g_ownship_HDTpredictor_style;
221extern int g_ownship_HDTpredictor_width;
222extern int g_OwnShipIconType;
223extern int g_own_ship_sog_cog_calc_damp_sec;
224extern int g_pNavAidRadarRingsStepUnits;
225extern int gps_watchdog_timeout_ticks;
226extern int g_restore_dbindex;
227extern int g_restore_stackindex;
228extern int g_route_line_width;
229extern int g_route_prop_sx;
230extern int g_route_prop_sy;
231extern int g_route_prop_x;
232extern int g_route_prop_y;
233extern int g_S57_dialog_sx;
234extern int g_S57_dialog_sy;
235extern int g_S57_extradialog_sx;
236extern int g_S57_extradialog_sy;
237extern int g_SENC_LOD_pixels;
238extern int g_ShipScaleFactor;
239extern int g_shipToActiveColor;
240extern int g_shipToActiveStyle;
241extern int g_SkewCompUpdatePeriod;
242extern int g_SOGFilterSec;
243extern int g_tcwin_scale;
244extern int g_trackFilterMax;
245extern int g_track_line_width;
246extern int g_WplAction;
247extern int n_NavMessageShown;
248extern int sat_watchdog_timeout_ticks;
249
250extern long g_maintoolbar_orient;
251
252extern std::vector<std::string> TideCurrentDataSet;
253extern unsigned g_canvasConfig;
254
255extern wxString g_active_route;
256extern wxString g_android_Device_Model;
257extern wxString g_AW1GUID;
258extern wxString g_AW2GUID;
259extern wxString g_catalog_channel;
260extern wxString g_catalog_custom_url;
261extern wxString g_CmdSoundString;
262extern wxString g_cog_predictor_color;
263extern wxString g_compatOS;
264extern wxString g_compatOsVersion;
265extern wxString g_config_version_string;
266extern wxString g_datetime_format;
267extern wxString g_datetime_format; // See extended docs below
268extern wxString g_default_font_facename; // See extended docs below
269extern wxString g_default_routepoint_icon;
270extern wxString g_default_wp_icon;
271extern wxString g_GPS_Ident;
272extern wxString g_gpx_path;
273extern wxString g_hostname;
274extern wxString g_InvisibleLayer;
275extern wxString g_InvisibleLayers;
276extern wxString g_InVisiNameinLayers;
277extern wxString g_lastAppliedTemplateGUID;
278extern wxString g_locale;
279extern wxString g_localeOverride;
280extern wxString g_ObjQFileExt;
281extern wxString g_ownship_HDTpredictor_color;
282extern wxString g_SART_sound_file;
283extern wxString g_TalkerIdText;
284extern wxString g_TCData_Dir;
285extern wxString g_toolbarConfig;
286extern wxString g_uiStyle; // Not used
287extern wxString g_uploadConnection;
288extern wxString g_UserPresLibData;
289extern wxString g_VisibleLayers;
290extern wxString g_VisiNameinLayers;
291extern wxString g_winPluginDir;
292extern wxString gWorldMapLocation;
293extern wxString gWorldShapefileLocation;
294
296extern std::vector<size_t> g_config_display_size_mm;
297
298wxConfigBase* TheBaseConfig();
299void InitBaseConfig(wxConfigBase* cfg);
300
419#endif // CONFIG_VARS_H__
g_iTempFormat
int g_iTempFormat
User-selected temperature unit format for display and input.
Definition config_vars.cpp:173
g_bsmoothpanzoom
bool g_bsmoothpanzoom
Controls how the chart panning and zooming smoothing is done during user interactions.
Definition config_vars.h:103
g_iHeightFormat
int g_iHeightFormat
User-selected height (vertical, above reference datum) unit format for display and input.
Definition config_vars.cpp:168
g_always_send_rmb_rmc
bool g_always_send_rmb_rmc
Always send RMB and RMC n0183 messages even if there is no active route.
Definition config_vars.cpp:31
g_nDepthUnitDisplay
int g_nDepthUnitDisplay
User-selected depth (below surface) unit format for display and input.
Definition config_vars.cpp:198
g_winPluginDir
wxString g_winPluginDir
Base plugin directory on Windows.
Definition config_vars.cpp:278
g_bRollover
bool g_bRollover
Enable/disable mouse rollover GUI effects.
Definition config_vars.cpp:71
g_bShowTide
bool g_bShowTide
not used
Definition config_vars.cpp:87
g_iSpeedFormat
int g_iSpeedFormat
User-selected speed unit format for display and input.
Definition config_vars.cpp:172
g_COGAvg
double g_COGAvg
Debug only usage.
Definition config_vars.cpp:121
g_COGAvgSec
int g_COGAvgSec
COG average period for Course Up Mode (sec)
Definition config_vars.cpp:154
g_default_font_facename
wxString g_default_font_facename
Default font size for user interface elements such as menus, dialogs, etc.
Definition config_vars.cpp:256
g_iDistanceFormat
int g_iDistanceFormat
User-selected distance (horizontal) unit format for display and input.
Definition config_vars.cpp:165
g_datetime_format
wxString g_datetime_format
Date/time format to use when formatting date/time strings.
Definition config_vars.h:267
g_config_display_size_mm
std::vector< size_t > g_config_display_size_mm
Size of pysical screen in millimeters.
Definition config_vars.cpp:290
g_bDisplayGrid
bool g_bDisplayGrid
Should lat/lon grid be displayed ?
Definition config_vars.cpp:45
g_display_size_mm
double g_display_size_mm
Physical display width (mm)
Definition config_vars.cpp:123