1 #ifndef ELM_WIDGET_PANES_H
2 #define ELM_WIDGET_PANES_H
4 #include "elm_widget_layout.h"
10 * @section elm-panes-class The Elementary Panes Class
12 * Elementary, besides having the @ref Panes widget, exposes its
13 * foundation -- the Elementary Panes Class -- in order to create other
14 * widgets which are a panes with some more logic on top.
18 * @def ELM_PANES_CLASS
20 * Use this macro to cast whichever subclass of
21 * #Elm_Panes_Smart_Class into it, so to access its fields.
25 #define ELM_PANES_CLASS(x) ((Elm_Panes_Smart_Class *)x)
30 * Use this macro to cast whichever subdata of
31 * #Elm_Panes_Smart_Data into it, so to access its fields.
35 #define ELM_PANES_DATA(x) ((Elm_Panes_Smart_Data *)x)
38 * @def ELM_PANES_SMART_CLASS_VERSION
40 * Current version for Elementary panes @b base smart class, a value
41 * which goes to _Elm_Panes_Smart_Class::version.
45 #define ELM_PANES_SMART_CLASS_VERSION 1
48 * @def ELM_PANES_SMART_CLASS_INIT
50 * Initializer for a whole #Elm_Panes_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_PANES_SMART_CLASS_INIT_NULL
59 * @see ELM_PANES_SMART_CLASS_INIT_NAME_VERSION
63 #define ELM_PANES_SMART_CLASS_INIT(smart_class_init) \
64 {smart_class_init, ELM_PANES_SMART_CLASS_VERSION}
67 * @def ELM_PANES_SMART_CLASS_INIT_NULL
69 * Initializer to zero out a whole #Elm_Panes_Smart_Class structure.
71 * @see ELM_PANES_SMART_CLASS_INIT_NAME_VERSION
72 * @see ELM_PANES_SMART_CLASS_INIT
76 #define ELM_PANES_SMART_CLASS_INIT_NULL \
77 ELM_PANES_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
80 * @def ELM_PANES_SMART_CLASS_INIT_NAME_VERSION
82 * Initializer to zero out a whole #Elm_Panes_Smart_Class structure and
83 * set its name and version.
85 * This is similar to #ELM_PANES_SMART_CLASS_INIT_NULL, but it will
86 * also set the version field of #Elm_Panes_Smart_Class (base field)
87 * to the latest #ELM_PANES_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_PANES_SMART_CLASS_INIT_NULL
95 * @see ELM_PANES_SMART_CLASS_INIT
99 #define ELM_PANES_SMART_CLASS_INIT_NAME_VERSION(name) \
100 ELM_PANES_SMART_CLASS_INIT \
101 (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
104 * Elementary panes base smart class. This inherits directly from
105 * #Elm_Layout_Smart_Class and is meant to build widgets extending the
106 * behavior of a panes.
108 * All of the functions listed on @ref Panes namespace will work for
109 * objects deriving from #Elm_Panes_Smart_Class.
111 typedef struct _Elm_Panes_Smart_Class
113 Elm_Layout_Smart_Class base;
115 int version; /**< Version of this smart class definition */
116 } Elm_Panes_Smart_Class;
119 * Base layout smart data extended with panes instance data.
121 typedef struct _Elm_Panes_Smart_Data Elm_Panes_Smart_Data;
122 struct _Elm_Panes_Smart_Data
124 Elm_Layout_Smart_Data base;
133 Eina_Bool double_clicked : 1;
134 Eina_Bool horizontal : 1;
142 EAPI extern const char ELM_PANES_SMART_NAME[];
143 EAPI const Elm_Panes_Smart_Class
144 *elm_panes_smart_class_get(void);
146 #define ELM_PANES_DATA_GET(o, sd) \
147 Elm_Panes_Smart_Data * sd = evas_object_smart_data_get(o)
149 #define ELM_PANES_DATA_GET_OR_RETURN(o, ptr) \
150 ELM_PANES_DATA_GET(o, ptr); \
153 CRITICAL("No widget data for object %p (%s)", \
154 o, evas_object_type_get(o)); \
158 #define ELM_PANES_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
159 ELM_PANES_DATA_GET(o, ptr); \
162 CRITICAL("No widget data for object %p (%s)", \
163 o, evas_object_type_get(o)); \
167 #define ELM_PANES_CHECK(obj) \
168 if (!obj || !elm_widget_type_check \
169 ((obj), ELM_PANES_SMART_NAME, __func__)) \