IActionSrv.hpp

/* ***** BEGIN LICENSE BLOCK *****
 * FW4SPL - Copyright (C) IRCAD, 2009-2018.
 * Distributed under the terms of the GNU Lesser General Public License (LGPL) as
 * published by the Free Software Foundation.
 * ****** END LICENSE BLOCK ****** */

#ifndef __FWGUI_IACTIONSRV_HPP__
#define __FWGUI_IACTIONSRV_HPP__

#include "fwGui/config.hpp"
#include "fwGui/registrar/ActionRegistrar.hpp"

#include <fwCom/Signals.hpp>
#include <fwCom/Slots.hpp>

#include <fwServices/IService.hpp>

namespace fwGui
{

class FWGUI_CLASS_API IActionSrv : public ::fwServices::IService
{

public:

    fwCoreServiceClassDefinitionsMacro( (IActionSrv)(::fwServices::IService) );
    fwCoreAllowSharedFromThis();

    typedef ::fwCom::Signal< void ()> EnabledSignalType;
    static const ::fwCom::Signals::SignalKeyType s_ENABLED_SIG;

    typedef ::fwCom::Signal< void ()> DisabledSignalType;
    static const ::fwCom::Signals::SignalKeyType s_DISABLED_SIG;

    typedef ::fwCom::Signal< void ()> CheckedSignalType;
    static const ::fwCom::Signals::SignalKeyType s_CHECKED_SIG;

    typedef ::fwCom::Signal< void ()> UncheckedSignalType;
    static const ::fwCom::Signals::SignalKeyType s_UNCHECKED_SIG;
    static const ::fwCom::Slots::SlotKeyType s_SET_VISIBLE_SLOT;

    static const ::fwCom::Slots::SlotKeyType s_SHOW_SLOT;

    static const ::fwCom::Slots::SlotKeyType s_HIDE_SLOT;

    static const ::fwCom::Slots::SlotKeyType s_SET_IS_ACTIVE_SLOT;

    static const ::fwCom::Slots::SlotKeyType s_ACTIVATE_SLOT;

    static const ::fwCom::Slots::SlotKeyType s_DEACTIVATE_SLOT;

    static const ::fwCom::Slots::SlotKeyType s_SET_IS_EXECUTABLE_SLOT;

    static const ::fwCom::Slots::SlotKeyType s_SET_EXECUTABLE_SLOT;

    static const ::fwCom::Slots::SlotKeyType s_SET_INEXECUTABLE_SLOT;
    FWGUI_API void actionServiceStopping();

    FWGUI_API void actionServiceStarting();

    FWGUI_API virtual void setIsActive(bool isActive);

    FWGUI_API virtual void activate();

    FWGUI_API virtual void deactivate();

    FWGUI_API bool getIsActive() const;

    bool getActiveStateValue() const
    {
        return m_activeStateValue;
    }

    FWGUI_API virtual void setIsExecutable(bool isExecutable);

    FWGUI_API virtual void setExecutable();

    FWGUI_API virtual void setInexecutable();

    FWGUI_API bool getIsExecutable() const;

    FWGUI_API void setVisible(bool isVisible);

    FWGUI_API void show();

    FWGUI_API void hide();

    FWGUI_API bool isVisible() const;

    FWGUI_API bool confirmAction();

protected:

    FWGUI_API IActionSrv();

    FWGUI_API virtual ~IActionSrv();

    typedef ::fwRuntime::ConfigurationElement::sptr ConfigurationType;

    FWGUI_API void initialize();

private:

    ::fwGui::registrar::ActionRegistrar::sptr m_registrar;

    bool m_activeStateValue;
    bool m_isActive;
    bool m_isExecutable;
    bool m_isVisible;
    bool m_confirmAction;
    std::string m_confirmMessage;
    std::string m_defaultButton;

    EnabledSignalType::sptr m_sigEnabled;
    DisabledSignalType::sptr m_sigDisabled;
    CheckedSignalType::sptr m_sigChecked;
    UncheckedSignalType::sptr m_sigUnchecked;
};

//-----------------------------------------------------------------------------

class LockAction
{
public:
    LockAction(IActionSrv::wptr action) :
        m_action(action)
    {
        m_action.lock()->setIsExecutable(false);
    }
    ~LockAction()
    {
        m_action.lock()->setIsExecutable(true);
    }
private:
    IActionSrv::wptr m_action;
};

//-----------------------------------------------------------------------------

} // namespace fwGui

#endif /*__FWGUI_IACTIONSRV_HPP__*/