src/lib/elm_widget_naviframe.h

   1 #ifndef ELM_WIDGET_NAVIFRAME_H
   2 #define ELM_WIDGET_NAVIFRAME_H
   3
   4 #include "elm_widget_layout.h"
   5
   6 /**
   7  * @addtogroup Widget
   8  * @{
   9  *
  10  * @section elm-naviframe-class The Elementary Naviframe Class
  11  *
  12  * Elementary, besides having the @ref Naviframe widget, exposes its
  13  * foundation -- the Elementary Naviframe Class -- in order to create other
  14  * widgets which are a naviframe with some more logic on top.
  15  */
  16
  17 /**
  18  * @def ELM_NAVIFRAME_CLASS
  19  *
  20  * Use this macro to cast whichever subclass of
  21  * #Elm_Naviframe_Smart_Class into it, so to access its fields.
  22  *
  23  * @ingroup Widget
  24  */
  25 #define ELM_NAVIFRAME_CLASS(x) ((Elm_Naviframe_Smart_Class *)x)
  26
  27 /**
  28  * @def ELM_NAVIFRAME_DATA
  29  *
  30  * Use this macro to cast whichever subdata of
  31  * #Elm_Naviframe_Smart_Data into it, so to access its fields.
  32  *
  33  * @ingroup Widget
  34  */
  35 #define ELM_NAVIFRAME_DATA(x)  ((Elm_Naviframe_Smart_Data *)x)
  36
  37 /**
  38  * @def ELM_NAVIFRAME_SMART_CLASS_VERSION
  39  *
  40  * Current version for Elementary naviframe @b base smart class, a value
  41  * which goes to _Elm_Naviframe_Smart_Class::version.
  42  *
  43  * @ingroup Widget
  44  */
  45 #define ELM_NAVIFRAME_SMART_CLASS_VERSION 1
  46
  47 /**
  48  * @def ELM_NAVIFRAME_SMART_CLASS_INIT
  49  *
  50  * Initializer for a whole #Elm_Naviframe_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_NAVIFRAME_SMART_CLASS_INIT_NULL
  59  * @see ELM_NAVIFRAME_SMART_CLASS_INIT_NAME_VERSION
  60  *
  61  * @ingroup Widget
  62  */
  63 #define ELM_NAVIFRAME_SMART_CLASS_INIT(smart_class_init) \
  64   {smart_class_init, ELM_NAVIFRAME_SMART_CLASS_VERSION}
  65
  66 /**
  67  * @def ELM_NAVIFRAME_SMART_CLASS_INIT_NULL
  68  *
  69  * Initializer to zero out a whole #Elm_Naviframe_Smart_Class structure.
  70  *
  71  * @see ELM_NAVIFRAME_SMART_CLASS_INIT_NAME_VERSION
  72  * @see ELM_NAVIFRAME_SMART_CLASS_INIT
  73  *
  74  * @ingroup Widget
  75  */
  76 #define ELM_NAVIFRAME_SMART_CLASS_INIT_NULL \
  77   ELM_NAVIFRAME_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
  78
  79 /**
  80  * @def ELM_NAVIFRAME_SMART_CLASS_INIT_NAME_VERSION
  81  *
  82  * Initializer to zero out a whole #Elm_Naviframe_Smart_Class structure and
  83  * set its name and version.
  84  *
  85  * This is similar to #ELM_NAVIFRAME_SMART_CLASS_INIT_NULL, but it will
  86  * also set the version field of #Elm_Naviframe_Smart_Class (base field)
  87  * to the latest #ELM_NAVIFRAME_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_NAVIFRAME_SMART_CLASS_INIT_NULL
  95  * @see ELM_NAVIFRAME_SMART_CLASS_INIT
  96  *
  97  * @ingroup Widget
  98  */
  99 #define ELM_NAVIFRAME_SMART_CLASS_INIT_NAME_VERSION(name) \
 100   ELM_NAVIFRAME_SMART_CLASS_INIT                          \
 101     (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
 102
 103 /**
 104  * Elementary naviframe base smart class. This inherits directly from
 105  * #Elm_Layout_Smart_Class and is meant to build widgets extending the
 106  * behavior of a naviframe.
 107  *
 108  * All of the functions listed on @ref Naviframe namespace will work for
 109  * objects deriving from #Elm_Naviframe_Smart_Class.
 110  */
 111 typedef struct _Elm_Naviframe_Smart_Class
 112 {
 113    Elm_Layout_Smart_Class base;
 114
 115    int                    version;    /**< Version of this smart class definition */
 116 } Elm_Naviframe_Smart_Class;
 117
 118 /**
 119  * Base layout smart data extended with naviframe instance data.
 120  */
 121 typedef struct _Elm_Naviframe_Smart_Data Elm_Naviframe_Smart_Data;
 122 struct _Elm_Naviframe_Smart_Data
 123 {
 124    Elm_Layout_Smart_Data base;
 125    Eina_Inlist          *stack; /* top item is the list's LAST item */
 126    Eina_List            *popping;
 127    Evas_Object          *dummy_edje;
 128    Evas_Display_Mode     dispmode;
 129
 130    Eina_Bool             preserve : 1;
 131    Eina_Bool             on_deletion : 1;
 132    Eina_Bool             auto_pushed : 1;
 133    Eina_Bool             freeze_events : 1;
 134 };
 135
 136 typedef struct _Elm_Naviframe_Item Elm_Naviframe_Item;
 137 struct _Elm_Naviframe_Item
 138 {
 139    ELM_WIDGET_ITEM;
 140    EINA_INLIST;
 141
 142    Eina_Inlist *content_list;
 143    Eina_Inlist *text_list;
 144    Evas_Object *content;
 145    Evas_Object *title_prev_btn;
 146    Evas_Object *title_next_btn;
 147    Evas_Object *title_icon;
 148    Ecore_Animator *animator;
 149    Evas_Display_Mode dispmode;
 150    Elm_Naviframe_Item_Pop_Cb pop_cb;
 151    void        *pop_data;
 152    const char  *style;
 153    const char  *title_label;
 154    const char  *subtitle_label;
 155
 156    Evas_Coord   minw;
 157    Evas_Coord   minh;
 158
 159    Eina_Bool    title_visible : 1;
 160    Eina_Bool    unfocusable : 1;
 161 };
 162
 163 typedef struct _Elm_Naviframe_Content_Item_Pair Elm_Naviframe_Content_Item_Pair;
 164 struct _Elm_Naviframe_Content_Item_Pair
 165 {
 166    EINA_INLIST;
 167    const char *part;
 168    Evas_Object *content;
 169    Elm_Naviframe_Item *it;
 170 };
 171
 172 typedef struct _Elm_Naviframe_Text_Item_Pair Elm_Naviframe_Text_Item_Pair;
 173 struct _Elm_Naviframe_Text_Item_Pair
 174 {
 175    EINA_INLIST;
 176    const char *part;
 177 };
 178
 179 /**
 180  * @}
 181  */
 182
 183 EAPI extern const char ELM_NAVIFRAME_SMART_NAME[];
 184 EAPI const Elm_Naviframe_Smart_Class *elm_naviframe_smart_class_get(void);
 185
 186 #define ELM_NAVIFRAME_DATA_GET(o, sd) \
 187   Elm_Naviframe_Smart_Data * sd = evas_object_smart_data_get(o)
 188
 189 #define ELM_NAVIFRAME_DATA_GET_OR_RETURN(o, ptr)     \
 190   ELM_NAVIFRAME_DATA_GET(o, ptr);                    \
 191   if (!ptr)                                          \
 192     {                                                \
 193        CRITICAL("No widget data for object %p (%s)", \
 194                 o, evas_object_type_get(o));         \
 195        return;                                       \
 196     }
 197
 198 #define ELM_NAVIFRAME_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
 199   ELM_NAVIFRAME_DATA_GET(o, ptr);                         \
 200   if (!ptr)                                               \
 201     {                                                     \
 202        CRITICAL("No widget data for object %p (%s)",      \
 203                 o, evas_object_type_get(o));              \
 204        return val;                                        \
 205     }
 206
 207 #define ELM_NAVIFRAME_CHECK(obj)                                      \
 208   if (!obj || !elm_widget_type_check((obj), ELM_NAVIFRAME_SMART_NAME, \
 209                                      __func__))                       \
 210     return
 211
 212 #define ELM_NAVIFRAME_ITEM_CHECK(it)                        \
 213   ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, ); \
 214   ELM_NAVIFRAME_CHECK(it->base.widget);
 215
 216 #define ELM_NAVIFRAME_ITEM_CHECK_OR_RETURN(it, ...)                    \
 217   ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
 218   ELM_NAVIFRAME_CHECK(it->base.widget) __VA_ARGS__;
 219
 220 #endif