efl/legacy/elementary/src/lib/elm_thumb.eo

239 lines
6.0 KiB
Plaintext
Raw Normal View History

enum Elm.Thumb.Animation_Setting
{
[[Used to set if a video thumbnail is animating or not]]
legacy: elm_thumb_animation;
start = 0, [[Play animation once]]
loop, [[Keep playing animation until stop is requested]]
stop, [[Stop playing the animation]]
last
}
class Elm.Thumb (Elm.Layout, Efl.File, Evas.Clickable_Interface)
2014-03-27 00:14:54 -07:00
{
eo_prefix: elm_obj_thumb;
2015-05-07 09:32:53 -07:00
methods {
@property compress {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Set the compression for the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get the compression of the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
return: void; [[Force the return type to be sure the argument
doesn't become the return]]
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
compress: int; [[The compression of the thumb.]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property format {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Set the format for the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get the format of the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
format: Ethumb_Thumb_Format; [[The format setting.]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property animate {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Set the animation state for the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
If its content is an animated video, you may start/stop the
animation or tell it o play continuously and looping.
]]
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get the animation state for the thumb object.]]
2014-03-27 00:14:54 -07:00
}
values {
setting: Elm.Thumb.Animation_Setting; [[The animation setting or
2015-07-31 07:00:58 -07:00
#ELM_THUMB_ANIMATION_LAST]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property fdo_size {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Set the FDO size for the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get the fdo size of the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
size: Ethumb_Thumb_FDO_Size; [[The FDO size setting.]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property orientation {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Set the orientation for the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get the orientation of the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
orient: Ethumb_Thumb_Orientation; [[The orientation setting.]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property editable {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Make the thumbnail 'editable'.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
This means the thumbnail is a valid drag target for drag and
drop, and can be cut or pasted too.
]]
return: bool;
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get whether the thumbnail is editable.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
This means the thumbnail is a valid drag target for drag and
drop, and can be cut or pasted too.
]]
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
edit: bool; [[The editable state, default is $false.]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property aspect {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Set the aspect for the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get the aspect of the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
aspect: Ethumb_Thumb_Aspect; [[The aspect setting.]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property quality {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Set the quality for the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get the quality of the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
return: void;
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
quality: int; [[The quality of the thumb.]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property size {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Set the size for the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get the size of the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
tw: int; [[The width of the thumb.]]
th: int; [[The height of the thumb.]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property crop_align {
2014-03-27 00:14:54 -07:00
set {
2015-07-31 07:00:58 -07:00
[[Set the crop alignment for the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
get {
2015-07-31 07:00:58 -07:00
[[Get the crop alignment of the thumb object.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
@since 1.8
]]
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
cropx: double; [[The x coordinate of the crop.]]
cropy: double; [[The y coordinate of the crop.]]
2014-03-27 00:14:54 -07:00
}
}
2015-05-07 09:32:53 -07:00
@property path {
2014-03-27 00:14:54 -07:00
get {
2015-07-31 07:00:58 -07:00
[[Get the path and key to the image or video thumbnail generated
by ethumb.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
One just needs to make sure that the thumbnail was generated
before getting its path; otherwise, the path will be $null.
One way to do that is by asking for the path when/after the
"generate,stop" smart callback is called.
]]
2014-03-27 00:14:54 -07:00
}
values {
2015-07-31 07:00:58 -07:00
file: const(char)* @optional; [[Pointer to thumb path.]]
key: const(char)* @optional; [[Pointer to thumb key.]]
2014-03-27 00:14:54 -07:00
}
}
reload {
2015-07-31 07:00:58 -07:00
[[Reload thumbnail if it was generated before.
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
This is useful if the ethumb client configuration changed, like its
size, aspect or any other property one set in the handle returned
by elm_thumb_ethumb_client_get().
2014-03-27 00:14:54 -07:00
2015-07-31 07:00:58 -07:00
If the options didn't change, the thumbnail won't be generated
again, but the old one will still be used.
]]
2014-03-27 00:14:54 -07:00
}
}
implements {
class.constructor;
Eo.Base.constructor;
2014-07-22 08:25:39 -07:00
Efl.File.file.set;
Efl.File.file.get;
Evas.Object_Smart.hide;
Evas.Object_Smart.add;
Evas.Object_Smart.del;
Evas.Object_Smart.show;
2014-03-27 00:14:54 -07:00
}
events {
generate,error;
generate,start;
generate,stop;
load,error;
press;
}
}