ObservableListener Class Reference

Keeps listening over its lifespan, removes itself on destruction. More...

#include <observable.h>

Public Member Functions
	ObservableListener ()
	Default constructor, does not listen to anything.
	ObservableListener (std::string k, wxEvtHandler *l, wxEventType e)
	Construct a listening object.
	ObservableListener (const KeyProvider &kp, wxEvtHandler *l, wxEventType e)
	ObservableListener (ObservableListener &&other) noexcept
	A listener can only be transferred using std::move().
ObservableListener &	operator= (ObservableListener &&other) noexcept
	A listener can only be transferred using std::move().
	ObservableListener (const ObservableListener &other)=delete
ObservableListener &	operator= (ObservableListener &)=delete
void	Listen (const std::string &key, wxEvtHandler *listener, wxEventType evt)
	Set object to send wxEventType ev to listener on changes in key.
void	Listen (const KeyProvider &kp, wxEvtHandler *l, wxEventType evt)
	Set object to send wxEventType ev to listener on changes in key.

Friends
class	ObsListener

Detailed Description

Keeps listening over its lifespan, removes itself on destruction.

Examples

/home/runner/work/main/main/opencpn/include/ocpn_plugin.h.

Definition at line 155 of file observable.h.

Constructor & Destructor Documentation

ObservableListener() [1/4]

ObservableListener::ObservableListener ( )

inline

Default constructor, does not listen to anything.

Definition at line 160 of file observable.h.

ObservableListener() [2/4]

ObservableListener::ObservableListener ( std::string  k, wxEvtHandler *  l, wxEventType  e  )

inline

Construct a listening object.

Definition at line 163 of file observable.h.

ObservableListener() [3/4]

ObservableListener::ObservableListener ( const KeyProvider &  kp, wxEvtHandler *  l, wxEventType  e  )

inline

Definition at line 168 of file observable.h.

ObservableListener() [4/4]

ObservableListener::ObservableListener ( ObservableListener &&  other )

inlinenoexcept

A listener can only be transferred using std::move().

Definition at line 172 of file observable.h.

~ObservableListener()

ObservableListener::~ObservableListener ( )

inline

Definition at line 193 of file observable.h.

Member Function Documentation

Listen() [1/2]

void ObservableListener::Listen ( const KeyProvider &  kp, wxEvtHandler *  l, wxEventType  evt  )

inline

Set object to send wxEventType ev to listener on changes in key.

Definition at line 199 of file observable.h.

Listen() [2/2]

void ObservableListener::Listen	(	const std::string &	key,
		wxEvtHandler *	listener,
		wxEventType	evt
	)

Set object to send wxEventType ev to listener on changes in key.

Definition at line 102 of file observable.cpp.

operator=()

ObservableListener & ObservableListener::operator= ( ObservableListener &&  other )

inlinenoexcept

A listener can only be transferred using std::move().

Definition at line 181 of file observable.h.

Friends And Related Symbol Documentation

ObsListener

friend class ObsListener

friend

Definition at line 156 of file observable.h.

---

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

• /home/runner/work/main/main/opencpn/libs/observable/include/observable.h
• /home/runner/work/main/main/opencpn/libs/observable/src/observable.cpp