diff options
Diffstat (limited to 'src/lib/elm_interface_scrollable.h')
| -rw-r--r-- | src/lib/elm_interface_scrollable.h | 508 |
1 files changed, 458 insertions, 50 deletions
diff --git a/src/lib/elm_interface_scrollable.h b/src/lib/elm_interface_scrollable.h index 25f50a14b..16ef2ba62 100644 --- a/src/lib/elm_interface_scrollable.h +++ b/src/lib/elm_interface_scrollable.h @@ -2,7 +2,10 @@ #define ELM_INTEFARCE_SCROLLER_H /** - * @addtogroup Widget + * @internal + * @defgroup elm_interface_scroller_group Elm Interface Scroller + * @ingroup elm_infra_group + * * @{ * * @section elm-scrollable-interface The Elementary Scrollable Interface @@ -14,10 +17,10 @@ * so an interface is also declared. * * The scrollable interface comes built with Elementary and is exposed - * as #ELM_SCROLLABLE_IFACE. + * as ELM_SCROLLABLE_IFACE. * * The interface API is explained in details at - * #Elm_Scrollable_Smart_Interface. + * Elm_Scrollable_Smart_Interface. * * An Elementary scrollable interface will handle an internal @b * panning object. It has the function of clipping and moving the @@ -31,7 +34,117 @@ * Elm_Scrollable_Smart_Interface::extern_pan_set. */ -#include "elm_pan.eo.h" +/** + * @def ELM_PAN_CLASS + * + * Use this macro to cast whichever subclass of + * #Elm_Pan_Smart_Class into it, so to access its fields. + * + * @ingroup Widget + */ + #define ELM_PAN_CLASS(x) ((Elm_Pan_Smart_Class *)x) + +/** + * @def ELM_PAN_SMART_CLASS_VERSION + * + * Current version for Elementary pan @b base smart class, a value + * which goes to _Elm_Pan_Smart_Class::version. + * + * @ingroup Widget + */ +#define ELM_PAN_SMART_CLASS_VERSION 1 + +/** + * @def ELM_PAN_SMART_CLASS_INIT + * + * Initializer for a whole #Elm_Pan_Smart_Class structure, with + * @c NULL values on its specific fields. + * + * @param smart_class_init initializer to use for the "base" field + * (#Evas_Smart_Class). + * + * @see EVAS_SMART_CLASS_INIT_NULL + * @see EVAS_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_PAN_SMART_CLASS_INIT_NULL + * @see ELM_PAN_SMART_CLASS_INIT_NAME_VERSION + * + * @ingroup Widget + */ +#define ELM_PAN_SMART_CLASS_INIT(smart_class_init) \ + {smart_class_init, ELM_PAN_SMART_CLASS_VERSION, NULL, NULL, NULL, NULL, \ + NULL, NULL, NULL} + +/** + * @def ELM_PAN_SMART_CLASS_INIT_NULL + * + * Initializer to zero out a whole #Elm_Pan_Smart_Class structure. + * + * @see ELM_PAN_SMART_CLASS_INIT_NAME_VERSION + * @see ELM_PAN_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PAN_SMART_CLASS_INIT_NULL \ + ELM_PAN_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL) + +/** + * @def ELM_PAN_SMART_CLASS_INIT_NAME_VERSION + * + * Initializer to zero out a whole #Elm_Pan_Smart_Class structure and + * set its name and version. + * + * This is similar to #ELM_PAN_SMART_CLASS_INIT_NULL, but it will + * also set the version field of #Elm_Pan_Smart_Class (base field) + * to the latest #ELM_PAN_SMART_CLASS_VERSION and name it to the + * specific value. + * + * It will keep a reference to the name field as a <c>"const char *"</c>, + * i.e., the name must be available while the structure is + * used (hint: static or global variable!) and must not be modified. + * + * @see ELM_PAN_SMART_CLASS_INIT_NULL + * @see ELM_PAN_SMART_CLASS_INIT + * + * @ingroup Widget + */ +#define ELM_PAN_SMART_CLASS_INIT_NAME_VERSION(name) \ + ELM_PAN_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NAME_VERSION(name)) + +/** + * Elementary scroller panning base smart class. This inherits + * directly from the Evas smart clipped class (an object clipping + * children to its viewport/size). It is exposed here only to build + * widgets needing a custom panning behavior. + */ +typedef struct _Elm_Pan_Smart_Class Elm_Pan_Smart_Class; +struct _Elm_Pan_Smart_Class +{ + Evas_Smart_Class base; /* it's a clipped smart object */ + + int version; /**< Version of this smart class definition */ + + void (*pos_set)(Evas_Object *obj, + Evas_Coord x, + Evas_Coord y); + void (*pos_get)(const Evas_Object *obj, + Evas_Coord *x, + Evas_Coord *y); + void (*pos_max_get)(const Evas_Object *obj, + Evas_Coord *x, + Evas_Coord *y); + void (*pos_min_get)(const Evas_Object *obj, + Evas_Coord *x, + Evas_Coord *y); + void (*content_size_get)(const Evas_Object *obj, + Evas_Coord *x, + Evas_Coord *y); + void (*gravity_set)(Evas_Object *obj, + double x, + double y); + void (*gravity_get)(const Evas_Object *obj, + double *x, + double *y); +}; /** * Elementary scroller panning base smart data. @@ -39,6 +152,10 @@ typedef struct _Elm_Pan_Smart_Data Elm_Pan_Smart_Data; struct _Elm_Pan_Smart_Data { + Evas_Object_Smart_Clipped_Data base; + + const Elm_Pan_Smart_Class *api; /**< This is the pointer to the object's class, from where we can reach/call its class functions */ + Evas_Object *self; Evas_Object *content; Evas_Coord x, y, w, h; @@ -47,13 +164,28 @@ struct _Elm_Pan_Smart_Data Evas_Coord prev_cw, prev_ch, delta_posx, delta_posy; }; +//TIZEN ONLY : for scroller smooth algorithm +typedef struct _Elm_Scroll_Pos +{ + Evas_Coord x, y; + double t; +} Elm_Scroll_Pos; + +typedef struct _Elm_Scroll_History_Item +{ + Evas_Coord x, y; + double timestamp, localtimestamp; +} Elm_Scroll_History_Item; + +typedef struct _Elm_Scroll_Predict +{ + double k[2]; +} Elm_Scroll_Predict; +#define ELM_SCROLL_HISTORY_SIZE 60 + /** * Elementary scrollable interface base data. */ -typedef void (*Elm_Interface_Scrollable_Cb)(Evas_Object *, void *data); -typedef void (*Elm_Interface_Scrollable_Min_Limit_Cb)(Evas_Object *obj, Eina_Bool w, Eina_Bool h); -typedef void (*Elm_Interface_Scrollable_Resize_Cb)(Evas_Object *obj, Evas_Coord w, Evas_Coord h); - typedef struct _Elm_Scrollable_Smart_Interface_Data Elm_Scrollable_Smart_Interface_Data; struct _Elm_Scrollable_Smart_Interface_Data @@ -71,7 +203,7 @@ struct _Elm_Scrollable_Smart_Interface_Data Elm_Scroller_Policy hbar_flags, vbar_flags; Elm_Scroller_Single_Direction one_direction_at_a_time; - Elm_Scroller_Movement_Block block; + Elm_Scroller_Movement_Block block; struct { @@ -85,11 +217,8 @@ struct _Elm_Scrollable_Smart_Interface_Data Evas_Coord b0x, b0y; Evas_Coord b2x, b2y; - struct - { - Evas_Coord x, y; - double timestamp, localtimestamp; - } history[60]; + //TIZEN ONLY : for scroller smooth algorithm + Elm_Scroll_History_Item history[ELM_SCROLL_HISTORY_SIZE]; struct { @@ -109,7 +238,6 @@ struct _Elm_Scrollable_Smart_Interface_Data Evas_Coord locked_x, locked_y; int hdir, vdir; - Ecore_Idle_Enterer *hold_enterer; Ecore_Animator *hold_animator; Ecore_Animator *onhold_animator; Ecore_Animator *momentum_animator; @@ -130,6 +258,23 @@ struct _Elm_Scrollable_Smart_Interface_Data Eina_Bool dir_y : 1; Eina_Bool hold : 1; Eina_Bool now : 1; + //TIZEN ONLY : for scroller smooth algorithm + double anim_t_prev; + int anim_x_prev; + int anim_y_prev; + double anim_vx_prev; + double anim_vy_prev; + int anim_x_coord_prev; + int anim_y_coord_prev; + int anim_count; + int anim_skip; + int anim_t_dont_adjust; + double anim_t_delay; + double anim_t_adjusted; + double anim_pos_t_prev; + int pageflick_h; + int pageflick_v; + Elm_Scroll_Predict predict; } down; struct @@ -145,29 +290,50 @@ struct _Elm_Scrollable_Smart_Interface_Data struct { - Elm_Interface_Scrollable_Cb drag_start; - Elm_Interface_Scrollable_Cb drag_stop; - Elm_Interface_Scrollable_Cb animate_start; - Elm_Interface_Scrollable_Cb animate_stop; - Elm_Interface_Scrollable_Cb scroll; - Elm_Interface_Scrollable_Cb scroll_left; - Elm_Interface_Scrollable_Cb scroll_right; - Elm_Interface_Scrollable_Cb scroll_up; - Elm_Interface_Scrollable_Cb scroll_down; - Elm_Interface_Scrollable_Cb edge_left; - Elm_Interface_Scrollable_Cb edge_right; - Elm_Interface_Scrollable_Cb edge_top; - Elm_Interface_Scrollable_Cb edge_bottom; - Elm_Interface_Scrollable_Cb vbar_drag; - Elm_Interface_Scrollable_Cb vbar_press; - Elm_Interface_Scrollable_Cb vbar_unpress; - Elm_Interface_Scrollable_Cb hbar_drag; - Elm_Interface_Scrollable_Cb hbar_press; - Elm_Interface_Scrollable_Cb hbar_unpress; - Elm_Interface_Scrollable_Cb page_change; - - Elm_Interface_Scrollable_Min_Limit_Cb content_min_limit; - Elm_Interface_Scrollable_Resize_Cb content_viewport_resize; + void (*drag_start)(Evas_Object *obj, + void *data); + void (*drag_stop)(Evas_Object *obj, + void *data); + void (*animate_start)(Evas_Object *obj, + void *data); + void (*animate_stop)(Evas_Object *obj, + void *data); + void (*scroll)(Evas_Object *obj, + void *data); + void (*scroll_left)(Evas_Object *obj, + void *data); + void (*scroll_right)(Evas_Object *obj, + void *data); + void (*scroll_up)(Evas_Object *obj, + void *data); + void (*scroll_down)(Evas_Object *obj, + void *data); + void (*edge_left)(Evas_Object *obj, + void *data); + void (*edge_right)(Evas_Object *obj, + void *data); + void (*edge_top)(Evas_Object *obj, + void *data); + void (*edge_bottom)(Evas_Object *obj, + void *data); + void (*vbar_drag)(Evas_Object *obj, + void *data); + void (*vbar_press)(Evas_Object *obj, + void *data); + void (*vbar_unpress)(Evas_Object *obj, + void *data); + void (*hbar_drag)(Evas_Object *obj, + void *data); + void (*hbar_press)(Evas_Object *obj, + void *data); + void (*hbar_unpress)(Evas_Object *obj, + void *data); + void (*content_min_limit)(Evas_Object *obj, + Eina_Bool w, + Eina_Bool h); + void (*content_viewport_resize)(Evas_Object *obj, + Evas_Coord w, + Evas_Coord h); } cb_func; struct @@ -180,19 +346,13 @@ struct _Elm_Scrollable_Smart_Interface_Data } x, y; } scrollto; + int pagecount_h, pagecount_v; double pagerel_h, pagerel_v; Evas_Coord pagesize_h, pagesize_v; int page_limit_h, page_limit_v; - int current_calc; - - unsigned char size_adjust_recurse; - unsigned char size_count; - Eina_Bool size_adjust_recurse_abort : 1; Eina_Bool momentum_animator_disabled : 1; Eina_Bool bounce_animator_disabled : 1; - Eina_Bool page_snap_horiz : 1; - Eina_Bool page_snap_vert : 1; Eina_Bool wheel_disabled : 1; Eina_Bool hbar_visible : 1; Eina_Bool vbar_visible : 1; @@ -210,20 +370,268 @@ struct _Elm_Scrollable_Smart_Interface_Data Eina_Bool go_right : 1; Eina_Bool go_up : 1; Eina_Bool go_down : 1; + Eina_Bool loop_h : 1; + Eina_Bool loop_v : 1; + Eina_Bool origin_x : 1; + Eina_Bool origin_y : 1; }; +typedef struct _Elm_Scrollable_Smart_Interface Elm_Scrollable_Smart_Interface; +struct _Elm_Scrollable_Smart_Interface +{ + Evas_Smart_Interface base; + + void (*objects_set)(Evas_Object *obj, + Evas_Object *edje_obj, + Evas_Object *hit_rectangle); + void (*content_set)(Evas_Object *obj, + Evas_Object *content); + + void (*extern_pan_set)(Evas_Object *obj, + Evas_Object *pan); + + void (*drag_start_cb_set)(Evas_Object *obj, + void (*d_start_cb)(Evas_Object *obj, + void *data)); + void (*drag_stop_cb_set)(Evas_Object *obj, + void (*d_stop_cb)(Evas_Object *obj, + void *data)); + void (*animate_start_cb_set)(Evas_Object *obj, + void (*a_start_cb)(Evas_Object *obj, + void *data)); + void (*animate_stop_cb_set)(Evas_Object *obj, + void (*a_stop_cb)(Evas_Object *obj, + void *data)); + void (*scroll_cb_set)(Evas_Object *obj, + void (*s_cb)(Evas_Object *obj, + void *data)); + void (*scroll_left_cb_set)(Evas_Object *obj, + void (*s_left_cb)(Evas_Object *obj, + void *data)); + void (*scroll_right_cb_set)(Evas_Object *obj, + void (*s_right_cb)(Evas_Object *obj, + void *data)); + void (*scroll_up_cb_set)(Evas_Object *obj, + void (*s_up_cb)(Evas_Object *obj, + void *data)); + void (*scroll_down_cb_set)(Evas_Object *obj, + void (*s_down_cb)(Evas_Object *obj, + void *data)); + void (*edge_left_cb_set)(Evas_Object *obj, + void (*e_left_cb)(Evas_Object *obj, + void *data)); + void (*edge_right_cb_set)(Evas_Object *obj, + void (*e_right_cb)(Evas_Object *obj, + void *data)); + void (*edge_top_cb_set)(Evas_Object *obj, + void (*e_top_cb)(Evas_Object *obj, + void *data)); + void (*edge_bottom_cb_set)(Evas_Object *obj, + void (*e_bottom_cb)(Evas_Object *obj, + void *data)); + void (*vbar_drag_cb_set)(Evas_Object *obj, + void (*v_drag_cb)(Evas_Object *obj, + void *data)); + void (*vbar_press_cb_set)(Evas_Object *obj, + void (*v_press_cb)(Evas_Object *obj, + void *data)); + void (*vbar_unpress_cb_set)(Evas_Object *obj, + void (*v_unpress_cb)(Evas_Object *obj, + void *data)); + void (*hbar_drag_cb_set)(Evas_Object *obj, + void (*h_drag_cb)(Evas_Object *obj, + void *data)); + void (*hbar_press_cb_set)(Evas_Object *obj, + void (*h_press_cb)(Evas_Object *obj, + void *data)); + void (*hbar_unpress_cb_set)(Evas_Object *obj, + void (*h_unpress_cb)(Evas_Object *obj, + void *data)); + + void (*content_min_limit_cb_set)(Evas_Object *obj, + void (*c_limit_cb)(Evas_Object *obj, + Eina_Bool w, + Eina_Bool h)); + void (*content_viewport_resize_cb_set)(Evas_Object *obj, + void (*c_viewport_resize_cb)(Evas_Object *obj, + Evas_Coord w, + Evas_Coord h)); + + /* set the position of content object inside the scrolling region, + * immediately */ + void (*content_pos_set)(Evas_Object *obj, + Evas_Coord x, + Evas_Coord y, + Eina_Bool sig); + void (*content_pos_get)(const Evas_Object *obj, + Evas_Coord *x, + Evas_Coord *y); + + void (*content_region_show)(Evas_Object *obj, + Evas_Coord x, + Evas_Coord y, + Evas_Coord w, + Evas_Coord h); + void (*content_region_set)(Evas_Object *obj, + Evas_Coord x, + Evas_Coord y, + Evas_Coord w, + Evas_Coord h); + + void (*content_size_get)(const Evas_Object *obj, + Evas_Coord *w, + Evas_Coord *h); + + /* get the size of the actual viewport area (swallowed into + * scroller Edje object) */ + void (*content_viewport_size_get)(const Evas_Object *obj, + Evas_Coord *w, + Evas_Coord *h); + + void (*content_viewport_pos_get)(const Evas_Object *obj, + Evas_Coord *x, + Evas_Coord *y); + + /* this one issues the respective callback, only */ + void (*content_min_limit)(Evas_Object *obj, + Eina_Bool w, + Eina_Bool h); + + void (*step_size_set)(Evas_Object *obj, + Evas_Coord x, + Evas_Coord y); + void (*step_size_get)(const Evas_Object *obj, + Evas_Coord *x, + Evas_Coord *y); + void (*page_size_set)(Evas_Object *obj, + Evas_Coord x, + Evas_Coord y); + void (*page_size_get)(const Evas_Object *obj, + Evas_Coord *x, + Evas_Coord *y); + void (*policy_set)(Evas_Object *obj, + Elm_Scroller_Policy hbar, + Elm_Scroller_Policy vbar); + void (*policy_get)(const Evas_Object *obj, + Elm_Scroller_Policy *hbar, + Elm_Scroller_Policy *vbar); + + void (*single_direction_set)(Evas_Object *obj, + Elm_Scroller_Single_Direction single_dir); + Elm_Scroller_Single_Direction (*single_direction_get)(const Evas_Object *obj); + + void (*repeat_events_set)(Evas_Object *obj, + Eina_Bool repeat_events); + Eina_Bool (*repeat_events_get)(const Evas_Object *obj); + + void (*mirrored_set)(Evas_Object *obj, + Eina_Bool mirrored); + + void (*hold_set)(Evas_Object *obj, + Eina_Bool hold); + void (*freeze_set)(Evas_Object *obj, + Eina_Bool freeze); + + void (*bounce_allow_set)(Evas_Object *obj, + Eina_Bool horiz, + Eina_Bool vert); + void (*bounce_allow_get)(const Evas_Object *obj, + Eina_Bool *horiz, + Eina_Bool *vert); + + void (*origin_reverse_set)(Evas_Object *obj, + Eina_Bool origin_x, Eina_Bool origin_y); + void (*origin_reverse_get)(const Evas_Object *obj, + Eina_Bool *origin_x, Eina_Bool *origin_y); + + void (*paging_set)(Evas_Object *obj, + double pagerel_h, + double pagerel_v, + Evas_Coord pagesize_h, + Evas_Coord pagesize_v); + void (*paging_get)(const Evas_Object *obj, + double *pagerel_h, + double *pagerel_v, + Evas_Coord *pagesize_h, + Evas_Coord *pagesize_v); + void (*page_scroll_limit_set)(const Evas_Object *obj, + int page_limit_h, + int page_limit_v); + void (*page_scroll_limit_get)(const Evas_Object *obj, + int *page_limit_h, + int *page_limit_v); + void (*current_page_get)(const Evas_Object *obj, + int *pagenumber_h, + int *pagenumber_v); + void (*last_page_get)(const Evas_Object *obj, + int *pagenumber_h, + int *pagenumber_v); + void (*page_show)(Evas_Object *obj, + int pagenumber_h, + int pagenumber_v); + void (*page_bring_in)(Evas_Object *obj, + int pagenumber_h, + int pagenumber_v); + + void (*region_bring_in)(Evas_Object *obj, + Evas_Coord x, + Evas_Coord y, + Evas_Coord w, + Evas_Coord h); + + void (*gravity_set)(Evas_Object *obj, + double x, + double y); + void (*gravity_get)(const Evas_Object *obj, + double *x, + double *y); + + void (*loop_set)(Evas_Object *obj, + Eina_Bool loop_h, + Eina_Bool loop_v); + void (*loop_get)(const Evas_Object *obj, + Eina_Bool *loop_h, + Eina_Bool *loop_v); + + Eina_Bool (*momentum_animator_disabled_get)(const Evas_Object *obj); + void (*momentum_animator_disabled_set)(Evas_Object *obj, + Eina_Bool disabled); + + void (*bounce_animator_disabled_set)(Evas_Object *obj, + Eina_Bool disabled); + Eina_Bool (*bounce_animator_disabled_get)(const Evas_Object *obj); + + Eina_Bool (*wheel_disabled_get)(const Evas_Object *obj); + void (*wheel_disabled_set)(Evas_Object *obj, + Eina_Bool disabled); + + void (*movement_block_set)(Evas_Object *obj, + Elm_Scroller_Movement_Block block); + Elm_Scroller_Movement_Block (*movement_block_get)(const Evas_Object *obj); +}; + +EAPI extern const char ELM_SCROLLABLE_IFACE_NAME[]; +EAPI extern const Elm_Scrollable_Smart_Interface ELM_SCROLLABLE_IFACE; + +EAPI const Elm_Pan_Smart_Class *elm_pan_smart_class_get(void); + +#define ELM_SCROLLABLE_IFACE_GET(obj, iface) \ + const Elm_Scrollable_Smart_Interface * iface; \ + iface = evas_object_smart_interface_get(obj, ELM_SCROLLABLE_IFACE_NAME); + #define ELM_SCROLLABLE_CHECK(obj, ...) \ + const Elm_Scrollable_Smart_Interface * s_iface = \ + evas_object_smart_interface_get(obj, ELM_SCROLLABLE_IFACE_NAME); \ \ - if (!eo_isa(obj, ELM_INTERFACE_SCROLLABLE_MIXIN)) \ + if (!s_iface) \ { \ - ERR("The object (%p) doesn't implement the Elementary scrollable" \ - " interface", obj); \ + ERR("Passing object (%p) of type '%s' in function %s, but it doesn't" \ + " implement the Elementary scrollable interface.", obj, \ + elm_widget_type_get(obj), __func__); \ if (getenv("ELM_ERROR_ABORT")) abort(); \ return __VA_ARGS__; \ } -#include "elm_interface_scrollable.eo.h" - /** * @} */ |