core/FloatingWindow.h

Go to the documentation of this file.

/*
  This file is part of KDDockWidgets.
 
  SPDX-FileCopyrightText: 2020 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.
*/
 
#pragma once
 
#include "Controller.h"
 
#include "kddockwidgets/KDDockWidgets.h"
#include "kddockwidgets/docks_export.h"
#include "kddockwidgets/LayoutSaver.h"
#include "Group.h"
#include "kddockwidgets/QtCompat_p.h"
#include "kddockwidgets/core/Draggable_p.h"
 
QT_BEGIN_NAMESPACE
class QAbstractNativeEventFilter;
QT_END_NAMESPACE
 
namespace KDDockWidgets::Core {
 
class DropArea;
class Group;
class Layout;
class MainWindow;
class TitleBar;
 
class DOCKS_EXPORT FloatingWindow : public Controller, public Draggable
{
    Q_OBJECT
public:
    explicit FloatingWindow(
        Rect suggestedGeometry, MainWindow *parent = nullptr,
        FloatingWindowFlags requestedFlags = FloatingWindowFlag::FromGlobalConfig);
    explicit FloatingWindow(Core::Group *group, Rect suggestedGeometry,
                            MainWindow *parent = nullptr);
    virtual ~FloatingWindow() override;
 
    bool deserialize(const LayoutSaver::FloatingWindow &);
    LayoutSaver::FloatingWindow serialize() const;
 
    // Draggable:
    std::unique_ptr<WindowBeingDragged> makeWindow() override;
    Core::DockWidget *singleDockWidget() const override final;
    bool isWindow() const override;
 
    Vector<DockWidget *> dockWidgets() const;
    Core::Group::List groups() const;
    DropArea *dropArea() const;
 
    int userType() const;
 
    bool isUtilityWindow() const;
 
    static void ensureRectIsOnScreen(Rect &geometry);
 
#ifdef KDDW_FRONTEND_QT_WINDOWS
    void setLastHitTest(int hitTest)
    {
        m_lastHitTest = hitTest;
    }
#endif
    Core::TitleBar *titleBar() const
    {
        return m_titleBar;
    }
 
    void setSuggestedGeometry(Rect suggestedRect,
                              SuggestedGeometryHints = SuggestedGeometryHint_None);
 
    bool anyNonClosable() const;
    bool anyNonDockable() const;
 
    bool hasSingleGroup() const;
 
    bool hasSingleDockWidget() const;
 
    Core::Group *singleFrame() const;
 
    bool beingDeleted() const;
 
    void scheduleDeleteLater();
 
    Core::DropArea *multiSplitter() const;
 
    Layout *layout() const;
 
    bool isInDragArea(Point globalPoint) const;
 
    bool isMDI() const override;
 
    void updateTitleAndIcon();
    void updateTitleBarVisibility();
 
    Vector<QString> affinities() const;
 
    Rect dragRect() const;
 
    bool allDockWidgetsHave(DockWidgetOption) const;
 
    bool anyDockWidgetsHas(DockWidgetOption) const;
 
    bool allDockWidgetsHave(LayoutSaverOption) const;
 
    bool anyDockWidgetsHas(LayoutSaverOption) const;
 
    void addDockWidget(DockWidget *, KDDockWidgets::Location location, DockWidget *relativeTo,
                       const InitialOption & = {});
 
    MainWindow *mainWindow() const;
 
    Margins contentMargins() const;
 
    // The state reported by QWidget is not always the same as what the
    // window manager thinks, due to the async nature. This method
    // returns the last state reported by the window manager itself.
    WindowState lastWindowManagerState() const;
    void setLastWindowManagerState(WindowState);
 
    static Qt::WindowFlags s_windowFlagsOverride;
 
    bool supportsMinimizeButton() const;
 
    bool supportsMaximizeButton() const;
 
    void maybeCreateResizeHandler();
    FloatingWindowFlags floatingWindowFlags() const;
 
    void focus(Qt::FocusReason reason);
 
    class Private;
    Private *dptr() const;
 
private:
    Private *const d;
 
protected:
    Core::TitleBar *const m_titleBar;
    WindowState m_lastWindowManagerState = WindowState::None;
 
private:
    KDDW_DELETE_COPY_CTOR(FloatingWindow)
    Size maxSizeHint() const;
    void onFrameCountChanged(int count);
    void onVisibleFrameCountChanged(int count);
    void onCloseEvent(CloseEvent *);
    void updateSizeConstraints();
 
    bool m_disableSetVisible = false;
    bool m_deleteScheduled = false;
    bool m_inDtor = false;
    bool m_updatingTitleBarVisibility = false;
    WindowState windowStateOverride() const;
#ifdef KDDW_FRONTEND_QT_WINDOWS
    QAbstractNativeEventFilter *m_nchittestFilter = nullptr;
    int m_lastHitTest = 0;
#endif
};
 
}