Linux Manuals session 3

X Damage Extension Functions – Functions related to the X Damage extension. Functions EAPI int ecore_x_damage_query (void) Return whether the Damage Extension is available. EAPI Ecore_X_Damage ecore_x_damage_new (Ecore_X_Drawable drawable, Ecore_X_Damage_Report_Level level) Creates a damage object. EAPI void ecore_x_damage_del (Ecore_X_Damage damage) Destroys a damage object. EAPI void ecore_x_damage_subtract (Ecore_X_Damage damage, Ecore_X_Region repair, Ecore_X_Region parts) Synchronously modifies…

X DPMS Extension Functions – Functions related to the X DPMS extension. Functions EAPI int ecore_x_dpms_query (void) Checks if the DPMS extension is available or not. EAPI void ecore_x_dpms_capable_get_prefetch (void) Sends the DPMSCapable request. EAPI void ecore_x_dpms_capable_get_fetch (void) Gets the reply of the DPMSCapable request sent by ecore_x_dpms_capable_get_prefetch(). EAPI int ecore_x_dpms_capable_get (void) Checks if the…

X Composite Extension Functions – Functions related to the X Composite extension. Functions EAPI int ecore_x_composite_query (void) Return whether the Composite Extension is available. Detailed Description Functions related to the X Composite extension. Function Documentation EAPI int ecore_x_composite_query (void) Return whether the Composite Extension is available. Returns: 1 if the Composite Extension is available, 0…

XCB Atom Functions – Functions that operate on atoms. Functions EAPI void ecore_x_atom_get_prefetch (const char *name) Sends the InternAtom request. EAPI void ecore_x_atom_get_fetch (void) Gets the reply of the InternAtom request sent by ecore_x_atom_get_prefetch(). EAPI Ecore_X_Atom ecore_x_atom_get (const char *name __UNUSED__) Retrieves the atom value associated to a name. Detailed Description Functions that operate on…

Ecore_X.h – Ecore functions for dealing with the X Windows System. Synopsis Enumerations enum _Ecore_X_Window_State { ECORE_X_WINDOW_STATE_ICONIFIED, ECORE_X_WINDOW_STATE_MODAL, ECORE_X_WINDOW_STATE_STICKY, ECORE_X_WINDOW_STATE_MAXIMIZED_VERT, ECORE_X_WINDOW_STATE_MAXIMIZED_HORZ, ECORE_X_WINDOW_STATE_SHADED, ECORE_X_WINDOW_STATE_SKIP_TASKBAR, ECORE_X_WINDOW_STATE_SKIP_PAGER, ECORE_X_WINDOW_STATE_HIDDEN, ECORE_X_WINDOW_STATE_FULLSCREEN } enum _Ecore_X_WM_Protocol { ECORE_X_WM_PROTOCOL_DELETE_REQUEST, ECORE_X_WM_PROTOCOL_TAKE_FOCUS, ECORE_X_NET_WM_PROTOCOL_PING, ECORE_X_NET_WM_PROTOCOL_SYNC_REQUEST } enum _Ecore_X_Window_Input_Mode { ECORE_X_WINDOW_INPUT_MODE_NONE, ECORE_X_WINDOW_INPUT_MODE_PASSIVE, ECORE_X_WINDOW_INPUT_MODE_ACTIVE_LOCAL, ECORE_X_WINDOW_INPUT_MODE_ACTIVE_GLOBAL } enum _Ecore_X_Window_State_Hint { ECORE_X_WINDOW_STATE_HINT_NONE = -1, ECORE_X_WINDOW_STATE_HINT_WITHDRAWN, ECORE_X_WINDOW_STATE_HINT_NORMAL, ECORE_X_WINDOW_STATE_HINT_ICONIC } Functions EAPI…

