summaryrefslogtreecommitdiff
path: root/legacy
diff options
context:
space:
mode:
authorSanjeev BA <iamsanjeev@gmail.com>2011-10-24 03:31:40 +0000
committerSanjeev BA <iamsanjeev@gmail.com>2011-10-24 03:31:40 +0000
commitcf19d8b70833461de2e3b1bd091810497bb67134 (patch)
treee95f314b15fceb79d2ba394ca76387b01ca3d766 /legacy
parent23de0435b97633ea0105f6ffc13ca72d0a2f9fb6 (diff)
Documentation fixes for Scroller.
SVN revision: 64348
Diffstat (limited to 'legacy')
-rw-r--r--legacy/elementary/src/lib/Elementary.h.in22
1 files changed, 11 insertions, 11 deletions
diff --git a/legacy/elementary/src/lib/Elementary.h.in b/legacy/elementary/src/lib/Elementary.h.in
index 0c7af405ff..95f8df0691 100644
--- a/legacy/elementary/src/lib/Elementary.h.in
+++ b/legacy/elementary/src/lib/Elementary.h.in
@@ -6971,7 +6971,7 @@ extern "C" {
6971 * A scroller holds a single object and "scrolls it around". This means that 6971 * A scroller holds a single object and "scrolls it around". This means that
6972 * it allows the user to use a scrollbar (or a finger) to drag the viewable 6972 * it allows the user to use a scrollbar (or a finger) to drag the viewable
6973 * region around, allowing to move through a much larger object that is 6973 * region around, allowing to move through a much larger object that is
6974 * contained in the scroller. The scroiller will always have a small minimum 6974 * contained in the scroller. The scroller will always have a small minimum
6975 * size by default as it won't be limited by the contents of the scroller. 6975 * size by default as it won't be limited by the contents of the scroller.
6976 * 6976 *
6977 * Signals that you can add callbacks for are: 6977 * Signals that you can add callbacks for are:
@@ -7129,8 +7129,8 @@ extern "C" {
7129 * @brief Get the size of the content object 7129 * @brief Get the size of the content object
7130 * 7130 *
7131 * @param obj The scroller object 7131 * @param obj The scroller object
7132 * @param w Width return 7132 * @param w Width of the content object.
7133 * @param h Height return 7133 * @param h Height of the content object.
7134 * 7134 *
7135 * This gets the size of the content object of the scroller. 7135 * This gets the size of the content object of the scroller.
7136 */ 7136 */
@@ -7139,21 +7139,21 @@ extern "C" {
7139 * @brief Set bouncing behavior 7139 * @brief Set bouncing behavior
7140 * 7140 *
7141 * @param obj The scroller object 7141 * @param obj The scroller object
7142 * @param h_bounce Will the scroller bounce horizontally or not 7142 * @param h_bounce Allow bounce horizontally
7143 * @param v_bounce Will the scroller bounce vertically or not 7143 * @param v_bounce Allow bounce vertically
7144 * 7144 *
7145 * When scrolling, the scroller may "bounce" when reaching an edge of the 7145 * When scrolling, the scroller may "bounce" when reaching an edge of the
7146 * content object. This is a visual way to indicate the end has been reached. 7146 * content object. This is a visual way to indicate the end has been reached.
7147 * This is enabled by default for both axis. This will set if it is enabled 7147 * This is enabled by default for both axis. This API will set if it is enabled
7148 * for that axis with the boolean parameters for each axis. 7148 * for the given axis with the boolean parameters for each axis.
7149 */ 7149 */
7150 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1); 7150 EAPI void elm_scroller_bounce_set(Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce) EINA_ARG_NONNULL(1);
7151 /** 7151 /**
7152 * @brief Get the bounce mode 7152 * @brief Get the bounce behaviour
7153 * 7153 *
7154 * @param obj The Scroller object 7154 * @param obj The Scroller object
7155 * @param h_bounce Allow bounce horizontally 7155 * @param h_bounce Will the scroller bounce horizontally or not
7156 * @param v_bounce Allow bounce vertically 7156 * @param v_bounce Will the scroller bounce vertically or not
7157 * 7157 *
7158 * @see elm_scroller_bounce_set() 7158 * @see elm_scroller_bounce_set()
7159 */ 7159 */
@@ -7172,7 +7172,7 @@ extern "C" {
7172 * viewport" is size (horizontally or vertically). 0.0 turns it off in that 7172 * viewport" is size (horizontally or vertically). 0.0 turns it off in that
7173 * axis. This is mutually exclusive with page size 7173 * axis. This is mutually exclusive with page size
7174 * (see elm_scroller_page_size_set() for more information). Likewise 0.5 7174 * (see elm_scroller_page_size_set() for more information). Likewise 0.5
7175 * is "half a viewport". Sane usable valus are normally between 0.0 and 1.0 7175 * is "half a viewport". Sane usable values are normally between 0.0 and 1.0
7176 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for 7176 * including 1.0. If you only want 1 axis to be page "limited", use 0.0 for
7177 * the other axis. 7177 * the other axis.
7178 */ 7178 */