summaryrefslogtreecommitdiff
path: root/src/lib/evas/canvas/evas_object.eo
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/evas/canvas/evas_object.eo')
-rw-r--r--src/lib/evas/canvas/evas_object.eo85
1 files changed, 63 insertions, 22 deletions
diff --git a/src/lib/evas/canvas/evas_object.eo b/src/lib/evas/canvas/evas_object.eo
index 8b67c06..b7166ed 100644
--- a/src/lib/evas/canvas/evas_object.eo
+++ b/src/lib/evas/canvas/evas_object.eo
@@ -1,6 +1,7 @@
1abstract Evas_Object (Eo_Base, Evas_Common_Interface) 1abstract Evas_Object (Eo_Base, Evas_Common_Interface)
2{ 2{
3 eo_prefix: evas_obj; 3 eo_prefix: evas_obj;
4 data: Evas_Object_Protected_Data;
4 properties { 5 properties {
5 size_hint_max { 6 size_hint_max {
6 set { 7 set {
@@ -76,9 +77,11 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
76 visibility { 77 visibility {
77 set { 78 set {
78 /*@ Makes the given Evas object visible or invisible. */ 79 /*@ Makes the given Evas object visible or invisible. */
80 legacy null;
79 } 81 }
80 get { 82 get {
81 /*@ Retrieves whether or not the given Evas object is visible. */ 83 /*@ Retrieves whether or not the given Evas object is visible. */
84 legacy evas_object_visible_get;
82 } 85 }
83 values { 86 values {
84 Eina_Bool v; /*@ @c EINA_TRUE if to make the object visible, @c EINA_FALSE otherwise */ 87 Eina_Bool v; /*@ @c EINA_TRUE if to make the object visible, @c EINA_FALSE otherwise */
@@ -117,7 +120,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
117 See the full @ref Example_Evas_Object_Manipulation "example". */ 120 See the full @ref Example_Evas_Object_Manipulation "example". */
118 } 121 }
119 values { 122 values {
120 const char* type; /*@ in */ 123 const char *type; /*@ in */
121 } 124 }
122 } 125 }
123 size_hint_min { 126 size_hint_min {
@@ -304,7 +307,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
304 @see evas_object_map_set() */ 307 @see evas_object_map_set() */
305 } 308 }
306 values { 309 values {
307 const Evas_Map* map; /*@ new map to use */ 310 const Evas_Map *map; /*@ new map to use */
308 } 311 }
309 } 312 }
310 size_hint_aspect { 313 size_hint_aspect {
@@ -480,7 +483,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
480 See the full @ref Example_Evas_Object_Manipulation "example". */ 483 See the full @ref Example_Evas_Object_Manipulation "example". */
481 } 484 }
482 values { 485 values {
483 Evas_Object* clip; /*@ The object to clip @p obj by */ 486 Evas_Object *clip @nonull; /*@ The object to clip @p obj by */
484 } 487 }
485 } 488 }
486 size_hint_padding { 489 size_hint_padding {
@@ -656,7 +659,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
656 See the full @ref Example_Evas_Events "example". */ 659 See the full @ref Example_Evas_Events "example". */
657 } 660 }
658 values { 661 values {
659 const char* name; /*@ The given name. */ 662 const char *name; /*@ The given name. */
660 } 663 }
661 } 664 }
662 scale { 665 scale {
@@ -725,6 +728,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
725 size { 728 size {
726 set { 729 set {
727 /*@ Changes the size of the given Evas object. */ 730 /*@ Changes the size of the given Evas object. */
731 legacy evas_object_resize;
728 } 732 }
729 get { 733 get {
730 /*@ Retrieves the (rectangular) size of the given Evas object. */ 734 /*@ Retrieves the (rectangular) size of the given Evas object. */
@@ -786,8 +790,10 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
786 } 790 }
787 is_frame_object { 791 is_frame_object {
788 set { 792 set {
793 /*@ @since 1.2 */
789 } 794 }
790 get { 795 get {
796 /*@ @since 1.2 */
791 } 797 }
792 values { 798 values {
793 Eina_Bool is_frame; /*@ in */ 799 Eina_Bool is_frame; /*@ in */
@@ -1007,6 +1013,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1007 position { 1013 position {
1008 set { 1014 set {
1009 /*@ Move the given Evas object to the given location inside its canvas' viewport. */ 1015 /*@ Move the given Evas object to the given location inside its canvas' viewport. */
1016 legacy evas_object_move;
1010 } 1017 }
1011 get { 1018 get {
1012 /*@ Retrieves the position of the given Evas object. */ 1019 /*@ Retrieves the position of the given Evas object. */
@@ -1093,7 +1100,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1093 @see evas_object_smart_data_set() 1100 @see evas_object_smart_data_set()
1094 1101
1095 @ingroup Evas_Smart_Object_Group */ 1102 @ingroup Evas_Smart_Object_Group */
1096 return void*; 1103 return void * @warn_unused;
1097 } 1104 }
1098 } 1105 }
1099 smart_clipped_clipper { 1106 smart_clipped_clipper {
@@ -1107,7 +1114,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1107 properties, like colors. 1114 properties, like colors.
1108 1115
1109 @see evas_object_smart_clipped_smart_add() */ 1116 @see evas_object_smart_clipped_smart_add() */
1110 return Evas_Object*; 1117 return Evas_Object * @warn_unused;
1111 } 1118 }
1112 } 1119 }
1113 below { 1120 below {
@@ -1124,7 +1131,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1124 @see evas_object_layer_get() 1131 @see evas_object_layer_get()
1125 @see evas_object_layer_set() 1132 @see evas_object_layer_set()
1126 @see evas_object_below_get() */ 1133 @see evas_object_below_get() */
1127 return Evas_Object*; 1134 return Evas_Object * @warn_unused;
1128 } 1135 }
1129 } 1136 }
1130 clipees { 1137 clipees {
@@ -1166,7 +1173,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1166 evas_object_show(obj_tmp); 1173 evas_object_show(obj_tmp);
1167 } 1174 }
1168 @endcode */ 1175 @endcode */
1169 return const Eina_List*; 1176 return const Eina_List * @warn_unused;
1170 } 1177 }
1171 } 1178 }
1172 smart_parent { 1179 smart_parent {
@@ -1178,7 +1185,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1178 obj is not a smart member of any 1185 obj is not a smart member of any
1179 1186
1180 @ingroup Evas_Smart_Object_Group */ 1187 @ingroup Evas_Smart_Object_Group */
1181 return Evas_Object*; 1188 return Evas_Object * @warn_unused;
1182 } 1189 }
1183 } 1190 }
1184 above { 1191 above {
@@ -1195,7 +1202,28 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1195 @see evas_object_layer_get() 1202 @see evas_object_layer_get()
1196 @see evas_object_layer_set() 1203 @see evas_object_layer_set()
1197 @see evas_object_below_get() */ 1204 @see evas_object_below_get() */
1198 return Evas_Object*; 1205 return Evas_Object * @warn_unused;
1206 }
1207 }
1208 size_hint_display_mode {
1209 get {
1210 /*@
1211 Retrieves the hints for an object's display mode
1212
1213 These are hints on the display mode @p obj. This is
1214 not a size enforcement in any way, it's just a hint that can be
1215 used whenever appropriate.
1216 This mode can be used object's display mode like commpress or expand */
1217 }
1218 set {
1219 /*@
1220 Sets the hints for an object's disply mode
1221
1222 This is not a size enforcement in any way, it's just a hint that
1223 can be used whenever appropriate.*/
1224 }
1225 values {
1226 Evas_Display_Mode dispmode; /*@ display mode hint */
1199 } 1227 }
1200 } 1228 }
1201 } 1229 }
@@ -1206,8 +1234,9 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1206 1234
1207 @return EINA_TRUE if @p obj clip any object. 1235 @return EINA_TRUE if @p obj clip any object.
1208 @since 1.8 */ 1236 @since 1.8 */
1237
1209 const; 1238 const;
1210 return Eina_Bool; 1239 return Eina_Bool @warn_unused;
1211 } 1240 }
1212 key_grab { 1241 key_grab {
1213 /*@ 1242 /*@
@@ -1249,9 +1278,10 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1249 @see evas_object_focus_get 1278 @see evas_object_focus_get
1250 @see evas_focus_get 1279 @see evas_focus_get
1251 @see evas_key_modifier_add */ 1280 @see evas_key_modifier_add */
1252 return Eina_Bool; 1281
1282 return Eina_Bool @warn_unused;
1253 params { 1283 params {
1254 @in const char* keyname; /*@ the key to request events for. */ 1284 @in const char *keyname @nonull; /*@ the key to request events for. */
1255 @in Evas_Modifier_Mask modifiers; /*@ a mask of modifiers that must be present to 1285 @in Evas_Modifier_Mask modifiers; /*@ a mask of modifiers that must be present to
1256 trigger the event. */ 1286 trigger the event. */
1257 @in Evas_Modifier_Mask not_modifiers; /*@ a mask of modifiers that must @b not be present 1287 @in Evas_Modifier_Mask not_modifiers; /*@ a mask of modifiers that must @b not be present
@@ -1283,8 +1313,9 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1283 @see evas_object_layer_get() 1313 @see evas_object_layer_get()
1284 @see evas_object_layer_set() 1314 @see evas_object_layer_set()
1285 @see evas_object_stack_below() */ 1315 @see evas_object_stack_below() */
1316
1286 params { 1317 params {
1287 @in Evas_Object* below; /*@ the object below which to stack */ 1318 @in Evas_Object *below @nonull; /*@ the object below which to stack */
1288 } 1319 }
1289 } 1320 }
1290 raise { 1321 raise {
@@ -1297,6 +1328,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1297 @see evas_object_stack_above() 1328 @see evas_object_stack_above()
1298 @see evas_object_stack_below() 1329 @see evas_object_stack_below()
1299 @see evas_object_lower() */ 1330 @see evas_object_lower() */
1331
1300 } 1332 }
1301 stack_above { 1333 stack_above {
1302 /*@ 1334 /*@
@@ -1321,8 +1353,9 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1321 @see evas_object_layer_get() 1353 @see evas_object_layer_get()
1322 @see evas_object_layer_set() 1354 @see evas_object_layer_set()
1323 @see evas_object_stack_below() */ 1355 @see evas_object_stack_below() */
1356
1324 params { 1357 params {
1325 @in Evas_Object* above; /*@ the object above which to stack */ 1358 @in Evas_Object *above @nonull; /*@ the object above which to stack */
1326 } 1359 }
1327 } 1360 }
1328 smart_type_check { 1361 smart_type_check {
@@ -1349,10 +1382,11 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1349 @see eo_isa 1382 @see eo_isa
1350 1383
1351 @ingroup Evas_Smart_Object_Group */ 1384 @ingroup Evas_Smart_Object_Group */
1385
1352 const; 1386 const;
1353 return Eina_Bool; 1387 return Eina_Bool @warn_unused;
1354 params { 1388 params {
1355 @in const char* type; /*@ The @b name (type) of the smart class to check for */ 1389 @in const char *type @nonull; /*@ The @b name (type) of the smart class to check for */
1356 } 1390 }
1357 } 1391 }
1358 name_child_find { 1392 name_child_find {
@@ -1371,10 +1405,11 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1371 @since 1.2 1405 @since 1.2
1372 1406
1373 @ingroup Evas_Object_Group_Find */ 1407 @ingroup Evas_Object_Group_Find */
1408
1374 const; 1409 const;
1375 return Evas_Object*; 1410 return Evas_Object * @warn_unused;
1376 params { 1411 params {
1377 @in const char* name; /*@ The given name. */ 1412 @in const char *name; /*@ The given name. */
1378 @in int recurse; /*@ Set to the number of child levels to recurse (0 == don't recurse, 1 == only look at the children of @p obj or their immediate children, but no further etc.). */ 1413 @in int recurse; /*@ Set to the number of child levels to recurse (0 == don't recurse, 1 == only look at the children of @p obj or their immediate children, but no further etc.). */
1379 } 1414 }
1380 } 1415 }
@@ -1396,8 +1431,9 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1396 @see evas_object_focus_set 1431 @see evas_object_focus_set
1397 @see evas_object_focus_get 1432 @see evas_object_focus_get
1398 @see evas_focus_get */ 1433 @see evas_focus_get */
1434
1399 params { 1435 params {
1400 @in const char* keyname; /*@ the key the grab is set for. */ 1436 @in const char *keyname @nonull; /*@ the key the grab is set for. */
1401 @in Evas_Modifier_Mask modifiers; /*@ a mask of modifiers that must be present to 1437 @in Evas_Modifier_Mask modifiers; /*@ a mask of modifiers that must be present to
1402 trigger the event. */ 1438 trigger the event. */
1403 @in Evas_Modifier_Mask not_modifiers; /*@ a mask of modifiers that must not not be 1439 @in Evas_Modifier_Mask not_modifiers; /*@ a mask of modifiers that must not not be
@@ -1414,6 +1450,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1414 @see evas_object_stack_above() 1450 @see evas_object_stack_above()
1415 @see evas_object_stack_below() 1451 @see evas_object_stack_below()
1416 @see evas_object_raise() */ 1452 @see evas_object_raise() */
1453
1417 } 1454 }
1418 clip_unset { 1455 clip_unset {
1419 /*@ 1456 /*@
@@ -1426,6 +1463,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1426 1463
1427 See also evas_object_clip_set() (for an example), 1464 See also evas_object_clip_set() (for an example),
1428 evas_object_clipees_get() and evas_object_clip_get(). */ 1465 evas_object_clipees_get() and evas_object_clip_get(). */
1466
1429 } 1467 }
1430 smart_move_children_relative { 1468 smart_move_children_relative {
1431 /*@ 1469 /*@
@@ -1439,6 +1477,7 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1439 1477
1440 @note Clipped smart objects already make use of this function on 1478 @note Clipped smart objects already make use of this function on
1441 their @c move() smart function definition. */ 1479 their @c move() smart function definition. */
1480
1442 params { 1481 params {
1443 @in Evas_Coord dx; /*@ horizontal offset (delta). */ 1482 @in Evas_Coord dx; /*@ horizontal offset (delta). */
1444 @in Evas_Coord dy; /*@ vertical offset (delta). */ 1483 @in Evas_Coord dy; /*@ vertical offset (delta). */
@@ -1456,10 +1495,11 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1456 @see eo_isa 1495 @see eo_isa
1457 1496
1458 @ingroup Evas_Smart_Object_Group */ 1497 @ingroup Evas_Smart_Object_Group */
1498
1459 const; 1499 const;
1460 return Eina_Bool; 1500 return Eina_Bool @warn_unused;
1461 params { 1501 params {
1462 @in const char* type; /*@ The type (name string) to check for. Must be the name */ 1502 @in const char *type @nonull; /*@ The type (name string) to check for. Must be the name */
1463 } 1503 }
1464 } 1504 }
1465 } 1505 }
@@ -1469,4 +1509,5 @@ abstract Evas_Object (Eo_Base, Evas_Common_Interface)
1469 Eo_Base::dbg_info_get; 1509 Eo_Base::dbg_info_get;
1470 Evas_Common_Interface::evas::get; 1510 Evas_Common_Interface::evas::get;
1471 } 1511 }
1512
1472} 1513}