Ecore_Txt.h – Provides a text encoding conversion function. Synopsis Functions EAPI char * ecore_txt_convert (const char *enc_from, const char *enc_to, const char *text) To be documented. Detailed Description Provides a text encoding conversion function. Function Documentation EAPI char* ecore_txt_convert (const char * enc_from, const char * enc_to, const char * text) To be documented. FIXME:…

Ecore Time Functions – Functions that deal with time. Functions EAPI double ecore_time_get (void) Retrieves the current system time as a floating point value in seconds. EAPI Ecore_Timer * ecore_timer_add (double in, int(*func)(void *data), const void *data) Creates a timer to call the given function in the given period of time. EAPI void * ecore_timer_del…

String Instance Functions – These functions allow you to store one copy of a string, and use it throughout your program. Functions EAPI const char * ecore_string_instance (const char *string) Retrieves an instance of a string for use in an ecore program. EAPI void ecore_string_release (const char *string) Notes that the given string has lost…

Ecore_Str.h – Contains useful C string functions. Synopsis Functions EAPI size_t ecore_strlcpy (char *dst, const char *src, size_t siz) copy a c-string EAPI size_t ecore_strlcat (char *dst, const char *src, size_t siz) append a c-string EAPI int ecore_str_has_prefix (const char *str, const char *prefix) checks if the string has the given prefix EAPI int ecore_str_has_suffix…

Ecore_Sdl.h – Ecore SDL system functions. Synopsis Data Structures struct _Ecore_Sdl_Event_Key_Down SDL Key Down event. struct _Ecore_Sdl_Event_Key_Up SDL Key Up event. struct _Ecore_Sdl_Event_Mouse_Button_Down SDL Mouse Down event. struct _Ecore_Sdl_Event_Mouse_Button_Up SDL Mouse Up event. struct _Ecore_Sdl_Event_Mouse_Move SDL Mouse Move event. struct _Ecore_Sdl_Event_Mouse_Wheel SDL Mouse Wheel event. Functions EAPI int ecore_sdl_shutdown (void) Shuts down the Ecore_Sdl library….

Plugin Functions – Functions that load modules of compiled code into memory. Functions EAPI Ecore_Plugin * ecore_plugin_load (Ecore_Path_Group *group, const char *plugin_name, const char *version) Loads the specified plugin from the specified path group. EAPI void ecore_plugin_unload (Ecore_Plugin *plugin) Unloads the given plugin from memory. EAPI Ecore_List * ecore_plugin_available_get (Ecore_Path_Group *group) Retrieves a list of…

Path Group Functions – Functions that make it easier to find a file in a set of search paths. Functions EAPI Ecore_Path_Group * ecore_path_group_new (void) Creates a new path group. EAPI void ecore_path_group_del (Ecore_Path_Group *group) Destroys a previously created path group. EAPI void ecore_path_group_add (Ecore_Path_Group *group, const char *path) Adds a directory to be searched…

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…

Main Loop Functions – These functions control the Ecore event handling loop. Functions EAPI 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…

Ecore Jobs – You can queue jobs that are to be done by the main loop when the current event is dealt with. Functions EAPI 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…

Ecore_Job.h – Functions for dealing with Ecore jobs. Synopsis Typedefs typedef void Ecore_Job A job handle. Functions EAPI 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 Description Functions for dealing with…

Ecore_Ipc.h – Ecore inter-process communication functions. Synopsis Typedefs typedef void Ecore_Ipc_Server An IPC connection handle. typedef void Ecore_Ipc_Client An IPC connection handle. Functions EAPI 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….

IPC Server Functions – Functions the deal with IPC server objects. Functions EAPI 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 Library Functions – Functions that set up and shut down the Ecore IPC Library. Functions EAPI int ecore_ipc_init (void) Initialises the Ecore IPC library. EAPI int ecore_ipc_shutdown (void) Shuts down the Ecore IPC library. Detailed Description Functions that set up and shut down the Ecore IPC Library. Function Documentation EAPI int ecore_ipc_init (void) Initialises…

IPC Client Functions – Functions that deal with IPC client objects. Functions EAPI 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…