From 7753347d273b1e758475da98734fe690ac75da57 Mon Sep 17 00:00:00 2001 From: Gustavo Lima Chaves Date: Tue, 12 Jun 2012 16:40:57 +0000 Subject: [PATCH] [elm] Sexying up elm_win_icon_object_set()'s doc string. SVN revision: 72045 --- legacy/elementary/src/lib/elm_win.h | 27 ++++++++++++++++++--------- 1 file changed, 18 insertions(+), 9 deletions(-) diff --git a/legacy/elementary/src/lib/elm_win.h b/legacy/elementary/src/lib/elm_win.h index 166546b7f5..741e9ee02b 100644 --- a/legacy/elementary/src/lib/elm_win.h +++ b/legacy/elementary/src/lib/elm_win.h @@ -378,17 +378,26 @@ EAPI void elm_win_role_set(Evas_Object *obj, const char *role); EAPI const char *elm_win_role_get(const Evas_Object *obj); /** - * Set the object to represent the window icon + * Set a window object's icon * - * This sets an object that will be used as the icon for the window. The exact - * pixel dimensions of the object (not object size) will be used, and the - * image pixels will be used as-is when this function is called. If the - * image object has been updated, then call this function again to source - * the image pixels and put them on the window's icon. This has limitations - * as only image objects allowed at this stage. This may be lifted in future. + * This sets an image to be used as the icon for the given window, in + * the window manager decoration part. The exact pixel dimensions of + * the object (not object size) will be used, and the image pixels + * will be used as-is when this function is called. If the image + * object has been updated, then call this function again to source + * the image pixels and put them on the window's icon. Note that + * only Evas image objects are allowed, for * - * @param obj The window object - * @param icon The object to use for an icon + * @param obj The window object to get an icon + * @param icon The Evas image object to use for an icon + * + * Example of usage: + * @code + * icon = evas_object_image_add(evas_object_evas_get(elm_window)); + * evas_object_image_file_set(icon, "/path/to/the/icon", NULL); + * elm_win_icon_object_set(elm_window, icon); + * evas_object_show(icon); + * @endcode * * @ingroup Win */