Data Structures
struct	address_const_of

struct	address_of

Public Member Functions
int	last_up_to_pos (Evas_Coord x_, Evas_Coord y_) const
	Returns the logical position of the last char in the text up to the pos given. More...

int	char_coords_get (Evas_Coord x_, Evas_Coord y_, Evas_Coord cx_, Evas_Coord cy_, Evas_Coord cw_, Evas_Coord ch_) const

bool	char_pos_get (int pos_, Evas_Coord cx_, Evas_Coord cy_, Evas_Coord cw_, Evas_Coord ch_) const
	Retrieve position and dimension information of a character within a text `Evas_Object`. More...

void	shadow_color_get (int r_, int g_, int b_, int a_) const
	Retrieves the shadow color for the given text object. More...

void	shadow_color_set (int r_, int g_, int b_, int a_) const
	Sets the shadow color for the given text object. More...

double	ellipsis_get () const
	Gets the ellipsis currently set on the text object. More...

void	ellipsis_set (double ellipsis_) const
	Sets the ellipsis that should be used for the text object. More...

::efl::eina::optional< std::string >	bidi_delimiters_get () const
	Gets the BiDi delimiters used in the textblock. More...

void	bidi_delimiters_set (::efl::eina::optional< std::string > delim_) const
	Sets the BiDi delimiters used in the textblock. More...

void	outline_color_get (int r_, int g_, int b_, int a_) const
	Retrieves the outline color for the given text object. More...

void	outline_color_set (int r_, int g_, int b_, int a_) const
	Sets the outline color for the given text object. More...

void	glow2_color_get (int r_, int g_, int b_, int a_) const
	Retrieves the 'glow 2' color for the given text object. More...

void	glow2_color_set (int r_, int g_, int b_, int a_) const
	Sets the 'glow 2' color for the given text object. More...

Evas_Text_Style_Type	style_get () const
	Retrieves the style on use on the given text object. More...

void	style_set (Evas_Text_Style_Type style_) const
	Sets the style to apply on the given text object. More...

void	glow_color_get (int r_, int g_, int b_, int a_) const
	Retrieves the glow color for the given text object. More...

void	glow_color_set (int r_, int g_, int b_, int a_) const
	Sets the glow color for the given text object. More...

void	filter_program_set (::efl::eina::optional< std::string > program_) const
	Set an Evas filter program on this Text Object. More...

void	filter_source_set (::efl::eina::optional< std::string > name_,::efl::eina::optional< ::efl::eo::concrete > eobj_) const
	Bind an object to use as a mask or texture with Evas Filters. More...

Evas_Coord	max_descent_get () const

void	style_pad_get (int l_, int r_, int t_, int b_) const
	Gets the text style pad of a text object. More...

Evas_BiDi_Direction	direction_get () const
	Retrieves the direction of the text currently being displayed in the text object. More...

Evas_Coord	ascent_get () const

Evas_Coord	horiz_advance_get () const

Evas_Coord	inset_get () const

Evas_Coord	max_ascent_get () const

Evas_Coord	vert_advance_get () const

Evas_Coord	descent_get () const

	operator::evas::text () const

	operator::evas::text & ()

	operator::evas::text const & () const

Static Public Member Functions
static Eo_Class const *	_eo_class ()

Member Function Documentation

int eo_cxx::evas::text::last_up_to_pos	(	Evas_Coord	x_,
		Evas_Coord	y_
	)		const

inline

Returns the logical position of the last char in the text up to the pos given.

this is NOT the position of the last char because of the possibility of RTL in the text.

Parameters

x	in
y	in

int eo_cxx::evas::text::char_coords_get	(	Evas_Coord	x_,
		Evas_Coord	y_,
		Evas_Coord *	cx_,
		Evas_Coord *	cy_,
		Evas_Coord *	cw_,
		Evas_Coord *	ch_
	)		const

inline

Parameters

	x	in
	y	in
[out]	cx	out
[out]	cy	out
[out]	cw	out
[out]	ch	out

bool eo_cxx::evas::text::char_pos_get	(	int	pos_,
		Evas_Coord *	cx_,
		Evas_Coord *	cy_,
		Evas_Coord *	cw_,
		Evas_Coord *	ch_
	)		const

inline

Retrieve position and dimension information of a character within a text Evas_Object.

This function is used to obtain the X, Y, width and height of the character located at pos within the Evas_Object obj. obj must be a text object as created with evas_object_text_add(). Any of the Evas_Coord parameters (cx, cy, cw, ch) may be NULL in which case no value will be assigned to that parameter.

