src/lib/elm_plug.h

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