Etk
Main Page Object Hierarchy Data Structures Related Pages
Etk

Etk_Engine


Detailed Description

Etk is based on engines that are used for specific tasks such as creating a window or handling copy/paste...


Data Structures

struct  Etk_Engine
 The structure of an engine regrouping the different methods to call. More...

Functions

Evas_List * etk_engine_list_get (void)
 Gets the list of the available engines.
Etk_Bool etk_engine_exists (const char *engine_name)
 Checks whether the engine exists.
Etk_Engine * etk_engine_get (void)
 Gets the engine currently used by Etk.
Etk_Bool etk_engine_inherit_from (Etk_Engine *engine, const char *inherit_name)
 Makes the engine inherit from another existing engine: the methods of the base engine will be used by the inheriting engine.
void etk_engine_window_constructor (Etk_Window *window)
 Calls the engine's method to create a window.
void etk_engine_window_destructor (Etk_Window *window)
 Calls the engine's method to destroy a window.
void etk_engine_window_show (Etk_Window *window)
 Calls the engine's method to show a window.
void etk_engine_window_hide (Etk_Window *window)
 Calls the engine's method to hide a window.
Evas * etk_engine_window_evas_get (Etk_Window *window)
 Calls the engine's method to get the evas of a window.
void etk_engine_window_title_set (Etk_Window *window, const char *title)
 Calls the engine's method to set the title of a window.
const char * etk_engine_window_title_get (Etk_Window *window)
 Calls the engine's method to get the title of a window.
void etk_engine_window_wmclass_set (Etk_Window *window, const char *window_name, const char *window_class)
 Calls the engine's method to set the window name and the window class of a window.
void etk_engine_window_move (Etk_Window *window, int x, int y)
 Calls the engine's method to move a window.
void etk_engine_window_resize (Etk_Window *window, int w, int h)
 Calls the engine's method to resize a window.
void etk_engine_window_size_min_set (Etk_Window *window, int w, int h)
 Calls the engine's method to set the minimum size of a window.
void etk_engine_window_evas_position_get (Etk_Window *window, int *x, int *y)
 Calls the engine's method to get the position of a window, relative to the evas where it is drawn.
void etk_engine_window_screen_position_get (Etk_Window *window, int *x, int *y)
 Calls the engine's method to get the position of a window, relative to the screen.
void etk_engine_window_size_get (Etk_Window *window, int *w, int *h)
 Calls the engine's method to get the size of a window.
void etk_engine_window_screen_geometry_get (Etk_Window *window, int *x, int *y, int *w, int *h)
 Calls the engine's method to get the geometry of the screen containing window.
void etk_engine_window_modal_for_window (Etk_Window *window_to_modal, Etk_Window *window)
 Calls the engine's method to make a window modal for another window.
void etk_engine_window_iconified_set (Etk_Window *window, Etk_Bool iconified)
 Calls the engine's method to set whether or not a window is iconified.
Etk_Bool etk_engine_window_iconified_get (Etk_Window *window)
 Calls the engine's method to get whether or not a window is iconified.
void etk_engine_window_maximized_set (Etk_Window *window, Etk_Bool maximized)
 Calls the engine's method to set whether or not a window is maximized.
Etk_Bool etk_engine_window_maximized_get (Etk_Window *window)
 Calls the engine's method to get whether or not a window is maximized.
void etk_engine_window_fullscreen_set (Etk_Window *window, Etk_Bool fullscreen)
 Calls the engine's method to set whether or not a window is in fullscreen mode.
Etk_Bool etk_engine_window_fullscreen_get (Etk_Window *window)
 Calls the engine's method to get whether a window is in fullscreen mode.
void etk_engine_window_raise (Etk_Window *window)
 Calls the engine's method to raise a window. The window will be stacked above all the existing windows.
void etk_engine_window_lower (Etk_Window *window)
 Calls the engine's method to lower a window. The window will be stacked below all the existing windows.
