src/lib/elm_plug.h

   1 /**
   2  * @defgroup Plug Plug
   3  *
   4  *
   5  * An object that allows one to show an image which other process created.
   6  * It can be used anywhere like any other elementary widget.
   7  *
   8  * This widget provides the limited functionality because this widget usually used to show socket's image.
   9  *
  10  * If more functionality is needed, it will be added.
  11  *
  12  *
  13  */
  14
  15 /**
  16  * @addtogroup Plug
  17  * @{
  18  */
  19
  20 /**
  21  * Add a new plug image to the parent.
  22  *
  23  * @param parent The parent object
  24  * @return The new plug image object or NULL if it cannot be created
  25  *
  26  *
  27  * @ingroup Plug
  28  */
  29 EAPI Evas_Object    *elm_plug_add(Evas_Object *parent);
  30
  31 /**
  32  * Connect a plug widget to service provided by socket image.
  33  *
  34  * @param ee_target The Ecore_Evas containing the canvas in which the new image object will live.
  35  * @param svcname The service name to connect to set up by the socket.
  36  * @param svcnum The service number to connect to (set up by socket).
  37  * @param svcsys Boolean to set if the service is a system one or not (set up by socket).
  38  * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
  39  *
  40  *
  41  * @ingroup Plug
  42  */
  43
  44 EAPI Eina_Bool       elm_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
  45
  46 /**
  47  * Get the basic Evas_Image object from this object (widget).
  48  *
  49  * @param obj The image object to get the inlined image from
  50  * @return The inlined image object, or NULL if none exists
  51  *
  52  * This function allows one to get the underlying @c Evas_Object of type
  53  * Image from this elementary widget. It can be useful to do things like get
  54  * the pixel data, save the image to a file, etc.
  55  *
  56  * @note Be careful to not manipulate it, as it is under control of
  57  * elementary.
  58  *
  59  * @ingroup Plug
  60  */
  61 EAPI Evas_Object    *elm_plug_image_object_get(const Evas_Object *obj);
  62
  63 /**
  64  * @}
  65  */