efl.evas Module

Classes

Enumerations

Size Hints Helper

Helper values to be used as Size Hints for objects.

EVAS_HINT_EXPAND = -1.0

to be used with weight or expand

EVAS_HINT_FILL = 1.0

to be used with align or fill

EXPAND_BOTH = EVAS_HINT_EXPAND, EVAS_HINT_EXPAND

Expand in both direction

New in version 1.13.

EXPAND_HORIZ = EVAS_HINT_EXPAND, 0.0

Expand horizontally

New in version 1.13.

EXPAND_VERT = 0.0, EVAS_HINT_EXPAND

Expand vertically

New in version 1.13.

FILL_BOTH = EVAS_HINT_FILL, EVAS_HINT_FILL

Fill both direction

New in version 1.13.

FILL_HORIZ = EVAS_HINT_FILL, 0.5

Fill horizontally

New in version 1.13.

FILL_VERT = 0.5, EVAS_HINT_FILL

Fill vertically

New in version 1.13.

Evas_Button_Flags

Flags for Mouse Button events.

efl.evas.EVAS_BUTTON_NONE

No extra mouse button data.

efl.evas.EVAS_BUTTON_DOUBLE_CLICK

This mouse button press was the 2nd press of a double click.

efl.evas.EVAS_BUTTON_TRIPLE_CLICK

This mouse button press was the 3rd press of a triple click.

Evas_BiDi_Direction

efl.evas.EVAS_BIDI_DIRECTION_NATURAL

Natural direction.

efl.evas.EVAS_BIDI_DIRECTION_NEUTRAL

Neutral direction.

efl.evas.EVAS_BIDI_DIRECTION_LTR

Left to right direction.

efl.evas.EVAS_BIDI_DIRECTION_RTL

Right to left direction.

efl.evas.EVAS_BIDI_DIRECTION_INHERIT

Inherit direction from parent object.

New in version 1.17.

Evas_Callback_Type

efl.evas.EVAS_CALLBACK_MOUSE_IN

Mouse In Event.

efl.evas.EVAS_CALLBACK_MOUSE_OUT

Mouse Out Event.

efl.evas.EVAS_CALLBACK_MOUSE_DOWN

Mouse Button Down Event.

efl.evas.EVAS_CALLBACK_MOUSE_UP

Mouse Button Up Event.

efl.evas.EVAS_CALLBACK_MOUSE_MOVE

Mouse Move Event.

efl.evas.EVAS_CALLBACK_MOUSE_WHEEL

Mouse Wheel Event.

efl.evas.EVAS_CALLBACK_MULTI_DOWN

Multi-touch Down Event.

efl.evas.EVAS_CALLBACK_MULTI_UP

Multi-touch Up Event.

efl.evas.EVAS_CALLBACK_MULTI_MOVE

Multi-touch Move Event.

efl.evas.EVAS_CALLBACK_FREE

Object Being Freed (Called after Del).

efl.evas.EVAS_CALLBACK_KEY_DOWN

Key Press Event.

efl.evas.EVAS_CALLBACK_KEY_UP

Key Release Event.

efl.evas.EVAS_CALLBACK_FOCUS_IN

Focus In Event.

efl.evas.EVAS_CALLBACK_FOCUS_OUT

Focus Out Event.

efl.evas.EVAS_CALLBACK_SHOW

Show Event.

efl.evas.EVAS_CALLBACK_HIDE

Hide Event.

efl.evas.EVAS_CALLBACK_MOVE

Move Event.

efl.evas.EVAS_CALLBACK_RESIZE

Resize Event.

efl.evas.EVAS_CALLBACK_RESTACK

Restack Event.

efl.evas.EVAS_CALLBACK_DEL

Object Being Deleted (called before Free).

efl.evas.EVAS_CALLBACK_HOLD

Events go on/off hold.

efl.evas.EVAS_CALLBACK_CHANGED_SIZE_HINTS

Size hints changed event.

efl.evas.EVAS_CALLBACK_IMAGE_PRELOADED

Image has been preloaded.

efl.evas.EVAS_CALLBACK_CANVAS_FOCUS_IN

Canvas got focus as a whole.

efl.evas.EVAS_CALLBACK_CANVAS_FOCUS_OUT

Canvas lost focus as a whole.

efl.evas.EVAS_CALLBACK_RENDER_FLUSH_PRE

Called just before rendering is updated on the canvas target.

