1 #ifndef ELM_WIDGET_MENU_H
2 #define ELM_WIDGET_MENU_H
8 * @section elm-menu-class The Elementary Menu Class
10 * Elementary, besides having the @ref Menu widget, exposes its
11 * foundation -- the Elementary Menu Class -- in order to create
12 * other widgets which are a menu with some more logic on top.
18 * Use this macro to cast whichever subclass of
19 * #Elm_Menu_Smart_Class into it, so to access its fields.
23 #define ELM_MENU_CLASS(x) ((Elm_Menu_Smart_Class *) x)
28 * Use this macro to cast whichever subdata of
29 * #Elm_Menu_Smart_Data into it, so to access its fields.
33 #define ELM_MENU_DATA(x) ((Elm_Menu_Smart_Data *) x)
36 * @def ELM_MENU_SMART_CLASS_VERSION
38 * Current version for Elementary menu @b base smart class, a value
39 * which goes to _Elm_Menu_Smart_Class::version.
43 #define ELM_MENU_SMART_CLASS_VERSION 1
46 * @def ELM_MENU_SMART_CLASS_INIT
48 * Initializer for a whole #Elm_Menu_Smart_Class structure, with
49 * @c NULL values on its specific fields.
51 * @param smart_class_init initializer to use for the "base" field
52 * (#Evas_Smart_Class).
54 * @see EVAS_SMART_CLASS_INIT_NULL
55 * @see EVAS_SMART_CLASS_INIT_NAME_VERSION
56 * @see ELM_MENU_SMART_CLASS_INIT_NULL
57 * @see ELM_MENU_SMART_CLASS_INIT_NAME_VERSION
61 #define ELM_MENU_SMART_CLASS_INIT(smart_class_init) \
62 {smart_class_init, ELM_MENU_SMART_CLASS_VERSION}
65 * @def ELM_MENU_SMART_CLASS_INIT_NULL
67 * Initializer to zero out a whole #Elm_Menu_Smart_Class structure.
69 * @see ELM_MENU_SMART_CLASS_INIT_NAME_VERSION
70 * @see ELM_MENU_SMART_CLASS_INIT
74 #define ELM_MENU_SMART_CLASS_INIT_NULL \
75 ELM_MENU_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
78 * @def ELM_MENU_SMART_CLASS_INIT_NAME_VERSION
80 * Initializer to zero out a whole #Elm_Menu_Smart_Class structure and
81 * set its name and version.
83 * This is similar to #ELM_MENU_SMART_CLASS_INIT_NULL, but it will
84 * also set the version field of #Elm_Menu_Smart_Class (base field)
85 * to the latest #ELM_MENU_SMART_CLASS_VERSION and name it to the
88 * It will keep a reference to the name field as a <c>"const char *"</c>,
89 * i.e., the name must be available while the structure is
90 * used (hint: static or global variable!) and must not be modified.
92 * @see ELM_MENU_SMART_CLASS_INIT_NULL
93 * @see ELM_MENU_SMART_CLASS_INIT
97 #define ELM_MENU_SMART_CLASS_INIT_NAME_VERSION(name) \
98 ELM_MENU_SMART_CLASS_INIT(ELM_WIDGET_SMART_CLASS_INIT_NAME_VERSION(name))
101 * Elementary menu base smart class. This inherits directly from
102 * #Elm_Widget_Smart_Class and is meant to build widgets extending the
103 * behavior of a menu.
105 * All of the functions listed on @ref Menu namespace will work for
106 * objects deriving from #Elm_Menu_Smart_Class.
108 typedef struct _Elm_Menu_Smart_Class
110 Elm_Widget_Smart_Class base;
112 int version; /**< Version of this smart class definition */
113 } Elm_Menu_Smart_Class;
116 * Base widget smart data extended with menu instance data.
118 typedef struct _Elm_Menu_Smart_Data Elm_Menu_Smart_Data;
119 struct _Elm_Menu_Smart_Data
121 Elm_Widget_Smart_Data base; /* base widget smart data as
122 * first member obligatory, as
123 * we're inheriting from it */
125 Evas_Object *hv, *bx, *location, *parent;
128 Evas_Coord xloc, yloc;
131 typedef struct _Elm_Menu_Item Elm_Menu_Item;
132 struct _Elm_Menu_Item
136 Elm_Menu_Item *parent;
137 Evas_Object *content;
138 const char *icon_str;
145 Evas_Object *hv, *bx, *location;
150 Eina_Bool separator : 1;
151 Eina_Bool selected : 1;
152 Eina_Bool object_item : 1;
159 EAPI extern const char ELM_MENU_SMART_NAME[];
160 EAPI const Elm_Menu_Smart_Class *elm_menu_smart_class_get(void);
162 #define ELM_MENU_DATA_GET(o, sd) \
163 Elm_Menu_Smart_Data * sd = evas_object_smart_data_get(o)
165 #define ELM_MENU_DATA_GET_OR_RETURN(o, ptr) \
166 ELM_MENU_DATA_GET(o, ptr); \
169 CRITICAL("No widget data for object %p (%s)", \
170 o, evas_object_type_get(o)); \
174 #define ELM_MENU_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
175 ELM_MENU_DATA_GET(o, ptr); \
178 CRITICAL("No widget data for object %p (%s)", \
179 o, evas_object_type_get(o)); \
183 #define ELM_MENU_CHECK(obj) \
184 if (!obj || !elm_widget_type_check((obj), ELM_MENU_SMART_NAME, __func__)) \
187 #define ELM_MENU_ITEM_CHECK(it) \
188 ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, ); \
189 ELM_MENU_CHECK(it->base.widget);
191 #define ELM_MENU_ITEM_CHECK_OR_RETURN(it, ...) \
192 ELM_WIDGET_ITEM_CHECK_OR_RETURN((Elm_Widget_Item *)it, __VA_ARGS__); \
193 ELM_MENU_CHECK(it->base.widget) __VA_ARGS__;