src/lib/elm_widget_scroller.h

   1 #ifndef ELM_WIDGET_SCROLLER_H
   2 #define ELM_WIDGET_SCROLLER_H
   3
   4 #include "elm_interface_scrollable.h"
   5 #include "elm_widget_layout.h"
   6
   7 /**
   8  * @addtogroup Widget
   9  * @{
  10  *
  11  * @section elm-scroller-class The Elementary Scroller Class
  12  *
  13  * Elementary, besides having the @ref Scroller widget, exposes its
  14  * foundation -- the Elementary Scroller Class -- in order to create
  15  * other widgets which are a scroller with some more logic on top.
  16  */
  17
  18 /**
  19  * @def ELM_SCROLLER_CLASS
  20  *
  21  * Use this macro to cast whichever subclass of
  22  * #Elm_Scroller_Smart_Class into it, so to access its fields.
  23  *
  24  * @ingroup Widget
  25  */
  26 #define ELM_SCROLLER_CLASS(x) ((Elm_Scroller_Smart_Class *)x)
  27
  28 /**
  29  * @def ELM_SCROLLER_DATA
  30  *
  31  * Use this macro to cast whichever subdata of
  32  * #Elm_Scroller_Smart_Data into it, so to access its fields.
  33  *
  34  * @ingroup Widget
  35  */
  36 #define ELM_SCROLLER_DATA(x)  ((Elm_Scroller_Smart_Data *)x)
  37
  38 /**
  39  * @def ELM_SCROLLER_SMART_CLASS_VERSION
  40  *
  41  * Current version for Elementary scroller @b base smart class, a value
  42  * which goes to _Elm_Scroller_Smart_Class::version.
  43  *
  44  * @ingroup Widget
  45  */
  46 #define ELM_SCROLLER_SMART_CLASS_VERSION 1
  47
  48 /**
  49  * @def ELM_SCROLLER_SMART_CLASS_INIT
  50  *
  51  * Initializer for a whole #Elm_Scroller_Smart_Class structure, with
  52  * @c NULL values on its specific fields.
  53  *
  54  * @param smart_class_init initializer to use for the "base" field
  55  * (#Evas_Smart_Class).
  56  *
  57  * @see EVAS_SMART_CLASS_INIT_NULL
  58  * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
  59  * @see ELM_SCROLLER_SMART_CLASS_INIT_NULL
  60  * @see ELM_SCROLLER_SMART_CLASS_INIT_NAME_VERSION
  61  *
  62  * @ingroup Widget
  63  */
  64 #define ELM_SCROLLER_SMART_CLASS_INIT(smart_class_init) \
  65   {smart_class_init, ELM_SCROLLER_SMART_CLASS_VERSION}
  66
  67 /**
  68  * @def ELM_SCROLLER_SMART_CLASS_INIT_NULL
  69  *
  70  * Initializer to zero out a whole #Elm_Scroller_Smart_Class structure.
  71  *
  72  * @see ELM_SCROLLER_SMART_CLASS_INIT_NAME_VERSION
  73  * @see ELM_SCROLLER_SMART_CLASS_INIT
  74  *
  75  * @ingroup Widget
  76  */
  77 #define ELM_SCROLLER_SMART_CLASS_INIT_NULL \
  78   ELM_SCROLLER_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
  79
  80 /**
  81  * @def ELM_SCROLLER_SMART_CLASS_INIT_NAME_VERSION
  82  *
  83  * Initializer to zero out a whole #Elm_Scroller_Smart_Class structure and
  84  * set its name and version.
  85  *
  86  * This is similar to #ELM_SCROLLER_SMART_CLASS_INIT_NULL, but it will
  87  * also set the version field of #Elm_Scroller_Smart_Class (base field)
  88  * to the latest #ELM_SCROLLER_SMART_CLASS_VERSION and name it to the
  89  * specific value.
  90  *
  91  * It will keep a reference to the name field as a <c>"const char *"</c>,
  92  * i.e., the name must be available while the structure is
  93  * used (hint: static or global variable!) and must not be modified.
  94  *
  95  * @see ELM_SCROLLER_SMART_CLASS_INIT_NULL
  96  * @see ELM_SCROLLER_SMART_CLASS_INIT
  97  *
  98  * @ingroup Widget
  99  */
 100 #define ELM_SCROLLER_SMART_CLASS_INIT_NAME_VERSION(name) \
 101   ELM_SCROLLER_SMART_CLASS_INIT                          \
 102     (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
 103
 104 /**
 105  * Elementary scroller base smart class. This inherits directly from
 106  * #Elm_Layout_Smart_Class and is meant to build widgets extending the
 107  * behavior of a scroller.
 108  *
 109  * All of the functions listed on @ref Scroller namespace will work for
 110  * objects deriving from #Elm_Scroller_Smart_Class.
 111  */
 112 typedef struct _Elm_Scroller_Smart_Class
 113 {
 114    Elm_Layout_Smart_Class base;
 115
 116    int                    version;    /**< Version of this smart class definition */
 117 } Elm_Scroller_Smart_Class;
 118
 119 /**
 120  * Base widget smart data extended with scroller instance data.
 121  */
 122 typedef struct _Elm_Scroller_Smart_Data Elm_Scroller_Smart_Data;
 123 struct _Elm_Scroller_Smart_Data
 124 {
 125    Elm_Layout_Smart_Data                 base; /* base widget smart data as
 126                                                 * first member obligatory, as
 127                                                 * we're inheriting from it */
 128
 129    const Elm_Scrollable_Smart_Interface *s_iface;
 130
 131    Evas_Object                          *hit_rect;
 132    Evas_Object                          *g_layer;
 133
 134    Evas_Object                          *content;
 135
 136    Eina_Bool                             min_w : 1;
 137    Eina_Bool                             min_h : 1;
 138 };
 139
 140 /**
 141  * @}
 142  */
 143
 144 EAPI extern const char ELM_SCROLLER_SMART_NAME[];
 145 EAPI const Elm_Scroller_Smart_Class *elm_scroller_smart_class_get(void);
 146
 147 #define ELM_SCROLLER_DATA_GET(o, sd) \
 148   Elm_Scroller_Smart_Data * sd = evas_object_smart_data_get(o)
 149
 150 #define ELM_SCROLLER_DATA_GET_OR_RETURN(o, ptr)      \
 151   ELM_SCROLLER_DATA_GET(o, ptr);                     \
 152   if (!ptr)                                          \
 153     {                                                \
 154        CRITICAL("No widget data for object %p (%s)", \
 155                 o, evas_object_type_get(o));         \
 156        return;                                       \
 157     }
 158
 159 #define ELM_SCROLLER_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
 160   ELM_SCROLLER_DATA_GET(o, ptr);                         \
 161   if (!ptr)                                              \
 162     {                                                    \
 163        CRITICAL("No widget data for object %p (%s)",     \
 164                 o, evas_object_type_get(o));             \
 165        return val;                                       \
 166     }
 167
 168 #define ELM_SCROLLER_CHECK(obj)                     \
 169   if (!obj || !elm_widget_type_check                \
 170         ((obj), ELM_SCROLLER_SMART_NAME, __func__)) \
 171     return
 172
 173 #endif