From 45782377bfdd49f3cf23b497670571b72b52ed07 Mon Sep 17 00:00:00 2001 From: Daniel Juyung Seo Date: Wed, 27 Mar 2013 02:41:34 +0900 Subject: [PATCH] gengrid/genlist/list.h: added more documentation for highlighted and unhighlighted smart callbacks. --- src/lib/elm_gengrid.h | 12 ++++++++---- src/lib/elm_genlist.h | 12 ++++++++---- src/lib/elm_list.h | 12 ++++++++---- 3 files changed, 24 insertions(+), 12 deletions(-) diff --git a/src/lib/elm_gengrid.h b/src/lib/elm_gengrid.h index 35b76d1..d4cd7cf 100644 --- a/src/lib/elm_gengrid.h +++ b/src/lib/elm_gengrid.h @@ -217,10 +217,14 @@ * until the left edge. * - @c "edge,right" - This is called when the gengrid is scrolled * until the right edge. - * - @c "highlighted" - an item in the list is pressed and highlighted. - * The %c event_info parameter is the item that was highlighted. - * - @c "unhighlighted" - an item in the list is unpressed and unhighlighted. - * The %c event_info parameter is the item that was unhighlighted. + * - @c "highlighted" - an item in the list is highlighted. This is called when + * the user presses an item or keyboard selection is done so the item is + * physically highlighted. The %c event_info parameter is the item that was + * highlighted. + * - @c "unhighlighted" - an item in the list is unhighlighted. This is called + * when the user releases an item or keyboard selection is moved so the item + * is physically unhighlighted. The %c event_info parameter is the item that + * was unhighlighted. * - @c "language,changed" - This is called when the program's language is * changed. Call the elm_gengrid_realized_items_update() if items text should * be translated. diff --git a/src/lib/elm_genlist.h b/src/lib/elm_genlist.h index efa8495..d9369f6 100644 --- a/src/lib/elm_genlist.h +++ b/src/lib/elm_genlist.h @@ -355,10 +355,14 @@ * changed. Call the elm_genlist_realized_items_update() if items text should * be translated. * - @c "tree,effect,finished" - This is called when a genlist tree effect is finished. - * - @c "highlighted" - an item in the list is pressed and highlighted. - * The %c event_info parameter is the item that was highlighted. - * - @c "unhighlighted" - an item in the list is unpressed and unhighlighted. - * The %c event_info parameter is the item that was unhighlighted. + * - @c "highlighted" - an item in the list is highlighted. This is called when + * the user presses an item or keyboard selection is done so the item is + * physically highlighted. The %c event_info parameter is the item that was + * highlighted. + * - @c "unhighlighted" - an item in the list is unhighlighted. This is called + * when the user releases an item or keyboard selection is moved so the item + * is physically unhighlighted. The %c event_info parameter is the item that + * was unhighlighted. * * * Supported elm_object_item common APIs diff --git a/src/lib/elm_list.h b/src/lib/elm_list.h index 9afcf50..5f28c8a 100644 --- a/src/lib/elm_list.h +++ b/src/lib/elm_list.h @@ -36,11 +36,15 @@ * - @c "edge,bottom" - the list is scrolled until the bottom edge * - @c "edge,left" - the list is scrolled until the left edge * - @c "edge,right" - the list is scrolled until the right edge + * - @c "highlighted" - an item in the list is highlighted. This is called when + * the user presses an item or keyboard selection is done so the item is + * physically highlighted. The %c event_info parameter is the item that was + * highlighted. + * - @c "unhighlighted" - an item in the list is unhighlighted. This is called + * when the user releases an item or keyboard selection is moved so the item + * is physically unhighlighted. The %c event_info parameter is the item that + * was unhighlighted. * - @c "language,changed" - the program's language changed - * - @c "highlighted" - an item in the list is pressed and highlighted. - * The %c event_info parameter is the item that was highlighted. - * - @c "unhighlighted" - an item in the list is unpressed and unhighlighted. - * The %c event_info parameter is the item that was unhighlighted. * * Available styles for it are: * - @c "default" -- 2.7.4