Functions |
void | elm_app_info_set (void *mainfunc, const char *dom, const char *checkfile) |
| Provides information in order to make Elementary determine the run time location of the software in question, so other data files such as images, sound files, executable utilities, libraries, modules and locale files can be found.
|
void | elm_app_name_set (const char *name) |
| Set a formal name to be used with the elm application.
|
void | elm_app_compile_bin_dir_set (const char *dir) |
| Provides information on the fallback application's binaries directory, in scenarios where they get overridden by elm_app_info_set().
|
void | elm_app_compile_lib_dir_set (const char *dir) |
| Provides information on the fallback application's libraries directory, on scenarios where they get overridden by elm_app_info_set().
|
void | elm_app_compile_data_dir_set (const char *dir) |
| Provides information on the fallback application's data directory, on scenarios where they get overridden by elm_app_info_set().
|
void | elm_app_compile_locale_set (const char *dir) |
| Provides information on the fallback application's locale directory, on scenarios where they get overridden by elm_app_info_set().
|
const char * | elm_app_name_get (void) |
| Retrieve the application formal name, as set by elm_app_name_set().
|
const char * | elm_app_prefix_dir_get (void) |
| Retrieves the application's run time prefix directory, as set by elm_app_info_set() and the way (environment) the application is run from it.
|
const char * | elm_app_bin_dir_get (void) |
| Retrieves the application's run time binaries prefix directory, as set by elm_app_info_set() and the way (environment) the application is run from it.
|
const char * | elm_app_lib_dir_get (void) |
| Retrieves the application's run time libraries prefix directory, as set by elm_app_info_set() and the way (environment) the application is run from it.
|
const char * | elm_app_data_dir_get (void) |
| Retrieves the application's run time data prefix directory, as set by elm_app_info_set() and the way (environment) the application is run from it.
|
const char * | elm_app_locale_dir_get (void) |
| Retrieves the application's run time locale prefix directory, as set by elm_app_info_set() and the way (environment) the application is run from it.
|
void | elm_app_base_scale_set (double base_scale) |
| Set the base scale of the application.
|
double | elm_app_base_scale_get (void) |
| Get the base scale of the application.
|
This group provides functions to get the application information.
void elm_app_info_set |
( |
void * |
mainfunc, |
|
|
const char * |
dom, |
|
|
const char * |
checkfile |
|
) |
| |
Provides information in order to make Elementary determine the run time location of the software in question, so other data files such as images, sound files, executable utilities, libraries, modules and locale files can be found.
- Since :
- 2.3.1
It then tries to trace back which file mainfunc comes from, if provided, to determine the application's prefix directory.
The dom string also provides a subdirectory inside the system shared data directory for data files. For example, if the system directory is /usr/local/share
, then this directory name is appended, creating /usr/local/share/myapp
, if it is "myapp"
. It is expected that the application installs data files in this directory.
- Parameters:
-
[in] | mainfunc | This is your application's main function name, whose binary's location is to be found
Providing NULL makes Elementary not use it |
[in] | dom | This is used as the application's "domain", in the form of a prefix to any environment variables that may override prefix detection and the directory name, inside the standard share or data directories, where the software's data files are looked for |
[in] | checkfile | This is an (optional) magic file's path to check for existence (and it must be located in the data directory, under the share directory provided above)
Its presence helps determine whther the prefix found is correct
Pass NULL if the check is not to be done. |
- See also:
- elm_app_compile_bin_dir_set()
-
elm_app_compile_lib_dir_set()
-
elm_app_compile_data_dir_set()
-
elm_app_compile_locale_set()
-
elm_app_prefix_dir_get()
-
elm_app_bin_dir_get()
-
elm_app_lib_dir_get()
-
elm_app_data_dir_get()
-
elm_app_locale_dir_get()