void etk_engine_window_stacking_set (Etk_Window *window, Etk_Window_Stacking stacking)
 Calls the engine's method to set the stacking layer of the window.
Etk_Window_Stacking etk_engine_window_stacking_get (Etk_Window *window)
 Calls the engine's method to get the stacking layer of the window.
void etk_engine_window_sticky_set (Etk_Window *window, Etk_Bool sticky)
 Calls the engine's method to set whether a window is sticky. A sticky window is a window that appears on all the virtual desktops.
Etk_Bool etk_engine_window_sticky_get (Etk_Window *window)
 Calls the engine's method to get whether a window is sticky the virtual desktops.
void etk_engine_window_focused_set (Etk_Window *window, Etk_Bool focused)
 Calls the engine's method to set whether a window is focused or not.
Etk_Bool etk_engine_window_focused_get (Etk_Window *window)
 Calls the engine's method to get whether a window is focused or not.
void etk_engine_window_decorated_set (Etk_Window *window, Etk_Bool decorated)
 Calls the engine's method to set whether the window should be decorated or not.
Etk_Bool etk_engine_window_decorated_get (Etk_Window *window)
 Calls the engine's method to get whether a window is decorated or not.
void etk_engine_window_shaped_set (Etk_Window *window, Etk_Bool shaped)
 Calls the engine's method to set whether the window is shaped or not. A shaped window can be non-rectangular.
Etk_Bool etk_engine_window_shaped_get (Etk_Window *window)
 Calls the engine's method to get whether the window is shaped or not.
void etk_engine_window_has_alpha_set (Etk_Window *window, Etk_Bool has_alpha)
 Calls the engine's method to set whether the window has alpha (supports translucency) or not.
Etk_Bool etk_engine_window_has_alpha_get (Etk_Window *window)
 Calls the engine's method to get whether the window has alpha (translucency) or not.
void etk_engine_window_skip_taskbar_hint_set (Etk_Window *window, Etk_Bool skip_taskbar_hint)
 Calls the engine's method to set whether or not the window should appear in the taskbar.
Etk_Bool etk_engine_window_skip_taskbar_hint_get (Etk_Window *window)
 Calls the engine's method to get whether or not the window appears in the taskbar.
void etk_engine_window_skip_pager_hint_set (Etk_Window *window, Etk_Bool skip_pager_hint)
 Calls the engine's method to set whether or not the window should appear in the pager.
Etk_Bool etk_engine_window_skip_pager_hint_get (Etk_Window *window)
 Calls the engine's method to get whether or not the window appears in the pager.
void etk_engine_window_pointer_set (Etk_Window *window, Etk_Pointer_Type pointer_type)
 Calls the engine's method to set the mouse pointer to use when the pointer is inside the window.
unsigned int etk_engine_event_timestamp_get (void)
 Calls the engine's method to get the current timestamp used by the events.
void etk_engine_mouse_position_get (int *x, int *y)
 Calls the engine's method to get the position of the mouse pointer, relative to the screen.
void etk_engine_mouse_screen_geometry_get (int *x, int *y, int *w, int *h)
 Calls the engine's method to get the geometry of the screen containing the mouse pointer.
void etk_engine_selection_text_set (Etk_Selection_Type selection, const char *text)
 Calls the engine's method to set the text of the given selection.
void etk_engine_selection_text_request (Etk_Selection_Type selection, Etk_Widget *target)
 Calls the engine's method to requests the text from a selection.
void etk_engine_selection_clear (Etk_Selection_Type selection)
 Calls the engine's method to clear the given selection.


Function Documentation

Evas_List * etk_engine_list_get ( void   ) 

Gets the list of the available engines.

Returns:
Returns the list of the available engines
Warning:
The returned list should not be modified or freed

Etk_Bool etk_engine_exists ( const char *  engine_name  ) 

Checks whether the engine exists.

