efl.ecore Module

Enumerations

Fd handler flags

What to monitor the file descriptor for: reading, writing or error.

efl.ecore.ECORE_FD_READ

Fd Read mask

efl.ecore.ECORE_FD_WRITE

Fd Write mask

efl.ecore.ECORE_FD_ERROR

Fd Error mask

Exe flags

Flags for executing a child with its stdin and/or stdout piped back.

efl.ecore.ECORE_EXE_NONE

No exe flags at all

efl.ecore.ECORE_EXE_PIPE_READ

Exe Pipe Read mask

efl.ecore.ECORE_EXE_PIPE_WRITE

Exe Pipe Write mask

efl.ecore.ECORE_EXE_PIPE_ERROR

Exe Pipe error mask

efl.ecore.ECORE_EXE_PIPE_READ_LINE_BUFFERED

Reads are buffered until a newline and split 1 line per Ecore_Exe_Event_Data_Line

efl.ecore.ECORE_EXE_PIPE_ERROR_LINE_BUFFERED

Errors are buffered until a newline and split 1 line per Ecore_Exe_Event_Data_Line

efl.ecore.ECORE_EXE_PIPE_AUTO

stdout and stderr are buffered automatically

efl.ecore.ECORE_EXE_RESPAWN

FIXME: Exe is restarted if it dies

efl.ecore.ECORE_EXE_USE_SH

Use /bin/sh to run the command

efl.ecore.ECORE_EXE_NOT_LEADER

Do not use setsid() to have the executed process be its own session leader

efl.ecore.ECORE_EXE_TERM_WITH_PARENT

Makes child receive SIGTERM when parent dies

Callback return values

efl.ecore.ECORE_CALLBACK_CANCEL

Return value to remove a callback, it will not be called again

efl.ecore.ECORE_CALLBACK_RENEW

Return value to keep a callback

Event return values

efl.ecore.ECORE_CALLBACK_PASS_ON

Return value to pass event to next handler

efl.ecore.ECORE_CALLBACK_DONE

Return value to stop event handling

Position mappings for the animation

efl.ecore.ECORE_POS_MAP_LINEAR

Linear 0.0 -> 1.0

efl.ecore.ECORE_POS_MAP_ACCELERATE

Start slow then speed up

efl.ecore.ECORE_POS_MAP_DECELERATE

Start fast then slow down

efl.ecore.ECORE_POS_MAP_SINUSOIDAL

Start slow, speed up then slow down at end

efl.ecore.ECORE_POS_MAP_ACCELERATE_FACTOR

Start slow then speed up, v1 being a power factor, 0.0 being linear, 1.0 being normal accelerate, 2.0 being much more pronounced accelerate (squared), 3.0 being cubed, etc.

efl.ecore.ECORE_POS_MAP_DECELERATE_FACTOR

Start fast then slow down, v1 being a power factor, 0.0 being linear, 1.0 being normal decelerate, 2.0 being much more pronounced decelerate (squared), 3.0 being cubed, etc.

efl.ecore.ECORE_POS_MAP_SINUSOIDAL_FACTOR

Start slow, speed up then slow down at end, v1 being a power factor, 0.0 being linear, 1.0 being normal sinusoidal, 2.0 being much more pronounced sinusoidal (squared), 3.0 being cubed, etc.

efl.ecore.ECORE_POS_MAP_DIVISOR_INTERP

Start at gradient * v1, interpolated via power of v2 curve

efl.ecore.ECORE_POS_MAP_BOUNCE

Start at 0.0 then “drop” like a ball bouncing to the ground at 1.0, and bounce v2 times, with decay factor of v1

efl.ecore.ECORE_POS_MAP_SPRING

Start at 0.0 then “wobble” like a spring rest position 1.0, and wobble v2 times, with decay factor of v1

efl.ecore.ECORE_POS_MAP_CUBIC_BEZIER

TODO: Follow the cubic-bezier curve calculated with the control points (x1, y1), (x2, y2)

Timing sources for animators

