From 772c6a5e975e362da0415b23b2162bd7e9c25e23 Mon Sep 17 00:00:00 2001 From: Mike McCormack Date: Tue, 8 Nov 2011 11:42:37 +0900 Subject: [PATCH] [pager] remove docs --- src/lib/elm_pager.c | 102 ---------------------------------------------------- 1 file changed, 102 deletions(-) diff --git a/src/lib/elm_pager.c b/src/lib/elm_pager.c index 332d614..1bf242d 100644 --- a/src/lib/elm_pager.c +++ b/src/lib/elm_pager.c @@ -1,30 +1,6 @@ #include #include "elm_priv.h" -/** - * @defgroup Pager Pager - * - * The pager is an object that allows flipping (with animation) between 1 or - * more “pages” of objects, much like a stack of windows within the window. - * - * Objects can be pushed or popped from the stack or deleted as normal. - * Pushes and pops will animate (and a pop will delete the object once the - * animation is finished). Any object in the pager can be promoted to the top - * (from its current stacking position) as well. Objects are pushed to the - * top with elm_pager_content_push() and when the top item is no longer - * wanted, simply pop it with elm_pager_content_pop() and it will also be - * deleted. Any object you wish to promote to the top that is already in the - * pager, simply use elm_pager_content_promote(). If an object is no longer - * needed and is not the top item, just delete it as normal. You can query - * which objects are the top and bottom with elm_pager_content_bottom_get() - * and elm_pager_content_top_get(). - * - * Signals that you can add callbacks for are: - * - * "hide,finished" - when the previous page is hided - * - */ - typedef struct _Widget_Data Widget_Data; typedef struct _Item Item; @@ -308,14 +284,6 @@ _signal_hide_finished(void *data, Evas_Object *obj __UNUSED__, const char *emiss _sizing_eval(obj2); } -/** - * Add a new pager to the parent - * - * @param parent The parent object - * @return The new object or NULL if it cannot be created - * - * @ingroup Pager - */ EAPI Evas_Object * elm_pager_add(Evas_Object *parent) { @@ -353,18 +321,6 @@ elm_pager_add(Evas_Object *parent) return obj; } -/** - * Push an object to the top of the pager stack (and show it) - * - * The object pushed becomes a child of the pager and will be controlled - * it and deleted when the pager is deleted. - * - * @param obj The pager object - * @param content The object to push - * - * @ingroup Pager - * @warning It will be failed if the content exists on the stack already. - */ EAPI void elm_pager_content_push(Evas_Object *obj, Evas_Object *content) { @@ -415,17 +371,6 @@ elm_pager_content_push(Evas_Object *obj, Evas_Object *content) _sizing_eval(obj); } -/** - * Pop the object that is on top of the stack - * - * This pops the object that is on top (visible) in the pager, makes it - * disappear, then deletes the object. The object that was underneath it - * on the stack will become visible. - * - * @param obj The pager object - * - * @ingroup Pager - */ EAPI void elm_pager_content_pop(Evas_Object *obj) { @@ -473,17 +418,6 @@ _del_job(void *data) evas_object_del(obj); } -/** - * Pop to the object that is on the stack - * - * This pops the objects that are on the stack, makes them - * disappear, then deletes the objects. The content will become visible. - * - * @param obj The pager object - * @param content The object to show - * - * @ingroup Pager - */ EAPI void elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content) { @@ -516,18 +450,6 @@ elm_pager_to_content_pop(Evas_Object *obj, Evas_Object *content) _eval_top(it->obj); } -/** - * Promote an object already in the pager stack to the top of the stack - * - * This will take the indicated object and promote it to the top of the stack - * as if it had been pushed there. The object must already be inside the - * pager stack to work. - * - * @param obj The pager object - * @param content The object to promote - * - * @ingroup Pager - */ EAPI void elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) { @@ -545,14 +467,6 @@ elm_pager_content_promote(Evas_Object *obj, Evas_Object *content) _eval_top(obj); } -/** - * Return the object at the bottom of the pager stack - * - * @param obj The pager object - * @return The bottom object or NULL if none - * - * @ingroup Pager - */ EAPI Evas_Object * elm_pager_content_bottom_get(const Evas_Object *obj) { @@ -565,14 +479,6 @@ elm_pager_content_bottom_get(const Evas_Object *obj) return it->content; } -/** - * Return the object at the top of the pager stack - * - * @param obj The pager object - * @return The top object or NULL if none - * - * @ingroup Pager - */ EAPI Evas_Object * elm_pager_content_top_get(const Evas_Object *obj) { @@ -583,14 +489,6 @@ elm_pager_content_top_get(const Evas_Object *obj) return wd->top->content; } -/** - * This disables content animation on push/pop. - * - * @param obj The pager object - * @param disable if EINA_TRUE animation is disabled. - * - * @ingroup Pager - */ EAPI void elm_pager_animation_disabled_set(Evas_Object *obj, Eina_Bool disable) { -- 2.7.4