OpenCPN Partial API docs
Loading...
Searching...
No Matches
mark_info.h
Go to the documentation of this file.
1/**************************************************************************
2 * Copyright (C) 2010 by David S. Register *
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 _MARKINFO_H_
25#define _MARKINFO_H_
26
27#include <memory>
28
32#include <wx/bmpcbox.h>
33#include <wx/choice.h>
34#include <wx/clrpicker.h>
35#include <wx/combobox.h>
36#include <wx/datectrl.h>
37#include <wx/dateevt.h>
38#include <wx/dialog.h>
39#include <wx/filesys.h>
40#include <wx/gbsizer.h>
41#include <wx/htmllbox.h>
42#include <wx/hyperlink.h> // toh, 2009.02.08
43#include <wx/listctrl.h>
44#include <wx/list.h>
45#include <wx/notebook.h>
46#include <wx/odcombo.h>
47#include <wx/spinctrl.h>
48#include <wx/tglbtn.h>
49#include <wx/timectrl.h>
50
51#include "model/hyperlink.h"
52#include "model/route.h"
53
54#include "field_text.h"
55#include "form_grid.h"
56#include "link_prop_dlg.h"
57#include "ocpn_frame.h" //FIXME (dave ) // for ColorScheme
58#include "ocpn_platform.h"
59#include "route_validator.h"
60#include "tcmgr.h"
61
62#ifdef __WXGTK__
63// wxTimePickerCtrl is completely broken in Gnome based desktop environments as
64// of wxGTK 3.0
65#include "time_textbox.h"
66#endif
67
68class MarkInfoDlg; // forward
71#ifdef __WXOSX__
72#define DIALOG_PARENT wxFrame
73#else
74#define DIALOG_PARENT wxDialog
75#endif
76
77#define ID_WPT_RANGERINGS_NO 7507
78#define ID_RCLK_MENU_COPY_TEXT 7013
79#define ID_RCLK_MENU_DELETE 7015
80#define ID_RCLK_MENU_COPY 7016
81#define ID_RCLK_MENU_COPY_LL 7017
82#define ID_RCLK_MENU_PASTE 7018
83#define ID_RCLK_MENU_PASTE_LL 7019
84#define ID_RCLK_MENU_DELETE_LINK 7023
85#define ID_RCLK_MENU_EDIT_LINK 7024
86#define ID_RCLK_MENU_ADD_LINK 7025
87
93
94#define ID_MARKPROP 8000
95#define SYMBOL_MARKPROP_STYLE \
96 wxCAPTION | wxRESIZE_BORDER | wxSYSTEM_MENU | wxCLOSE_BOX
97#define SYMBOL_MARKPROP_TITLE _("Waypoint Properties")
98#define SYMBOL_MARKPROP_IDNAME ID_MARKPROP
99#define SYMBOL_MARKPROP_SIZE wxSize(200, 300)
100#define SYMBOL_MARKPROP_POSITION wxDefaultPosition
101#define ID_MARKPROP_CANCEL 8001
102#define ID_MARKPROP_OK 8002
103#define ID_ICONCTRL 8003
104#define ID_LATCTRL 8004
105#define ID_LONCTRL 8005
106#define ID_SHOWNAMECHECKBOXBASIC 8006
107#define ID_BITMAPCOMBOCTRL 8007
108#define ID_NAMECTRL 8008
109#define wxID_HTMLLIST 8009
110#define ID_DESCR_CTR_DESC 8010
111#define ID_DESCR_CTR_BASIC 8011
112#define ID_BTN_DESC_BASIC 8012
113#define ID_ETA_DATEPICKERCTRL 8013
114#define ID_ETA_TIMEPICKERCTRL 8014
115#define ID_SHOWNAMECHECKBOX_EXT 8015
116#define ID_CHECKBOX_VIS_EXT 8016
117#define ID_CHECKBOX_SCAMIN_VIS 8017
118#define ID_SET_DEFAULT_ICON 8018
119#define ID_SET_DEFAULT_RANGERINGS 8019
120#define ID_SET_DEFAULT_ARRIVALRADIUS 8020
121#define ID_SET_DEFAULT_SCAMIN 8021
122#define ID_SET_DEFAULT_NAMEVIS 8022
123#define ID_SET_DEFAULT_ALL 8023
124#define ID_BTN_LINK_MENU 8024
125#define ID_DEFAULT 8025
126#define ID_BTN_SHOW_TIDES 8026
127
129
134#ifndef wxCLOSE_BOX
135#define wxCLOSE_BOX 0x1000
136#endif
137#ifndef wxFIXED_MINSIZE
138#define wxFIXED_MINSIZE 0
139#endif
140
141class OCPNIconCombo; // forward
142class SaveDefaultsDialog; // forward
143
144WX_DECLARE_OBJARRAY(wxBitmap, ArrayOfBitmaps);
145
151class OCPNIconCombo : public wxOwnerDrawnComboBox {
152public:
153 OCPNIconCombo(wxWindow* parent, wxWindowID id, const wxString& value = "",
154 const wxPoint& pos = wxDefaultPosition,
155 const wxSize& size = wxDefaultSize, int n = 0,
156 const wxString choices[] = NULL, long style = 0,
157 const wxValidator& validator = wxDefaultValidator,
158 const wxString& name = "OCPNIconCombo");
159
161
162 void OnDrawItem(wxDC& dc, const wxRect& rect, int item, int flags) const;
163 wxCoord OnMeasureItem(size_t item) const;
164 wxCoord OnMeasureItemWidth(size_t item) const;
165
166 int Append(const wxString& item, wxBitmap bmp);
167 void Clear();
168
169private:
170 int itemHeight;
171 ArrayOfBitmaps bmpArray;
172};
173
174// LatLonTextCtrl Specification
175// We need a derived wxText control for lat/lon input in the MarkProp dialog
176// Specifically, we need to catch loss-of-focus events and signal the parent
177// dialog to update the mark's lat/lon dynamically.
178
179// DECLARE_EVENT_TYPE(EVT_LLCHANGE, -1)
180extern /*expdecl*/ const wxEventType EVT_LLCHANGE;
181
182class LatLonTextCtrl : public wxTextCtrl {
183 DECLARE_EVENT_TABLE()
184
185public:
186 LatLonTextCtrl(wxWindow* parent, wxWindowID id, const wxString& value = "",
187 const wxPoint& pos = wxDefaultPosition,
188 const wxSize& size = wxDefaultSize, long style = 0,
189 const wxValidator& validator = wxDefaultValidator,
190 const wxString& name = wxTextCtrlNameStr);
191
192 void OnKillFocus(wxFocusEvent& event);
193
194 wxEvtHandler* m_pParentEventHandler;
195};
196
203class MarkInfoDlg : public DIALOG_PARENT {
204 DECLARE_EVENT_TABLE()
205 friend class SaveDefaultsDialog;
206
207private:
228 RoutePoint* m_pRoutePoint;
229 static bool instanceFlag;
230 int i_htmlList_item;
231
232 bool m_bShowName_save;
233 wxString m_Name_save;
234 wxString m_IconName_save;
235 int m_current_icon_Index;
236 double m_lat_save;
237 double m_lon_save;
238 wxString m_Description_save;
239 HyperlinkList* m_pMyLinkList;
240 bool m_bIsVisible_save;
241 bool m_bUseScaMin_save;
242 int m_iScaminVal_save;
243 bool m_bShowWaypointRangeRings_save;
244 int m_iWaypointRangeRingsNumber_save;
245 float m_fWaypointRangeRingsStep_save;
246 wxColour m_wxcWaypointRangeRingsColour_save;
247 double m_WaypointArrivalRadius_save;
248 float m_PlannedSpeed_save;
249 wxDateTime m_ArrETA_save;
250 std::map<double, const IDX_entry*> m_tss;
251 wxString m_lasttspos;
252
253protected:
254 OCPNIconCombo* m_bcomboBoxIcon;
255 wxBoxSizer* bSizerBasicProperties;
256 wxBoxSizer* bSizerLinks;
257 wxButton* m_buttonOkay;
258 wxButton* m_buttonExtDescription;
259 wxButton* m_buttonLinksMenu;
260 wxBitmapButton* m_buttonShowTides;
261 wxButton* DefaultsBtn;
262 wxCheckBox* m_checkBoxScaMin;
263 wxCheckBox* m_checkBoxShowName;
264 wxCheckBox* m_checkBoxShowNameExt;
265 wxCheckBox* m_checkBoxVisible;
266 wxChoice* m_choiceWaypointRangeRingsUnits;
267 wxColourPickerCtrl* m_PickColor;
285 wxCheckBox* m_cbEtdPresent;
286 wxBoxSizer* bMainSizer;
287 FormGrid* fSizerBasicProperties;
288 wxFlexGridSizer* waypointradarGrid;
289 wxFlexGridSizer* waypointrrSelect;
290 wxGridBagSizer* bGB_SizerProperties;
291 wxFlexGridSizer* gbSizerInnerProperties;
292 wxNotebook* m_notebookProperties;
293 wxObject* m_contextObject;
294 wxScrolledWindow* m_panelBasicProperties;
295 wxPanel* m_panelDescription;
296 wxScrolledWindow* m_panelExtendedProperties;
297 wxSimpleHtmlListBox* m_htmlList;
298 wxSize m_defaultClientSize;
299 wxChoice* m_ChoiceWaypointRangeRingsNumber;
300 wxStaticBitmap* m_bitmapIcon;
301 wxStaticBoxSizer* sbS_Description;
302 wxStaticBoxSizer* sbSizerExtProperties;
303 wxStaticBoxSizer* sbSizerLinks;
304 wxStaticBoxSizer* sbSizerBasicProperties;
305 wxStaticBoxSizer* sbRangeRingsExtProperties;
306 wxStaticBoxSizer* sbSizerDescription;
307 wxStaticText* m_staticTextArrivalRadius;
308 wxStaticText* m_staticTextDescription;
309 wxStaticText* m_staticTextEditEnabled;
310 wxStaticText* m_staticTextGpx;
311 wxStaticText* m_staticTextGuid;
312 wxStaticText* m_staticTextTideStation;
313 wxStaticText* m_staticTextIcon;
314 wxStaticText* m_staticTextLatitude;
315 wxStaticText* m_staticTextLayer;
316 wxStaticText* m_staticTextLongitude;
317 wxStaticText* m_staticTextName;
318 wxStaticText* m_staticTextScaMin;
319 wxStaticText* m_staticTextShowNameExt;
320 wxStaticText* m_staticTextRR1;
321 wxStaticText* m_staticTextRR2;
322 wxChoice* m_RangeRingUnits;
323 wxStaticText* m_staticTextRR4;
324 wxStaticText* m_staticTextArrivalUnits;
325 wxStaticText* m_staticTextPlSpeed;
327 wxStaticText* m_staticTextEtd;
328 wxStaticText* m_staticTextPlSpeedUnits;
329 wxStdDialogButtonSizer* m_sdbSizerButtons;
330 wxTextCtrl* m_textArrivalRadius;
331 wxTextCtrl* m_textCtrlExtDescription;
332 wxTextCtrl* m_textCtrlGpx;
333 wxTextCtrl* m_textCtrlGuid;
334 wxScrolledWindow* m_scrolledWindowLinks;
335 wxHyperlinkCtrl* m_hyperlink17;
336 wxMenu* m_menuLink;
337 wxToggleButton* m_toggleBtnEdit;
338 wxButton* m_buttonAddLink;
339
340#ifdef __ANDROID__
341 wxChoice* m_comboBoxTideStation;
342#else
343 wxComboBox* m_comboBoxTideStation;
344#endif
345 wxTextCtrl* m_textDescription;
346 wxTextCtrl* m_textLatitude;
347 wxTextCtrl* m_textLongitude;
348 TextField* m_textName;
349 std::unique_ptr<RoutePointNameValidator> m_name_validator;
350 wxTextCtrl* m_textScaMin;
351 wxTextCtrl* m_textWaypointRangeRingsStep;
360 wxTextCtrl* m_textCtrlPlSpeed;
361 wxBitmap _img_MUI_settings_svg;
362 wxButton* m_sdbSizerButtonsCancel;
363 wxButton* m_sdbSizerButtonsOK;
364
372 wxDatePickerCtrl* m_EtdDatePickerCtrl;
373#ifdef __WXGTK__
375#else
383 wxTimePickerCtrl* m_EtdTimePickerCtrl;
384#endif
385 wxArrayString m_choiceTideChoices;
386 wxBitmap m_bmTide;
387 int m_sizeMetric;
388 wxHyperlinkCtrl* m_pEditedLink;
389
390 void initialize_images();
391 void OnBitmapCombClick(wxCommandEvent& event);
392 void OnPositionCtlUpdated(wxCommandEvent& event);
393 void OnFocusEvent(wxFocusEvent& event);
394 void OnExtDescriptionClick(wxCommandEvent& event);
395 void OnDescChangedExt(wxCommandEvent& event);
396 void OnDescChangedBasic(wxCommandEvent& event);
397 void OnMarkInfoCancelClick(wxCommandEvent& event);
398 void OnMarkInfoOKClick(wxCommandEvent& event);
399 void OnShowWaypointNameSelectBasic(wxCommandEvent& event);
400 void OnShowWaypointNameSelectExt(wxCommandEvent& event);
401 void OnSelectScaMinExt(wxCommandEvent& event);
402 void OnWptRangeRingsNoChange(wxCommandEvent& event);
403 void OnCopyPasteLatLon(wxCommandEvent& event);
404 void OnWaypointRangeRingSelect(wxCommandEvent& event);
405 void m_htmlListContextMenuBtn(wxCommandEvent& event);
406 void m_htmlListContextMenu(wxMouseEvent& event);
407 void OnRightClickLatLon(wxCommandEvent& event);
408 void OnHtmlLinkClicked(wxHtmlLinkEvent& event);
409 void OnHyperLinkClick(wxHyperlinkEvent& event);
410 void OnLayoutResize(wxCommandEvent& event);
411
412 void On_html_link_popupmenu_Click(wxCommandEvent& event);
413 void DefautlBtnClicked(wxCommandEvent& event);
414 void OnNotebookPageChanged(wxNotebookEvent& event);
415 void OnTimeChanged(wxDateEvent& event) { m_cbEtdPresent->SetValue(true); }
416 void OnTideStationCombobox(wxCommandEvent& event);
417 void OnClose(wxCloseEvent& event);
418 void ShowTidesBtnClicked(wxCommandEvent& event);
419 void OnAddLink(wxCommandEvent& event);
420
421public:
422 MarkInfoDlg(wxWindow* parent, wxWindowID id = wxID_ANY,
423 const wxString& title = _("Waypoint Properties"),
424 const wxPoint& pos = wxDefaultPosition,
425 const wxSize& size = wxSize(-1, -1),
426 long style = FRAME_WITH_LINKS_STYLE);
427 ~MarkInfoDlg();
428 void Create();
429 void InitialFocus();
430 void RecalculateSize();
431 RoutePoint* GetRoutePoint() { return m_pRoutePoint; }
432 void SetColorScheme(ColorScheme cs);
433 void SetRoutePoint(RoutePoint* pRP);
434 void ClearData();
435 void SetBulkEdit(bool bBulkEdit);
436 void UpdateHtmlList();
437 void SetDialogTitle(const wxString& title) { SetTitle(title); }
438 bool UpdateProperties(bool positionOnly = false);
439 void ValidateMark();
440 bool SaveChanges();
441 void OnActivate(wxActivateEvent& event);
442
443 wxSimpleHtmlListBox* GetSimpleBox() {
444 return dynamic_cast<wxSimpleHtmlListBox*>(m_htmlList);
445 }
446 void OnHtmlCellClicked(wxHtmlCellEvent& event);
447
448 SaveDefaultsDialog* m_SaveDefaultDlg;
449};
450
456class SaveDefaultsDialog : public wxDialog {
457 friend class MarkInfoDlg;
458
459protected:
460 //(*Declarations(SaveDefaultsDialog)
461 wxCheckBox* RangRingsCB;
462 wxCheckBox* ArrivalRCB;
463 wxCheckBox* IconCB;
464 wxCheckBox* NameCB;
465 wxCheckBox* ScaleCB;
466 wxStaticText* stRR;
467 wxStaticText* stArrivalR;
468 wxStaticText* stIcon;
469 wxStaticText* stName;
470 wxStaticText* stScale;
471 wxStaticText* StaticText1;
472 //*)
473
474public:
476};
477
478#endif // _MARKINFO_H_
Grid layout with 2 columns for form labels and fields.
Definition form_grid.h:28
Dialog for displaying and editing waypoint properties.
Definition mark_info.h:203
wxDatePickerCtrl * m_EtdDatePickerCtrl
Date picker control for setting the Estimated Time of Departure (ETD).
Definition mark_info.h:372
wxStaticText * m_staticTextEtd
Label for the Estimated Time of Departure field.
Definition mark_info.h:327
wxCheckBox * m_cbEtdPresent
Checkbox control that enables/disables manual ETD setting for a waypoint.
Definition mark_info.h:285
wxTextCtrl * m_textCtrlPlSpeed
Text control for waypoint planned speed.
Definition mark_info.h:360
wxTimePickerCtrl * m_EtdTimePickerCtrl
Time picker control for setting the Estimated Time of Departure (ETD).
Definition mark_info.h:383
Custom combobox for selecting waypoint icons.
Definition mark_info.h:151
Represents a waypoint or mark within the navigation system.
Definition route_point.h:71
Dialog for saving default waypoint properties.
Definition mark_info.h:456
Text field with validator and error handler.
Definition field_text.h:38
Text field classes and text validator base classes.
MarkInfoDlg * g_pMarkInfoDialog
global instance
Definition mark_info.cpp:76
const wxEventType EVT_LLCHANGE
OpenCPN top window.
OpenCPN Platform specific support utilities.
Route abstraction.
Route dialog validation checks.
Tide and Current Manager @TODO Add original author copyright.
Time textbox to replace broken wxTimePickerCtrl on wxGTK.