2017-09-18 01:01:10 -07:00
|
|
|
import eina_types;
|
|
|
|
|
efl: apply the stabilzed column of the efl api board
Summary:
The project https://phab.enlightenment.org/tag/efl_api/ has been used in
the last few weeks to figure out which classes can be stablized and
which cannot. This commit moves those dedicated classes outside beta.
And makes them stable.
ref T7601
ref T7600
ref T7599
ref T7598
ref T7597
ref T7596
ref T7594
ref T7593
ref T7591
ref T7590
ref T7589
ref T7588
ref T7583
ref T7582
ref T7581
ref T7576
ref T7570
ref T7567
ref T7564
ref T7563
ref T7560
ref T7559
ref T7672
ref T7584
ref T7577
ref T7571
ref T7558
ref T7555
ref T7554
ref T7553
ref T7512
ref T7511
Depends on D8272
Reviewers: cedric, stefan_schmidt, zmike, segfaultxavi
Reviewed By: segfaultxavi
Subscribers: #reviewers, #committers
Tags: #efl
Maniphest Tasks: T7672, T7601, T7600, T7599, T7598, T7597, T7596, T7594, T7593, T7591, T7590, T7589, T7588, T7584, T7583, T7582, T7581, T7577, T7576, T7571, T7570, T7567, T7564, T7563, T7560, T7559, T7558, T7555, T7554, T7553, T7512, T7511
Differential Revision: https://phab.enlightenment.org/D8273
2019-03-09 04:44:17 -08:00
|
|
|
interface Efl.Layout.Group
|
2017-08-03 01:50:01 -07:00
|
|
|
{
|
|
|
|
[[APIs representing static data from a group in an edje file.
|
2019-03-22 08:25:22 -07:00
|
|
|
|
|
|
|
@since 1.22
|
2017-08-03 01:50:01 -07:00
|
|
|
]]
|
|
|
|
methods {
|
|
|
|
@property group_size_min {
|
2019-09-13 03:25:49 -07:00
|
|
|
[[The minimum size specified -- as an EDC property -- for a
|
|
|
|
given Edje object
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
This property retrieves the obj object's minimum size values, as
|
|
|
|
declared in its EDC group definition. For instance, for an Edje
|
|
|
|
object of minimum size 100x100 pixels:
|
|
|
|
collections {
|
|
|
|
group {
|
|
|
|
name: "a_group";
|
|
|
|
min: 100 100;
|
2017-08-03 01:50:01 -07:00
|
|
|
}
|
2019-09-13 03:25:49 -07:00
|
|
|
}
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
Note: If the $min EDC property was not declared for this object,
|
|
|
|
this call will return 0x0.
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
Note: On failure, this function also return 0x0.
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
See also @.group_size_max.
|
|
|
|
]]
|
|
|
|
get {
|
2017-08-03 01:50:01 -07:00
|
|
|
}
|
|
|
|
values {
|
2017-09-18 01:01:10 -07:00
|
|
|
min: Eina.Size2D; [[The minimum size as set in EDC.]]
|
2017-08-03 01:50:01 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
@property group_size_max {
|
2019-09-13 03:25:49 -07:00
|
|
|
[[The maximum size specified -- as an EDC property -- for a
|
|
|
|
given Edje object
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
This property retrieves the object's maximum size values, as
|
|
|
|
declared in its EDC group definition. For instance, for an Edje
|
|
|
|
object of maximum size 100x100 pixels:
|
|
|
|
collections {
|
|
|
|
group {
|
|
|
|
name: "a_group";
|
|
|
|
max: 100 100;
|
2017-08-03 01:50:01 -07:00
|
|
|
}
|
2019-09-13 03:25:49 -07:00
|
|
|
}
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
Note: If the $max EDC property was not declared for the object,
|
|
|
|
this call will return the maximum size a given Edje object may
|
|
|
|
have, for each axis.
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
Note: On failure, this function will return 0x0.
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
See also @.group_size_min.
|
|
|
|
]]
|
|
|
|
get {
|
2017-08-03 01:50:01 -07:00
|
|
|
}
|
|
|
|
values {
|
2017-09-18 01:01:10 -07:00
|
|
|
max: Eina.Size2D; [[The maximum size as set in EDC.]]
|
2017-08-03 01:50:01 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
@property group_data {
|
2019-09-13 03:25:49 -07:00
|
|
|
[[The EDC data field's value from a given Edje object's group.
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
This property represents an EDC data field's value, which is declared
|
|
|
|
on the objects building EDC file, under its group. EDC data blocks
|
|
|
|
are most commonly used to pass arbitrary parameters from an
|
|
|
|
application's theme to its code.
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
EDC data fields always hold strings as values, hence the return
|
|
|
|
type of this function. Check the complete "syntax reference" for
|
|
|
|
EDC files.
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
This is how a data item is defined in EDC:
|
|
|
|
collections {
|
|
|
|
group {
|
|
|
|
name: "a_group";
|
|
|
|
data {
|
|
|
|
item: "key1" "value1";
|
|
|
|
item: "key2" "value2";
|
2017-08-03 01:50:01 -07:00
|
|
|
}
|
|
|
|
}
|
2019-09-13 03:25:49 -07:00
|
|
|
}
|
2017-08-03 01:50:01 -07:00
|
|
|
|
2019-09-13 03:25:49 -07:00
|
|
|
Warning: Do not confuse this call with edje_file_data_get(), which
|
|
|
|
queries for a global EDC data field on an EDC declaration file.
|
|
|
|
]]
|
|
|
|
get {
|
2017-08-03 01:50:01 -07:00
|
|
|
}
|
|
|
|
keys {
|
|
|
|
key: string; [[The data field's key string]]
|
|
|
|
}
|
|
|
|
values {
|
|
|
|
val: string; [[The data's value string.]]
|
|
|
|
}
|
|
|
|
}
|
2018-01-15 00:27:10 -08:00
|
|
|
@property part_exist {
|
|
|
|
[[Whether the given part exists in this group.
|
|
|
|
|
|
|
|
This is mostly equivalent to verifying the part type on the object
|
|
|
|
as would be done in C as follows:
|
|
|
|
(efl_canvas_layout_part_type_get(efl_part(obj, "partname")) !=
|
|
|
|
EFL_CANVAS_LAYOUT_PART_TYPE_NONE)
|
|
|
|
|
|
|
|
The differences are that will silently return $false if the part
|
|
|
|
does not exist, and this will return $true if the part is of type
|
|
|
|
$SPACER in the EDC file ($SPACER parts have type $NONE).
|
|
|
|
|
2020-03-16 05:53:03 -07:00
|
|
|
See also @Efl.Canvas.Layout_Part_Type_Provider.part_type.
|
2018-01-15 00:27:10 -08:00
|
|
|
]]
|
2019-10-07 07:40:50 -07:00
|
|
|
get {}
|
2018-01-15 00:27:10 -08:00
|
|
|
keys {
|
2019-05-26 08:25:15 -07:00
|
|
|
part: string; [[The part name to check.]]
|
2018-01-15 00:27:10 -08:00
|
|
|
}
|
|
|
|
values {
|
|
|
|
exists: bool; [[$true if the part exists, $false otherwise.]]
|
|
|
|
}
|
|
|
|
}
|
2017-08-03 01:50:01 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|