dockwidgetsettings.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2016 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_GUI_SETTINGS_DOCKWIDGET_H
#define SWIFT_GUI_SETTINGS_DOCKWIDGET_H
 
#include <QMap>
#include <QMetaType>
#include <QString>
 
#include "gui/swiftguiexport.h"
#include "misc/dictionary.h"
#include "misc/propertyindex.h"
#include "misc/settingscache.h"
#include "misc/variant.h"
 
SWIFT_DECLARE_VALUEOBJECT_MIXINS(swift::gui::settings, CDockWidgetSettings)
 
namespace swift::gui::settings
{
    class SWIFT_GUI_EXPORT CDockWidgetSettings : public swift::misc::CValueObject<CDockWidgetSettings>
    {
    public:
        enum ColumnIndex
        {
            IndexFloatingMargins = swift::misc::CPropertyIndexRef::GlobalIndexCDockWidgetSettings,
            IndexFloatingFramelessMargins,
            IndexDockedMargins,
            IndexFrameless,
            IndexFloating
        };
 
        CDockWidgetSettings();
 
        void resetMarginsToDefault();
 
        void reset();
 
        void setMarginsWhenFramelessFloating(const QMargins &margins);
 
        QMargins getMarginsWhenFramelessFloating() const;
 
        void setMarginsWhenFloating(const QMargins &margins);
 
        QMargins getMarginsWhenFloating() const;
 
        void setMarginsWhenDocked(const QMargins &margins);
 
        QMargins getMarginsWhenDocked() const;
 
        bool isFloating() const { return m_floating; }
 
        bool isFramless() const { return m_frameless; }
 
        void setFloating(bool floating) { m_floating = floating; }
 
        void setFrameless(bool frameless) { m_frameless = frameless; }
 
        QByteArray getGeometry() const;
 
        void setGeometry(const QByteArray &ba);
 
        QString convertToQString(bool i18n = false) const;
 
        QString convertToQString(const QString &separator, bool i18n = false) const;
 
        QVariant propertyByIndex(swift::misc::CPropertyIndexRef index) const;
 
        void setPropertyByIndex(swift::misc::CPropertyIndexRef index, const QVariant &variant);
 
    private:
        QString m_floatingMargins { "0:0:0:0" }; 
        QString m_floatingFramelessMargins { "0:0:0:0" }; 
        QString m_dockedMargins { "0:0:0:0" }; 
        QString m_geometry; 
        bool m_floating = false; 
        bool m_frameless = false; 
 
        SWIFT_METACLASS(
            CDockWidgetSettings,
            SWIFT_METAMEMBER(floatingMargins),
            SWIFT_METAMEMBER(floatingFramelessMargins),
            SWIFT_METAMEMBER(dockedMargins),
            SWIFT_METAMEMBER(floating),
            SWIFT_METAMEMBER(frameless),
            SWIFT_METAMEMBER(geometry));
    };
 
    struct TDockWidget : public swift::misc::TSettingTrait<CDockWidgetSettings>
    {
        static const char *key() { return "guidockwidget/%Application%/%OwnerName%"; } // Key in data cache
 
        static const QString &humanReadable()
        {
            static const QString name("Dockable widgets");
            return name;
        }
    };
} // namespace swift::gui::settings
 
Q_DECLARE_METATYPE(swift::gui::settings::CDockWidgetSettings)
Q_DECLARE_METATYPE(swift::misc::CCollection<swift::gui::settings::CDockWidgetSettings>)
 
#endif // SWIFT_GUI_SETTINGS_DOCKWIDGET_H