q66 pushed a commit to branch master.
http://git.enlightenment.org/core/efl.git/commit/?id=f00013b018ef93780cfc630f38cac72a52babf76
commit f00013b018ef93780cfc630f38cac72a52babf76
Author: Daniel Kolesa <d.kol...@osg.samsung.com>
Date: Fri Aug 14 13:20:17 2015 +0100
evas_object,evas_image: partial doc conversion
---
src/lib/evas/canvas/evas_image.eo | 402 ++++++++++++++++---------------------
src/lib/evas/canvas/evas_object.eo | 228 ++++++++++-----------
2 files changed, 280 insertions(+), 350 deletions(-)
diff --git a/src/lib/evas/canvas/evas_image.eo
b/src/lib/evas/canvas/evas_image.eo
index 58a7baf..c12f5bb 100644
--- a/src/lib/evas/canvas/evas_image.eo
+++ b/src/lib/evas/canvas/evas_image.eo
@@ -5,236 +5,192 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
methods {
@property load_dpi {
set {
- /*@
- Set the DPI resolution of an image object's source image.
-
- This function sets the DPI resolution of a given loaded canvas
- image. Most useful for the SVG image loader.
+ [[Set the DPI resolution of an image object's source image.
- @see evas_object_image_load_dpi_get() */
+ This function sets the DPI resolution of a given loaded canvas
+ image. Most useful for the SVG image loader.
+ ]]
}
get {
- /*@
- Get the DPI resolution of a loaded image object in the canvas.
+ [[Get the DPI resolution of a loaded image object in the canvas.
- @return The DPI resolution of the given canvas image.
-
- This function returns the DPI resolution of the given canvas image.
-
- @see evas_object_image_load_dpi_set() for more details */
+ This function returns the DPI resolution of the given canvas
+ image.
+ ]]
}
values {
- dpi: double; /*@ The new DPI resolution. */
+ dpi: double; [[The DPI resolution.]]
}
}
@property source_clip {
set {
- /*@
- Clip the proxy object with the source object's clipper.
+ [[Clip the proxy object with the source object's clipper.
- @see evas_object_clip_set()
- @see evas_object_image_source_set()
- @since 1.8 */
+ @since 1.8
+ ]]
}
get {
- /*@
- Determine whether an object is clipped by source object's clipper.
+ [[Determine whether an object is clipped by source object's
+ clipper.
- @return @c EINA_TRUE if source clip is enabled, @c EINA_FALSE
otherwise.
-
- @see evas_object_clip_set()
- @see evas_object_image_source_set()
- @see evas_object_image_source_clip_set()
- @since 1.8 */
+ @since 1.8
+ ]]
}
values {
- source_clip: bool; /*@ whether @p obj is clipped by the source
clipper.
- (@c EINA_TRUE) or not (@c EINA_FALSE) */
+ source_clip: bool; [[Whether $obj is clipped by the source
+ clipper ($true) or not ($false).]]
}
}
@property source {
set {
- /*@
- Set the source object on an image object to used as a @b proxy.
-
- @return @c EINA_TRUE on success, @c EINA_FALSE on error.
-
- If an image object is set to behave as a @b proxy, it will mirror
- the rendering contents of a given @b source object in its drawing
- region, without affecting that source in any way. The source must
- be another valid Evas object. Other effects may be applied to the
- proxy, such as a map (see evas_object_map_set()) to create a
- reflection of the original object (for example).
-
- Any existing source object on @p obj will be removed after this
- call. Setting @p src to @c NULL clears the proxy object (not in
- "proxy state" anymore).
-
- @warning You cannot set a proxy as another proxy's source.
-
- @see evas_object_image_source_get()
- @see evas_object_image_source_unset()
- @see evas_object_image_source_visible_set() */
+ [[Set the source object on an image object to used as a proxy.
+
+ If an image object is set to behave as a proxy, it will mirror
+ the rendering contents of a given source object in its drawing
+ region, without affecting that source in any way. The source
+ must be another valid Evas object. Other effects may be
+ applied to the proxy, such as a map (see
+ \@ref evas_object_map_set) to create a reflection of the
+ original object (for example).
+
+ Any existing source object on $obj will be removed after this
+ call. Setting $src to $null clears the proxy object (not in
+ "proxy state" anymore).
+
+ Warning: You cannot set a proxy as another proxy's source.
+ ]]
return: bool;
}
get {
- /*@
- Get the current source object of an image object.
-
- @return Source object (if any), or @c NULL, if not in "proxy mode"
- (or on errors).
-
- @see evas_object_image_source_set() for more details */
+ [[Get the current source object of an image object.]]
}
values {
- src: Evas.Object *; /*@ Source object to use for the proxy. */
+ src: Evas.Object *; [[Source object to use for the proxy.]]
}
}
@property filled {
set {
- /*@
- Set whether the image object's fill property should track the
- object's size.
+ [[Set whether the image object's fill property should track the
+ object's size.
- If @p setting is @c EINA_TRUE, then every evas_object_resize() will
- @b automatically trigger a call to evas_object_image_fill_set()
- with the that new size (and @c 0, @c 0 as source image's origin),
- so the bound image will fill the whole object's area.
-
- @see evas_object_image_filled_add()
- @see evas_object_image_fill_get() */
+ If $setting is $true, then every \@ref evas_object_resize will
+ automatically trigger a call to \@ref evas_object_image_fill_set
+ with the that new size (and 0, 0 as source image's origin),
+ so the bound image will fill the whole object's area.
+ ]]
}
get {
- /*@
- Retrieve whether the image object's fill property should track the
- object's size.
+ [[Retrieve whether the image object's fill property should track
+ the object's size.
- @return @c EINA_TRUE if it is tracking, @c EINA_FALSE, if not (and
- evas_object_fill_set() must be called manually).
-
- @see evas_object_image_filled_set() for more information */
+ Returns $true if it is tracking, $false if not (and
+ \@ref evas_object_fill_set must be called manually).
+ ]]
}
values {
- filled: bool; /*@ @c EINA_TRUE, to make the fill property follow
- object size or @c EINA_FALSE, otherwise. */
+ filled: bool; [[$true to make the fill property follow
+ object size or $false otherwise.]]
}
}
@property content_hint {
set {
- /*@
- Set the content hint setting of a given image object of the canvas.
+ [[Set the content hint setting of a given image object of the
+ canvas.
- This function sets the content hint value of the given image of the
- canvas. For example, if you're on the GL engine and your driver
- implementation supports it, setting this hint to
- #EVAS_IMAGE_CONTENT_HINT_DYNAMIC will make it need @b zero copies
- at texture upload time, which is an "expensive" operation.
-
- @see evas_object_image_content_hint_get() */
+ This function sets the content hint value of the given image
+ of the canvas. For example, if you're on the GL engine and
+ your driver implementation supports it, setting this hint to
+ #EVAS_IMAGE_CONTENT_HINT_DYNAMIC will make it need zero copies
+ at texture upload time, which is an "expensive" operation.
+ ]]
}
get {
- /*@
- Get the content hint setting of a given image object of the canvas.
-
- @return hint The content hint value set on it, one of the
- #Evas_Image_Content_Hint ones (#EVAS_IMAGE_CONTENT_HINT_NONE means
- an error).
-
- This function returns the content hint value of the given image of
- the canvas.
+ [[Get the content hint setting of a given image object of the
+ canvas.
- @see evas_object_image_content_hint_set() */
+ This returns #EVAS_IMAGE_CONTENT_HINT_NONE on error.
+ ]]
}
values {
- hint: Evas_Image_Content_Hint; /*@ The content hint value, one of
the
- #Evas_Image_Content_Hint ones. */
+ hint: Evas_Image_Content_Hint; [[The content hint value, one of
+ the #Evas_Image_Content_Hint
ones.]]
}
}
@property load_region {
set {
- /*@
- Inform a given image object to load a selective region of its
- source image.
-
- This function is useful when one is not showing all of an image's
- area on its image object.
+ [[Inform a given image object to load a selective region of its
+ source image.
- @note The image loader for the image format in question has to
- support selective region loading in order to this function to take
- effect.
+ This function is useful when one is not showing all of an
+ image's area on its image object.
- @see evas_object_image_load_region_get() */
+ Note: The image loader for the image format in question has
+ to support selective region loading in order to this function
+ to take effect.
+ ]]
}
get {
- /*@
- Retrieve the coordinates of a given image object's selective
- (source image) load region.
-
- @note Use @c NULL pointers on the coordinates you're not interested
- in: they'll be ignored by the function.
+ [[Retrieve the coordinates of a given image object's selective
+ (source image) load region.
- @see evas_object_image_load_region_get() */
+ Note: Use $null pointers on the coordinates you're not
+ interested in: they'll be ignored by the function.
+ ]]
}
values {
- x: int; /*@ X-offset of the region to be loaded. */
- y: int; /*@ Y-offset of the region to be loaded. */
- w: int; /*@ Width of the region to be loaded. */
- h: int; /*@ Height of the region to be loaded. */
+ x: int; [[X-offset of the region to be loaded.]]
+ y: int; [[Y-offset of the region to be loaded.]]
+ w: int; [[Width of the region to be loaded.]]
+ h: int; [[Height of the region to be loaded.]]
}
}
@property alpha {
set {
- /*@
- Enable or disable alpha channel usage on the given image object.
-
- This function sets a flag on an image object indicating whether or
- not to use alpha channel data. A value of @c EINA_TRUE makes it use
- alpha channel data, and @c EINA_FALSE makes it ignore that
- data. Note that this has nothing to do with an object's color as
- manipulated by evas_object_color_set().
+ [[Enable or disable alpha channel usage on the given image
+ object.
- @see evas_object_image_alpha_get() */
+ This function sets a flag on an image object indicating
+ whether or not to use alpha channel data. A value of $true
+ makes it use alpha channel data, and $false makes it ignore
+ that data. Note that this has nothing to do with an object's
+ color as manipulated by \@ref evas_object_color_set.
+ ]]
}
get {
- /*@
- Retrieve whether alpha channel data is being used on the given
- image object.
-
- @return Whether the alpha channel data is being used (@c EINA_TRUE)
- or not (@c EINA_FALSE).
+ [[Retrieve whether alpha channel data is being used on the
+ given image object.
- This function returns @c EINA_TRUE if the image object's alpha
- channel is being used, or @c EINA_FALSE otherwise.
-
- See @ref evas_object_image_alpha_set() for more details. */
+ This function returns $true if the image object's alpha
+ channel is being used, or $false otherwise.
+ ]]
}
values {
- alpha: bool; /*@ Whether to use alpha channel (@c EINA_TRUE) data
- or not (@c EINA_FALSE). */
+ alpha: bool; [[Whether to use alpha channel ($true) data
+ or not ($false).]]
}
}
@property border {
set {
- /*@
- Set the dimensions for an image object's border, a region which @b
- won't ever be scaled together with its center.
+ [[Set the dimensions for an image object's border, a region
+ which won't ever be scaled together with its center.
- When Evas is rendering, an image source may be scaled to fit the
- size of its image object. This function sets an area from the
- borders of the image inwards which is @b not to be scaled. This
- function is useful for making frames and for widget theming, where,
- for example, buttons may be of varying sizes, but their border size
- must remain constant.
+ When Evas is rendering, an image source may be scaled to fit
+ the size of its image object. This function sets an area from
+ the borders of the image inwards which is not to be scaled.
+ This function is useful for making frames and for widget
+ theming, where, for example, buttons may be of varying
+ sizes, but their border size must remain constant.
- The units used for @p l, @p r, @p t and @p b are canvas units.
+ The units used for $l, $r, $t and $b are canvas units.
- @note The border region itself @b may be scaled by the
- evas_object_image_border_scale_set() function.
-
- @note By default, image objects have no borders set, i. e. @c l, @c
- r, @c t and @c b start as @c 0.
+ Note: The border region itself may be scaled by the
+ @.border_scale.set function.
+ Note: By default, image objects have no borders set, i. e.
+ $l, $r, $t and $b start as 0.
+ ]]
+ /* FIXME-doc
See the following figures for visual explanation:\n
@htmlonly
<img src="image-borders.png" style="max-width: 100%;" />
@@ -248,122 +204,108 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
@endhtmlonly
@image rtf border-effect.png
@image latex border-effect.eps width=\textwidth
-
- @see evas_object_image_border_get()
- @see evas_object_image_border_center_fill_set() */
+ */
}
get {
- /*@
- Retrieve the dimensions for an image object's border, a region
- which @b won't ever be scaled together with its center.
+ [[Retrieve the dimensions for an image object's border, a
+ region which won't ever be scaled together with its center.
- @note Use @c NULL pointers on the border components you're not
- interested in: they'll be ignored by the function.
-
- See @ref evas_object_image_border_set() for more details. */
+ Note: Use $null pointers on the border components you're not
+ interested in: they'll be ignored by the function.
+ ]]
}
values {
- l: int; /*@ The border's left width. */
- r: int; /*@ The border's right width. */
- t: int; /*@ The border's top width. */
- b: int; /*@ The border's bottom width. */
+ l: int; [[The border's left width.]]
+ r: int; [[The border's right width.]]
+ t: int; [[The border's top width.]]
+ b: int; [[The border's bottom width.]]
}
}
@property border_scale {
set {
- /*@
- Sets the scaling factor (multiplier) for the borders of an image
- object.
-
- @see evas_object_image_border_set()
- @see evas_object_image_border_scale_get() */
+ [[Sets the scaling factor (multiplier) for the borders of an
+ image object.
+ ]]
}
get {
- /*@
- Retrieves the scaling factor (multiplier) for the borders of an
- image object.
-
- @return The scale factor set for its borders
-
- @see evas_object_image_border_set()
- @see evas_object_image_border_scale_set() */
+ [[Retrieves the scaling factor (multiplier) for the borders
+ of an image object.
+ ]]
}
values {
- scale: double; /*@ The scale factor (default is @c 1.0 - i.e. no
scaling) */
+ scale: double; [[The scale factor (default is 1.0 - i.e. no
scaling).]]
}
}
@property pixels_dirty {
set {
- /*@
- Mark whether the given image object is dirty and needs to request
its pixels.
-
- This function will only properly work if a pixels get callback has
been set.
+ [[Mark whether the given image object is dirty and needs to
+ request its pixels.
- @warning use this function if you really know what you are doing.
+ This function will only properly work if a pixels get
+ callback has been set.
- @see evas_object_image_pixels_get_callback_set() */
+ Warning: Use this function if you really know what you are
+ doing.
+ ]]
}
get {
- /*@
- Retrieves whether the given image object is dirty (needs to be
redrawn).
-
- @return Whether the image is dirty. */
+ [[Retrieves whether the given image object is dirty (needs to
+ be redrawn).
+ ]]
}
values {
- dirty: bool; /*@ Whether the image is dirty. */
+ dirty: bool; [[Whether the image is dirty.]]
}
}
@property video_surface {
set {
- /*@
- Set the video surface linked to a given image of the canvas
+ [[Set the video surface linked to a given image of the canvas.
- This function links a video surface to a given canvas image. */
+ @since 1.1
+ ]]
values {
- surf: Evas_Video_Surface*; /*@ The new video surface.
- @since 1.1 */
+ surf: Evas_Video_Surface*; [[The new video surface.]]
}
}
get {
- /*@
- Get the video surface linekd to a given image of the canvas
+ [[Get the video surface linekd to a given image of the canvas.
- @return The video surface of the given canvas image.
- @since 1.1
-
- This function returns the video surface linked to a given canvas
image. */
+ @since 1.1
+ ]]
values {
- surf: const(Evas_Video_Surface)*; /*@ The new video surface.
- @since 1.1 */
+ surf: const(Evas_Video_Surface)*; [[The new video surface.]]
}
}
}
@property video_surface_caps {
set {
- /*@ Set the video surface capabilities to a given image of the
canvas */
+ [[Set the video surface capabilities to a given image of the
canvas.]]
}
get {
- /*@ Get the video surface capabilities to a given image of the
canvas */
+ [[Get the video surface capabilities to a given image of the
canvas.]]
}
values {
- caps: uint; /*@ in */
+ caps: uint;
}
}
@property load_orientation {
set {
- /*@
- Define if the orientation information in the image file should be
honored.
+ [[Define if the orientation information in the image file
+ should be honored.
- @since 1.1 */
+ @since 1.1
+ ]]
}
get {
- /*@
- Get if the orientation information in the image file should be
honored.
+ [[Get if the orientation information in the image file should
+ be honored.
- @since 1.1 */
+ @since 1.1
+ ]]
}
values {
- enable: bool; /*@ @c EINA_TRUE means that it should honor the
orientation information */
+ enable: bool; [[$true means that it should honor the orientation
+ information.]]
}
}
@property border_center_fill {
@@ -402,7 +344,7 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
/*@
Set the source object to be visible or not.
- If the @p visible set to @c EINA_FALSE, the source object of the
proxy(@p obj
+ If the @p visible set to $false, the source object of the proxy(@p
obj
) will be invisible.
This API works differently to evas_object_show() and
evas_object_hide().
@@ -426,7 +368,7 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
/*@
Get the state of the source object visibility.
- @return @c EINA_TRUE if source object is visible, @c EINA_FALSE
otherwise.
+ @return $true if source object is visible, $false otherwise.
@see evas_object_image_source_visible_set()
@see evas_object_image_source_set()
@@ -435,7 +377,7 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
@since 1.8 */
}
values {
- visible: bool; /*@ @c EINA_TRUE is source object to be shown, @c
EINA_FALSE
+ visible: bool; /*@ $true is source object to be shown, $false
otherwise. */
}
}
@@ -517,12 +459,12 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
Set whether an Evas object is to repeat events to source.
- If @p source is @c EINA_TRUE, it will make events on @p obj to
also be
+ If @p source is $true, it will make events on @p obj to also be
repeated for the source object (see
evas_object_image_source_set()). Even the
@p obj and source geometries are different, the event position
will be
transformed to the source object's space.
- If @p source is @c EINA_FALSE, events occurring on @p obj will be
+ If @p source is $false, events occurring on @p obj will be
processed only on it.
@see evas_object_image_source_get()
@@ -534,7 +476,7 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
/*@
Determine whether an object is set to source events.
- @return @c EINA_TRUE if source object has events, @c EINA_FALSE
otherwise.
+ @return $true if source object has events, $false otherwise.
@see evas_object_image_source_set()
@see evas_object_image_source_visible_set()
@@ -542,8 +484,8 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
@since 1.8 */
}
values {
- source: bool; /*@ whether @p obj is to pass events (@c EINA_TRUE)
or not
- (@c EINA_FALSE) */
+ source: bool; /*@ whether @p obj is to pass events ($true) or not
+ ($false) */
}
}
@property colorspace {
@@ -798,7 +740,7 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
Determine wether the Evas_Object_Image replicate the content of the
canvas below.
- @return @c EINA_TRUE if it does, @c EINA_FALSE if it doesn't.
+ @return $true if it does, $false if it doesn't.
@since 1.15
*/
}
@@ -855,14 +797,14 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
Note that the raw data must be of the same size (see
evas_object_image_size_set(), which has to be called @b before this
one) and colorspace (see evas_object_image_colorspace_set()) of the
- image. If data is @c NULL, the current image data will be
+ image. If data is $null, the current image data will be
freed. Naturally, if one does not set an image object's data
manually, it will still have one, allocated by Evas.
@see evas_object_image_data_get() */
params {
- @in data: void *; /*@ The raw data, or @c NULL. */
+ @in data: void *; /*@ The raw data, or $null. */
}
}
data_get @const {
@@ -894,7 +836,7 @@ class Evas.Image (Evas.Object, Efl.File, Efl.Image,
Efl.Gfx.Fill, Efl.Gfx.View,
return: void * @warn_unused;
params {
@in for_writing: bool; /*@ Whether the data being retrieved will be
- modified (@c EINA_TRUE) or not (@c EINA_FALSE). */
+ modified ($true) or not ($false). */
}
}
preload_cancel {
diff --git a/src/lib/evas/canvas/evas_object.eo
b/src/lib/evas/canvas/evas_object.eo
index 060b069..451c2a1 100644
--- a/src/lib/evas/canvas/evas_object.eo
+++ b/src/lib/evas/canvas/evas_object.eo
@@ -7,18 +7,19 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
methods {
@property size_hint_max {
set {
- /*@
- Sets the hints for an object's maximum size.
-
- This is not a size enforcement in any way, it's just a hint that
- should be used whenever appropriate.
+ [[Sets the hints for an object's maximum size.
- Values @c -1 will be treated as unset hint components, when queried
- by managers.
+ This is not a size enforcement in any way, it's just a hint
+ that should be used whenever appropriate.
- @note Smart objects(such as elementary) can have their own size
hint
- policy. So calling this API may or may not affect the size of
smart objects.
+ Values -1 will be treated as unset hint components, when
+ queried by managers.
+ Note: Smart objects (such as elementary) can have their own
+ size hint policy. So calling this API may or may not affect
+ the size of smart objects.
+ ]]
+ /* FIXME-doc
Example:
@dontinclude evas-hints.c
@skip evas_object_size_hint_max_set
@@ -27,96 +28,83 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
In this example the maximum size hints change the behavior of an
Evas box when layouting its children. See the full @ref
Example_Evas_Size_Hints "example".
-
- @see evas_object_size_hint_max_get() */
+ */
}
get {
- /*@
- Retrieves the hints for an object's maximum size.
-
- These are hints on the maximum sizes @p obj should have. This is
- not a size enforcement in any way, it's just a hint that should be
- used whenever appropriate.
+ [[Retrieves the hints for an object's maximum size.
- @note Use @c NULL pointers on the hint components you're not
- interested in: they'll be ignored by the function.
+ These are hints on the maximum sizes $obj should have. This is
+ not a size enforcement in any way, it's just a hint that
+ should be used whenever appropriate.
- @see evas_object_size_hint_max_set() */
+ Note: Use $null pointers on the hint components you're not
+ interested in: they'll be ignored by the function.
+ ]]
}
values {
- w: Evas.Coord; /*@ Integer to use as the maximum width hint. */
- h: Evas.Coord; /*@ Integer to use as the maximum height hint. */
+ w: Evas.Coord; [[Integer to use as the maximum width hint.]]
+ h: Evas.Coord; [[Integer to use as the maximum height hint.]]
}
}
@property size_hint_request {
set {
- /*@
- Sets the hints for an object's optimum size.
-
- This is not a size enforcement in any way, it's just a hint that
- should be used whenever appropriate.
+ [[Sets the hints for an object's optimum size.
- Values @c 0 will be treated as unset hint components, when queried
- by managers.
+ This is not a size enforcement in any way, it's just a hint
+ that hould be used whenever appropriate.
- @note Smart objects(such as elementary) can have their own size
hint
- policy. So calling this API may or may not affect the size of
smart objects.
+ Values 0 will be treated as unset hint components, when
+ queried by managers.
- @see evas_object_size_hint_request_get() */
+ Note: Smart objects(such as elementary) can have their own
+ size hint policy. So calling this API may or may not affect
+ the size of smart objects.
+ ]]
}
get {
- /*@
- Retrieves the hints for an object's optimum size.
-
- These are hints on the optimum sizes @p obj should have. This is
- not a size enforcement in any way, it's just a hint that should be
- used whenever appropriate.
+ [[Retrieves the hints for an object's optimum size.
- @note Use @c NULL pointers on the hint components you're not
- interested in: they'll be ignored by the function.
+ These are hints on the optimum sizes $obj should have.
+ This is not a size enforcement in any way, it's just a hint
+ that should be used whenever appropriate.
- @see evas_object_size_hint_request_set() */
+ Note: Use $null pointers on the hint components you're not
+ interested in: they'll be ignored by the function.
+ ]]
}
values {
- w: Evas.Coord; /*@ Integer to use as the preferred width hint. */
- h: Evas.Coord; /*@ Integer to use as the preferred height hint. */
+ w: Evas.Coord; [[Integer to use as the preferred width hint.]]
+ h: Evas.Coord; [[Integer to use as the preferred height hint.]]
}
}
@property type {
set {
- /*@ Sets the type of the given Evas object. */
+ [[Sets the type of the given Evas object.]]
legacy: null;
}
get {
- /*@
- Retrieves the type of the given Evas object.
-
- @return The type of the object.
-
- For Evas' builtin types, the return strings will be one of:
- - <c>"rectangle"</c>,
- - <c>"line"</c>,
- - <c>"polygon"</c>,
- - <c>"text"</c>,
- - <c>"textblock"</c> and
- - <c>"image"</c>.
-
- For Evas smart objects (see @ref Evas_Smart_Group), the name of the
- smart class itself is returned on this call. For the built-in smart
- objects, these names are:
- - <c>"EvasObjectSmartClipped"</c>, for the clipped smart object
- - <c>"Evas_Object_Box"</c>, for the box object and
- - <c>"Evas_Object_Table"</c>, for the table object.
-
+ [[Retrieves the type of the given Evas object.
+
+ For Evas' builtin types, the return strings will be one of
+ "rectangle", "line", "polygon", "text", "textblock" or "image".
+
+ For Evas smart objects (see \@ref Evas_Smart_Group), the name
+ of the smart class itself is returned on this call. For the
+ built-in smart objects, these names are "EvasObjectSmartClipped"
+ for the clipped smart object, "Evas_Object_Box" for the box
+ object and "Evas_Object_Table for the table object.
+ ]]
+ /* FIXME-doc
Example:
@dontinclude evas-object-manipulation.c
@skip d.img = evas_object_image_filled_add(d.canvas);
@until border on the
- See the full @ref Example_Evas_Object_Manipulation "example". */
+ See the full @ref Example_Evas_Object_Manipulation "example".
+ */
}
values {
- type: const(char)*; /*@ in */
+ type: const(char)*; [[The type of the object.]]
}
}
@property size_hint_min {
@@ -152,7 +140,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
not a size enforcement in any way, it's just a hint that should be
used whenever appropriate.
- @note Use @c NULL pointers on the hint components you're not
+ @note Use $null pointers on the hint components you're not
interested in: they'll be ignored by the function.
@see evas_object_size_hint_min_set() for an example */
@@ -213,12 +201,12 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Set whether an Evas object is to freeze (discard) events.
- If @p freeze is @c EINA_TRUE, it will make events on @p obj to be
@b
+ If @p freeze is $true, it will make events on @p obj to be @b
discarded. Unlike evas_object_pass_events_set(), events will not be
passed to @b next lower object. This API can be used for blocking
events while @p obj is on transiting.
- If @p freeze is @c EINA_FALSE, events will be processed on that
+ If @p freeze is $false, events will be processed on that
object as normal.
@warning If you block only key/mouse up events with this API, we
won't
@@ -235,8 +223,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Determine whether an object is set to freeze (discard) events.
- @return freeze whether @p obj is set to freeze events (@c
EINA_TRUE) or
- not (@c EINA_FALSE)
+ @return freeze whether @p obj is set to freeze events ($true) or
+ not ($false)
@see evas_object_freeze_events_set()
@see evas_object_pass_events_get()
@@ -245,8 +233,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
@since 1.1 */
}
values {
- freeze: bool; /*@ pass whether @p obj is to freeze events (@c
EINA_TRUE) or not
- (@c EINA_FALSE) */
+ freeze: bool; /*@ pass whether @p obj is to freeze events ($true)
or not
+ ($false) */
}
}
@property map {
@@ -365,7 +353,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
This is not a size enforcement in any way, it's just a hint that
should be used whenever appropriate.
- @note Use @c NULL pointers on the hint components you're not
+ @note Use $null pointers on the hint components you're not
interested in: they'll be ignored by the function.
Example:
@@ -442,7 +430,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
Get the object clipping @p obj (if any).
This function returns the object clipping @p obj. If @p obj is
- not being clipped at all, @c NULL is returned. The object @p obj
+ not being clipped at all, $null is returned. The object @p obj
must be a valid .Evas_Object.
See also evas_object_clip_set(), evas_object_clip_unset() and
@@ -487,7 +475,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
This is not a size enforcement in any way, it's just a hint that
should be used whenever appropriate.
- @note Use @c NULL pointers on the hint components you're not
+ @note Use $null pointers on the hint components you're not
interested in: they'll be ignored by the function.
Example:
@@ -513,11 +501,11 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Set whether an Evas object is to repeat events.
- If @p repeat is @c EINA_TRUE, it will make events on @p obj to also
+ If @p repeat is $true, it will make events on @p obj to also
be repeated for the @b next lower object in the objects' stack (see
see evas_object_below_get()).
- If @p repeat is @c EINA_FALSE, events occurring on @p obj will be
+ If @p repeat is $false, events occurring on @p obj will be
processed only on it.
Example:
@@ -536,8 +524,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Determine whether an object is set to repeat events.
- @return whether @p obj is set to repeat events (@c EINA_TRUE)
- or not (@c EINA_FALSE)
+ @return whether @p obj is set to repeat events ($true)
+ or not ($false)
@see evas_object_repeat_events_set() for an example
@see evas_object_pass_events_get()
@@ -545,8 +533,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
@see evas_object_freeze_events_get() */
}
values {
- repeat: bool; /*@ whether @p obj is to repeat events (@c
EINA_TRUE) or not
- (@c EINA_FALSE) */
+ repeat: bool; /*@ whether @p obj is to repeat events ($true) or not
+ ($false) */
}
}
@property size_hint_weight {
@@ -594,7 +582,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
This is not a size enforcement in any way, it's just a hint that
should be used whenever appropriate.
- @note Use @c NULL pointers on the hint components you're not
+ @note Use $null pointers on the hint components you're not
interested in: they'll be ignored by the function.
@note If @c obj is invalid, then the hint components will be set
with 0.0
@@ -624,7 +612,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Retrieves the name of the given Evas object.
- @return The name of the object or @c NULL, if no name has been
given
+ @return The name of the object or $null, if no name has been given
to it.
Example:
@@ -679,7 +667,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
This is a hint to Evas that this object is used as a big static
clipper and shouldn't be moved with children and otherwise
considered specially. The default value for new objects is
- @c EINA_FALSE.
+ $false.
@see evas_object_static_clip_get()
@@ -689,16 +677,16 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Get the "static clipper" hint flag for a given Evas object.
- @return @c EINA_TRUE if it's set as a static clipper,
- @c EINA_FALSE otherwise.
+ @return $true if it's set as a static clipper,
+ $false otherwise.
@see evas_object_static_clip_set() for more details
@ingroup Evas_Object_Group_Extras */
}
values {
- is_static_clip: bool; /*@ @c EINA_TRUE if it's to be used as a
static
- clipper, @c EINA_FALSE otherwise. */
+ is_static_clip: bool; /*@ $true if it's to be used as a static
+ clipper, $false otherwise. */
}
}
@property focus {
@@ -708,7 +696,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
canvas.
Changing focus only affects where (key) input events go. There can
- be only one object focused at any time. If @p focus is @c
EINA_TRUE,
+ be only one object focused at any time. If @p focus is $true,
@p obj will be set as the currently focused object and it will
receive all keyboard events that are not exclusive key grabs on
other objects.
@@ -729,10 +717,10 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Retrieve whether an object has the focus.
- @return @c EINA_TRUE if the object has the focus, @c EINA_FALSE
otherwise.
+ @return $true if the object has the focus, $false otherwise.
- If the passed object is the currently focused one, @c EINA_TRUE is
- returned. @c EINA_FALSE is returned, otherwise.
+ If the passed object is the currently focused one, $true is
+ returned. $false is returned, otherwise.
Example:
@dontinclude evas-events.c
@@ -747,7 +735,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
@see evas_object_key_ungrab */
}
values {
- focus: bool; /*@ @c EINA_TRUE, to set it as focused or @c
EINA_FALSE,
+ focus: bool; /*@ $true, to set it as focused or $false,
to take away the focus from it. */
}
}
@@ -882,7 +870,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
This is not a size enforcement in any way, it's just a hint that
should be used whenever appropriate.
- @note Use @c NULL pointers on the hint components you're not
+ @note Use $null pointers on the hint components you're not
interested in: they'll be ignored by the function.
@note If @c obj is invalid, then the hint components will be set
with 0.5
@@ -904,11 +892,11 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
This function has @b no effect if @p obj is not a member of a smart
object.
- If @p prop is @c EINA_TRUE, events occurring on this object will be
+ If @p prop is $true, events occurring on this object will be
propagated on to the smart object of which @p obj is a member. If
- @p prop is @c EINA_FALSE, events occurring on this object will @b
+ @p prop is $false, events occurring on this object will @b
not be propagated on to the smart object of which @p obj is a
- member. The default value is @c EINA_TRUE.
+ member. The default value is $true.
@see evas_object_propagate_events_get()
@see evas_object_repeat_events_set()
@@ -919,8 +907,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Retrieve whether an Evas object is set to propagate events.
- @return whether @p obj is set to propagate events (@c EINA_TRUE)
- or not (@c EINA_FALSE)
+ @return whether @p obj is set to propagate events ($true)
+ or not ($false)
@see evas_object_propagate_events_set()
@see evas_object_repeat_events_get()
@@ -928,8 +916,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
@see evas_object_freeze_events_get() */
}
values {
- propagate: bool; /*@ whether to propagate events (@c EINA_TRUE) or
not
- (@c EINA_FALSE) */
+ propagate: bool; /*@ whether to propagate events ($true) or not
+ ($false) */
}
}
@property pass_events {
@@ -937,11 +925,11 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Set whether an Evas object is to pass (ignore) events.
- If @p pass is @c EINA_TRUE, it will make events on @p obj to be @b
+ If @p pass is $true, it will make events on @p obj to be @b
ignored. They will be triggered on the @b next lower object (that
is not set to pass events), instead (see evas_object_below_get()).
- If @p pass is @c EINA_FALSE, events will be processed on that
+ If @p pass is $false, events will be processed on that
object as normal.
@see evas_object_pass_events_get() for an example
@@ -953,8 +941,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Determine whether an object is set to pass (ignore) events.
- @return pass whether @p obj is set to pass events (@c EINA_TRUE)
or not
- (@c EINA_FALSE)
+ @return pass whether @p obj is set to pass events ($true) or not
+ ($false)
Example:
@dontinclude evas-stacking.c
@@ -969,8 +957,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
@see evas_object_freeze_events_get() */
}
values {
- pass: bool; /*@ whether @p obj is to pass events (@c EINA_TRUE) or
not
- (@c EINA_FALSE) */
+ pass: bool; /*@ whether @p obj is to pass events ($true) or not
+ ($false) */
}
}
@property anti_alias {
@@ -983,11 +971,11 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
get {
/*@
Retrieves whether or not the given Evas object is to be drawn
anti_aliased.
- @return (@c EINA_TRUE) if the object is to be anti_aliased. (@c
EINA_FALSE) otherwise.
+ @return ($true) if the object is to be anti_aliased. ($false)
otherwise.
@ingroup Evas_Object_Group_Extras */
}
values {
- anti_alias: bool; /*@ (@c EINA_TRUE) if the object is to be
anti_aliased, (@c EINA_FALSE) otherwise. */
+ anti_alias: bool; /*@ ($true) if the object is to be anti_aliased,
($false) otherwise. */
}
}
@property smart_data {
@@ -996,7 +984,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
Retrieve user data stored on a given smart object.
@return A pointer to data stored using
- evas_object_smart_data_set(), or @c NULL, if none has been
+ evas_object_smart_data_set(), or $null, if none has been
set.
@see evas_object_smart_data_set()
@@ -1028,7 +1016,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
This returns the internal list handle that contains all objects
clipped by the object @p obj. If none are clipped by it, the call
- returns @c NULL. This list is only valid until the clip list is
+ returns $null. This list is only valid until the clip list is
changed and should be fetched again with another call to
evas_object_clipees_get() if any objects being clipped by this
object are unclipped, clipped by a new object, deleted or get the
@@ -1066,7 +1054,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Gets the parent smart object of a given Evas object, if it has one.
- @return Returns the parent smart object of @a obj or @c NULL, if @a
+ @return Returns the parent smart object of @a obj or $null, if @a
obj is not a smart member of any
@ingroup Evas_Smart_Object_Group */
@@ -1106,7 +1094,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Requests @p keyname key events be directed to @p obj.
- @return @c EINA_TRUE, if the call succeeded, @c EINA_FALSE otherwise.
+ @return $true, if the call succeeded, $false otherwise.
Key grabs allow one or more objects to receive key events for
specific key strokes even if other objects have focus. Whenever a
@@ -1124,7 +1112,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
evas_key_modifier_mask_get() or use @c 0 for empty masks.
@p exclusive will make the given object the only one permitted to
- grab the given key. If given @c EINA_TRUE, subsequent calls on this
+ grab the given key. If given $true, subsequent calls on this
function with different @p obj arguments will fail, unless the key
is ungrabbed again.
@@ -1159,8 +1147,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
Checks whether a given smart object or any of its smart object
parents is of a given smart class.
- @return @c EINA_TRUE, if @a obj or any of its parents is of type @a
- type, @c EINA_FALSE otherwise
+ @return $true, if @a obj or any of its parents is of type @a
+ type, $false otherwise
If @p obj is not a smart object, this call will fail
immediately.
@@ -1187,7 +1175,7 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
/*@
Retrieves the object from children of the given object 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(), but
it ONLY looks at the children of the object *p obj, and will only
recurse
@@ -1268,8 +1256,8 @@ abstract Evas.Object (Eo.Base, Evas.Common_Interface,
Efl.Gfx.Base, Efl.Gfx.Stac
Checks whether a given smart object or any of its smart object
parents is of a given smart class, <b>using pointer comparison</b>.
- @return @c EINA_TRUE, if @a obj or any of its parents is of type @a
- type, @c EINA_FALSE otherwise
+ @return $true, if @a obj or any of its parents is of type @a
+ type, $false otherwise
@see evas_object_smart_type_check() for more details
@see eo_isa
--