efl.ecore.ECORE_ANIMATOR_SOURCE_TIMER

The default system clock/timer based animator that ticks every “frametime” seconds

efl.ecore.ECORE_ANIMATOR_SOURCE_CUSTOM

A custom animator trigger that you need to call ecore_animator_trigger() to make it tick

File monitor events

efl.ecore.ECORE_FILE_EVENT_NONE

No event

efl.ecore.ECORE_FILE_EVENT_CREATED_FILE

A file has been created

efl.ecore.ECORE_FILE_EVENT_CREATED_DIRECTORY

A directory has been created

efl.ecore.ECORE_FILE_EVENT_DELETED_FILE

A file has been deleted

efl.ecore.ECORE_FILE_EVENT_DELETED_DIRECTORY

A directory has been deleted

efl.ecore.ECORE_FILE_EVENT_DELETED_SELF

The monitored path itself has been deleted

efl.ecore.ECORE_FILE_EVENT_MODIFIED

A file has changed

efl.ecore.ECORE_FILE_EVENT_CLOSED

A file has been closed

Classes

class efl.ecore.CustomEvent

Bases: efl.ecore.Event

class efl.ecore.Event

Bases: object

class efl.ecore.EventHandler(int type, func, *args, **kargs)

Bases: object

Parm type

event type, as registered with ecore_event_type_new().

delete()
stop()
class efl.ecore.EventHandlerExe

Bases: efl.ecore.EventHandler

Specialized event handler that creates specialized event instances.

This class is responsible by filtering out the events created from C without associated Python wrappers.

Parm type

event type, as registered with ecore_event_type_new().

class efl.ecore.EventHandlerSignalExit(func, *args, **kargs)

Bases: efl.ecore.EventHandler

class efl.ecore.EventHandlerSignalUser(func, *args, **kargs)

Bases: efl.ecore.EventHandler

class efl.ecore.EventSignalExit

Bases: efl.ecore.Event

class efl.ecore.EventSignalHup

Bases: efl.ecore.Event

class efl.ecore.EventSignalInterrupt

Bases: efl.ecore.EventSignalExit

class efl.ecore.EventSignalPower

Bases: efl.ecore.Event

class efl.ecore.EventSignalQuit

Bases: efl.ecore.EventSignalExit

class efl.ecore.EventSignalRealtime

Bases: efl.ecore.Event

class efl.ecore.EventSignalTerminate

Bases: efl.ecore.EventSignalExit

class efl.ecore.EventSignalUser

Bases: efl.ecore.Event

class efl.ecore.EventSignalUser1

Bases: efl.ecore.EventSignalUser

class efl.ecore.EventSignalUser2

Bases: efl.ecore.EventSignalUser

class efl.ecore.ExeEventFilter(Exe exe, int event_type)

Bases: object

callback_add(func, args, kargs)
callback_del(func, args, kargs)
delete()
class efl.ecore.QueuedEvent(int type, *args)

Bases: object

delete()
efl.ecore.animator_add(func, *args, **kargs)

Animator factory, for C-api compatibility.

func signature:

func(*args, **kargs): bool
Parameters

func – function to call every frame.

Returns

a new Animator instance

Return type

efl.ecore.Animator

efl.ecore.animator_frametime_get()
efl.ecore.animator_frametime_set(frametime)
efl.ecore.event_add(type, *args)
efl.ecore.event_handler_add(type, func, *args, **kargs)
efl.ecore.event_type_new(cls)
efl.ecore.exe_pipe_run(exe_cmd, flags=0, data=None)

efl.ecore.Exe factory, for C-api compatibility.

efl.ecore.exe_run(exe_cmd, data=None)

efl.ecore.Exe factory, for C-api compatibility.

efl.ecore.exe_run_priority_get()
efl.ecore.exe_run_priority_set(pri)
efl.ecore.fd_handler_add(fd, flags, func, *args, **kargs)

FdHandler factory, for C-api compatibility.

func signature:

