Section 3: library functions
Ecore_Main_Loop_Page – The Ecore Main Loop What is Ecore?Ecore is a clean and tiny event loop library with many modules to do lots of convenient things for a programmer, to save time and effort. It’s small and lean, designed to work on embedded systems all the way to large and powerful multi-cpu workstations. It serialises…
Main Loop Functions – These functions control the Ecore event handling loop. FunctionsEAPI void ecore_main_loop_iterate (void) Runs a single iteration of the main loop to process everything on the queue. EAPI void ecore_main_loop_begin (void) Runs the application main loop. EAPI void ecore_main_loop_quit (void) Quits the main loop once all the events currently on the queue…
Ecore Jobs – You can queue jobs that are to be done by the main loop when the current event is dealt with. FunctionsEAPI Ecore_Job * ecore_job_add (void(*func)(void *data), const void *data) Add a job to the event queue. EAPI void * ecore_job_del (Ecore_Job *job) Delete a queued job that has not yet been executed….
Ecore_Job.h – Functions for dealing with Ecore jobs. SynopsisTypedefstypedef void Ecore_Job A job handle. FunctionsEAPI Ecore_Job * ecore_job_add (void(*func)(void *data), const void *data) Add a job to the event queue. EAPI void * ecore_job_del (Ecore_Job *job) Delete a queued job that has not yet been executed. Detailed DescriptionFunctions for dealing with Ecore jobs. AuthorGenerated automatically…
Ecore_Ipc.h – Ecore inter-process communication functions. SynopsisTypedefstypedef void Ecore_Ipc_Server An IPC connection handle. typedef void Ecore_Ipc_Client An IPC connection handle. FunctionsEAPI unsigned short _ecore_ipc_swap_16 (unsigned short v) Macros used for generic data packing. EAPI int ecore_ipc_init (void) Initialises the Ecore IPC library. EAPI int ecore_ipc_shutdown (void) Shuts down the Ecore IPC library. EAPI Ecore_Ipc_Server *…
IPC Server Functions – Functions the deal with IPC server objects. FunctionsEAPI Ecore_Ipc_Server * ecore_ipc_server_add (Ecore_Ipc_Type compl_type, const char *name, int port, const void *data) Creates an IPC server that listens for connections. EAPI Ecore_Ipc_Server * ecore_ipc_server_connect (Ecore_Ipc_Type compl_type, char *name, int port, const void *data) Creates an IPC server object to represent the IPC…
IPC Library Functions – Functions that set up and shut down the Ecore IPC Library. FunctionsEAPI int ecore_ipc_init (void) Initialises the Ecore IPC library. EAPI int ecore_ipc_shutdown (void) Shuts down the Ecore IPC library. Detailed DescriptionFunctions that set up and shut down the Ecore IPC Library. Function DocumentationEAPI int ecore_ipc_init (void)Initialises the Ecore IPC library….
IPC Client Functions – Functions that deal with IPC client objects. FunctionsEAPI int ecore_ipc_client_send (Ecore_Ipc_Client *cl, int major, int minor, int ref, int ref_to, int response, const void *data, int size) Sends a message to the given IPC client. EAPI Ecore_Ipc_Server * ecore_ipc_client_server_get (Ecore_Ipc_Client *cl) Retrieves the IPC server that the given IPC client is…
Ecore Input Method Library Functions – Utility functions that set up and shut down the Ecore Input Method library. FunctionsEAPI int ecore_imf_init (void) Initialises the Ecore_IMF library. EAPI int ecore_imf_shutdown (void) Shuts down the Ecore_IMF library. Detailed DescriptionUtility functions that set up and shut down the Ecore Input Method library. Function DocumentationEAPI int ecore_imf_init (void)Initialises…
Ecore Input Method Context Evas Helper Functions – Helper functions to make it easy to use Evas with Ecore_IMF. FunctionsEAPI void ecore_imf_evas_event_mouse_in_wrap (Evas_Event_Mouse_In *evas_event, Ecore_IMF_Event_Mouse_In *imf_event) Converts a ‘mouse_in’ event from Evas to the corresponding event of Ecore_IMF. EAPI void ecore_imf_evas_event_mouse_out_wrap (Evas_Event_Mouse_Out *evas_event, Ecore_IMF_Event_Mouse_Out *imf_event) Converts a ‘mouse_out’ event from Evas to the corresponding event…
Ecore Input Method Context Module Functions – Functions that should be used by Ecore Input Method Context modules. FunctionsEAPI Ecore_IMF_Context * ecore_imf_context_new (const Ecore_IMF_Context_Class *ctxc) Creates a new Input Method Context with klass specified by ctxc. EAPI void ecore_imf_context_data_set (Ecore_IMF_Context *ctx, void *data) Set the Input Method Context specific data. EAPI void * ecore_imf_context_data_get (Ecore_IMF_Context…
Ecore Input Method Context Functions – Functions that operate on Ecore Input Method Context objects. FunctionsEAPI Ecore_List * ecore_imf_context_available_ids_get (void) Get the list of the available Input Method Context ids. EAPI const char * ecore_imf_context_default_id_get (void) Get the id of the default Input Method Context. EAPI const Ecore_IMF_Context_Info * ecore_imf_context_info_by_id_get (const char *id) Retrieve the…
Ecore_File.h – Files utility functions. SynopsisFunctionsEAPI int ecore_file_init (void) Initialize Ecore_File and the services it will use. EAPI int ecore_file_shutdown (void) Shutdown the Ecore_File. EAPI long long ecore_file_mod_time (const char *file) Get the time of the last modification to the give file. EAPI long long ecore_file_size (const char *file) Get the size of the given…
Ecore_Fb.h – Ecore frame buffer system functions. SynopsisData Structuresstruct _Ecore_Fb_Event_Key_Down FB Key Down event. struct _Ecore_Fb_Event_Key_Up FB Key Up event. struct _Ecore_Fb_Event_Mouse_Button_Down FB Mouse Down event. struct _Ecore_Fb_Event_Mouse_Button_Up FB Mouse Up event. struct _Ecore_Fb_Event_Mouse_Move FB Mouse Move event. struct _Ecore_Fb_Event_Mouse_Wheel FB Mouse Wheel event. Typedefstypedef struct _Ecore_Fb_Event_Key_Down Ecore_Fb_Event_Key_Down FB Key Down event. typedef struct _Ecore_Fb_Event_Key_Up…
File Event Handling Functions – Functions that deal with file descriptor handlers. FunctionsEAPI Ecore_Fd_Handler * ecore_main_fd_handler_add (int fd, Ecore_Fd_Handler_Flags flags, int(*func)(void *data, Ecore_Fd_Handler *fd_handler), const void *data, int(*buf_func)(void *buf_data, Ecore_Fd_Handler *fd_handler), const void *buf_data) Adds a callback for activity on the given file descriptor. EAPI void * ecore_main_fd_handler_del (Ecore_Fd_Handler *fd_handler) Deletes the given FD handler….
Framebuffer Library Functions – Functions used to set up and shut down the Ecore_Framebuffer functions. FunctionsEAPI int ecore_fb_init (const char *name __UNUSED__) Sets up the Ecore_Fb library. EAPI int ecore_fb_shutdown (void) Shuts down the Ecore_Fb library. Detailed DescriptionFunctions used to set up and shut down the Ecore_Framebuffer functions. Function DocumentationEAPI int ecore_fb_init (const char *name…
Framebuffer Calibration Functions – Functions that calibrate the screen. FunctionsEAPI void ecore_fb_touch_screen_calibrate_set (int xscale, int xtrans, int yscale, int ytrans, int xyswap) Calibrates the touschreen using the given parameters. EAPI void ecore_fb_touch_screen_calibrate_get (int *xscale, int *xtrans, int *yscale, int *ytrans, int *xyswap) Retrieves the calibration parameters of the touchscreen. Detailed DescriptionFunctions that calibrate the screen….
Spawned Process Signal Functions – Functions that send signals to spawned processes. FunctionsEAPI void ecore_exe_pause (Ecore_Exe *exe) Pauses the given process by sending it a SIGSTOP signal. EAPI void ecore_exe_continue (Ecore_Exe *exe) Continues the given paused process by sending it a SIGCONT signal. EAPI void ecore_exe_interrupt (Ecore_Exe *exe) Sends the given spawned process a interrupt…
Process Spawning Functions – Functions that deal with spawned processes. FunctionsEAPI Ecore_Exe * ecore_exe_run (const char *exe_cmd, const void *data) Spawns a child process. EAPI Ecore_Exe * ecore_exe_pipe_run (const char *exe_cmd, Ecore_Exe_Flags flags, const void *data) Spawns a child process with its stdin/out available for communication. EAPI int ecore_exe_send (Ecore_Exe *exe, void *data, int size)…
Ecore_Evas.h – Evas wrapper functions. SynopsisFunctionsEAPI int ecore_evas_engine_type_supported_get (Ecore_Evas_Engine_Type engine) Query if a particular renginering engine target has support. EAPI int ecore_evas_init (void) Init the Evas system. EAPI int ecore_evas_shutdown (void) Shut down the Evas system. EAPI Evas_List * ecore_evas_engines_get (void) Returns a list of supported engines names. EAPI void ecore_evas_engines_free (Evas_List *engines) Free list…