enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 1 Projects Releases Wiki Activity

elementary - updated doc. 

SVN revision: 66984
This commit is contained in:
ChunEon Park 2012-01-09 06:55:51 +00:00
parent 55f5848ade
commit 5661f3830a
20 changed files with 157 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
legacy/elementary/src/lib/elc_naviframe.h
View File

@ -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
*/

8
legacy/elementary/src/lib/elm_diskselector.h
View File

@ -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

19
legacy/elementary/src/lib/elm_entry.h
View File

@ -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

10
legacy/elementary/src/lib/elm_flipselector.h
View File

@ -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

9
legacy/elementary/src/lib/elm_frame.h
View File

@ -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.
*

5
legacy/elementary/src/lib/elm_gesture_layer.h
View File

@ -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
*
*/
/**

5
legacy/elementary/src/lib/elm_hover.h
View File

@ -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.
*
* @{

5
legacy/elementary/src/lib/elm_icon.h
View File

@ -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
*/

10
legacy/elementary/src/lib/elm_layout.h
View File

@ -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:

5
legacy/elementary/src/lib/elm_mapbuf.h
View File

@ -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:

8
legacy/elementary/src/lib/elm_menu.h
View File

@ -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
* @{
*/

5
legacy/elementary/src/lib/elm_notify.h
View File

@ -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.
*
* @{

8
legacy/elementary/src/lib/elm_panel.h
View File

@ -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.
* @{
*/

10
legacy/elementary/src/lib/elm_progressbar.h
View File

@ -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
*/

12
legacy/elementary/src/lib/elm_radio.h
View File

@ -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.
* @{
*/

8
legacy/elementary/src/lib/elm_scroller.h
View File

@ -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.
* @{

17
legacy/elementary/src/lib/elm_segment_control.h
View File

@ -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
*
*/
/**

10
legacy/elementary/src/lib/elm_slider.h
View File

@ -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
*/

7
legacy/elementary/src/lib/elm_spinner.h
View File

@ -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
*/

3
legacy/elementary/src/lib/elm_toolbar.h
View File

@ -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: