1 #ifndef ELM_WIDGET_FILESELECTOR_H
2 #define ELM_WIDGET_FILESELECTOR_H
4 #include "elm_widget_layout.h"
10 * @section elm-fileselector-class The Elementary Fileselector Class
12 * Elementary, besides having the @ref Fileselector widget, exposes its
13 * foundation -- the Elementary Fileselector Class -- in order to create other
14 * widgets which are a fileselector with some more logic on top.
18 * @def ELM_FILESELECTOR_CLASS
20 * Use this macro to cast whichever subclass of
21 * #Elm_Fileselector_Smart_Class into it, so to access its fields.
25 #define ELM_FILESELECTOR_CLASS(x) ((Elm_Fileselector_Smart_Class *)x)
28 * @def ELM_FILESELECTOR_DATA
30 * Use this macro to cast whichever subdata of
31 * #Elm_Fileselector_Smart_Data into it, so to access its fields.
35 #define ELM_FILESELECTOR_DATA(x) ((Elm_Fileselector_Smart_Data *)x)
38 * @def ELM_FILESELECTOR_SMART_CLASS_VERSION
40 * Current version for Elementary fileselector @b base smart class, a value
41 * which goes to _Elm_Fileselector_Smart_Class::version.
45 #define ELM_FILESELECTOR_SMART_CLASS_VERSION 1
48 * @def ELM_FILESELECTOR_SMART_CLASS_INIT
50 * Initializer for a whole #Elm_Fileselector_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_FILESELECTOR_SMART_CLASS_INIT_NULL
59 * @see ELM_FILESELECTOR_SMART_CLASS_INIT_NAME_VERSION
63 #define ELM_FILESELECTOR_SMART_CLASS_INIT(smart_class_init) \
64 {smart_class_init, ELM_FILESELECTOR_SMART_CLASS_VERSION}
67 * @def ELM_FILESELECTOR_SMART_CLASS_INIT_NULL
69 * Initializer to zero out a whole #Elm_Fileselector_Smart_Class structure.
71 * @see ELM_FILESELECTOR_SMART_CLASS_INIT_NAME_VERSION
72 * @see ELM_FILESELECTOR_SMART_CLASS_INIT
76 #define ELM_FILESELECTOR_SMART_CLASS_INIT_NULL \
77 ELM_FILESELECTOR_SMART_CLASS_INIT(EVAS_SMART_CLASS_INIT_NULL)
80 * @def ELM_FILESELECTOR_SMART_CLASS_INIT_NAME_VERSION
82 * Initializer to zero out a whole #Elm_Fileselector_Smart_Class structure and
83 * set its name and version.
85 * This is similar to #ELM_FILESELECTOR_SMART_CLASS_INIT_NULL, but it will
86 * also set the version field of #Elm_Fileselector_Smart_Class (base field)
87 * to the latest #ELM_FILESELECTOR_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_FILESELECTOR_SMART_CLASS_INIT_NULL
95 * @see ELM_FILESELECTOR_SMART_CLASS_INIT
99 #define ELM_FILESELECTOR_SMART_CLASS_INIT_NAME_VERSION(name) \
100 ELM_FILESELECTOR_SMART_CLASS_INIT \
101 (ELM_LAYOUT_SMART_CLASS_INIT_NAME_VERSION(name))
104 * Elementary fileselector base smart class. This inherits directly from
105 * #Elm_Layout_Smart_Class and is meant to build widgets extending the
106 * behavior of a fileselector.
108 * All of the functions listed on @ref Fileselector namespace will work for
109 * objects deriving from #Elm_Fileselector_Smart_Class.
111 typedef struct _Elm_Fileselector_Smart_Class
113 Elm_Layout_Smart_Class base;
115 int version; /**< Version of this smart class definition */
116 } Elm_Fileselector_Smart_Class;
119 * Base layout smart data extended with fileselector instance data.
121 typedef struct _Elm_Fileselector_Smart_Data Elm_Fileselector_Smart_Data;
122 struct _Elm_Fileselector_Smart_Data
124 Elm_Layout_Smart_Data base;
128 Evas_Object *filename_entry;
129 Evas_Object *path_entry;
130 Evas_Object *files_list;
131 Evas_Object *files_grid;
132 Evas_Object *up_button;
133 Evas_Object *home_button;
134 Evas_Object *spinner;
135 Evas_Object *ok_button;
136 Evas_Object *cancel_button;
139 const char *selection;
140 Ecore_Idler *sel_idler;
142 const char *path_separator;
148 Elm_Fileselector_Mode mode;
150 Eina_Bool only_folder : 1;
151 Eina_Bool expand : 1;
160 typedef struct _Listing_Request Listing_Request;
161 struct _Listing_Request
163 Elm_Fileselector_Smart_Data *sd;
164 Elm_Object_Item *parent_it;
176 } Elm_Fileselector_Type;
182 EAPI extern const char ELM_FILESELECTOR_SMART_NAME[];
183 EAPI const Elm_Fileselector_Smart_Class *elm_fileselector_smart_class_get(void);
185 #define ELM_FILESELECTOR_DATA_GET(o, sd) \
186 Elm_Fileselector_Smart_Data * sd = evas_object_smart_data_get(o)
188 #define ELM_FILESELECTOR_DATA_GET_OR_RETURN(o, ptr) \
189 ELM_FILESELECTOR_DATA_GET(o, ptr); \
192 CRITICAL("No widget data for object %p (%s)", \
193 o, evas_object_type_get(o)); \
197 #define ELM_FILESELECTOR_DATA_GET_OR_RETURN_VAL(o, ptr, val) \
198 ELM_FILESELECTOR_DATA_GET(o, ptr); \
201 CRITICAL("No widget data for object %p (%s)", \
202 o, evas_object_type_get(o)); \
206 #define ELM_FILESELECTOR_CHECK(obj) \
207 if (!obj || !elm_widget_type_check \
208 ((obj), ELM_FILESELECTOR_SMART_NAME, __func__)) \