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

evas_canvas: prepare for doc conversion + partial conversion

This commit is contained in:
Daniel Kolesa 2015-09-02 15:13:36 +01:00
parent 03bbe8a4a7
commit 00678aea1b
1 changed files with 189 additions and 219 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

408
src/lib/evas/canvas/evas_canvas.eo
View File

@ -5,264 +5,234 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
methods {
@property output_framespace {
set {
/*@
Sets the output framespace size of the render engine of the given evas.
[[Sets the output framespace size of the render engine of the
given evas.
The framespace size is used in the Wayland engines to denote space where
the output is not drawn. This is mainly used in ecore_evas to draw borders
The framespace size is used in the Wayland engines to denote
space where the output is not drawn. This is mainly used in
ecore_evas to draw borders.
The units used for @p w and @p h depend on the engine used by the
evas.
The units used for $w and $h depend on the engine used by the
evas.
@ingroup Evas_Output_Size
@since 1.1 */
@since 1.1
]]
}
get {
/*@
Get the render engine's output framespace co-ordinates in canvas units.
[[Get the render engine's output framespace co-ordinates in
canvas units.
@ingroup Evas_Output_Size
@since 1.1 */
@since 1.1
]]
}
values {
x: Evas.Coord; /*@ The left coordinate in output units, usually pixels. */
y: Evas.Coord; /*@ The top coordinate in output units, usually pixels. */
w: Evas.Coord; /*@ The width in output units, usually pixels. */
h: Evas.Coord; /*@ The height in output units, usually pixels. */
x: Evas.Coord; [[The left coordinate in output units, usually pixels.]]
y: Evas.Coord; [[The top coordinate in output units, usually pixels.]]
w: Evas.Coord; [[The width in output units, usually pixels.]]
h: Evas.Coord; [[The height in output units, usually pixels.]]
}
}
@property output_viewport {
set {
/*@
Sets the output viewport of the given evas in evas units.
[[Sets the output viewport of the given evas in evas units.
The output viewport is the area of the evas that will be visible to
the viewer. The viewport will be stretched to fit the output
target of the evas when rendering is performed.
The output viewport is the area of the evas that will be
visible to the viewer. The viewport will be stretched to
fit the output target of the evas when rendering is performed.
@note The coordinate values do not have to map 1-to-1 with the output
target. However, it is generally advised that it is done for ease
of use.
@ingroup Evas_Output_Size */
Note: The coordinate values do not have to map 1-to-1 with
the output target. However, it is generally advised that it
is done for ease of use.
]]
}
get {
/*@
Get the render engine's output viewport co-ordinates in canvas units.
Calling this function writes the current canvas output viewport
size and location values into the variables pointed to by @p x, @p
y, @p w and @p h. On success the variables have the output
location and size values written to them in canvas units. Any of @p
x, @p y, @p w or @p h that are @c NULL will not be written to. If @p e
is invalid, the results are undefined.
[[Get the render engine's output viewport co-ordinates in
canvas units.
Calling this function writes the current canvas output
viewport size and location values into the variables pointed
to by $x, $y, $w and $h. On success the variables have the
output location and size values written to them in canvas
units. Any of $x, $y, $w or $h that are $null will not be
written to. If $e is invalid, the results are undefined.
]]
/* FIXME-doc
Example:
@code
extern Evas *evas;
Evas_Coord x, y, width, height;
evas_output_viewport_get(evas, &x, &y, &w, &h);
@endcode */
@endcode
*/
}
values {
x: Evas.Coord; /*@ The top-left corner x value of the viewport. */
y: Evas.Coord; /*@ The top-left corner y value of the viewport. */
w: Evas.Coord; /*@ The width of the viewport. Must be greater than 0. */
h: Evas.Coord; /*@ The height of the viewport. Must be greater than 0. */
x: Evas.Coord; [[The top-left corner x value of the viewport.]]
y: Evas.Coord; [[The top-left corner y value of the viewport.]]
w: Evas.Coord; [[The width of the viewport. Must be greater than 0.]]
h: Evas.Coord; [[The height of the viewport. Must be greater than 0.]]
}
}
@property image_cache {
set {
/*@
Set the image cache.
[[Set the image cache.
This function sets the image cache of canvas in bytes. */
This function sets the image cache of canvas in bytes.
]]
}
get {
/*@
Get the image cache
[[Get the image cache.
This function returns the image cache size of canvas in bytes. */
This function returns the image cache size of canvas in bytes.
]]
}
values {
size: int; /*@ The cache size. */
size: int; [[The cache size.]]
}
}
@property event_default_flags {
set {
/*@
Set the default set of flags an event begins with
[[Set the default set of flags an event begins with
Events in evas can have an event_flags member. This starts out with
and initial value (no flags). This lets you set the default flags that
an event begins with to be @p flags
Events in evas can have an event_flags member. This starts
out with and initial value (no flags). This lets you set
the default flags that an event begins with to be $flags.
@since 1.2 */
@since 1.2
]]
}
get {
/*@
Get the default set of flags an event begins with
[[Get the default set of flags an event begins with
@return The default event flags for that canvas
This gets the default event flags events are produced with
when fed in.
This gets the default event flags events are produced with when fed in.
@see evas_event_default_flags_set()
@since 1.2 */
@since 1.2
]]
}
values {
flags: Evas.Event_Flags; /*@ The default flags to use */
flags: Evas.Event_Flags; [[The default flags to use.]]
}
}
@property output_method {
set {
/*@
Sets the output engine for the given evas.
[[Sets the output engine for the given evas.
Once the output engine for an evas is set, any attempt to change it
will be ignored. The value for @p render_method can be found using
@ref evas_render_method_lookup .
Once the output engine for an evas is set, any attempt to
change it will be ignored. The value for $render_method can
be found using \@ref evas_render_method_lookup.
@attention it is mandatory that one calls evas_init() before
setting the output method.
@ingroup Evas_Output_Method */
Note: it is mandatory that one calls \@ref evas_init before
setting the output method.
]]
}
get {
/*@
Retrieves the number of the output engine used for the given evas.
@return The ID number of the output engine being used. @c 0 is
returned if there is an error.
@ingroup Evas_Output_Method */
[[Retrieves the number of the output engine used for the given
evas.
]]
}
values {
render_method: int; /*@ The numeric engine value to use. */
render_method: int; [[The numeric engine value to use.]]
}
}
@property font_cache {
set {
/*@
Changes the size of font cache of the given evas.
@ingroup Evas_Font_Group */
[[Changes the size of font cache of the given evas.]]
}
get {
/*@
Changes the size of font cache of the given evas.
@return The size, in bytes.
@ingroup Evas_Font_Group */
[[Get the size of font cache of the given evas in bytes.]]
}
values {
size: int; /*@ The size, in bytes. */
size: int; [[The size in bytes.]]
}
}
@property output_size {
set {
/*@
Sets the output size of the render engine of the given evas.
[[Sets the output size of the render engine of the given evas.
The evas will render to a rectangle of the given size once this
function is called. The output size is independent of the viewport
size. The viewport will be stretched to fill the given rectangle.
The evas will render to a rectangle of the given size once
this function is called. The output size is independent of
the viewport size. The viewport will be stretched to fill
the given rectangle.
The units used for @p w and @p h depend on the engine used by the
evas.
@ingroup Evas_Output_Size */
The units used for $w and $h depend on the engine used by the
evas.
]]
}
get {
/*@
Retrieve the output size of the render engine of the given evas.
[[Retrieve the output size of the render engine of the given
evas.
The output size is given in whatever the output units are for the
engine.
The output size is given in whatever the output units are for
the engine.
If either @p w or @p h is @c NULL, then it is ignored. If @p e is
invalid, the returned results are undefined.
@ingroup Evas_Output_Size */
If either $w or $h is $null, then it is ignored. If $e is
invalid, the returned results are undefined.
]]
}
values {
w: int; /*@ The width in output units, usually pixels. */
h: int; /*@ The height in output units, usually pixels. */
w: int; [[The width in output units, usually pixels.]]
h: int; [[The height in output units, usually pixels.]]
}
}
@property data_attach {
set {
/*@
Attaches a specific pointer to the evas for fetching later
@ingroup Evas_Canvas */
[[Attaches a specific pointer to the evas for fetching later.]]
}
get {
/*@
Returns the pointer attached by evas_data_attach_set()
@return The pointer attached
@ingroup Evas_Canvas */
[[Returns the pointer attached by @.data_attach.set.]]
}
values {
data: void *; /*@ The pointer to attach */
data: void *; [[The attached pointer.]]
}
}
@property font_hinting {
set {
/*@
Changes the font hinting for the given evas.
[[Changes the font hinting for the given evas.
#EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
@ingroup Evas_Font_Group */
#EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
]]
}
get {
/*@
Retrieves the font hinting used by the given evas.
@return The hinting in use, one of #EVAS_FONT_HINTING_NONE,
#EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
@ingroup Evas_Font_Group */
[[Retrieves the font hinting used by the given evas.]]
}
values {
hinting: Evas.Font.Hinting_Flags; /*@ The hinting to use, one of #EVAS_FONT_HINTING_NONE, */
hinting: Evas.Font.Hinting_Flags; [[
The used hinting, one of #EVAS_FONT_HINTING_NONE,
#EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
]]
}
}
@property engine_info {
set {
/*@
Applies the engine settings for the given evas from the given @c
Evas_Engine_Info structure.
[[Applies the engine settings for the given evas from the
given $Evas_Engine_Info structure.
To get the Evas_Engine_Info structure to use, call @ref
evas_engine_info_get . Do not try to obtain a pointer to an
@c Evas_Engine_Info structure in any other way.
To get the Evas_Engine_Info structure to use, call \@ref
evas_engine_info_get. Do not try to obtain a pointer to an
$Evas_Engine_Info structure in any other way.
You will need to call this function at least once before you can
create objects on an evas or render that evas. Some engines allow
their settings to be changed more than once.
You will need to call this function at least once before you
can create objects on an evas or render that evas. Some
engines allow their settings to be changed more than once.
Once called, the @p info pointer should be considered invalid.
@return @c EINA_TRUE if no error occurred, @c EINA_FALSE otherwise.
@ingroup Evas_Output_Method */
return: bool;
Once called, the $info pointer should be considered invalid.
]]
return: bool; [[$true if no error occurred, $false otherwise.]]
}
get {
/*@
Retrieves the current render engine info struct from the given evas.
[[Retrieves the current render engine info struct from the given
evas.
The returned structure is publicly modifiable. The contents are
valid until either @ref evas_engine_info_set or @ref evas_render
are called.
The returned structure is publicly modifiable. The contents
are valid until either \@ref evas_engine_info_set or \@ref
evas_render are called.
This structure does not need to be freed by the caller.
@return A pointer to the Engine Info structure. @c NULL is returned if
an engine has not yet been assigned.
@ingroup Evas_Output_Method */
This structure does not need to be freed by the caller.
]]
}
values {
info: Evas.Engine_Info *; /*@ The pointer to the Engine Info to use */
info: Evas.Engine_Info *; [[The pointer to the engine info to use.]]
}
}
@property focus {
@ -270,7 +240,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
/*@
Retrieve the object that currently has focus.
@return The object that has focus or @c NULL if there is not one.
@return The object that has focus or $null if there is not one.
Evas can have (at most) one of its objects focused at a time.
Focused objects will be the ones having <b>key events</b> delivered
@ -283,7 +253,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
receiving input for them.
This call returns the object that currently has focus on the canvas
@p e or @c NULL, if none.
$e or $null, if none.
@see evas_object_focus_set
@see evas_object_focus_get
@ -298,7 +268,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@skip called when our rectangle gets focus
@until }
In this example the @c event_info is exactly a pointer to that
In this example the $event_info is exactly a pointer to that
focused rectangle. See the full @ref Example_Evas_Events "example".
@ingroup Evas_Object_Group_Find */
@ -308,9 +278,9 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@property object_top {
get {
/*@
Get the highest (stacked) Evas object on the canvas @p e.
Get the highest (stacked) Evas object on the canvas $e.
@return a pointer to the highest object on it, if any, or @c NULL,
@return a pointer to the highest object on it, if any, or $null,
otherwise
This function will take all populated layers in the canvas into
@ -332,7 +302,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
get {
/*@
Returns a handle to the list of lock keys registered in the canvas
@p e. This is required to check for which locks are set at a given
$e. This is required to check for which locks are set at a given
time with the evas_key_lock_is_set() function.
@see evas_key_lock_add
@ -342,7 +312,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@see evas_key_lock_is_set
@return An .Evas_Lock handle to query Evas' keys subsystem with
evas_key_lock_is_set(), or @c NULL on error. */
evas_key_lock_is_set(), or $null on error. */
return: const(Evas.Lock)* @warn_unused;
}
}
@ -353,7 +323,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
This function returns the current known canvas unit co-ordinates of
the mouse pointer and sets the contents of the Evas_Coords pointed
to by @p x and @p y to contain these co-ordinates. If @p e is not a
to by $x and $y to contain these co-ordinates. If $e is not a
valid canvas the results of this function are undefined.
Example:
@ -376,7 +346,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
/*@
Get the number of mouse or multi presses currently active
@p e The given canvas pointer.
$e The given canvas pointer.
@return The number of presses (0 if none active).
@since 1.2 */
@ -406,7 +376,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
/*@
Get the focus state known by the given evas
@return @c EINA_TRUE if it got the focus, @c EINA_FALSE otherwise.
@return $true if it got the focus, $false otherwise.
@ingroup Evas_Canvas */
return: bool;
}
@ -416,7 +386,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
/*@
Get the changed marker for the canvas
@return @c EINA_TRUE if something has been marked as changed, @c EINA_FALSE otherwise.
@return $true if something has been marked as changed, $false otherwise.
@ingroup Evas_Canvas
@since 1.11
*/
@ -430,7 +400,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
This function returns the current known screen/output co-ordinates
of the mouse pointer and sets the contents of the integers pointed
to by @p x and @p y to contain these co-ordinates. If @p e is not a
to by $x and $y to contain these co-ordinates. If $e is not a
valid canvas the results of this function are undefined.
Example:
@ -467,7 +437,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
A canvas begins with the mouse being assumed outside (0).
If @p e is not a valid canvas, the return value is undefined.
If $e is not a valid canvas, the return value is undefined.
Example:
@code
@ -485,9 +455,9 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
Get the maximum image size evas can possibly handle
This function returns the larges image or surface size that evas can handle
in pixels, and if there is one, returns @c EINA_TRUE. It returns
@c EINA_FALSE if no extra constraint on maximum image size exists. You still
should check the return values of @p maxw and @p maxh as there may still be
in pixels, and if there is one, returns $true. It returns
$false if no extra constraint on maximum image size exists. You still
should check the return values of $maxw and $maxh as there may still be
a limit, just a much higher one.
@since 1.1 */
@ -501,9 +471,9 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@property object_bottom {
get {
/*@
Get the lowest (stacked) Evas object on the canvas @p e.
Get the lowest (stacked) Evas object on the canvas $e.
@return a pointer to the lowest object on it, if any, or @c NULL,
@return a pointer to the lowest object on it, if any, or $null,
otherwise
This function will take all populated layers in the canvas into
@ -524,7 +494,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
get {
/*@
Returns a handle to the list of modifier keys registered in the
canvas @p e. This is required to check for which modifiers are set
canvas $e. This is required to check for which modifiers are set
at a given time with the evas_key_modifier_is_set() function.
@see evas_key_modifier_add
@ -534,7 +504,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@see evas_key_modifier_is_set
@return An .Evas_Modifier handle to query Evas' keys subsystem
with evas_key_modifier_is_set(), or @c NULL on error. */
with evas_key_modifier_is_set(), or $null on error. */
return: const(Evas.Modifier)* @warn_unused;
}
}
@ -561,7 +531,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
(button 1) and the most significant bit corresponds to the last
mouse button (button 32).
If @p e is not a valid canvas, the return value is undefined.
If $e is not a valid canvas, the return value is undefined.
Example:
@code
@ -614,8 +584,8 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
key_lock_on {
/*@
Enables or turns on programmatically the lock key with name @p
keyname.
Enables or turns on programmatically the lock key with name
$keyname.
The effect will be as if the key was put on its active state after
this call.
@ -648,12 +618,12 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
key_modifier_mask_get @const {
/*@
Creates a bit mask from the @p keyname @b modifier key. Values
Creates a bit mask from the $keyname @b modifier key. Values
returned from different calls to it may be ORed together,
naturally.
@returns the bit mask or 0 if the @p keyname key wasn't registered as a
modifier for canvas @p e.
@returns the bit mask or 0 if the $keyname key wasn't registered as a
modifier for canvas $e.
This function is meant to be using in conjunction with
evas_object_key_grab()/evas_object_key_ungrab(). Go check their
@ -673,7 +643,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
key_modifier_add {
/*@
Adds the @p keyname key to the current list of modifier keys.
Adds the $keyname key to the current list of modifier keys.
Modifiers are keys like shift, alt and ctrl, i.e., keys which are
meant to be pressed together with others, altering the behavior of
@ -705,7 +675,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
key_modifier_off {
/*@
Disables or turns off programmatically the modifier key with name
@p keyname.
$keyname.
@see evas_key_modifier_add
@see evas_key_modifier_get
@ -796,7 +766,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
a canvas
@return The list of Evas objects that are over the given position
in @p e
in $e
This function will traverse all the layers of the given canvas,
from top to bottom, querying for objects with areas covering the
@ -856,18 +826,18 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
/*@
Render the given Evas canvas asynchronously.
@return EINA_TRUE if the canvas will render, EINA_FALSE otherwise.
@return $true if the canvas will render, $false otherwise.
This function only returns EINA_TRUE when a frame will be rendered. If the
previous frame is still rendering, EINA_FALSE will be returned so the users
This function only returns $true when a frame will be rendered. If the
previous frame is still rendering, $false will be returned so the users
know not to wait for the updates callback and just return to their main
loop.
If a @p func callback is given, a list of updated areas will be generated
If a $func callback is given, a list of updated areas will be generated
and the function will be called from the main thread after the rendered
frame is flushed to the screen. The resulting list should be freed with
@f evas_render_updates_free().
The list is given in the @p event_info parameter of the callback function.
The list is given in the $event_info parameter of the callback function.
@ingroup Evas_Canvas
@since 1.8 */
@ -880,10 +850,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
This is experimental and will change over time until noted here.
@return EINA_TRUE if the canvas will render, EINA_FALSE otherwise.
@return $true if the canvas will render, $false otherwise.
This function only returns EINA_TRUE when a frame will be rendered. If the
previous frame is still rendering, EINA_FALSE will be returned so the users
This function only returns $true when a frame will be rendered. If the
previous frame is still rendering, $false will be returned so the users
know not to wait for the updates callback and just return to their main
loop.
@ -899,7 +869,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
This is experimental and will change over time until noted here.
@return A newly allocated list of updated rectangles of thecanvas
(@c Eina.Rectangle structs). Free this list with
($Eina.Rectangle structs). Free this list with
evas_render_updates_free().
@ingroup Evas_Canvas
@ -1007,8 +977,8 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
key_lock_off {
/*@
Disables or turns off programmatically the lock key with name @p
keyname.
Disables or turns off programmatically the lock key with name
$keyname.
The effect will be as if the key was put on its inactive state
after this call.
@ -1047,7 +1017,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
Checks if the font hinting is supported by the given evas.
#EVAS_FONT_HINTING_AUTO, #EVAS_FONT_HINTING_BYTECODE.
@return @c EINA_TRUE if it is supported, @c EINA_FALSE otherwise.
@return $true if it is supported, $false otherwise.
@ingroup Evas_Font_Group */
return: bool @warn_unused;
params {
@ -1082,8 +1052,8 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
key_modifier_on {
/*@
Enables or turns on programmatically the modifier key with name @p
keyname.
Enables or turns on programmatically the modifier key with name
$keyname.
The effect will be as if the key was pressed for the whole time
between this call and a matching evas_key_modifier_off().
@ -1171,7 +1141,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
/*@
Retrieves the object on the given evas with the given name.
@return If successful, the Evas object with the given name. Otherwise,
@c NULL.
$null.
This looks for the evas object given a name by evas_object_name_set(). If
the name is not unique canvas-wide, then which one of the many objects
@ -1195,12 +1165,12 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
touch_point_list_nth_id_get {
/*@
This function returns the @p id of nth touch point.
This function returns the $id of nth touch point.
@return id of nth touch point, if the call succeeded, -1 otherwise.
The point which comes from Mouse Event has @p id 0 and The point
which comes from Multi Event has @p id that is same as Multi
The point which comes from Mouse Event has $id 0 and The point
which comes from Multi Event has $id that is same as Multi
Event's device id.
Example:
@ -1232,7 +1202,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
smart_objects_calculate {
/*@
Call user-provided @c calculate() smart functions and unset the
Call user-provided $calculate smart functions and unset the
flag signalling that the object needs to get recalculated to @b all
smart objects in the canvas.
@ -1272,8 +1242,8 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
key_lock_del {
/*@
Removes the @p keyname key from the current list of lock keys on
canvas @p e.
Removes the $keyname key from the current list of lock keys on
canvas $e.
@see evas_key_lock_get
@see evas_key_lock_add
@ -1326,10 +1296,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@return The output/screen co-ordinate translated to output co-ordinates
@ingroup Evas_Coord_Mapping_Group
This function takes in a horizontal co-ordinate as the @p x
This function takes in a horizontal co-ordinate as the $x
parameter and converts it into output units, accounting for output
size, viewport size and location, returning it as the function
return value. If @p e is invalid, the results are undefined.
return value. If $e is invalid, the results are undefined.
Example:
@code
@ -1366,11 +1336,11 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
Force immediate renderization of the given Evas canvas.
@return A newly allocated list of updated rectangles of the canvas
(@c Eina.Rectangle structs). Free this list with
($Eina.Rectangle structs). Free this list with
evas_render_updates_free().
This function forces an immediate renderization update of the given
canvas @p e.
canvas $e.
@note This is a <b>very low level function</b>, which most of
Evas' users wouldn't care about. One would use it, for example, to
@ -1407,10 +1377,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@return The screen co-ordinate translated to canvas unit co-ordinates
@ingroup Evas_Coord_Mapping_Group
This function takes in a vertical co-ordinate as the @p y parameter
This function takes in a vertical co-ordinate as the $y parameter
and converts it into canvas units, accounting for output size,
viewport size and location, returning it as the function return
value. If @p e is invalid, the results are undefined.
value. If $e is invalid, the results are undefined.
Example:
@code
@ -1427,8 +1397,8 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
key_modifier_del {
/*@
Removes the @p keyname key from the current list of modifier keys
on canvas @p e.
Removes the $keyname key from the current list of modifier keys
on canvas $e.
@see evas_key_modifier_add
@see evas_key_modifier_get
@ -1442,12 +1412,12 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
touch_point_list_nth_state_get {
/*@
This function returns the @p state of nth touch point.
This function returns the $state of nth touch point.
@return @p state of nth touch point, if the call succeeded,
@return $state of nth touch point, if the call succeeded,
EVAS_TOUCH_POINT_CANCEL otherwise.
The point's @p state is EVAS_TOUCH_POINT_DOWN when pressed,
The point's $state is EVAS_TOUCH_POINT_DOWN when pressed,
EVAS_TOUCH_POINT_STILL when the point is not moved after pressed,
EVAS_TOUCH_POINT_MOVE when moved at least once after pressed and
EVAS_TOUCH_POINT_UP when released.
@ -1575,7 +1545,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
This function will traverse all the layers of the given canvas,
from top to bottom, querying for objects with areas overlapping
with the given rectangular region inside @p e. The user can remove
with the given rectangular region inside $e. The user can remove
from the query objects which are hidden and/or which are set to
pass events.
@ -1635,7 +1605,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
Remove all "obscured regions" from an Evas canvas.
This function removes all the rectangles from the obscured regions
list of the canvas @p e. It takes obscured areas added with
list of the canvas $e. It takes obscured areas added with
evas_obscured_rectangle_add() and make them again a regions that @b
have to be repainted on rendering updates.
@ -1672,10 +1642,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@return The screen co-ordinate translated to canvas unit co-ordinates
@ingroup Evas_Coord_Mapping_Group
This function takes in a horizontal co-ordinate as the @p x
This function takes in a horizontal co-ordinate as the $x
parameter and converts it into canvas units, accounting for output
size, viewport size and location, returning it as the function
return value. If @p e is invalid, the results are undefined.
return value. If $e is invalid, the results are undefined.
Example:
@code
@ -1692,7 +1662,7 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
}
key_lock_add {
/*@
Adds the @p keyname key to the current list of lock keys.
Adds the $keyname key to the current list of lock keys.
Locks are keys like caps lock, num lock or scroll lock, i.e., keys
which are meant to be pressed once -- toggling a binary state which
@ -1739,10 +1709,10 @@ class Evas.Canvas (Eo.Base, Evas.Common_Interface)
@return The output/screen co-ordinate translated to output co-ordinates
@ingroup Evas_Coord_Mapping_Group
This function takes in a vertical co-ordinate as the @p x parameter
This function takes in a vertical co-ordinate as the $x parameter
and converts it into output units, accounting for output size,
viewport size and location, returning it as the function return
value. If @p e is invalid, the results are undefined.
value. If $e is invalid, the results are undefined.
Example:
@code