tizen 2.4 release
[framework/uifw/elementary.git] / src / lib / elm_plug.eo
1 class Elm_Plug (Elm_Widget)
2 {
3    eo_prefix: elm_obj_plug;
4    data: null;
5    properties {
6       image_object {
7          get {
8             /*@
9             @brief Get the basic Evas_Image object from this object (widget).
10
11             @if MOBILE @since_tizen 2.3
12             @elseif WEARABLE @since_tizen 2.3.1
13             @endif
14
15             @return The inlined image object, or NULL if none exists
16
17             @remark This function allows one to get the underlying @c Evas_Object of type
18             Image from this elementary widget. It can be useful to do things like get
19             the pixel data, save the image to a file, etc.
20
21             @remark Be careful to not manipulate it, as it is under control of
22             elementary.
23
24             @ingroup Plug */
25             return: Evas_Object *;
26          }
27       }
28    }
29    methods {
30       connect {
31          /*@
32          @brief Connect a plug widget to service provided by socket image.
33
34          @if MOBILE @since_tizen 2.3
35          @elseif WEARABLE @since_tizen 2.3.1
36          @endif
37
38          @return (@c EINA_TRUE = success, @c EINA_FALSE = error)
39
40          @ingroup Plug */
41
42          return: bool;
43          params {
44             @in const(char)* svcname; /*@ The service name to connect to set up by the socket. */
45             @in int svcnum; /*@ The service number to connect to (set up by socket). */
46             @in bool svcsys; /*@ Boolean to set if the service is a system one or not (set up by socket). */
47          }
48       }
49    }
50    implements {
51       class.constructor;
52       Eo.Base.constructor;
53       Evas.Object_Smart.add;
54       Elm_Widget.theme_apply;
55       Elm_Widget.on_focus;
56    }
57    events {
58       clicked;
59       image,deleted;
60       image,resized; /*@ ii */
61    }
62
63 }