CDocumentProcessingManagerCompBase.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_CDocumentProcessingManagerCompBase_included
#define iprocgui_CDocumentProcessingManagerCompBase_included
 
 
// Qt includes
#include <QtCore/QObject>
 
// ICF includes
#include <imod/CMultiModelDispatcherBase.h>
#include <ilog/TLoggerCompWrap.h>
#include <ibase/ICommandsProvider.h>
#include <idoc/IDocumentManager.h>
#include <iproc/IProcessor.h>
#include <istdgui/IGuiObject.h>
#include <istdgui/CHierarchicalCommand.h>
 
 
namespace iprocgui
{
 
 
class CDocumentProcessingManagerCompBase:
            public QObject,
            public ilog::CLoggerComponentBase,
            protected imod::CMultiModelDispatcherBase,
            virtual public ibase::ICommandsProvider
{
    Q_OBJECT
public:
    typedef ilog::CLoggerComponentBase BaseClass;
    
    I_BEGIN_BASE_COMPONENT(CDocumentProcessingManagerCompBase);
        I_REGISTER_INTERFACE(ibase::ICommandsProvider);
        I_ASSIGN(m_documentManagerCompPtr, "DocumentManager", "Application's document manager", true, "DocumentManager");
        I_ASSIGN_TO(m_documentManagerModelCompPtr, m_documentManagerCompPtr, true);
        I_ASSIGN(m_processorCompPtr, "Processor", "Target processing component", true, "Processor");
        I_ASSIGN(m_progressManagerCompPtr, "ProgressManager", "Processing progress manager", false, "ProgressManager");
        I_ASSIGN(m_paramsSetCompPtr, "ProcessingParamsSet", "Processing parameters", false, "ProcessingParameters");
        I_ASSIGN(m_paramsGuiCompPtr, "ProcessingParamsGui", "UI for processing parameters", false, "ProcessingParamsGui");
        I_ASSIGN(m_commandNameAttrPtr, "ProcessingCommandName", "Name of the processing action in menu", true, "");
        I_ASSIGN(m_menuNameAttrPtr, "ProcessingMenuName", "Name of the processing menu", false, "Processing");
        I_ASSIGN(m_inputDocumentRequiredAttrPtr, "InputDocumentRequired", "If enabled, the input document is required for processing", false, true);
        I_ASSIGN(m_documentTypeIdAttrPtr, "DocumentTypeId", "Document type ID used for document creation", false, "Default");
        I_ASSIGN(m_commandGroupIdAttrPtr, "CommandGroup", "Specify the command group ID", true, 0);
        I_ASSIGN(m_commandShowInToolBarAttrPtr, "ShowInToolsBar", "If enabled the command button will be shown also in the tool bar", true, false);
        I_ASSIGN(m_commandIconPathAttrPtr, "CommandIconPath", "Path to the icon resource used for the command", false, "CommandIconPath");
 
    I_END_COMPONENT;
 
    CDocumentProcessingManagerCompBase();
 
    bool IsInputDocumentRequired() const;
 
    void UpdateCommandsState();
 
    // reimpemented (ibase::ICommandsProvider)
    const ibase::IHierarchicalCommand* GetCommands() const override;
 
    // reimpemented (icomp::IComponent)
    void OnComponentCreated() override;
    void OnComponentDestroyed() override;
 
    // abstract methods
 
    virtual void DoDocumentProcessing(const istd::IChangeable* inputDocumentPtr, const QByteArray& documentTypeId) = 0;
 
protected:
    // reimplemented (imod::CMultiModelDispatcherBase)
    void OnModelChanged(int modelId, const istd::IChangeable::ChangeSet& changeSet) override;
 
    I_REF(idoc::IDocumentManager, m_documentManagerCompPtr);
    I_REF(imod::IModel, m_documentManagerModelCompPtr);
    I_REF(iproc::IProcessor, m_processorCompPtr);
    I_REF(iproc::IProgressManager, m_progressManagerCompPtr);
    I_REF(iprm::IParamsSet, m_paramsSetCompPtr);
    I_REF(istdgui::IGuiObject, m_paramsGuiCompPtr);
    I_TEXTATTR(m_commandNameAttrPtr);
    I_TEXTATTR(m_menuNameAttrPtr);
    I_ATTR(bool, m_inputDocumentRequiredAttrPtr);
    I_ATTR(QByteArray, m_documentTypeIdAttrPtr);
    I_ATTR(int, m_commandGroupIdAttrPtr);
    I_ATTR(bool, m_commandShowInToolBarAttrPtr);
    I_ATTR(QString, m_commandIconPathAttrPtr);
 
    istdgui::CHierarchicalCommand m_processingMenu;
    istdgui::CHierarchicalCommand m_rootCommands;
    istdgui::CHierarchicalCommand m_processingCommand;
 
private Q_SLOTS:
    void OnDoProcessing();
};
 
 
} // namespace iproc
 
 
#endif // !iprocgui_CDocumentProcessingManagerCompBase_included