summaryrefslogtreecommitdiff
path: root/src/lib/elementary/efl_ui_text_factory_images.eo
blob: d682e294a7235ced4be1b17101335e5279d801c9 (plain)
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
class Efl.Ui.Text.Factory.Images (Efl.Object, Efl.Canvas.Text.Factory)
{
   [[Factory that creates images given key string

     The key can be either a full image path, or associated with one. The
     factory will fallback if key was not matches with an image, and try
     to load it as a full path.

     @since 1.21
   ]]
   methods {
      matches_add {
         [[Associates given name with a path of an image or EET file.

          This can be used for quick retrieval (instead of
          providing actual filenames.

          This $file is associated with $name is considered a full file path.

          see @.matches_mmap_add for mmap version
          see @.matches_del
         ]]
         params {
            name: string; [[the name associated with filename]]
            path: string; [[the image or EET file path]]
            key: string; [[the key to use (in cases of loading an EET file]]
         }
         return: bool; [[$true if successful, $false otherwise]]
      }
      matches_del {
         [[Deletes an association of $key with its respective file path.

          see @.matches_add
         ]]
         params {
            key: string; [[the entry's key to delete]]
         }
         return: bool; [[$true if successful, $false otherwise]]
      }
      matches_mmap_add {
         [[Associates given name with a mmap'd image or EET file and key.

          see @.matches_add for string file path version
          see @.matches_mmap_del
         ]]
         params {
            name: string; [[the name associated with filename]]
            file: ptr(const(Eina.File)); [[the image or EET file]]
            key: string; [[the key to use (in cases of loading an EET file]]
         }
         return: bool; [[$true if successful, $false otherwise]]
      }
      matches_mmap_del {
         [[Deletes an association of $key with its respective file.

          see @.matches_mmap_add
         ]]
         params {
            key: string; [[the entry's key to delete]]
         }
         return: bool; [[$true if successful, $false otherwise]]
      }
   }
   implements {
      Efl.Object.constructor;
      Efl.Object.destructor;
      Efl.Canvas.Text.Factory.create;
   }
}