OpenCPN Partial API docs
Observable Class Reference

The observable notify/listen basic nuts and bolts. More...

#include <observable.h>

Inheritance diagram for Observable:
KeyProvider ConfigVar< T > EventVar GlobalVar< T >

Public Member Functions

 Observable (const std::string &_key)
 
 Observable (const KeyProvider &kp)
 
virtual const void Notify ()
 Notify all listeners about variable change.
 
const void Notify (std::shared_ptr< const void > p)
 
bool Unlisten (wxEvtHandler *listener, wxEventType ev)
 Remove window listening to ev from list of listeners. More...
 
std::string GetKey () const
 

Public Attributes

const std::string key
 The key used to create and clone.
 

Protected Member Functions

const void Notify (std::shared_ptr< const void > ptr, const std::string &s, int num, void *client_data)
 Notify all listeners: send them a 'type' ObservedEvt message as defined by listen() with optional data available using GetString() and/or GetClientData().
 
const void Notify (const std::string &s, void *client_data)
 

Friends

class ObservableListener
 

Detailed Description

The observable notify/listen basic nuts and bolts.


Definition at line 82 of file observable.h.

Member Function Documentation

◆ Unlisten()

bool Observable::Unlisten ( wxEvtHandler *  listener,
wxEventType  ev 
)

Remove window listening to ev from list of listeners.

Returns
true if such a listener existed, else false.

Definition at line 67 of file observable.cpp.


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