Parameters:
engine_name the name of the engine to find
Returns:
Return ETK_TRUE if the engine exists, ETK_FALSE otherwise

Etk_Engine * etk_engine_get ( void   ) 

Gets the engine currently used by Etk.

Returns:
Returns the engine currently used by Etk or NULL if no engine is loaded yet

Etk_Bool etk_engine_inherit_from ( Etk_Engine *  engine,
const char *  inherit_name 
)

Makes the engine inherit from another existing engine: the methods of the base engine will be used by the inheriting engine.

Parameters:
engine the engine which will inherit from the methods of the base engine
inherit_name the name of the engine from which engine will inherit
Returns:
Returns ETK_TRUE on success, ETK_FALSE otherwise

void etk_engine_window_constructor ( Etk_Window *  window  ) 

Calls the engine's method to create a window.

Parameters:
window a window

void etk_engine_window_destructor ( Etk_Window *  window  ) 

Calls the engine's method to destroy a window.

Parameters:
window a window

void etk_engine_window_show ( Etk_Window *  window  ) 

Calls the engine's method to show a window.

Parameters:
window a window

void etk_engine_window_hide ( Etk_Window *  window  ) 

Calls the engine's method to hide a window.

Parameters:
window a window

Evas * etk_engine_window_evas_get ( Etk_Window *  window  ) 

Calls the engine's method to get the evas of a window.

Parameters:
window a window
Returns:
Returns the evas of the window, or NULL on failure

void etk_engine_window_title_set ( Etk_Window *  window,
const char *  title 
)

Calls the engine's method to set the title of a window.

Parameters:
window a window
title the title to set to the window

const char * etk_engine_window_title_get ( Etk_Window *  window  ) 

Calls the engine's method to get the title of a window.

Parameters:
window a window
Returns:
Returns the title of the window, or NULL on failure

void etk_engine_window_wmclass_set ( Etk_Window *  window,
const char *  window_name,
const char *  window_class 
)

Calls the engine's method to set the window name and the window class of a window.

Parameters:
window a window
window_name the window name to set
window_class the window class to set

void etk_engine_window_move ( Etk_Window *  window,
int  x,
int  y 
)

Calls the engine's method to move a window.

Parameters:
window a window
x the x position
y the y position

void etk_engine_window_resize ( Etk_Window *  window,
int  w,
int  h 
)

Calls the engine's method to resize a window.

Parameters:
window a window
w the new width of the window
h the new height of the window

void etk_engine_window_size_min_set ( Etk_Window *  window,
int  w,
int  h 
)

Calls the engine's method to set the minimum size of a window.

Parameters:
window a window
w the minimum width of the window
h the minimum height of the window

void etk_engine_window_evas_position_get ( Etk_Window *  window,
int *  x,
int *  y 
)

Calls the engine's method to get the position of a window, relative to the evas where it is drawn.

Parameters:
window a window
x the location where to store the x evas position of the window
y the location where to store the y evas position of the window

void etk_engine_window_screen_position_get ( Etk_Window *  window,
int *  x,
int *  y 
)

Calls the engine's method to get the position of a window, relative to the screen.

Parameters:
window a window
x the location where to store the x screen position of the window
y the location where to store the y screen position of the window

void etk_engine_window_size_get ( Etk_Window *  window,
int *  w,
int *  h 
)

Calls the engine's method to get the size of a window.

Parameters:
window a window
w the location where to store the width of the window
h the location where to store the height of the window

void etk_engine_window_screen_geometry_get ( Etk_Window *  window,
int *  x,
int *  y,
int *  w,
int *  h 
)

Calls the engine's method to get the geometry of the screen containing window.

Parameters:
window a window
x the location where to store x position of the screen
y the location where to store y position of the screen
w the location where to store the width of the screen
h the location where to store the height of the screen

void etk_engine_window_modal_for_window ( Etk_Window *  window_to_modal,
Etk_Window *  window 
)

