1 #ifndef ELM_WIDGET_NOTIFY_H
2 #define ELM_WIDGET_NOTIFY_H
4 #include "elm_widget_container.h"
10 * @section elm-notify-class The Elementary Notify Class
12 * Elementary, besides having the @ref Notify widget, exposes its
13 * foundation -- the Elementary Notify Class -- in order to create other
14 * widgets which are a notify with some more logic on top.
18 * @def ELM_NOTIFY_CLASS
20 * Use this macro to cast whichever subclass of
21 * #Elm_Notify_Smart_Class into it, so to access its fields.
25 #define ELM_NOTIFY_CLASS(x) ((Elm_Notify_Smart_Class *)x)
28 * @def ELM_NOTIFY_DATA
30 * Use this macro to cast whichever subdata of
31 * #Elm_Notify_Smart_Data into it, so to access its fields.
35 #define ELM_NOTIFY_DATA(x) ((Elm_Notify_Smart_Data *)x)
38 * @def ELM_NOTIFY_SMART_CLASS_VERSION
40 * Current version for Elementary notify @b base smart class, a value
41 * which goes to _Elm_Notify_Smart_Class::version.
45 #define ELM_NOTIFY_SMART_CLASS_VERSION 1
48 * @def ELM_NOTIFY_SMART_CLASS_INIT
50 * Initializer for a whole #Elm_Notify_Smart_Class structure, with
51 * @c NULL values on its specific fields.
53 * @param smart_class_init initializer to use for the "base" field
54 * (#Evas_Smart_Class).
56 * @see EVAS_SMART_CLASS_INIT_NULL
57 * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
58 * @see ELM_NOTIFY_SMART_CLASS_INIT_NULL
59 * @see ELM_NOTIFY_SMART_CLASS_INIT_NAME_VERSION
63 #define ELM_NOTIFY_SMART_CLASS_INIT(smart_class_init) \
64 {smart_class_init, ELM_NOTIFY_SMART_CLASS_VERSION}
67 * @def ELM_NOTIFY_SMART_CLASS_INIT_NULL
69 * Initializer to zero out a whole #Elm_Notify_Smart_Class structure.
71 * @see ELM_NOTIFY_SMART_CLASS_INIT_NAME_VERSION
72 * @see ELM_NOTIFY_SMART_CLASS_INIT
76 #define ELM_NOTIFY_SMART_CLASS_INIT_NULL \
77 ELM_NOTIFY_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
80 * @def ELM_NOTIFY_SMART_CLASS_INIT_NAME_VERSION
82 * Initializer to zero out a whole #Elm_Notify_Smart_Class structure and
83 * set its name and version.
85 * This is similar to #ELM_NOTIFY_SMART_CLASS_INIT_NULL, but it will
86 * also set the version field of #Elm_Notify_Smart_Class (base field)
87 * to the latest #ELM_NOTIFY_SMART_CLASS_VERSION and name it to the
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.
94 * @see ELM_NOTIFY_SMART_CLASS_INIT_NULL
95 * @see ELM_NOTIFY_SMART_CLASS_INIT
99 #define ELM_NOTIFY_SMART_CLASS_INIT_NAME_VERSION(name) \
100 ELM_NOTIFY_SMART_CLASS_INIT(ELM_CONTAINER_SMART_CLASS_INIT_NAME_VERSION(name))
103 * Elementary notify base smart class. This inherits directly from
104 * #Elm_Container_Smart_Class and is meant to build widgets extending the
105 * behavior of a notify.
107 * All of the functions listed on @ref Notify namespace will work for
108 * objects deriving from #Elm_Notify_Smart_Class.
110 typedef struct _Elm_Notify_Smart_Class
112 Elm_Container_Smart_Class base;
114 int version; /**< Version of this smart class definition */
115 } Elm_Notify_Smart_Class;
118 * Base widget smart data extended with notify instance data.
120 typedef struct _Elm_Notify_Smart_Data Elm_Notify_Smart_Data;
121 struct _Elm_Notify_Smart_Data
123 Elm_Container_Smart_Data base;
125 Evas_Object *notify, *content, *parent;
126 Evas_Object *block_events;
128 double horizontal_align, vertical_align;
131 Eina_Bool allow_events : 1;
138 EAPI extern const char ELM_NOTIFY_SMART_NAME[];
139 EAPI const Elm_Notify_Smart_Class *elm_notify_smart_class_get(void);
141 #define ELM_NOTIFY_DATA_GET(o, sd) \
142 Elm_Notify_Smart_Data * sd = evas_object_smart_data_get(o)
144 #define ELM_NOTIFY_DATA_GET_OR_RETURN(o, ptr) \
145 ELM_NOTIFY_DATA_GET(o, ptr); \
148 CRITICAL("No widget data for object %p (%s)", \
149 o, evas_object_type_get(o)); \
153 #define ELM_NOTIFY_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
154 ELM_NOTIFY_DATA_GET(o, ptr); \
157 CRITICAL("No widget data for object %p (%s)", \
158 o, evas_object_type_get(o)); \
162 #define ELM_NOTIFY_CHECK(obj) \
163 if (!obj || !elm_widget_type_check((obj), ELM_NOTIFY_SMART_NAME, __func__)) \