func(fd_handler, *args, **kargs): bool
Parameters
  • fd – file descriptor or object with fileno() method.

  • flags – bitwise OR of ECORE_FD_READ, ECORE_FD_WRITE…

  • func – function to call when file descriptor state changes.

Return type

efl.ecore.FdHandler

efl.ecore.file_download(url, dst, completion_cb, progress_cb, *args, **kargs)

efl.ecore.FileDownload factory, for C-api compatibility.

Parameters
  • url – The complete url to download

  • dst – Where to download the file

  • completion_cb

    The function called when the download end Expected signature:

    completion_cb(file, status, \*args, \**kargs)
    

  • progress_cb

    The function to called while the download progress advance. Expected signature:

    progress_cb(file, dltotal, dlnow, uptotal, upnow, \*args, \**kargs): int
    

Returns

a new efl.ecore.FileDownload instance

Return type

efl.ecore.FileDownload

efl.ecore.file_download_abort(instance)

C-api compatibility Abort the given download an free internal resources

efl.ecore.file_download_abort_all()

This will abort all the download currently in progress, use with caution.

efl.ecore.file_download_protocol_available(protocol)

Check if the given download protocol is available, available protocols are: “http://”, “ftp://” and “file://”. Note that ecore can be compiled without CURL support and thus http and ftp could not be available

Parameters

protocol (str) – The protocol to check, ex: “http://

Returns

True if the protocol is supported

Return type

bool

efl.ecore.idle_enterer_add(func, *args, **kargs)

efl.ecore.IdleEnterer factory, for C-api compatibility.

Parameters

func

Function to call when system enters idle. Expected signature:

func(*args, **kargs): bool

Returns

a new IdleEnterer instance

Return type

efl.ecore.IdleEnterer

efl.ecore.idle_exiter_add(func, *args, **kargs)

efl.ecore.IdleExiter factory, for C-api compatibility.

Parameters

func

Function to call when system exits idle. Expected signature:

func(*args, **kargs): bool

Returns

a new IdleExiter instance

Return type

efl.ecore.IdleExiter

efl.ecore.idler_add(func, *args, **kargs)

efl.ecore.Idler factory, for C-api compatibility.

Parameters

func

function to call when system is idle. Expected signature:

func(*args, **kargs): bool

Returns

a new Idler instance

Return type

efl.ecore.Idler

efl.ecore.init()
efl.ecore.loop_time_get()
efl.ecore.main_loop_begin()
efl.ecore.main_loop_glib_always_integrate_disable()
efl.ecore.main_loop_glib_integrate()
efl.ecore.main_loop_iterate()
efl.ecore.main_loop_quit()
efl.ecore.on_exe_add_event_add(func, *args, **kargs)

Create an ecore event handler for ECORE_EXE_EVENT_ADD

See

EventHandler

See

EventHandlerExe

efl.ecore.on_exe_data_event_add(func, *args, **kargs)

Create an ecore event handler for ECORE_EXE_EVENT_DATA

See

EventHandler

See

EventHandlerExe

efl.ecore.on_exe_del_event_add(func, *args, **kargs)

Create an ecore event handler for ECORE_EXE_EVENT_DEL

See

EventHandler

See

EventHandlerExe

efl.ecore.on_exe_error_event_add(func, *args, **kargs)

Create an ecore event handler for ECORE_EXE_EVENT_ERROR

See

EventHandler

See

EventHandlerExe

efl.ecore.on_signal_exit(func, *args, **kargs)
efl.ecore.on_signal_hup(func, *args, **kargs)
efl.ecore.on_signal_power(func, *args, **kargs)
efl.ecore.on_signal_realtime(func, *args, **kargs)
efl.ecore.on_signal_user(func, *args, **kargs)
efl.ecore.poller_add(t, func, *args, **kargs)
efl.ecore.shutdown()
efl.ecore.signal_warning(sig, action)
efl.ecore.time_get()
efl.ecore.timer_add(t, func, *args, **kargs)
efl.ecore.timer_precision_get()
efl.ecore.timer_precision_set(value)