efl.evas.EVAS_CALLBACK_RENDER_FLUSH_POST

Called just after rendering is updated on the canvas target.

efl.evas.EVAS_CALLBACK_CANVAS_OBJECT_FOCUS_IN

Canvas object got focus.

efl.evas.EVAS_CALLBACK_CANVAS_OBJECT_FOCUS_OUT

Canvas object lost focus.

efl.evas.EVAS_CALLBACK_IMAGE_UNLOADED

Image data has been unloaded.

efl.evas.EVAS_CALLBACK_RENDER_PRE

Called just before rendering starts on the canvas target.

efl.evas.EVAS_CALLBACK_RENDER_POST

Called just after rendering stops on the canvas target.

efl.evas.EVAS_CALLBACK_IMAGE_RESIZE

Image size is changed.

efl.evas.EVAS_CALLBACK_DEVICE_CHANGED

Devices added, removed or changed on canvas.

efl.evas.EVAS_CALLBACK_AXIS_UPDATE

Input device changed value on some axis. (since 1.13)

efl.evas.EVAS_CALLBACK_CANVAS_VIEWPORT_RESIZE

Canvas viewport resized. (since 1.15)

efl.evas.EVAS_CALLBACK_LAST

kept as last element/sentinel – not really an event.

Evas_Event_Flags

efl.evas.EVAS_EVENT_FLAG_NONE

No fancy flags set.

efl.evas.EVAS_EVENT_FLAG_ON_HOLD

This event is being delivered but should be put “on hold” until the on hold flag is unset. The event should be used for informational purposes and maybe some indications visually, but not actually perform anything

efl.evas.EVAS_EVENT_FLAG_ON_SCROLL

This event flag indicates the event occurs while scrolling; for example, DOWN event occurs during scrolling; the event should be used for informational purposes and maybe some indications visually, but not actually perform anything

Evas_Touch_Point_State

efl.evas.EVAS_TOUCH_POINT_DOWN

Touch point is pressed down

efl.evas.EVAS_TOUCH_POINT_UP

Touch point is released

efl.evas.EVAS_TOUCH_POINT_MOVE

Touch point is moved

efl.evas.EVAS_TOUCH_POINT_STILL

Touch point is not moved after pressed

efl.evas.EVAS_TOUCH_POINT_CANCEL

Touch point is cancelled

Evas_Font_Hinting_Flags

efl.evas.EVAS_FONT_HINTING_NONE

No font hinting

efl.evas.EVAS_FONT_HINTING_AUTO

Automatic font hinting

efl.evas.EVAS_FONT_HINTING_BYTECODE

Bytecode font hinting

Evas_Colorspace

efl.evas.EVAS_COLORSPACE_ARGB8888

ARGB8888

efl.evas.EVAS_COLORSPACE_YCBCR422P601_PL

YCBCR422P601_PL

efl.evas.EVAS_COLORSPACE_YCBCR422P709_PL

YCBCR422P709_PL

efl.evas.EVAS_COLORSPACE_RGB565_A5P

RGB565_A5P

efl.evas.EVAS_COLORSPACE_GRY8

GRY8

efl.evas.EVAS_COLORSPACE_YCBCR422601_PL

YCBCR422601_PL

efl.evas.EVAS_COLORSPACE_YCBCR420NV12601_PL

YCBCR420NV12601_PL

efl.evas.EVAS_COLORSPACE_YCBCR420TM12601_PL

YCBCR420TM12601_PL

Evas_Object_Table_Homogeneous_Mode

How to pack items into cells in a table

efl.evas.EVAS_OBJECT_TABLE_HOMOGENEOUS_NONE

None

efl.evas.EVAS_OBJECT_TABLE_HOMOGENEOUS_TABLE

Table

efl.evas.EVAS_OBJECT_TABLE_HOMOGENEOUS_ITEM

Item

Evas_Aspect_Control

efl.evas.EVAS_ASPECT_CONTROL_NONE

Preference on scaling unset

efl.evas.EVAS_ASPECT_CONTROL_NEITHER

Same effect as unset preference on scaling

efl.evas.EVAS_ASPECT_CONTROL_HORIZONTAL

Use all horizontal container space to place an object, using the given aspect

efl.evas.EVAS_ASPECT_CONTROL_VERTICAL

Use all vertical container space to place an object, using the given aspect