Returns: EINA_FALSE on success, EINA_TRUE on error.

Parameters

	pos	The character position to request co-ordinates for.
[out]	cx	A pointer to an `Evas_Coord` to store the X value in (can be NULL).
[out]	cy	A pointer to an `Evas_Coord` to store the Y value in (can be NULL).
[out]	cw	A pointer to an `Evas_Coord` to store the Width value in (can be NULL).
[out]	ch	A pointer to an `Evas_Coord` to store the Height value in (can be NULL).

void eo_cxx::evas::text::shadow_color_get	(	int *	r_,
		int *	g_,
		int *	b_,
		int *	a_
	)		const

inline

Retrieves the shadow color for the given text object.

Note: Use NULL pointers on the color components you're not interested in: they'll be ignored by the function.

See also: evas_object_text_shadow_color_set() for more details.

Parameters

r	The red component of the given color.
g	The green component of the given color.
b	The blue component of the given color.
a	The alpha component of the given color.

void eo_cxx::evas::text::shadow_color_set	(	int	r_,
		int	g_,
		int	b_,
		int	a_
	)		const

inline

Sets the shadow color for the given text object.

Shadow effects, which are fading colors decorating the text underneath it, will just be shown if the object is set to one of the following styles:

One can also change the direction where the shadow grows to, with evas_object_text_style_set().

See also: evas_object_text_shadow_color_get()

Parameters

r	The red component of the given color.
g	The green component of the given color.
b	The blue component of the given color.
a	The alpha component of the given color.

double eo_cxx::evas::text::ellipsis_get ( ) const

inline

Gets the ellipsis currently set on the text object.

Returns: The ellipsis set on the text object.

See also: evas_object_text_ellipsis_set.

Since: 1.8

Parameters

ellipsis the ellipsis.

void eo_cxx::evas::text::ellipsis_set ( double ellipsis_ ) const

inline

Sets the ellipsis that should be used for the text object.

This is a value between 0.0 and 1.0 indicating the position of the text to be shown. 0.0 means the start will be shown and the end trimmed, 1.0 means the beginning will be trimmed and the end will be shown, and any value in between will cause ellipsis to be added in both end of the text and the requested part to be shown. -1.0 means ellipsis is turned off.

Since: 1.8

Parameters

ellipsis the ellipsis.

efl::eina::optional< std::string > eo_cxx::evas::text::bidi_delimiters_get ( ) const

inline

Gets the BiDi delimiters used in the textblock.

BiDi delimiters are use for in-paragraph separation of bidi segments. This is useful for example in recipients fields of e-mail clients where bidi oddities can occur when mixing RTL and LTR.

Returns: A null terminated string of delimiters, e.g ",|". If empty, returns NULL.

Since: 1.1

Parameters

delim A null terminated string of delimiters, e.g ",|".

void eo_cxx::evas::text::bidi_delimiters_set ( ::efl::eina::optional< std::string > delim_ ) const

inline

Sets the BiDi delimiters used in the textblock.

BiDi delimiters are use for in-paragraph separation of bidi segments. This is useful for example in recipients fields of e-mail clients where bidi oddities can occur when mixing RTL and LTR.

Since: 1.1

Parameters

delim A null terminated string of delimiters, e.g ",|".

void eo_cxx::evas::text::outline_color_get	(	int *	r_,
		int *	g_,
		int *	b_,
		int *	a_
	)		const

inline

Retrieves the outline color for the given text object.

Note: Use NULL pointers on the color components you're not interested in: they'll be ignored by the function.

See also: evas_object_text_outline_color_set() for more details.

Parameters

r	The red component of the given color.
g	The green component of the given color.
b	The blue component of the given color.
a	The alpha component of the given color.

void eo_cxx::evas::text::outline_color_set	(	int	r_,
		int	g_,
		int	b_,
		int	a_
	)		const

inline

Sets the outline color for the given text object.

Outline effects (colored lines around text glyphs) will just be shown if the object is set to one of the following styles:

See also: evas_object_text_outline_color_get()

Parameters

r	The red component of the given color.
g	The green component of the given color.
b	The blue component of the given color.
a	The alpha component of the given color.

void eo_cxx::evas::text::glow2_color_get	(	int *	r_,
		int *	g_,
		int *	b_,
		int *	a_
	)		const

inline

Retrieves the 'glow 2' color for the given text object.

Note: Use NULL pointers on the color components you're not interested in: they'll be ignored by the function.

See also: evas_object_text_glow2_color_set() for more details.

Parameters

