Efl.Ui.Internal.Text.Interactive (class)


An internal object in charge of the interactive aspect of the text widget.

This object is in charge of processing inputs, moving the text caret and so on.


Efl.Canvas.Text (class)Efl.Canvas.Object (class)Efl.Object (class)

Full hierarchy


constructor [Overridden from Efl.Object]

Call the object's constructor.
Efl_Object *efl_constructor(Eo *obj);

editable (get, set) [Overridden from Efl.Ui.Text.Interactive]

Whether the entry is editable.
Eina_Bool efl_ui_text_interactive_editable_get(const Eo *obj);
void efl_ui_text_interactive_editable_set(Eo *obj, Eina_Bool editable);

finalize [Overridden from Efl.Object]

Called at the end of efl_add. Should not be called, just overridden.
Efl_Object *efl_finalize(Eo *obj);

selection_allowed (get, set) [Overridden from Efl.Ui.Text.Interactive]

Whether or not selection is allowed on this object
Eina_Bool efl_ui_text_interactive_selection_allowed_get(const Eo *obj);
void efl_ui_text_interactive_selection_allowed_set(Eo *obj, Eina_Bool allowed);

selection_cursors (get) [Overridden from Efl.Ui.Text.Interactive]

The cursors used for selection handling.
void efl_ui_text_interactive_selection_cursors_get(const Eo *obj, Efl_Text_Cursor_Cursor **start, Efl_Text_Cursor_Cursor **end);