efl.evas.EVAS_ASPECT_CONTROL_BOTH

Use all horizontal and vertical container spaces to place an object (never growing it out of those bounds), using the given aspect

Evas_Display_Mode

efl.evas.EVAS_DISPLAY_MODE_NONE

Default mode.

efl.evas.EVAS_DISPLAY_MODE_COMPRESS

Use this mode when you want to give compress display mode hint to an object.

efl.evas.EVAS_DISPLAY_MODE_EXPAND

Use this mode when you want to give expand display mode hint to an object.

efl.evas.EVAS_DISPLAY_MODE_DONT_CHANGE

Use this mode when an object should not change its display mode.

Evas_Load_Error

efl.evas.EVAS_LOAD_ERROR_NONE

None.

efl.evas.EVAS_LOAD_ERROR_GENERIC

Generic.

efl.evas.EVAS_LOAD_ERROR_DOES_NOT_EXIST

Not exists.

efl.evas.EVAS_LOAD_ERROR_PERMISSION_DENIED

Permission danied.

efl.evas.EVAS_LOAD_ERROR_RESOURCE_ALLOCATION_FAILED

Allocation failure.

efl.evas.EVAS_LOAD_ERROR_CORRUPT_FILE

Corrupted file.

efl.evas.EVAS_LOAD_ERROR_UNKNOWN_FORMAT

Unknown format.

Evas_Alloc_Error

efl.evas.EVAS_ALLOC_ERROR_NONE

No allocation error.

efl.evas.EVAS_ALLOC_ERROR_FATAL

Allocation failed despite attempts to free up memory.

efl.evas.EVAS_ALLOC_ERROR_RECOVERED

Allocation succeeded, but extra memory had to be found by freeing up speculative resources.

XXX

efl.evas.EVAS_TEXTURE_REFLECT

Image fill tiling mode - tiling reflects

efl.evas.EVAS_TEXTURE_REPEAT

Image fill tiling mode - tiling reflects

efl.evas.EVAS_TEXTURE_RESTRICT

Tiling clamps - range offset ignored

efl.evas.EVAS_TEXTURE_RESTRICT_REFLECT

Tiling clamps and any range offset reflects

efl.evas.EVAS_TEXTURE_RESTRICT_REPEAT

Tiling clamps and any range offset repeats

efl.evas.EVAS_TEXTURE_PAD

Tiling extends with end values

Evas_Pixel_Import_Pixel_Format

efl.evas.EVAS_PIXEL_FORMAT_NONE

No pixel format.

efl.evas.EVAS_PIXEL_FORMAT_ARGB32

ARGB 32bit pixel format with A in the high byte per 32bit pixel word.

efl.evas.EVAS_PIXEL_FORMAT_YUV420P_601

YUV 420 Planar format with CCIR 601 color encoding with contiguous planes in the order Y, U and V.

_Evas_Native_Surface_Type

efl.evas.EVAS_NATIVE_SURFACE_NONE

No surface type.

efl.evas.EVAS_NATIVE_SURFACE_X11

X Window system based type.

efl.evas.EVAS_NATIVE_SURFACE_OPENGL

OpenGL system based type.

efl.evas.EVAS_NATIVE_SURFACE_WL

Wayland system based type.

Evas_Render_Op

efl.evas.EVAS_RENDER_BLEND

default op: d = d*(1-sa) + s

efl.evas.EVAS_RENDER_BLEND_REL

d = d*(1 - sa) + s*da

efl.evas.EVAS_RENDER_COPY

d = s

efl.evas.EVAS_RENDER_COPY_REL

d = s*da

efl.evas.EVAS_RENDER_ADD

Unknown

efl.evas.EVAS_RENDER_ADD_REL

d = d + s*da

efl.evas.EVAS_RENDER_SUB

d = d - s

efl.evas.EVAS_RENDER_SUB_REL

Unknown

efl.evas.EVAS_RENDER_TINT

d = d*s + d*(1 - sa) + s*(1 - da)

efl.evas.EVAS_RENDER_TINT_REL

d = d*(1 - sa + s)

efl.evas.EVAS_RENDER_MASK

d = d*sa

efl.evas.EVAS_RENDER_MUL

d = d*s

Evas_Border_Fill_Mode

efl.evas.EVAS_BORDER_FILL_NONE

None

efl.evas.EVAS_BORDER_FILL_DEFAULT

Default

