summaryrefslogtreecommitdiff
path: root/legacy/efreet/src/lib/Efreet_Mime.h
diff options
context:
space:
mode:
authorCarsten Haitzler <raster@rasterman.com>2011-04-08 11:01:08 +0000
committerCarsten Haitzler <raster@rasterman.com>2011-04-08 11:01:08 +0000
commit71b7acde90fc826669a6afa1bea7ea6af555ad3f (patch)
tree89f0ce84e7d7dd03cbaf7773af275d52aa41eb6f /legacy/efreet/src/lib/Efreet_Mime.h
parent3441c6f107924af1006acb5d2ac8173018327f6e (diff)
doxy -> h files.
SVN revision: 58487
Diffstat (limited to 'legacy/efreet/src/lib/Efreet_Mime.h')
-rw-r--r--legacy/efreet/src/lib/Efreet_Mime.h58
1 files changed, 57 insertions, 1 deletions
diff --git a/legacy/efreet/src/lib/Efreet_Mime.h b/legacy/efreet/src/lib/Efreet_Mime.h
index 9258f73..254c3e5 100644
--- a/legacy/efreet/src/lib/Efreet_Mime.h
+++ b/legacy/efreet/src/lib/Efreet_Mime.h
@@ -43,19 +43,75 @@ extern "C" {
43#endif 43#endif
44 44
45 45
46/**
47 * @return Returns 1 on success or 0 on failure
48 * @brief Initializes the efreet mime settings
49 */
46EAPI int efreet_mime_init(void); 50EAPI int efreet_mime_init(void);
51
52/**
53 * @return Returns no value
54 * @brief Cleans up the efreet mime settings system
55 */
47EAPI int efreet_mime_shutdown(void); 56EAPI int efreet_mime_shutdown(void);
48 57
58/**
59 * @param file The file to find the mime type
60 * @return Returns mime type as a string
61 * @brief Retreive the mime type of a file
62 */
49EAPI const char *efreet_mime_type_get(const char *file); 63EAPI const char *efreet_mime_type_get(const char *file);
64
65/**
66 * @param file The file to check the mime type
67 * @return Returns mime type as a string
68 * @brief Retreive the mime type of a file using magic
69 */
50EAPI const char *efreet_mime_magic_type_get(const char *file); 70EAPI const char *efreet_mime_magic_type_get(const char *file);
71
72/**
73 * @param file The file to check the mime type
74 * @return Returns mime type as a string
75 * @brief Retreive the mime type of a file using globs
76 */
51EAPI const char *efreet_mime_globs_type_get(const char *file); 77EAPI const char *efreet_mime_globs_type_get(const char *file);
78
79/**
80 * @param file The file to check the mime type
81 * @return Returns mime type as a string
82 * @brief Retreive the special mime type of a file
83 */
52EAPI const char *efreet_mime_special_type_get(const char *file); 84EAPI const char *efreet_mime_special_type_get(const char *file);
85
86/**
87 * @param file The file to check the mime type
88 * @return Returns mime type as a string
89 * @brief Retreive the fallback mime type of a file
90 */
53EAPI const char *efreet_mime_fallback_type_get(const char *file); 91EAPI const char *efreet_mime_fallback_type_get(const char *file);
54 92
93
94/**
95 * @param mime The name of the mime type
96 * @param theme The name of the theme to search icons in
97 * @param size The wanted size of the icon
98 * @return Returns mime type icon path as a string
99 * @brief Retreive the mime type icon for a file
100 */
55EAPI const char *efreet_mime_type_icon_get(const char *mime, const char *theme, 101EAPI const char *efreet_mime_type_icon_get(const char *mime, const char *theme,
56 unsigned int size); 102 unsigned int size);
57 103
104/**
105 * @brief Clear mime icons mapping cache
106 */
58EAPI void efreet_mime_type_cache_clear(void); 107EAPI void efreet_mime_type_cache_clear(void);
108
109/**
110 * @brief Flush mime icons mapping cache
111 *
112 * Flush timeout is defined at compile time by
113 * EFREET_MIME_ICONS_FLUSH_TIMEOUT
114 */
59EAPI void efreet_mime_type_cache_flush(void); 115EAPI void efreet_mime_type_cache_flush(void);
60 116
61/** 117/**