Config.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_DOCKWIDGETS_CONFIG_H
#define KD_DOCKWIDGETS_CONFIG_H
 
#include "kddockwidgets/docks_export.h"
#include "kddockwidgets/KDDockWidgets.h"
 
namespace KDDockWidgets {
 
namespace Core {
class DockWidget;
class MainWindow;
class DropArea;
class Draggable;
class ViewFactory;
}
 
typedef KDDockWidgets::Core::DockWidget *(*DockWidgetFactoryFunc)(const QString &name);
typedef KDDockWidgets::Core::MainWindow *(*MainWindowFactoryFunc)(const QString &name, KDDockWidgets::MainWindowOptions);
typedef bool (*DragAboutToStartFunc)(Core::Draggable *draggable);
typedef void (*DragEndedFunc)();
 
typedef bool (*DropIndicatorAllowedFunc)(DropLocation location,
                                         const Vector<Core::DockWidget *> &source,
                                         const Vector<Core::DockWidget *> &target,
                                         Core::DropArea *dropArea);
 
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, 
        InternalFlag_NoDeleteLaterWorkaround = 128, 
        InternalFlag_DeleteSeparatorsLater = 256 
    };
    Q_DECLARE_FLAGS(InternalFlags, InternalFlag)
 
    
    enum MDIFlag {
        MDIFlag_None = 0,
        MDIFlag_NoClickToRaise = 1 
    };
    Q_DECLARE_FLAGS(MDIFlags, MDIFlag)
 
    
    Flags flags() const;
 
    MDIFlags mdiFlags() const;
 
    void setFlags(Flags flags);
 
    void setMDIFlags(MDIFlags);
 
    static bool hasFlag(Flag);
 
    static bool hasMDIFlag(MDIFlag);
 
    void setDockWidgetFactoryFunc(DockWidgetFactoryFunc);
 
    DockWidgetFactoryFunc dockWidgetFactoryFunc() const;
 
    void setMainWindowFactoryFunc(MainWindowFactoryFunc);
 
    MainWindowFactoryFunc mainWindowFactoryFunc() const;
 
    void setViewFactory(Core::ViewFactory *);
 
    Core::ViewFactory *viewFactory() const;
 
    int separatorThickness() const;
 
    void setSeparatorThickness(int value);
 
    int layoutSpacing() const;
 
    void setLayoutSpacing(int);
 
    void setDraggedWindowOpacity(double opacity);
 
    void setTransparencyOnlyOverDropIndicator(bool only);
 
    double draggedWindowOpacity() const;
 
    bool transparencyOnlyOverDropIndicator() const;
 
    void setDropIndicatorsInhibited(bool inhibit) const;
 
    bool dropIndicatorsInhibited() const;
 
    void setDropIndicatorAllowedFunc(DropIndicatorAllowedFunc func);
 
    void setDragAboutToStartFunc(DragAboutToStartFunc func);
    DragAboutToStartFunc dragAboutToStartFunc() const;
 
    void setDragEndedFunc(DragEndedFunc func);
    DragEndedFunc dragEndedFunc() const;
 
    DropIndicatorAllowedFunc dropIndicatorAllowedFunc() const;
 
    void setAbsoluteWidgetMinSize(Size size);
    Size absoluteWidgetMinSize() const;
 
    void setAbsoluteWidgetMaxSize(Size size);
    Size 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 setStartDragDistance(int);
 
    int startDragDistance() const;
 
    void printDebug();
 
    void setLayoutSaverStrictMode(bool);
    bool layoutSaverUsesStrictMode() const;
 
    void setOnlyProgrammaticDrag(bool);
    bool onlyProgrammaticDrag() const;
 
private:
    KDDW_DELETE_COPY_CTOR(Config)
    Config();
    class Private;
    Private *const d;
};
 
}
 
Q_DECLARE_OPERATORS_FOR_FLAGS(KDDockWidgets::Config::Flags)
 
#endif