filter_padding (get) Required padding to apply this filter without cropping.
filter_state (get, set) Set the current state of the filter.
protected filter_changed (set) Marks this filter as changed.
protected filter_input_alpha Called by Efl.Canvas.Filter.Internal to determine whether the input is alpha or rgba.
protected filter_invalid (set) Marks this filter as invalid.
protected filter_output_buffer (get) Retrieve cached output buffer, if any.
above (get) Get the Evas object stacked right above obj
anti_alias (get, set)
below (get) Get the Evas object stacked right below obj
clip (get, set)
clipees (get) Return a list of objects currently clipped by obj.
clipees_has Test if any object is clipped by obj.
color (get, set)
coords_inside (get) Returns whether the coords are logically inside the object.
debug_name_override Build a read-only name for this object used for debugging.
del Unrefs the object and reparents it to NULL.
event_animation (get, set) Set the animation which starts when the given event_name happens to the object.
freeze_events (get, set)
geometry (get, set) Rectangular geometry that combines both position and size.
hint_align (get, set) Hints for an object's alignment.
hint_aspect (get, set) Defines the aspect ratio to respect when scaling this object.
hint_combined_min (get) Read-only minimum size combining both Efl.Gfx.Size.Hint.hint_restricted_min and Efl.Gfx.Size.Hint.hint_min size hints.
hint_margin (get, set) Hints for an object's margin or padding space.
hint_max (get, set) Hints on the object's maximum size.
hint_min (get, set) Hints on the object's minimum size.
protected set hint_restricted_min (get, set) Internal hints for an object's minimum size.
hint_weight (get, set) Hints for an object's weight.
is_frame_object (get, set) If true the object belongs to the window border decorations.
key_focus (get, set) Indicates that this object is the keyboard event receiver on its canvas.
key_grab Requests keyname key events be directed to obj.
key_ungrab Removes the grab on keyname key events by obj.
layer (get, set)
loop (get) The loop to which this object belongs to.
lower Lower obj to the bottom of its layer.
no_render (get, set)
pass_events (get, set)
pointer_inside (get) Returns whether the mouse pointer is logically inside the canvas.
pointer_mode (get, set) Low-level pointer behaviour.
pointer_mode_by_device (get, set) Low-level pointer behaviour by device. See Efl.Canvas.Object.pointer_mode.get and Efl.Canvas.Object.pointer_mode.set for more explanation.
position (get, set) The 2D position of a canvas object.
precise_is_inside (get, set)
propagate_events (get, set)
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.
raise Raise obj to the top of its layer.
render_op (get, set) Render mode to be used for compositing the Evas object.
repeat_events (get, set)
seat_event_filter (get, set)
seat_focus (get) Check if this object is focused.
seat_focus_add Add a seat to the focus list.
seat_focus_check Check if this object is focused by a given seat
seat_focus_del Remove a seat from the focus list.
size (get, set) The 2D size of a canvas object.
stack_above Stack obj immediately above
stack_below Stack obj immediately below
visible (get, set) The visibility of a canvas object.
protected render_parent (get) Gets the parent smart object of a given Evas object, if it has one.
annotation (get, set) A new format for annotation.
annotation_del Deletes given annotation.
annotation_insert Inserts an annotation format in a specified range [start, end - 1].
annotation_positions_get Sets given cursors to the start and end positions of the annotation.
async_layout Requests to layout the text off the mainloop.
backing_color (get, set) Backing color
backing_type (get, set) Enable or disable backing type
bidi_delimiters (get, set) BiDi delimiters are used for in-paragraph separation of bidi segments. This is useful, for example, in the recipient fields of e-mail clients where bidi oddities can occur when mixing RTL and LTR.
cursor (get) The object's main cursor.
cursor_char_delete Deletes a single character from position pointed by given cursor.
cursor_char_next Advances to the next character
cursor_char_prev Advances to the previous character
cursor_compare Compare two cursors
cursor_content (get) The content of the cursor (the character under the cursor)
cursor_coord_set Set cursor coordinates
cursor_copy Copy existing cursor
cursor_equal Check if two cursors are equal
cursor_free Free existing cursor
cursor_geometry (get) Returns the geometry of two cursors ("split cursor"), if logical cursor is between LTR/RTL text, also considering paragraph direction. Upper cursor is shown for the text of the same direction as paragraph, lower cursor - for opposite.
cursor_line_char_first Advance to current line first character
cursor_line_char_last Advance to current line last character
cursor_line_jump_by Jump the cursor by the given number of lines
cursor_markup_insert Inserts a markup text to the text object in a given cursor position
cursor_new Create new cursor
cursor_object_item_annotation (get) The object-item annotation at the cursor's position.
cursor_object_item_insert Inserts a object item at specified position.
cursor_paragraph_char_first Advances to the first character in this paragraph
cursor_paragraph_char_last Advances to the last character in this paragraph
cursor_paragraph_first Advance to current paragraph first character
cursor_paragraph_last Advance to current paragraph last character
cursor_paragraph_next Advances to the start of the next text node
cursor_paragraph_prev Advances to the end of the previous text node
cursor_position (get, set) Cursor position
cursor_text_insert Adds text to the current cursor position and set the cursor to *after* the start of the text just added.
cursor_word_end Advance to current word end
cursor_word_start Advance to current word start
destructor Call the object's destructor.
effect_type (get, set) Type of effect used for the displayed text
ellipsis (get, set) Ellipsis value (number from -1.0 to 1.0)
filter_data (get, set) Extra data used by the filter program.
filter_program (get, set)
filter_source (get, set) Bind an object to use as a mask or texture in a filter program.
font (get, set) The font name and size that is used for the displayed text
font_bitmap_scalable (get, set) The bitmap fonts have fixed size glyphs for several available sizes. Basically, it is not scalable. But, it needs to be scalable for some use cases. (ex. colorful emoji fonts)
font_fallbacks (get, set) Comma-separated list of font fallbacks
font_lang (get, set) Specific language of the displayed font
font_slant (get, set) Type of slant of the displayed font
font_source (get, set) The source that will be used to lookup the font of the text
font_weight (get, set) Type of weight of the displayed font
font_width (get, set) Type of width of the displayed font
gfx_filter (get, set) Program that applies a special filter
glow2_color (get, set) Second color of the glow effect
glow_color (get, set) Color of glow effect
halign (get, set) Horizontal alignment of text
halign_auto_type (get, set) Horizontal alignment of text
is_empty (get) Whether the object is empty (no text) or not
legacy_newline (get, set) When true, newline character will behave as a paragraph separator.
linegap (get, set) Minimal line gap (top and bottom) for each line in the text
linerelgap (get, set) Relative line gap (top and bottom) for each line in the text
markup (get, set) Markup property
multiline (get, set) Multiline is enabled or not
normal_color (get, set) Color of text, excluding style
object_item_geometry_get Queries a given object item for its geometry.
obstacle_add Add obstacle evas object eo_obs to be observed during layout of text.
obstacle_del Removes eo_obs from observation during text layout.
obstacles_update Triggers for relayout due to obstacles' state change.
outline_color (get, set) Color of outline effect
paragraph_direction (get, set) This handles text paragraph direction of the given object. Even if the given object is not textblock or text, its smart child objects can inherit the paragraph direction from the given object. The default paragraph direction is inherit.
password (get, set) Whether text is a password
range_annotations_get Returns an iterator of all the handles in a range.
range_delete Deletes the range between given cursors.
range_geometry_get Get the geometry of a range in the text.
range_simple_geometry_get Get the "simple" geometry of a range.
range_text_get Returns the text in the range between cur1 and cur2.
replacement_char (get, set) The character used to replace characters that can't be displayed
scale (get, set) The scaling factor of an object.
shadow_color (get, set) Color of shadow effect
shadow_direction (get, set) Direction of shadow effect
size_formatted (get) The formatted width and height.
size_native (get) The native width and height.
strikethrough_color (get, set) Color of strikethrough_style
strikethrough_type (get, set) Type of strikethrough style
style (get, set) The text style of the object.
style_insets (get) Gets the left, right, top and bottom insets of the text.
tabstops (get, set) Tabstops value
text (get, set)
underline2_color (get, set) Color of underline2 style
underline2_type (get, set) Type of underline2 style
underline_color (get, set) Color of normal underline style
underline_dashed_color (get, set) Color of dashed underline style
underline_dashed_gap (get, set) Gap of dashed underline style
underline_dashed_width (get, set) Width of dashed underline style
underline_height (get, set) Height of underline style
underline_type (get, set) Sets an underline style on the text
valign (get, set) Vertical alignment of text
visible_range_get Returns the currently visible range.
wrap (get, set) Wrap mode for use in the text
protected filter_dirty Called when filter changes must trigger a redraw of the object.
protected filter_input_render Called by Efl.Canvas.Filter.Internal when the parent class must render the input.
protected filter_state_prepare Called by Efl.Canvas.Filter.Internal to request the parent class for state information (color, etc...).
color_class_code (get, set)
color_code (get, set)
lightning_3d Apply a lighting effect on the object.
lightning_3d_absolute Apply a lighting effect to the object.
map_alpha (get, set) Alpha flag for map rendering.
map_clockwise (get) Clockwise state of a map (read-only).
map_color (get, set) Color of a vertex in the map.
map_coord_absolute (get, set) A point's absolute coordinate on the canvas.
map_has Read-only property indicating whether an object is mapped.
map_point_count (get, set) Number of points of a map.
map_reset Resets the map transformation to its default state.
map_smooth (get, set) Smoothing state for map rendering.
map_uv (get, set) Map point's U and V texture source point.
perspective_3d Apply a perspective transform to the map
perspective_3d_absolute Apply a perspective transform to the map
rotate Apply a rotation to the object.
rotate_3d Rotate the object around 3 axes in 3D.
rotate_3d_absolute Rotate the object around 3 axes in 3D, using absolute coordinates.
rotate_absolute Apply a rotation to the object, using absolute coordinates.
rotate_quat Rotate the object in 3D using a unit quaternion.
rotate_quat_absolute Rotate the object in 3D using a unit quaternion, using absolute coordinates.
translate Apply a translation to the object using map.
zoom Apply a zoom to the object.
zoom_absolute Apply a zoom to the object, using absolute coordinates.
hint_base (get, set) Base size for objects with sizing restrictions.
hint_step (get, set) Step size for objects with sizing restrictions.
allow_parent_unref (get, set) Allow an object to be deleted by unref even if it has a parent.
children_iterator_new Get an iterator on all childrens
comment (get, set) A human readable comment for the object
composite_attach Make an object a composite object of another.
composite_detach Detach a composite object from another object.
composite_part_is Check if an object is part of a composite object.
event_callback_forwarder_add Add an event callback forwarder for an event and an object.
event_callback_forwarder_del Remove an event callback forwarder for an event and an object.
event_callback_stop Stop the current callback call.
event_freeze Freeze events of object.
event_freeze_count (get) Return freeze events of object.
class event_global_freeze Freeze events of object.
class event_global_freeze_count (get) Return freeze events of object.
class event_global_thaw Thaw events of object.
event_thaw Thaw events of object.
finalized (get) True if the object is already finalized, otherwise false.
name (get, set) The name of the object.
name_find Find a child object with the given name and return it.
parent (get, set) The parent of an object.
font (get, set)
font_source (get, set)
language (get, set) The (human) language for this object.
mirrored (get, set) Whether this object should be mirrored.
mirrored_automatic (get, set) Whether the property Efl.Ui.Base.mirrored should be set automatically.



