ConfigVar< T > Class Template Reference

Wrapper for configuration variables which lives in a wxBaseConfig object. More...

#include <observable_confvar.h>

Inheritance diagram for ConfigVar< T >:

Public Member Functions
	ConfigVar (const std::string &section_, const std::string &key_, wxConfigBase *cb)
void	Set (const T &arg)
const T	Get (const T &default_val)
Public Member Functions inherited from Observable
	Observable (const std::string &_key)
	Observable (const KeyProvider &kp)
	~Observable () override=default
	Destroy the Observable object.
virtual void	Notify ()
	Notify all listeners about variable change.
void	Notify (const std::shared_ptr< const void > &p)
bool	Unlisten (wxEvtHandler *listener, wxEventType ev)
	Remove window listening to ev from list of listeners.
std::string	GetKey () const override
	Get the Key object from the Key Provider.
Public Member Functions inherited from KeyProvider
virtual	~KeyProvider ()=default
	Destroy the Key Provider object.

Additional Inherited Members
Public Attributes inherited from Observable
const std::string	key
	The key used to create and clone.
Protected Member Functions inherited from Observable
void	Notify (const 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().
void	Notify (const std::string &s, void *client_data)

Detailed Description

template<typename T = std::string>
class ConfigVar< T >

Wrapper for configuration variables which lives in a wxBaseConfig object.

Supports int, bool, double, std::string and wxString. Besides basic set()/get() also provides notification events when value changes.

Client usage when reading, setting a value and notifying listeners:

ConfigVar<bool> expert("/PlugIns", "CatalogExpert", &g_pConfig);
bool old_value = expert.Get(false);
expert.Set(false);

Client usage, listening to value changes.

class Foo: public wxEventHandler {
public:
  Foo(...) {
    ConfigVar<bool> expert("/PlugIns", "CatalogExpert", &g_pConfig);
    auto action = [](wxCommandEvent&) { cout << "value has changed"; });
    expert_listener.Init(expert, action);
    ...
  }
private:
  ObsListener expert_listener;
  ...
}

Definition at line 69 of file observable_confvar.h.

Constructor & Destructor Documentation

ConfigVar()

template<typename T >

ConfigVar< T >::ConfigVar	(	const std::string &	section_,
		const std::string &	key_,
		wxConfigBase *	cb
	)

Definition at line 47 of file observable_confvar.cpp.

Member Function Documentation

Get()

template<typename T >

const T ConfigVar< T >::Get

(

const T &

default_val

)

Definition at line 55 of file observable_confvar.cpp.

Set()

template<typename T >

void ConfigVar< T >::Set

(

const T &

arg

)

Definition at line 66 of file observable_confvar.cpp.

---

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

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