src/lib/efreet_base.h

   1 #ifndef EFREET_BASE_H
   2 #define EFREET_BASE_H
   3 /**
   4  * @file efreet_base.h
   5  * @brief Contains the methods used to support the FDO base directory
   6  * specification.
   7  * @addtogroup Efreet_Base Efreet_Base: The XDG Base Directory Specification
   8  * functions
   9  *
  10  * @{
  11  */
  12
  13
  14 /**
  15  * @return Returns the XDG Data Home directory
  16  * @brief Retrieves the XDG Data Home directory
  17  */
  18 EAPI const char *efreet_data_home_get(void);
  19
  20 /**
  21  * @return Returns the Eina_List of preference ordered extra data directories
  22  * @brief Returns the Eina_List of preference ordered extra data directories
  23  *
  24  * @note The returned list is static inside Efreet. If you add/remove from the
  25  * list then the next call to efreet_data_dirs_get() will return your
  26  * modified values. DO NOT free this list.
  27  */
  28 EAPI Eina_List *efreet_data_dirs_get(void);
  29
  30
  31 /**
  32  * @return Returns the XDG Config Home directory
  33  * @brief Retrieves the XDG Config Home directory
  34  */
  35 EAPI const char *efreet_config_home_get(void);
  36
  37 /**
  38  * @return Returns the XDG Desktop directory
  39  * @brief Retrieves the XDG Desktop directory
  40  * @since 1.3
  41  */
  42 EAPI const char *efreet_desktop_dir_get(void);
  43
  44 /**
  45  * @return Returns the Eina_List of preference ordered extra config directories
  46  * @brief Returns the Eina_List of preference ordered extra config
  47  * directories
  48  *
  49  * @note The returned list is static inside Efreet. If you add/remove from the
  50  * list then the next call to efreet_config_dirs_get() will return your
  51  * modified values. DO NOT free this list.
  52  */
  53 EAPI Eina_List *efreet_config_dirs_get(void);
  54
  55
  56 /**
  57  * @return Returns the XDG Cache Home directory
  58  * @brief Retrieves the XDG Cache Home directory
  59  */
  60 EAPI const char *efreet_cache_home_get(void);
  61
  62 /**
  63  * @return Returns the current hostname
  64  * @brief Returns the current hostname or empty string if not found
  65  */
  66 EAPI const char *efreet_hostname_get(void);
  67
  68 /**
  69  * Efreet_Event_Cache_Update
  70  */
  71 typedef struct _Efreet_Event_Cache_Update Efreet_Event_Cache_Update;
  72
  73 /**
  74  * Efreet_Event_Cache_Update
  75  * @brief event struct sent with EFREET_EVENT_*_CACHE_UPDATE
  76  */
  77 struct _Efreet_Event_Cache_Update
  78 {
  79     int dummy;
  80 };
  81
  82 /**
  83  * @}
  84  */
  85
  86 #endif