Krita Source Code Documentation
Loading...
Searching...
No Matches
KisPaintopPropertiesCanvasResourcesBase Class Referenceabstract

#include <KisPaintopPropertiesBase.h>

+ Inheritance diagram for KisPaintopPropertiesCanvasResourcesBase:

Public Member Functions

template<typename KisPropertiesConfigurationPointer >
QList< KoResourceLoadResultprepareEmbeddedResources (const KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface) const
 
template<typename KisPropertiesConfigurationPointer >
QList< KoResourceLoadResultprepareLinkedResources (const KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface) const
 
template<typename KisPropertiesConfigurationPointer >
void readOptionSetting (KisPropertiesConfigurationPointer settings, KisResourcesInterfaceSP resourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface)
 
template<typename KisPropertiesConfigurationPointer >
void writeOptionSetting (KisPropertiesConfigurationPointer settings) const
 
virtual ~KisPaintopPropertiesCanvasResourcesBase ()
 

Protected Member Functions

virtual QList< KoResourceLoadResultprepareEmbeddedResourcesImpl (const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const =0
 
virtual QList< KoResourceLoadResultprepareLinkedResourcesImpl (const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const =0
 
virtual void readOptionSettingResourceImpl (const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface)=0
 
virtual void writeOptionSettingImpl (KisPropertiesConfiguration *settings) const =0
 

Detailed Description

This is a special base class for all the options that load/save settings into a properties objects and do not store the properties themselves. A KisPaintOpOption derived class generates a QWidget for its configuration page. This cannot be created from a KisPaintO[

This class adapts your option to allow its easy use with both raw pointers and shared pointers.

Motivation: In quite a lot of places we call some options from the KisPaintOpSettings class itself with patting 'this' as a parameter into read/writeOptionSetting(). Conversion of 'this' into a shared pointer is extremely dangerous, and, ideally, should be prohibited. We cannot prohibit it atm, but we still can create a special interface for accepting raw pointers, which will be used automatically, when 'this' is passed.

Definition at line 42 of file KisPaintopPropertiesBase.h.

Constructor & Destructor Documentation

◆ ~KisPaintopPropertiesCanvasResourcesBase()

KisPaintopPropertiesCanvasResourcesBase::~KisPaintopPropertiesCanvasResourcesBase ( )
virtual

Definition at line 22 of file KisPaintopPropertiesBase.cpp.

23{
24
25}

Member Function Documentation

◆ prepareEmbeddedResources()

template<typename KisPropertiesConfigurationPointer >
QList< KoResourceLoadResult > KisPaintopPropertiesCanvasResourcesBase::prepareEmbeddedResources ( const KisPropertiesConfigurationPointer settings,
KisResourcesInterfaceSP resourcesInterface ) const
inline

Definition at line 66 of file KisPaintopPropertiesBase.h.

67 {
68 return prepareEmbeddedResourcesImpl(removeSharedPointer(settings), resourcesInterface);
69 }
virtual QList< KoResourceLoadResult > prepareEmbeddedResourcesImpl(const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const =0
T * removeSharedPointer(T *value)

References removeSharedPointer().

◆ prepareEmbeddedResourcesImpl()

virtual QList< KoResourceLoadResult > KisPaintopPropertiesCanvasResourcesBase::prepareEmbeddedResourcesImpl ( const KisPropertiesConfiguration * settings,
KisResourcesInterfaceSP resourcesInterface ) const
protectedpure virtual

Implemented in KisBrushOptionProperties.

◆ prepareLinkedResources()

template<typename KisPropertiesConfigurationPointer >
QList< KoResourceLoadResult > KisPaintopPropertiesCanvasResourcesBase::prepareLinkedResources ( const KisPropertiesConfigurationPointer settings,
KisResourcesInterfaceSP resourcesInterface ) const
inline

Definition at line 60 of file KisPaintopPropertiesBase.h.

61 {
62 return prepareLinkedResourcesImpl(removeSharedPointer(settings), resourcesInterface);
63 }
virtual QList< KoResourceLoadResult > prepareLinkedResourcesImpl(const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface) const =0

References removeSharedPointer().

◆ prepareLinkedResourcesImpl()

virtual QList< KoResourceLoadResult > KisPaintopPropertiesCanvasResourcesBase::prepareLinkedResourcesImpl ( const KisPropertiesConfiguration * settings,
KisResourcesInterfaceSP resourcesInterface ) const
protectedpure virtual

Implemented in KisBrushOptionProperties.

◆ readOptionSetting()

template<typename KisPropertiesConfigurationPointer >
void KisPaintopPropertiesCanvasResourcesBase::readOptionSetting ( KisPropertiesConfigurationPointer settings,
KisResourcesInterfaceSP resourcesInterface,
KoCanvasResourcesInterfaceSP canvasResourcesInterface )
inline

Definition at line 48 of file KisPaintopPropertiesBase.h.

49 {
50 readOptionSettingResourceImpl(removeSharedPointer(settings), resourcesInterface, canvasResourcesInterface);
51 }
virtual void readOptionSettingResourceImpl(const KisPropertiesConfiguration *settings, KisResourcesInterfaceSP resourcesInterface, KoCanvasResourcesInterfaceSP canvasResourcesInterface)=0

References removeSharedPointer().

◆ readOptionSettingResourceImpl()

virtual void KisPaintopPropertiesCanvasResourcesBase::readOptionSettingResourceImpl ( const KisPropertiesConfiguration * settings,
KisResourcesInterfaceSP resourcesInterface,
KoCanvasResourcesInterfaceSP canvasResourcesInterface )
protectedpure virtual

Implemented in KisBrushOptionProperties.

◆ writeOptionSetting()

template<typename KisPropertiesConfigurationPointer >
void KisPaintopPropertiesCanvasResourcesBase::writeOptionSetting ( KisPropertiesConfigurationPointer settings) const
inline

Definition at line 54 of file KisPaintopPropertiesBase.h.

55 {
57 }
virtual void writeOptionSettingImpl(KisPropertiesConfiguration *settings) const =0

References removeSharedPointer().

◆ writeOptionSettingImpl()

virtual void KisPaintopPropertiesCanvasResourcesBase::writeOptionSettingImpl ( KisPropertiesConfiguration * settings) const
protectedpure virtual

Implemented in KisBrushOptionProperties.


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