ot::GraphicsPickerCollectionCfg Class Reference

#include "GraphicsPickerCollectionCfg.h"

Inheritance diagram for ot::GraphicsPickerCollectionCfg:

Public Member Functions
	GraphicsPickerCollectionCfg ()
	GraphicsPickerCollectionCfg (const std::string &_collectionName, const std::string &_collectionTitle)
	GraphicsPickerCollectionCfg (const GraphicsPickerCollectionCfg &_other)
virtual	~GraphicsPickerCollectionCfg ()
GraphicsPickerCollectionCfg &	operator= (const GraphicsPickerCollectionCfg &_other)
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	setName (const std::string &_name)
const std::string &	getName (void) const
void	setTitle (const std::string &_title)
const std::string &	getTitle (void) const
void	addChildCollection (GraphicsPickerCollectionCfg *_child)
const std::list< GraphicsPickerCollectionCfg * > &	getChildCollections (void) const
void	addItem (const std::string &_itemName, const std::string &_itemTitle, const std::string &_previewIconPath)
void	addItem (const GraphicsPickerItemInformation &_itemInfo)
const std::list< GraphicsPickerItemInformation > &	getItems (void) const
void	mergeWith (const GraphicsPickerCollectionCfg &_other)
	Will merge this collection with the collection provided. New data will be added to this collection.
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.

Constructor & Destructor Documentation

GraphicsPickerCollectionCfg() [1/3]

ot::GraphicsPickerCollectionCfg::GraphicsPickerCollectionCfg

(

)

GraphicsPickerCollectionCfg() [2/3]

ot::GraphicsPickerCollectionCfg::GraphicsPickerCollectionCfg	(	const std::string &	_collectionName,
		const std::string &	_collectionTitle )

GraphicsPickerCollectionCfg() [3/3]

ot::GraphicsPickerCollectionCfg::GraphicsPickerCollectionCfg

(

const GraphicsPickerCollectionCfg &

_other

)

~GraphicsPickerCollectionCfg()

ot::GraphicsPickerCollectionCfg::~GraphicsPickerCollectionCfg ( )

virtual

Member Function Documentation

addChildCollection()

void ot::GraphicsPickerCollectionCfg::addChildCollection

(

GraphicsPickerCollectionCfg *

_child

)

addItem() [1/2]

void ot::GraphicsPickerCollectionCfg::addItem

(

const GraphicsPickerItemInformation &

_itemInfo

)

addItem() [2/2]

void ot::GraphicsPickerCollectionCfg::addItem	(	const std::string &	_itemName,
		const std::string &	_itemTitle,
		const std::string &	_previewIconPath )

addToJsonObject()

void ot::GraphicsPickerCollectionCfg::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

getChildCollections()

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

inline

getItems()

const std::list< GraphicsPickerItemInformation > & ot::GraphicsPickerCollectionCfg::getItems ( void ) const

inline

getName()

const std::string & ot::GraphicsPickerCollectionCfg::getName ( void ) const

inline

getTitle()

const std::string & ot::GraphicsPickerCollectionCfg::getTitle ( void ) const

inline

mergeWith()

void ot::GraphicsPickerCollectionCfg::mergeWith

(

const GraphicsPickerCollectionCfg &

_other

)

Will merge this collection with the collection provided. New data will be added to this collection.

operator=()

ot::GraphicsPickerCollectionCfg & ot::GraphicsPickerCollectionCfg::operator=

(

const GraphicsPickerCollectionCfg &

_other

)

setFromJsonObject()

void ot::GraphicsPickerCollectionCfg::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.

setName()

void ot::GraphicsPickerCollectionCfg::setName ( const std::string & _name )

inline

setTitle()

void ot::GraphicsPickerCollectionCfg::setTitle ( const std::string & _title )

inline

---

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

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