Efreet_Utils(3)

NAME
Efreet_Utils - Efreet utilities for FDO

SYNOPSIS

  Functions
const char * efreet_util_path_to_file_id (const char *path)
Returns the fdo file id for a given path.
Eina_List * efreet_util_desktop_mime_list (const char *mime)
Find all desktops for a given mime type.
Efreet_Desktop * efreet_util_desktop_wm_class_find (const char *wmname, const char *wmclass)
Find all desktops for a given wm class.
Efreet_Desktop * efreet_util_desktop_file_id_find (const char *file_id)
Find a desktop by file id.
Efreet_Desktop * efreet_util_desktop_exec_find (const char *exec)
Find a desktop by exec.
Efreet_Desktop * efreet_util_desktop_name_find (const char *name)
Find a desktop by name.
Efreet_Desktop * efreet_util_desktop_generic_name_find (const char *generic_name)
Find a desktop by generic name.
Eina_List * efreet_util_desktop_name_glob_list (const char *glob)
Find all desktops where name matches a glob pattern.
Eina_List * efreet_util_desktop_exec_glob_list (const char *glob)
Find all desktops where exec matches a glob pattern.
Eina_List * efreet_util_desktop_generic_name_glob_list (const char *glob)
Find all desktops where generic name matches a glob pattern.
Eina_List * efreet_util_desktop_comment_glob_list (const char *glob)
Find all desktops where comment matches a glob pattern.
Eina_List * efreet_util_desktop_categories_list (void)
Find all desktop categories This list must be freed using EINA_LIST_FREE.
Eina_List * efreet_util_desktop_category_list (const char *category)
Find all desktops in a given category.
Eina_List * efreet_util_menus_find (void)
Returns a list of .menu files found in the various config dirs.
Eina_List * efreet_util_desktop_environments_list (void)
Find all known desktop environments This list must be freed using EINA_LIST_FREE.

Detailed Description

Function Documentation

  const char* efreet_util_path_to_file_id (const char * path)

Returns the fdo file id for a given path. If the file isn't inside a default fdo path it will return NULL.

Parameters
    path The path to find the file id for

Returns
    File id for path or NULL

References alloca(), eina_hash_find(), eina_hash_set(), eina_lock_release(), eina_lock_take(), EINA_SAFETY_ON_NULL_RETURN_VAL, eina_stringshare_add(), and eina_stringshare_del().

Referenced by efreet_menu_desktop_insert().

  Eina_List* efreet_util_desktop_mime_list (const char * mime)

Find all desktops for a given mime type. This list must be freed using EINA_LIST_FREE / efreet_desktop_free

Parameters
    mime the mime type

Returns
    a list of desktops

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  Efreet_Desktop* efreet_util_desktop_wm_class_find (const char * wmname, const char * wmclass)

Find all desktops for a given wm class. This list must be freed using EINA_LIST_FREE / efreet_desktop_free

Parameters
    wmname the wm name
    wmclass the wm class

Returns
    a list of desktops

References EINA_SAFETY_ON_TRUE_RETURN_VAL.

  Efreet_Desktop* efreet_util_desktop_file_id_find (const char * file_id)

Find a desktop by file id. return value must be freed by efreet_desktop_free

Parameters
    file_id the file id

Returns
    a desktop

References efreet_desktop_get(), eina_hash_find(), and EINA_SAFETY_ON_NULL_RETURN_VAL.

  Efreet_Desktop* efreet_util_desktop_exec_find (const char * exec)

Find a desktop by exec. return value must be freed by efreet_desktop_free

Parameters
    exec the exec name

Returns
    a desktop

References ecore_file_app_exe_get(), ecore_file_file_get(), efreet_desktop_get(), eina_hash_find(), EINA_SAFETY_ON_NULL_RETURN_VAL, and _Efreet_Desktop::exec.

  Efreet_Desktop* efreet_util_desktop_name_find (const char * name)

Find a desktop by name. return value must be freed by efreet_desktop_free

Parameters
    name the name

Returns
    a desktop

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  Efreet_Desktop* efreet_util_desktop_generic_name_find (const char * generic_name)

Find a desktop by generic name. return value must be freed by efreet_desktop_free

Parameters
    generic_name the generic name

Returns
    a desktop

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  Eina_List* efreet_util_desktop_name_glob_list (const char * glob)

Find all desktops where name matches a glob pattern. This list must be freed using EINA_LIST_FREE / efreet_desktop_free

Parameters
    glob the pattern to match

Returns
    a list of desktops

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  Eina_List* efreet_util_desktop_exec_glob_list (const char * glob)

Find all desktops where exec matches a glob pattern. This list must be freed using EINA_LIST_FREE / efreet_desktop_free

Parameters
    glob the pattern to match

Returns
    a list of desktops

References ecore_file_app_exe_get(), efreet_desktop_get(), eina_hash_find(), eina_list_append(), and EINA_SAFETY_ON_NULL_RETURN_VAL.

  Eina_List* efreet_util_desktop_generic_name_glob_list (const char * glob)

Find all desktops where generic name matches a glob pattern. This list must be freed using EINA_LIST_FREE / efreet_desktop_free

Parameters
    glob the pattern to match

Returns
    a list of desktops

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  Eina_List* efreet_util_desktop_comment_glob_list (const char * glob)

Find all desktops where comment matches a glob pattern. This list must be freed using EINA_LIST_FREE / efreet_desktop_free

Parameters
    glob the pattern to match

Returns
    a list of desktops

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  Eina_List* efreet_util_desktop_categories_list (void)

Find all desktop categories This list must be freed using EINA_LIST_FREE.

Returns
    an Eina_List of category names (const char *)

References eina_list_append().

  Eina_List* efreet_util_desktop_category_list (const char * category)

Find all desktops in a given category. This list must be freed using EINA_LIST_FREE / efreet_desktop_free

Parameters
    category the category name

Returns
    a list of desktops

References EINA_SAFETY_ON_NULL_RETURN_VAL.

  Eina_List* efreet_util_menus_find (void)

Returns a list of .menu files found in the various config dirs.

Returns
    An eina list of menu file paths (const char *). This must be freed with EINA_LIST_FREE.

References efreet_config_dirs_get(), efreet_config_home_get(), and EINA_LIST_FOREACH.

  Eina_List* efreet_util_desktop_environments_list (void)

Find all known desktop environments This list must be freed using EINA_LIST_FREE.

Since
    1.12

Returns
    an Eina_List of desktop environments names (const char *)

References eina_list_append().

Author

Generated automatically by Doxygen for EFL from the source code.