ewol::resource::ColorFile Class Reference

#include <ColorFile.hpp>

Inheritance diagram for ewol::resource::ColorFile:

Public Member Functions
	DECLARE_RESOURCE_NAMED_FACTORY (ColorFile)
virtual	~ColorFile ()
void	setErrorColor (const etk::Color< float > &_errorColor)
int32_t	request (const std::string &_paramName)
const etk::Color< float > &	get (int32_t _id)
std::vector< std::string >	getColors () const
void	reload ()

Protected Member Functions
	ColorFile ()
void	init (const std::string &_filename)

Detailed Description

ColorFile is a Resource designed to be specific with the theme (for example black, or white or orange ...)

Constructor & Destructor Documentation

ColorFile()

ewol::resource::ColorFile::ColorFile ( )

protected

Constructor of the color property file.

Parameters

[in]

_filename

Name of the file needed

~ColorFile()

virtual ewol::resource::ColorFile::~ColorFile ( )

virtual

Simple Destructor of this class (nothing specific ...)

Member Function Documentation

get()

const etk::Color<float>& ewol::resource::ColorFile::get ( int32_t  _id )

inline

Get the associated color of the ID.

Parameters

[in]

_Id

Id of the color.

Returns

The requested color.

getColors()

std::vector<std::string> ewol::resource::ColorFile::getColors ( ) const

inline

Get All color name.

Returns

list of all color existing

request()

int32_t ewol::resource::ColorFile::request

(

const std::string &

_paramName

)

Request the presence of a specific color.

Parameters

[in]

_paramName

Name of the color.

Returns

A unique ID of the color (or -1 if an error occured).

setErrorColor()

void ewol::resource::ColorFile::setErrorColor ( const etk::Color< float > &  _errorColor )

inline

Set the error color.

Parameters

[in]

_errorColor

Color that might be set when not finding a color

---

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

• framework/atria-soft/ewol/ewol/resource/ColorFile.hpp