Package that will be used to fill the graphics picker The name of the editor must be unique. If an editor with the given name already exists, the creation will fail. Note that the request to the UI must be send manually by providing this object (serialized) as the package. More...

#include "GraphicsPackage.h"

Inheritance diagram for ot::GraphicsPickerCollectionPackage:

Public Member Functions
	GraphicsPickerCollectionPackage ()

virtual	~GraphicsPickerCollectionPackage ()

virtual void	addToJsonObject (JsonValue &_object, JsonAllocator &_allocator) const override
	Add the object contents to the provided JSON object.

virtual void	setFromJsonObject (const ConstJsonObject &_object) override
	Will set the object contents from the provided JSON object.

void	addCollection (GraphicsPickerCollectionCfg *_collection)

const std::list< GraphicsPickerCollectionCfg * > &	collections (void) const

Public Member Functions inherited from ot::Serializable
	Serializable ()

virtual	~Serializable ()

virtual void	addToJsonObject (ot::JsonValue &_object, ot::JsonAllocator &_allocator) const =0
	Add the object contents to the provided JSON object.

Detailed Description

Package that will be used to fill the graphics picker The name of the editor must be unique. If an editor with the given name already exists, the creation will fail. Note that the request to the UI must be send manually by providing this object (serialized) as the package.

Constructor & Destructor Documentation

◆ GraphicsPickerCollectionPackage()

ot::GraphicsPickerCollectionPackage::GraphicsPickerCollectionPackage ( )

◆ ~GraphicsPickerCollectionPackage()

ot::GraphicsPickerCollectionPackage::~GraphicsPickerCollectionPackage ( )

virtual

Member Function Documentation

◆ addCollection()

void ot::GraphicsPickerCollectionPackage::addCollection ( GraphicsPickerCollectionCfg * _collection )

◆ addToJsonObject()

void ot::GraphicsPickerCollectionPackage::addToJsonObject	(	JsonValue &	_object,
		JsonAllocator &	_allocator ) const

overridevirtual

Add the object contents to the provided JSON object.

Parameters

_document	The JSON document (used to get the allocator)
_object	The JSON object to add the contents to

Reimplemented in ot::GraphicsNewEditorPackage.

◆ collections()

const std::list< GraphicsPickerCollectionCfg * > & ot::GraphicsPickerCollectionPackage::collections ( void ) const

inline

◆ setFromJsonObject()

void ot::GraphicsPickerCollectionPackage::setFromJsonObject ( const ConstJsonObject & _object )

overridevirtual

Will set the object contents from the provided JSON object.

Parameters

_object The JSON object containing the information

Exceptions

Will	throw an exception if the provided object is not valid (members missing or invalid types)

Implements ot::Serializable.