Enlightenment CVS committal
Author : moom
Project : e17
Module : libs/etk
Dir : e17/libs/etk/src/lib
Modified Files:
etk_scrollbar.c etk_slider.c
Log Message:
* [Doc] Document the slider's API
===================================================================
RCS file: /cvs/e/e17/libs/etk/src/lib/etk_scrollbar.c,v
retrieving revision 1.17
retrieving revision 1.18
diff -u -3 -r1.17 -r1.18
--- etk_scrollbar.c 28 Nov 2006 21:40:07 -0000 1.17
+++ etk_scrollbar.c 20 Feb 2007 21:55:25 -0000 1.18
@@ -92,9 +92,9 @@
* @param lower the lower bound of the scrollbar
* @param upper the upper bound of the scrollbar
* @param value the initial value of the scrollbar
- * @param step_increment the step increment value. This value is added or
substracted to the current value of the
+ * @param step_increment the step-increment value. This value is added or
substracted to the current value of the
* scrollbar when an arrow button of the scrollbar is clicked, or when the
mouse wheel is used
- * @param page_increment the page increment value. This value is added or
substracted to the current value of the
+ * @param page_increment the page-increment value. This value is added or
substracted to the current value of the
* scrollbar when the page up/down keys are pressed or when the user clicks on
the trough of the scrollbar
* @param page_size the page size value: this value will determine the size of
the drag button of the scrollbar
* @return Returns the new horizontal scrollbar widget
@@ -110,9 +110,9 @@
* @param lower the lower bound of the scrollbar
* @param upper the upper bound of the scrollbar
* @param value the initial value of the scrollbar
- * @param step_increment the step increment value. This value is added or
substracted to the current value of the
+ * @param step_increment the-step increment value. This value is added or
substracted to the current value of the
* scrollbar when an arrow button of the scrollbar is clicked, or when the
mouse wheel is used
- * @param page_increment the page increment value. This value is added or
substracted to the current value of the
+ * @param page_increment the page-increment value. This value is added or
substracted to the current value of the
* scrollbar when the page up/down keys are pressed or when the user clicks on
the trough of the scrollbar
* @param page_size the page size value: this value will determine the size of
the drag button of the scrollbar
* @return Returns the new vertical scrollbar widget
===================================================================
RCS file: /cvs/e/e17/libs/etk/src/lib/etk_slider.c,v
retrieving revision 1.14
retrieving revision 1.15
diff -u -3 -r1.14 -r1.15
--- etk_slider.c 20 Feb 2007 20:50:19 -0000 1.14
+++ etk_slider.c 20 Feb 2007 21:55:25 -0000 1.15
@@ -93,6 +93,13 @@
/**
* @brief Creates a new horizontal slider
+ * @param lower the lower bound of the slider
+ * @param upper the upper bound of the slider
+ * @param value the initial value of the slider
+ * @param step_increment the step-increment value. This value is added or
substracted to the current value of the
+ * slider when an arrow key is pressed, or when the mouse wheel is used
+ * @param page_increment the page-increment value. This value is added or
substracted to the current value of the
+ * slider when the page up/down keys are pressed
* @return Returns the new horizontal slider widget
*/
Etk_Widget *etk_hslider_new(double lower, double upper, double value, double
step_increment, double page_increment)
@@ -104,6 +111,13 @@
/**
* @brief Creates a new vertical slider
+ * @param lower the lower bound of the slider
+ * @param upper the upper bound of the slider
+ * @param value the initial value of the slider
+ * @param step_increment the step-increment value. This value is added or
substracted to the current value of the
+ * slider when an arrow key is pressed, or when the mouse wheel is used
+ * @param page_increment the page-increment value. This value is added or
substracted to the current value of the
+ * slider when the page up/down keys are pressed
* @return Returns the new vertical slider widget
*/
Etk_Widget *etk_vslider_new(double lower, double upper, double value, double
step_increment, double page_increment)
@@ -367,3 +381,39 @@
}
/** @} */
+
+/**************************
+ *
+ * Documentation
+ *
+ **************************/
+
+/**
+ * @addtogroup Etk_Slider
+ *
+ * @image html widgets/slider.png
+ * Etk_Slider is the base class for Etk_HSlider (for horizontal sliders) and
Etk_VSlider (for vertical sliders). @n
+ * Since Etk_Slider inherits from Etk_Range, you can use all the @a
etk_range_*() functions to get or set the value of
+ * a slider, or to change its bounds. You can also use the @a "value_changed"
signal to be notified when the value
+ * of a slider is changed. @n
+ * Sliders can also have their own label. For example, if you want to use a
slider to control a value in centimeters,
+ * you can add the associated label with:
+ * @code
+ * //Display the value of the slider with the format "2.17 cm"
+ * etk_slider_label_set(slider, "%.2f cm");
+ * @endcode @n
+ *
+ * \par Object Hierarchy:
+ * - Etk_Object
+ * - Etk_Widget
+ * - Etk_Range
+ * - Etk_Slider
+ * - Etk_HSlider
+ * - Etk_VSlider
+ *
+ * \par Properties:
+ * @prop_name "label_format": The format of the slider's label, or NULL if the
label is hidden
+ * @prop_type String (char *)
+ * @prop_rw
+ * @prop_val NULL
+ */
-------------------------------------------------------------------------
Take Surveys. Earn Cash. Influence the Future of IT
Join SourceForge.net's Techsay panel and you'll get the chance to share your
opinions on IT & business topics through brief surveys-and earn cash
http://www.techsay.com/default.php?page=join.php&p=sourceforge&CID=DEVDEV
_______________________________________________
enlightenment-cvs mailing list
enlightenment-cvs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-cvs
