gobservable.h

/*
 * File: gobservable.h
 * --------------------
 *
 * @author Marty Stepp
 * @version 2021/04/09
 * - added sgl namespace
 * @version 2021/04/03
 * - removed dependency on custom collections
 * @version 2018/09/08
 * - added doc comments for new documentation generation
 * @version 2018/08/23
 * - renamed to gobservable.h to replace Java version
 * @version 2018/07/11
 * - initial version
 */


#ifndef _gobservable_h
#define _gobservable_h

#include <functional>
#include <map>
#include <string>
#include <QtEvents>

#include "gevent.h"

namespace sgl {

class GInteractor;
class _Internal_QWidget;

class GObservable {
public:
    GObservable();

    virtual ~GObservable();

    virtual bool eventsEnabled() const;

    virtual string getType() const = 0;

    virtual void setEventsEnabled(bool eventsEnabled);

    virtual string toString() const;

protected:
    virtual void clearEventListeners();

    virtual void ensureThreadSafety(const string& memberName = "");

    virtual void fireEvent(GEvent& event);

    virtual void fireGEvent(QEvent* event, EventType eventType, const string& eventName);

    virtual void fireGEvent(QCloseEvent* event, EventType eventType, const string& eventName);

    virtual void fireGEvent(QKeyEvent* event, EventType eventType, const string& eventName);

    virtual void fireGEvent(QMouseEvent* event, EventType eventType, const string& eventName, const string& actionCommand = "");

    virtual void fireGEvent(QResizeEvent* event, EventType eventType, const string& eventName);

    virtual void fireGEvent(QTimerEvent* event, EventType eventType, const string& eventName);

    virtual void fireGEvent(QWheelEvent* event, EventType eventType, const string& eventName);

    virtual void fireGEvent(QWindowStateChangeEvent* event, EventType eventType, const string& eventName);

    virtual bool hasEventListener(const string& eventName) const;

    virtual bool isAcceptingEvent(int eventMask) const;

    virtual bool isAcceptingEvent(const GEvent& event) const;

    virtual bool isAcceptingEvent(const string& eventType) const;

    virtual void removeEventListener(const string& eventName);

    virtual void removeEventListeners(std::initializer_list<string> eventNames);

    virtual void setEventListener(const string& eventName, GEventListener func);

    virtual void setEventListener(const string& eventName, GEventListenerVoid func);

    virtual void setEventListeners(std::initializer_list<string> eventNames, GEventListener func);

    virtual void setEventListeners(std::initializer_list<string> eventNames, GEventListenerVoid func);

private:
    std::map<string, GEvent::EventListenerWrapper> _eventMap;
    bool _eventsEnabled;

    // allow all interactors and their inner QWidgets to call observable methods
    friend class GInteractor;
    friend class _Internal_QWidget;
};

} // namespace sgl

#endif // _gobservable_h