GenericMenuItem.hpp

Go to the documentation of this file.

/*
 * This file is part of the DUDS project. It is subject to the BSD-style
 * license terms in the LICENSE file found in the top-level directory of this
 * distribution and at https://github.com/jjackowski/duds/blob/master/LICENSE.
 * No part of DUDS, including this file, may be copied, modified, propagated,
 * or distributed except according to the terms contained in the LICENSE file.
 *
 * Copyright (C) 2019  Jeff Jackowski
 */
#ifndef GENERICMENUITEM_HPP
#define GENERICMENUITEM_HPP

#include <duds/ui/menu/MenuItem.hpp>
#include <boost/signals2/signal.hpp>

namespace duds { namespace ui { namespace menu {

class GenericMenuItem : public MenuItem {
public:
    typedef boost::signals2::signal<
        void(
            MenuView &invokingView,
            const MenuAccess &access,
            GenericMenuItem &self
        )
    > Signal;
private:
    Signal choseSig;
    Signal selSig;
    Signal deselSig;
public:
    GenericMenuItem(
        MenuItemToken,
        const std::string &label,
        Flags flags = Flags::Zero()
    ) : MenuItem(MenuItemToken(), label, flags) { }
    GenericMenuItem(
        MenuItemToken,
        const std::string &label,
        const std::string &description,
        Flags flags = Flags::Zero()
    ) : MenuItem(MenuItemToken(), label, description, flags) { }
    GenericMenuItem(
        MenuItemToken,
        const std::string &label,
        const std::string &description,
        const std::string &value,
        Flags flags = Flags::Zero()
    ) : MenuItem(MenuItemToken(), label, description, value, flags) { }
    static std::shared_ptr<GenericMenuItem> make(
        const std::string &label,
        Flags flags = Flags::Zero()
    ) {
        return std::make_shared<GenericMenuItem>(MenuItemToken(), label, flags);
    }
    static std::shared_ptr<GenericMenuItem> make(
        const std::string &label,
        const std::string &description,
        Flags flags = Flags::Zero()
    ) {
        return std::make_shared<GenericMenuItem>(
            MenuItemToken(),
            label,
            description,
            flags
        );
    }
    static std::shared_ptr<GenericMenuItem> make(
        const std::string &label,
        const std::string &description,
        const std::string &value,
        Flags flags = Flags::Zero()
    ) {
        return std::make_shared<GenericMenuItem>(
            MenuItemToken(),
            label,
            description,
            value,
            flags
        );
    }
    virtual void chose(MenuView &invokingView, const MenuAccess &access);
    virtual void select(MenuView &invokingView, const MenuAccess &access);
    virtual void deselect(MenuView &invokingView, const MenuAccess &access);
    boost::signals2::connection choseConnect(
        const typename Signal::slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return choseSig.connect(slot, at);
    }
    boost::signals2::connection choseConnect(
        const typename Signal::group_type &group,
        const typename Signal::slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return choseSig.connect(group, slot, at);
    }
    boost::signals2::connection choseConnectExtended(
        const typename Signal::extended_slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return choseSig.connect_extended(slot, at);
    }
    boost::signals2::connection choseConnectExtended(
        const typename Signal::group_type &group,
        const typename Signal::extended_slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return choseSig.connect_extended(group, slot, at);
    }
    void choseDisconnect(
        const typename Signal::group_type &group
    ) {
        choseSig.disconnect(group);
    }
    template<typename Slot>
    void choseDisconnect(const Slot &slotFunc) {
        choseSig.disconnect(slotFunc);
    }
    boost::signals2::connection selectConnect(
        const typename Signal::slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return selSig.connect(slot, at);
    }
    boost::signals2::connection selectConnect(
        const typename Signal::group_type &group,
        const typename Signal::slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return selSig.connect(group, slot, at);
    }
    boost::signals2::connection selectConnectExtended(
        const typename Signal::extended_slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return selSig.connect_extended(slot, at);
    }
    boost::signals2::connection selectConnectExtended(
        const typename Signal::group_type &group,
        const typename Signal::extended_slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return selSig.connect_extended(group, slot, at);
    }
    void selectDisconnect(
        const typename Signal::group_type &group
    ) {
        selSig.disconnect(group);
    }
    template<typename Slot>
    void selectDisconnect(const Slot &slotFunc) {
        selSig.disconnect(slotFunc);
    }
    boost::signals2::connection deselectConnect(
        const typename Signal::slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return deselSig.connect(slot, at);
    }
    boost::signals2::connection deselectConnect(
        const typename Signal::group_type &group,
        const typename Signal::slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return deselSig.connect(group, slot, at);
    }
    boost::signals2::connection deselectConnectExtended(
        const typename Signal::extended_slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return deselSig.connect_extended(slot, at);
    }
    boost::signals2::connection deselectConnectExtended(
        const typename Signal::group_type &group,
        const typename Signal::extended_slot_type &slot,
        boost::signals2::connect_position at = boost::signals2::at_back
    ) {
        return deselSig.connect_extended(group, slot, at);
    }
    void deselectDisconnect(
        const typename Signal::group_type &group
    ) {
        deselSig.disconnect(group);
    }
    template<typename Slot>
    void deselectDisconnect(const Slot &slotFunc) {
        deselSig.disconnect(slotFunc);
    }
};

typedef std::shared_ptr<GenericMenuItem>  GenericMenuItemSptr;

typedef std::weak_ptr<GenericMenuItem>  GenericMenuItemWptr;

} } }

#endif        //  #ifndef GENERICMENUITEM_HPP