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

photo: convert docs

This commit is contained in:
Daniel Kolesa 2015-07-02 14:43:50 +01:00
parent ff533a6568
commit b1fba116aa
1 changed files with 29 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

72
legacy/elementary/src/lib/elm_photo.eo
View File

@ -4,84 +4,70 @@ class Elm.Photo (Elm.Widget, Efl.File, Evas.Clickable_Interface, Evas.Draggable_
methods { methods {
@property editable { @property editable {
set { set {
/*@ [[Set editability of the photo.
Set editability of the photo.
An editable photo can be dragged to or from, and can be cut or An editable photo can be dragged to or from, and can be cut or
pasted too. Note that pasting an image or dropping an item on pasted too. Note that pasting an image or dropping an item on
the image will delete the existing content. */ the image will delete the existing content.
]]
} }
get { get {
/*@ Get editability of the photo. */ [[Get editability of the photo.]]
} }
values { values {
set: bool; /*@ To set of clear editability. */ set: bool; [[To set of clear editability.]]
} }
} }
@property fill_inside { @property fill_inside {
set { set {
/*@ [[Set if the photo should be completely visible or not.]]
Set if the photo should be completely visible or not.
@ingroup Photo */
} }
get { get {
/*@ Get if the photo should be completely visible or not. */ [[Get if the photo should be completely visible or not.]]
} }
values { values {
fill: bool; /*@ if true the photo will be completely visible */ fill: bool; [[Photo visibility.]]
} }
} }
@property aspect_fixed { @property aspect_fixed {
set { set {
/*@ [[Set whether the original aspect ratio of the photo should be kept
Set whether the original aspect ratio of the photo should be kept on resize. on resize.
The original aspect ratio (width / height) of the photo is usually The original aspect ratio (width / height) of the photo is
distorted to match the object's size. Enabling this option will fix usually distorted to match the object's size. Enabling this
this original aspect, and the way that the photo is fit into option will fix this original aspect, and the way that the
the object's area photo is fit into the object's area.
@see elm_photo_aspect_fixed_get() See also @elm_photo_aspect_fixed_get.
]]
@ingroup Photo */
} }
get { get {
/*@ [[Get if the object keeps the original aspect ratio.]]
Get if the object keeps the original aspect ratio.
@return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
otherwise.
@ingroup Photo */
} }
values { values {
fixed: bool; /*@ @c EINA_TRUE if the photo should fix the aspect, fixed: bool; [[true if the photo should fix the aspect,
@c EINA_FALSE otherwise. */ false otherwise.]]
} }
} }
@property size { @property size {
set { set {
/*@ [[Set the size that will be used on the photo]]
Set the size that will be used on the photo
@ingroup Photo */
} }
get { get {
/*@ Get the size that will be used on the photo */ [[Get the size that will be used on the photo]]
} }
values { values {
size: int; /*@ The size of the photo */ size: int; [[The size of the photo]]
} }
} }
thumb_set @const { thumb_set @const {
/*@ [[Set the file that will be used as thumbnail in the photo.]]
Set the file that will be used as thumbnail in the photo.
@ingroup Photo */
params { params {
@in file: const(char)* @nullable; /*@ The path to file that will be used as thumbnail. */ @in file: const(char)* @nullable; [[The path to file that will be
@in group: const(char)* @optional; /*@ The key used in case of an EET file. */ used as thumbnail.]]
@in group: const(char)* @optional; [[The key used in case of an EET
file.]]
} }
} }
} }