Data Structures | Public Member Functions | Static Public Member Functions
eo_cxx::evas::textgrid Struct Reference

Data Structures

struct  address_const_of
 
struct  address_of
 

Public Member Functions

void update_add (int x_, int y_, int w_, int h_) const
 Indicate for evas that part of a textgrid region (cells) has been updated. More...
 
void cellrow_set (int y_, const Evas_Textgrid_Cell *row_) const
 Set the string at the given row of the given textgrid object. More...
 
Evas_Textgrid_Cellcellrow_get (int y_) const
 Get the string at the given row of the given textgrid object. More...
 
void palette_set (Evas_Textgrid_Palette pal_, int idx_, int r_, int g_, int b_, int a_) const
 The set color to the given palette at the given index of the given textgrid object. More...
 
void palette_get (Evas_Textgrid_Palette pal_, int idx_, int *r_, int *g_, int *b_, int *a_) const
 The retrieve color to the given palette at the given index of the given textgrid object. More...
 
Evas_Textgrid_Font_Style supported_font_styles_get () const
 This function is not implemented yet, do not use. More...
 
void supported_font_styles_set (Evas_Textgrid_Font_Style styles_) const
 This function is not implemented yet, do not use. More...
 
void size_get (int *w_, int *h_) const
 Get the size of the textgrid object. More...
 
void size_set (int w_, int h_) const
 Set the size of the textgrid object. More...
 
void cell_size_get (int *width_, int *height_) const
 Retrieve the size of a cell of the given textgrid object in pixels. More...
 
 operator::evas::textgrid () const
 
 operator::evas::textgrid & ()
 
 operator::evas::textgrid const & () const
 

Static Public Member Functions

static Eo_Class const * _eo_class ()
 

Member Function Documentation

void eo_cxx::evas::textgrid::update_add ( int  x_,
int  y_,
int  w_,
int  h_ 
) const
inline

Indicate for evas that part of a textgrid region (cells) has been updated.

This function declares to evas that a region of cells was updated by code and needs refreshing. An application should modify cells like this as an example:

int i;
cells = evas_object_textgrid_cellrow_get(obj, row);
for (i = 0; i < width; i++) cells[i].codepoint = 'E';
evas_object_textgrid_cellrow_set(obj, row, cells);
evas_object_textgrid_update_add(obj, 0, row, width, 1);
See also
evas_object_textgrid_cellrow_set()
evas_object_textgrid_cellrow_get()
evas_object_textgrid_size_set()
Since
1.7
Parameters
xThe rect region of cells top-left x (column)
yThe rect region of cells top-left y (row)
wThe rect region size in number of cells (columns)
hThe rect region size in number of cells (rows)
void eo_cxx::evas::textgrid::cellrow_set ( int  y_,
const Evas_Textgrid_Cell row_ 
) const
inline

Set the string at the given row of the given textgrid object.

This function returns cells to the textgrid taken by evas_object_textgrid_cellrow_get(). The row pointer row should be the same row pointer returned by evas_object_textgrid_cellrow_get() for the same row y.

See also
evas_object_textgrid_cellrow_get()
evas_object_textgrid_size_set()
evas_object_textgrid_update_add()
Since
1.7
Parameters
yThe row index of the grid.
rowThe string as a sequence of Evas_Textgrid_Cell.
Evas_Textgrid_Cell * eo_cxx::evas::textgrid::cellrow_get ( int  y_) const
inline

Get the string at the given row of the given textgrid object.

Returns
A pointer to the first cell of the given row.

This function returns a pointer to the first cell of the line y of the textgrid object obj. If y is not between 0 and the number of lines of the grid - 1, or on error, this function return NULL.

See also
evas_object_textgrid_cellrow_set()
evas_object_textgrid_size_set()
evas_object_textgrid_update_add()
Since
1.7
Parameters
yThe row index of the grid.
void eo_cxx::evas::textgrid::palette_set ( Evas_Textgrid_Palette  pal_,
int  idx_,
int  r_,
int  g_,
int  b_,
int  a_ 
) const
inline

