This group provides functions to get the application information.

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.

Function Documentation

double elm_app_base_scale_get ( void )

Get the base scale of the application.

Returns:: The base scale which the application sets.

Since :: 2.3.1

void elm_app_base_scale_set ( double base_scale )

Set the base scale of the application.

Parameters:

base_scale The scale that the application is made on the basis of.

Remarks:: The scale is used for the application to be scaled. if the application isn't made on the basis of scale 1.0, the application layout will be break. So if the application set the base scale, it is applied when the application is scaled.; You should call this function before using ELM_SCALE_SIZE macro.

Since :: 2.3.1

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.

Since :: 2.3.1

Returns:: The binaries directory prefix that the application is actually using

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().

Since :: 2.3.1

Remarks:: Elementary also uses this path to determine the actual names of binaries' directory paths, maybe changing it to be something/local/bin instead of something/bin, only, for example.; You should call this function before elm_app_info_set().

Parameters:

[in] dir The path to the default binaries directory (compile time one)

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().

Since :: 2.3.1

Remarks:: Elementary also uses this path to determine the actual names of data directory paths, maybe changing it to be something/local/share instead of something/share only, for example.; You should call this function before elm_app_info_set().

Parameters:

[in] dir The path to the default data directory (compile time one)

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().

Since :: 2.3.1

Remarks:: Elementary also uses this path to determine the actual names of libraries' directory paths, maybe changing it to be something/lib32 or something/lib64 instead of something/lib only, for example.; You should call this function before elm_app_info_set().

Parameters:

[in] dir The path to the default libraries directory (compile time one)

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().

Since :: 2.3.1

Remarks:: You should call this function before elm_app_info_set().

Parameters:

[in] dir The path to the default locale directory (compile time one)

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.

Since :: 2.3.1

Returns:: The data directory prefix that the application is actually using

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

Remarks:: This function allows one to re-locate the application somewhere else after compilation, if the developer wishes for easier distribution of pre-compiled binaries.; The prefix system is designed to locate where the given software is installed (under a common path prefix) at run time and then report specific locations of this prefix and common directories inside this prefix like the binary, library, data, and locale directories, through the elm_app_*_get() family of functions.; Call elm_app_info_set() early, before you change the working directory or anything about argv[0], so it gets accurate information.

It then tries to trace back which file mainfunc comes from, if provided, to determine the application's prefix directory.

Remarks:: The dom parameter provides a string prefix to prepend before environment variables, allowing a fallback to specific environment variables to locate the software. You would most probably provide a lowercase string there, because it also serves as the directory domain, explained next. For environment variables purposes, this string is made uppercase. For example if "myapp" is provided as the prefix, then the program would expect "MYAPP_PREFIX" as a master environment variable to specify the exact install prefix for the software, or more specific environment variables like "MYAPP_BIN_DIR", "MYAPP_LIB_DIR", "MYAPP_DATA_DIR", and "MYAPP_LOCALE_DIR", which could be set by the user or scripts before launching. If not provided (NULL), environment variables are not used to override compiled-in defaults or auto detections.

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.

Remarks:: The checkfile is a file name or path of something inside the share or data directory to be used to test if the prefix detection worked. For example, your app installs a wallpaper image as /usr/local/share/myapp/images/wallpaper.jpg and so to check that this worked, provide "images/wallpaper.jpg" as the checkfile string.

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()

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.

Since :: 2.3.1

Returns:: The libraries directory prefix that the application is actually using

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.

Since :: 2.3.1

Returns:: The locale directory prefix the application is actually using

const char* elm_app_name_get ( void )

Retrieve the application formal name, as set by elm_app_name_set().

Since :: 2.3.1

Returns:: The application formal name.

void elm_app_name_set ( const char * name )

Set a formal name to be used with the elm application.

Since :: 2.3.1

Parameters:

[in] name Application name.

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.

Since :: 2.3.1

Returns:: The directory prefix that the application is actually using

Functions

Function Documentation