Functions
Plug

Functions

EOAPI Evas_Object * elm_obj_plug_image_object_get (void)
 Get the basic Evas_Image object from this object (widget). More...
 
EOAPI Eina_Bool elm_obj_plug_connect (const char *svcname, int svcnum, Eina_Bool svcsys)
 Connect a plug widget to service provided by socket image. More...
 
Evas_Object * elm_plug_image_object_get (const Elm_Plug *obj)
 Get the basic Evas_Image object from this object (widget). More...
 
Eina_Bool elm_plug_connect (Elm_Plug *obj, const char *svcname, int svcnum, Eina_Bool svcsys)
 Connect a plug widget to service provided by socket image. More...
 
Evas_Object * elm_plug_add (Evas_Object *parent)
 Add a new plug image to the parent. More...
 

Detailed Description

plug_inheritance_tree.png

An object that allows one to show an image which other process created. It can be used anywhere like any other elementary widget.

This widget emits the following signals:

Note
the event "image,resized" will be sent whenever the server resized its image and this always happen on the first time. Then it can be used to track when the server-side image is fully known (client connected to server, retrieved its image buffer through shared memory and resized the evas object).

Function Documentation

EOAPI Eina_Bool elm_obj_plug_connect ( const char *  svcname,
int  svcnum,
Eina_Bool  svcsys 
)

Connect a plug widget to service provided by socket image.

Returns
(EINA_TRUE = success, EINA_FALSE = error)
Parameters
[in]svcnameThe service name to connect to set up by the socket.
[in]svcnumThe service number to connect to (set up by socket).
[in]svcsysBoolean to set if the service is a system one or not (set up by socket).

Referenced by elm_plug_connect().

EOAPI Evas_Object* elm_obj_plug_image_object_get ( void  )

Get the basic Evas_Image object from this object (widget).

Returns
The inlined image object, or NULL if none exists

This function allows one to get the underlying Evas_Object of type Image from this elementary widget. It can be useful to do things like get the pixel data, save the image to a file, etc.

Note
Be careful to not manipulate it, as it is under control of elementary.

Referenced by elm_plug_image_object_get().

Evas_Object* elm_plug_add ( Evas_Object *  parent)

Add a new plug image to the parent.

Parameters
parentThe parent object
Returns
The new plug image object or NULL if it cannot be created
Eina_Bool elm_plug_connect ( Elm_Plug *  obj,
const char *  svcname,
int  svcnum,
Eina_Bool  svcsys 
)

Connect a plug widget to service provided by socket image.

Returns
(EINA_TRUE = success, EINA_FALSE = error)
Parameters
[in]svcnameThe service name to connect to set up by the socket.
[in]svcnumThe service number to connect to (set up by socket).
[in]svcsysBoolean to set if the service is a system one or not (set up by socket).

References elm_obj_plug_connect().

Evas_Object* elm_plug_image_object_get ( const Elm_Plug *  obj)

Get the basic Evas_Image object from this object (widget).

Returns
The inlined image object, or NULL if none exists

This function allows one to get the underlying Evas_Object of type Image from this elementary widget. It can be useful to do things like get the pixel data, save the image to a file, etc.

Note
Be careful to not manipulate it, as it is under control of elementary.

References elm_obj_plug_image_object_get().