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

Description

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.

Inheritance

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

Full hierarchy

Members

constructor [Overridden from Efl.Object]

Implement this method to provide optional initialization code for your object.
Efl_Object *efl_constructor(Eo *obj);


editable (get, set) [Overridden from Efl.Text_Interactive]

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


finalize [Overridden from Efl.Object]

Implement this method to finish the initialization of your object after all (if any) user-provided configuration methods have been executed.
Efl_Object *efl_finalize(Eo *obj);


select_none [Overridden from Efl.Text_Interactive]

Clears the selection.
void efl_text_interactive_select_none(Eo *obj);


selection_allowed (get, set) [Overridden from Efl.Text_Interactive]

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


selection_cursors (get) [Overridden from Efl.Text_Interactive]

void efl_text_interactive_selection_cursors_get(const Eo *obj, Efl_Text_Cursor_Cursor **start, Efl_Text_Cursor_Cursor **end);


Inherited

Efl.Canvas.Filter.Internal
filter_padding (get)
filter_state (get, set) Set the current state of the filter.
protected filter_changed (set)
protected filter_input_alpha Called by Efl.Canvas.Filter.Internal to determine whether the input is alpha or rgba.
protected filter_invalid (set)
protected filter_output_buffer (get)
Efl.Canvas.Object
above (get)
anti_alias (get, set) Whether or not the given Evas object is to be drawn anti-aliased.
below (get)
clipped_objects (get)
clipped_objects_count Returns the number of objects clipped by obj
clipper (get, set) Clip one object to another.
color (get, set) The general/main color of the given Evas object.
coords_inside (get)
debug_name_override Build a read-only name for this object used for debugging.
event_freeze Freeze events of this object.
event_thaw Thaw events of object.
geometry (get, set) Rectangular geometry that combines both position and size.
gesture_manager_get Returns current canvas's gesture manager
has_fixed_size (get, set) A hint for an object that its size will not change.
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_fill (get, set) Hints for an object's fill property that used to specify "justify" or "fill" by some users. Efl.Gfx.Hint.hint_fill specify whether to fill the space inside the boundaries of a container/manager.
hint_margin (get, set) Hints for an object's margin or padding space.
hint_size_combined_max (get)
hint_size_combined_min (get)
hint_size_max (get, set) Hints on the object's maximum size.
hint_size_min (get, set) Hints on the object's minimum size.
protected set hint_size_restricted_max (get, set) Internal hints for an object's maximum size.
protected set hint_size_restricted_min (get, set) Internal hints for an object's minimum size.
hint_weight (get, set) Hints for an object's weight.
invalidate Implement this method to perform special actions when your object loses its parent, if you need to.
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) The layer of its canvas that the given object will be part of.
loop (get)
lower_to_bottom Lower obj to the bottom of its layer.
no_render (get, set) Disables all rendering on the canvas.
pass_events (get, set) Whether an Evas object is to pass (ignore) events.
pointer_inside (get)
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) Whether to use precise (usually expensive) point collision detection for a given Evas object.
propagate_events (get, set) Whether events on a smart object's member should be propagated up to its parent.
provider_find Searches upwards in the object tree for a provider which knows the given class/interface.
raise_to_top 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) Whether an Evas object is to repeat events to objects below it.
seat_event_filter (get, set) Whether input events from a given seat are enabled. If the filter list is empty (no seat is disabled) this object will report mouse, keyboard and focus events from any seat, otherwise those events will only be reported if the event comes from a seat that is not in the list.
seat_focus (get)
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)
Efl.Canvas.Text
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_is_item Whether this is an "item" type of annotation. Should be used before querying the annotation's geometry, as only "item" annotations have a geometry.
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_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_cluster_coord_set Set cursor coordinates according to grapheme clusters. It does not allow to put a cursor to the middle of a grapheme cluster.
cursor_cluster_next Advances to the next grapheme cluster
cursor_cluster_prev Advances to the previous grapheme cluster
cursor_compare Compare two cursors
cursor_content (get)
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)
cursor_item_annotation (get)
cursor_item_insert Inserts a object item at specified position.
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_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 Implement this method to provide deinitialization code for your object if you need it.
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) A graphical filter program on this object.
filter_source (get, set) Bind an object to use as a mask or texture in a filter program.
font (get, set) The font family, filename and size for a given text object.
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 font (source) file to be used on a given text object.
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)
item_geometry_get Queries a given object item for its geometry.
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
markup_range (get, set) Markup of a given range in the text
multiline (get, set) Multiline is enabled or not
normal_color (get, set) Color of text, excluding style
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)
size_native (get)
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)
tabstops (get, set) Tabstops value
text (get, set) The text string to be displayed by the given text object.
text_cursor (get)
underline2_color (get, set) Color 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...).
Efl.Gfx.Color
color_code (get, set) Hexadecimal color code of given Evas object (#RRGGBBAA).
Efl.Gfx.Mapping
lighting_3d Apply a lighting effect on the object.
lighting_3d_absolute Apply a lighting effect to the object.
mapping_alpha (get, set) Alpha flag for map rendering.
mapping_clockwise (get)
mapping_color (get, set) Color of a vertex in the map.
mapping_coord_absolute (get, set) A point's absolute coordinate on the canvas.
mapping_has Read-only property indicating whether an object is mapped.
mapping_point_count (get, set) Number of points of a map.
mapping_reset Resets the map transformation to its default state.
mapping_smooth (get, set) Smoothing state for map rendering.
mapping_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.
Efl.Loop_Consumer
future_rejected Creates a new future that is already rejected to a specified error using the Efl.Loop_Consumer.loop.get.
future_resolved Creates a new future that is already resolved to a value.
parent (get, set) The parent of an object.
promise_new Create a new promise with the scheduler coming from the loop provided by this object.
Efl.Object
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 children.
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_del Remove an event callback forwarder for a specified event and object.
event_callback_forwarder_priority_add Add an event callback forwarder that will make this object emit an event whenever another object (source) emits it. The event is said to be forwarded from source to this object.
event_callback_stop Stop the current callback call.
event_freeze_count (get)
static event_global_freeze Globally freeze events for ALL EFL OBJECTS.
static event_global_freeze_count (get)
static event_global_thaw Globally thaw events for ALL EFL OBJECTS.
finalized (get)
invalidated (get)
invalidating (get)
name (get, set) The name of the object.
name_find Find a child object with the given name and return it.
provider_register Will register a manager of a specific class to be answered by Efl.Object.provider_find.
provider_unregister Will unregister a manager of a specific class that was previously registered and answered by Efl.Object.provider_find.
Efl.Ui.I18n
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.I18n.mirrored should be set automatically.

Events

Inherited

Efl.Canvas.Object
animator,tick Animator tick synchronized with screen vsync if possible.
Efl.Canvas.Text
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.
Efl.Gesture.Events
gesture,double_tap Emitted when a Double-tap gesture has been detected. A Double-tap gesture consists of two taps on the screen (or clicks of the mouse) in quick succession. If the second one is delayed for too long they will be detected as two independent Efl.Gesture.Events.gesture,tap events.
gesture,flick Emitted when a Flick gesture has been detected.
gesture,long_tap Emitted when a Long-tap gesture has been detected. A Long-tap gesture consists of a touch of the screen (or click of the mouse) followed by a release after some time. If the release happens too quickly a Efl.Gesture.Events.gesture,tap event will be emitted instead.
gesture,momentum Emitted when a Momentum gesture has been detected. A Momentum gesture consists of a quick displacement of the finger while touching the screen (or while holding down a mouse button).
gesture,tap Emitted when a Tap gesture has been detected. A Tap gesture consists of a touch of the screen (or click of the mouse) quickly followed by a release. If the release happens too late a Efl.Gesture.Events.gesture,long_tap event will be emitted instead.
gesture,triple_tap Emitted when a Triple-tap gesture has been detected. A Triple-tap gesture consists of three taps on the screen (or clicks of the mouse) in quick succession. If any of them is delayed for too long they will be detected as independent Efl.Gesture.Events.gesture,tap or Efl.Gesture.Events.gesture,double_tap events.
gesture,zoom Emitted when a Zoom gesture has been detected. A Zoom gesture consists of two fingers touching the screen and separating ("zoom in") or getting closer ("zoom out" or "pinch"). This gesture cannot be performed with a mouse as it requires more than one pointer.
Efl.Gfx.Entity
position,changed Object was moved, its position during the event is the new one.
size,changed Object was resized, its size during the event is the new one.
visibility,changed Object's visibility state changed, the event value is the new state.
Efl.Gfx.Hint
hints,changed Object hints changed.
Efl.Gfx.Stack
stacking,changed Object stacking was changed.
Efl.Input.Interface
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.
Efl.Object
del Object is being deleted. See Efl.Object.destructor.
destruct Object has been fully destroyed. It can not be used beyond this point. This event should only serve to clean up any reference you keep to the object.
invalidate Object is being invalidated and losing its parent. See Efl.Object.invalidate.
noref Object has lost its last reference, only parent relationship is keeping it alive. Advanced usage.
ownership,shared Object has acquired a second reference. It has multiple owners now. Triggered whenever increasing the refcount from one to two, it will not trigger by further increasing the refcount beyond two.
ownership,unique Object has lost a reference and only one is left. It has just one owner now. Triggered whenever the refcount goes from two to one.
Efl.Text_Interactive
text,selection,changed The selection on the object has changed. Query using Efl.Text_Interactive.selection_cursors