This group discusses functions to deal with EDJ files.
Typedef Documentation
Enumeration Type Documentation
Edje Load Error Type.
- Enumerator:
EDJE_LOAD_ERROR_NONE |
No error occurred, the loading is successful
|
EDJE_LOAD_ERROR_GENERIC |
A generic error occurred during loading
|
EDJE_LOAD_ERROR_DOES_NOT_EXIST |
The file being pointed to does not exist
|
EDJE_LOAD_ERROR_PERMISSION_DENIED |
Permission to read the given file has been denied
|
EDJE_LOAD_ERROR_RESOURCE_ALLOCATION_FAILED |
Resource allocation failed during loading
|
EDJE_LOAD_ERROR_CORRUPT_FILE |
The file being pointed to is corrupt
|
EDJE_LOAD_ERROR_UNKNOWN_FORMAT |
The file being pointed to has an unknown format
|
EDJE_LOAD_ERROR_INCOMPATIBLE_FILE |
The file being pointed to is incompatible, i.e., it doesn't match the library's current version format
|
EDJE_LOAD_ERROR_UNKNOWN_COLLECTION |
The group/collection set to load from is not found in the file
|
EDJE_LOAD_ERROR_RECURSIVE_REFERENCE |
The group/collection set to load from had recursive references on its components
|
Function Documentation
Gets the list of groups in an edje file.
- Since :
- 2.3.1
- Parameters:
-
[in] | file | The path to the edje file |
- Returns:
- An Eina_List of group names (char *)
Frees the file collection list.
This frees the list returned by edje_file_collection_list().
- Parameters:
-
[in] | lst | An Eina_List of groups |
- Since :
- 2.3.1
Gets data from the file level data block of an edje file.
- Since :
- 2.3.1
data { item: "key1" "value1"; item: "key2" "value2"; } collections { ... }
Then, edje_file_data_get("key1") returns "value1".
- Parameters:
-
[in] | file | The path to the .edj file |
[in] | key | The data key |
- Returns:
- The string value of the data, must be freed by the user when no longer needed
Checks whether a group matching glob exists in an edje file.
- Since :
- 2.3.1
- Parameters:
-
[in] | file | The file path |
[in] | glob | The glob to match with |
- Returns:
1
if a match is found, otherwise 0
Converts the given edje file load error code into a string describing it in English.
- Since :
- 2.3.1
- Parameters:
-
- Returns:
- A valid string
If the given error is not supported, "Unknown error"
is returned.
Gets an EDC data field value from a given Edje object group.
This function fetches an EDC data field value, which is declared on the object's building EDC file, under its group. EDC data blocks are most commonly used to pass arbitrary parameters from an application's theme to its code.
- Since :
- 2.3.1
They look like the following:
collections {
group {
name: "a_group";
data {
item: "key1" "value1";
item: "key2" "value2";
}
}
}
- Parameters:
-
[in] | obj | A handle to an edje object |
[in] | key | The data field key string |
- Returns:
- The data value string, must not be freed
- See also:
- edje_object_file_set()
Gets the file and group name that a given edje object is bound to.
- Since :
- 2.3.1
- Parameters:
-
[in] | obj | A handle to an edje object |
[out] | file | A pointer to a variable to store the file path |
[out] | group | A pointer to a variable to store the group name |
- See also:
- edje_object_file_set()
Sets the EDJ file (and group within it) from which to load an edje object's contents.
- Since :
- 2.3.1
- Parameters:
-
[in] | obj | A handle to an edje object |
[in] | file | The path to the EDJ file to load from |
[in] | group | The name of the group, in file, which implements an edje object |
- Returns:
- EINA_TRUE on success otherwise EINA_FALSE on errors (check edje_object_load_error_get() after this call to get errors causes)
- See also:
- edje_object_add()
-
edje_object_file_get()
Gets the (last) file loading error for a given edje object.
This function is meant to be used after an edje EDJ file load that takes place with the edje_object_file_set() function. If that function does not return EINA_TRUE, one should check for the reason of failure.
- Since :
- 2.3.1
- Parameters:
-
[in] | obj | A handle to an edje object |
- Returns:
- The Edje loading error, one from:
- See also:
- edje_load_error_str()