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

efl.interfaces: Doc conversion of efl_gfx_fill.eo 

Summary: Signed-off-by: Srivardhan Hebbar <sri.hebbar@samsung.com>

Reviewers: cedric, tasn, q66

Reviewed By: q66

Subscribers: cedric

Differential Revision: https://phab.enlightenment.org/D2818
This commit is contained in:
Srivardhan Hebbar 2015-07-15 13:47:46 +01:00 committed by Daniel Kolesa
parent 29de62cd13
commit 96ad2462d2
1 changed files with 41 additions and 45 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

86
src/lib/efl/interfaces/efl_gfx_fill.eo
View File

@ -3,69 +3,65 @@ interface Efl.Gfx.Fill {
methods { methods {
@property fill_spread { @property fill_spread {
set { set {
/*@ [[Sets the tiling mode for the given evas image object's fill.
Sets the tiling mode for the given evas image object's fill. $EFL_GFX_FILL_RESTRICT, or $EFL_GFX_FILL_PAD.]]
EFL_GFX_FILL_RESTRICT, or EFL_GFX_FILL_PAD. */
} }
get { get {
/*@ [[Retrieves the spread (tiling mode) for the given image object's
Retrieves the spread (tiling mode) for the given image object's fill.]]
fill.
@return The current spread mode of the image object. */
} }
values { values {
spread: Efl_Gfx_Fill_Spread; /*@ One of EVAS_TEXTURE_REFLECT, EVAS_TEXTURE_REPEAT, */ spread: Efl_Gfx_Fill_Spread; [[The current spread mode of the image object.
One of $EFL_GFX_FILL_REFLECT, $EFL_GFX_FILL_REPEAT]]
} }
} }
@property fill { @property fill {
set { set {
/*@ [[Set how to fill an image object's drawing rectangle given the
Set how to fill an image object's drawing rectangle given the (real) image bound to it.
(real) image bound to it.
Note that if @p w or @p h are smaller than the dimensions of Note that if $w or $h are smaller than the dimensions of
@p obj, the displayed image will be @b tiled around the object's $obj, the displayed image will be tiled around the object's
area. To have only one copy of the bound image drawn, @p x and @p y area. To have only one copy of the bound image drawn, $x and $y
must be 0 and @p w and @p h need to be the exact width and height must be 0 and $w and $h need to be the exact width and height
of the image object itself, respectively. of the image object itself, respectively.
See the following image to better understand the effects of this Warning: The default values for the fill parameters are $x = 0,
call. On this diagram, both image object and original image source $y = 0, $w = 0 and $h = 0. Thus, if you're not using the
have @c a x @c a dimensions and the image itself is a circle, with evas_object_image_filled_add() helper and want your image
empty space around it: displayed, you'll have to set valid values with this function on
your object.
@image html image-fill.png Note: evas_object_image_filled_set() is a helper function which
@image rtf image-fill.png will override the values set here automatically, for you, in a
@image latex image-fill.eps given way.]]
/* FIXME-doc
* See the following image to better understand the effects of this
* call. On this diagram, both image object and original image source
* have $a x $a dimensions and the image itself is a circle, with
* empty space around it:
@warning The default values for the fill parameters are @p x = 0, * @image html image-fill.png
@p y = 0, @p w = 0 and @p h = 0. Thus, if you're not using the * @image rtf image-fill.png
evas_object_image_filled_add() helper and want your image * @image latex image-fill.eps
displayed, you'll have to set valid values with this function on */
your object.
@note evas_object_image_filled_set() is a helper function which
will @b override the values set here automatically, for you, in a
given way. */
} }
get { get {
/*@ [[Retrieve how an image object is to fill its drawing rectangle,
Retrieve how an image object is to fill its drawing rectangle, given the (real) image bound to it.
given the (real) image bound to it.
@note Use @c NULL pointers on the fill components you're not Note: Use $null pointers on the fill components you're not
interested in: they'll be ignored by the function. interested in: they'll be ignored by the function.
See @ref evas_object_image_fill_set() for more details. */ See @.fill.set() for more details.]]
} }
values { values {
x: int; /*@ The x coordinate (from the top left corner of the bound x: int; [[The x coordinate (from the top left corner of the bound
image) to start drawing from. */ image) to start drawing from.]]
y: int; /*@ The y coordinate (from the top left corner of the bound y: int; [[The y coordinate (from the top left corner of the bound
image) to start drawing from. */ image) to start drawing from.]]
w: int; /*@ The width the bound image will be displayed at. */ w: int; [[The width the bound image will be displayed at.]]
h: int; /*@ The height the bound image will be displayed at. */ h: int; [[The height the bound image will be displayed at.]]
} }
} }
} }