summaryrefslogtreecommitdiff
path: root/src/lib/efl/interfaces/efl_vpath.eo
blob: 7447a2a2be4c6778aee3fb1b271c1e723aa7f15b (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
interface Efl.Vpath
{
   [[ VPath is the EFL "Virtual Path" system that maps paths and downloads

     You can provide virtual paths common in unix shells like:
       "~/file.jpg"
       "~username/file.png"
     And also other extended paths like:
       "(:cache:)/file.png"
       "(:videos:)/file.mp4"
       ...
     And in future:
       "file:///blah.jpg"
       "http://blah.com/file.jpg"
       "https://blahblah.com/file.jpg"
       "ssh://blahblah.com:~/file.jpg"
       ...

     @since 1.18
   ]]
   eo_prefix: efl_vpath;
   methods {
      fetch {
         [[ Fetch a new Vpath File object from the Vpath system ]]
         params {
            path: string; [[ The input virtual file path to fetch ]]
         }
         return: own(Efl.Vpath.File); [[ An object representing the file ]]
      }
   }
}