ZXWidgetsForm.h

Go to the documentation of this file.

 
/* **************************************************************************/
#ifndef ZXGUIFORM
#define ZXGUIFORM
 
#include <functional>
#include <string>
#include <vector>
#include <utility>
#include "zxecosystem/gui/widgets/ZXWidgetsBase.h"
#include "zxecosystem/gui/ZXWindows.h"
 
 
 
namespace zxeco
{
 
namespace gui
{
 
 
/*******************************************************************************
*
*   Template abstract base class: WidgetsForm
*
*******************************************************************************/
 
 
template <class Underlying>
class WidgetsForm
{
 public:
 
 
    using Callback = std::function< bool(void) >;
 
 
 
    WidgetsForm(const std::string & formname, Underlying & under): 
                                                            formname_{formname},
                                                            underlying_{under},
                                                            populated_{false} 
        {}
 
    WidgetsForm(const WidgetsForm &) = delete;
    WidgetsForm(WidgetsForm &&) = delete;
    WidgetsForm & operator=(const WidgetsForm &) = delete;
    WidgetsForm & operator=(WidgetsForm &&) = delete;
 
    virtual ~WidgetsForm(void) = default;
 
 
 
    virtual void populateGUI(zxeco::gui::Window::DepthFirstInserter & wins) = 0;
 
    virtual void fill(void) = 0;
    
    virtual void dump(void) = 0;
 
 
    zxeco::gui::ContainerWidget & mainContainer(void);
 
 
 protected:
 
    const std::string formname_;
    bool populated_; 
    Underlying & underlying_;
    zxeco::gui::ContainerWidget * cont_; 
    void checkIsPopulated(
                const std::string & place = "") const; 
    void checkIsUnpopulated(
                const std::string & place = "") const; 
};
 
 
/*******************************************************************************
*
*   Class: WidgetsFormBroker
*
*******************************************************************************/
 
 
class WidgetsFormBroker
{
 public:
 
    using Topic = int;
 
    using Handler = std::pair<Topic,size_t>;
 
 
    using Callback = std::function< bool(Topic, void *,
                                         Widget *, const Widget::EventData *) >;
 
 
 
    Handler subscribe(Topic topic, const Callback & cbck);
 
 
    bool produce(Topic topic, 
                 void * parms = nullptr,
                 Widget * w = nullptr, const Widget::EventData * ed = nullptr);
 
    std::string to_string(void) const;
 
 
 private:
 
    using TopicLink = std::pair<Topic,size_t>;
    using Callbacks = std::vector<Callback>;
 
    static bool comp(const TopicLink & t1, const TopicLink & t2) noexcept
        { return(t1.first < t2.first); }
 
    std::vector<TopicLink> topics_;
    std::vector<Callbacks> subscribed_;
 
    size_t findTopic(Topic topic) const;
};
 
 
 
/*============================================================================
 
    TEMPLATE IMPLEMENTATIONS
 
==============================================================================*/
 
 
/*******************************************************************************
*
*   Template abstract base class: WidgetsForm
*
*******************************************************************************/
 
template <class Underlying>
void WidgetsForm<Underlying>::checkIsPopulated(const std::string & place) const
{
    if (!populated_) RUNTIMEEXCEP("WidgetsForm '" + formname_ + 
                                  "' not populated. " +
                                  (place.empty() ? "" : place));
}
 
template <class Underlying>
void WidgetsForm<Underlying>::checkIsUnpopulated(const std::string & place) const
{
    if (populated_) RUNTIMEEXCEP("Cannot populate twice WidgetsForm '" +
                                 formname_ + "'. " +
                                 (place.empty() ? "" : place));
}
 
template <class Underlying>
zxeco::gui::ContainerWidget & WidgetsForm<Underlying>::mainContainer(void) 
{
    checkIsPopulated();
    return(*cont_);
}
 
 
 
} // end namespace gui
} // end namespace zxeco
 
#endif
 // ZXForm