orbea
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

edje_cc: add missing default values to documentation 

@fix
This commit is contained in:
Andrii Kroitor 2017-10-27 09:52:15 +03:00
parent 0aedfdb538
commit ed9aa79344
1 changed files with 249 additions and 57 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

306
src/bin/edje/edje_cc_handlers.c
View File

@ -2292,6 +2292,8 @@ st_externals_external(void)
@li LOSSY_ETC1 [0-100]: ETC1 lossy texture compression with quality from 0 to 100. @li LOSSY_ETC1 [0-100]: ETC1 lossy texture compression with quality from 0 to 100.
@li LOSSY_ETC2 [0-100]: ETC2 lossy texture compression with quality from 0 to 100 (supports alpha). @li LOSSY_ETC2 [0-100]: ETC2 lossy texture compression with quality from 0 to 100 (supports alpha).
@li USER: Do not embed the file, refer to the external file instead. @li USER: Do not embed the file, refer to the external file instead.
Defaults: compression level for lossy methods is 90.
@endproperty @endproperty
*/ */
static void static void
@ -2675,6 +2677,8 @@ ob_images_set_image(void)
@li LOSSY_ETC1 [0-100]: ETC1 lossy texture compression with quality from 0 to 100. @li LOSSY_ETC1 [0-100]: ETC1 lossy texture compression with quality from 0 to 100.
@li LOSSY_ETC2 [0-100]: ETC2 lossy texture compression with quality from 0 to 100 (supports alpha). @li LOSSY_ETC2 [0-100]: ETC2 lossy texture compression with quality from 0 to 100 (supports alpha).
@li USER: Do not embed the file, refer to the external file instead. @li USER: Do not embed the file, refer to the external file instead.
Defaults: compression level for lossy methods is 90.
@endproperty @endproperty
**/ **/
static void static void
@ -2709,6 +2713,8 @@ st_images_set_image_image(void)
[minw] [minh] [maxw] [maxh] [minw] [minh] [maxw] [maxh]
@effect @effect
Define the minimal and maximal size that will select the specified image. Define the minimal and maximal size that will select the specified image.
Defaults: 0 0 0 0
@endproperty @endproperty
*/ */
static void static void
@ -2746,6 +2752,8 @@ st_images_set_image_size(void)
If set, the area (in pixels) of each side of the image will be If set, the area (in pixels) of each side of the image will be
displayed as a fixed size border, from the side -> inwards, preventing displayed as a fixed size border, from the side -> inwards, preventing
the corners from being changed on a resize. the corners from being changed on a resize.
Defaults: 0 0 0 0
@since 1.8 @since 1.8
@endproperty @endproperty
*/ */
@ -2781,6 +2789,8 @@ st_images_set_image_border(void)
the highest resolution artwork and then runtime scaling it down. the highest resolution artwork and then runtime scaling it down.
Valid values are: 0.0 or bigger (0.0 or 1.0 to turn it off) Valid values are: 0.0 or bigger (0.0 or 1.0 to turn it off)
Defaults: 0.0
@since 1.8 @since 1.8
@endproperty @endproperty
*/ */
@ -3530,6 +3540,8 @@ st_text_class_font(void)
[font size in points (pt)] [font size in points (pt)]
@effect @effect
Sets the font size for the text class. Sets the font size for the text class.
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -3638,6 +3650,8 @@ st_size_class_name(void)
[width] [height] [width] [height]
@effect @effect
The minimum size. The minimum size.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -3660,6 +3674,8 @@ st_size_class_min(void)
[width] [height] [width] [height]
@effect @effect
The maximum size. The maximum size.
Defaults: -1 -1
@endproperty @endproperty
*/ */
static void static void
@ -3722,6 +3738,8 @@ ob_collections(void)
which is same with a desktop(The monitor has 96 dpi). which is same with a desktop(The monitor has 96 dpi).
If you make a collection in another environment(ex: 115 dpi), you have to If you make a collection in another environment(ex: 115 dpi), you have to
set the base_scale(ex: 1.2). Then it will be shown same size in the desktop. set the base_scale(ex: 1.2). Then it will be shown same size in the desktop.
Defaults: 1.0
@since 1.11 @since 1.11
@endproperty @endproperty
*/ */
@ -4646,6 +4664,8 @@ _part_copy(Edje_Part *ep, Edje_Part *ep2)
will inhibit edje_cc resolving of programs and parts that may will inhibit edje_cc resolving of programs and parts that may
not exist in this group, but are located in the group which is inheriting not exist in this group, but are located in the group which is inheriting
this group. this group.
Defaults: 0
@since 1.10 @since 1.10
@endproperty @endproperty
*/ */
@ -4683,6 +4703,8 @@ st_collections_group_inherit_only(void)
system, as seat names, or when the application system, as seat names, or when the application
sets the devices names to guarantee they'll match sets the devices names to guarantee they'll match
seat names on EDC. seat names on EDC.
Defaults: 0
@since 1.19 @since 1.19
@endproperty @endproperty
*/ */
@ -5051,6 +5073,8 @@ st_collections_group_inherit(void)
@effect @effect
The flag (on/off) as to if this group is defined ONLY by script The flag (on/off) as to if this group is defined ONLY by script
callbacks such as init(), resize() and shutdown() callbacks such as init(), resize() and shutdown()
Defaults: off
@endproperty @endproperty
*/ */
static void static void
@ -5076,6 +5100,8 @@ st_collections_group_lua_script_only(void)
For example, running an Embryo script which calls EDC which has a For example, running an Embryo script which calls EDC which has a
script{} block is unsafe, and the outer-most (first) Embryo stack is GUARANTEED script{} block is unsafe, and the outer-most (first) Embryo stack is GUARANTEED
to be corrupted. Only use this flag if you are sure that you know what you are doing. to be corrupted. Only use this flag if you are sure that you know what you are doing.
Defaults: 0
@since 1.10 @since 1.10
@endproperty @endproperty
*/ */
@ -5141,6 +5167,8 @@ st_collections_group_alias(void)
@effect @effect
The minimum size for the container defined by the composition of the The minimum size for the container defined by the composition of the
parts. It is not enforced. parts. It is not enforced.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -5164,6 +5192,8 @@ st_collections_group_min(void)
@effect @effect
The maximum size for the container defined by the totality of the The maximum size for the container defined by the totality of the
parts. It is not enforced. parts. It is not enforced.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -5186,6 +5216,8 @@ st_collections_group_max(void)
[width] [height] [width] [height]
@effect @effect
Size of scene. Size of scene.
Defaults: 0.0 0.0
@endproperty @endproperty
*/ */
static void static void
@ -5207,8 +5239,10 @@ st_collections_group_scene_size(void)
@parameters @parameters
[on/off] [on/off]
@effect @effect
Signal got automatically broadcasted to all sub group part. Default to Signal got automatically broadcasted to all sub group part.
true since 1.1.
Defaults: true
@since 1.1
@endproperty @endproperty
*/ */
static void static void
@ -5256,6 +5290,8 @@ st_collections_group_nobroadcast(void)
@li AUTO - Follow system defs. @li AUTO - Follow system defs.
@li LTR - suitable for Left To Right Languages (latin) @li LTR - suitable for Left To Right Languages (latin)
@li RTL - suitable for Right To Left Languages (Hebrew, Arabic interface) @li RTL - suitable for Right To Left Languages (Hebrew, Arabic interface)
Defaults: AUTO
@endproperty @endproperty
*/ */
static void static void
@ -5281,7 +5317,8 @@ st_collections_group_orientation(void)
[1 or 0] [1 or 0]
@effect @effect
Change the default value of mouse_events for every part in this group. Change the default value of mouse_events for every part in this group.
Defaults to 1 if not set, to maintain compatibility.
Defaults: 1 (to maintain compatibility)
@endproperty @endproperty
*/ */
static void static void
@ -5396,7 +5433,8 @@ _script_flush(void)
@effect @effect
Change the default value of source for every program in the current group Change the default value of source for every program in the current group
which is declared after this value is set. which is declared after this value is set.
Defaults to an unset value to maintain compatibility.
Defaults: an unset value (to maintain compatibility)
@since 1.10 @since 1.10
@endproperty @endproperty
*/ */
@ -6643,6 +6681,8 @@ st_collections_group_parts_part_name(void)
@li PROXY @li PROXY
@li SPACER @li SPACER
@li SNAPSHOT @li SNAPSHOT
Defaults: IMAGE
@endproperty @endproperty
*/ */
static void static void
@ -6719,6 +6759,7 @@ st_collections_group_parts_part_type(void)
@li BOUNDARY_FRONT @li BOUNDARY_FRONT
@li BOUNDARY_BACK @li BOUNDARY_BACK
Defaults: NONE
@since 1.8 @since 1.8
@endproperty @endproperty
*/ */
@ -6847,8 +6888,9 @@ st_collections_group_parts_part_insert_after(void)
@effect @effect
Specifies whether the part will emit signals, although it is named Specifies whether the part will emit signals, although it is named
"mouse_events", disabling it (0) will prevent the part from emitting "mouse_events", disabling it (0) will prevent the part from emitting
any type of signal at all. It's set to 1 by default, or to the value any type of signal at all.
set to "mouse_events" at the group level, if any.
Defaults: group.mouse_events
@endproperty @endproperty
*/ */
static void static void
@ -6880,8 +6922,9 @@ st_collections_group_parts_part_nomouse(void)
@parameters @parameters
[1 or 0] [1 or 0]
@effect @effect
Takes a boolean value specifying whether part is anti_alias (1) or not Takes a boolean value specifying whether part is anti_alias (1) or not (0).
(0). The default value is 1.
Defaults: 1
@endproperty @endproperty
*/ */
static void static void
@ -6899,7 +6942,9 @@ st_collections_group_parts_part_anti_alias(void)
[1 or 0] [1 or 0]
@effect @effect
Specifies whether a part echoes a mouse event to other parts below the Specifies whether a part echoes a mouse event to other parts below the
pointer (1), or not (0). It's set to 0 by default. pointer (1), or not (0)
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -6938,8 +6983,10 @@ st_collections_group_parts_part_norepeat(void)
must be separated by spaces, the effect will be ignoring all events must be separated by spaces, the effect will be ignoring all events
with one of the flags specified. with one of the flags specified.
Possible flags: Possible flags:
@li NONE (default value, no event will be ignored) @li NONE (no event will be ignored)
@li ON_HOLD @li ON_HOLD
Defaults: NONE
@endproperty @endproperty
*/ */
static void static void
@ -6963,8 +7010,10 @@ st_collections_group_parts_part_ignore_flags(void)
Masks event flags with the given value, so that the event can be repeated Masks event flags with the given value, so that the event can be repeated
to the lower object along with masked event flags. to the lower object along with masked event flags.
Possible flags: Possible flags:
@li NONE (default value, no event will be masked) @li NONE (no event will be masked)
@li ON_HOLD @li ON_HOLD
Defaults: NONE
@endproperty @endproperty
*/ */
static void static void
@ -6993,6 +7042,8 @@ st_collections_group_parts_part_mask_flags(void)
is that some things work well being scaled, others do not, so the is that some things work well being scaled, others do not, so the
designer gets to choose what works best. For MESH_NODE parts three designer gets to choose what works best. For MESH_NODE parts three
parameters specify how much the part will stretched along each axis. parameters specify how much the part will stretched along each axis.
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -7018,13 +7069,14 @@ st_collections_group_parts_part_noscale(void)
@parameters @parameters
[MODE] [MODE]
@effect @effect
Sets the mouse pointer behavior for a given part. The default value is Sets the mouse pointer behavior for a given part. Aviable modes:
AUTOGRAB. Aviable modes:
@li AUTOGRAB, when the part is clicked and the button remains @li AUTOGRAB, when the part is clicked and the button remains
pressed, the part will be the source of all future mouse pressed, the part will be the source of all future mouse
signals emitted, even outside the object, until the button is signals emitted, even outside the object, until the button is
released. released.
@li NOGRAB, the effect will be limited to the part's container. @li NOGRAB, the effect will be limited to the part's container.
Defaults: AUTOGRAB
@endproperty @endproperty
*/ */
static void static void
@ -7046,7 +7098,9 @@ st_collections_group_parts_part_pointer_mode(void)
[1 or 0] [1 or 0]
@effect @effect
Enables precise point collision detection for the part, which is more Enables precise point collision detection for the part, which is more
resource intensive. Disabled by default. resource intensive.
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -7083,6 +7137,8 @@ st_collections_group_parts_part_noprecise(void)
Only affects text and textblock parts, when enabled Edje will use Only affects text and textblock parts, when enabled Edje will use
different size measurement functions. Disabled by default. (note from different size measurement functions. Disabled by default. (note from
the author: I don't know what this is exactly useful for?) the author: I don't know what this is exactly useful for?)
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -7135,6 +7191,8 @@ st_collections_group_parts_part_clip_to_id(void)
required if it is a proxy source or a mask (clipper). required if it is a proxy source or a mask (clipper).
Strongly recommended for use with mask objects and proxy sources Strongly recommended for use with mask objects and proxy sources
(instead of setting "source_visible" on the proxy itself). (instead of setting "source_visible" on the proxy itself).
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -7161,6 +7219,8 @@ st_collections_group_parts_part_render(void)
@effect @effect
If the required flag is set, this part will be considered If the required flag is set, this part will be considered
stable and it is safe to use by any application." stable and it is safe to use by any application."
Defaults: 0
@since 1.18 @since 1.18
@endproperty @endproperty
*/ */
@ -7343,6 +7403,8 @@ st_collections_group_parts_part_source6(void)
@li TOP @li TOP
@li TOP_RIGHT @li TOP_RIGHT
@li RIGHT @li RIGHT
Defaults: PLAIN
@endproperty @endproperty
*/ */
static void static void
@ -7393,11 +7455,14 @@ st_collections_group_parts_part_effect(void)
@li PLAIN @li PLAIN
@li EDITABLE @li EDITABLE
@li PASSWORD @li PASSWORD
It causes the part be editable if the edje object has the keyboard It causes the part be editable if the edje object has the keyboard
focus AND the part has the edje focus (or selectable always focus AND the part has the edje focus (or selectable always
regardless of focus) and in the event of password mode, not regardless of focus) and in the event of password mode, not
selectable and all text chars replaced with *'s but editable and selectable and all text chars replaced with *'s but editable and
pastable. pastable.
Defaults: NONE
@endproperty @endproperty
*/ */
static void static void
@ -7447,10 +7512,11 @@ st_collections_group_parts_part_select_mode(void)
[mode] [mode]
@effect @effect
Sets the cursor mode for a textblock part to one of: Sets the cursor mode for a textblock part to one of:
@li UNDER cursor mode means the cursor will draw below the character pointed @li UNDER cursor mode means the cursor will draw below the character pointed at.
at. That's the default.
@li BEFORE cursor mode means the cursor is drawn as a vertical line before @li BEFORE cursor mode means the cursor is drawn as a vertical line before
the current character, just like many other GUI toolkits handle it. the current character, just like many other GUI toolkits handle it.
Defaults: UNDER
@endproperty @endproperty
*/ */
static void static void
@ -7473,6 +7539,8 @@ st_collections_group_parts_part_cursor_mode(void)
@effect @effect
It causes a textblock that is editable to allow multiple lines for It causes a textblock that is editable to allow multiple lines for
editing. editing.
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -7490,8 +7558,9 @@ st_collections_group_parts_part_multiline(void)
@parameters @parameters
[1 or 0] [1 or 0]
@effect @effect
Specifies whether the part will use accessibility feature (1), Specifies whether the part will use accessibility feature (1), or not (0).
or not (0). It's set to 0 by default.
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -7542,6 +7611,8 @@ st_collections_group_parts_part_access(void)
divisible by it, causing the part to jump from position to position. divisible by it, causing the part to jump from position to position.
If step is set to 0 it is calculated as width of confine part divided by If step is set to 0 it is calculated as width of confine part divided by
count. count.
Defaults: 0 0 0
@endproperty @endproperty
*/ */
static void static void
@ -7568,6 +7639,8 @@ st_collections_group_parts_part_dragable_x(void)
divisibles by it, causing the part to jump from position to position. divisibles by it, causing the part to jump from position to position.
If step is set to 0 it is calculated as height of confine part divided by If step is set to 0 it is calculated as height of confine part divided by
count. count.
Defaults: 0 0 0
@endproperty @endproperty
*/ */
static void static void
@ -7928,6 +8001,8 @@ static void st_collections_group_parts_part_box_items_item_source(void)
[width] [height] [width] [height]
@effect @effect
Sets the minimum size hints for this object. Sets the minimum size hints for this object.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_box_items_item_min(void) static void st_collections_group_parts_part_box_items_item_min(void)
@ -7950,7 +8025,7 @@ static void st_collections_group_parts_part_box_items_item_min(void)
Will replicate the item in a rectangle of size width x height Will replicate the item in a rectangle of size width x height
box starting from the defined position of this item. box starting from the defined position of this item.
default value will be 1 1; Defaults: 1 1
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_box_items_item_spread(void) static void st_collections_group_parts_part_box_items_item_spread(void)
@ -7971,6 +8046,8 @@ static void st_collections_group_parts_part_box_items_item_spread(void)
[width] [height] [width] [height]
@effect @effect
Sets the preferred size hints for this object. Sets the preferred size hints for this object.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_box_items_item_prefer(void) static void st_collections_group_parts_part_box_items_item_prefer(void)
@ -7990,6 +8067,8 @@ static void st_collections_group_parts_part_box_items_item_prefer(void)
[width] [height] [width] [height]
@effect @effect
Sets the maximum size hints for this object. Sets the maximum size hints for this object.
Defaults: -1 -1
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_box_items_item_max(void) static void st_collections_group_parts_part_box_items_item_max(void)
@ -8010,6 +8089,8 @@ static void st_collections_group_parts_part_box_items_item_max(void)
[left] [right] [top] [bottom] [left] [right] [top] [bottom]
@effect @effect
Sets the padding hints for this object. Sets the padding hints for this object.
Defaults: 0 0 0 0
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_box_items_item_padding(void) static void st_collections_group_parts_part_box_items_item_padding(void)
@ -8031,7 +8112,9 @@ static void st_collections_group_parts_part_box_items_item_padding(void)
@parameters @parameters
[x] [y] [x] [y]
@effect @effect
Sets the alignment hints for this object. Sets the alignment [-1.0 - 1.0] hints for this object.
Defaults: 0.5
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_box_items_item_align(void) static void st_collections_group_parts_part_box_items_item_align(void)
@ -8052,6 +8135,8 @@ static void st_collections_group_parts_part_box_items_item_align(void)
[x] [y] [x] [y]
@effect @effect
Sets the weight hints for this object. Sets the weight hints for this object.
Defaults: 0.0 0.0
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_box_items_item_weight(void) static void st_collections_group_parts_part_box_items_item_weight(void)
@ -8072,6 +8157,8 @@ static void st_collections_group_parts_part_box_items_item_weight(void)
[w] [h] [w] [h]
@effect @effect
Sets the aspect width and height hints for this object. Sets the aspect width and height hints for this object.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_box_items_item_aspect(void) static void st_collections_group_parts_part_box_items_item_aspect(void)
@ -8097,6 +8184,8 @@ static void st_collections_group_parts_part_box_items_item_aspect(void)
@li HORIZONTAL @li HORIZONTAL
@li VERTICAL @li VERTICAL
@li BOTH @li BOTH
Defaults: NONE
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_box_items_item_aspect_mode(void) static void st_collections_group_parts_part_box_items_item_aspect_mode(void)
@ -8169,7 +8258,8 @@ static void st_collections_group_parts_part_table_items_item_position(void)
[col] [row] [col] [row]
@effect @effect
Sets how many columns/rows this item will use. Sets how many columns/rows this item will use.
Defaults to 1 1.
Defaults: 1 1
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_table_items_item_span(void) static void st_collections_group_parts_part_table_items_item_span(void)
@ -8747,8 +8837,12 @@ _part_description_state_update(Edje_Part_Description_Common *ed)
Sets a name used to identify a description inside a given part. Sets a name used to identify a description inside a given part.
Multiple descriptions are used to declare different states of the same Multiple descriptions are used to declare different states of the same
part, like "clicked" or "invisible". All states declarations are also part, like "clicked" or "invisible". All states declarations are also
coupled with an index number between 0.0 and 1.0. All parts must have coupled with an index number between 0.0 and 1.0.
at least one description named "default 0.0". First description in part must always be "default" 0.0.
@warning state name "custom" is reserved and can't be used in edc.
Defaults: "default" 0.0
@endproperty @endproperty
*/ */
static void static void
@ -8800,7 +8894,9 @@ st_collections_group_parts_part_description_state(void)
[0 or 1] [0 or 1]
@effect @effect
Takes a boolean value specifying whether part is visible (1) or not Takes a boolean value specifying whether part is visible (1) or not
(0). Non-visible parts do not emit signals. The default value is 1. (0). Non-visible parts do not emit signals.
Defaults: 1
@endproperty @endproperty
*/ */
static void static void
@ -8892,6 +8988,7 @@ st_collections_group_parts_part_description_no_render(void)
@li HEIGHT @li HEIGHT
@li BOTH @li BOTH
Defaults: NONE
@since 1.7 @since 1.7
@endproperty @endproperty
*/ */
@ -8933,9 +9030,10 @@ st_collections_group_parts_part_description_limit(void)
axis inside its container. @c "0.0" means left/top edges of axis inside its container. @c "0.0" means left/top edges of
the object touching container's respective ones, while @c the object touching container's respective ones, while @c
"1.0" stands for right/bottom edges of the object (on "1.0" stands for right/bottom edges of the object (on
horizonal/vertical axis, respectively). The default value is horizonal/vertical axis, respectively).
@c "0.5 0.5". There is one more parametr for Z axis in case There is one more parametr for Z axis in case of MESH_NODE.
of MESH_NODE.
Defaults: 0.5 0.5 (0.5)
@endproperty @endproperty
*/ */
static void static void
@ -8968,6 +9066,8 @@ st_collections_group_parts_part_description_align(void)
This tells the min size calculation routine that this part does not This tells the min size calculation routine that this part does not
change size in width or height (1 for it doesn't, 0 for it does), so change size in width or height (1 for it doesn't, 0 for it does), so
the routine should not try and expand or contract the part. the routine should not try and expand or contract the part.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -8992,6 +9092,8 @@ st_collections_group_parts_part_description_fixed(void)
When min is defined to SOURCE, it will look at the original When min is defined to SOURCE, it will look at the original
image size and enforce it minimal size to match at least the image size and enforce it minimal size to match at least the
original one. The part must be an IMAGE or a GROUP part. original one. The part must be an IMAGE or a GROUP part.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -9030,6 +9132,8 @@ st_collections_group_parts_part_description_min(void)
@effect @effect
A multiplier FORCIBLY applied to whatever minimum size is only during A multiplier FORCIBLY applied to whatever minimum size is only during
minimum size calculation. minimum size calculation.
Defaults: 1.0 1.0
@since 1.2 @since 1.2
@endproperty @endproperty
*/ */
@ -9049,11 +9153,13 @@ st_collections_group_parts_part_description_minmul(void)
@parameters @parameters
[width] [height] or SOURCE [width] [height] or SOURCE
@effect @effect
The maximum size of the state. A size of -1.0 means that it will be ignored in one direction. The maximum size of the state. A size of -1 means that it will be ignored in one direction.
When max is set to SOURCE, edje will enforce the part to be When max is set to SOURCE, edje will enforce the part to be
not more than the original image size. The part must be an not more than the original image size. The part must be an
IMAGE part. IMAGE part.
Defaults: -1 -1
@endproperty @endproperty
*/ */
static void static void
@ -9113,6 +9219,8 @@ st_collections_group_parts_part_description_size_class(void)
Restricts resizing of each dimension to values divisible by its value. Restricts resizing of each dimension to values divisible by its value.
This causes the part to jump from value to value while resizing. The This causes the part to jump from value to value while resizing. The
default value is "0 0" disabling stepping. default value is "0 0" disabling stepping.
Defaults: 0.0 0.0
@endproperty @endproperty
*/ */
static void static void
@ -9136,6 +9244,8 @@ st_collections_group_parts_part_description_step(void)
the minimum and maximum set. For example, "1.0 1.0" will increase the the minimum and maximum set. For example, "1.0 1.0" will increase the
width a pixel for every pixel added to height. The default value is width a pixel for every pixel added to height. The default value is
"0.0 0.0" disabling aspect. "0.0 0.0" disabling aspect.
Defaults: 0.0 0.0
@endproperty @endproperty
*/ */
static void static void
@ -9156,6 +9266,8 @@ st_collections_group_parts_part_description_aspect(void)
@effect @effect
Sets the scope of the "aspect" property to a given dimension. Available Sets the scope of the "aspect" property to a given dimension. Available
options are BOTH, VERTICAL, HORIZONTAL, SOURCE and NONE options are BOTH, VERTICAL, HORIZONTAL, SOURCE and NONE
Defaults: NONE
@endproperty @endproperty
*/ */
static void static void
@ -9380,6 +9492,10 @@ st_collections_group_parts_part_description_clip_to_id(void)
Moves a corner to a relative position inside the container of the Moves a corner to a relative position inside the container of the
relative "to" part. Values from 0.0 (0%, beginning) to 1.0 (100%, end) relative "to" part. Values from 0.0 (0%, beginning) to 1.0 (100%, end)
of each axis. of each axis.
Defaults:
@li rel1.relative: 0.0 0.0
@li rel2.relative: 1.0 1.0
@endproperty @endproperty
*/ */
static void static void
@ -9400,6 +9516,10 @@ st_collections_group_parts_part_description_rel1_relative(void)
[X axis] [Y axis] [X axis] [Y axis]
@effect @effect
Affects the corner position a fixed number of pixels along each axis. Affects the corner position a fixed number of pixels along each axis.
Defaults:
@li rel1.offset: 0 0
@li rel2.offset: -1 -1
@endproperty @endproperty
*/ */
static void static void
@ -10346,6 +10466,8 @@ st_collections_group_parts_part_description_image_tween(void)
If set, the area (in pixels) of each side of the image will be If set, the area (in pixels) of each side of the image will be
displayed as a fixed size border, from the side -> inwards, preventing displayed as a fixed size border, from the side -> inwards, preventing
the corners from being changed on a resize. the corners from being changed on a resize.
Defaults: 0 0 0 0
@endproperty @endproperty
*/ */
static void static void
@ -10428,6 +10550,8 @@ st_collections_group_parts_part_description_image_middle(void)
the highest resolution artwork and then runtime scaling it down. the highest resolution artwork and then runtime scaling it down.
value can be: 0.0 or bigger (0.0 or 1.0 to turn it off) value can be: 0.0 or bigger (0.0 or 1.0 to turn it off)
Defaults: 0.0
@endproperty @endproperty
*/ */
static void static void
@ -10458,6 +10582,8 @@ st_collections_group_parts_part_description_image_border_scale_by(void)
@effect @effect
If border is set, this value tells Edje if the border should be scaled If border is set, this value tells Edje if the border should be scaled
by the object/global edje scale factors by the object/global edje scale factors
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -10495,6 +10621,8 @@ st_collections_group_parts_part_description_image_border_scale(void)
@li 0 or NONE @li 0 or NONE
@li DYNAMIC @li DYNAMIC
@li STATIC @li STATIC
Defaults: NONE
@endproperty @endproperty
*/ */
static void static void
@ -10556,7 +10684,9 @@ st_collections_group_parts_part_description_image_scale_hint(void)
[0 or 1] [0 or 1]
@effect @effect
The smooth property takes a boolean value to decide if the image will The smooth property takes a boolean value to decide if the image will
be smoothed on scaling (1) or not (0). The default value is 1. be smoothed on scaling (1) or not (0).
Defaults: 1
@endproperty @endproperty
*/ */
static void static void
@ -10611,11 +10741,12 @@ st_collections_group_parts_part_description_fill_smooth(void)
'offset' from 'origin' and 'size' blocks. Important: the part parameter 'offset' from 'origin' and 'size' blocks. Important: the part parameter
'min' must be setted, it's size of tiled image. If parameter 'max' setted 'min' must be setted, it's size of tiled image. If parameter 'max' setted
tiled area will has the size accordingly 'max' values. tiled area will has the size accordingly 'max' values.
SCALE is default type.
Valid values are: Valid values are:
@li SCALE @li SCALE
@li TILE @li TILE
Defaults: SCALE
@endproperty @endproperty
*/ */
static void static void
@ -10692,6 +10823,8 @@ st_collections_group_parts_part_description_fill_type(void)
[X axis] [Y axis] [X axis] [Y axis]
@effect @effect
Sets the starting point relatively to displayed element's content. Sets the starting point relatively to displayed element's content.
Defaults: 0.0 0.0
@endproperty @endproperty
*/ */
static void static void
@ -10742,6 +10875,8 @@ st_collections_group_parts_part_description_fill_origin_relative(void)
[X axis] [Y axis] [X axis] [Y axis]
@effect @effect
Affects the starting point a fixed number of pixels along each axis. Affects the starting point a fixed number of pixels along each axis.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -10816,8 +10951,9 @@ st_collections_group_parts_part_description_fill_origin_offset(void)
@effect @effect
Takes a pair of decimal values that represent the percentual value Takes a pair of decimal values that represent the percentual value
of the original size of the element. For example, "0.5 0.5" represents of the original size of the element. For example, "0.5 0.5" represents
half the size, while "2.0 2.0" represents the double. The default half the size, while "2.0 2.0" represents the double.
value is "1.0 1.0".
Defaults: 1.0 1.0
@endproperty @endproperty
*/ */
static void static void
@ -10868,6 +11004,8 @@ st_collections_group_parts_part_description_fill_size_relative(void)
[X axis] [Y axis] [X axis] [Y axis]
@effect @effect
Affects the size of the tile a fixed number of pixels along each axis. Affects the size of the tile a fixed number of pixels along each axis.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -11152,10 +11290,12 @@ st_collections_group_parts_part_description_text_repch(void)
@property @property
size size
@parameters @parameters
[font size in points (pt)] [font size in points (pt) 0 - 255]
@effect @effect
Sets the default font size for the text part. Can be overridden by the Sets the default font size for the text part. Can be overridden by the
application. application.
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -11184,10 +11324,12 @@ st_collections_group_parts_part_description_text_size(void)
@property @property
size_range size_range
@parameters @parameters
[font min size in points (pt)] [font max size in points (pt)] [font min size in points (pt) 0 - 255] [font max size in points (pt) 0 - 255]
@effect @effect
Sets the allowed font size for the text part. Setting min and max to 0 Sets the allowed font size for the text part. Setting min and max to 0
means we won't restrict the sizing (default). means we won't restrict the sizing.
Defaults: 0 0
@since 1.1 @since 1.1
@endproperty @endproperty
*/ */
@ -11228,6 +11370,8 @@ st_collections_group_parts_part_description_text_size_range(void)
@effect @effect
When any of the parameters is set to 1 edje will resize the text for it When any of the parameters is set to 1 edje will resize the text for it
to fit in it's container. Both are disabled by default. to fit in it's container. Both are disabled by default.
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -11260,8 +11404,9 @@ st_collections_group_parts_part_description_text_fit(void)
[horizontal] [vertical] [horizontal] [vertical]
@effect @effect
When any of the parameters is enabled (1) it forces the minimum size of When any of the parameters is enabled (1) it forces the minimum size of
the container to be equal to the minimum size of the text. The default the container to be equal to the minimum size of the text.
value is "0 0".
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -11297,8 +11442,9 @@ st_collections_group_parts_part_description_text_min(void)
[horizontal] [vertical] [horizontal] [vertical]
@effect @effect
When any of the parameters is enabled (1) it forces the maximum size of When any of the parameters is enabled (1) it forces the maximum size of
the container to be equal to the maximum size of the text. The default the container to be equal to the maximum size of the text.
value is "0 0".
Defaults: 0 0
@endproperty @endproperty
*/ */
static void static void
@ -11333,8 +11479,9 @@ st_collections_group_parts_part_description_text_max(void)
@parameters @parameters
[horizontal] [vertical] [horizontal] [vertical]
@effect @effect
Change the position of the point of balance inside the container. The Change the position of the point of balance inside the container [-1.0 - 1.0].
default value is 0.5 0.5.
Defaults: 0.5 0.5
@endproperty @endproperty
*/ */
static void static void
@ -11450,7 +11597,10 @@ st_collections_group_parts_part_description_text_text_source(void)
@effect @effect
Used to balance the text in a relative point from 0.0 to 1.0, this Used to balance the text in a relative point from 0.0 to 1.0, this
point is the last section of the string to be cut out in case of a point is the last section of the string to be cut out in case of a
resize that is smaller than the text itself. The default value is 0.0. resize that is smaller than the text itself.
Setting -1.0 will disable text cutting.
Defaults: 0.0
@endproperty @endproperty
*/ */
static void static void
@ -11506,7 +11656,7 @@ st_collections_group_parts_part_description_text_ellipsis(void)
[primary layout] (fallback layout) [primary layout] (fallback layout)
@effect @effect
Sets the layout for the box: Sets the layout for the box:
@li horizontal (default) @li horizontal
@li vertical @li vertical
@li horizontal_homogeneous @li horizontal_homogeneous
@li vertical_homogeneous @li vertical_homogeneous
@ -11519,6 +11669,8 @@ st_collections_group_parts_part_description_text_ellipsis(void)
You could set a custom layout as fallback, it makes very You could set a custom layout as fallback, it makes very
very little sense though, and if that one fails, it will very little sense though, and if that one fails, it will
default to horizontal. default to horizontal.
Defaults: "horizontal"
@endproperty @endproperty
@property @property
@ -11526,8 +11678,9 @@ st_collections_group_parts_part_description_text_ellipsis(void)
@parameters @parameters
[horizontal] [vertical] [horizontal] [vertical]
@effect @effect
Change the position of the point of balance inside the container. The Change the position of the point of balance inside the container [-1.0 - 1.0].
default value is 0.5 0.5.
Defaults: 0.5 0.5
@endproperty @endproperty
@property @property
@ -11535,7 +11688,9 @@ st_collections_group_parts_part_description_text_ellipsis(void)
@parameters @parameters
[horizontal] [vertical] [horizontal] [vertical]
@effect @effect
Sets the space between cells in pixels. Defaults to 0 0. Sets the space between cells in pixels.
Defaults: 0 0
@endproperty @endproperty
@property @property
@ -11544,8 +11699,9 @@ st_collections_group_parts_part_description_text_ellipsis(void)
[horizontal] [vertical] [horizontal] [vertical]
@effect @effect
When any of the parameters is enabled (1) it forces the minimum size of When any of the parameters is enabled (1) it forces the minimum size of
the box to be equal to the minimum size of the items. The default the box to be equal to the minimum size of the items.
value is "0 0".
Defaults: 0 0
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_description_box_layout(void) static void st_collections_group_parts_part_description_box_layout(void)
@ -11660,9 +11816,11 @@ st_collections_group_parts_part_description_box_min(void)
[homogeneous mode] [homogeneous mode]
@effect @effect
Sets the homogeneous mode for the table: Sets the homogeneous mode for the table:
@li NONE (default) @li NONE
@li TABLE @li TABLE
@li ITEM @li ITEM
Defaults: NONE
@endproperty @endproperty
@property @property
@ -11670,8 +11828,9 @@ st_collections_group_parts_part_description_box_min(void)
@parameters @parameters
[horizontal] [vertical] [horizontal] [vertical]
@effect @effect
Change the position of the point of balance inside the container. The Change the position of the point of balance inside the container [-1.0 - 1.0].
default value is 0.5 0.5.
Defaults: 0.5 0.5
@endproperty @endproperty
@property @property
@ -11679,7 +11838,9 @@ st_collections_group_parts_part_description_box_min(void)
@parameters @parameters
[horizontal] [vertical] [horizontal] [vertical]
@effect @effect
Sets the space between cells in pixels. Defaults to 0 0. Sets the space between cells in pixels.
Defaults: 0 0
@endproperty @endproperty
@property @property
@ -11688,8 +11849,9 @@ st_collections_group_parts_part_description_box_min(void)
[horizontal] [vertical] [horizontal] [vertical]
@effect @effect
When any of the parameters is enabled (1) it forces the minimum size of When any of the parameters is enabled (1) it forces the minimum size of
the table to be equal to the minimum size of the items. The default the table to be equal to the minimum size of the items.
value is "0 0".
Defaults: 0 0
@endproperty @endproperty
*/ */
static void st_collections_group_parts_part_description_table_homogeneous(void) static void st_collections_group_parts_part_description_table_homogeneous(void)
@ -11785,6 +11947,8 @@ static void st_collections_group_parts_part_description_table_padding(void)
Sets the 'source_clip' property on this PROXY object. True by default, Sets the 'source_clip' property on this PROXY object. True by default,
this means the proxy will be clipped by its source clipper. False this means the proxy will be clipped by its source clipper. False
means the source clipper is ignored when rendering the proxy. means the source clipper is ignored when rendering the proxy.
Defaults: 1
@endproperty @endproperty
@property @property
@ -11796,6 +11960,8 @@ static void st_collections_group_parts_part_description_table_padding(void)
default, meaning both the proxy and its source object will be visible. default, meaning both the proxy and its source object will be visible.
If false, the source object will not be visible. False is equivalent If false, the source object will not be visible. False is equivalent
to setting the 'no_render' flag on the source object itself. to setting the 'no_render' flag on the source object itself.
Defaults: 1
@endproperty @endproperty
*/ */
static void static void
@ -13840,7 +14006,9 @@ st_collections_group_parts_part_description_map_light(void)
@parameters @parameters
[1 or 0] [1 or 0]
@effect @effect
This enables mapping for the part. Default is 0. This enables mapping for the part.
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -13861,7 +14029,9 @@ st_collections_group_parts_part_description_map_on(void)
This enable smooth map rendering. This may be linear interpolation, This enable smooth map rendering. This may be linear interpolation,
anisotropic filtering or anything the engine decides is "smooth". anisotropic filtering or anything the engine decides is "smooth".
This is a best-effort hint and may not produce precisely the same This is a best-effort hint and may not produce precisely the same
results in all engines and situations. Default is 1 results in all engines and situations.
Defaults: 1
@endproperty @endproperty
*/ */
static void static void
@ -13879,7 +14049,9 @@ st_collections_group_parts_part_description_map_smooth(void)
@parameters @parameters
[1 or 0] [1 or 0]
@effect @effect
This enable alpha channel when map rendering. Default is 1. This enable alpha channel when map rendering.
Defaults: 1
@endproperty @endproperty
*/ */
static void static void
@ -13900,6 +14072,8 @@ st_collections_group_parts_part_description_map_alpha(void)
This enables backface culling (when the rotated part that normally This enables backface culling (when the rotated part that normally
faces the camera is facing away after being rotated etc.). This means faces the camera is facing away after being rotated etc.). This means
that the object will be hidden when "backface culled". that the object will be hidden when "backface culled".
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -13921,6 +14095,8 @@ st_collections_group_parts_part_description_map_backface_cull(void)
This would use perspective set for the object itself or for the This would use perspective set for the object itself or for the
canvas as a whole as the global perspective with canvas as a whole as the global perspective with
edje_perspective_set() and edje_perspective_global_set(). edje_perspective_set() and edje_perspective_global_set().
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -13997,6 +14173,8 @@ st_collections_group_parts_part_description_map_color(void)
[X horizontal zoom to use] [X horizontal zoom to use]
@effect @effect
This sets the zoom rate of the horizontal This sets the zoom rate of the horizontal
Defaults: 1.0
@endproperty @endproperty
*/ */
static void static void
@ -14015,6 +14193,8 @@ st_collections_group_parts_part_description_map_zoom_x(void)
[Y vertical zoom to use] [Y vertical zoom to use]
@effect @effect
This sets the zoom rate of vertical This sets the zoom rate of vertical
Defaults: 1.0
@endproperty @endproperty
*/ */
static void static void
@ -14086,6 +14266,8 @@ st_collections_group_parts_part_description_map_rotation_center(void)
@effect @effect
This sets the rotation around the x axis of the part considering This sets the rotation around the x axis of the part considering
the center set. In degrees. the center set. In degrees.
Defaults: 0.0
@endproperty @endproperty
*/ */
static void static void
@ -14105,6 +14287,8 @@ st_collections_group_parts_part_description_map_rotation_x(void)
@effect @effect
This sets the rotation around the y axis of the part considering This sets the rotation around the y axis of the part considering
the center set. In degrees. the center set. In degrees.
Defaults: 0.0
@endproperty @endproperty
*/ */
static void static void
@ -14124,6 +14308,8 @@ st_collections_group_parts_part_description_map_rotation_y(void)
@effect @effect
This sets the rotation around the z axis of the part considering This sets the rotation around the z axis of the part considering
the center set. In degrees. the center set. In degrees.
Defaults: 0.0
@endproperty @endproperty
*/ */
static void static void
@ -14162,6 +14348,8 @@ st_collections_group_parts_part_description_map_rotation_z(void)
@effect @effect
This sets the z value that will not be scaled. Normally this is 0 as This sets the z value that will not be scaled. Normally this is 0 as
that is the z distance that all objects are at normally. that is the z distance that all objects are at normally.
Defaults: 0
@endproperty @endproperty
*/ */
static void static void
@ -14182,6 +14370,8 @@ st_collections_group_parts_part_description_perspective_zplane(void)
@effect @effect
This sets the distance from the focal z plane (zplane) and the This sets the distance from the focal z plane (zplane) and the
camera - i.e. very much equating to focal length of the camera camera - i.e. very much equating to focal length of the camera
Defaults: 1000
@endproperty @endproperty
*/ */
static void static void
@ -15003,6 +15193,8 @@ st_collections_group_programs_program_filter(void)
@effect @effect
Wait 'from' seconds before executing the program. And add a random Wait 'from' seconds before executing the program. And add a random
number of seconds (from 0 to 'range') to the total waiting time. number of seconds (from 0 to 'range') to the total waiting time.
Defaults: 0.0 0.0
@endproperty @endproperty
*/ */
static void static void