DockWidgetBase.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 KD_DOCKWIDGET_BASE_H
#define KD_DOCKWIDGET_BASE_H
 
#include "docks_export.h"
#include "KDDockWidgets.h"
#include "QWidgetAdapter.h"
#include "LayoutSaver.h"
 
#include <QVector>
#include <memory>
 
// clazy:excludeall=ctor-missing-parent-argument
 
class TestDocks;
 
namespace KDDockWidgets {
 
class Frame;
class FloatingWindow;
class DragController;
class DockRegistry;
class LayoutSaver;
class TabWidget;
class TitleBar;
class MainWindowBase;
class StateDragging;
class FrameQuick;
class DockWidgetQuick;
class LayoutWidget;
 
#ifndef PYTHON_BINDINGS // Pyside bug: https://bugreports.qt.io/projects/PYSIDE/issues/PYSIDE-1327
class DOCKS_EXPORT DockWidgetBase : public QWidgetAdapter
#else
class DOCKS_EXPORT DockWidgetBase : public QWidget
#endif
{
    Q_OBJECT
    Q_PROPERTY(bool isFocused READ isFocused NOTIFY isFocusedChanged)
    Q_PROPERTY(bool isFloating READ isFloating WRITE setFloating NOTIFY isFloatingChanged)
    Q_PROPERTY(QString uniqueName READ uniqueName CONSTANT)
    Q_PROPERTY(QString title READ title WRITE setTitle NOTIFY titleChanged)
    Q_PROPERTY(QObject *widget READ widget NOTIFY widgetChanged)
    Q_PROPERTY(KDDockWidgets::DockWidgetBase::Options options READ options WRITE setOptions NOTIFY
                   optionsChanged)
public:
    typedef QVector<DockWidgetBase *> List;
 
    enum Option {
        Option_None = 0, 
        Option_NotClosable = 1, 
        Option_NotDockable = 2, 
        Option_DeleteOnClose = 4, 
        Option_MDINestable = 8 
    };
    Q_DECLARE_FLAGS(Options, Option)
    Q_ENUM(Options)
 
    
    enum class LayoutSaverOption {
        None = 0, 
        Skip = 1, 
    };
    Q_DECLARE_FLAGS(LayoutSaverOptions, LayoutSaverOption)
 
    enum class IconPlace {
        TitleBar = 1,
        TabBar = 2,
        ToggleAction = 4,
        All = ToggleAction | TitleBar | TabBar
    };
    Q_ENUM(IconPlace)
    Q_DECLARE_FLAGS(IconPlaces, IconPlace)
 
    
    explicit DockWidgetBase(const QString &uniqueName,
                            Options options = KDDockWidgets::DockWidgetBase::Options(),
                            LayoutSaverOptions layoutSaverOptions = KDDockWidgets::DockWidgetBase::LayoutSaverOptions());
 
    ~DockWidgetBase() override;
 
    Q_INVOKABLE void addDockWidgetAsTab(KDDockWidgets::DockWidgetBase *other,
                                        KDDockWidgets::InitialOption initialOption = {});
 
    Q_INVOKABLE void
    addDockWidgetToContainingWindow(KDDockWidgets::DockWidgetBase *other,
                                    KDDockWidgets::Location location,
                                    KDDockWidgets::DockWidgetBase *relativeTo = nullptr,
                                    KDDockWidgets::InitialOption initialOption = {});
 
    virtual void setWidget(QWidgetOrQuick *widget);
 
    QWidgetOrQuick *widget() const;
 
    bool isFloating() const;
 
    bool setFloating(bool floats);
 
    Q_INVOKABLE QAction *toggleAction() const;
 
    Q_INVOKABLE QAction *floatAction() const;
 
    QString uniqueName() const;
 
    QString title() const;
 
    void setTitle(const QString &title);
 
    QRect frameGeometry() const;
 
    Options options() const;
 
    KDDockWidgets::DockWidgetBase::LayoutSaverOptions layoutSaverOptions() const;
 
    void setOptions(Options);
 
    bool isTabbed() const;
 
    bool isCurrentTab() const;
 
    Q_INVOKABLE void setAsCurrentTab();
 
    int tabIndex() const;
 
    int currentTabIndex() const;
 
    void setIcon(const QIcon &icon, IconPlaces places = IconPlace::All);
 
    QIcon icon(IconPlace place = IconPlace::TitleBar) const;
 
    Q_INVOKABLE void forceClose();
 
    TitleBar *titleBar() const;
 
    Q_INVOKABLE bool isOpen() const;
 
    void setAffinities(const QStringList &);
 
    void setAffinityName(const QString &name);
 
    QStringList affinities() const;
 
    Q_INVOKABLE void show();
 
    Q_INVOKABLE void raise();
 
    bool isMainWindow() const;
 
    bool isInMainWindow() const;
 
    MainWindowBase *mainWindow() const;
 
    bool isFocused() const;
 
    Q_INVOKABLE void moveToSideBar();
 
    bool isOverlayed() const;
 
    SideBarLocation sideBarLocation() const;
 
    bool isInSideBar() const;
 
    bool hasPreviousDockedLocation() const;
 
    QSize lastOverlayedSize() const;
 
 
    static DockWidgetBase *byName(const QString &uniqueName);
 
    bool skipsRestore() const;
 
    void setFloatingGeometry(QRect geo);
 
    void setUserType(int userType);
    int userType() const;
 
    void setMDIPosition(QPoint pos);
    void setMDISize(QSize size);
    void setMDIZ(int z);
 
    bool isPersistentCentralDockWidget() const;
 
    void setFloatingWindowFlags(FloatingWindowFlags);
    KDDockWidgets::FloatingWindowFlags floatingWindowFlags() const;
 
Q_SIGNALS:
#ifdef KDDOCKWIDGETS_QTWIDGETS
    void parentChanged();
#endif
 
    void shown();
 
    void hidden();
 
    void iconChanged();
 
    void titleChanged(const QString &title);
 
    void widgetChanged(KDDockWidgets::QWidgetOrQuick *);
 
    void optionsChanged(KDDockWidgets::DockWidgetBase::Options);
 
    void isFocusedChanged(bool);
 
    void isOverlayedChanged(bool);
 
    void isFloatingChanged(bool);
 
    void removedFromSideBar();
 
    void windowActiveAboutToChange(bool activated);
 
    void actualTitleBarChanged();
 
    void aboutToDeleteOnClose();
 
protected:
    void onParentChanged();
    void onShown(bool spontaneous);
    void onHidden(bool spontaneous);
 
#ifndef PYTHON_BINDINGS // Pyside bug: https://bugreports.qt.io/projects/PYSIDE/issues/PYSIDE-1327
    void onCloseEvent(QCloseEvent *e) override;
    bool onResize(QSize newSize) override;
#endif
 
#if defined(DOCKS_DEVELOPER_MODE)
public:
#else
private:
#endif
    Q_DISABLE_COPY(DockWidgetBase)
    friend class MultiSplitter;
    friend class LayoutWidget;
    friend class MDILayoutWidget;
    friend class FloatingWindow;
    friend class Frame;
    friend class DropArea;
    friend class ::TestDocks;
    friend class StateDragging;
    friend class KDDockWidgets::TabWidget;
    friend class KDDockWidgets::TitleBar;
    friend class KDDockWidgets::DragController;
    friend class KDDockWidgets::DockRegistry;
    friend class KDDockWidgets::LayoutSaver;
    friend class KDDockWidgets::MainWindowBase;
    friend class KDDockWidgets::FrameQuick;
    friend class KDDockWidgets::DockWidgetQuick;
 
    static DockWidgetBase *deserialize(const std::shared_ptr<LayoutSaver::DockWidget> &);
 
 
    class Private;
    Private *const d;
 
    Private *dptr() const;
};
 
}
Q_DECLARE_METATYPE(KDDockWidgets::Location)
Q_DECLARE_METATYPE(KDDockWidgets::DockWidgetBase::List)
 
#endif