efl.evas.EVAS_BORDER_FILL_SOLID

Solid

Evas_Image_Scale_Hint

efl.evas.EVAS_IMAGE_SCALE_HINT_NONE

None

efl.evas.EVAS_IMAGE_SCALE_HINT_DYNAMIC

Dynamic

efl.evas.EVAS_IMAGE_SCALE_HINT_STATIC

Static

Evas_Image_Animated_Loop_Hint

efl.evas.EVAS_IMAGE_ANIMATED_HINT_NONE

None

efl.evas.EVAS_IMAGE_ANIMATED_HINT_LOOP

Loop

efl.evas.EVAS_IMAGE_ANIMATED_HINT_PINGPONG

Pingpong

Evas_Image_Orient

New in version 1.14.

efl.evas.EVAS_IMAGE_ORIENT_NONE

No orientation change

efl.evas.EVAS_IMAGE_ORIENT_0

No orientation change

efl.evas.EVAS_IMAGE_ORIENT_90

Orient 90 degrees clockwise

efl.evas.EVAS_IMAGE_ORIENT_180

Orient 180 degrees clockwise

efl.evas.EVAS_IMAGE_ORIENT_270

Rotate 90 degrees counter-clockwise (i.e. 270 degrees clockwise)

efl.evas.EVAS_IMAGE_FLIP_HORIZONTAL

Flip image horizontally

efl.evas.EVAS_IMAGE_FLIP_VERTICAL

Flip image vertically

efl.evas.EVAS_IMAGE_FLIP_TRANSPOSE

Flip image along the y = (width - x) line (bottom-left to top-right)

efl.evas.EVAS_IMAGE_FLIP_TRANSVERSE

Flip image along the y = x line (top-left to bottom-right)

Evas_Engine_Render_Mode

efl.evas.EVAS_RENDER_MODE_BLOCKING

The rendering is blocking mode.

efl.evas.EVAS_RENDER_MODE_NONBLOCKING

The rendering is non blocking mode.

Evas_Image_Content_Hint

efl.evas.EVAS_IMAGE_CONTENT_HINT_NONE

No hint at all.

efl.evas.EVAS_IMAGE_CONTENT_HINT_DYNAMIC

The contents will change over time.

efl.evas.EVAS_IMAGE_CONTENT_HINT_STATIC

The contents won’t change over time.

Evas_Device_Class

efl.evas.EVAS_DEVICE_CLASS_NONE

Not a device.

efl.evas.EVAS_DEVICE_CLASS_SEAT

The user/seat (the user themselves)

efl.evas.EVAS_DEVICE_CLASS_KEYBOARD

A regular keyboard, numberpad or attached buttons.

efl.evas.EVAS_DEVICE_CLASS_MOUSE

A mouse, trackball or touchpad relative motion device.

efl.evas.EVAS_DEVICE_CLASS_TOUCH

A touchscreen with fingers or stylus.

efl.evas.EVAS_DEVICE_CLASS_PEN

A special pen device.

efl.evas.EVAS_DEVICE_CLASS_POINTER

A laser pointer, wii-style or “minority report” pointing device.

efl.evas.EVAS_DEVICE_CLASS_GAMEPAD

A gamepad controller or joystick.

Evas_Object_Pointer_Mode

efl.evas.EVAS_OBJECT_POINTER_MODE_AUTOGRAB

default, X11-like

efl.evas.EVAS_OBJECT_POINTER_MODE_NOGRAB

pointer always bound to the object right below it

efl.evas.EVAS_OBJECT_POINTER_MODE_NOGRAB_NO_REPEAT_UPDOWN

useful on object with “repeat events” enabled, where mouse/touch up and down events WONT be repeated to objects and these objects wont be auto-grabbed.

Evas_Text_Style_Type

efl.evas.EVAS_TEXT_STYLE_PLAIN

plain

efl.evas.EVAS_TEXT_STYLE_SHADOW

shadow

efl.evas.EVAS_TEXT_STYLE_OUTLINE

outline

efl.evas.EVAS_TEXT_STYLE_SOFT_OUTLINE

soft outline

efl.evas.EVAS_TEXT_STYLE_GLOW

glow

efl.evas.EVAS_TEXT_STYLE_OUTLINE_SHADOW

outline shadow

efl.evas.EVAS_TEXT_STYLE_FAR_SHADOW

far shadow

efl.evas.EVAS_TEXT_STYLE_OUTLINE_SOFT_SHADOW

