OpenTwin 0.1
OpenTwin
 
Loading...
Searching...
No Matches
ot::GraphicsPickerItemInformation Class Reference

#include "GraphicsPickerItemInformation.h"

Inheritance diagram for ot::GraphicsPickerItemInformation:
ot::Serializable

Public Member Functions

 GraphicsPickerItemInformation ()
 
 GraphicsPickerItemInformation (const std::string &_name, const std::string &_title, const std::string &_previewIcon)
 
 GraphicsPickerItemInformation (const GraphicsPickerItemInformation &_other)
 
virtual ~GraphicsPickerItemInformation ()
 
GraphicsPickerItemInformationoperator= (const GraphicsPickerItemInformation &_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 setPreviewIcon (const std::string &_iconPath)
 
const std::string & getPreviewIcon (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.
 

Constructor & Destructor Documentation

◆ GraphicsPickerItemInformation() [1/3]

ot::GraphicsPickerItemInformation::GraphicsPickerItemInformation ( )

◆ GraphicsPickerItemInformation() [2/3]

ot::GraphicsPickerItemInformation::GraphicsPickerItemInformation ( const std::string & _name,
const std::string & _title,
const std::string & _previewIcon )

◆ GraphicsPickerItemInformation() [3/3]

ot::GraphicsPickerItemInformation::GraphicsPickerItemInformation ( const GraphicsPickerItemInformation & _other)

◆ ~GraphicsPickerItemInformation()

ot::GraphicsPickerItemInformation::~GraphicsPickerItemInformation ( )
virtual

Member Function Documentation

◆ addToJsonObject()

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

Add the object contents to the provided JSON object.

Parameters
_documentThe JSON document (used to get the allocator)
_objectThe JSON object to add the contents to

◆ getName()

const std::string & ot::GraphicsPickerItemInformation::getName ( void ) const
inline

◆ getPreviewIcon()

const std::string & ot::GraphicsPickerItemInformation::getPreviewIcon ( void ) const
inline

◆ getTitle()

const std::string & ot::GraphicsPickerItemInformation::getTitle ( void ) const
inline

◆ operator=()

ot::GraphicsPickerItemInformation & ot::GraphicsPickerItemInformation::operator= ( const GraphicsPickerItemInformation & _other)

◆ setFromJsonObject()

void ot::GraphicsPickerItemInformation::setFromJsonObject ( const ConstJsonObject & _object)
overridevirtual

Will set the object contents from the provided JSON object.

Parameters
_objectThe JSON object containing the information
Exceptions
Willthrow an exception if the provided object is not valid (members missing or invalid types)

Implements ot::Serializable.

◆ setName()

void ot::GraphicsPickerItemInformation::setName ( const std::string & _name)
inline

◆ setPreviewIcon()

void ot::GraphicsPickerItemInformation::setPreviewIcon ( const std::string & _iconPath)
inline

◆ setTitle()

void ot::GraphicsPickerItemInformation::setTitle ( const std::string & _title)
inline

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