qtwidgets/views/DockWidget.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2019 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_WIDGETS_H
#define KD_DOCKWIDGET_WIDGETS_H
#pragma once
 
#include "kddockwidgets/core/views/DockWidgetViewInterface.h"
#include "View.h"
 
// clazy:excludeall=ctor-missing-parent-argument
 
namespace KDDockWidgets {
 
namespace QtWidgets {
 
#ifdef PYTHON_BINDINGS
class DOCKS_EXPORT DockWidget : public QWidget,
                                public Core::DockWidgetViewInterface
#else
class DOCKS_EXPORT DockWidget : public QtWidgets::View<QWidget>,
                                public Core::DockWidgetViewInterface
#endif
{
    Q_OBJECT
public:
    using QWidget::size;
 
    explicit DockWidget(const QString &uniqueName, DockWidgetOptions options = {},
                        LayoutSaverOptions layoutSaverOptions = {},
                        Qt::WindowFlags windowFlags = Qt::Tool);
 
    ~DockWidget() override;
 
    void setWidget(QWidget *widget);
 
    QWidget *widget() const;
 
    QAction *toggleAction() const;
    QAction *floatAction() const;
 
#ifndef PYTHON_BINDINGS
    // Override QWidget::show() as there's more to do.
    void show() override
    {
        Core::DockWidgetViewInterface::open();
    }
 
    // Override QWidget::raise() as there's more to do, like setting it as current tab
    // if it's tabbed
    void raise() override
    {
        Core::DockWidgetViewInterface::raise();
    }
#endif
 
Q_SIGNALS:
    void optionsChanged(KDDockWidgets::DockWidgetOptions);
    void guestViewChanged();
    void isFocusedChanged(bool);
    void isFloatingChanged(bool);
    void isOpenChanged(bool);
    void windowActiveAboutToChange(bool);
 
    void isCurrentTabChanged(bool);
 
protected:
    bool event(QEvent *) override;
    void mouseDoubleClickEvent(QMouseEvent *ev) override;
    void resizeEvent(QResizeEvent *) override;
    std::shared_ptr<Core::View> focusCandidate() const override;
 
private:
    class Private;
    Private *const d;
};
 
}
 
}
 
#endif