efl

1
import eina_types;
2

3
interface Efl.Layout.Group
4
{
5
   [[APIs representing static data from a group in an edje file.
6

7
    @since 1.22
8
   ]]
9
   methods {
10
      @property group_size_min {
11
         [[The minimum size specified -- as an EDC property -- for a
12
           given Edje object
13

14
           This property retrieves the obj object's minimum size values, as
15
           declared in its EDC group definition. For instance, for an Edje
16
           object of minimum size 100x100 pixels:
17
           collections {
18
              group {
19
                 name: "a_group";
20
                 min: 100 100;
21
              }
22
           }
23

24
           Note: If the $min EDC property was not declared for this object,
25
           this call will return 0x0.
26

27
           Note: On failure, this function also return 0x0.
28

29
           See also @.group_size_max.
30
         ]]
31
         get {
32
         }
33
         values {
34
            min: Eina.Size2D; [[The minimum size as set in EDC.]]
35
         }
36
      }
37
      @property group_size_max {
38
         [[The maximum size specified -- as an EDC property -- for a
39
           given Edje object
40

41
           This property retrieves the object's maximum size values, as
42
           declared in its EDC group definition. For instance, for an Edje
43
           object of maximum size 100x100 pixels:
44
           collections {
45
              group {
46
                 name: "a_group";
47
                 max: 100 100;
48
              }
49
           }
50

51
           Note: If the $max EDC property was not declared for the object,
52
           this call will return the maximum size a given Edje object may
53
           have, for each axis.
54

55
           Note: On failure, this function will return 0x0.
56

57
           See also @.group_size_min.
58
         ]]
59
         get {
60
         }
61
         values {
62
            max: Eina.Size2D; [[The maximum size as set in EDC.]]
63
         }
64
      }
65
      @property group_data {
66
         [[The EDC data field's value from a given Edje object's group.
67

68
           This property represents an EDC data field's value, which is declared
69
           on the objects building EDC file, under its group. EDC data blocks
70
           are most commonly used to pass arbitrary parameters from an
71
           application's theme to its code.
72

73
           EDC data fields always hold  strings as values, hence the return
74
           type of this function. Check the complete "syntax reference" for
75
           EDC files.
76

77
           This is how a data item is defined in EDC:
78
           collections {
79
              group {
80
                 name: "a_group";
81
                 data {
82
                    item: "key1" "value1";
83
                    item: "key2" "value2";
84
                 }
85
              }
86
           }
87

88
           Warning: Do not confuse this call with edje_file_data_get(), which
89
           queries for a global EDC data field on an EDC declaration file.
90
         ]]
91
         get {
92
         }
93
         keys {
94
            key: string; [[The data field's key string]]
95
         }
96
         values {
97
            val: string; [[The data's value string.]]
98
         }
99
      }
100
      @property part_exist {
101
         [[Whether the given part exists in this group.
102

103
           This is mostly equivalent to verifying the part type on the object
104
           as would be done in C as follows:
105
             (efl_canvas_layout_part_type_get(efl_part(obj, "partname")) !=
106
                EFL_CANVAS_LAYOUT_PART_TYPE_NONE)
107

108
           The differences are that will silently return $false if the part
109
           does not exist, and this will return $true if the part is of type
110
           $SPACER in the EDC file ($SPACER parts have type $NONE).
111

112
           See also @Efl.Canvas.Layout_Part_Type_Provider.part_type.
113
         ]]
114
         get {}
115
         keys {
116
            part: string; [[The part name to check.]]
117
         }
118
         values {
119
            exists: bool; [[$true if the part exists, $false otherwise.]]
120
         }
121
      }
122
   }
123
}
124

125