#include <KisPlatformPluginInterfaceFactory.h>

Public Member Functions
QString	colorManagementReport (QWidget *widget)

KisExtendedModifiersMapperPluginInterface *	createExtendedModifiersMapper ()

	KisPlatformPluginInterfaceFactory ()

QString	osPreferredColorSpaceReport (QWidget *widget)

bool	surfaceColorManagedByOS ()

Static Public Member Functions
static KisPlatformPluginInterfaceFactory *	instance ()

Private Attributes
bool	m_surfaceColorManagedByOS {false}

Detailed Description

Definition at line 25 of file KisPlatformPluginInterfaceFactory.h.

Constructor & Destructor Documentation

◆ KisPlatformPluginInterfaceFactory()

KisPlatformPluginInterfaceFactory::KisPlatformPluginInterfaceFactory ( )

Definition at line 28 of file KisPlatformPluginInterfaceFactory.cpp.

{
#if KRITA_USE_SURFACE_COLOR_MANAGEMENT_API
 
    auto fetchSurfaceColorManagedByOS = []() {
        KPluginFactory *factory = KoPluginLoader::instance()->loadSinglePlugin(
            std::make_pair("X-Krita-PlatformId", QApplication::platformName()),
            "Krita/PlatformPlugin");
 
        if (factory) {
            QScopedPointer<KisSurfaceColorManagementInfo> interface(factory->create<KisSurfaceColorManagementInfo>());
            return interface && interface->surfaceColorManagedByOS();
        }
 
        return false;
    };
 
    m_surfaceColorManagedByOS = fetchSurfaceColorManagedByOS();
 
#endif /* KRITA_USE_SURFACE_COLOR_MANAGEMENT_API */
}

References KoPluginLoader::instance(), and KoPluginLoader::loadSinglePlugin().

Member Function Documentation

◆ colorManagementReport()

QString KisPlatformPluginInterfaceFactory::colorManagementReport ( QWidget * widget )

Return user-facing information about color management status of the main window surface. The information is intentionally left untranslated, since it is supposed to be used for bugreports.

Definition at line 85 of file KisPlatformPluginInterfaceFactory.cpp.

{
#if KRITA_USE_SURFACE_COLOR_MANAGEMENT_API
    if (KisPlatformPluginInterfaceFactory::instance()->surfaceColorManagedByOS()) {
        KisRootSurfaceInfoProxy proxy(widget);
        KIS_SAFE_ASSERT_RECOVER_NOOP(proxy.isReady());
        return proxy.colorManagementReport();
    } else {
        return "Surface color management is not supported on this platform\n";
    }
#else
    return "Surface color management is disabled\n";
#endif
}

References KisRootSurfaceInfoProxy::colorManagementReport(), instance(), KisRootSurfaceInfoProxy::isReady(), KIS_SAFE_ASSERT_RECOVER_NOOP, and surfaceColorManagedByOS().

◆ createExtendedModifiersMapper()

KisExtendedModifiersMapperPluginInterface * KisPlatformPluginInterfaceFactory::createExtendedModifiersMapper ( )

Creates an instance of the extended modifiers interface using the platform plugin

If the current platform plugin doesn't profide this interface, returns nullptr

Definition at line 116 of file KisPlatformPluginInterfaceFactory.cpp.

{
    KPluginFactory *factory = KoPluginLoader::instance()->loadSinglePlugin(
        std::make_pair("X-Krita-PlatformId", QApplication::platformName()),
        "Krita/PlatformPlugin");
 
    if (factory) {
        return factory->create<KisExtendedModifiersMapperPluginInterface>();
    }
 
    return nullptr;
}

References KoPluginLoader::instance(), and KoPluginLoader::loadSinglePlugin().

◆ instance()

KisPlatformPluginInterfaceFactory * KisPlatformPluginInterfaceFactory::instance ( )

static

Definition at line 50 of file KisPlatformPluginInterfaceFactory.cpp.

{
    return s_instance;
}

◆ osPreferredColorSpaceReport()

QString KisPlatformPluginInterfaceFactory::osPreferredColorSpaceReport ( QWidget * widget )

Return user-facing information about the preferred color space of the operating system. This information is supposed to be used in the preferences dialog, so it is supposed to be translated.

Definition at line 100 of file KisPlatformPluginInterfaceFactory.cpp.

{
#if KRITA_USE_SURFACE_COLOR_MANAGEMENT_API
    if (KisPlatformPluginInterfaceFactory::instance()->surfaceColorManagedByOS()) {
        KisRootSurfaceInfoProxy proxy(widget);
        KIS_SAFE_ASSERT_RECOVER_NOOP(proxy.isReady());
        return proxy.osPreferredColorSpaceReport();
    } else {
        return "Surface color management is not supported on this platform\n";
    }
#else
    return "Surface color management is disabled\n";
#endif
}

References instance(), KisRootSurfaceInfoProxy::isReady(), KIS_SAFE_ASSERT_RECOVER_NOOP, KisRootSurfaceInfoProxy::osPreferredColorSpaceReport(), and surfaceColorManagedByOS().

◆ surfaceColorManagedByOS()

bool KisPlatformPluginInterfaceFactory::surfaceColorManagedByOS ( )

Returns true if Krita is running on a system that manages the color space of the underlying surface. If it is true, the canvas should use KisCanvasSurfaceColorSpaceManager and all other windows should use KisSRGBSurfaceColorSpaceManager to set up the color space properly.

Definition at line 80 of file KisPlatformPluginInterfaceFactory.cpp.

{
    return m_surfaceColorManagedByOS;
}

References m_surfaceColorManagedByOS.

Member Data Documentation

◆ m_surfaceColorManagedByOS

bool KisPlatformPluginInterfaceFactory::m_surfaceColorManagedByOS {false}

private

Definition at line 70 of file KisPlatformPluginInterfaceFactory.h.

70{false};

The documentation for this class was generated from the following files:

libs/ui/KisPlatformPluginInterfaceFactory.h
libs/ui/KisPlatformPluginInterfaceFactory.cpp

Public Member Functions

Static Public Member Functions

Private Attributes