The set color to the given palette at the given index of the given textgrid object.

This function sets the color for the palette of type pal at the index idx of the textgrid object obj. The ARGB components are given by r, g, b and a. This color can be used when setting the Evas_Textgrid_Cell structure. The components must set a pre-multiplied color. If pal is EVAS_TEXTGRID_PALETTE_NONE or EVAS_TEXTGRID_PALETTE_LAST, or if idx is not between 0 and 255, or on error, this function does nothing. The color components are clamped between 0 and 255. If idx is greater than the latest set color, the colors between this last index and idx - 1 are set to black (0, 0, 0, 0).

See also
evas_object_textgrid_palette_get()
Since
1.7
Parameters
palThe type of the palette to set the color.
idxThe index of the paletter to which the color is stored.
rThe red component of the color.
gThe green component of the color.
bThe blue component of the color.
aThe alpha component of the color.
void eo_cxx::evas::textgrid::palette_get ( Evas_Textgrid_Palette  pal_,
int  idx_,
int *  r_,
int *  g_,
int *  b_,
int *  a_ 
) const
inline

The retrieve color to the given palette at the given index of the given textgrid object.

This function retrieves the color for the palette of type pal at the index idx of the textgrid object obj. The ARGB components are stored in the buffers r, g, b and a. If idx is not between 0 and the index of the latest set color, or if pal is EVAS_TEXTGRID_PALETTE_NONE or EVAS_TEXTGRID_PALETTE_LAST, the values of the components are 0. r, g, b and a can be NULL.

See also
evas_object_textgrid_palette_set()
Since
1.7
Parameters
palThe type of the palette to set the color.
idxThe index of the palette to which the color is stored.
[out]rA pointer to the red component of the color.
[out]gA pointer to the green component of the color.
[out]bA pointer to the blue component of the color.
[out]aA pointer to the alpha component of the color.
Evas_Textgrid_Font_Style eo_cxx::evas::textgrid::supported_font_styles_get ( ) const
inline

This function is not implemented yet, do not use.

Returns
EVAS_TEXTGRID_FONT_STYLE_NORMAL
Parameters
styles
void eo_cxx::evas::textgrid::supported_font_styles_set ( Evas_Textgrid_Font_Style  styles_) const
inline

This function is not implemented yet, do not use.

Parameters
styles
void eo_cxx::evas::textgrid::size_get ( int *  w_,
int *  h_ 
) const
inline

Get the size of the textgrid object.

This function retrieves the number of lines in the buffer h and the number of columns in the buffer w of the textgrid object obj. w or h can be NULL. On error, their value is 0.

Since
1.7
Parameters
wThe number of columns (width in cells) of the grid.
hThe number of rows (height in cells) of the grid.
void eo_cxx::evas::textgrid::size_set ( int  w_,
int  h_ 
) const
inline

Set the size of the textgrid object.

This function sets the number of lines h and the number of columns w to the textgrid object obj. If w or h are less or equal than 0, this functiond does nothing.

Since
1.7
Parameters
wThe number of columns (width in cells) of the grid.
hThe number of rows (height in cells) of the grid.
void eo_cxx::evas::textgrid::cell_size_get ( int *  width_,
int *  height_ 
) const
inline

Retrieve the size of a cell of the given textgrid object in pixels.

This functions retrieves the width and height, in pixels, of a cell of the textgrid object obj and store them respectively in the buffers width and height. Their value depends on the monospace font used for the textgrid object, as well as the style. width and height can be NULL. On error, they are set to 0.

See also
evas_object_textgrid_font_set()
evas_object_textgrid_supported_font_styles_set()
Since
1.7
Parameters
widthA pointer to the location to store the width in pixels of a cell.
heightA pointer to the location to store the height in pixels of a cell.