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
24#ifndef CONFIG_VARS_H__
25#define CONFIG_VARS_H__
26
27#include <vector>
28
29#include <wx/config.h>
30#include <wx/string.h>
31
32extern bool g_bAISRolloverShowClass;
33extern bool g_bAISRolloverShowCOG;
34extern bool g_bAISRolloverShowCPA;
35extern bool g_bAllowShipToActive;
36extern bool g_bAutoHideToolbar;
37extern bool g_bBasicMenus;
38extern bool g_bConfirmObjectDelete;
39extern bool g_bDebugCM93;
40extern bool g_bDebugOGL;
41extern bool g_benable_rotate;
42extern bool g_benableUDPNullHeader;
43extern bool g_bEnableZoomToCursor;
44extern bool g_bfilter_cogsog;
45extern bool g_bFullScreenQuilt;
46extern bool g_bGarminHostUpload;
47extern bool g_bInlandEcdis;
48extern bool g_bMagneticAPB;
49extern bool g_bOverruleScaMin;
50extern bool g_bPreserveScaleOnX;
51extern bool g_bresponsive;
52extern bool g_bRollover;
53extern bool g_bShowActiveRouteHighway;
54extern bool g_bShowChartBar;
55extern bool g_bShowCompassWin;
56extern bool g_bShowLiveETA;
57extern bool g_bShowMag;
58extern bool g_bShowMenuBar;
59extern bool g_bShowRouteTotal;
60extern bool g_bShowShipToActive;
61extern bool g_bShowTrackPointTime;
62extern bool g_bShowTrue;
63extern bool g_bShowWptName;
64extern bool g_bsimplifiedScalebar;
65extern bool g_bskew_comp;
66extern bool g_bsmoothpanzoom;
67extern bool g_bSpaceDropMark;
68extern bool g_btenhertz;
69extern bool g_btouch;
70extern bool g_bTrackDaily;
71extern bool g_bUserIconsFirst;
72extern bool g_bUseWptScaMin;
73extern bool g_bWayPointPreventDragging;
74extern bool g_bWplUsePosition;
75extern bool g_enable_root_menu_debug;
76extern bool g_persist_active_route;
77extern bool g_useMUI;
78
79extern bool g_always_send_rmb_rmc; // See extended docs below
80extern bool g_bAISRolloverShowClass;
81extern bool g_bAISRolloverShowCOG;
82extern bool g_bAISRolloverShowCPA;
83extern bool g_bAllowShipToActive;
84extern bool g_bAutoAnchorMar;
85extern bool g_bAutoAnchorMark;
86extern bool g_bAutoAnchorMark;
87extern bool g_bAutoHideToolbar;
88extern bool g_bBasicMenus;
89extern bool g_bConfirmObjectDelete;
90extern bool g_bCourseUp;
91extern bool g_bDebugCM93;
92extern bool g_bDisplayGrid;
93extern bool g_bEmailCrashReport;
94extern bool g_benable_rotate;
95extern bool g_benableUDPNullHeader;
96extern bool g_bEnableZoomToCursor;
97extern bool g_bfilter_cogsog;
98extern bool g_bframemax;
99extern bool g_bframemax;
100extern bool g_bFullscreen;
101extern bool g_bFullScreenQuilt;
102extern bool g_bFullscreenToolbar;
103extern bool g_bGarminHostUpload;
104extern bool g_bGLexpert;
105extern bool g_bHighliteTracks;
106extern bool g_bInlandEcdis;
107extern bool g_bLookAhead;
108extern bool g_bMagneticAPB;
109extern bool g_bopengl;
110extern bool g_bOverruleScaMin;
111extern bool g_bPermanentMOBIcon;
112extern bool g_bPlayShipsBell;
113extern bool g_bPlayShipsBells;
114extern bool g_bPreserveScaleOnX;
115extern bool g_bPreserveScaleOnX;
116extern bool g_bQuiltEnable;
117extern bool g_bQuiltStart; // Not used
118extern bool g_bresponsive;
119extern bool g_bShowActiveRouteHighway;
120extern bool g_bShowChartBar;
121extern bool g_bShowCompassWin;
122extern bool g_bShowDepthUnits;
123extern bool g_bShowDetailSlider;
124extern bool g_bShowDetailSlider;
125extern bool g_bShowLayers;
126extern bool g_bShowLiveETA;
127extern bool g_bShowLiveETA;
128extern bool g_bShowMag;
129extern bool g_bShowMenuBar;
130extern bool g_bShowOutlines;
131extern bool g_bShowRouteTotal;
132extern bool g_bShowStatusBar;
133extern bool g_bShowTrue;
134extern bool g_bShowWptName;
135extern bool g_bsimplifiedScalebar;
136extern bool g_bskew_comp;
137extern bool g_bskew_comp;
138extern bool g_bsmoothpanzoom; // see extended docs below
139extern bool g_bSoftwareGL;
140extern bool g_bSpaceDropMark;
141extern bool g_btouch;
142extern bool g_bTrackDaily;
143extern bool g_bUIexpert;
144extern bool g_bUseGLL;
145extern bool g_bUserIconsFirst;
146extern bool g_bUseWptScaMin;
147extern bool g_bWayPointPreventDragging;
148extern bool g_bWplUsePosition;
149extern bool g_config_display_size_manual;
150extern bool g_enable_root_menu_debug;
151extern bool g_own_ship_sog_cog_calc;
152extern bool g_persist_active_route;
153extern bool g_useMUI;
154extern bool s_bSetSystemTime;
155
156extern double g_COGAvg;
157extern double g_defaultBoatSpeed;
158extern double g_defaultBoatSpeed;
159extern double g_display_size_mm;
160extern double g_display_size_mm;
161extern double g_mouse_zoom_sensitivity;
162extern double g_n_arrival_circle_radius;
163extern double g_n_gps_antenna_offset_x;
164extern double g_n_gps_antenna_offset_x;
165extern double g_n_gps_antenna_offset_y;
166extern double g_n_gps_antenna_offset_y;
167extern double g_n_ownship_beam_meters;
168extern double g_n_ownship_beam_meters;
169extern double g_n_ownship_length_meters;
170extern double g_n_ownship_length_meters;
171extern double g_ownship_HDTpredictor_miles;
172extern double g_ownship_HDTpredictor_miles;
173extern double g_ownship_predictor_minutes;
174extern double g_ownship_predictor_minutes;
175extern double g_PlanSpeed;
176extern double g_plus_minus_zoom_factor;
177extern double g_TrackDeltaDistance;
178extern double g_TrackIntervalSeconds;
179extern double g_UserVar;
180extern double g_UserVar;
181
182extern float g_fNavAidRadarRingsStep;
183extern float g_fWaypointRangeRingsStep;
184extern float g_GLMinSymbolLineWidth;
185extern float g_selection_radius_mm;
186extern float g_selection_radius_touch_mm;
187extern float g_ShipScaleFactorExp;
188
189extern int g_ais_cog_predictor_width;
190extern int g_ChartScaleFactor;
191extern int g_chart_zoom_modifier_raster;
192extern int g_chart_zoom_modifier_vector;
193extern int g_cm93_zoom_factor;
194extern int g_COGAvgSec;
195extern int g_COGFilterSec;
196extern int g_cog_predictor_endmarker;
197extern int g_cog_predictor_style;
198extern int g_cog_predictor_width;
199extern int g_default_font_size;
200extern int g_detailslider_dialog_x;
201extern int g_detailslider_dialog_y;
202extern int g_ENCSoundingScaleFactor;
203extern int g_ENCTextScaleFactor;
204extern int g_GUIScaleFactor;
205extern int g_iDistanceFormat;
206extern int g_iENCToolbarPosX;
207extern int g_iENCToolbarPosY;
208extern int g_iNavAidRadarRingsNumberVisible;
209extern int g_iSDMMFormat;
210extern int g_iSoundDeviceIndex;
211extern int g_iSpeedFormat;
212extern int g_iTempFormat;
213extern int g_iWaypointRangeRingsNumber;
214extern int g_iWaypointRangeRingsStepUnits;
215extern int g_iWindSpeedFormat;
216extern int g_iWpt_ScaMin;
217extern int g_lastClientRecth;
218extern int g_lastClientRectw;
219extern int g_lastClientRectx;
220extern int g_lastClientRecty;
221extern int g_maintoolbar_x;
222extern int g_maintoolbar_y;
223extern int g_maxWPNameLength;
224extern int g_maxzoomin;
225extern int g_mbtilesMaxLayers;
226extern int g_memCacheLimit;
227extern int g_MemFootMB;
228extern int g_nAutoHideToolbar;
229extern int g_navobjbackups;
230extern int g_nAWDefault;
231extern int g_nAWMax;
232extern int g_nbrightness;
233extern int g_nCacheLimit;
234extern int g_nCOMPortCheck;
235extern int g_nDepthUnitDisplay;
236extern int g_netmask_bits;
237extern int g_nframewin_posx;
238extern int g_nframewin_posy;
239extern int g_nframewin_x;
240extern int g_nframewin_y;
241extern int g_NMEAAPBPrecision;
242extern int g_nNMEADebug;
243extern int g_n_ownship_min_mm;
244extern int g_nTrackPrecision;
245extern int g_ownship_HDTpredictor_endmarker;
246extern int g_ownship_HDTpredictor_style;
247extern int g_ownship_HDTpredictor_width;
248extern int g_OwnShipIconType;
249extern int g_own_ship_sog_cog_calc_damp_sec;
250extern int g_pNavAidRadarRingsStepUnits;
251extern int gps_watchdog_timeout_ticks;
252extern int g_restore_dbindex;
253extern int g_restore_stackindex;
254extern int g_route_line_width;
255extern int g_S57_dialog_sx;
256extern int g_S57_dialog_sy;
257extern int g_SENC_LOD_pixels;
258extern int g_ShipScaleFactor;
259extern int g_shipToActiveColor;
260extern int g_shipToActiveStyle;
261extern int g_SkewCompUpdatePeriod;
262extern int g_SOGFilterSec;
263extern int g_trackFilterMax;
264extern int g_track_line_width;
265extern int g_WplAction;
266extern int sat_watchdog_timeout_ticks;
267
268extern long g_maintoolbar_orient;
269
270extern unsigned g_canvasConfig;
271
272extern wxString g_active_route;
273extern wxString g_android_Device_Model;
274extern wxString g_AW1GUID;
275extern wxString g_AW2GUID;
276extern wxString g_catalog_channel;
277extern wxString g_catalog_custom_url;
278extern wxString g_compatOS;
279extern wxString g_compatOsVersion;
280extern wxString g_datetime_format; // See extended docs below
281extern wxString g_default_routepoint_icon;
282extern wxString g_default_wp_icon;
283extern wxString g_GPS_Ident;
284extern wxString g_gpx_path;
285extern wxString g_hostname;
286extern wxString g_SART_sound_file;
287extern wxString g_TalkerIdText;
288extern wxString g_winPluginDir; // Base plugin directory on Windows.
289extern wxString gWorldMapLocation;
290extern wxString gWorldShapefileLocation;
291extern wxString g_uploadConnection;
292extern wxString g_cog_predictor_color;
293extern wxString g_ownship_HDTpredictor_color;
294extern wxString g_CmdSoundString;
295extern wxString g_ObjQFileExt;
296extern wxString g_toolbarConfig;
297extern wxString g_locale;
298extern wxString g_localeOverride;
299extern wxString g_TCData_Dir;
300extern wxString g_toolbarConfig;
301extern wxString g_uiStyle; // Not used
302extern wxString g_uploadConnection;
303extern wxString g_UserPresLibData;
304extern wxString g_winPluginDir;
305extern wxString gWorldMapLocation;
306extern wxString gWorldShapefileLocation;
307
309extern std::vector<size_t> g_config_display_size_mm;
310
311extern unsigned g_canvasConfig;
312
313wxConfigBase* TheBaseConfig();
314void InitBaseConfig(wxConfigBase* cfg);
315
367#endif // CONFIG_VARS_H__
g_bsmoothpanzoom
bool g_bsmoothpanzoom
Controls how the chart panning and zooming smoothing is done during user interactions.
Definition config_vars.h:138
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:29
g_winPluginDir
wxString g_winPluginDir
Base plugin directory on Windows.
Definition config_vars.h:304
g_bRollover
bool g_bRollover
Enable/disable mouse rollover GUI effects.
Definition config_vars.cpp:65
g_COGAvg
double g_COGAvg
Debug only usage.
Definition config_vars.cpp:104
g_COGAvgSec
int g_COGAvgSec
COG average period for Course Up Mode (sec)
Definition config_vars.cpp:133
g_datetime_format
wxString g_datetime_format
Date/time format to use when formatting date/time strings.
Definition config_vars.cpp:218
g_config_display_size_mm
std::vector< size_t > g_config_display_size_mm
g_config_display_size_mm: Size of pysical screen in millimeters.
Definition config_vars.cpp:249
g_bDisplayGrid
bool g_bDisplayGrid
Should lat/lon grid be displayed ?
Definition config_vars.cpp:41
g_display_size_mm
double g_display_size_mm
Physical display width (mm)
Definition config_vars.h:160