Hi folks!
Since the adding of map capabilities to Edje, it's EDC Reference
documentation has been broken due to the inclusion of tags out of
proper order. That can be easily verified by going to
http://docs.enlightenment.org/auto/edje/edcref.html and looking at the
bottom part.
So, I created this patch that contains no code change and just changes
the already existing documentation to be in order so Doxygen is nice
and produce the desired output. I also fixed a couple of spelling
errors, and some documentation error on an internal header (There's no
need to confuse new devs)
If anything is wrong, please feel free to change. It was created with r46394.
Cheers,
Eduardo Felipe.
Index: src/lib/edje_private.h
===================================================================
--- src/lib/edje_private.h (revision 46421)
+++ src/lib/edje_private.h (working copy)
@@ -417,8 +417,8 @@
const char *source; /* if part that emitted this (name) matches this glob */
struct {
- const char *part;
- const char *state; /* if state is not set, we will try with source */
+ const char *part; /* if part is not set, we will try with event source
as part name */
+ const char *state; /* if state is not set the filter is ignored */
} filter; /* the part filter.part should be in state filter.state for
signal to be accepted */
struct {
Index: src/bin/edje_cc_handlers.c
===================================================================
--- src/bin/edje_cc_handlers.c (revision 46421)
+++ src/bin/edje_cc_handlers.c (working copy)
@@ -704,6 +704,8 @@
external
@parameters
[external filename]
+ @effect
+ Used to add a file to the externals list.
@endproperty
*/
static void
@@ -1962,7 +1964,6 @@
signals emitted, even outside the object, until the button is
released.
@li NOGRAB, the effect will be limited to the part's container.
- container.
@endproperty
*/
static void
@@ -2275,12 +2276,13 @@
@property
entry_mode
@parameters
+ [MODE]
+ @effect
Sets the edit mode for a textblock part to one of:
@li NONE
@li PLAIN
@li EDITABLE
@li PASSWORD
- @effect
It causes the part be editable if the edje object has the keyboard
focus AND the part has the edje focus (or selectable always
regardless of focus) and in the event of password mode, not
@@ -2311,10 +2313,11 @@
@property
select_mode
@parameters
+ [MODE]
+ @effect
Sets the selection mode for a textblock part to one of:
@li DEFAULT
@li EXPLICIT
- @effect
DEFAULT selection mode is what you would expect on any desktop. Press
mouse, drag and release to end. EXPLICIT mode requires the application
controlling the edje object has to explicitly begin and end selection
@@ -2342,7 +2345,7 @@
@property
multiline
@parameters
- 0 or 1 (boolean) off/on
+ [1 or 0]
@effect
It causes a textblock that is editable to allow multiple lines for
editing.
@@ -2394,7 +2397,7 @@
used to enable (1 or -1) and disable (0) dragging along the axis. When
enabled, 1 will set the starting point at 0.0 and -1 at 1.0. The second
parameter takes any integer and will limit movement to values
- divisibles by it, causing the part to jump from position to position.
+ divisible by it, causing the part to jump from position to position.
The third parameter, (question from the author: What is count for?).
@endproperty
*/
@@ -4165,8 +4168,8 @@
@parameters
0, NONE, DYNAMIC, STATIC
@effect
- Sets the evas image scale hint letting the engine more efectively save
- cached copies of the scaled image if it maks sense
+ Sets the evas image scale hint letting the engine more effectively save
+ cached copies of the scaled image if it makes sense
@endproperty
*/
static void
@@ -4304,7 +4307,7 @@
[angle]
@effect
The angle of rotation of a GRADIENT part. It is invalid in any other
- part type. The angle is espressed as an int, in the range 0 - 360.
+ part type. The angle is expressed as an int, in the range 0 - 360.
@endproperty
*/
static void
@@ -5672,16 +5675,32 @@
/**
@page edcref
- @property
- perspective
+ @block
+ map
@context
- description {
- ..
- map {
- perspective: "name";
+ description {
+ ..
+ map {
+ perspective: "name";
+ light: "name";
+ on: 1;
+ smooth: 1;
+ perspective_on: 1;
+ backface_cull: 1;
+ alpha: 1;
+
+ rotation {
+ ..
}
- ..
}
+ ..
+ }
+
+ @description
+ @endblock
+
+ @property
+ perspective
@parameters
[another part's name]
@effect
@@ -5722,22 +5741,14 @@
@page edcref
@property
light
- @context
- description {
- ..
- map {
- light: "name";
- }
- ..
- }
@parameters
[another part's name]
@effect
This sets the part that is used as the "light" for calculating the
brightness (based on how directly the part's surface is facing the
- lightsource point). Like the perspective point part, the center point
- is used and zplane is used for the z position (0 being th zero-plane
- where all 2d objects normally live) and positive values being further
+ light source point). Like the perspective point part, the center point
+ is used and zplane is used for the z position (0 being the zero-plane
+ where all 2D objects normally live) and positive values being further
away into the distance. The light part color is used as the light
color (alpha not used for light color). The color2 color is used for
the ambient lighting when calculating brightness (alpha also not
@@ -5766,33 +5777,18 @@
free(name);
}
}
-
/**
@page edcref
@property
- center
- @context
- description {
- ..
- map {
- rotation {
- center: "name";
- }
- }
- ..
- }
+ on
@parameters
- [another part's name]
+ [1 or 0]
@effect
- This sets the part that is used as the center of rotation when
- rotating the part with this description. The part's center point
- is used as the rotation center when applying rotation around the
- x, y and z axes. If no center is given, the parts original center
- itself is used for the rotation center.
+ This enables mapping for the part. Default is 0.
@endproperty
*/
static void
-st_collections_group_parts_part_description_map_rotation_center(void)
+st_collections_group_parts_part_description_map_on(void)
{
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -5805,37 +5801,24 @@
ed = ep->default_desc;
if (ep->other_desc) ed = eina_list_data_get(eina_list_last(ep->other_desc));
- {
- char *name;
-
- name = parse_str(0);
- data_queue_part_lookup(pc, name, &(ed->map.rot.id_center));
- free(name);
- }
+ ed->map.on = parse_bool(0);
}
/**
@page edcref
@property
- x
- @context
- description {
- ..
- map {
- rotation {
- x: 45.0;
- }
- }
- ..
- }
+ smooth
@parameters
- rotation in degrees around the x axis
+ [1 or 0]
@effect
- This sets the rotation of the part around the center set in degrees
+ This enable smooth map rendering. This may be linear interpolation,
+ anisotropic filtering or anything the engine decides is "smooth".
+ This is a best-effort hint and may not produce precisely the same
+ results in all engines and situations. Default is 1
@endproperty
*/
static void
-st_collections_group_parts_part_description_map_rotation_x(void)
+st_collections_group_parts_part_description_map_smooth(void)
{
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -5848,31 +5831,21 @@
ed = ep->default_desc;
if (ep->other_desc) ed = eina_list_data_get(eina_list_last(ep->other_desc));
- ed->map.rot.x = FROM_DOUBLE(parse_float(0));
+ ed->map.smooth = parse_bool(0);
}
/**
@page edcref
@property
- y
- @context
- description {
- ..
- map {
- rotation {
- y: 45.0;
- }
- }
- ..
- }
+ alpha
@parameters
- rotation in degrees around the y axis
+ [1 or 0]
@effect
- This sets the rotation of the part around the center set in degrees
+ This enable alpha channel when map rendering. Default is 1.
@endproperty
*/
static void
-st_collections_group_parts_part_description_map_rotation_y(void)
+st_collections_group_parts_part_description_map_alpha(void)
{
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -5885,31 +5858,23 @@
ed = ep->default_desc;
if (ep->other_desc) ed = eina_list_data_get(eina_list_last(ep->other_desc));
- ed->map.rot.y = FROM_DOUBLE(parse_float(0));
+ ed->map.alpha = parse_bool(0);
}
/**
@page edcref
@property
- z
- @context
- description {
- ..
- map {
- rotation {
- z: 45.0;
- }
- }
- ..
- }
+ backface_cull
@parameters
- rotation in degrees around the z axis
+ [1 or 0]
@effect
- This sets the rotation of the part around the center set in degrees
+ This enables backface culling (when the rotated part that normally
+ faces the camera is facing away after being rotated etc.). This means
+ that the object will be hidden when "backface culled".
@endproperty
*/
static void
-st_collections_group_parts_part_description_map_rotation_z(void)
+st_collections_group_parts_part_description_map_backface_cull(void)
{
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -5922,29 +5887,24 @@
ed = ep->default_desc;
if (ep->other_desc) ed = eina_list_data_get(eina_list_last(ep->other_desc));
- ed->map.rot.z = FROM_DOUBLE(parse_float(0));
+ ed->map.backcull = parse_bool(0);
}
/**
@page edcref
@property
- on
- @context
- description {
- ..
- map {
- on: 1;
- }
- ..
- }
+ perspective_on
@parameters
- enable map at all (1/0)
+ enable perspective when rotating
@effect
- This enables mapping for the part. Default is 0.
+ This enables perspective even without a perspective point object.
+ This would use perspective set for the object itself or for the
+ canvas as a whole as the global perspective with
+ edje_perspective_set() and edje_perspective_global_set().
@endproperty
*/
static void
-st_collections_group_parts_part_description_map_on(void)
+st_collections_group_parts_part_description_map_perspective_on(void)
{
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -5957,32 +5917,42 @@
ed = ep->default_desc;
if (ep->other_desc) ed = eina_list_data_get(eina_list_last(ep->other_desc));
- ed->map.on = parse_bool(0);
+ ed->map.persp_on = parse_bool(0);
}
/**
@page edcref
- @property
- smooth
+ @block
+ rotation
@context
- description {
- ..
- map {
- smooth: 1;
- }
- ..
+ map {
+ ..
+ rotation {
+ center: "name";
+ x: 45.0;
+ y: 45.0;
+ z: 45.0;
}
+ ..
+ }
+ @description
+ Rotates the part, optionally with the center on another part.
+ @endblock
+
+ @property
+ center
@parameters
- enable map smooth rendering (linear interpolation) (1/0)
+ [another part's name]
@effect
- This enable smooth map rendering. This may be linear interpolation,
- asinortopic filtering or anything the engine decides is "smooth".
- This is a best-effort hint and may not produce precisely the same
- results in all engines and situations. Default is 1
+ This sets the part that is used as the center of rotation when
+ rotating the part with this description. The part's center point
+ is used as the rotation center when applying rotation around the
+ x, y and z axes. If no center is given, the parts original center
+ itself is used for the rotation center.
@endproperty
*/
static void
-st_collections_group_parts_part_description_map_smooth(void)
+st_collections_group_parts_part_description_map_rotation_center(void)
{
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -5995,29 +5965,28 @@
ed = ep->default_desc;
if (ep->other_desc) ed = eina_list_data_get(eina_list_last(ep->other_desc));
- ed->map.smooth = parse_bool(0);
+ {
+ char *name;
+
+ name = parse_str(0);
+ data_queue_part_lookup(pc, name, &(ed->map.rot.id_center));
+ free(name);
+ }
}
/**
@page edcref
@property
- alpha
- @context
- description {
- ..
- map {
- alpha: 1;
- }
- ..
- }
+ x
@parameters
- enable map alpha rendering (1/0)
+ [X degrees]
@effect
- This enable alpha channel when map rendering. Default is 1
+ This sets the rotation around the x axis of the part considering
+ the center set. In degrees.
@endproperty
*/
static void
-st_collections_group_parts_part_description_map_alpha(void)
+st_collections_group_parts_part_description_map_rotation_x(void)
{
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -6030,31 +5999,22 @@
ed = ep->default_desc;
if (ep->other_desc) ed = eina_list_data_get(eina_list_last(ep->other_desc));
- ed->map.alpha = parse_bool(0);
+ ed->map.rot.x = FROM_DOUBLE(parse_float(0));
}
/**
@page edcref
@property
- backface_cull
- @context
- description {
- ..
- map {
- backface_cull: 1;
- }
- ..
- }
+ y
@parameters
- enable backface culling (1/0)
+ [Y degrees]
@effect
- This enables backface culling (when the rotated part that normally
- faces the camera is facing away after being rotated etc.). This means
- that the object will be hidden when "backface culled".
+ This sets the rotation around the u axis of the part considering
+ the center set. In degrees.
@endproperty
*/
static void
-st_collections_group_parts_part_description_map_backface_cull(void)
+st_collections_group_parts_part_description_map_rotation_y(void)
{
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -6067,32 +6027,22 @@
ed = ep->default_desc;
if (ep->other_desc) ed = eina_list_data_get(eina_list_last(ep->other_desc));
- ed->map.backcull = parse_bool(0);
+ ed->map.rot.y = FROM_DOUBLE(parse_float(0));
}
/**
@page edcref
@property
- perspective_on
- @context
- description {
- ..
- map {
- perspective_on: 1;
- }
- ..
- }
+ z
@parameters
- enable perspective when rotating
+ [Z degrees]
@effect
- This enables perspective even without a perspective point object.
- This would use perspective set for the object itself or for the
- canvas as a whole as the global perspective with
- edje_perspective_set() and edje_perspective_global_set().
+ This sets the rotation around the z axis of the part considering
+ the center set. In degrees.
@endproperty
*/
static void
-st_collections_group_parts_part_description_map_perspective_on(void)
+st_collections_group_parts_part_description_map_rotation_z(void)
{
Edje_Part_Collection *pc;
Edje_Part *ep;
@@ -6105,26 +6055,33 @@
ed = ep->default_desc;
if (ep->other_desc) ed = eina_list_data_get(eina_list_last(ep->other_desc));
- ed->map.persp_on = parse_bool(0);
+ ed->map.rot.z = FROM_DOUBLE(parse_float(0));
}
-
/**
@page edcref
- @property
- z
+ @block
+ perspective
@context
- description {
- ..
- perspective {
- zplane: 0;
- }
- ..
+ description {
+ ..
+ perspective {
+ zplane: 0;
+ focal: 1000;
}
+ ..
+ }
+ @description
+ Adds focal and plane perspective to the part. Active if perspective_on
is true.
+ Must be provided if the part is being used by other part as it's
perspective target.
+ @endblock
+
+ @property
+ zplane
@parameters
- the z value that will be "unscaled".
+ [unscaled Z value]
@effect
- This sets the z value that wil 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.
@endproperty
*/
@@ -6150,16 +6107,8 @@
@page edcref
@property
focal
- @context
- description {
- ..
- perspective {
- focal: 1000;
- }
- ..
- }
@parameters
- focal distance from camera to focal plane
+ [distance]
@effect
This sets the distance from the focal z plane (zplane) and the
camera - i.e. very much equating to focal length of the camera
@@ -6182,6 +6131,25 @@
ed->persp.focal = parse_int_range(0, 1, 0x7fffffff);
}
+/**
+ @page edcref
+ @block
+ params
+ @context
+ description {
+ ..
+ params {
+ int: "name" 0;
+ double: "other_name" 0.0;
+ string: "another_name" "some text";
+ }
+ ..
+ }
+ @description
+ Set parameters for EXTERNAL parts. The value overwrites previous
+ definitions with the same name.
+ @endblock
+*/
static void
_st_collections_group_parts_part_description_params(Edje_External_Param_Type
type)
{
@@ -6252,11 +6220,11 @@
/**
@page edcref
@property
- inherit
+ int
@parameters
[param_name] [int_value]
@effect
- Adds an integer parameter for an external object
+ Adds an integer parameter for an external object
@endproperty
*/
static void
@@ -6268,11 +6236,11 @@
/**
@page edcref
@property
- inherit
+ double
@parameters
[param_name] [double_value]
@effect
- Adds a double parameter for an external object
+ Adds a double parameter for an external object
@endproperty
*/
static void
@@ -6284,11 +6252,11 @@
/**
@page edcref
@property
- inherit
+ string
@parameters
[param_name] [string_value]
@effect
- Adds a string parameter for an external object
+ Adds a string parameter for an external object
@endproperty
*/
static void
@@ -6435,11 +6403,11 @@
@property
filter
@parameters
- [filter part state]
+ [part] [state]
@effect
- The part [part] should be in state [state] for the signal to be
accepted. Only one source state
- keyword per program may be used. ex:state: "button" "default";
(Signals are accepted
- if part button is currently in state named "default").
+ Filter signals to be only accepted if the part [part] is in state
named [state].
+ Only one filter per program can be used. If [state] is not given, the
source of
+ the event will be used instead.
@endproperty
*/
static void
@@ -6577,9 +6545,9 @@
@parameters
[type] [length]
@effect
- Defines how transistions occur using STATE_SET action.\n
- Where 'type' is the style of the transistion and 'length' is a double
- specifying the number of seconds in which to preform the transistion.\n
+ Defines how transitions occur using STATE_SET action.\n
+ Where 'type' is the style of the transition and 'length' is a double
+ specifying the number of seconds in which to preform the transition.\n
Valid types are: LINEAR, SINUSOIDAL, ACCELERATE, and DECELERATE.
@endproperty
*/
@@ -6724,19 +6692,6 @@
}
}
-/**
- @page edcref
- @property
- api
- @parameters
- [name] [description]
- @effect
- Specifies a hint to let applications (or IDE's) know how to bind
- things. The parameter name should contain the name of the function that
- the application should use, and description describes how it should
- be used.
- @endproperty
-*/
static void
st_collections_group_parts_part_api(void)
{
------------------------------------------------------------------------------
Download Intel® Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel
