forked from enlightenment/efl
148 lines
5.0 KiB
Plaintext
148 lines
5.0 KiB
Plaintext
interface Efl.File {
|
|
legacy_prefix: null;
|
|
properties {
|
|
mmap {
|
|
set {
|
|
/*@
|
|
Set the source mmaped file from where an image object must fetch the real
|
|
image data (it must be an Eina_File).
|
|
|
|
If the file supports multiple data stored in it (as Eet files do),
|
|
you can specify the key to be used as the index of the image in
|
|
this file.
|
|
|
|
@since 1.8 */
|
|
|
|
return: bool;
|
|
}
|
|
get {
|
|
/*@
|
|
Get the source mmaped file from where an image object must fetch the real
|
|
image data (it must be an Eina_File).
|
|
|
|
If the file supports multiple data stored in it (as Eet files do),
|
|
you can get the key to be used as the index of the image in
|
|
this file.
|
|
|
|
@since 1.10 */
|
|
}
|
|
values {
|
|
const(Eina.File)* f; /*@ The mmaped file */
|
|
const(char)* key; /*@ The image key in @p file (if its an Eet one), or @c
|
|
NULL, otherwise. */
|
|
}
|
|
}
|
|
file {
|
|
set {
|
|
/*@
|
|
Set the source file from where an image object must fetch the real
|
|
image data (it may be an Eet file, besides pure image ones).
|
|
|
|
If the file supports multiple data stored in it (as Eet files do),
|
|
you can specify the key to be used as the index of the image in
|
|
this file.
|
|
|
|
Example:
|
|
@code
|
|
img = evas_object_image_add(canvas);
|
|
evas_object_image_file_set(img, "/path/to/img", NULL);
|
|
err = evas_object_image_load_error_get(img);
|
|
if (err != EVAS_LOAD_ERROR_NONE)
|
|
{
|
|
fprintf(stderr, "could not load image '%s'. error string is \"%s\"\n",
|
|
valid_path, evas_load_error_str(err));
|
|
}
|
|
else
|
|
{
|
|
evas_object_image_fill_set(img, 0, 0, w, h);
|
|
evas_object_resize(img, w, h);
|
|
evas_object_show(img);
|
|
}
|
|
@endcode */
|
|
|
|
return: bool;
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieve the source file from where an image object is to fetch the
|
|
real image data (it may be an Eet file, besides pure image ones).
|
|
|
|
You must @b not modify the strings on the returned pointers.
|
|
|
|
@note Use @c NULL pointers on the file components you're not
|
|
interested in: they'll be ignored by the function. */
|
|
}
|
|
values {
|
|
const(char)* file; /*@ The image file path. */
|
|
const(char)* key; /*@ The image key in @p file (if its an Eet one), or @c
|
|
NULL, otherwise. */
|
|
}
|
|
}
|
|
async {
|
|
set {
|
|
/*@
|
|
If true, file open will happen asynchronously allowing for better
|
|
performance in some situations. The file will be opened from a
|
|
different thread. Classes implementing async open might then block
|
|
and wait when querying information from the file (eg. image size).
|
|
|
|
Only a few objects implement this feature, and this flag may
|
|
be ignored by EFL. In that case, get() will always return false. */
|
|
}
|
|
get {
|
|
/*@
|
|
Retrieves the asynchronous open flag, which will be true only if
|
|
enabled and supported by the object. */
|
|
}
|
|
values {
|
|
bool async; /*@ Flag for asynchronous open. */
|
|
}
|
|
}
|
|
}
|
|
methods {
|
|
save @const {
|
|
/*@
|
|
Save the given image object's contents to an (image) file.
|
|
|
|
The extension suffix on @p file will determine which <b>saver
|
|
module</b> Evas is to use when saving, thus the final file's
|
|
format. If the file supports multiple data stored in it (Eet ones),
|
|
you can specify the key to be used as the index of the image in it.
|
|
|
|
You can specify some flags when saving the image. Currently
|
|
acceptable flags are @c quality and @c compress. Eg.: @c
|
|
"quality=100 compress=9" */
|
|
|
|
return: bool;
|
|
params {
|
|
@in const(char)* file @nonull; /*@ The filename to be used to save the image (extension
|
|
obligatory). */
|
|
@in const(char)* key; /*@ The image key in the file (if an Eet one), or @c NULL,
|
|
otherwise. */
|
|
@in const(char)* flags; /*@ String containing the flags to be used (@c NULL for
|
|
none). */
|
|
}
|
|
}
|
|
eject @const {
|
|
/*@
|
|
Eject the represented object.
|
|
|
|
Get rid of and clean the pointed resource.
|
|
*/
|
|
}
|
|
async_wait @const {
|
|
/*@
|
|
Block and wait until all asynchronous operations are completed. Unless
|
|
the async flag was set on this object, this method has no effect.
|
|
|
|
Returns false if an error occured. */
|
|
|
|
return: bool;
|
|
}
|
|
}
|
|
events {
|
|
async,opened; /*@ The file was successfully opened asynchronously */
|
|
async,error; /*@ Error occured in asynchronous file operation */
|
|
}
|
|
}
|