From: hermet Date: Mon, 9 Jan 2012 06:55:51 +0000 (+0000) Subject: elementary - updated doc. X-Git-Tag: REL_F_I9500_20120323_1~17^2~914 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=43e26d706ddcd893642021d6b6df4056581b56b1;p=framework%2Fuifw%2Felementary.git elementary - updated doc. git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/elementary@66984 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33 --- diff --git a/src/lib/elc_naviframe.h b/src/lib/elc_naviframe.h index dcc95dc..70a48d4 100644 --- a/src/lib/elc_naviframe.h +++ b/src/lib/elc_naviframe.h @@ -34,15 +34,10 @@ * @li elm_object_signal_emit * * Supported elm_object_item common APIs. - * @li elm_object_item_text_set * @li elm_object_item_part_text_set - * @li elm_object_item_text_get * @li elm_object_item_part_text_get - * @li elm_object_item_content_set * @li elm_object_item_part_content_set - * @li elm_object_item_content_get * @li elm_object_item_part_content_get - * @li elm_object_item_content_unset * @li elm_object_item_part_content_unset * @li elm_object_item_signal_emit */ diff --git a/src/lib/elm_diskselector.h b/src/lib/elm_diskselector.h index 47e8688..727192f 100644 --- a/src/lib/elm_diskselector.h +++ b/src/lib/elm_diskselector.h @@ -23,7 +23,13 @@ * * Default text parts of the diskselector items that you can use for are: * @li "default" - Label of the diskselector item - * + * + * Supported elm_object_item common APIs. + * @li elm_object_item_part_text_set + * @li elm_object_item_part_text_get + * @li elm_object_item_part_content_set + * @li elm_object_item_part_content_get + * * List of examples: * @li @ref diskselector_example_01 * @li @ref diskselector_example_02 diff --git a/src/lib/elm_entry.h b/src/lib/elm_entry.h index 5f306a2..7d90d0d 100644 --- a/src/lib/elm_entry.h +++ b/src/lib/elm_entry.h @@ -255,6 +255,25 @@ typedef enum * @li "preedit,changed": The preedit string has changed. * @li "language,changed": Program language changed. * + * Default contents parts of the entry items that you can use for are: + * @li "elm.swallow.icon" - An icon in the entry + * @li "elm.swallow.end" - A content in the end of the entry + * + * Default text parts of the entry that you can use for are: + * @li "default" - text of the entry + * + * Supported elm_object common APIs. + * @li elm_object_signal_emit + * @li elm_object_part_text_set + * @li elm_object_part_text_get + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset + * @li elm_object_signal_callback_add + * @li elm_object_signal_callback_del + * @li elm_object_disabled_set + * @li elm_object_disabled_get + * * @section entry-examples * * An overview of the Entry API can be seen in @ref entry_example_01 diff --git a/src/lib/elm_flipselector.h b/src/lib/elm_flipselector.h index 9148d31..9f40d81 100644 --- a/src/lib/elm_flipselector.h +++ b/src/lib/elm_flipselector.h @@ -25,9 +25,13 @@ * Available styles for it: * - @c "default" * - * To set/get the label of the flipselector item, you can use - * elm_object_item_text_set/get APIs. - * Once the text is set, a previously set one will be deleted. + * Default text parts of the flipselector items that you can use for are: + * @li "default" - label of the flipselector item + * + * Supported elm_object_item common APIs. + * @li elm_object_item_text_set + * @li elm_object_item_part_text_set + * @li elm_object_item_signal_emit * * Here is an example on its usage: * @li @ref flipselector_example diff --git a/src/lib/elm_frame.h b/src/lib/elm_frame.h index 452d2cf..67750a7 100644 --- a/src/lib/elm_frame.h +++ b/src/lib/elm_frame.h @@ -25,7 +25,14 @@ * @li "default" - A content of the frame * * Default text parts of the frame widget that you can use for are: - * @li "elm.text" - Label of the frame + * @li "default" - Label of the frame + * + * Supported elm_object common APIs. + * @li elm_object_part_text_set + * @li elm_object_part_text_get + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset * * For a detailed example see the @ref tutorial_frame. * diff --git a/src/lib/elm_gesture_layer.h b/src/lib/elm_gesture_layer.h index daeb93e..7f92b6f 100644 --- a/src/lib/elm_gesture_layer.h +++ b/src/lib/elm_gesture_layer.h @@ -53,6 +53,11 @@ * Setting glayer_continues_enable to false in @ref Config will change this behavior * so gesture starts when user touches (a *DOWN event) touch-surface * and ends when no fingers touches surface (a *UP event). + * + * Supported elm_object common APIs. + * @li elm_object_disabled_set + * @li elm_object_disabled_get + * */ /** diff --git a/src/lib/elm_hover.h b/src/lib/elm_hover.h index ff2f5b8..9f8f40a 100644 --- a/src/lib/elm_hover.h +++ b/src/lib/elm_hover.h @@ -40,6 +40,11 @@ * @li "smart,changed" - a content object placed under the "smart" * policy was replaced to a new slot direction. * + * Supported elm_object common APIs. + * @li elm_object_signal_emit + * @li elm_object_signal_callback_add + * @li elm_object_signal_callback_del + * * See @ref tutorial_hover for more information. * * @{ diff --git a/src/lib/elm_icon.h b/src/lib/elm_icon.h index b967679..7a4e4ab 100644 --- a/src/lib/elm_icon.h +++ b/src/lib/elm_icon.h @@ -63,6 +63,11 @@ * * "clicked" - This is called when a user has clicked the icon * + * Supported elm_object common APIs. + * @li elm_object_signal_emit + * @li elm_object_signal_callback_add + * @li elm_object_signal_callback_del + * * An example of usage for this API follows: * @li @ref tutorial_icon */ diff --git a/src/lib/elm_layout.h b/src/lib/elm_layout.h index 7a79729..8b7f8c1 100644 --- a/src/lib/elm_layout.h +++ b/src/lib/elm_layout.h @@ -131,6 +131,16 @@ * @li @c toolbar-table - application with toolbar and main content area as a * table * + * Supported elm_object common APIs. + * @li elm_object_signal_emit + * @li elm_object_signal_callback_add + * @li elm_object_signal_callback_del + * @li elm_object_part_text_set + * @li elm_object_part_text_get + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset + * * @section secExamples Examples * * Some examples of the Layout widget can be found here: diff --git a/src/lib/elm_mapbuf.h b/src/lib/elm_mapbuf.h index 6201c1d..fe9b977 100644 --- a/src/lib/elm_mapbuf.h +++ b/src/lib/elm_mapbuf.h @@ -15,6 +15,11 @@ * Default contents parts of the mapbuf widget that you can use for are: * @li "default" - A content of the mapbuf * + * Supported elm_object common APIs. + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset + * * To enable map, elm_mapbuf_enabled_set() should be used. * * See how to use this widget in this example: diff --git a/src/lib/elm_menu.h b/src/lib/elm_menu.h index 5f34bdc..2371928 100644 --- a/src/lib/elm_menu.h +++ b/src/lib/elm_menu.h @@ -18,6 +18,14 @@ * Default text parts of the menu items that you can use for are: * @li "default" - label in the menu item * + * Supported elm_object_item common APIs. + * @li elm_object_item_part_text_set + * @li elm_object_item_part_text_get + * @li elm_object_item_part_content_set + * @li elm_object_item_part_content_get + * @li elm_object_item_disabled_set + * @li elm_object_item_disabled_get + * * @see @ref tutorial_menu * @{ */ diff --git a/src/lib/elm_notify.h b/src/lib/elm_notify.h index d728f04..9ee270c 100644 --- a/src/lib/elm_notify.h +++ b/src/lib/elm_notify.h @@ -16,6 +16,11 @@ * Default contents parts of the notify widget that you can use for are: * @li "default" - A content of the notify * + * Supported elm_object common APIs. + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset + * * @ref tutorial_notify show usage of the API. * * @{ diff --git a/src/lib/elm_panel.h b/src/lib/elm_panel.h index 3a90dcd..0c27212 100644 --- a/src/lib/elm_panel.h +++ b/src/lib/elm_panel.h @@ -15,6 +15,14 @@ * Default contents parts of the panel widget that you can use for are: * @li "default" - A content of the panel * + * Supported elm_object common APIs. + * @li elm_object_signal_emit + * @li elm_object_signal_callback_add + * @li elm_object_signal_callback_del + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset + * * @ref tutorial_panel shows one way to use this widget. * @{ */ diff --git a/src/lib/elm_progressbar.h b/src/lib/elm_progressbar.h index f42053c..2104924 100644 --- a/src/lib/elm_progressbar.h +++ b/src/lib/elm_progressbar.h @@ -32,9 +32,19 @@ * - @c "wheel" (simple style, no text, no progression, only * "pulse" effect is available) * + * Default text parts of the progressbar widget that you can use for are: + * @li "default" - Label of the progressabar + * * Default contents parts of the progressbar widget that you can use for are: * @li "icon" - An icon of the progressbar * + * Supported elm_object common APIs. + * @li elm_object_part_text_set + * @li elm_object_part_text_get + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset + * * Here is an example on its usage: * @li @ref progressbar_example */ diff --git a/src/lib/elm_radio.h b/src/lib/elm_radio.h index d800b08..5623d8f 100644 --- a/src/lib/elm_radio.h +++ b/src/lib/elm_radio.h @@ -26,9 +26,21 @@ * @li changed - This is called whenever the user changes the state of one of * the radio objects within the group of radio objects that work together. * + * Default text parts of the radio widget that you can use for are: + * @li "default" - Label of the radio + * * Default contents parts of the radio widget that you can use for are: * @li "icon" - An icon of the radio * + * Supported elm_object common APIs. + * @li elm_object_part_text_set + * @li elm_object_part_text_get + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset + * @li elm_object_disabled_set + * @li elm_object_disabled_get + * * @ref tutorial_radio show most of this API in action. * @{ */ diff --git a/src/lib/elm_scroller.h b/src/lib/elm_scroller.h index 388825e..6356ff1 100644 --- a/src/lib/elm_scroller.h +++ b/src/lib/elm_scroller.h @@ -28,6 +28,14 @@ * Default contents parts of the scroller widget that you can use for are: * @li "default" - A content of the scroller * + * Supported elm_object common APIs. + * @li elm_object_signal_emit + * @li elm_object_signal_callback_add + * @li elm_object_signal_callback_del + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset + * * In @ref tutorial_scroller you'll find an example of how to use most of * this API. * @{ diff --git a/src/lib/elm_segment_control.h b/src/lib/elm_segment_control.h index a297e38..50f3e37 100644 --- a/src/lib/elm_segment_control.h +++ b/src/lib/elm_segment_control.h @@ -26,8 +26,25 @@ * Available styles for it: * - @c "default" * + * Default contents parts of the segment control items that you can use for are: + * @li "icon" - An icon in a segment control item + * + * Default text parts of the segment control items that you can use for are: + * @li "default" - Title label in a segment control item + * + * Supported elm_object common APIs. + * @li elm_object_disabled_set + * @li elm_object_disabled_get + * + * Supported elm_object_item common APIs. + * @li elm_object_item_part_text_set + * @li elm_object_item_part_text_get + * @li elm_object_item_part_content_set + * @li elm_object_item_part_content_get + * * Here is an example on its usage: * @li @ref segment_control_example + * */ /** diff --git a/src/lib/elm_slider.h b/src/lib/elm_slider.h index 1ced64e..e7a6bf6 100644 --- a/src/lib/elm_slider.h +++ b/src/lib/elm_slider.h @@ -45,6 +45,16 @@ * * Default text parts of the silder widget that you can use for are: * @li "default" - Label of the silder + * + * Supported elm_object common APIs. + * @li elm_object_disabled_set + * @li elm_object_disabled_get + * @li elm_object_part_text_set + * @li elm_object_part_text_get + * @li elm_object_part_content_set + * @li elm_object_part_content_get + * @li elm_object_part_content_unset + * * Here is an example on its usage: * @li @ref slider_example */ diff --git a/src/lib/elm_spinner.h b/src/lib/elm_spinner.h index 89dc4ab..8bbb8dc 100644 --- a/src/lib/elm_spinner.h +++ b/src/lib/elm_spinner.h @@ -30,6 +30,13 @@ * - @c "default"; * - @c "vertical": up/down buttons at the right side and text left aligned. * + * Supported elm_object common APIs. + * @li elm_object_signal_emit + * @li elm_object_signal_callback_add + * @li elm_object_signal_callback_del + * @li elm_object_disabled_set + * @li elm_object_disabled_get + * * Here is an example on its usage: * @ref spinner_example */ diff --git a/src/lib/elm_toolbar.h b/src/lib/elm_toolbar.h index c6eb488..e344c43 100644 --- a/src/lib/elm_toolbar.h +++ b/src/lib/elm_toolbar.h @@ -29,9 +29,8 @@ * * Supported elm_object_item common APIs. * @li elm_object_item_disabled_set - * @li elm_object_item_text_set + * @li elm_object_item_disabled_get * @li elm_object_item_part_text_set - * @li elm_object_item_text_get * @li elm_object_item_part_text_get * * List of examples: