/* This file is part of the KDE project * SPDX-FileCopyrightText: 2008 Boudewijn Rempt * * SPDX-License-Identifier: LGPL-2.0-or-later */ #ifndef KIS_PAINTOP_OPTION_H #define KIS_PAINTOP_OPTION_H #include #include #include #include #include #include #include class QWidget; class QString; class KisPaintopLodLimitations; /** * Base interface for paintop options. A paintop option * can be enabled/disabled, has a configuration page * (for example, a curve), a user-visible name and can * be serialized and deserialized into KisPaintOpPresets * * Because KisPaintOpOption classes create a QWidget in * their constructor (the configuration page) you CANNOT * create those objects in a KisPaintOp. KisPaintOps are * created in non-gui threads. * * Options are disabled by default. */ class KRITAUI_EXPORT KisPaintOpOption : public QObject { Q_OBJECT public: using OptionalLodLimitationsReader = std::optional>; enum PaintopCategory { GENERAL, COLOR, TEXTURE, FILTER, MASKING_BRUSH }; KisPaintOpOption(const QString &label, KisPaintOpOption::PaintopCategory category, bool checked); KisPaintOpOption(const QString &label, KisPaintOpOption::PaintopCategory category, lager::cursor checkedCursor); KisPaintOpOption(const QString &label, KisPaintOpOption::PaintopCategory category, lager::cursor checkedCursor, lager::reader externallyEnabledLink); ~KisPaintOpOption() override; KisPaintOpOption::PaintopCategory category() const; virtual bool isCheckable() const; virtual bool isChecked() const; virtual void setChecked(bool checked); bool isEnabled() const; void setLocked(bool value); bool isLocked() const; QString label() const; /** * Reimplement this to use the image in the option widget */ virtual void setImage(KisImageWSP image); virtual void setNode(KisNodeWSP node); virtual void setResourcesInterface(KisResourcesInterfaceSP resourcesInterface); virtual void setCanvasResourcesInterface(KoCanvasResourcesInterfaceSP canvasResourcesInterface); void startReadOptionSetting(const KisPropertiesConfigurationSP setting); void startWriteOptionSetting(KisPropertiesConfigurationSP setting) const; QWidget *configurationPage() const; virtual void lodLimitations(KisPaintopLodLimitations *l) const; OptionalLodLimitationsReader effectiveLodLimitations() const; protected: virtual OptionalLodLimitationsReader lodLimitationsReader() const; void setConfigurationPage(QWidget *page); KisResourcesInterfaceSP resourcesInterface() const; KoCanvasResourcesInterfaceSP canvasResourcesInterface() const; protected: /** * Re-implement this to save the configuration to the paint configuration. */ virtual void writeOptionSetting(KisPropertiesConfigurationSP setting) const { Q_UNUSED(setting); } /** * Re-implement this to set the widgets with the values in @p setting. */ virtual void readOptionSetting(const KisPropertiesConfigurationSP setting) { Q_UNUSED(setting); } protected Q_SLOTS: void emitSettingChanged(); void emitCheckedChanged(bool checked); void emitEnabledChanged(bool enabled); Q_SIGNALS: /** * Q_EMIT this whenever a setting has changed. It will update the preview */ void sigSettingChanged(); /** * Q_EMIT this whenever a checked state of the option has changed. It as always * emitted *before* sigSettingChanged() */ void sigCheckedChanged(bool value); void sigEnabledChanged(bool value); private: void slotEnablePageWidget(bool value); protected: bool m_checkable {false}; bool m_locked {false}; private: struct Private; Private* const m_d; }; #endif