2015-06-01 06:05:31 -07:00
|
|
|
import eina_types;
|
2017-10-04 20:58:06 -07:00
|
|
|
import efl_gfx_types;
|
2015-06-01 06:05:31 -07:00
|
|
|
|
efl: apply the stabilzed column of the efl api board
Summary:
The project https://phab.enlightenment.org/tag/efl_api/ has been used in
the last few weeks to figure out which classes can be stablized and
which cannot. This commit moves those dedicated classes outside beta.
And makes them stable.
ref T7601
ref T7600
ref T7599
ref T7598
ref T7597
ref T7596
ref T7594
ref T7593
ref T7591
ref T7590
ref T7589
ref T7588
ref T7583
ref T7582
ref T7581
ref T7576
ref T7570
ref T7567
ref T7564
ref T7563
ref T7560
ref T7559
ref T7672
ref T7584
ref T7577
ref T7571
ref T7558
ref T7555
ref T7554
ref T7553
ref T7512
ref T7511
Depends on D8272
Reviewers: cedric, stefan_schmidt, zmike, segfaultxavi
Reviewed By: segfaultxavi
Subscribers: #reviewers, #committers
Tags: #efl
Maniphest Tasks: T7672, T7601, T7600, T7599, T7598, T7597, T7596, T7594, T7593, T7591, T7590, T7589, T7588, T7584, T7583, T7582, T7581, T7577, T7576, T7571, T7570, T7567, T7564, T7563, T7560, T7559, T7558, T7555, T7554, T7553, T7512, T7511
Differential Revision: https://phab.enlightenment.org/D8273
2019-03-09 04:44:17 -08:00
|
|
|
mixin Efl.File requires Efl.Object {
|
2016-11-01 06:18:26 -07:00
|
|
|
[[Efl file interface]]
|
2015-05-07 08:36:45 -07:00
|
|
|
methods {
|
2019-02-27 10:17:09 -08:00
|
|
|
@property mmap {
|
|
|
|
set {
|
|
|
|
[[Set the mmaped file from where an object will fetch the real
|
|
|
|
data (it must be an Eina_File).
|
|
|
|
|
|
|
|
If mmap is set during object construction, the object will automatically
|
|
|
|
call @.load during the finalize phase of construction.
|
|
|
|
|
|
|
|
]]
|
|
|
|
|
|
|
|
return: Eina.Error; [[0 on success, error code otherwise]]
|
|
|
|
}
|
2017-10-04 20:58:06 -07:00
|
|
|
get {
|
2019-02-27 10:17:09 -08:00
|
|
|
[[Get the mmaped file from where an object will fetch the real
|
|
|
|
data (it must be an Eina_File).
|
|
|
|
|
|
|
|
]]
|
2017-10-04 20:58:06 -07:00
|
|
|
}
|
|
|
|
values {
|
2019-02-27 10:17:09 -08:00
|
|
|
f: ptr(const(Eina.File)); [[The handle to an Eina_File that will be used]]
|
2017-10-04 20:58:06 -07:00
|
|
|
}
|
|
|
|
}
|
2019-02-27 10:17:09 -08:00
|
|
|
@property file {
|
|
|
|
set {
|
|
|
|
[[Set the file path from where an object will fetch the data.
|
2015-04-03 07:23:13 -07:00
|
|
|
|
2019-02-27 10:17:09 -08:00
|
|
|
If file is set during object construction, the object will automatically
|
|
|
|
call @.load during the finalize phase of construction.
|
|
|
|
]]
|
2015-04-03 07:23:13 -07:00
|
|
|
|
2019-02-27 10:17:09 -08:00
|
|
|
return: Eina.Error; [[0 on success, error code otherwise]]
|
2015-04-03 07:23:13 -07:00
|
|
|
}
|
2019-02-27 10:17:09 -08:00
|
|
|
get {
|
|
|
|
[[Retrieve the file path from where an object is to fetch the data.
|
2015-04-03 07:23:13 -07:00
|
|
|
|
2019-02-27 10:17:09 -08:00
|
|
|
You must not modify the strings on the returned pointers.]]
|
2015-04-03 07:23:13 -07:00
|
|
|
}
|
|
|
|
values {
|
2019-02-27 10:17:09 -08:00
|
|
|
file: string; [[The file path.]]
|
2015-04-03 07:23:13 -07:00
|
|
|
}
|
|
|
|
}
|
2019-02-27 10:17:09 -08:00
|
|
|
@property key {
|
2014-05-21 04:49:47 -07:00
|
|
|
set {
|
2019-02-27 10:17:09 -08:00
|
|
|
[[Set the key which corresponds to the target data within a file.
|
|
|
|
|
|
|
|
Some filetypes can contain multiple data streams which are indexed by
|
|
|
|
a key. Use this property for such cases.
|
|
|
|
]]
|
2014-05-21 04:49:47 -07:00
|
|
|
}
|
|
|
|
get {
|
2019-02-27 10:17:09 -08:00
|
|
|
[[Get the previously-set key which corresponds to the target data within a file.
|
2014-07-22 06:55:51 -07:00
|
|
|
|
2019-02-27 10:17:09 -08:00
|
|
|
Some filetypes can contain multiple data streams which are indexed by
|
|
|
|
a key. Use this property for such cases.
|
2014-07-22 06:55:51 -07:00
|
|
|
|
2019-02-27 10:17:09 -08:00
|
|
|
You must not modify the strings on the returned pointers.]]
|
2014-05-21 04:49:47 -07:00
|
|
|
}
|
|
|
|
values {
|
efl: apply the stabilzed column of the efl api board
Summary:
The project https://phab.enlightenment.org/tag/efl_api/ has been used in
the last few weeks to figure out which classes can be stablized and
which cannot. This commit moves those dedicated classes outside beta.
And makes them stable.
ref T7601
ref T7600
ref T7599
ref T7598
ref T7597
ref T7596
ref T7594
ref T7593
ref T7591
ref T7590
ref T7589
ref T7588
ref T7583
ref T7582
ref T7581
ref T7576
ref T7570
ref T7567
ref T7564
ref T7563
ref T7560
ref T7559
ref T7672
ref T7584
ref T7577
ref T7571
ref T7558
ref T7555
ref T7554
ref T7553
ref T7512
ref T7511
Depends on D8272
Reviewers: cedric, stefan_schmidt, zmike, segfaultxavi
Reviewed By: segfaultxavi
Subscribers: #reviewers, #committers
Tags: #efl
Maniphest Tasks: T7672, T7601, T7600, T7599, T7598, T7597, T7596, T7594, T7593, T7591, T7590, T7589, T7588, T7584, T7583, T7582, T7581, T7577, T7576, T7571, T7570, T7567, T7564, T7563, T7560, T7559, T7558, T7555, T7554, T7553, T7512, T7511
Differential Revision: https://phab.enlightenment.org/D8273
2019-03-09 04:44:17 -08:00
|
|
|
key: string; [[The group that the image belongs to, in case
|
2019-02-27 10:17:09 -08:00
|
|
|
it's an EET(including Edje case) file. This can be used
|
|
|
|
as a key inside evas image cache if this is a normal image
|
|
|
|
file not eet file.]]
|
2014-07-22 06:55:51 -07:00
|
|
|
}
|
|
|
|
}
|
2019-02-27 10:17:09 -08:00
|
|
|
@property loaded {
|
|
|
|
get {
|
|
|
|
[[Get the load state of the object.
|
|
|
|
]]
|
|
|
|
}
|
|
|
|
values {
|
|
|
|
loaded: bool; [[True if the object is loaded, otherwise false.]]
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
load {
|
|
|
|
[[Perform all necessary operations to open and load file data into the object
|
|
|
|
using the @.file (or @.mmap) and @.key properties.
|
|
|
|
|
|
|
|
In the case where @.file.set has been called on an object, this will internally
|
|
|
|
open the file and call @.mmap.set on the object using the opened file handle.
|
|
|
|
|
|
|
|
Calling @.load on an object which has already performed file operations based on
|
|
|
|
the currently set properties will have no effect.]]
|
|
|
|
|
|
|
|
return: Eina.Error; [[0 on success, error code otherwise]]
|
|
|
|
}
|
|
|
|
|
|
|
|
unload {
|
|
|
|
[[Perform all necessary operations to unload file data from the object.
|
|
|
|
|
|
|
|
In the case where @.mmap.set has been externally called on an object, the file handle
|
|
|
|
stored in the object will be preserved.
|
|
|
|
|
|
|
|
Calling @.unload on an object which is not currently loaded will have no effect.
|
|
|
|
]]
|
|
|
|
}
|
|
|
|
}
|
|
|
|
implements {
|
|
|
|
Efl.Object.destructor;
|
|
|
|
Efl.Object.finalize;
|
2014-05-21 04:49:47 -07:00
|
|
|
}
|
|
|
|
}
|