libscratchcpp::ScratchConfiguration Class Reference

The ScratchConfiguration class provides methods for adding custom extensions. More...

#include <scratchcpp/scratchconfiguration.h>

Public Member Functions
	ScratchConfiguration ()=delete

Static Public Member Functions
static void	registerExtension (std::shared_ptr< IExtension > extension)
static void	removeExtension (std::shared_ptr< IExtension > extension)
static IExtension *	getExtension (const std::string &name)
template<class T>
static IExtension *	getExtension ()
static void	registerGraphicsEffect (std::shared_ptr< IGraphicsEffect > effect)
static void	removeGraphicsEffect (const std::string &name)
static IGraphicsEffect *	getGraphicsEffect (const std::string &name)
static const std::string &	version ()
static int	majorVersion ()
static int	minorVersion ()
static int	patchVersion ()

Detailed Description

The ScratchConfiguration class provides methods for adding custom extensions.

Constructor & Destructor Documentation

ScratchConfiguration()

libscratchcpp::ScratchConfiguration::ScratchConfiguration ( )

delete

Member Function Documentation

getExtension() [1/2]

template<class T>

static IExtension * libscratchcpp::ScratchConfiguration::getExtension ( )

inlinestatic

Finds the extension of class T. Returns nullptr if it isn't registered.

getExtension() [2/2]

IExtension * ScratchConfiguration::getExtension ( const std::string & name )

static

Returns the extension with the given name, or nullptr if it isn't registered.

getGraphicsEffect()

IGraphicsEffect * ScratchConfiguration::getGraphicsEffect ( const std::string & name )

static

Returns the graphics effect with the given name, or nullptr if it isn't registered.

majorVersion()

int ScratchConfiguration::majorVersion ( )

static

Returns the major version of the library.

minorVersion()

int ScratchConfiguration::minorVersion ( )

static

Returns the minor version of the library.

patchVersion()

int ScratchConfiguration::patchVersion ( )

static

Returns the patch version of the library.

registerExtension()

void ScratchConfiguration::registerExtension ( std::shared_ptr< IExtension > extension )

static

Registers the given extension.

registerGraphicsEffect()

void ScratchConfiguration::registerGraphicsEffect ( std::shared_ptr< IGraphicsEffect > effect )

static

Registers the given graphics effect.

removeExtension()

void ScratchConfiguration::removeExtension ( std::shared_ptr< IExtension > extension )

static

Unregisters the given extension.

removeGraphicsEffect()

void ScratchConfiguration::removeGraphicsEffect ( const std::string & name )

static

Removes the given graphics effect.

version()

const std::string & ScratchConfiguration::version ( )

static

Returns the version string of the library.

---

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

• include/scratchcpp/scratchconfiguration.h
• src/scratchconfiguration.cpp