[access] call a callback function with information
[framework/uifw/elementary.git] / src / lib / elm_widget_separator.h
1 #ifndef ELM_WIDGET_SEPARATOR_H
2 #define ELM_WIDGET_SEPARATOR_H
3
4 #include "elm_widget_layout.h"
5
6 /**
7  * @addtogroup Widget
8  * @{
9  *
10  * @section elm-separator-class The Elementary Separator Class
11  *
12  * Elementary, besides having the @ref Separator widget, exposes its
13  * foundation -- the Elementary Separator Class -- in order to create other
14  * widgets which are a separator with some more logic on top.
15  */
16
17 /**
18  * @def ELM_SEPARATOR_CLASS
19  *
20  * Use this macro to cast whichever subclass of
21  * #Elm_Separator_Smart_Class into it, so to access its fields.
22  *
23  * @ingroup Widget
24  */
25 #define ELM_SEPARATOR_CLASS(x) ((Elm_Separator_Smart_Class *)x)
26
27 /**
28  * @def ELM_SEPARATOR_DATA
29  *
30  * Use this macro to cast whichever subdata of
31  * #Elm_Separator_Smart_Data into it, so to access its fields.
32  *
33  * @ingroup Widget
34  */
35 #define ELM_SEPARATOR_DATA(x)  ((Elm_Separator_Smart_Data *)x)
36
37 /**
38  * @def ELM_SEPARATOR_SMART_CLASS_VERSION
39  *
40  * Current version for Elementary separator @b base smart class, a value
41  * which goes to _Elm_Separator_Smart_Class::version.
42  *
43  * @ingroup Widget
44  */
45 #define ELM_SEPARATOR_SMART_CLASS_VERSION 1
46
47 /**
48  * @def ELM_SEPARATOR_SMART_CLASS_INIT
49  *
50  * Initializer for a whole #Elm_Separator_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_SEPARATOR_SMART_CLASS_INIT_NULL
59  * @see ELM_SEPARATOR_SMART_CLASS_INIT_NAME_VERSION
60  *
61  * @ingroup Widget
62  */
63 #define ELM_SEPARATOR_SMART_CLASS_INIT(smart_class_init) \
64   {smart_class_init, ELM_SEPARATOR_SMART_CLASS_VERSION}
65
66 /**
67  * @def ELM_SEPARATOR_SMART_CLASS_INIT_NULL
68  *
69  * Initializer to zero out a whole #Elm_Separator_Smart_Class structure.
70  *
71  * @see ELM_SEPARATOR_SMART_CLASS_INIT_NAME_VERSION
72  * @see ELM_SEPARATOR_SMART_CLASS_INIT
73  *
74  * @ingroup Widget
75  */
76 #define ELM_SEPARATOR_SMART_CLASS_INIT_NULL \
77   ELM_SEPARATOR_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
78
79 /**
80  * @def ELM_SEPARATOR_SMART_CLASS_INIT_NAME_VERSION
81  *
82  * Initializer to zero out a whole #Elm_Separator_Smart_Class structure and
83  * set its name and version.
84  *
85  * This is similar to #ELM_SEPARATOR_SMART_CLASS_INIT_NULL, but it will
86  * also set the version field of #Elm_Separator_Smart_Class (base field)
87  * to the latest #ELM_SEPARATOR_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_SEPARATOR_SMART_CLASS_INIT_NULL
95  * @see ELM_SEPARATOR_SMART_CLASS_INIT
96  *
97  * @ingroup Widget
98  */
99 #define ELM_SEPARATOR_SMART_CLASS_INIT_NAME_VERSION(name) \
100   ELM_SEPARATOR_SMART_CLASS_INIT                          \
101     (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
102
103 /**
104  * Elementary separator base smart class. This inherits directly from
105  * #Elm_Layout_Smart_Class and is meant to build widgets extending the
106  * behavior of a separator.
107  *
108  * All of the functions listed on @ref Separator namespace will work for
109  * objects deriving from #Elm_Separator_Smart_Class.
110  */
111 typedef struct _Elm_Separator_Smart_Class
112 {
113    Elm_Layout_Smart_Class base;
114
115    int                    version;    /**< Version of this smart class definition */
116 } Elm_Separator_Smart_Class;
117
118 /**
119  * Base layout smart data extended with separator instance data.
120  */
121 typedef struct _Elm_Separator_Smart_Data Elm_Separator_Smart_Data;
122 struct _Elm_Separator_Smart_Data
123 {
124    Elm_Layout_Smart_Data base;
125
126    Eina_Bool             horizontal : 1;
127 };
128
129 /**
130  * @}
131  */
132
133 EAPI extern const char ELM_SEPARATOR_SMART_NAME[];
134 EAPI const Elm_Separator_Smart_Class *elm_separator_smart_class_get(void);
135
136 #define ELM_SEPARATOR_DATA_GET(o, sd) \
137   Elm_Separator_Smart_Data * sd = evas_object_smart_data_get(o)
138
139 #define ELM_SEPARATOR_DATA_GET_OR_RETURN(o, ptr)     \
140   ELM_SEPARATOR_DATA_GET(o, ptr);                    \
141   if (!ptr)                                          \
142     {                                                \
143        CRITICAL("No widget data for object %p (%s)", \
144                 o, evas_object_type_get(o));         \
145        return;                                       \
146     }
147
148 #define ELM_SEPARATOR_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
149   ELM_SEPARATOR_DATA_GET(o, ptr);                         \
150   if (!ptr)                                               \
151     {                                                     \
152        CRITICAL("No widget data for object %p (%s)",      \
153                 o, evas_object_type_get(o));              \
154        return val;                                        \
155     }
156
157 #define ELM_SEPARATOR_CHECK(obj)                                      \
158   if (!obj || !elm_widget_type_check((obj), ELM_SEPARATOR_SMART_NAME, \
159                                      __func__))                       \
160     return
161
162 #endif