KDDockWidgets.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_KDDOCKWIDGETS_H
#define KD_KDDOCKWIDGETS_H
 
#include "kddockwidgets/docks_export.h"
 
#include "QtCompat_p.h"
 
#ifdef KDDW_FRONTEND_QT
#include "Qt5Qt6Compat_p.h"
 
#ifdef Q_OS_WIN
#define KDDW_FRONTEND_QT_WINDOWS
#endif
 
#ifdef KDDW_FRONTEND_QTWIDGETS
#include <QWidget>
#endif
 
#endif
 
namespace KDDockWidgets::QtQuick {
}
namespace KDDockWidgets::QtWidgets {
}
namespace KDDockWidgets::QtCommon {
}
namespace KDDockWidgets::Flutter {
}
 
namespace KDDockWidgets {
QT_DOCKS_EXPORT
Q_NAMESPACE
 
namespace QtWidgets {
class DockWidget;
}
 
namespace Core {
class Item;
class ItemBoxContainer;
}
 
enum Location {
    Location_None,
    Location_OnLeft, 
    Location_OnTop, 
    Location_OnRight, 
    Location_OnBottom 
};
Q_ENUM_NS(Location)
 
enum MainWindowOption {
    MainWindowOption_None = 0, 
    MainWindowOption_HasCentralFrame =
        1, 
    MainWindowOption_MDI = 2, 
    MainWindowOption_HasCentralWidget =
        4 | MainWindowOption_HasCentralFrame, 
    MainWindowOption_QDockWidgets = 8, 
    MainWindowOption_ManualInit = 16 
};
Q_DECLARE_FLAGS(MainWindowOptions, MainWindowOption)
Q_ENUM_NS(MainWindowOptions)
 
 
enum DockWidgetOption {
    DockWidgetOption_None = 0, 
    DockWidgetOption_NotClosable =
        1, 
    DockWidgetOption_NotDockable = 2, 
    DockWidgetOption_DeleteOnClose = 4, 
    DockWidgetOption_MDINestable =
        8 
};
Q_DECLARE_FLAGS(DockWidgetOptions, DockWidgetOption)
Q_ENUM_NS(DockWidgetOptions)
 
 
enum class LayoutSaverOption {
    None = 0, 
    Skip = 1, 
    CheckForPreviousRestore = 2, 
};
Q_DECLARE_FLAGS(LayoutSaverOptions, LayoutSaverOption)
 
enum class IconPlace {
    TitleBar = 1,
    TabBar = 2,
    ToggleAction = 4,
    All = ToggleAction | TitleBar | TabBar
};
Q_ENUM_NS(IconPlace)
Q_DECLARE_FLAGS(IconPlaces, IconPlace)
 
enum class FrontendType {
    QtWidgets = 1,
    QtQuick,
    Flutter,
};
Q_ENUM_NS(FrontendType)
 
 
enum class DefaultSizeMode {
    ItemSize, 
    Fair, 
    FairButFloor, 
    NoDefaultSizeMode, 
};
Q_ENUM_NS(DefaultSizeMode)
 
 
enum AddingOption {
    AddingOption_None = 0,
    AddingOption_StartHidden
};
Q_ENUM_NS(AddingOption)
 
enum class InitialVisibilityOption {
    StartVisible = 0, 
    StartHidden, 
    PreserveCurrentTab 
};
Q_ENUM_NS(InitialVisibilityOption)
 
enum class NeighbourSqueezeStrategy {
    AllNeighbours, 
    ImmediateNeighboursFirst 
};
Q_ENUM_NS(NeighbourSqueezeStrategy)
 
 
struct DOCKS_EXPORT InitialOption
{
    // Implicit ctors for convenience:
 
    InitialOption();
    InitialOption(InitialVisibilityOption v);
    InitialOption(Size size);
    InitialOption(InitialVisibilityOption v, Size size);
 
    bool startsHidden() const
    {
        return visibility == InitialVisibilityOption::StartHidden;
    }
 
