Main Page | Modules | Alphabetical List | Data Structures | File List | Data Fields | Related Pages

Embed: A Container for Displaying on an Evas

Defines the Ewl_Embed class to provide EWL with the ability to work with an evas. More...

Data Structures

struct  Ewl_Embed
 The class inheriting from Ewl_Container that acts as a top level widget for interacting with the evas. More...

struct  Ewl_Embed
 The class inheriting from Ewl_Container that acts as a top level widget for interacting with the evas. More...


Defines

#define EWL_EMBED(widget)   ((Ewl_Embed *) widget)
 Typecast a pointer to an Ewl_Embed pointer.

#define EWL_EMBED_EVAS_WINDOW(window)   ((Ewl_Embed_Evas_Window *)window)
 Typecast a pointer to an Evas_Window.


Typedefs

typedef Ewl_Embed Ewl_Embed
 The embed structure is mostly a container for holding widgets and a wrapper evas smart object.

typedef void * Ewl_Embed_Evas_Window
 Typedef and abstract out embedded evas windows.


Functions

Ewl_Widgetewl_embed_new (void)
 Allocate and initialize a new embed.

int ewl_embed_init (Ewl_Embed *win)
 initialize a embed to default values and callbacks

Evas_Object * ewl_embed_evas_set (Ewl_Embed *emb, Evas *evas, Ewl_Embed_Evas_Window *evas_window)
 Change the evas used by the embedded container.

void ewl_embed_focus_set (Ewl_Embed *embed, int f)
 Sets the boolean flag in the embed to determine if it takes focus.

int ewl_embed_focus_get (Ewl_Embed *embed)
 Retrieve the boolean value that indicates if the emebd takes focus.

int ewl_embed_max_layer_get (Ewl_Embed *embed)
 Retrieve the layer being used for receiving evas events.

void ewl_embed_max_layer_set (Ewl_Embed *embed, int layer)
 Sets the layer for the embed to receive events.

void ewl_embed_key_down_feed (Ewl_Embed *embed, char *keyname, unsigned int modifiers)
 Sends the event for a key press into an embed.

void ewl_embed_key_up_feed (Ewl_Embed *embed, char *keyname, unsigned int modifiers)
 Sends the event for a key release into an embed.

void ewl_embed_mouse_down_feed (Ewl_Embed *embed, int b, int clicks, int x, int y, unsigned int modifiers)
 Sends the event for a mouse button press into an embed.

void ewl_embed_mouse_up_feed (Ewl_Embed *embed, int b, int x, int y, unsigned int modifiers)
 Sends the event for a mouse button release into an embed.

void ewl_embed_mouse_move_feed (Ewl_Embed *embed, int x, int y, unsigned int modifiers)
 Sends the event for a mouse button release into an embed.

void ewl_embed_mouse_out_feed (Ewl_Embed *embed, int x, int y, unsigned int modifiers)
 Sends a mouse out event to the last focused widget.

void ewl_embed_mouse_wheel_feed (Ewl_Embed *embed, int x, int y, int z, int dir, unsigned int mods)
 Sends a mouse out event to the last focused widget.

void ewl_embed_font_path_add (char *path)
 Add a font path to all embeds after realized.

Ewl_Embedewl_embed_evas_window_find (Ewl_Embed_Evas_Window *win)
 Find an ewl embed by its evas window.

Ewl_Embedewl_embed_widget_find (Ewl_Widget *w)
 Find an ewl embed by a widget inside.

void ewl_embed_tab_order_next (Ewl_Embed *e)
 Changes focus to the next widget in the circular tab order list.

void ewl_embed_tab_order_remove (Ewl_Embed *e, Ewl_Widget *w)
 Removes the widget w from the tab order list for e.

void ewl_embed_tab_order_push (Ewl_Embed *e, Ewl_Widget *w)
 Moves the widget w to the front of the tab order list.

void ewl_embed_coord_to_screen (Ewl_Embed *e, int xx, int yy, int *x, int *y)
 Maps coordinates from the Evas to screen coordinates.


Detailed Description

Defines the Ewl_Embed class to provide EWL with the ability to work with an evas.


Function Documentation

void ewl_embed_coord_to_screen Ewl_Embed e,
int  xx,
int  yy,
int *  x,
int *  y
 

Maps coordinates from the Evas to screen coordinates.

Parameters:
e: the embed to retrieve coord screen position
xx: the x coord to map to a screen position
yy: the y coord to map to a screen position
x: storage for the mapped screen x position
y: storage for the mapped screen y position
Returns:
Returns no value.

Evas_Object* ewl_embed_evas_set Ewl_Embed emb,
Evas *  evas,
Ewl_Embed_Evas_Window evas_window
 

Change the evas used by the embedded container.

Parameters:
emb: the embedded container to change the target evas
evas: the new evas to draw the container and it's contents
evas_window: the window containing the evas, for event dispatching
Returns:
Returns an evas smart object on success, NULL on failure.
The returned smart object can be used to manipulate the area used by EWL through standard evas functions.

Ewl_Embed* ewl_embed_evas_window_find Ewl_Embed_Evas_Window window  ) 
 

Find an ewl embed by its evas window.

Parameters:
window: the evas window to search for on the list of embeds
Returns:
Returns the found embed on success, NULL on failure.

int ewl_embed_focus_get Ewl_Embed embed  ) 
 

Retrieve the boolean value that indicates if the emebd takes focus.