Calls the engine's method to make a window modal for another window.

Parameters:
window_to_modal the window to make modal
window the window on which window_to_modal will modal'ed on, or NULL to disable the modal state

void etk_engine_window_iconified_set ( Etk_Window *  window,
Etk_Bool  iconified 
)

Calls the engine's method to set whether or not a window is iconified.

Parameters:
window a window
iconified ETK_TRUE to iconify the window, ETK_FALSE to de-iconify it

Etk_Bool etk_engine_window_iconified_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether or not a window is iconified.

Parameters:
window a window
Returns:
Returns ETK_TRUE if the window is iconified, ETK_FALSE if not

void etk_engine_window_maximized_set ( Etk_Window *  window,
Etk_Bool  maximized 
)

Calls the engine's method to set whether or not a window is maximized.

Parameters:
window a window
maximized ETK_TRUE to maximize the window, ETK_FALSE to unmaximize it

Etk_Bool etk_engine_window_maximized_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether or not a window is maximized.

Parameters:
window a window
Returns:
Returns ETK_TRUE if the window is maximized, ETK_FALSE if not

void etk_engine_window_fullscreen_set ( Etk_Window *  window,
Etk_Bool  fullscreen 
)

Calls the engine's method to set whether or not a window is in fullscreen mode.

Parameters:
window a window
fullscreen ETK_TRUE to place the window in the fullscreen state, ETK_FALSE to toggle off the fullscreen state

Etk_Bool etk_engine_window_fullscreen_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether a window is in fullscreen mode.

Parameters:
window a window
Returns:
Returns ETK_TRUE if the window is in fullscreen mode, ETK_FALSE otherwise

void etk_engine_window_raise ( Etk_Window *  window  ) 

Calls the engine's method to raise a window. The window will be stacked above all the existing windows.

Parameters:
window the window to raise

void etk_engine_window_lower ( Etk_Window *  window  ) 

Calls the engine's method to lower a window. The window will be stacked below all the existing windows.

Parameters:
window the window to lower

void etk_engine_window_stacking_set ( Etk_Window *  window,
Etk_Window_Stacking  stacking 
)

Calls the engine's method to set the stacking layer of the window.

Parameters:
window a window
stacking the stacking layer to use

Etk_Window_Stacking etk_engine_window_stacking_get ( Etk_Window *  window  ) 

Calls the engine's method to get the stacking layer of the window.

Parameters:
window a window
Returns:
Returns the stacking layer of the window

void etk_engine_window_sticky_set ( Etk_Window *  window,
Etk_Bool  sticky 
)

Calls the engine's method to set whether a window is sticky. A sticky window is a window that appears on all the virtual desktops.

Parameters:
window a window
sticky ETK_TRUE to make the window sticky, ETK_FALSE otherwise

Etk_Bool etk_engine_window_sticky_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether a window is sticky the virtual desktops.

Parameters:
window a window
Returns:
Returns ETK_TRUE if the window is sticky, ETK_FALSE otherwise

void etk_engine_window_focused_set ( Etk_Window *  window,
Etk_Bool  focused 
)

Calls the engine's method to set whether a window is focused or not.

Parameters:
window a window
focused ETK_TRUE to focus the window, ETK_FALSE to unfocus it

Etk_Bool etk_engine_window_focused_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether a window is focused or not.

Parameters:
window a window
Returns:
Returns ETK_TRUE if the window is focused, ETK_FALSE otherwise

void etk_engine_window_decorated_set ( Etk_Window *  window,
Etk_Bool  decorated 
)

Calls the engine's method to set whether the window should be decorated or not.

Parameters:
window a window
decorated ETK_TRUE to make the window decorated, ETK_FALSE to make it undecorated

Etk_Bool etk_engine_window_decorated_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether a window is decorated or not.

Parameters:
window a window
Returns:
Returns ETK_TRUE if the window is decorated, ETK_FALSE otherwise

