summaryrefslogtreecommitdiff
path: root/legacy/elementary/src/lib/elm_icon.eo
blob: 016a4bbcbeff99c20ab8321e16ade65106893ae7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
enum Elm.Icon.Type
{
   legacy: elm_icon;
   none,
   file,
   standard
}

enum Elm.Icon.Lookup_Order
{
   [[Lookup order used by elm_icon_standard_set(). Should look for icons in
     the theme, FDO paths, or both?
   ]]
   legacy: elm_icon_lookup;
   fdo_theme, [[Icon look up order: freedesktop, theme.]]
   theme_fdo, [[Icon look up order: theme, freedesktop.]]
   fdo, [[Icon look up order: freedesktop.]]
   theme [[Icon look up order: theme.]]
}


class Elm.Icon (Elm.Image)
{
   eo_prefix: elm_obj_icon;
   methods {
      @property order_lookup {
         set {
            [[Sets the icon lookup order used by elm_icon_standard_set().

              See also @.order_lookup.get, @Elm.Icon.Lookup_Order.
            ]]
         }
         get {
            [[Get the icon lookup order.

              See also @.order_lookup.set, @Elm.Icon.Lookup_Order.
            ]]
         }
         values {
            order: Elm.Icon.Lookup_Order(Elm.Icon.Lookup_Order.theme_fdo); [[The icon lookup order (can be
                                               one of ELM_ICON_LOOKUP_FDO_THEME,
                                               ELM_ICON_LOOKUP_THEME_FDO,
                                               ELM_ICON_LOOKUP_FDO or
                                               ELM_ICON_LOOKUP_THEME)
                                             ]]
         }
      }
      @property standard {
         set {
            [[Set the icon by icon standards names.

              For example, freedesktop.org defines standard icon names such
              as "home", "network", etc. There can be different icon sets to
              match those icon keys. The "name" given as parameter is one of
              these "keys", and will be used to look in the freedesktop.org
              paths and elementary theme. One can change the lookup order
              with @.order_lookup.set.

              If name is not found in any of the expected locations and it is
              the absolute path of an image file, this image will be used.

              Note: The icon image set by this function can be changed by
              @Efl.File.file.set.

              Note: This function does not accept relative icon path.

              See also @.standard.get.
            ]]
            return: bool; [[true on success, false on error]]
         }
         get {
            [[Get the icon name set by icon standard names.

              If the icon image was set using elm_image_file_set() instead of
              @.standard.set, then this function will return null.
            ]]
         }
         values {
            name: const(char)*; [[The icon name]]
         }
      }
      @property thumb {
         set {
            [[Set the file that will be used, but use a generated thumbnail.

              This functions like elm_image_file_set() but requires the Ethumb
              library support to be enabled successfully with $elm_need_ethumb.
              When set the file indicated has a thumbnail generated and cached
              on disk for future use or will directly use an existing cached
              thumbnail if it is valid.
            ]]
         }
         values {
            file: const(char)* @nullable; [[The path to file that will be used
                                            as icon image]]
            group: const(char)* @optional; [[The group that the icon belongs
                                             to an edje file]]
         }
      }
   }
   implements {
      class.constructor;
      Eo.Base.constructor;
      Evas.Object_Smart.add;
      Evas.Object_Smart.del;
      Elm.Widget.theme_apply;
      Elm.Image.memfile.set;
      Efl.File.file.set;
   }
   events {
      thumb,done;
      thumb,error;
   }

}