legato_tablestring.h File Reference

Definition for the table string feature. More...

#include "gfx/legato/string/legato_string.h"

Include dependency graph for legato_tablestring.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	leTableString
	This struct represents a table string. More...

Macros
#define	LE_STRING_NULLIDX   -1
#define	THIS_TYPE   struct leWidget

Typedefs
typedef struct leTableString	leTableString
	This struct represents a table string. More...

Functions
leTableString *	leTableString_New (uint32_t idx)
	Constructs a new table string. More...
void	leTableString_Constructor (leTableString *str, uint32_t idx)
	Constructs a new table string. More...
virtual uint32_t	getID (const leTableString *_this)
	Get id. More...
virtual leResult	setID (leTableString *this, uint32_t id)
	Set string table ID. More...
virtual uint32_t	sizeInBytes (const leTableString *this)
	Get size of this string in bytes. More...

Detailed Description

Definition for the table string feature.

Typedef Documentation

leTableString

typedef struct leTableString leTableString

This struct represents a table string.

Color mode information keeps track of size, bpp, color channel mask and color.

Function Documentation

getID()

virtual uint32_t getID ( const leTableString *  _this )

virtual

Get id.

Gets the ID from _this.

leTableString* _this;
uint32_t id = _this->fn->getID(str);

Parameters

_this

is the string to examine.

Returns

returns the id of the string.

leTableString_Constructor()

void leTableString_Constructor	(	leTableString *	str,
		uint32_t	idx
	)

Constructs a new table string.

Creates a new table in table idx.

See also

leString_New().

uint32_t idx;
leTableString* tstr = leTableString_New(idx);

Parameters

idx	is the table from which to create

Returns

returns a new table string. Initialize table string.

Initializes the leTableString str at idx.

leTableString* str;
leTableString_Constructor(str, idx);

Parameters

str	is the string to initialize
idx	is the index location

Returns

void.

leTableString_New()

leTableString* leTableString_New

(

uint32_t

idx

)

Constructs a new table string.

Creates a new table in table idx.

See also

leString_New().

uint32_t idx;
leTableString* tstr = leTableString_New(idx);

Parameters

idx	is the table from which to create

Returns

returns a new table string.

setID()

virtual leResult setID ( leTableString *  this, uint32_t  id  )

virtual

Set string table ID.

Sets the ID to id.

leTableString* str;
leResult res = _this->fn->setID(_this, id);

Parameters

_this	is the string to examine.
id	is the string table ID to use.

Returns

LE_SUCCESS if set, otherwise LE_FAILURE.

sizeInBytes()

virtual uint32_t sizeInBytes ( const leTableString *  this )

virtual

Get size of this string in bytes.

Gets the size of this string in bytes.

leTableString* str;
uint32_t size = str->fn->sizeInBytes(str);

Parameters

str	is the string to examine.

Returns

returns the size of the string table.