OpenCPN Partial API docs
Loading...
Searching...
No Matches
GuiEvents Class Reference

EventVar exchange point, a singleton. More...

#include <gui_events.h>

Public Member Functions

 GuiEvents (const GuiEvents &)=delete
 
GuiEventsoperator= (const GuiEvents &)=delete
 

Static Public Member Functions

static GuiEventsGetInstance ()
 

Public Attributes

EventVar color_scheme_change
 Notified when the day/dusk/night color scheme changes.
 
EventVar gframe_update_status_bar
 Notified when the top level status bas should be updated by gFrame.
 
EventVar on_center_ais_target
 Notified with a shared_ptr<const AisTargetData> when gFrame should center the given AIS target.
 
EventVar on_dm_colors_change
 Notified without arguments when the global variables housing the Data Monitor user defined colors are updated.
 
EventVar on_routes_update
 Notified when list of routes is updated (no data in event)
 
EventVar on_waypoint_update
 Notified when waypoint(s) is updated (no data in event)
 
EventVar on_finalize_chartdbs
 Notified when chartdbs async operations complete, to reload charts.
 
EventVar options_on_finalize_chartdbs
 Notified when chartdbs async operations complete, to finalize settings.
 

Detailed Description

EventVar exchange point, a singleton.

Definition at line 30 of file gui_events.h.

Member Function Documentation

◆ GetInstance()

static GuiEvents & GuiEvents::GetInstance ( )
inlinestatic

Definition at line 32 of file gui_events.h.

Member Data Documentation

◆ color_scheme_change

EventVar GuiEvents::color_scheme_change

Notified when the day/dusk/night color scheme changes.

GetInt() returns a boolean "day" value, true if the new scheme uses dark text on light background.

Definition at line 45 of file gui_events.h.

◆ gframe_update_status_bar

EventVar GuiEvents::gframe_update_status_bar

Notified when the top level status bas should be updated by gFrame.

Definition at line 50 of file gui_events.h.

◆ on_center_ais_target

EventVar GuiEvents::on_center_ais_target

Notified with a shared_ptr<const AisTargetData> when gFrame should center the given AIS target.

Definition at line 56 of file gui_events.h.

◆ on_dm_colors_change

EventVar GuiEvents::on_dm_colors_change

Notified without arguments when the global variables housing the Data Monitor user defined colors are updated.

Definition at line 62 of file gui_events.h.

◆ on_finalize_chartdbs

EventVar GuiEvents::on_finalize_chartdbs

Notified when chartdbs async operations complete, to reload charts.

Definition at line 71 of file gui_events.h.

◆ on_routes_update

EventVar GuiEvents::on_routes_update

Notified when list of routes is updated (no data in event)

Definition at line 65 of file gui_events.h.

◆ on_waypoint_update

EventVar GuiEvents::on_waypoint_update

Notified when waypoint(s) is updated (no data in event)

Definition at line 68 of file gui_events.h.

◆ options_on_finalize_chartdbs

EventVar GuiEvents::options_on_finalize_chartdbs

Notified when chartdbs async operations complete, to finalize settings.

Definition at line 74 of file gui_events.h.


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