forked from enlightenment/efl
66 lines
1.8 KiB
C
66 lines
1.8 KiB
C
|
/**
|
||
|
* @defgroup Plug Plug
|
||
|
*
|
||
|
*
|
||
|
* 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 provides the limited functionality because this widget usually used to show socket's image.
|
||
|
*
|
||
|
* If more functionality is needed, it will be added.
|
||
|
*
|
||
|
*
|
||
|
*/
|
||
|
|
||
|
/**
|
||
|
* @addtogroup Plug
|
||
|
* @{
|
||
|
*/
|
||
|
|
||
|
/**
|
||
|
* Add a new plug image to the parent.
|
||
|
*
|
||
|
* @param parent The parent object
|
||
|
* @return The new plug image object or NULL if it cannot be created
|
||
|
*
|
||
|
*
|
||
|
* @ingroup Plug
|
||
|
*/
|
||
|
EAPI Evas_Object *elm_plug_add(Evas_Object *parent);
|
||
|
|
||
|
/**
|
||
|
* Connect a plug widget to service provided by socket image.
|
||
|
*
|
||
|
* @param ee_target The Ecore_Evas containing the canvas in which the new image object will live.
|
||
|
* @param svcname The service name to connect to set up by the socket.
|
||
|
* @param svcnum The service number to connect to (set up by socket).
|
||
|
* @param svcsys Booleain to set if the service is a system one or not (set up by socket).
|
||
|
* @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
|
||
|
*
|
||
|
*
|
||
|
* @ingroup Plug
|
||
|
*/
|
||
|
|
||
|
EAPI Eina_Bool elm_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
|
||
|
|
||
|
/**
|
||
|
* Get the basic Evas_Image object from this object (widget).
|
||
|
*
|
||
|
* @param obj The image object to get the inlined image from
|
||
|
* @return The inlined image object, or NULL if none exists
|
||
|
*
|
||
|
* This function allows one to get the underlying @c 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.
|
||
|
*
|
||
|
* @ingroup Plug
|
||
|
*/
|
||
|
EAPI Evas_Object *elm_plug_image_object_get(const Evas_Object *obj);
|
||
|
|
||
|
/**
|
||
|
* @}
|
||
|
*/
|