r	The red component of the given color.
g	The green component of the given color.
b	The blue component of the given color.
a	The alpha component of the given color.

void eo_cxx::evas::text::glow2_color_set	(	int	r_,
		int	g_,
		int	b_,
		int	a_
	)		const

inline

Sets the 'glow 2' color for the given text object.

'Glow 2' effects, which are glowing colors decorating the text's (immediate) surroundings, will just be shown if the object is set to the EVAS_TEXT_STYLE_GLOW style. See also evas_object_text_glow_color_set().

See also: evas_object_text_glow2_color_get()

Parameters

r	The red component of the given color.
g	The green component of the given color.
b	The blue component of the given color.
a	The alpha component of the given color.

Evas_Text_Style_Type eo_cxx::evas::text::style_get ( ) const

inline

Retrieves the style on use on the given text object.

Returns: the style type in use.

See also: evas_object_text_style_set() for more details.

Parameters

style a style type.

void eo_cxx::evas::text::style_set ( Evas_Text_Style_Type style_ ) const

inline

Sets the style to apply on the given text object.

Text object styles are one of the values in Evas_Text_Style_Type. Some of those values are combinations of more than one style, and some account for the direction of the rendering of shadow effects.

Note: One may use the helper macros EVAS_TEXT_STYLE_BASIC_SET and EVAS_TEXT_STYLE_SHADOW_DIRECTION_SET to assemble a style value.

The following figure illustrates the text styles:

See also: evas_object_text_style_get(); evas_object_text_shadow_color_set(); evas_object_text_outline_color_set(); evas_object_text_glow_color_set(); evas_object_text_glow2_color_set()

Parameters

style a style type.

void eo_cxx::evas::text::glow_color_get	(	int *	r_,
		int *	g_,
		int *	b_,
		int *	a_
	)		const

inline

Retrieves the glow color for the given text object.

Note: Use NULL pointers on the color components you're not interested in: they'll be ignored by the function.

See also: evas_object_text_glow_color_set() for more details.

Parameters

r	The red component of the given color.
g	The green component of the given color.
b	The blue component of the given color.
a	The alpha component of the given color.

void eo_cxx::evas::text::glow_color_set	(	int	r_,
		int	g_,
		int	b_,
		int	a_
	)		const

inline

Sets the glow color for the given text object.

Glow effects, which are glowing colors decorating the text's surroundings, will just be shown if the object is set to the EVAS_TEXT_STYLE_GLOW style.

Note: Glow effects are placed from a short distance of the text itself, but no touching it. For glowing effects right on the borders of the glyphs, see 'glow 2' effects (evas_object_text_glow2_color_set()).

See also: evas_object_text_glow_color_get()

Parameters

r	The red component of the given color.
g	The green component of the given color.
b	The blue component of the given color.
a	The alpha component of the given color.

void eo_cxx::evas::text::filter_program_set ( ::efl::eina::optional< std::string > program_ ) const

inline

Set an Evas filter program on this Text Object.

If the program fails to compile (syntax error, invalid buffer name, etc...), the standard text effects will be applied instead (SHADOW, etc...). switch back to the standard text effects.

Since: 1.9

Note: EXPERIMENTAL FEATURE. This is an unstable API, please use only for testing purposes.

See also: Evas filters reference

Parameters

program The program code, as defined by the Evas filters script language. Pass NULL to remove the former program and switch back to the standard text effect

void eo_cxx::evas::text::filter_source_set	(	::efl::eina::optional< std::string >	name_,
		::efl::eina::optional< ::efl::eo::concrete >	eobj_
	)		const

inline

Bind an object to use as a mask or texture with Evas Filters.

This will create automatically a new RGBA buffer containing the source object's pixels (as it is rendered).

Since: 1.9

Note: EXPERIMENTAL FEATURE. This is an unstable API, please use only for testing purposes.

See also: Evas filters reference

Parameters

name	Object name as used in the program code
eobj	Eo object to use through proxy rendering

void eo_cxx::evas::text::style_pad_get	(	int *	l_,
		int *	r_,
		int *	t_,
		int *	b_
	)		const

inline

Gets the text style pad of a text object.

Parameters

l	The left pad (or `NULL`).
r	The right pad (or `NULL`).
t	The top pad (or `NULL`).
b	The bottom pad (or `NULL`).

Evas_BiDi_Direction eo_cxx::evas::text::direction_get ( ) const

inline

Retrieves the direction of the text currently being displayed in the text object.

Returns: the direction of the text

Data Structures

Public Member Functions

Static Public Member Functions

Member Function Documentation