src/lib/elm_plug.h

   1 /**
   2  * @defgroup Plug Plug
   3  * @ingroup Elementary
   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  */
   9
  10 /**
  11  * @addtogroup Plug
  12  * @{
  13  */
  14
  15 /**
  16  * Add a new plug image to the parent.
  17  *
  18  * @param parent The parent object
  19  * @return The new plug image object or NULL if it cannot be created
  20  *
  21  * @ingroup Plug
  22  */
  23 EAPI Evas_Object    *elm_plug_add(Evas_Object *parent);
  24
  25 /**
  26  * Connect a plug widget to service provided by socket image.
  27  *
  28  * @param obj The Evas_Object where the new image object will live.
  29  * @param svcname The service name to connect to set up by the socket.
  30  * @param svcnum The service number to connect to (set up by socket).
  31  * @param svcsys Boolean to set if the service is a system one or not (set up by socket).
  32  * @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
  33  *
  34  * @ingroup Plug
  35  */
  36 EAPI Eina_Bool       elm_plug_connect(Evas_Object *obj, const char *svcname, int svcnum, Eina_Bool svcsys);
  37
  38 /**
  39  * Get the basic Evas_Image object from this object (widget).
  40  *
  41  * @param obj The image object to get the inlined image from
  42  * @return The inlined image object, or NULL if none exists
  43  *
  44  * This function allows one to get the underlying @c Evas_Object of type
  45  * Image from this elementary widget. It can be useful to do things like get
  46  * the pixel data, save the image to a file, etc.
  47  *
  48  * @note Be careful to not manipulate it, as it is under control of
  49  * elementary.
  50  *
  51  * @ingroup Plug
  52  */
  53 EAPI Evas_Object    *elm_plug_image_object_get(const Evas_Object *obj);
  54
  55 /**
  56  * @}
  57  */