dockwidget.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2014 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_GUI_DOCKWIDGET_H
#define SWIFT_GUI_DOCKWIDGET_H
 
#include <QDockWidget>
#include <QMargins>
#include <QObject>
#include <QPoint>
#include <QSize>
#include <QString>
 
#include "gui/enableforframelesswindow.h"
#include "gui/managedstatusbar.h"
#include "gui/overlaymessagesframe.h"
#include "gui/settings/dockwidgetsettings.h"
#include "gui/swiftguiexport.h"
#include "misc/statusmessage.h"
#include "misc/statusmessagelist.h"
 
class QCloseEvent;
class QMenu;
class QMouseEvent;
class QPaintEvent;
class QWidget;
class QWidgetAction;
 
namespace swift::gui
{
    namespace components
    {
        class CMarginsInput;
    }
    namespace menus
    {
        class CFontMenu;
    }
 
    class SWIFT_GUI_EXPORT CDockWidget : public COverlayMessagesDockWidget, public CEnableForFramelessWindow
    {
        Q_OBJECT
 
    public:
        void setOriginalTitleBar();
 
        void setEmptyTitleBar();
 
        void setNullTitleBarWidget();
 
        const QString &windowTitleBackup() const { return m_windowTitleBackup; }
 
        QString windowTitleOrBackup() const;
 
        bool showTitleWhenDocked() const { return m_windowTitleWhenDocked; }
 
        bool isSelected() const { return m_selected; }
 
        bool isWidgetVisible() const;
 
        void allowStatusBar(bool allow) { m_allowStatusBar = allow; }
 
        void showTitleWhenDocked(bool show);
 
        void resetWasAlreadyFloating();
 
        bool wasAlreadyFloating() const { return m_wasAlreadyFloating; }
 
        void setPreferredSizeWhenFloating(const QSize &size);
 
        void setOffsetWhenFloating(const QPoint &point, bool frameless);
 
        virtual void setFrameless(bool frameless) override;
 
        void toggleFloating();
 
        void toggleVisibility();
 
        void toggleFrameless();
 
        // void toggleFramelessDeferred(int delayMs = 1000);
 
        void windowAlwaysOnTop();
 
        void windowNotAlwaysOnTop();
 
        void setAlwaysOnTop(bool onTop) { m_alwaysOnTop = onTop; }
 
        bool restoreFromSettings();
 
        void saveCurrentStateToSettings();
 
        void resetSettings();
 
        void resetPosition();
 
        void setWindowTitle(const QString &title);
 
        void displayStatusMessage(const swift::misc::CStatusMessage &statusMessage);
 
        void displayStatusMessages(const swift::misc::CStatusMessageList &statusMessages);
 
        static const QString &propertyOuterWidget();
 
        static const QString &propertyInnerWidget();
 
    signals:
        void widgetTopLevelChanged(CDockWidget *, bool topLevel);
 
        void fontSizePlus();
        void fontSizeMinus();
 
    protected:
        explicit CDockWidget(QWidget *parent = nullptr);
 
        CDockWidget(bool allowStatusBar, QWidget *parent = nullptr);
 
        void setMargins();
 
        void setMarginsWhenFloating(const QMargins &margins);
 
        void setMarginsWhenFloating(int left, int top, int right, int bottom);
 
        QMargins getMarginsWhenFloating() const;
 
        void setMarginsWhenFramelessFloating(const QMargins &margins);
 
        void setMarginsWhenFramelessFloating(int left, int top, int right, int bottom);
 
        QMargins getMarginsWhenFramelessFloating() const;
 
        void setMarginsWhenDocked(const QMargins &margins);
 
        void setMarginsWhenDocked(int left, int top, int right, int bottom);
 
        QMargins getMarginsWhenDocked() const;
 
        void setAlwaysOnTopFlag(bool onTop);
 
        virtual void closeEvent(QCloseEvent *event) override;
 
        virtual void paintEvent(QPaintEvent *event) override;
 
        virtual void mouseMoveEvent(QMouseEvent *event) override;
 
        virtual void keyPressEvent(QKeyEvent *event) override;
 
        virtual void mousePressEvent(QMouseEvent *event) override;
 
        virtual void addToContextMenu(QMenu *contextMenu) const;
 
        virtual void initialFloating();
 
        virtual void onStyleSheetsChanged();
 
    private:
        QWidget *m_titleBarWidgetEmpty = nullptr; 
        QWidget *m_titleBarWidgetOriginal = nullptr; 
        QWidgetAction *m_marginMenuAction = nullptr; 
        components::CMarginsInput *m_input = nullptr; 
        menus::CFontMenu *m_fontMenu = nullptr; 
        bool m_allowStatusBar = true;
        bool m_windowTitleWhenDocked = true;
        bool m_wasAlreadyFloating = false; 
        bool m_selected = false; 
        bool m_dockWidgetVisible = false; 
        bool m_wasFrameless = false; 
        bool m_alwaysOnTop = false; 
        CManagedStatusBar m_statusBar; 
        QString m_windowTitleBackup; 
        QSize m_preferredSizeWhenFloating; 
        QSize m_initialDockedMinimumSize; 
        QSize m_lastFloatingSize; 
        QPoint m_offsetWhenFloating; 
        QPoint m_lastFloatingPosition; 
        Qt::DockWidgetAreas m_originalAreas; 
 
        swift::misc::CSetting<swift::gui::settings::TDockWidget> m_settings { this, &CDockWidget::settingsChanged };
 
        void onTopLevelChanged(bool topLevel);
 
        void showContextMenu(const QPoint &pos);
 
        void onVisibilityChanged(bool visible);
 
        void menuChangeMargins(const QMargins &margins);
 
        void settingsChanged();
 
        void dummy();
 
        void initTitleBarWidgets();
 
        void initStatusBarAndProperties();
 
        void forceStyleSheetUpdate();
 
        void rememberFloatingSizeAndPosition();
 
        void restoreFloatingSizeAndPosition();
 
        void restoreFloatingSizeAndPositionDeferred();
 
        settings::CDockWidgetSettings getSettings() const;
 
        void saveSettings(const swift::gui::settings::CDockWidgetSettings &settings);
    };
} // namespace swift::gui
 
#endif // SWIFT_GUI_DOCKWIDGET_H