Data Structures
struct	address_const_of

struct	address_of

Public Member Functions
bool	line_number_geometry_get (int line_, Evas_Coord cx_, Evas_Coord cy_, Evas_Coord cw_, Evas_Coord ch_) const
	Get the geometry of a line number. More...

::efl::eina::optional< std::string >	replace_char_get () const
	Get the "replacement character" for given textblock object. More...

void	style_user_pop () const
	Del the from the top of the user style stack. More...

Evas_Textblock_Cursor *	cursor_new () const
	Create a new cursor, associate it to the obj and init it to point to the start of the textblock. More...

::efl::eina::optional< ::efl::eina::crange_list< ::evas::object > >	node_format_list_get (::efl::eina::optional< std::string > anchor_) const
	No description supplied by the EAPI. More...

const Evas_Textblock_Style *	style_user_peek () const
	Get (don't remove) the style at the top of the user style stack. More...

void	node_format_remove_pair (Evas_Object_Textblock_Node_Format *n_) const
	Remove a format node and its match. More...

void	clear () const
	Clear the textblock object. More...

void	style_user_push (Evas_Textblock_Style *ts_) const
	Push ts to the top of the user style stack. More...

::efl::eina::optional< std::string >	text_markup_get () const
	Return the markup of the object. More...

void	text_markup_set (::efl::eina::optional< std::string > text_) const
	Sets the tetxblock's text to the markup text. More...

double	valign_get () const
	Gets the vertical alignment of a textblock. More...

void	valign_set (double align_) const
	Sets the vertical alignment of text within the textblock object as a whole. 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	replace_char_set (::efl::eina::optional< std::string > ch_) const
	Set the "replacement character" to use for the given textblock object. More...

bool	legacy_newline_get () const
	Gets newline mode. More...

void	legacy_newline_set (bool mode_) const
	Sets newline mode. More...

const Evas_Textblock_Style *	style_get () const
	Return the style of an object. More...

void	style_set (const Evas_Textblock_Style *ts_) const
	Set the objects style to ts. More...

const Evas_Object_Textblock_Node_Format *	node_format_first_get () const
	Returns the first format node. More...

void	size_formatted_get (Evas_Coord w_, Evas_Coord h_) const
	Get the formatted width and height. More...

const Evas_Object_Textblock_Node_Format *	node_format_last_get () const
	Returns the last format node. More...

Evas_Textblock_Cursor *	cursor_get () const
	Return the object's main cursor. More...

void	size_native_get (Evas_Coord w_, Evas_Coord h_) const
	Get the native width and height. More...

void	style_insets_get (Evas_Coord l_, Evas_Coord r_, Evas_Coord t_, Evas_Coord b_) const
	No description supplied by the EAPI. More...

	operator::evas::textblock () const

	operator::evas::textblock & ()

	operator::evas::textblock const & () const

Static Public Member Functions
static Eo_Class const *	_eo_class ()

Member Function Documentation

bool eo_cxx::evas::textblock::line_number_geometry_get	(	int	line_,
		Evas_Coord *	cx_,
		Evas_Coord *	cy_,
		Evas_Coord *	cw_,
		Evas_Coord *	ch_
	)		const

inline

Get the geometry of a line number.

Returns: EINA_TRUE on success, EINA_FALSE otherwise.

Parameters

	line	the line number.
[out]	cx	x coord of the line.
[out]	cy	y coord of the line.
[out]	cw	w coord of the line.
[out]	ch	h coord of the line.

efl::eina::optional< std::string > eo_cxx::evas::textblock::replace_char_get ( ) const

inline

Get the "replacement character" for given textblock object.

Returns NULL if no replacement character is in use.

Returns: Replacement character or NULL.

void eo_cxx::evas::textblock::style_user_pop ( ) const

inline

Del the from the top of the user style stack.

See also: evas_object_textblock_style_get

Since: 1.2

Evas_Textblock_Cursor * eo_cxx::evas::textblock::cursor_new ( ) const

inline

Create a new cursor, associate it to the obj and init it to point to the start of the textblock.

Association to the object means the cursor will be updated when the object will change.

Note: if you need speed and you know what you are doing, it's slightly faster to just allocate the cursor yourself and not associate it. (only people developing the actual object, and not users of the object).

Returns: the new cursor.

efl::eina::optional<::efl::eina::crange_list<::evas::object > > eo_cxx::evas::textblock::node_format_list_get ( ::efl::eina::optional< std::string > anchor_ ) const

inline

No description supplied by the EAPI.

Parameters

anchor

const Evas_Textblock_Style * eo_cxx::evas::textblock::style_user_peek ( ) const

inline

Get (don't remove) the style at the top of the user style stack.

Returns: the style of the object.

See also: evas_object_textblock_style_get

Since: 1.2

void eo_cxx::evas::textblock::node_format_remove_pair ( Evas_Object_Textblock_Node_Format * n_ ) const

inline

Remove a format node and its match.

Parameters

n

void eo_cxx::evas::textblock::clear ( ) const

inline

Clear the textblock object.

Note: Does NOT free the Evas object itself.

Returns: nothing.

void eo_cxx::evas::textblock::style_user_push ( Evas_Textblock_Style * ts_ ) const

inline

Push ts to the top of the user style stack.

FIXME: API is solid but currently only supports 1 style in the stack.

The user style overrides the corresponding elements of the regular style. This is the proper way to do theme overrides in code.

Returns: Returns no value.

See also: evas_object_textblock_style_set

Since: 1.2

Parameters

ts	the style to set.

efl::eina::optional< std::string > eo_cxx::evas::textblock::text_markup_get ( ) const

inline

Return the markup of the object.

Returns: the markup text of the object.

Parameters

text	the markup text to use.

void eo_cxx::evas::textblock::text_markup_set ( ::efl::eina::optional< std::string > text_ ) const

inline

Sets the tetxblock's text to the markup text.

Note: assumes text does not include the unicode object replacement char (0xFFFC)

Returns: Return no value.

Parameters

text	the markup text to use.

double eo_cxx::evas::textblock::valign_get ( ) const

inline

Gets the vertical alignment of a textblock.

Returns: The alignment set for the object.

Since: 1.1

Parameters

align A value between 0.0 and 1.0.

void eo_cxx::evas::textblock::valign_set ( double align_ ) const

inline

Sets the vertical alignment of text within the textblock object as a whole.

Normally alignment is 0.0 (top of object). Values given should be between 0.0 and 1.0 (1.0 bottom of object, 0.5 being vertically centered etc.).

Since: 1.1

Parameters

align A value between 0.0 and 1.0.

efl::eina::optional< std::string > eo_cxx::evas::textblock::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::textblock::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::textblock::replace_char_set ( ::efl::eina::optional< std::string > ch_ ) const

inline

Set the "replacement character" to use for the given textblock object.

Parameters

ch	The charset name.

bool eo_cxx::evas::textblock::legacy_newline_get ( ) const

inline

Gets newline mode.

When true, newline character behaves as a paragraph separator.

Returns: EINA_TRUE if in legacy mode, EINA_FALSE otherwise.

Since: 1.1

Parameters

mode	`EINA_TRUE` for legacy mode, `EINA_FALSE` otherwise.

void eo_cxx::evas::textblock::legacy_newline_set ( bool mode_ ) const

inline

Sets newline mode.

When true, newline character will behave as a paragraph separator.

Since: 1.1

Parameters

mode	`EINA_TRUE` for legacy mode, `EINA_FALSE` otherwise.

const Evas_Textblock_Style * eo_cxx::evas::textblock::style_get ( ) const

inline

Return the style of an object.

Returns: the style of the object.

Parameters

ts	the style to set.

void eo_cxx::evas::textblock::style_set ( const Evas_Textblock_Style * ts_ ) const

inline

Set the objects style to ts.

Returns: Returns no value.

Parameters

ts	the style to set.

const Evas_Object_Textblock_Node_Format * eo_cxx::evas::textblock::node_format_first_get ( ) const

inline

Returns the first format node.

Parameters

format

void eo_cxx::evas::textblock::size_formatted_get	(	Evas_Coord *	w_,
		Evas_Coord *	h_
	)		const

inline

Get the formatted width and height.

This calculates the actual size after restricting the textblock to the current size of the object. The main difference between this and evas_object_textblock_size_native_get is that the "native" function does not wrapping into account it just calculates the real width of the object if it was placed on an infinite canvas, while this function gives the size after wrapping according to the size restrictions of the object.

For example for a textblock containing the text: "You shall not pass!" with no margins or padding and assuming a monospace font and a size of 7x10 char widths (for simplicity) has a native size of 19x1 and a formatted size of 5x4.

Returns: Returns no value.

See also: evas_object_textblock_size_native_get

Parameters

w	the width of the object.
h	the height of the object

const Evas_Object_Textblock_Node_Format * eo_cxx::evas::textblock::node_format_last_get ( ) const

inline

Returns the last format node.

Parameters

format

Evas_Textblock_Cursor * eo_cxx::evas::textblock::cursor_get ( ) const

inline

Return the object's main cursor.

Returns: The obj's main cursor.

void eo_cxx::evas::textblock::size_native_get	(	Evas_Coord *	w_,
		Evas_Coord *	h_
	)		const

inline

Get the native width and height.

This calculates the actual size without taking account the current size of the object. The main difference between this and evas_object_textblock_size_formatted_get is that the "native" function does not take wrapping into account it just calculates the real width of the object if it was placed on an infinite canvas, while the "formatted" function gives the size after wrapping text according to the size restrictions of the object.

For example for a textblock containing the text: "You shall not pass!" with no margins or padding and assuming a monospace font and a size of 7x10 char widths (for simplicity) has a native size of 19x1 and a formatted size of 5x4.

Returns: Returns no value.

Parameters

w	the width returned
h	the height returned

void eo_cxx::evas::textblock::style_insets_get	(	Evas_Coord *	l_,
		Evas_Coord *	r_,
		Evas_Coord *	t_,
		Evas_Coord *	b_
	)		const

inline

No description supplied by the EAPI.

Parameters

l
r
t
b

Data Structures

Public Member Functions

Static Public Member Functions

Member Function Documentation