Parameters:
embed: the embed to indicate if it takes focus
Returns:
Returns a boolean indicating if the embed takes focus.

void ewl_embed_focus_set Ewl_Embed embed,
int  f
 

Sets the boolean flag in the embed to determine if it takes focus.

Parameters:
embed: the embed to inidicate if it takes focus
f: boolean to determine if the embed takes focus
Returns:
Returns no value.

void ewl_embed_font_path_add char *  path  ) 
 

Add a font path to all embeds after realized.

Parameters:
path: the font path to add to the embeds
Returns:
Returns no value.
Adds the search path to the evases created in the embeds. Using ewl_theme_font_path_add is preferred.

int ewl_embed_init Ewl_Embed w  ) 
 

initialize a embed to default values and callbacks

Parameters:
w: the embed to be initialized to default values and callbacks
Returns:
Returns TRUE or FALSE depending on if initialization succeeds.
Sets the values and callbacks of a embed w to their defaults.

void ewl_embed_key_down_feed Ewl_Embed embed,
char *  keyname,
unsigned int  mods
 

Sends the event for a key press into an embed.

Parameters:
embed: the embed where the key event is to occur
keyname: the key press to trigger
mods: the mask of key modifiers currently pressed
Returns:
Returns no value.

void ewl_embed_key_up_feed Ewl_Embed embed,
char *  keyname,
unsigned int  mods
 

Sends the event for a key release into an embed.

Parameters:
embed: the embed where the key event is to occur
keyname: the key release to trigger
mods: the mask of key modifiers currently pressed
Returns:
Returns no value.

int ewl_embed_max_layer_get Ewl_Embed embed  ) 
 

Retrieve the layer being used for receiving evas events.

Parameters:
embed: the embed to retrieve maximum layer
Returns:
Returns the layer used for obtaining evas events.

void ewl_embed_max_layer_set Ewl_Embed embed,
int  layer
 

Sets the layer for the embed to receive events.

Parameters:
embed: embed to set the maximum layer
layer: the maximum layer used for handling evas events
Returns:
Returns no value.

void ewl_embed_mouse_down_feed Ewl_Embed embed,
int  b,
int  clicks,
int  x,
int  y,
unsigned int  mods
 

Sends the event for a mouse button press into an embed.

Parameters:
embed: the embed where the mouse event is to occur
b: the number of the button pressed
clicks: the number of times the button was pressed
x: the x coordinate of the mouse press
y: the y coordinate of the mouse press
mods: the mask of key modifiers currently pressed
Returns:
Returns no value.

void ewl_embed_mouse_move_feed Ewl_Embed embed,
int  x,
int  y,
unsigned int  mods
 

Sends the event for a mouse button release into an embed.

Parameters:
embed: the embed where the mouse event is to occur
x: the x coordinate of the mouse move
y: the y coordinate of the mouse move
mods: the mask of key modifiers currently release
Returns:
Returns no value.

void ewl_embed_mouse_out_feed Ewl_Embed embed,
int  x,
int  y,
unsigned int  mods
 

Sends a mouse out event to the last focused widget.

Parameters:
embed: the embed where the mouse event is to occur
x: the x coordinate of the mouse out
y: the y coordinate of the mouse out
mods: the mask of key modifiers currently release
Returns:
Returns no value.

void ewl_embed_mouse_up_feed Ewl_Embed embed,
int  b,
int  x,
int  y,
unsigned int  mods
 

Sends the event for a mouse button release into an embed.

Parameters:
embed: the embed where the mouse event is to occur
b: the number of the button released
x: the x coordinate of the mouse release
y: the y coordinate of the mouse release
mods: the mask of key modifiers currently release
Returns:
Returns no value.

void ewl_embed_mouse_wheel_feed Ewl_Embed embed,
int  x,
int  y,
int  z,
int  dir,
unsigned int  mods
 

Sends a mouse out event to the last focused widget.

Parameters:
embed: the embed where the mouse event is to occur
x: the x coordinate of the mouse when the wheel event occurred
y: the y coordinate of the mouse when wheel event occurred
z: the direction the mouse wheel rotated
dir: FIXME, not sure what this does, it's always 0
mods: the mask of key modifiers currently release
Returns:
Returns no value.

Ewl_Widget* ewl_embed_new void   ) 
 

Allocate and initialize a new embed.

Returns:
Returns a new embed on success, or NULL on failure.

void ewl_embed_tab_order_next Ewl_Embed e  ) 
 

Changes focus to the next widget in the circular tab order list.

Parameters:
e: the embed to change focus of it's contained widgets
Returns:
Returns no value.

void ewl_embed_tab_order_push Ewl_Embed e,
Ewl_Widget w
 

Moves the widget w to the front of the tab order list.

Parameters:
e: the embed that holds widgets to change tab order
w: the widget that will be moved to the front of the tab order list
Returns:
Returns no value.

void ewl_embed_tab_order_remove Ewl_Embed e,
Ewl_Widget w
 

Removes the widget w from the tab order list for e.

Parameters:
e: the embed containing a widget to remove from the tab order
w: the widget to remove from the tab order list
Returns:
Returns no value.

Ewl_Embed* ewl_embed_widget_find Ewl_Widget w  ) 
 

Find an ewl embed by a widget inside.

Parameters:
w: the widget to search for its embed
Returns:
Returns the found embed on success, NULL on failure.