src/lib/elm_plug.h

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