src/lib/elm_widget_photo.h

   1 #ifndef ELM_WIDGET_PHOTO_H
   2 #define ELM_WIDGET_PHOTO_H
   3
   4 #include "elm_widget_layout.h"
   5
   6 /**
   7  * @internal
   8  * @addtogroup Widget
   9  * @{
  10  *
  11  * @section elm-photo-class The Elementary Photo Class
  12  *
  13  * Elementary, besides having the @ref Photo widget, exposes its
  14  * foundation -- the Elementary Photo Class -- in order to create
  15  * other widgets which are a photo with some more logic on top.
  16  */
  17
  18 /**
  19  * @def ELM_PHOTO_CLASS
  20  *
  21  * Use this macro to cast whichever subclass of
  22  * #Elm_Photo_Smart_Class into it, so to access its fields.
  23  *
  24  * @ingroup Widget
  25  */
  26 #define ELM_PHOTO_CLASS(x) ((Elm_Photo_Smart_Class *) x)
  27
  28 /**
  29  * @def ELM_PHOTO_DATA
  30  *
  31  * Use this macro to cast whichever subdata of
  32  * #Elm_Photo_Smart_Data into it, so to access its fields.
  33  *
  34  * @ingroup Widget
  35  */
  36 #define ELM_PHOTO_DATA(x) ((Elm_Photo_Smart_Data *) x)
  37
  38 /**
  39  * @def ELM_PHOTO_SMART_CLASS_VERSION
  40  *
  41  * Current version for Elementary photo @b base smart class, a value
  42  * which goes to _Elm_Photo_Smart_Class::version.
  43  *
  44  * @ingroup Widget
  45  */
  46 #define ELM_PHOTO_SMART_CLASS_VERSION 1
  47
  48 /**
  49  * @def ELM_PHOTO_SMART_CLASS_INIT
  50  *
  51  * Initializer for a whole #Elm_Photo_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_PHOTO_SMART_CLASS_INIT_NULL
  60  * @see ELM_PHOTO_SMART_CLASS_INIT_NAME_VERSION
  61  *
  62  * @ingroup Widget
  63  */
  64 #define ELM_PHOTO_SMART_CLASS_INIT(smart_class_init)                        \
  65   {smart_class_init, ELM_PHOTO_SMART_CLASS_VERSION}
  66
  67 /**
  68  * @def ELM_PHOTO_SMART_CLASS_INIT_NULL
  69  *
  70  * Initializer to zero out a whole #Elm_Photo_Smart_Class structure.
  71  *
  72  * @see ELM_PHOTO_SMART_CLASS_INIT_NAME_VERSION
  73  * @see ELM_PHOTO_SMART_CLASS_INIT
  74  *
  75  * @ingroup Widget
  76  */
  77 #define ELM_PHOTO_SMART_CLASS_INIT_NULL \
  78   ELM_PHOTO_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
  79
  80 /**
  81  * @def ELM_PHOTO_SMART_CLASS_INIT_NAME_VERSION
  82  *
  83  * Initializer to zero out a whole #Elm_Photo_Smart_Class structure and
  84  * set its name and version.
  85  *
  86  * This is similar to #ELM_PHOTO_SMART_CLASS_INIT_NULL, but it will
  87  * also set the version field of #Elm_Photo_Smart_Class (base field)
  88  * to the latest #ELM_PHOTO_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_PHOTO_SMART_CLASS_INIT_NULL
  96  * @see ELM_PHOTO_SMART_CLASS_INIT
  97  *
  98  * @ingroup Widget
  99  */
 100 #define ELM_PHOTO_SMART_CLASS_INIT_NAME_VERSION(name) \
 101   ELM_PHOTO_SMART_CLASS_INIT(ELM_WIDGET_SMART_CLASS_INIT_NAME_VERSION(name))
 102
 103 /**
 104  * Elementary photo base smart class. This inherits directly from
 105  * #Elm_Widget_Smart_Class and is meant to build widgets extending the
 106  * behavior of a photo.
 107  *
 108  * All of the functions listed on @ref Photo namespace will work for
 109  * objects deriving from #Elm_Photo_Smart_Class.
 110  */
 111 typedef struct _Elm_Photo_Smart_Class
 112 {
 113    Elm_Widget_Smart_Class base;
 114
 115    int                    version; /**< Version of this smart class definition */
 116 } Elm_Photo_Smart_Class;
 117
 118 /**
 119  * Base widget smart data extended with photo instance data.
 120  */
 121 typedef struct _Elm_Photo_Smart_Data Elm_Photo_Smart_Data;
 122
 123 struct _Elm_Photo_Smart_Data
 124 {
 125    Elm_Widget_Smart_Data base;
 126
 127    Evas_Object          *icon;
 128    int                   size;
 129    Eina_Bool             fill_inside;
 130    Ecore_Timer          *long_press_timer;
 131
 132 #ifdef HAVE_ELEMENTARY_ETHUMB
 133    struct
 134    {
 135       struct
 136       {
 137          const char *path;
 138          const char *key;
 139       } file, thumb;
 140    } thumb;
 141 #endif
 142 };
 143
 144 /**
 145  * @}
 146  */
 147
 148 EAPI extern const char ELM_PHOTO_SMART_NAME[];
 149 EAPI const Elm_Photo_Smart_Class *elm_photo_smart_class_get(void);
 150
 151 #define ELM_PHOTO_DATA_GET(o, sd) \
 152   Elm_Photo_Smart_Data * sd = evas_object_smart_data_get(o)
 153
 154 #define ELM_PHOTO_DATA_GET_OR_RETURN(o, ptr)         \
 155   ELM_PHOTO_DATA_GET(o, ptr);                        \
 156   if (!ptr)                                          \
 157     {                                                \
 158        CRITICAL("No widget data for object %p (%s)", \
 159                 o, evas_object_type_get(o));         \
 160        return;                                       \
 161     }
 162
 163 #define ELM_PHOTO_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
 164   ELM_PHOTO_DATA_GET(o, ptr);                         \
 165   if (!ptr)                                           \
 166     {                                                 \
 167        CRITICAL("No widget data for object %p (%s)",  \
 168                 o, evas_object_type_get(o));          \
 169        return val;                                    \
 170     }
 171
 172 #define ELM_PHOTO_CHECK(obj)                                                 \
 173   if (!obj || !elm_widget_type_check((obj), ELM_PHOTO_SMART_NAME, __func__)) \
 174     return
 175
 176 #endif