infoarea.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_INFOAREA_H
#define SWIFT_GUI_INFOAREA_H
 
#include <QDockWidget>
#include <QList>
#include <QMainWindow>
#include <QObject>
#include <QSize>
#include <QString>
#include <QTabWidget>
#include <Qt>
 
#include "gui/enableforframelesswindow.h"
#include "gui/swiftguiexport.h"
#include "misc/statusmessage.h"
#include "misc/statusmessagelist.h"
 
class QAction;
class QCloseEvent;
class QKeyEvent;
class QMenu;
class QPaintEvent;
class QPixmap;
class QPoint;
class QTabBar;
class QWidget;
 
namespace swift::gui
{
    class CDockWidget;
    class CDockWidgetInfoArea;
 
    class SWIFT_GUI_EXPORT CInfoArea : public QMainWindow, CEnableForFramelessWindow
    {
        Q_OBJECT
 
    public:
        virtual ~CInfoArea() override;
 
        void addToContextMenu(QMenu *menu) const;
 
        bool isFloating() const { return m_infoAreaFloating; }
 
        bool isSelectedDockWidgetInfoArea(const CDockWidgetInfoArea *infoArea) const;
 
        const CDockWidgetInfoArea *getSelectedDockInfoArea() const;
 
        int getSelectedDockInfoAreaIndex() const;
 
        QList<const CDockWidgetInfoArea *> getDockWidgetInfoAreas() const;
 
        QList<QAction *> getInfoAreaSelectActions(bool withShortcut, QWidget *parent) const;
 
        QList<QAction *> getInfoAreaToggleFloatingActions(QWidget *parent) const;
 
        QList<QAction *> getInfoAreaRestoreActions(QWidget *parent) const;
 
        QList<QAction *> getInfoAreaResetPositionActions(QWidget *parent) const;
 
        QList<int> getAreaIndexesDockedOrFloating(bool floating) const;
 
        void dockAllWidgets();
 
        void adjustSizeForAllDockWidgets();
 
        void floatAllWidgets();
 
        void allFloatingOnTop();
 
        void resetAllFloatingWidgetSettings();
 
        void resetAllWidgetSettings();
 
        virtual void toggleFloatingWholeInfoArea();
 
        void toggleFloatingByIndex(int areaIndex);
 
        void toggleVisibility(int areaIndex);
 
        void selectArea(int areaIndex);
 
        void resetPosition(int areaIndex);
 
        void selectArea(const CDockWidgetInfoArea *dockWidgetInfoArea);
 
        void selectAreaByAction();
 
        void resetPositionByAction();
 
        void toggleAreaFloatingByAction();
 
        void restoreDockWidgetInfoArea();
 
        void restoreDockWidgetInfoAreaByIndex(int areaIndex);
 
        void selectLeftTab();
 
        void selectRightTab();
 
        void displayStatusMessage(const swift::misc::CStatusMessage &statusMessage);
 
        void displayStatusMessages(const swift::misc::CStatusMessageList &statusMessages);
 
    signals:
        void changedInfoAreaTabBarIndex(int index);
 
        void changedInfoAreaStatus(int currentTabIndex, QList<int> dockedAreas, QList<int> floatingAreas);
 
        void changedWholeInfoAreaFloating(bool floating);
 
    protected:
        explicit CInfoArea(QWidget *parent = nullptr);
 
        virtual void closeEvent(QCloseEvent *event) override;
 
        virtual void paintEvent(QPaintEvent *event) override;
 
        virtual void keyPressEvent(QKeyEvent *event) override;
 
        virtual QSize getPreferredSizeWhenFloating(int areaIndex) const = 0;
 
        virtual const QPixmap &indexToPixmap(int areaIndex) const = 0;
 
        void initInfoArea();
 
        void setTabBarPosition(QTabWidget::TabPosition position);
 
        void toggleTabBarLocked(bool locked);
 
    private:
        QList<CDockWidgetInfoArea *> m_dockWidgetInfoAreas;
        QList<CInfoArea *> m_childInfoAreas;
        QTabBar *m_tabBar = nullptr;
        bool m_showTabTexts = true; 
        bool m_infoAreaFloating = false; 
        bool m_showTabBar = true; 
        bool m_lockTabBar = false; 
 
        void toggleTabBarPosition();
 
        void tabifyAllWidgets();
 
        void unTabifyAllWidgets();
 
        bool isValidAreaIndex(int areaIndex) const;
 
        int getAreaIndexByWindowTitle(const QString &title) const;
 
        int getTabBarIndexByTitle(const QString &title) const;
 
        CDockWidgetInfoArea *getDockWidgetInfoAreaByTabBarIndex(int tabBarIndex) const;
 
        CDockWidgetInfoArea *getDockWidgetInfoAreaByWindowTitle(const QString &title) const;
 
        int dockWidgetInfoAreaToTabBarIndex(const CDockWidgetInfoArea *dockWidgetInfoArea) const;
 
        void setFeaturesForDockableWidgets(QDockWidget::DockWidgetFeatures features);
 
        int countDockedWidgetInfoAreas() const;
 
        void setTabPixmaps();
 
        void connectTopLevelChanged();
 
        void onTabBarDoubleClicked(int tabBarIndex);
 
        void onWidgetTopLevelChanged(CDockWidget *dockWidget, bool topLevel);
 
        void onStyleSheetChanged();
 
        void showContextMenu(const QPoint &pos);
 
        void showTabTexts(bool show);
 
        void showTabBar(bool show);
 
        void setDockArea(Qt::DockWidgetArea area);
 
        void setWholeInfoAreaFloating(bool floating);
 
        void emitInfoAreaStatus();
 
        void onTabBarIndexChanged(int tabBarIndex);
 
        QList<CInfoArea *> findOwnChildInfoAreas() const;
 
        QList<CDockWidgetInfoArea *> findOwnDockWidgetInfoAreas() const;
    };
} // namespace swift::gui
 
#endif // SWIFT_GUI_INFOAREA_H