summaryrefslogtreecommitdiff
path: root/src/lib/ethumb
diff options
context:
space:
mode:
authorPhilippe Caseiro <pcaseiro@cadoles.com>2014-10-20 11:41:25 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:29:29 +0200
commit513d9efc78cb47f9fe564602c446c53787f95950 (patch)
tree8a0237103555819ac15b28db4897a5e54e6f2bbb /src/lib/ethumb
parent73d58b94465dab056ca727941ecb0eebd822d550 (diff)
ethumb: update API documentation.
- ethumb_frame_set - ethumb_frame_get - ethumb_thumb_dir_path_set - ethumb_thumb_dir_path_get - ethumb_thumb_category_set - ethumb_thumb_category_get
Diffstat (limited to 'src/lib/ethumb')
-rw-r--r--src/lib/ethumb/Ethumb.h51
1 files changed, 51 insertions, 0 deletions
diff --git a/src/lib/ethumb/Ethumb.h b/src/lib/ethumb/Ethumb.h
index 46ab759ad6..eaf1bc3dcd 100644
--- a/src/lib/ethumb/Ethumb.h
+++ b/src/lib/ethumb/Ethumb.h
@@ -179,13 +179,64 @@ EAPI void ethumb_free(Ethumb *e);
179 * @{ 179 * @{
180 */ 180 */
181 181
182/**
183 *
184 * @brief Set the Ethumb Frame
185 *
186 * This can be used to simulate wood frames in the Thumbnails
187 *
188 * @param e handle of the current thumbnailer.
189 * @param theme_file the edje theme file
190 * @param group the edje group in theme
191 * @param swallow the edje swallow in theme
192 *
193 * @return EINA_TRUE on success and EINA_FALSE on failure
194 */
182EAPI Eina_Bool ethumb_frame_set(Ethumb *e, const char *theme_file, const char *group, const char *swallow) EINA_ARG_NONNULL(1); 195EAPI Eina_Bool ethumb_frame_set(Ethumb *e, const char *theme_file, const char *group, const char *swallow) EINA_ARG_NONNULL(1);
196
197/**
198 * @brief Retreives the current ethumb frame of and Ethumb instance.
199 *
200 * @param e handle of the current thumbnailer.
201 * @param theme_file will be setted with the edje theme
202 * @param group will be setted with the edje group
203 * @param swallow will be setted with the edje swallow
204 */
183EAPI void ethumb_frame_get(const Ethumb *e, const char **theme_file, const char **group, const char **swallow) EINA_ARG_NONNULL(1); 205EAPI void ethumb_frame_get(const Ethumb *e, const char **theme_file, const char **group, const char **swallow) EINA_ARG_NONNULL(1);
184 206
207/**
208 * @brief Set the ethumb thumbnails path
209 *
210 * @param e handle of the current thumbnailer.
211 * @param path The thumbnails path
212 *
213 */
185EAPI void ethumb_thumb_dir_path_set(Ethumb *e, const char *path) EINA_ARG_NONNULL(1); 214EAPI void ethumb_thumb_dir_path_set(Ethumb *e, const char *path) EINA_ARG_NONNULL(1);
215
216/**
217 * @brief Get the ethumb thumbnails path
218 *
219 * @param e handle of the current thumbnailer.
220 *
221 * @return The thumbnails path for the current thumbnailer
222 */
186EAPI const char *ethumb_thumb_dir_path_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; 223EAPI const char *ethumb_thumb_dir_path_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE;
187 224
225/**
226 * @brief Set the thumbnails category
227 *
228 * @param e handle of the current thumbnailer.
229 * @param category the category to set
230 */
188EAPI void ethumb_thumb_category_set(Ethumb *e, const char *category) EINA_ARG_NONNULL(1); 231EAPI void ethumb_thumb_category_set(Ethumb *e, const char *category) EINA_ARG_NONNULL(1);
232
233/**
234 * @brief Get the thumbnails category
235 *
236 * @param e handle of the current thumbnailer
237 *
238 * @return the current thumbnailer thumbnails category
239 */
189EAPI const char *ethumb_thumb_category_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE; 240EAPI const char *ethumb_thumb_category_get(const Ethumb *e) EINA_WARN_UNUSED_RESULT EINA_ARG_NONNULL(1) EINA_PURE;
190 241
191EAPI void ethumb_thumb_path_set(Ethumb *e, const char *path, const char *key) EINA_ARG_NONNULL(1); 242EAPI void ethumb_thumb_path_set(Ethumb *e, const char *path, const char *key) EINA_ARG_NONNULL(1);