src/lib/elm_widget_bg.h

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