void etk_engine_window_shaped_set ( Etk_Window *  window,
Etk_Bool  shaped 
)

Calls the engine's method to set whether the window is shaped or not. A shaped window can be non-rectangular.

Parameters:
window a window
shaped ETK_TRUE to make the window shaped, ETK_FALSE to make it rectangular

Etk_Bool etk_engine_window_shaped_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether the window is shaped or not.

Parameters:
window a window
Returns:
Returns ETK_TRUE if the window is shaped, ETK_FALSE otherwise

void etk_engine_window_has_alpha_set ( Etk_Window *  window,
Etk_Bool  has_alpha 
)

Calls the engine's method to set whether the window has alpha (supports translucency) or not.

Parameters:
window a window
has_alpha ETK_TRUE to give the window alpha, ETK_FALSE to make it non-translucent

Etk_Bool etk_engine_window_has_alpha_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether the window has alpha (translucency) or not.

Parameters:
window a window
Returns:
Returns ETK_TRUE if the window has an alpha channel (supports translucency), ETK_FALSE otherwise

void etk_engine_window_skip_taskbar_hint_set ( Etk_Window *  window,
Etk_Bool  skip_taskbar_hint 
)

Calls the engine's method to set whether or not the window should appear in the taskbar.

Parameters:
window a window
skip_taskbar_hint ETK_TRUE to prevent the window from appearing in the taskbar, ETK_FALSE otherwise

Etk_Bool etk_engine_window_skip_taskbar_hint_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether or not the window appears in the taskbar.

Parameters:
window a window
Returns:
ETK_TRUE if the window does not appear in the taskbar, ETK_FALSE otherwise

void etk_engine_window_skip_pager_hint_set ( Etk_Window *  window,
Etk_Bool  skip_pager_hint 
)

Calls the engine's method to set whether or not the window should appear in the pager.

Parameters:
window a window
skip_pager_hint ETK_TRUE to prevent the window from appearing in the pager, ETK_FALSE otherwise

Etk_Bool etk_engine_window_skip_pager_hint_get ( Etk_Window *  window  ) 

Calls the engine's method to get whether or not the window appears in the pager.

Parameters:
window a window
Returns:
ETK_TRUE if the window does not appear in the pager, ETK_FALSE otherwise

void etk_engine_window_pointer_set ( Etk_Window *  window,
Etk_Pointer_Type  pointer_type 
)

Calls the engine's method to set the mouse pointer to use when the pointer is inside the window.

Parameters:
window a window
pointer_type the type of mouse pointer to use

unsigned int etk_engine_event_timestamp_get ( void   ) 

Calls the engine's method to get the current timestamp used by the events.

Returns:
Returns the current event timestamp

void etk_engine_mouse_position_get ( int *  x,
int *  y 
)

Calls the engine's method to get the position of the mouse pointer, relative to the screen.

Parameters:
x the location where to store the x position of the mouse pointer
y the location where to store the y position of the mouse pointer

void etk_engine_mouse_screen_geometry_get ( int *  x,
int *  y,
int *  w,
int *  h 
)

Calls the engine's method to get the geometry of the screen containing the mouse pointer.

Parameters:
x the location where to store x position of the screen
y the location where to store y position of the screen
w the location where to store the width of the screen
h the location where to store the height of the screen

void etk_engine_selection_text_set ( Etk_Selection_Type  selection,
const char *  text 
)

Calls the engine's method to set the text of the given selection.

Parameters:
selection the selection type whose text should be set
text the text to set

void etk_engine_selection_text_request ( Etk_Selection_Type  selection,
Etk_Widget *  target 
)

Calls the engine's method to requests the text from a selection.

Parameters:
selection the selection you want to request the text from
target the widget that will receive the selection

void etk_engine_selection_clear ( Etk_Selection_Type  selection  ) 

Calls the engine's method to clear the given selection.

Parameters:
selection the selection to clear