*
* Here is a list of the widgets and some images to give you an idea of what
* they are:
- * @li @ref Elm_Actionslider
- *
- * @image html img/widget/actionslider/preview-00.png
- * @image latex img/widget/actionslider/preview-00.eps
* @li @ref Elm_Bg
*
- * @image html img/widget/bg/preview-00.png
- * @image latex img/widget/bg/preview-00.eps
- * @li @ref Elm_Bubble
- *
- * @image html img/widget/bubble/preview-00.png
- * @image latex img/widget/bubble/preview-00.eps
* @li @ref Elm_Button
*
- * @image html img/widget/button/preview-00.png
- * @image latex img/widget/button/preview-00.eps
* @li @ref Elm_Calendar
*
- * @image html img/widget/calendar/preview-00.png
- * @image latex img/widget/calendar/preview-00.eps
* @li @ref Elm_Check
*
- * @image html img/widget/check/preview-00.png
- * @image latex img/widget/check/preview-00.eps
- * @li @ref Elm_Clock
- *
- * @image html img/widget/clock/preview-00.png
- * @image latex img/widget/clock/preview-00.eps
- *
* @li @ref Elm_Colorselector
*
- * @image html img/widget/colorselector/preview-00.png
- * @image latex img/widget/colorselector/preview-00.eps
* @li @ref Elm_Ctxpopup
*
- * @image html img/widget/ctxpopup/preview-00.png
- * @image latex img/widget/ctxpopup/preview-00.eps
* @li @ref Elm_Datetime
*
- * @image html img/widget/datetime/preview-00.png
- * @image latex img/widget/datetime/preview-00.eps
- * @li @ref Elm_Dayselector
- *
- * @image html img/widget/dayselector/preview-00.png
- * @image latex img/widget/dayselector/preview-00.eps
- * @li @ref Elm_Diskselector
- *
- * @image html img/widget/diskselector/preview-00.png
- * @image latex img/widget/diskselector/preview-00.eps
* @li @ref Elm_Entry
*
- * @image html img/widget/entry/preview-02.png
- * @image latex img/widget/entry/preview-02.eps
- * @li @ref Elm_File_Selector_Button
- *
- * @image html img/widget/fileselector_button/preview-00.png
- * @image latex img/widget/fileselector_button/preview-00.eps
- * @li @ref Elm_File_Selector_Entry
- *
- * @image html img/widget/fileselector_entry/preview-00.png
- * @image latex img/widget/fileselector_entry/preview-00.eps
- * @li @ref Elm_Fileselector
- *
- * @image html img/widget/fileselector/preview-00.png
- * @image latex img/widget/fileselector/preview-00.eps
* @li @ref Elm_Flip
*
- * @image html img/widget/flip/preview-00.png
- * @image latex img/widget/flip/preview-00.eps
* @li @ref Elm_Flipselector
*
- * @image html img/widget/flipselector/preview-00.png
- * @image latex img/widget/flipselector/preview-00.eps
- * @li @ref Elm_Frame
- *
- * @image html img/widget/frame/preview-00.png
- * @image latex img/widget/frame/preview-00.eps
- *
* @li @ref Elm_GLView
- * @li @ref Elm_Hover
*
- * @image html img/widget/hover/preview-00.png
- * @image latex img/widget/hover/preview-00.eps
* @li @ref Elm_Hoversel
*
- * @image html img/widget/hoversel/preview-00.png
- * @image latex img/widget/hoversel/preview-00.eps
* @li @ref Elm_Icon
*
- * @image html img/widget/icon/preview-00.png
- * @image latex img/widget/icon/preview-00.eps
* @li @ref Elm_Image
*
- * @image html img/widget/image/preview-00.png
- * @image latex img/widget/image/preview-00.eps
* @li @ref Elm_Index
*
- * @image html img/widget/index/preview-00.png
- * @image latex img/widget/index/preview-00.eps
* @li @ref Elm_Inwin
*
- * @image html img/widget/inwin/preview-00.png
- * @image latex img/widget/inwin/preview-00.eps
* @li @ref Elm_List
*
- * @image html img/widget/list/preview-00.png
- * @image latex img/widget/list/preview-00.eps
- * @image html img/list.png
- * @image latex img/list.eps
* @li @ref Elm_Label
*
- * @image html img/widget/label/preview-00.png
- * @image latex img/widget/label/preview-00.eps
* @li @ref Elm_Map
*
- * @image html img/widget/map/preview-00.png
- * @image latex img/widget/map/preview-00.eps
* @li @ref Elm_Mapbuf
*
- * @image html img/widget/mapbuf/preview-00.png
- * @image latex img/widget/mapbuf/preview-00.eps
- * @li @ref Elm_Menu
- *
- * @image html img/widget/menu/preview-00.png
- * @image latex img/widget/menu/preview-00.eps
* @li @ref Elm_Notify
*
- * @image html img/widget/notify/preview-00.png
- * @image latex img/widget/notify/preview-00.eps
* @li @ref Elm_Panel
*
- * @image html img/widget/panel/preview-00.png
- * @image latex img/widget/panel/preview-00.eps
- * @li @ref Elm_Photo
* @li @ref Elm_Photocam
*
- * @image html img/widget/photocam/preview-00.png
- * @image latex img/widget/photocam/preview-00.eps
- * @li @ref Elm_Popup
+ * @li @ref Elm_Plug
*
- * @li @ref Elm_Prefs
- *
- * @image html img/widget/prefs/preview-00.png
- * @image latex img/widget/prefs/preview-00.eps
- * @image html img/prefs.png
- * @image latex img/prefs.eps
+ * @li @ref Elm_Popup
*
* @li @ref Elm_Progressbar
*
- * @image html img/widget/progressbar/preview-00.png
- * @image latex img/widget/progressbar/preview-00.eps
* @li @ref Elm_Radio
*
- * @image html img/widget/radio/preview-00.png
- * @image latex img/widget/radio/preview-00.eps
- * @li @ref Elm_Route
* @li @ref Elm_SegmentControl
*
- * @image html img/widget/segment_control/preview-00.png
- * @image latex img/widget/segment_control/preview-00.eps
- * @image html img/segment_control.png
- * @image latex img/segment_control.eps
- * @li @ref Elm_Separator
- *
- * @image html img/widget/separator/preview-00.png
- * @image latex img/widget/separator/preview-00.eps
* @li @ref Elm_Slider
*
- * @image html img/widget/slider/preview-00.png
- * @image latex img/widget/slider/preview-00.eps
- * @li @ref Elm_Slideshow
- *
- * @image html img/widget/slideshow/preview-00.png
- * @image latex img/widget/slideshow/preview-00.eps
* @li @ref Elm_Spinner
*
- * @image html img/widget/spinner/preview-00.png
- * @image latex img/widget/spinner/preview-00.eps
- * @li @ref Elm_Thumb
-
- * @image html img/widget/thumb/preview-00.png
- * @image latex img/widget/thumb/preview-00.eps
* @li @ref Elm_Toolbar
*
- * @image html img/widget/toolbar/preview-00.png
- * @image latex img/widget/toolbar/preview-00.eps
- * @image html img/toolbar.png
- * @image latex img/toolbar.eps
* @li @ref Elm_Tooltips
- * @li @ref Elm_Video
- * @li @ref Elm_Web
*
- * @image html img/widget/web/preview-00.png
- * @image latex img/widget/web/preview-00.eps
* @li @ref Elm_Win
*
- * @image html img/widget/win/preview-00.png
- * @image latex img/widget/win/preview-00.eps
*
* The other two main groups in Elementary are:
* @li @ref infralist - These are modules that deal with Elementary as a whole.
* them and a diagram showing their component parts:
* @li @ref Elm_Gengrid
*
- * @image html img/widget/gengrid/preview-00.png
- * @image latex img/widget/gengrid/preview-00.eps
* @li @ref Elm_Genlist
*
- * @image html img/widget/genlist/preview-00.png
- * @image latex img/widget/genlist/preview-00.eps
- * @image html img/genlist.png
- * @image latex img/genlist.eps
* @li @ref Elm_Box
*
- * @image html img/widget/box/preview-00.png
- * @image latex img/widget/box/preview-00.eps
- * @image html img/box.png
- * @image latex img/box.eps
* @li @ref Elm_Conformant
*
- * @image html img/widget/conformant/preview-00.png
- * @image latex img/widget/conformant/preview-00.eps
- * @image html img/conformant.png
- * @image latex img/conformant.eps
* @li @ref Elm_Grid
- * @li @ref Elm_Layout
*
- * @image html img/widget/layout/preview-00.png
- * @image latex img/widget/layout/preview-00.eps
- * @image html img/layout-predefined.png
- * @image latex img/layout-predefined.eps
+ * @li @ref Elm_Layout
*
* @li @ref Elm_Naviframe
*
* @li @ref Elm_Panes
*
- * @image html img/widget/panes/preview-00.png
- * @image latex img/widget/panes/preview-00.eps
- * @image html img/panes.png
- * @image latex img/panes.eps
* @li @ref Elm_Scroller
*
- * @image html img/widget/scroller/preview-00.png
- * @image latex img/widget/scroller/preview-00.eps
* @li @ref Elm_Table
*
- * @image html img/widget/table/preview-00.png
- * @image latex img/widget/table/preview-00.eps
*
* The other two main groups in Elementary are:
* @li @ref infralist - These are modules that deal with Elementary as a whole.
* @image html ctxpopup_inheritance_tree.png
* @image latex ctxpopup_inheritance_tree.eps
*
- * @image html img/widget/ctxpopup/preview-00.png
- * @image latex img/widget/ctxpopup/preview-00.eps
- *
* @brief Context popup widget.
*
* A ctxpopup is a widget that, when shown, pops up a list of items.
* @image html fileselector_inheritance_tree.png
* @image latex fileselector_inheritance_tree.eps
*
- * @image html img/widget/fileselector/preview-00.png
- * @image latex img/widget/fileselector/preview-00.eps
- *
* A file selector is a widget that allows a user to navigate
* through a file system, reporting file selections back via its
* API.
* @li @c "ok" - OK button label if the ok button is set. @since 1.8
* @li @c "cancel" - Cancel button label if the cancel button is set. @since 1.8
*
- * Here is an example on its usage:
- * @li @ref fileselector_example
*/
/**
* @image html fileselector_button_inheritance_tree.png
* @image latex fileselector_button_inheritance_tree.eps
*
- * @image html img/widget/fileselector_button/preview-00.png
- * @image latex img/widget/fileselector_button/preview-00.eps
- * @image html img/widget/fileselector_button/preview-01.png
- * @image latex img/widget/fileselector_button/preview-01.eps
- * @image html img/widget/fileselector_button/preview-02.png
- * @image latex img/widget/fileselector_button/preview-02.eps
- *
* This is a button that, when clicked, creates an Elementary
* window (or inner window) <b> with a @ref Fileselector "file
* selector widget" within</b>. When a file is chosen, the (inner)
* @li @ref elm_object_disabled_set
* @li @ref elm_object_disabled_get
*
- * Here is an example on its usage:
- * @li @ref fileselector_button_example
- *
* @see @ref File_Selector_Entry for a similar widget.
* @{
*/
* @image html fileselector_entry_inheritance_tree.png
* @image latex fileselector_entry_inheritance_tree.eps
*
- * @image html img/widget/fileselector_entry/preview-00.png
- * @image latex img/widget/fileselector_entry/preview-00.eps
- *
* This is an entry made to be filled with or display a <b>file
* system path string</b>. Besides the entry itself, the widget has
* a @ref File_Selector_Button "file selector button" on its side,
* @li @ref elm_object_disabled_set
* @li @ref elm_object_disabled_get
*
- * Here is an example on its usage:
- * @li @ref fileselector_entry_example
*
* @see @ref File_Selector_Button for a similar widget.
* @{
* @image html hoversel_inheritance_tree.png
* @image latex hoversel_inheritance_tree.eps
*
- * @image html img/widget/hoversel/preview-00.png
- * @image latex img/widget/hoversel/preview-00.eps
- *
* A hoversel is a button that pops up a list of items (automatically
* choosing the direction to display) that have a label and, optionally, an
* icon to select from. It is a convenience widget to avoid the need to do
* @li elm_object_item_focus_set - this works only when the item is created.
* @li elm_object_item_focus_get - this works only when the item is created.
*
- * See @ref tutorial_hoversel for an example.
* @{
*/
* widget's target layout, when accessed directly. Items lying below
* the top one can be interacted with this way.
*
- * Here is an example on its usage:
- * @li @ref naviframe_example
*/
/**
* @li @ref elm_object_part_content_unset
* @li @ref elm_object_signal_emit
*
- * Here are some sample code to illustrate Popup usage:
- * @li @ref popup_example_01_c
- * @li @ref popup_example_02_c
- * @li @ref popup_example_03_c
*/
#ifdef EFL_EO_API_SUPPORT
* @image html actionslider_inheritance_tree.png
* @image latex actionslider_inheritance_tree.eps
*
- * @image html img/widget/actionslider/preview-00.png
- * @image latex img/widget/actionslider/preview-00.eps
- *
* An actionslider is a switcher for 2 or 3 labels with customizable magnet
* properties. The user drags and releases the indicator, to choose a label.
*
* @li @ref elm_object_part_text_set
* @li @ref elm_object_part_text_get
*
- * See an example of actionslider usage @ref actionslider_example_page "here"
* @{
*/
* @image html bg_inheritance_tree.png
* @image latex bg_inheritance_tree.eps
*
- * @image html img/widget/bg/preview-00.png
- * @image latex img/widget/bg/preview-00.eps
- *
* @brief Background object, used for setting a solid color, image or
* Edje group as a background to a window or any container object.
*
* Default content parts of the bg widget that you can use for are:
* @li @c "overlay" - overlay of the bg
*
- * Here is some sample code using it:
- * @li @ref bg_01_example_page
- * @li @ref bg_02_example_page
- * @li @ref bg_03_example_page
*/
#ifdef EFL_EO_API_SUPPORT
* @image html box_inheritance_tree.png
* @image latex box_inheritance_tree.eps
*
- * @image html img/widget/box/preview-00.png
- * @image latex img/widget/box/preview-00.eps width=\textwidth
- *
* @image html img/box.png
* @image latex img/box.eps width=\textwidth
*
*
* @note Objects should not be added to box objects using _add() calls.
*
- * Some examples on how to use boxes follow:
- * @li @ref box_example_01
- * @li @ref box_example_02
- *
* @{
*/
* @image html bubble_inheritance_tree.png
* @image latex bubble_inheritance_tree.eps
*
- * @image html img/widget/bubble/preview-00.png
- * @image latex img/widget/bubble/preview-00.eps
- * @image html img/widget/bubble/preview-01.png
- * @image latex img/widget/bubble/preview-01.eps
- * @image html img/widget/bubble/preview-02.png
- * @image latex img/widget/bubble/preview-02.eps
- *
* @brief The Bubble is a widget to show text similar to how speech is
* represented in comics.
*
* @li @ref elm_object_part_content_get
* @li @ref elm_object_part_content_unset
*
- * For an example of using a bubble see @ref bubble_01_example_page "this".
- *
* @{
*/
* @image html button_inheritance_tree.png
* @image latex button_inheritance_tree.eps
*
- * @image html img/widget/button/preview-00.png
- * @image latex img/widget/button/preview-00.eps
- * @image html img/widget/button/preview-01.png
- * @image latex img/widget/button/preview-01.eps
- * @image html img/widget/button/preview-02.png
- * @image latex img/widget/button/preview-02.eps
- *
* This is a push-button. Press it and run some function. It can contain
* a simple label and icon object and it also has an autorepeat feature.
*
* @li @ref elm_object_signal_callback_add
* @li @ref elm_object_signal_callback_del
*
- * Here is some sample code using it:
- * @li @ref button_example_00
- * @li @ref button_example_01
*/
/**
See also @.weekdays_names.get.
- \@ref calendar_example_02.
-
\@if MOBILE \@since_tizen 2.4
\@endif
]]
See also @.weekdays_names.set.
- \@ref calendar_example_05.
-
\@if MOBILE \@since_tizen 2.4
\@endif
]]
that will be freed by the widget after usage.
A pointer to the string and a pointer to the time struct will be provided.
- \@ref calendar_example_02.
-
\@if MOBILE \@since_tizen 2.4
\@endif
]]
See also @.selected_time_get.
- \@ref calendar_example_04
-
\@if MOBILE \@since_tizen 2.4
\@endif
]]
See also @.selected_time_get.
- \@ref calendar_example_05.
-
\@if MOBILE \@since_tizen 2.4
\@endif
]]
See also @.marks_draw,
\@ref elm_calendar_mark_del().
- \@ref calendar_example_06
-
\@if MOBILE \@since_tizen 2.4
\@endif
]]
\@ref elm_calendar_mark_del(),
@.marks_clear.
- \@ref calendar_example_06
-
\@if MOBILE \@since_tizen 2.4
\@endif
]]
* @li @ref elm_object_signal_callback_add
* @li @ref elm_object_signal_callback_del
*
- * Here is some sample code using it:
- * @li @ref calendar_example_01
- * @li @ref calendar_example_02
- * @li @ref calendar_example_03
- * @li @ref calendar_example_04
- * @li @ref calendar_example_05
- * @li @ref calendar_example_06
*/
/**
*
* @see elm_calendar_mark_add()
*
- * @ref calendar_example_06
- *
* @if MOBILE @since_tizen 2.4
* @endif
*/
*
* This function inserts a new calendar widget on the canvas.
*
- * @ref calendar_example_01
- *
* @ingroup Elm_Calendar
*
* @if MOBILE @since_tizen 2.4
* @image html check_inheritance_tree.png
* @image latex check_inheritance_tree.eps
*
- * @image html img/widget/check/preview-00.png
- * @image latex img/widget/check/preview-00.eps
- * @image html img/widget/check/preview-01.png
- * @image latex img/widget/check/preview-01.eps
- * @image html img/widget/check/preview-02.png
- * @image latex img/widget/check/preview-02.eps
- *
* @brief The check widget allows for toggling a value between true
* and false.
*
* @image html clock_inheritance_tree.png
* @image latex clock_inheritance_tree.eps
*
- * @image html img/widget/clock/preview-00.png
- * @image latex img/widget/clock/preview-00.eps
- *
* This is a @b digital clock widget. In its default theme, it has a
* vintage "flipping numbers clock" appearance, which will animate
* sheets of individual algorisms individually as time goes by.
* @li @ref elm_object_signal_callback_add
* @li @ref elm_object_signal_callback_del
*
- * Here is an example on its usage:
- * @li @ref clock_example
*/
/**
* @image html colorselector_inheritance_tree.png
* @image latex colorselector_inheritance_tree.eps
*
- * @image html img/widget/colorselector/preview-00.png
- * @image latex img/widget/colorselector/preview-00.eps
- *
* A ColorSelector is a color selection widget. It allows application
* to set a series of colors.It also allows to load/save colors
* from/to config with a unique identifier, by default, the colors are
* @image html conformant_inheritance_tree.png
* @image latex conformant_inheritance_tree.eps
*
- * @image html img/widget/conformant/preview-00.png
- * @image latex img/widget/conformant/preview-00.eps width=\textwidth
- *
* @image html img/conformant.png
* @image latex img/conformant.eps width=\textwidth
*
* Default content parts of the conformant widget that you can use for are:
* @li "default" - A content of the conformant
*
- * See how to use this widget in this example:
- * @ref conformant_example
*/
/**
* @image html datetime_inheritance_tree.png
* @image latex datetime_inheritance_tree.eps
*
- * @image html img/widget/datetime/preview-00.png
- * @image latex img/widget/datetime/preview-00.eps
- *
- * @image html img/widget/datetime/preview-01.png
- * @image latex img/widget/datetime/preview-01.eps
- *
- * @image html img/widget/datetime/preview-02.png
- * @image latex img/widget/datetime/preview-02.eps
- *
* Datetime widget is used to display and input date & time values.
* This widget displays date and time as per the <b>system's locale</b> settings (Date
* includes Day, Month & Year along with the defined separators and
* @li @c "focused" - When the datetime has received focus. (since 1.8)
* @li @c "unfocused" - When the datetime has lost focus. (since 1.8)
*
- * Here is an example on its usage:
- * @li @ref datetime_example
- *
*/
/**
* @image html dayselector_inheritance_tree.png
* @image latex dayselector_inheritance_tree.eps
*
- * @image html img/widget/dayselector/preview-00.png
- * @image latex img/widget/dayselector/preview-00.eps
- *
* @brief <b>Dayselector widget:</b>
*
*"elm_dayselector" is a day selection widget. It displays all seven days of
* Available styles for dayselector are:
* @li default
*
- * This example shows the usage of the widget.
- * @li @ref dayselector_example
- *
*/
/**
* @image html diskselector_inheritance_tree.png
* @image latex diskselector_inheritance_tree.eps
*
- * @image html img/widget/diskselector/preview-00.png
- * @image latex img/widget/diskselector/preview-00.eps
- *
* A diskselector is a kind of list widget. It scrolls horizontally,
* and can contain label and icon objects. Three items are displayed
* with the selected one in the middle.
* @li @ref elm_object_item_part_content_set
* @li @ref elm_object_item_part_content_get
*
- * List of examples:
- * @li @ref diskselector_example_01
- * @li @ref diskselector_example_02
*/
/**
* @image html entry_inheritance_tree.png
* @image latex entry_inheritance_tree.eps
*
- * @image html img/widget/entry/preview-00.png
- * @image latex img/widget/entry/preview-00.eps width=\textwidth
- * @image html img/widget/entry/preview-01.png
- * @image latex img/widget/entry/preview-01.eps width=\textwidth
- * @image html img/widget/entry/preview-02.png
- * @image latex img/widget/entry/preview-02.eps width=\textwidth
- * @image html img/widget/entry/preview-03.png
- * @image latex img/widget/entry/preview-03.eps width=\textwidth
- *
* An entry is a convenience widget which shows a box that the user can
* enter text into. Entries by default don't scroll, so they grow to
* accommodate the entire text, resizing the parent window as needed. This
* @li full: Items will be placed between the descent and ascent, or the
* lowest point in the line and its highest.
*
- * The next image shows different configurations of items and how
- * the previously mentioned options affect their sizes. In all cases,
- * the green line indicates the ascent, blue for the baseline and red for
- * the descent.
- *
- * @image html entry_item.png
- * @image latex entry_item.eps width=\textwidth
- *
- * And another one to show how size differs from absize. In the first one,
- * the scale value is set to 1.0, while the second one is using one of 2.0.
- *
- * @image html entry_item_scale.png
- * @image latex entry_item_scale.eps width=\textwidth
- *
* After the size for an item is calculated, the entry will request an
* object to place in its space. For this, the functions set with
* elm_entry_item_provider_append() and related functions will be called
* @li @ref elm_object_disabled_set
* @li @ref elm_object_disabled_get
*
- * @section entry-examples
- *
- * An overview of the Entry API can be seen in @ref entry_example
- *
* @{
*/
*
* Different profiles may have pre-set values for finger sizes.
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
- *
* @{
*/
* @image html flip_inheritance_tree.png
* @image latex flip_inheritance_tree.eps
*
- * @image html img/widget/flip/preview-00.png
- * @image latex img/widget/flip/preview-00.eps
- *
* This widget holds 2 content objects(Evas_Object): one on the front and one
* on the back. It allows you to flip from front to back and vice-versa using
* various animations.
* @image html flipselector_inheritance_tree.png
* @image latex flipselector_inheritance_tree.eps
*
- * @image html img/widget/flipselector/preview-00.png
- * @image latex img/widget/flipselector/preview-00.eps
- *
* A flip selector is a widget to show a set of @b text items, one
* at a time, with the same sheet switching style as the @ref Clock
* "clock" widget, when one changes the current displaying sheet
* @li @ref elm_object_item_part_text_get
* @li @ref elm_object_item_signal_emit
*
- * Here is an example on its usage:
- * @li @ref flipselector_example
*/
/**
* interacted with input events, but are there just for visual
* purposes.
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
*/
/**
* @image html frame_inheritance_tree.png
* @image latex frame_inheritance_tree.eps
*
- * @image html img/widget/frame/preview-00.png
- * @image latex img/widget/frame/preview-00.eps
- *
* @brief Frame is a widget that holds some content and has a title.
*
* The default look is a frame with a title, but Frame supports multiple
* that apply to generic Elementary objects, that deal with
* configuration, et cetera.
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
*/
/**
* @skip static void
* @until ELM_MAIN
*
- * See the full @ref bg_example_01_c "example".
- *
* @see elm_shutdown().
* @ingroup Elm_General
*
* @li elm_object_item_part_content_unset()
* @li elm_object_item_part_text_set()
*
- * List of gengrid examples:
- * @li @ref gengrid_example
*/
/**
* @image html genlist_inheritance_tree.png
* @image latex genlist_inheritance_tree.eps
*
- * @image html img/widget/genlist/preview-00.png
- * @image latex img/widget/genlist/preview-00.eps
- * @image html img/genlist.png
- * @image latex img/genlist.eps
- *
* This widget aims to have more expansive list than the simple list in
* Elementary that could have more flexible items and allow many more entries
* while still being fast and low on memory usage. At the same time it was
* - default
* - default_style - The text part is a textblock
*
- * @image html img/widget/genlist/preview-04.png
- * @image latex img/widget/genlist/preview-04.eps
*
* - double_label
*
- * @image html img/widget/genlist/preview-01.png
- * @image latex img/widget/genlist/preview-01.eps
*
* - icon_top_text_bottom
*
- * @image html img/widget/genlist/preview-02.png
- * @image latex img/widget/genlist/preview-02.eps
*
* - group_index
*
- * @image html img/widget/genlist/preview-03.png
- * @image latex img/widget/genlist/preview-03.eps
*
* - one_icon - Only 1 icon (left) (since 1.7)
* - end_icon - Only 1 icon (at end/right) (since 1.7)
* are two solutions. One is to use 'full' style that has one big swallow part.
* You can swallow anything there. The other solution is to customize genlist
* item style in application side by using elm_theme_extension_add() and its
- * own edc. Please refer @ref theme_example_01 for that.
+ * own edc.
*
* @section Genlist_Items Structure of items
*
*
* @section Genlist_Examples Examples
*
- * Here is a list of examples that use the genlist, trying to show some of
- * its capabilities:
- * - @ref genlist_example_01
- * - @ref genlist_example_02
- * - @ref genlist_example_03
- * - @ref genlist_example_04
- * - @ref genlist_example_05
*/
/**
* - @c "unfocused" - when glview has lost focus.
* - @c "language,changed" - the program's language changed
*
- * Below is an illustrative example of how to use GLView and and OpenGL
- * to render in elementary environment.
- * @ref glview_example_01_page
- *
*/
/**
* @image html hover_inheritance_tree.png
* @image latex hover_inheritance_tree.eps
*
- * @image html img/widget/hover/preview-00.png
- * @image latex img/widget/hover/preview-00.eps
- *
* A Hover object will hover over its @p parent object at the @p target
* location. Anything in the background will be given a darker coloring to
* indicate that the hover object is on top (at the default theme). When the
* @image html icon_inheritance_tree.png
* @image latex icon_inheritance_tree.eps
*
- * @image html img/widget/icon/preview-00.png
- * @image latex img/widget/icon/preview-00.eps
- *
* An icon object is used to display standard icon images ("delete",
* "edit", "arrows", etc.) or images coming from a custom file (PNG,
* JPG, EDJE, etc.), on icon contexts.
* @image html image_inheritance_tree.png
* @image latex image_inheritance_tree.eps
*
- * @image html img/widget/image/preview-00.png
- * @image latex img/widget/image/preview-00.eps
- *
* An Elementary image object is a direct realization of
* @ref elm-image-class, and it allows one to load and display an @b image
* file on it, be it from a disk file or from a memory
* @image html index_inheritance_tree.png
* @image latex index_inheritance_tree.eps
*
- * @image html img/widget/index/preview-00.png
- * @image latex img/widget/index/preview-00.eps
- *
* An index widget gives you an index for fast access to whichever
* group of other UI items one might have. It's a list of text
* items (usually letters, for alphabetically ordered access).
* Supported elm_object_item common APIs
* @li elm_object_item_del
*
- * Here are some examples on its usage:
- * @li @ref index_example_01
- * @li @ref index_example_02
*/
/**
* @image html inwin_inheritance_tree.png
* @image latex inwin_inheritance_tree.eps
*
- * @image html img/widget/inwin/preview-00.png
- * @image latex img/widget/inwin/preview-00.eps
- * @image html img/widget/inwin/preview-01.png
- * @image latex img/widget/inwin/preview-01.eps
- * @image html img/widget/inwin/preview-02.png
- * @image latex img/widget/inwin/preview-02.eps
- *
* An inwin is a window inside a window that is useful for a quick popup.
* It does not hover.
*
* Default content parts of the inwin that you can use for are:
* @li "default" A content of the inwin
*
- * Some examples of Inwin can be found in the following:
- * @li @ref inwin_example_01
- *
* @{
*/
* @image html label_inheritance_tree.png
* @image latex label_inheritance_tree.eps
*
- * @image html img/widget/label/preview-00.png
- * @image latex img/widget/label/preview-00.eps
- *
* @brief Widget to display text, with simple html-like markup.
*
* The Label widget @b doesn't allow text to overflow its boundaries, if the
* @image html layout_inheritance_tree.png
* @image latex layout_inheritance_tree.eps
*
- * @image html img/widget/layout/preview-00.png
- * @image latex img/widget/layout/preview-00.eps width=\textwidth
- *
* @image html img/layout-predefined.png
* @image latex img/layout-predefined.eps width=\textwidth
*
*
* @section secExamples Examples
*
- * Some examples of the Layout widget can be found here:
- * @li @ref layout_example_01
- * @li @ref layout_example_02
- * @li @ref layout_example_03
- * @li @ref layout_example_edc
- *
*/
#include <elm_layout_common.h>
* @image html list_inheritance_tree.png
* @image latex list_inheritance_tree.eps
*
- * @image html img/widget/list/preview-00.png
- * @image latex img/widget/list/preview-00.eps width=\textwidth
- *
* @image html img/list.png
* @image latex img/list.eps width=\textwidth
*
* eventually the deprecated ones will be discarded (next major
* release).
*
- * List of examples:
- * @li @ref list_example_01
- * @li @ref list_example_02
- * @li @ref list_example_03
*/
/**
* @image html map_inheritance_tree.png
* @image latex map_inheritance_tree.eps
*
- * @image html img/widget/map/preview-00.png
- * @image latex img/widget/map/preview-00.eps
- *
* This is a widget specifically for displaying a map. It uses basically
* OpenStreetMap provider http://www.openstreetmap.org/,
* but custom providers can be added.
* Available style for marker bubble:
* - @c "default"
*
- * List of examples:
- * @li @ref map_example_01
- * @li @ref map_example_02
- * @li @ref map_example_03
*/
#include "elm_map_common.h"
* @image html mapbuf_inheritance_tree.png
* @image latex mapbuf_inheritance_tree.eps
*
- * @image html img/widget/mapbuf/preview-00.png
- * @image latex img/widget/mapbuf/preview-00.eps width=\textwidth
- *
* This holds one content object and uses an Evas Map of transformation
* points to be later used with this content. So the content will be
* moved as a single image. So it will improve performance
*
* To enable map, elm_mapbuf_enabled_set() should be used.
*
- * See how to use this widget in this example:
- * @ref mapbuf_example
*/
/**
* @image html menu_inheritance_tree.png
* @image latex menu_inheritance_tree.eps
*
- * @image html img/widget/menu/preview-00.png
- * @image latex img/widget/menu/preview-00.eps
- *
* A menu is a list of items displayed above its parent. When the menu is
* showing its parent is darkened. Each item can have a sub-menu. The menu
* object can be used to display a menu on a right click event, in a toolbar,
* @image html notify_inheritance_tree.png
* @image latex notify_inheritance_tree.eps
*
- * @image html img/widget/notify/preview-00.png
- * @image latex img/widget/notify/preview-00.eps
- *
* Display a container in a particular region of the parent(top, bottom,
* etc). A timeout can be set to automatically hide the notify. This is so
* that, after an evas_object_show() on a notify object, if a timeout was set
* set styles of widgets, if they support them (and if the theme(s)
* do).
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
*/
/**
* @image html panel_inheritance_tree.png
* @image latex panel_inheritance_tree.eps
*
- * @image html img/widget/panel/preview-00.png
- * @image latex img/widget/panel/preview-00.eps
- *
* @brief A panel is an animated side-panel that contains a
* sub-object. It can be expanded or contracted by clicking the
* button on its edge.
* @image html panes_inheritance_tree.png
* @image latex panes_inheritance_tree.eps
*
- * @image html img/widget/panes/preview-00.png
- * @image latex img/widget/panes/preview-00.eps width=\textwidth
- *
* @image html img/panes.png
* @image latex img/panes.eps width=\textwidth
*
* @li @ref elm_object_part_content_get
* @li @ref elm_object_part_content_unset
*
- * Here is an example on its usage:
- * @li @ref panes_example
*/
* @image html photocam_inheritance_tree.png
* @image latex photocam_inheritance_tree.eps
*
- * @image html img/widget/photocam/preview-00.png
- * @image latex img/widget/photocam/preview-00.eps
- *
* Photocam is a widget meant specifically for displaying
* high-resolution digital camera photos, giving speedy feedback (fast
* load), zooming and panning as well as fitting logic, all with low
*
* @section elm-prefs-widget Prefs
*
- * @image html img/widget/prefs/preview-00.png
- * @image latex img/widget/prefs/preview-00.eps width=\textwidth
- *
* @image html prefs_inheritance_tree.png
* @image latex prefs_inheritance_tree.eps
*
*
* @li @ref epcref
*
- * The following are examples on how to use prefs:
- * @li @ref prefs_example_01
- * @li @ref prefs_example_02
- * @li @ref prefs_example_03
*/
#include "elm_prefs_common.h"
* @li @ref elm_object_part_content_get
* @li @ref elm_object_part_content_unset
*
- * Here is an example on its usage:
- * @li @ref progressbar_example
*/
#include "elm_progressbar_common.h"
* @image html radio_inheritance_tree.png
* @image latex radio_inheritance_tree.eps
*
- * @image html img/widget/radio/preview-00.png
- * @image latex img/widget/radio/preview-00.eps
- *
* @brief Radio is a widget that allows for 1 or more options to be displayed
* and have the user choose only 1 of them.
*
#error "do not include this"
/**
- * @image html img/widget/toggle/preview-00.png
- * @image latex img/widget/toggle/preview-00.eps
*
* @brief A toggle is a slider which can be used to toggle between
* two values. It has two states: on and off.
* parent's scale size. @c 1.0 means “don't scale”, @c 2.0 is
* double size, @c 0.5 is half, etc.
*
- * @ref general_functions_example_page "This" example contemplates
- * some of these functions.
*/
/**
* Default content parts of the scroller widget that you can use are:
* @li @c "default" - A content of the scroller
*
- * In @ref tutorial_scroller you'll find an example on how to use most
- * of this API.
* @{
*/
* @image html segment_control_inheritance_tree.png
* @image latex segment_control_inheritance_tree.eps
*
- * @image html img/widget/segment_control/preview-00.png
- * @image latex img/widget/segment_control/preview-00.eps width=\textwidth
- *
* @image html img/segment_control.png
* @image latex img/segment_control.eps width=\textwidth
*
* @li @ref elm_object_item_part_content_set
* @li @ref elm_object_item_part_content_get
*
- * Here is an example on its usage:
- * @li @ref segment_control_example
*
*/
*
* This widget emits the signals coming from @ref Layout.
*
- * @ref tutorial_separator is a good example of how to use a separator.
* @{
*/
* @image html slider_inheritance_tree.png
* @image latex slider_inheritance_tree.eps
*
- * @image html img/widget/slider/preview-00.png
- * @image latex img/widget/slider/preview-00.eps width=\textwidth
- *
* The slider adds a draggable “slider” widget for selecting the value of
* something within a range.
*
* @li @ref elm_object_part_content_get
* @li @ref elm_object_part_content_unset
*
- * Here is an example on its usage:
- * @li @ref slider_example
*/
/**
* @image html slideshow_inheritance_tree.png
* @image latex slideshow_inheritance_tree.eps
*
- * @image html img/widget/slideshow/preview-00.png
- * @image latex img/widget/slideshow/preview-00.eps
- *
* This widget, as the name indicates, is a pre-made image
* slideshow panel, with API functions acting on (child) image
* items presentation. Between those actions, are:
* Supported @c elm_object_item common APIs.
* @li @ref elm_object_item_del
*
- * List of examples for the slideshow widget:
- * @li @ref slideshow_example
*/
/**
* @image html spinner_inheritance_tree.png
* @image latex spinner_inheritance_tree.eps
*
- * @image html img/widget/spinner/preview-00.png
- * @image latex img/widget/spinner/preview-00.eps
- *
* A spinner is a widget which allows the user to increase or decrease
* numeric values using arrow buttons, or edit values directly, clicking
* over it and typing the new value.
* @li @ref elm_object_disabled_set
* @li @ref elm_object_disabled_get
*
- * Here is an example on its usage:
- * @ref spinner_example
*/
/**
* children), but this is as discouraged, if not even more so, than using
* overlays. Don't use this unless you really know what you are doing.
*
- * But to be less negative about things, you can look at the following
- * examples:
- * @li @ref theme_example_01 "Using extensions"
- * @li @ref theme_example_02 "Using overlays"
- *
* @{
*/
/**
* @image html thumb_inheritance_tree.png
* @image latex thumb_inheritance_tree.eps
*
- * @image html img/widget/thumb/preview-00.png
- * @image latex img/widget/thumb/preview-00.eps
- *
* A thumbnail object is used for displaying the thumbnail of an image
* or video. You must have compiled Elementary with @c Ethumb_Client
* support. Also, Ethumb's DBus service must be present and
* - @c "default"
* - @c "noframe"
*
- * An example of use of thumbnail:
- *
- * - @ref thumb_example_01
*/
/**
* @image html toolbar_inheritance_tree.png
* @image latex toolbar_inheritance_tree.eps
*
- * @image html img/widget/toolbar/preview-00.png
- * @image latex img/widget/toolbar/preview-00.eps width=\textwidth
- *
* @image html img/toolbar.png
* @image latex img/toolbar.eps width=\textwidth
*
* @li @ref elm_object_item_focus_set
* @li @ref elm_object_item_focus_get
*
- * List of examples:
- * @li @ref toolbar_example_01
- * @li @ref toolbar_example_02
- * @li @ref toolbar_example_03
*/
/**
* the trick. Edje is better at handling transitions than Elm_Transit.
* Edje has more flexibility and animations can be manipulated inside the theme.
*
- * List of examples:
- * @li @ref transit_example_01_explained
- * @li @ref transit_example_02_explained
- * @li @ref transit_example_03_c
- * @li @ref transit_example_04_c
- *
* @{
*/
* @image html web_inheritance_tree.png
* @image latex web_inheritance_tree.eps
*
- * @image html img/widget/web/preview-00.png
- * @image latex img/widget/web/preview-00.eps
- *
* A web widget is used for displaying web pages (HTML/CSS/JS)
* using WebKit-EFL. You must have compiled Elementary with
* ewebkit support.
* available styles:
* - default
*
- * An example of use of web:
- *
- * - @ref web_example_01
- * - @ref web_example_02
*/
/**
* @image html win_inheritance_tree.png
* @image latex win_inheritance_tree.eps
*
- * @image html img/widget/win/preview-00.png
- * @image latex img/widget/win/preview-00.eps
- *
* The window class of Elementary. Contains functions to manipulate
* windows. The Evas engine used to render the window contents is specified
* in the system or user elementary config files (whichever is found last),
* calls directly. For example, XMapWindow is called directly during
* evas_object_show() in X11 engine.
*
- * Examples:
- * @li @ref win_example_01
- *
* @{
*/