CMultiDocumentWorkspaceGuiComp.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.
********************************************************************************/
 
#pragma once
 
 
// Qt includes
#include <QtCore/QtGlobal>
#include <QtWidgets/QMdiArea>
#include <QtWidgets/QMdiSubWindow>
 
// ICF includes
#include <ibase/ICommandsProvider.h>
#include <iprm/ISelectionParam.h>
#include <iprm/IOptionsList.h>
#include <idoc/CMultiDocumentManagerBase.h>
#include <idoc/IDocumentTemplate.h>
#include <istdgui/TGuiComponentBase.h>
#include <istdgui/TRestorableGuiWrap.h>
#include <istdgui/CHierarchicalCommand.h>
#include <idocgui/TQtDocumentManagerWrap.h>
 
 
namespace idocgui
{
 
 
class CMultiDocumentWorkspaceGuiComp:
        public idocgui::TQtDocumentManagerWrap<
        idoc::CMultiDocumentManagerBase,
        istdgui::TRestorableGuiWrap<
        istdgui::TGuiComponentBase<QMdiArea> > >,
        virtual public ibase::ICommandsProvider
{
    Q_OBJECT
 
public:
    typedef idocgui::TQtDocumentManagerWrap<
            idoc::CMultiDocumentManagerBase,
            istdgui::TRestorableGuiWrap<
            istdgui::TGuiComponentBase<QMdiArea> > > BaseClass;
 
    I_BEGIN_COMPONENT(CMultiDocumentWorkspaceGuiComp);
        I_REGISTER_INTERFACE(idoc::IDocumentManager);
        I_REGISTER_INTERFACE(idoc::IDocumentTypesInfo);
        I_REGISTER_INTERFACE(ibase::ICommandsProvider);
        I_REGISTER_SUBELEMENT(DocumentSelection);
        I_REGISTER_SUBELEMENT_INTERFACE(DocumentSelection, iprm::ISelectionParam, ExtractSelectionInfo);
        I_REGISTER_SUBELEMENT_INTERFACE(DocumentSelection, imod::IModel, ExtractSelectionInfo);
        I_REGISTER_SUBELEMENT_INTERFACE(DocumentSelection, istd::IChangeable, ExtractSelectionInfo);
        I_REGISTER_SUBELEMENT_INTERFACE(DocumentSelection, iprm::IOptionsList, ExtractSelectionInfo);
        I_ASSIGN(m_documentTemplateCompPtr, "DocumentTemplate", "Document template", true, "DocumentTemplate");
        I_ASSIGN(m_showMaximizedAttrPtr, "ShowViewMaximized", "At start shows the document view maximized", false, true);
        I_ASSIGN(m_showPathAsTipAttrPtr, "ShowFilePathAsToolTip", "if enabled, the current document file path will be shown as tool tip of document tab", true, false);
        I_ASSIGN(m_allowViewRepeatingAttrPtr, "AllowViewRepeating", "If enabled, multiple views for the same document are allowed", false, true);
        I_ASSIGN(m_rememberOpenDocumentsParamPtr, "RememberOpenDocumentsOnExit", "If enabled, restores open documents from previous session", false, "RememberOpenDocumentsOnExit");
        I_ASSIGN(m_workspaceBackgroundColorAttrPtr, "WorkspaceBackgroundColor", "Background color of the MDI workspace", false, "");
        I_ASSIGN(m_defaultCreatedDocumentTypeIdAttrPtr, "DefaultCreatedDocumentTypeId", "Type-ID of the document that should be created if the workspace is empty", false, "");
    I_END_COMPONENT;
 
    enum GroupId
    {
        GI_WINDOW = 0x300,
        GI_DOCUMENT,
        GI_VIEW
    };
 
    CMultiDocumentWorkspaceGuiComp();
 
    // reimplemented (idoc::IDocumentManager)
    void SetActiveView(istd::IPolymorphic* viewPtr) override;
 
    // reimplemented (ibase::ICommandsProvider)
    const ibase::IHierarchicalCommand* GetCommands() const override;
 
    // reimplemented (istdgui::IGuiObject)
    void OnTryClose(bool* ignoredPtr = nullptr) override;
 
protected:
 
    void UpdateAllTitles();
 
    istdgui::IGuiObject* GetViewFromWidget(const QWidget& widget) const;
 
    int GetDocumentIndexFromWidget(const QWidget& widget) const;
 
    virtual void CreateConnections();
 
    void OnViewsCountChanged();
 
    // reimplemented (idoc::CMultiDocumentManagerBase)
    istd::IChangeable* OpenSingleDocument(
            const QString& filePath,
            bool createView,
            const QByteArray& viewTypeId,
            QByteArray& documentTypeId,
            bool beQuiet,
            bool* ignoredPtr,
            iproc::IProgressManager* progressManagerPtr) override;
 
    // reimplemented (QObject)
    bool eventFilter(QObject* sourcePtr, QEvent* eventPtr) override;
 
    // reimplemented (TRestorableGuiWrap)
    void OnRestoreSettings(const QSettings& settings) override;
    void OnSaveSettings(QSettings& settings) const override;
 
    // reimplemented (idoc::CMultiDocumentManagerBase)
    void CloseAllDocuments() override;
    QStringList GetOpenFilePaths(const QByteArray* documentTypeIdPtr = nullptr) const override;
    void OnViewRegistered(istd::IPolymorphic* viewPtr, const SingleDocumentData& documentData) override;
    void OnViewRemoved(istd::IPolymorphic* viewPtr) override;
    bool QueryDocumentSave(const SingleDocumentData& info, bool* ignoredPtr) override;
 
    // reimplemented (ibase:CGuiComponentBase)
    void OnGuiCreated() override;
    void OnGuiDestroyed() override;
    void OnRetranslate() override;
    void OnGuiRetranslate() override;
 
    // reimplemented (icomp::CComponentBase)
    void OnComponentCreated() override;
 
    // reimplemented (istd:IChangeable)
    void OnEndChanges(const ChangeSet& changeSet) override;
 
protected Q_SLOTS:
    void OnWindowActivated(QMdiSubWindow* window);
    void OnCloseAllViews();
 
private:
    class DocumentSelectionInfo: virtual public iprm::ISelectionParam, virtual public iprm::IOptionsList
    {
    public:
        DocumentSelectionInfo();
 
        void SetParent(CMultiDocumentWorkspaceGuiComp& parent);
 
        // reimplemented (iprm::ISelectionParam)
        const iprm::IOptionsList* GetSelectionConstraints() const override;
        QByteArray GetSelectedOptionId() const override;
        int GetSelectedOptionIndex() const override;
        bool SetSelectedOptionIndex(int index) override;
        iprm::ISelectionParam* GetSubselection(int index) const override;
 
        // reimplemented (iprm::IOptionsList)
        int GetOptionsFlags() const override;
        int GetOptionsCount() const override;
        QString GetOptionName(int index) const override;
        QString GetOptionDescription(int index) const override;
        QByteArray GetOptionId(int index) const override;
        bool IsOptionEnabled(int index) const override;
 
        // reimplemented (iser::ISerializable)
        bool Serialize(iser::IArchive& archive) override;
 
    private:
        int m_docIndex;
        CMultiDocumentWorkspaceGuiComp* m_parent;
    };
 
    friend class imod::TModelWrap<DocumentSelectionInfo>;
 
    // static template methods for subelement access
    template <class InterfaceType>
    static InterfaceType* ExtractSelectionInfo(CMultiDocumentWorkspaceGuiComp& component)
    {
        return &component.m_documentSelectionInfo;
    }
 
    istdgui::CHierarchicalCommand m_commands;
 
    // global commands
    istdgui::CHierarchicalCommand m_windowCommand;
 
    // window menu group
    istdgui::CHierarchicalCommand m_closeAllDocumentsCommand;
 
    mutable QString m_lastDirectory;
 
    int m_viewsCount;
 
    imod::TModelWrap<DocumentSelectionInfo> m_documentSelectionInfo;
 
    QString m_organizationName;
    QString m_applicationName;
 
    bool m_forceQuietClose;
 
    I_REF(idoc::IDocumentTemplate, m_documentTemplateCompPtr);
    I_REF(iprm::IEnableableParam, m_rememberOpenDocumentsParamPtr);
    I_ATTR(bool, m_showMaximizedAttrPtr);
    I_ATTR(bool, m_showPathAsTipAttrPtr);
    I_ATTR(bool, m_allowViewRepeatingAttrPtr);
    I_ATTR(QString, m_workspaceBackgroundColorAttrPtr);
    I_ATTR(QByteArray, m_defaultCreatedDocumentTypeIdAttrPtr);
};
 
 
} // namespace idocgui