ot::GraphicsNewEditorPackage Class Reference

Package that will be used to create a new graphics editor 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::GraphicsNewEditorPackage:

Public Member Functions
	GraphicsNewEditorPackage (const std::string &_editorName=std::string(), const std::string &_editorTitle=std::string())
	Constructor.
virtual	~GraphicsNewEditorPackage ()
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.
const std::string &	name (void) const
const std::string &	title (void) const
Public Member Functions inherited from ot::GraphicsPickerCollectionPackage
	GraphicsPickerCollectionPackage ()
virtual	~GraphicsPickerCollectionPackage ()
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 create a new graphics editor 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

GraphicsNewEditorPackage()

ot::GraphicsNewEditorPackage::GraphicsNewEditorPackage	(	const std::string &	_editorName = std::string(),
		const std::string &	_editorTitle = std::string() )

Constructor.

Parameters

_editorName

The unique name for the editor.

~GraphicsNewEditorPackage()

ot::GraphicsNewEditorPackage::~GraphicsNewEditorPackage ( )

virtual

Member Function Documentation

addToJsonObject()

void ot::GraphicsNewEditorPackage::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 from ot::GraphicsPickerCollectionPackage.

name()

const std::string & ot::GraphicsNewEditorPackage::name ( void ) const

inline

setFromJsonObject()

void ot::GraphicsNewEditorPackage::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)

Reimplemented from ot::GraphicsPickerCollectionPackage.

title()

const std::string & ot::GraphicsNewEditorPackage::title ( void ) const

inline

---

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

• Libraries/OTGui/include/OTGui/GraphicsPackage.h
• Libraries/OTGui/src/GraphicsPackage.cpp