animator,tick Animator tick synchronized with screen vsync if possible.
changed Called when canvas text changed
cursor,changed Called when cursor changed
style_insets,changed Called when the property Efl.Canvas.Text.style_insets changed.
hide Object just became invisible.
move Object was moved, its position during the event is the new one.
resize Object was resized, its size during the event is the new one.
show Object just became visible.
change,size,hints Object size hints changed.
restack Object stacking was changed.
finger,down Finger pressed (finger id is known).
finger,move Finger moved (current and previous positions are known).
finger,up Finger released (finger id is known).
focus,in A focus in event.
focus,out A focus out event.
hold All input events are on hold or resumed.
key,down Keyboard key press.
key,up Keyboard key release.
pointer,axis Pen or other axis event update.
pointer,cancel Main pointer button press was cancelled (button id is known). This can happen in rare cases when the window manager passes the focus to a more urgent window, for instance. You probably don't need to listen to this event, as it will be accompanied by an up event.
pointer,down Main pointer button pressed (button id is known).
pointer,in Pointer entered a window or a widget.
pointer,move Main pointer move (current and previous positions are known).
pointer,out Pointer left a window or a widget.
pointer,up Main pointer button released (button id is known).
pointer,wheel Mouse wheel event.
callback,add A callback was added.
callback,del A callback was deleted.
del Object is being deleted.
destruct Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any dangling pointer.
selection,changed The selection on the object has changed. Query using Efl.Ui.Text.Interactive.selection_cursors