outline soft shadow

efl.evas.EVAS_TEXT_STYLE_SOFT_SHADOW

soft shadow

efl.evas.EVAS_TEXT_STYLE_FAR_SOFT_SHADOW

far soft shadow

efl.evas.EVAS_TEXT_STYLE_SHADOW_DIRECTION_BOTTOM_RIGHT

shadow direction bottom right

efl.evas.EVAS_TEXT_STYLE_SHADOW_DIRECTION_BOTTOM

shadow direction bottom

efl.evas.EVAS_TEXT_STYLE_SHADOW_DIRECTION_BOTTOM_LEFT

shadow direction bottom left

efl.evas.EVAS_TEXT_STYLE_SHADOW_DIRECTION_LEFT

shadow direction left

efl.evas.EVAS_TEXT_STYLE_SHADOW_DIRECTION_TOP_LEFT

shadow direction top left

efl.evas.EVAS_TEXT_STYLE_SHADOW_DIRECTION_TOP

shadow direction top

efl.evas.EVAS_TEXT_STYLE_SHADOW_DIRECTION_TOP_RIGHT

shadow direction top right

efl.evas.EVAS_TEXT_STYLE_SHADOW_DIRECTION_RIGHT

shadow direction right

Evas_Textblock_Text_Type

efl.evas.EVAS_TEXTBLOCK_TEXT_RAW

Textblock text of type raw.

efl.evas.EVAS_TEXTBLOCK_TEXT_PLAIN

Textblock text of type plain.

efl.evas.EVAS_TEXTBLOCK_TEXT_MARKUP

Textblock text of type markup.

Evas_Textblock_Cursor_Type

efl.evas.EVAS_TEXTBLOCK_CURSOR_UNDER

Cursor type is under.

efl.evas.EVAS_TEXTBLOCK_CURSOR_BEFORE

Cursor type is before.

Textgrid Palette

The palette to use for the foreground and background colors.

efl.evas.EVAS_TEXTGRID_PALETTE_NONE

No palette is used.

efl.evas.EVAS_TEXTGRID_PALETTE_STANDARD

Standard palette (around 16 colors).

efl.evas.EVAS_TEXTGRID_PALETTE_EXTENDED

Extended palette (at max 256 colors).

efl.evas.EVAS_TEXTGRID_PALETTE_LAST

Ignore it.

Textgrid Font Style

The style to give to each character of the grid.

efl.evas.EVAS_TEXTGRID_FONT_STYLE_NORMAL

Normal style.

efl.evas.EVAS_TEXTGRID_FONT_STYLE_BOLD

Bold style.

efl.evas.EVAS_TEXTGRID_FONT_STYLE_ITALIC

Oblique style.

Module level functions

class efl.evas.ClippedSmartObject

Bases: efl.evas.SmartObject

exception efl.evas.EvasLoadError(self, int code, filename, key)

Bases: Exception

class efl.evas.SmartCbDescription(name, types)

Bases: object

Introspection description for a smart callback

name
Type

string

type
Type

string

efl.evas.color_argb_premul(r, g, b, a)
efl.evas.color_argb_unpremul(r, g, b, a)
efl.evas.color_hsv_to_rgb(h, s, v)
efl.evas.color_parse(desc, is_premul=None)
efl.evas.color_rgb_to_hsv(r, g, b)
efl.evas.extension_can_load(filename)

Check if a file extension is supported by Image.

Parameters

filename (unicode) – The file to check

Returns

True if we may be able to open it,``False`` if it’s unlikely.

Return type

bool

Note

This function is threadsafe.

efl.evas.font_path_global_append(path)

Appends a font path to the list of font paths used by the application

efl.evas.font_path_global_clear()

Removes all font paths loaded

efl.evas.font_path_global_list()

Retrieves the list of font paths used by the application

efl.evas.font_path_global_prepend(path)

Prepends a font path to the list of font paths used by the application

efl.evas.init()
efl.evas.render_method_list()

Returns a list of render method names.

Return type

list of str

efl.evas.render_method_lookup(name)

Lookup render method and return its id (> 0 if found).

Parameters

name (string) – Render method

Returns

ID

Return type

int

efl.evas.shutdown()
© Copyright 2008-2022, The Python-EFL community (see AUTHORS).
Last updated on Feb 27, 2022. Created using Sphinx 4.4.0.