[elm_colorselector]: merged from Opensource 2. config/slp updated with
[framework/uifw/elementary.git] / doc / examples.dox
index c1ded30..ea894ca 100644 (file)
  *
  * @ref clock_example
  *
-<<<<<<< HEAD
-=======
  * @ref datetime_example
  *
  * @ref dayselector_example
  *
->>>>>>> remotes/origin/upstream
  * @ref mapbuf_example
 
  * @ref map_example_01
  */
 
 /**
-<<<<<<< HEAD
-=======
  * @page datetime_example Datetime widget example
  *
  * This code places three Elementary Datetime widgets on a window, each of
  */
 
 /**
->>>>>>> remotes/origin/upstream
  * @page mapbuf_example Mapbuf Widget Example
  *
  * This code places a Elementary mapbuf widget on a window,
  */
 
 /**
-<<<<<<< HEAD
- * @page map_example_02 Map Example - Markers Usage
- *
- * This code places a Elementary map widget on a window,
- * to exemplify part of the widget's API, related to markers.
- *
- * We'll start this example the same way
-=======
  * @page map_example_02 Map Example - Overlay Usage
  *
  * This code places a Elementary map widget on a window,
  * to exemplify part of the widget's API, related to overlays.
  *
  * We'll start this example in the same way
->>>>>>> remotes/origin/upstream
  * @ref map_example_01 "Map Example 1". Adding a map with buttons to control
  * zoom, so if you didn't read it yet, just do it now.
  * @dontinclude map_example_02.c
  * @skipline elm_map_add
  * @until zoom_fill
  *
-<<<<<<< HEAD
- * Markers can be placed over the map to represent anything we want. Let's
- * say we want to represent some countries and cities with markers. To add
- * a mark we need a marker class and also a group class.
- *
- * A marker class can be created as the following code does:
- * @skipline marker_class_new
- * @until style_set
- *
- * These lines create a new class, set a function to return the object
- * to be displayed inside the bubble that opens when a user clicks over
- * the mark, set the function to retrieve an icon to be placed inside
- * the marker, and defines the style of this marker. It can be @c empty
- * that will just show the icon, @c radio, that will place a blue circle,
- * and @c radio2 that will place a green circle.
- *
- * The group classes can be created in a very similar way, but you won't
- * set callback functions to get stuff to be placed inside the bubble,
- * since clicking over a group marker will just get the content
- * of all the markers composing the group and place on this bubble.
- * The limit of markers to get can be set with function
- * elm_map_max_marker_per_group_set() but we won't need on this example.
- * But we can set the zoom required to display the marks that belongs
- * to this group class, so if the zoom is less than this value, nothing
- * will be show. The group marker style will be used when markers are
- * near each other, and the count of markers grouped will be placed
- * inside the group marker.
- * @skipline group_class_new
- * @until displayed_set
- *
- * For marker and group classes to represent a country, the same is done:
- * @skipline marker_class_new
- * @until displayed_set
- *
- * Next we'll create some markers representing cities and coutries.
- * We'll append them in a list, to close up them later. To create a marker
- * we need to pass the coordinates, marker class, group class and optionally,
- * data:
- * @skipline marker_add
- * @until data_chile
- * @until append
-=======
  * Overlays can be placed over the map to represent anything we want. Let's
  * say we want to represent some countries and cities with overlays. 
  * 
  * Finally, on our @c main function, we ask the map to show all the overlays
  * with the biggest zoom possible, passing the list of overlays added.
  * @skipline elm_map_overlays_show
->>>>>>> remotes/origin/upstream
  *
  * We have created a specific structure for this example to store the name
  * of the place and a path to a image file to represent it.
  * @dontinclude map_example_02.c
  * @skipline typedef
-<<<<<<< HEAD
- * @until Marker_Data;
-=======
  * @until Overlay_Data;
->>>>>>> remotes/origin/upstream
  *
  * We'll create instances for each place:
  * @skipline argentina
  * @until sky_03
  *
-<<<<<<< HEAD
- * Finally, on our @c main function, we ask the map to show all the markers
- * with the biggest zoom possible, passing the list of markers added:
- * @skipline list_show
- *
- * Actually the zoom is not what we want, so after the download of the map
- * is concluded, let's set another zoom level. For this we add a callback
- * for @c "downloaded" signal:
- * @skipline callback_add
- *
- * The callback function will simply set the zoom level we want and remove
- * the callback, otherwise it would be called all the time, after the map
- * is downloaded:
- * @dontinclude map_example_02.c
- * @skipline _map_downloaded
- * @until }
- *
- * We added two kinds of callback functions when we added the markers.
- * One will return the content of the bubbles, and other the icon to be
- * placed inside the marker.
- *
- * To return an icon, all we need to do is add a elm_icon and return it:
- * @dontinclude map_example_02.c
- * @skip static Evas_Object
- * @skip }
- * @skipline static Evas_Object
- * @until }
- *
- * For the content, let's return something more elaboreate. We will return
- * a box with an image representing the place, and the name of this place:
- * @skipline static Evas_Object
-=======
   * To return an icon, all we need to do is to add a elm_icon and return it:
  * @dontinclude map_example_02.c
  * @skipline _icon_get(
  * For the content, let's return something more elaborate. We will return
  * a box with an image representing the place, and the name of this place:
  * @skipline _box_get(
->>>>>>> remotes/origin/upstream
  * @until }
  *
  * See @ref map_example_02.c "map_example_02.c" for full source,
  * start point, and would like that he enters the address of his
  * destination in a entry, and we'll trace a route on the map.
  *
-<<<<<<< HEAD
- * We'll start this example the same way
-=======
  * We'll start this example in the same way
->>>>>>> remotes/origin/upstream
  * @ref map_example_01 "Map Example 1". Adding a map with buttons to control
  * zoom, so if you didn't read it yet, just do it now. Actually there is
  * a change, that we're aligning buttons to the top, since we wan't a
  * diskselector will display first item after last, and last previous to
  * the first one. So, as you can see, @b Sa will appears on left side
  * of selected @b Sunday. This property is set with
-<<<<<<< HEAD
- * elm_diskselector_round_set().
- *
- * Also, we decide to display only 2 character for side labels, instead of 3.
- * For this we call elm_diskselector_side_label_length_set(). As result,
-=======
  * elm_diskselector_round_enabled_set().
  *
  * Also, we decide to display only 2 character for side labels, instead of 3.
  * For this we call elm_diskselector_side_text_max_length_set(). As result,
->>>>>>> remotes/origin/upstream
  * we'll see @b Mo displayed instead of @b Mon, when @b Monday is on a
  * side position.
  *
   * elm_image_no_scale_set() is used just to set this value to true (we
   * don't want to scale our image anyway, just resize it).
   *
-<<<<<<< HEAD
-  * elm_image_scale_set() is used to allow the image to be resized to a size
-=======
   * elm_image_resizable_set() is used to allow the image to be resized to a size
->>>>>>> remotes/origin/upstream
   * smaller than the original one, but not to a size bigger than it.
   *
   * elm_elm_image_smooth_set() will disable the smooth scaling, so the scale
   * elm_icon_no_scale_set() is used just to set this value to true (we
   * don't want to scale our icon anyway, just resize it).
   *
-<<<<<<< HEAD
-  * elm_icon_scale_set() is used to allow the icon to be resized to a size
-=======
   * elm_icon_resizable_set() is used to allow the icon to be resized to a size
->>>>>>> remotes/origin/upstream
   * smaller than the original one, but not to a size bigger than it.
   *
   * elm_elm_icon_smooth_set() will disable the smooth scaling, so the scale
  */
 
 /**
-<<<<<<< HEAD
- * @page tutorial_pager
- * @dontinclude pager_example_01.c
- *
- * In this example we'll have a pager with 3 rectangles on it, one blue, one
- * green and one blue, we'll also have 1 button for each rectangle. Pressing a
- * button will bring the associated rectangle to the front of the pager(promote
- * it).
- *
- * We start our example with some run of the mill code that you've seen in other
- * examples:
- * @until show
- *
- * And then we get right to creating our pager, setting a style and some basic
- * properties to it:
- * @until show
- *
- * Well a pager without any content is not of much use, so let's create the
- * first of our rectangles, add it to the pager and create the button for it:
- * @until smart_callback
- * @note The only line of above code that directly relates to our pager is the
- * call to elm_pager_content_push().
- *
- * And now we will do the same thing again twice for our next two rectangles:
- * @until smart_callback
- * @until smart_callback
- *
- * Now that we haver our widgets create we can get to running the main loop:
- * @until ELM_MAIN
- *
- * We also have the callback that is called when any of the buttons is pressed,
- * this callback is receiving the rectangle in it's @p data argument, so we
- * check if it's already on top and if not move it there:
- * @until }
- *
- * Our example will look like this:
- *
- * @image html screenshots/pager_example_01.png
- * @image latex screenshots/pager_example_01.eps width=\textwidth
- * @note Like all examples that involve animations the screenshot doesn't do it
- * justice, seeing it in action is a must.
- *
- * @example pager_example_01.c
- */
-
-/**
-=======
->>>>>>> remotes/origin/upstream
  * @page tutorial_separator Separator example
  * @dontinclude separator_example_01.c
  *
  * and the entry itself doesn't, yet, support all the needed capabilities to
  * make this simpler. We begin by getting the format we are using in our
  * function from the button pressed.
-<<<<<<< HEAD
- * @skip aid->pager = pager;
-=======
  * @skip aid->naviframe = naviframe;
->>>>>>> remotes/origin/upstream
  * @until sizeof(fmt_close)
  *
  * Next we need to find out if we need to insert an opening or a closing tag.
  * elm_genlist_bounce_set().
  *
  * We also want our list to compress items if they are wider than the list
-<<<<<<< HEAD
- * width (thus we call elm_genlist_compress_mode_set().
-=======
  * width (thus we call elm_genlist_mode_set(obj, ELM_LIST_COMPRESS).
->>>>>>> remotes/origin/upstream
  *
  * The items have different width, so they are not homogeneous:
  * elm_genlist_homogeneous_set() is set to false.
  * However, if the @c item1 didn't have any child previously, we have to change
  * it to a parent item now. It would be easy to just change its item class to
  * the parent type, but there's no way to change the item flags and make it be
-<<<<<<< HEAD
- * of the type #ELM_GENLIST_ITEM_SUBITEMS. Thus, we have to delete it and create
-=======
  * of the type #ELM_GENLIST_ITEM_TREE. Thus, we have to delete it and create
->>>>>>> remotes/origin/upstream
  * a new item, and add this new item to the same position that the deleted one
  * was. That's the reason of the checks inside the bigger @c if.
  *
  */
 
 /**
-<<<<<<< HEAD
-=======
  * @page popup_example_01_c popup_example_01.c
  * @include popup_example_01.c
  *
  */
 
 /**
->>>>>>> remotes/origin/upstream
  * @page tutorial_frame Frame example
  * @dontinclude frame_example_01.c
  *
  * @until show(rect)
  *
  * Now that we have a window with background and a rectangle we can create
- * our color_selector and set it's initial color to fully opaque blue:
- * @until show
+ * our color_selector
+ * @until elm_colorselector_add
+ *
+ * Now colors can be loaded to color selector's palette by setting the palette name
+ * @until show(cs)
  *
- * Next we tell ask to be notified whenever the color changes:
+ * Next we ask to be notified whenever the color changes on selector:
  * @until changed
  *
- * We follow that we some more run of the mill setup code:
+ * Next we ask to be notified whenever the color item is selected and longpressed:
+ * @until color,item,longpressed
+ *
+ * We add some more code to the usual setup code:
  * @until ELM_MAIN()
  *
- * And now get to the callback that sets the color of the rectangle:
+ * now get to the "changed" callback that sets the color of the rectangle:
+ * @until }
+ *
+ * And now get to the "color,item,selected" callback that sets the color of the rectangle:
+ * @until }
+ *
+ * And now get to the "color,item,longpressed" callback that gets and displays 
+ * the color of the rectangle:
  * @until }
  *
  * This example will look like this:
  * accordingly and the URL bar needs to show the right address.
  *
  * @skip static void
-<<<<<<< HEAD
- * @until pager_content_promote
-=======
  * @until naviframe_item_simple_promote
->>>>>>> remotes/origin/upstream
  * @until }
  *
  * Other updates happen based on events from the web object, like title change
  * @example clock_example.c
  */
 
-<<<<<<< HEAD
-=======
  /**
  * @page datetime_example_c Datetime example
  * @include datetime_example.c
  * @example dayselector_example.c
  */
 
->>>>>>> remotes/origin/upstream
 /**
  * @page flipselector_example_c Flipselector example
  * @include flipselector_example.c