CProcessorCommandComp.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#ifndef iprocgui_CProcessorCommandComp_included
#define iprocgui_CProcessorCommandComp_included
 
 
// ICF includes
#include <imod/TSingleModelObserverBase.h>
 
#include <icomp/CComponentBase.h>
 
#include <ibase/ICommandsProvider.h>
 
#include <istdgui/IIconProvider.h>
#include <istdgui/CHierarchicalCommand.h>
 
#include <iproc/IProcessor.h>
 
 
namespace iprocgui
{
 
 
class CProcessorCommandComp:
            public QObject,
            public icomp::CComponentBase,
            virtual public ibase::ICommandsProvider
{
    Q_OBJECT
public:
    typedef icomp::CComponentBase BaseClass;
    
    I_BEGIN_COMPONENT(CProcessorCommandComp);
        I_REGISTER_INTERFACE(ibase::ICommandsProvider);
        I_ASSIGN(m_processorCompPtr, "ActionProcessor", "Processor used for action execution", true, "ActionProcessor");
        I_ASSIGN(m_processorParamsCompPtr, "ProcessingParams", "Parameter set used for processor execution", false, "ProcessingParams");
        I_ASSIGN(m_processorInputCompPtr, "ProcessingInput", "Input object used for processor execution", false, "ProcessingInput");
        I_ASSIGN(m_processorOutputCompPtr, "ProcessingOutput", "Output object used for processor execution", false, "ProcessingOutput");
        I_ASSIGN(m_progressManagerCompPtr, "ProgressManager", "Progress manager used for processor execution", false, "ProgressManager");
        I_ASSIGN(m_actionIconAttrPtr, "ActionIcon", "Icon used command menu", true, ":/IcfIcons");
        I_ASSIGN(m_menuNameAttrPtr, "MenuName", "Name of the menu for the action group", true, "MenuName");
        I_ASSIGN(m_menuDescriptionAttrPtr, "MenuDescription", "Description for the action group", true, "MenuDescription");
        I_ASSIGN(m_rootMenuNameAttrPtr, "RootMenu", "Name of the root command", true, "Process");
        I_ASSIGN(m_successMessageAttrPtr, "SuccessMessage", "If defined, the message will be shown at the end of a successed processing action", false, "");
        I_ASSIGN(m_errorMessageAttrPtr, "ErrorMessage", "If defined, the message will be shown at the end of a failed processing action", false, "");
        I_ASSIGN(m_cancelMessageAttrPtr, "CancelMessage", "If defined, the message will be shown at the end of a canceled processing action", false, "");
    I_END_COMPONENT;
 
    CProcessorCommandComp();
 
    // reimpemented (ibase::ICommandsProvider)
    const ibase::IHierarchicalCommand* GetCommands() const override;
 
    // reimpemented (icomp::IComponent)
    void OnComponentCreated() override;
 
private Q_SLOTS:
    void OnCommandActivated();
 
protected:
    I_REF(iproc::IProcessor, m_processorCompPtr);
    I_REF(iprm::IParamsSet, m_processorParamsCompPtr);
    I_REF(istd::IPolymorphic, m_processorInputCompPtr);
    I_REF(istd::IChangeable, m_processorOutputCompPtr);
    I_REF(iproc::IProgressManager, m_progressManagerCompPtr);
    I_ATTR(QByteArray, m_actionIconAttrPtr);
    I_TEXTATTR(m_menuNameAttrPtr);
    I_TEXTATTR(m_menuDescriptionAttrPtr);
    I_TEXTATTR(m_rootMenuNameAttrPtr);
    I_TEXTATTR(m_successMessageAttrPtr);
    I_TEXTATTR(m_errorMessageAttrPtr);
    I_TEXTATTR(m_cancelMessageAttrPtr);
 
    istdgui::CHierarchicalCommand m_rootMenuCommand;
    istdgui::CHierarchicalCommand m_mainMenuCommand;
    istdgui::CHierarchicalCommand m_processingCommand;
};
 
 
} // namespace iprocgui
 
 
#endif // !iprocgui_CProcessorCommandComp_included