mainwindow.h

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
 
#ifndef MAINWINDOW_H
#define MAINWINDOW_H
 
#include <QtCore/qlist.h>
 
#include <QtWidgets/qmainwindow.h>
#include <QtWidgets/qmdiarea.h>
 
QT_BEGIN_NAMESPACE
 
class QDesignerActions;
class QDesignerWorkbench;
class QDesignerToolWindow;
class QDesignerFormWindow;
class QDesignerSettings;
 
class QtToolBarManager;
class QToolBar;
class QMdiArea;
class QMenu;
class QByteArray;
class QMimeData;
 
/* A main window that has a configureable policy on handling close events. If
 * enabled, it can forward the close event to external handlers.
 * Base class for windows that can switch roles between tool windows
 * and main windows. */
 
class MainWindowBase: public QMainWindow
{
    Q_DISABLE_COPY_MOVE(MainWindowBase)
    Q_OBJECT
protected:
    explicit MainWindowBase(QWidget *parent = nullptr, Qt::WindowFlags flags = Qt::Window);
 
public:
    enum CloseEventPolicy {
        /* Always accept close events */
        AcceptCloseEvents,
        /* Emit a signal with the event, have it handled elsewhere */
        EmitCloseEventSignal };
 
    CloseEventPolicy closeEventPolicy() const { return m_policy; }
    void setCloseEventPolicy(CloseEventPolicy pol) { m_policy = pol; }
 
    static QList<QToolBar *> createToolBars(const QDesignerActions *actions, bool singleToolBar);
    static QString mainWindowTitle();
 
    // Use the minor Qt version as settings versions to avoid conflicts
    static int settingsVersion();
 
signals:
    void closeEventReceived(QCloseEvent *e);
 
protected:
    void closeEvent(QCloseEvent *e) override;
private:
    CloseEventPolicy m_policy = AcceptCloseEvents;
};
 
/* An MdiArea that listens for desktop file manager file drop events and emits
 * a signal to open a dropped file. */
class DockedMdiArea : public QMdiArea
{
    Q_DISABLE_COPY_MOVE(DockedMdiArea)
    Q_OBJECT
public:
    explicit DockedMdiArea(const QString &extension, QWidget *parent = nullptr);
 
signals:
    void fileDropped(const QString &);
 
protected:
    bool event (QEvent *event) override;
 
private:
    QStringList uiFiles(const QMimeData *d) const;
 
    const QString m_extension;
};
 
// Convenience class that manages a QtToolBarManager and an action to trigger
// it on a mainwindow.
class ToolBarManager : public QObject
{
    Q_OBJECT
    Q_DISABLE_COPY_MOVE(ToolBarManager)
public:
    explicit ToolBarManager(QMainWindow *configureableMainWindow,
                            QWidget *parent,
                            QMenu *toolBarMenu,
                            const QDesignerActions *actions,
                            const QList<QToolBar *> &toolbars,
                            const QList<QDesignerToolWindow *> &toolWindows);
 
    QByteArray saveState(int version = 0) const;
    bool restoreState(const QByteArray &state, int version = 0);
 
private slots:
    void configureToolBars();
    void updateToolBarMenu();
 
private:
    QMainWindow *m_configureableMainWindow;
    QWidget *m_parent;
    QMenu *m_toolBarMenu;
    QtToolBarManager *m_manager;
    QAction *m_configureAction;
    QList<QToolBar *> m_toolbars;
};
 
/* Main window to be used for docked mode */
class DockedMainWindow : public MainWindowBase {
    Q_OBJECT
    Q_DISABLE_COPY_MOVE(DockedMainWindow)
public:
    using DesignerToolWindowList = QList<QDesignerToolWindow *>;
    using DockWidgetList = QList<QDockWidget *>;
 
    explicit DockedMainWindow(QDesignerWorkbench *wb,
                              QMenu *toolBarMenu,
                              const DesignerToolWindowList &toolWindows);
 
    // Create a MDI subwindow for the form.
    QMdiSubWindow *createMdiSubWindow(QWidget *fw, Qt::WindowFlags f, const QKeySequence &designerCloseActionShortCut);
 
    QMdiArea *mdiArea() const;
 
    DockWidgetList addToolWindows(const DesignerToolWindowList &toolWindows);
 
    void restoreSettings(const QDesignerSettings &s, const DockWidgetList &dws, const QRect &desktopArea);
    void saveSettings(QDesignerSettings &) const;
 
signals:
    void fileDropped(const QString &);
    void formWindowActivated(QDesignerFormWindow *);
 
private slots:
    void slotSubWindowActivated(QMdiSubWindow*);
 
private:
    ToolBarManager *m_toolBarManager = nullptr;
};
 
QT_END_NAMESPACE
 
#endif // MAINWINDOW_H