Config.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_DOCKWIDGETS_CONFIG_H
#define KD_DOCKWIDGETS_CONFIG_H
 
#include "docks_export.h"
#include "KDDockWidgets.h"
 
#include <qglobal.h>
 
QT_BEGIN_NAMESPACE
class QQmlEngine;
class QSize;
QT_END_NAMESPACE
 
namespace KDDockWidgets {
 
class DockWidgetBase;
class MainWindowBase;
class FrameworkWidgetFactory;
class DropArea;
 
typedef KDDockWidgets::DockWidgetBase *(*DockWidgetFactoryFunc)(const QString &name);
typedef KDDockWidgets::MainWindowBase *(*MainWindowFactoryFunc)(const QString &name);
 
typedef bool (*DropIndicatorAllowedFunc)(DropLocation location,
                                         const QVector<DockWidgetBase *> &source,
                                         const QVector<DockWidgetBase *> &target,
                                         DropArea *dropArea);
 
typedef bool (*TabbingAllowedFunc)(const QVector<DockWidgetBase *> &source,
                                   const QVector<DockWidgetBase *> &target);
 
class DOCKS_EXPORT Config
{
public:
    static Config &self();
 
    ~Config();
 
    enum Flag {
        Flag_None = 0, 
        Flag_NativeTitleBar = 1, 
        Flag_AeroSnapWithClientDecos = 2, 
        Flag_AlwaysTitleBarWhenFloating = 4, 
        Flag_HideTitleBarWhenTabsVisible = 8, 
        Flag_AlwaysShowTabs = 16, 
        Flag_AllowReorderTabs = 32, 
        Flag_TabsHaveCloseButton = 64, 
        Flag_DoubleClickMaximizes = 128, 
        Flag_TitleBarHasMaximizeButton = 256, 
        Flag_TitleBarIsFocusable = 512, 
        Flag_LazyResize = 1024, 
        Flag_DontUseUtilityFloatingWindows = 0x1000,
        Flag_TitleBarHasMinimizeButton = 0x2000 | Flag_DontUseUtilityFloatingWindows, 
        Flag_TitleBarNoFloatButton = 0x4000, 
        Flag_AutoHideSupport = 0x8000 | Flag_TitleBarNoFloatButton, 
        Flag_KeepAboveIfNotUtilityWindow = 0x10000, 
        Flag_CloseOnlyCurrentTab = 0x20000, 
        Flag_ShowButtonsOnTabBarIfTitleBarHidden = 0x40000, 
        Flag_AllowSwitchingTabsViaMenu = 0x80000, 
        Flag_AutoHideAsTabGroups = 0x100000, 
        Flag_Default = Flag_AeroSnapWithClientDecos 
    };
    Q_DECLARE_FLAGS(Flags, Flag)
 
    
    enum CustomizableWidget {
        CustomizableWidget_None = 0, 
        CustomizableWidget_TitleBar, 
        CustomizableWidget_DockWidget, 
        CustomizableWidget_Frame, 
        CustomizableWidget_TabBar, 
        CustomizableWidget_TabWidget, 
        CustomizableWidget_FloatingWindow, 
        CustomizableWidget_Separator 
    };
    Q_DECLARE_FLAGS(CustomizableWidgets, CustomizableWidget)
 
    
    enum InternalFlag {
        InternalFlag_None = 0, 
        InternalFlag_NoAeroSnap = 1, 
        InternalFlag_DontUseParentForFloatingWindows = 2, 
        InternalFlag_DontUseQtToolWindowsForFloatingWindows = 4, 
        InternalFlag_DontShowWhenUnfloatingHiddenWindow = 8, 
        InternalFlag_UseTransparentFloatingWindow = 16, 
        InternalFlag_DisableTranslucency = 32, 
        InternalFlag_TopLevelIndicatorRubberBand = 64 
    };
    Q_DECLARE_FLAGS(InternalFlags, InternalFlag)
 
    
    Flags flags() const;
 
    void setFlags(Flags flags);
 
    void setDockWidgetFactoryFunc(DockWidgetFactoryFunc);
 
    DockWidgetFactoryFunc dockWidgetFactoryFunc() const;
 
    void setMainWindowFactoryFunc(MainWindowFactoryFunc);
 
    MainWindowFactoryFunc mainWindowFactoryFunc() const;
 
    void setFrameworkWidgetFactory(FrameworkWidgetFactory *);
 
    FrameworkWidgetFactory *frameworkWidgetFactory() const;
 
    int separatorThickness() const;
 
    void setSeparatorThickness(int value);
 
    void setDraggedWindowOpacity(qreal opacity);
 
    qreal draggedWindowOpacity() const;
 
    void setDropIndicatorsInhibited(bool inhibit) const;
 
    bool dropIndicatorsInhibited() const;
 
    void setTabbingAllowedFunc(TabbingAllowedFunc func);
 
    TabbingAllowedFunc tabbingAllowedFunc() const;
 
    void setDropIndicatorAllowedFunc(DropIndicatorAllowedFunc func);
 
    DropIndicatorAllowedFunc dropIndicatorAllowedFunc() const;
 
    void setAbsoluteWidgetMinSize(QSize size);
    QSize absoluteWidgetMinSize() const;
 
    void setAbsoluteWidgetMaxSize(QSize size);
    QSize absoluteWidgetMaxSize() const;
 
    // via CSS stylesheets.
    void setDisabledPaintEvents(CustomizableWidgets);
    Config::CustomizableWidgets disabledPaintEvents() const;
 
    InternalFlags internalFlags() const;
 
    void setInternalFlags(InternalFlags flags);
 
    void setMDIPopupThreshold(int);
    int mdiPopupThreshold() const;
 
    void printDebug();
 
#ifdef KDDOCKWIDGETS_QTQUICK
    void setQmlEngine(QQmlEngine *);
    QQmlEngine *qmlEngine() const;
#endif
 
private:
    Q_DISABLE_COPY(Config)
    Config();
    class Private;
    Private *const d;
};
 
}
 
Q_DECLARE_OPERATORS_FOR_FLAGS(KDDockWidgets::Config::Flags)
 
#endif