    bool preservesCurrentTab() const
    {
        return visibility == InitialVisibilityOption::PreserveCurrentTab;
    }
 
    int preferredLength(Qt::Orientation o) const
    {
        return o == Qt::Horizontal ? preferredSize.width() : preferredSize.height();
    }
 
    bool hasPreferredLength(Qt::Orientation o) const
    {
        return preferredLength(o) > 0;
    }
 
    InitialVisibilityOption visibility = InitialVisibilityOption::StartVisible;
 
    Size preferredSize;
 
    static NeighbourSqueezeStrategy s_defaultNeighbourSqueezeStrategy;
    NeighbourSqueezeStrategy neighbourSqueezeStrategy = s_defaultNeighbourSqueezeStrategy;
 
    InitialOption(DefaultSizeMode mode);
 
private:
    friend class Core::Item;
    friend class Core::ItemBoxContainer;
 
    DefaultSizeMode sizeMode = DefaultSizeMode::Fair;
};
 
enum RestoreOption {
    RestoreOption_None = 0,
    RestoreOption_RelativeToMainWindow =
        1, 
    RestoreOption_AbsoluteFloatingDockWindows = 2, 
};
Q_DECLARE_FLAGS(RestoreOptions, RestoreOption)
Q_ENUM_NS(RestoreOptions)
 
enum class DropIndicatorType {
    Classic, 
    Segmented, 
    None 
};
Q_ENUM_NS(DropIndicatorType)
 
 
enum SuggestedGeometryHint {
    SuggestedGeometryHint_None,
    SuggestedGeometryHint_PreserveCenter = 1,
    SuggestedGeometryHint_GeometryIsFromDocked = 2
};
Q_DECLARE_FLAGS(SuggestedGeometryHints, SuggestedGeometryHint)
Q_ENUM_NS(SuggestedGeometryHint)
 
 
enum class SideBarLocation {
    None = 0,
    North,
    East,
    West,
    South,
    Last
};
 
enum class TitleBarButtonType {
    Close = 1,
    Float = 2,
    Minimize = 4,
    Maximize = 8,
    Normal = 16, // Restore from maximized state
    AutoHide = 32,
    UnautoHide = 64,
    AllTitleBarButtonTypes = Close | Float | Minimize | Maximize | Normal | AutoHide | UnautoHide
};
Q_ENUM_NS(TitleBarButtonType)
Q_DECLARE_FLAGS(TitleBarButtonTypes, TitleBarButtonType)
 
 
enum DropLocation {
    DropLocation_None = 0,
    DropLocation_Left = 1,
    DropLocation_Top = 2,
    DropLocation_Right = 4,
    DropLocation_Bottom = 8,
    DropLocation_Center = 16,
    DropLocation_OutterLeft = 32,
    DropLocation_OutterTop = 64,
    DropLocation_OutterRight = 128,
    DropLocation_OutterBottom = 256,
    DropLocation_Inner =
        DropLocation_Left | DropLocation_Right | DropLocation_Top | DropLocation_Bottom,
    DropLocation_Outter = DropLocation_OutterLeft | DropLocation_OutterRight
        | DropLocation_OutterTop | DropLocation_OutterBottom,
    DropLocation_Horizontal =
        DropLocation_Left | DropLocation_Right | DropLocation_OutterLeft | DropLocation_OutterRight,
    DropLocation_Vertical =
        DropLocation_Top | DropLocation_Bottom | DropLocation_OutterTop | DropLocation_OutterBottom
};
Q_ENUM_NS(DropLocation)
 
 
enum CursorPosition {
    CursorPosition_Undefined = 0,
    CursorPosition_Left = 1,
    CursorPosition_Right = 2,
    CursorPosition_Top = 4,
    CursorPosition_Bottom = 8,
    CursorPosition_TopLeft = CursorPosition_Top | CursorPosition_Left,
    CursorPosition_TopRight = CursorPosition_Top | CursorPosition_Right,
    CursorPosition_BottomRight = CursorPosition_Bottom | CursorPosition_Right,
    CursorPosition_BottomLeft = CursorPosition_Bottom | CursorPosition_Left,
    CursorPosition_Horizontal = CursorPosition_Right | CursorPosition_Left,
    CursorPosition_Vertical = CursorPosition_Top | CursorPosition_Bottom,
    CursorPosition_All =
        CursorPosition_Left | CursorPosition_Right | CursorPosition_Top | CursorPosition_Bottom
};
Q_DECLARE_FLAGS(CursorPositions, CursorPosition)
Q_ENUM_NS(CursorPosition)
 
 
 
enum FrameOption {
    FrameOption_None = 0,
    FrameOption_AlwaysShowsTabs = 1,
    FrameOption_IsCentralFrame = 2,
    FrameOption_IsOverlayed = 4,
    FrameOption_NonDockable = 8 
};
Q_DECLARE_FLAGS(FrameOptions, FrameOption)
Q_ENUM_NS(FrameOptions)
 
 
enum StackOption {
    StackOption_None = 0,
    StackOption_DocumentMode = 1 
};
Q_DECLARE_FLAGS(StackOptions, StackOption)
Q_ENUM_NS(StackOptions)
 
 
enum class FloatingWindowFlag {
    None = 0,
    FromGlobalConfig = 1, // KDDockWidgets::Config is used instead
    TitleBarHasMinimizeButton = 2,
    TitleBarHasMaximizeButton = 4,
    KeepAboveIfNotUtilityWindow = 8,
    NativeTitleBar = 16,
    HideTitleBarWhenTabsVisible = 32,
    AlwaysTitleBarWhenFloating = 64,
    DontUseParentForFloatingWindows = 128,
    UseQtWindow = 256,
    UseQtTool = 512,
    StartsMinimized = 1024
};
Q_DECLARE_FLAGS(FloatingWindowFlags, FloatingWindowFlag)
 
 
enum class WindowState {
    None = 0,
    Minimized = 1,
    Maximized = 2,
    FullScreen = 4
};
Q_DECLARE_FLAGS(WindowStates, WindowState)
 
 
enum class CloseReason {
    Unspecified = 0, 
    TitleBarCloseButton = 1, 
    Action = 2, 
    MovedToSideBar = 4, 
    OverlayCollapse = 8 
};
 
void DOCKS_EXPORT initFrontend(FrontendType);
 
DOCKS_EXPORT const char *spdlogLoggerName();
 
#ifdef KDDW_FRONTEND_QTWIDGETS
 
template<typename T>
inline T *findAncestor(QWidget *widget)
{
    QWidget *p = widget;
    while (p) {
        if (auto w = qobject_cast<T *>(p))
            return w;
 
        if (p->isWindow()) {
            // No need to check across window boundaries.
            // Main window is parent of floating windows.
            return nullptr;
        }
 
        p = p->parentWidget();
    }
 
    return nullptr;
}
#endif
 
template<typename T>
T bound(T minVal, T value, T maxVal)
{
    return std::max(minVal, std::min(value, maxVal));
}
 
inline bool fuzzyCompare(double a, double b, double epsilon = 0.0001)
{
    return std::abs(a - b) < epsilon;
}
 
} // end namespace
 
Q_DECLARE_OPERATORS_FOR_FLAGS(KDDockWidgets::FrameOptions)
Q_DECLARE_METATYPE(KDDockWidgets::InitialVisibilityOption)
Q_DECLARE_METATYPE(KDDockWidgets::Location)
 
#define KDDW_DELETE_COPY_CTOR(NAME)         \
    NAME(const NAME &) = delete;            \
    NAME(const NAME &&) = delete;           \
    NAME &operator=(const NAME &) = delete; \
    NAME &operator=(const NAME &&) = delete;
 
#define KDDW_UNUSED(name) (( void )name);
 
 
#endif