summaryrefslogtreecommitdiff
path: root/src/lib/edje/edje_convert.h
diff options
context:
space:
mode:
authorChidambar Zinnoury <chidambar.zinnoury@zefla.fr>2014-10-17 17:08:26 +0200
committerCedric BAIL <cedric@osg.samsung.com>2014-10-20 18:27:24 +0200
commitd7600d6b559f02d8aff410761487617a59587805 (patch)
treeec7bfd29998e28f59090457528829eb72419f930 /src/lib/edje/edje_convert.h
parent11d62ac4f3c2606f6b784f542fb5a6791bab65dd (diff)
edje: documentation for edje_convert.h.
Diffstat (limited to 'src/lib/edje/edje_convert.h')
-rw-r--r--src/lib/edje/edje_convert.h208
1 files changed, 123 insertions, 85 deletions
diff --git a/src/lib/edje/edje_convert.h b/src/lib/edje/edje_convert.h
index 4d0248a510..c37afd7bb8 100644
--- a/src/lib/edje/edje_convert.h
+++ b/src/lib/edje/edje_convert.h
@@ -1,72 +1,98 @@
1#ifndef EDJE_CONVERT_H__ 1#ifndef EDJE_CONVERT_H__
2# define EDJE_CONVERT_H__ 2# define EDJE_CONVERT_H__
3 3
4typedef struct _Old_Edje_Image_Directory Old_Edje_Image_Directory; 4typedef struct _Old_Edje_Image_Directory Old_Edje_Image_Directory; /**< An old Edje image directory */
5typedef struct _Old_Edje_Font_Directory Old_Edje_Font_Directory; 5typedef struct _Old_Edje_Font_Directory Old_Edje_Font_Directory; /**< An old Edje font directory */
6typedef struct _Old_Edje_External_Directory Old_Edje_External_Directory; 6typedef struct _Old_Edje_External_Directory Old_Edje_External_Directory; /**< An old Edje external directory */
7typedef struct _Old_Edje_Part Old_Edje_Part; 7typedef struct _Old_Edje_Part Old_Edje_Part; /**< An old Edje part */
8typedef struct _Old_Edje_Part_Collection Old_Edje_Part_Collection; 8typedef struct _Old_Edje_Part_Collection Old_Edje_Part_Collection; /**< An old Edje part collection */
9typedef struct _Old_Edje_Part_Description Old_Edje_Part_Description; 9typedef struct _Old_Edje_Part_Description Old_Edje_Part_Description; /**< An old Edje part description */
10typedef struct _Old_Edje_Part_Description_Spec_Image Old_Edje_Part_Description_Spec_Image; 10typedef struct _Old_Edje_Part_Description_Spec_Image Old_Edje_Part_Description_Spec_Image; /**< An old Edje part description image */
11typedef struct _Edje_Data Edje_Data; 11typedef struct _Edje_Data Edje_Data; /**< A key/value tuple */
12 12
13
14/**
15 * @struct _Edje_Data
16 * @brief A structure that stores a key/value tuple.
17 */
13struct _Edje_Data 18struct _Edje_Data
14{ 19{
15 const char *key; 20 const char *key; /**< key name */
16 char *value; 21 char *value; /**< contents value */
17}; 22};
18 23
19/*----------*/ 24/*----------*/
20 25
26/**
27 * @struct _Old_Edje_Font_Directory
28 * @brief A structure that stores old font directory entries.
29 */
21struct _Old_Edje_Font_Directory 30struct _Old_Edje_Font_Directory
22{ 31{
23 Eina_List *entries; /* a list of Edje_Font_Directory_Entry */ 32 Eina_List *entries; /**< a list of Edje_Font_Directory_Entry */
24}; 33};
25 34
35/**
36 * @struct _Old_Edje_Image_Directory
37 * @brief A structure that stores old image directory entries.
38 */
26struct _Old_Edje_Image_Directory 39struct _Old_Edje_Image_Directory
27{ 40{
28 Eina_List *entries; /* a list of Edje_Image_Directory_Entry */ 41 Eina_List *entries; /**< a list of Edje_Image_Directory_Entry */
29 Eina_List *sets; /* a list of Edje_Image_Directory_Set */ 42 Eina_List *sets; /**< a list of Edje_Image_Directory_Set */
30}; 43};
31 44
45/**
46 * @struct _Old_Edje_External_Directory
47 * @brief A structure that stores old external directory entries.
48 */
32struct _Old_Edje_External_Directory 49struct _Old_Edje_External_Directory
33{ 50{
34 Eina_List *entries; /* a list of Edje_External_Directory_Entry */ 51 Eina_List *entries; /**< a list of Edje_External_Directory_Entry */
35}; 52};
36 53
54/**
55 * @struct _Old_Edje_File
56 * @brief A structure that stores old Edje files information.
57 */
37struct _Old_Edje_File 58struct _Old_Edje_File
38{ 59{
39 const char *path; 60 const char *path; /**< path */
40 time_t mtime; 61 time_t mtime; /**< modification time */
41 62
42 Old_Edje_External_Directory *external_dir; 63 Old_Edje_External_Directory *external_dir; /**< external directory */
43 Old_Edje_Font_Directory *font_dir; 64 Old_Edje_Font_Directory *font_dir; /**< fonts directory */
44 Old_Edje_Image_Directory *image_dir; 65 Old_Edje_Image_Directory *image_dir; /**< images directory */
45 Edje_Part_Collection_Directory *collection_dir; 66 Edje_Part_Collection_Directory *collection_dir; /**< collection directory */
46 Eina_List *data; 67 Eina_List *data; /**< list of Edje_Data */
47 Eina_List *styles; 68 Eina_List *styles; /**< list of Edje_Style */
48 Eina_List *color_classes; 69 Eina_List *color_classes; /**< list of Edje_Color_Class */
49 70
50 const char *compiler; 71 const char *compiler; /**< compiler name */
51 int version; 72 int version; /**< Edje version */
52 int feature_ver; 73 int feature_ver; /**< features version */
53}; 74};
54 75
76/**
77 * @struct _Old_Edje_Part_Collection
78 * @brief A structure that stores old Edje part collection information.
79 */
55struct _Old_Edje_Part_Collection 80struct _Old_Edje_Part_Collection
56{ 81{
57 Eina_List *programs; /* a list of Edje_Program */ 82 Eina_List *programs; /**< a list of Edje_Program */
58 Eina_List *parts; /* a list of Edje_Part */ 83 Eina_List *parts; /**< a list of Edje_Part */
59 Eina_List *data; 84 Eina_List *data; /**< a list of Edje_Data */
60 85
61 int id; /* the collection id */ 86 int id; /**< the collection id */
62 87
63 Eina_Hash *alias; /* aliasing part*/ 88 Eina_Hash *alias; /**< aliasing part*/
64 89
65 struct { 90 struct {
66 Edje_Size min, max; 91 Edje_Size min; /**< minimum size */
92 Edje_Size max; /**< maximum size */
67 } prop; 93 } prop;
68 94
69 int references; 95 int references; /**< references count */
70#ifdef EDJE_PROGRAM_CACHE 96#ifdef EDJE_PROGRAM_CACHE
71 struct { 97 struct {
72 Eina_Hash *no_matches; 98 Eina_Hash *no_matches;
@@ -74,86 +100,98 @@ struct _Old_Edje_Part_Collection
74 } prog_cache; 100 } prog_cache;
75#endif 101#endif
76 102
77 Embryo_Program *script; /* all the embryo script code for this group */ 103 Embryo_Program *script; /**< all the embryo script code for this group */
78 const char *part; 104 const char *part; /**< part name */
79 105
80 unsigned char script_only; 106 unsigned char script_only; /**< script only */
81 107
82 unsigned char lua_script_only; 108 unsigned char lua_script_only; /** LUA script only */
83 109
84 unsigned char checked : 1; 110 unsigned char checked : 1; /**< contents checked and registered */
85}; 111};
86 112
113/**
114 * @struct _Old_Edje_Part
115 * @brief A structure that stores old Edje part information.
116 */
87struct _Old_Edje_Part 117struct _Old_Edje_Part
88{ 118{
89 const char *name; /* the name if any of the part */ 119 const char *name; /**< the name if any of the part */
90 Old_Edje_Part_Description *default_desc; /* the part descriptor for default */ 120 Old_Edje_Part_Description *default_desc; /**< the part descriptor for default */
91 Eina_List *other_desc; /* other possible descriptors */ 121 Eina_List *other_desc; /**< other possible descriptors */
92 const char *source, *source2, *source3, *source4, *source5, *source6; 122 const char *source, *source2, *source3, *source4, *source5, *source6;
93 int id; /* its id number */ 123 int id; /**< its id number */
94 int clip_to_id; /* the part id to clip this one to */ 124 int clip_to_id; /**< the part id to clip this one to */
95 Edje_Part_Dragable dragable; 125 Edje_Part_Dragable dragable; /**< dragable part */
96 Eina_List *items; /* packed items for box and table */ 126 Eina_List *items; /**< packed items for box and table */
97 unsigned char type; /* what type (image, rect, text) */ 127 unsigned char type; /**< what type (image, rect, text) */
98 unsigned char effect; /* 0 = plain... */ 128 unsigned char effect; /**< 0 = plain... */
99 unsigned char mouse_events; /* it will affect/respond to mouse events */ 129 unsigned char mouse_events; /**< it will affect/respond to mouse events */
100 unsigned char repeat_events; /* it will repeat events to objects below */ 130 unsigned char repeat_events; /**< it will repeat events to objects below */
101 Evas_Event_Flags ignore_flags; 131 Evas_Event_Flags ignore_flags; /**< ignore flags */
102 unsigned char scale; /* should certain properties scale with edje scale factor? */ 132 unsigned char scale; /**< should certain properties scale with edje scale factor? */
103 unsigned char precise_is_inside; 133 unsigned char precise_is_inside; /**< whether is precisely inside */
104 unsigned char use_alternate_font_metrics; 134 unsigned char use_alternate_font_metrics; /**< use alternate font metrics */
105 unsigned char pointer_mode; 135 unsigned char pointer_mode; /**< pointer mode */
106 unsigned char entry_mode; 136 unsigned char entry_mode; /**< entry mode */
107 unsigned char select_mode; 137 unsigned char select_mode; /**< entry selection mode */
108 unsigned char multiline; 138 unsigned char multiline; /**< multiline enabled */
109 Edje_Part_Api api; 139 Edje_Part_Api api; /**< part API */
110}; 140};
111 141
142/**
143 * @struct _Old_Edje_Part_Description_Spec_Image
144 * @brief A structure that stores old Edje part description image information.
145 */
112struct _Old_Edje_Part_Description_Spec_Image 146struct _Old_Edje_Part_Description_Spec_Image
113{ 147{
114 Eina_List *tween_list; /* list of Edje_Part_Image_Id */ 148 Eina_List *tween_list; /**< list of Edje_Part_Image_Id */
115 int id; /* the image id to use */ 149 int id; /**< the image id to use */
116 int scale_hint; /* evas scale hint */ 150 int scale_hint; /**< evas scale hint */
117 Eina_Bool set; /* if image condition it's content */ 151 Eina_Bool set; /**< if image condition it's content */
118 152
119 Edje_Part_Description_Spec_Border border; 153 Edje_Part_Description_Spec_Border border; /**< border settings */
120 Edje_Part_Description_Spec_Fill fill; 154 Edje_Part_Description_Spec_Fill fill; /**< fill settings */
121}; 155};
122 156
157/**
158 * @struct _Old_Edje_Part_Description
159 * @brief A structure that stores old Edje part description information.
160 */
123struct _Old_Edje_Part_Description 161struct _Old_Edje_Part_Description
124{ 162{
125 Edje_Part_Description_Common common; 163 Edje_Part_Description_Common common; /**< common part description */
126 Old_Edje_Part_Description_Spec_Image image; 164 Old_Edje_Part_Description_Spec_Image image; /**< image part description */
127 Edje_Part_Description_Spec_Text text; 165 Edje_Part_Description_Spec_Text text; /**< text part description */
128 Edje_Part_Description_Spec_Box box; 166 Edje_Part_Description_Spec_Box box; /**< box part description */
129 Edje_Part_Description_Spec_Table table; 167 Edje_Part_Description_Spec_Table table; /**< table part description */
130 168
131 Eina_List *external_params; /* parameters for external objects */ 169 Eina_List *external_params; /**< list of Edje_External_Param */
132}; 170};
133 171
134/** 172/**
135 * Convert old edje files into new edje files 173 * Convert old Edje files into new Edje files.
136 * 174 *
137 * @param file an Eet_File to write the new edje file 175 * @param file an Eet_File to write the new Edje file to
138 * @param oedf the old edje file 176 * @param oedf the old Edje file
139 * 177 *
140 * @return An Edje_File pointer to the converted file 178 * @return an Edje_File pointer to the converted file
141 */ 179 */
142Edje_File *_edje_file_convert(Eet_File *file, Old_Edje_File *oedf); 180Edje_File *_edje_file_convert(Eet_File *file, Old_Edje_File *oedf);
143 181
144/** 182/**
145 * Convert old edje part collection into the new edje file 183 * Convert old edje part collection into the new Edje file.
146 * 184 *
147 * @param file an Eet_File to write the new edje file 185 * @param file an Eet_File to write the new Edje file to
148 * @param oedc The old edje part collection 186 * @param oedc The Old edje part collection
149 * 187 *
150 * @return a new edje parte collection 188 * @return a new Edje part collection
151 */ 189 */
152Edje_Part_Collection *_edje_collection_convert(Edje_File *file, 190Edje_Part_Collection *_edje_collection_convert(Edje_File *file,
153 Old_Edje_Part_Collection *oedc); 191 Old_Edje_Part_Collection *oedc);
154 192
155/** 193/**
156 * Convert old edje part descripton into new format 194 * Convert old Edje part descripton into new format.
157 * 195 *
158 * @param type The edje par description common type 196 * @param type The edje par description common type
159 * @param ce an edje collection directory entry 197 * @param ce an edje collection directory entry
@@ -166,16 +204,16 @@ Edje_Part_Description_Common *_edje_description_convert(int type,
166 Old_Edje_Part_Description *oed); 204 Old_Edje_Part_Description *oed);
167 205
168/** 206/**
169 * Get the current edje file 207 * Get the current Edje file.
170 * 208 *
171 * @return the current edje file 209 * @return the current Edje file
172 */ 210 */
173const Edje_File *_edje_file_get(void); 211const Edje_File *_edje_file_get(void);
174 212
175/** 213/**
176 * Set the current edje file 214 * Set the current Edje file.
177 * 215 *
178 * @param edf the edje file to set 216 * @param edf the Edje file to set
179 * 217 *
180 */ 218 */
181void _edje_file_set(const Edje_File *edf); 219void _edje_file_set(const Edje_File *edf);