FrameworkWidgetFactory.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2019-2023 Klarälvdalens Datakonsult AB, a KDAB Group company <info@kdab.com>
  Author: Sérgio Martins <sergio.martins@kdab.com>
 
  SPDX-License-Identifier: GPL-2.0-only OR GPL-3.0-only
 
  Contact KDAB at <info@kdab.com> for commercial licensing options.
*/
 
#ifndef KDDOCKWIDGETS_FRAMEWORKWIDGETFACTORY_H
#define KDDOCKWIDGETS_FRAMEWORKWIDGETFACTORY_H
 
#include "docks_export.h"
#include "KDDockWidgets.h"
#include "QWidgetAdapter.h"
 
#include <QMap>
 
#include <utility>
 
// clazy:excludeall=ctor-missing-parent-argument
 
QT_BEGIN_NAMESPACE
class QAbstractButton;
QT_END_NAMESPACE
 
namespace Layouting {
class Separator;
class Widget;
}
 
namespace KDDockWidgets {
 
class MainWindowBase;
class DropIndicatorOverlayInterface;
class FloatingWindow;
class TabWidget;
class TitleBar;
class Frame;
class DropArea;
class SideBar;
class TabBar;
class TabWidgetQuick;
 
class DOCKS_EXPORT FrameworkWidgetFactory : public QObject
{
    Q_OBJECT
public:
    FrameworkWidgetFactory() = default;
 
    virtual ~FrameworkWidgetFactory();
 
    virtual Frame *createFrame(QWidgetOrQuick *parent = nullptr, FrameOptions options = FrameOption_None) const = 0;
 
    virtual TitleBar *createTitleBar(Frame *frame) const = 0;
 
    virtual TitleBar *createTitleBar(FloatingWindow *floatingWindow) const = 0;
 
    virtual TabWidget *createTabWidget(Frame *parent, TabWidgetOptions options = TabWidgetOption_None) const = 0;
 
    virtual TabBar *createTabBar(TabWidget *parent = nullptr) const = 0;
 
    virtual Layouting::Separator *createSeparator(Layouting::Widget *parent = nullptr) const = 0;
 
    virtual FloatingWindow *createFloatingWindow(MainWindowBase *parent = nullptr,
                                                 FloatingWindowFlags = FloatingWindowFlag::FromGlobalConfig) const = 0;
 
    virtual FloatingWindow *createFloatingWindow(Frame *frame, MainWindowBase *parent = nullptr, QRect suggestedGeometry = {}) const = 0;
 
    virtual DropIndicatorOverlayInterface *createDropIndicatorOverlay(DropArea *dropArea) const = 0;
 
    virtual QWidgetOrQuick *createRubberBand(QWidgetOrQuick *parent) const = 0;
 
    virtual SideBar *createSideBar(SideBarLocation loc, MainWindowBase *parent) const = 0;
 
#ifdef KDDOCKWIDGETS_QTWIDGETS
    virtual QAbstractButton *createTitleBarButton(QWidget *parent, TitleBarButtonType) const = 0;
#else
    virtual QUrl titleBarFilename() const = 0;
    virtual QUrl dockwidgetFilename() const = 0;
    virtual QUrl frameFilename() const = 0;
    virtual QUrl floatingWindowFilename() const = 0;
#endif
 
    virtual QIcon iconForButtonType(TitleBarButtonType type, qreal dpr) const = 0;
 
private:
    Q_DISABLE_COPY(FrameworkWidgetFactory)
};
 
class DOCKS_EXPORT DefaultWidgetFactory : public FrameworkWidgetFactory
{
    Q_OBJECT
public:
    DefaultWidgetFactory() = default;
    Frame *createFrame(QWidgetOrQuick *parent, FrameOptions) const override;
    TitleBar *createTitleBar(Frame *) const override;
    TitleBar *createTitleBar(FloatingWindow *) const override;
    TabWidget *createTabWidget(Frame *parent, TabWidgetOptions = TabWidgetOption_None) const override;
    TabBar *createTabBar(TabWidget *parent) const override;
    Layouting::Separator *createSeparator(Layouting::Widget *parent = nullptr) const override;
    FloatingWindow *createFloatingWindow(MainWindowBase *parent = nullptr, FloatingWindowFlags = FloatingWindowFlag::FromGlobalConfig) const override;
    FloatingWindow *createFloatingWindow(Frame *frame, MainWindowBase *parent = nullptr, QRect suggestedGeometry = {}) const override;
    DropIndicatorOverlayInterface *createDropIndicatorOverlay(DropArea *) const override;
    QWidgetOrQuick *createRubberBand(QWidgetOrQuick *parent) const override;
    SideBar *createSideBar(SideBarLocation loc, MainWindowBase *parent) const override;
 
#ifdef KDDOCKWIDGETS_QTWIDGETS
    QAbstractButton *createTitleBarButton(QWidget *parent, TitleBarButtonType) const override;
#else
    Q_INVOKABLE QUrl titleBarFilename() const override;
    QUrl dockwidgetFilename() const override;
    QUrl frameFilename() const override;
    QUrl floatingWindowFilename() const override;
#endif
 
    QIcon iconForButtonType(TitleBarButtonType type, qreal dpr) const override;
    void clearIconCache();
 
    static DropIndicatorType s_dropIndicatorType;
 
private:
    Q_DISABLE_COPY(DefaultWidgetFactory)
    mutable QMap<std::pair<TitleBarButtonType, qreal>, QIcon> m_cachedIcons;
};
 
}
 
#endif