[elm] Thumb now a layout.

SVN revision: 71173
This commit is contained in:
Gustavo Lima Chaves 2012-05-16 17:20:42 +00:00
parent efe3d3f5be
commit 83f37467b6
2 changed files with 514 additions and 405 deletions

File diff suppressed because it is too large Load Diff

View File

@ -1,40 +1,46 @@
/** /**
* @defgroup Thumb Thumb * @defgroup Thumb Thumbnail
* @ingroup Elementary * @ingroup Elementary
* *
* @image html img/widget/thumb/preview-00.png * @image html img/widget/thumb/preview-00.png
* @image latex img/widget/thumb/preview-00.eps * @image latex img/widget/thumb/preview-00.eps
* *
* A thumb object is used for displaying the thumbnail of an image or video. * A thumbnail object is used for displaying the thumbnail of an image
* You must have compiled Elementary with Ethumb_Client support and the DBus * or video. You must have compiled Elementary with @c Ethumb_Client
* service must be present and auto-activated in order to have thumbnails to * support. Also, Ethumb's DBus service must be present and
* be generated. You must also have a Session bus, not System bus. * auto-activated in order to have thumbnails generated. You must also
* have a @b session bus, not a @b system one.
* *
* Once the thumbnail object becomes visible, it will check if there is a * Once the thumbnail object becomes visible, it will check if there
* previously generated thumbnail image for the file set on it. If not, it * is a previously generated thumbnail image for the file set on
* will start generating this thumbnail. * it. If not, it will start generating this thumbnail.
* *
* Different config settings will cause different thumbnails to be generated * Different configuration settings will cause different thumbnails to
* even on the same file. * be generated even on the same file.
* *
* Generated thumbnails are stored under @c $HOME/.thumbnails/. Check the * Generated thumbnails are stored under @c $HOME/.thumbnails/. Check
* Ethumb documentation to change this path, and to see other configuration * Ethumb's documentation to change this path, and to see other
* options. * configuration options.
* *
* Signals that you can add callbacks for are: * This widget inherits from the @ref Layout one, so that all the
* functions acting on it also work for thumbnail objects.
* *
* - "clicked" - This is called when a user has clicked the thumb without dragging * This widget emits the following signals, besides the ones sent from
* around. * @ref Layout:
* - "clicked,double" - This is called when a user has double-clicked the thumb. * - @c "clicked" - This is called when a user has clicked the
* - "press" - This is called when a user has pressed down the thumb. * thumbnail object without dragging it around.
* - "generate,start" - The thumbnail generation started. * - @c "clicked,double" - This is called when a user has double-clicked
* - "generate,stop" - The generation process stopped. * the thumbnail object.
* - "generate,error" - The generation failed. * - @c "press" - This is called when a user has pressed down over the
* - "load,error" - The thumbnail image loading failed. * thumbnail object.
* - @c "generate,start" - The thumbnail generation has started.
* - @c "generate,stop" - The generation process has stopped.
* - @c "generate,error" - The thumbnail generation failed.
* - @c "load,error" - The thumbnail image loading failed.
* *
* available styles: * Available styles:
* - default * - @c "default"
* - noframe * - @c "noframe"
* *
* An example of use of thumbnail: * An example of use of thumbnail:
* *
@ -94,15 +100,19 @@ EAPI Evas_Object *elm_thumb_add(Evas_Object *parent);
EAPI void elm_thumb_reload(Evas_Object *obj); EAPI void elm_thumb_reload(Evas_Object *obj);
/** /**
* Set the file that will be used as thumbnail. * Set the file that will be used as thumbnail @b source.
* *
* @param obj The thumb object. * @param obj The thumb object.
* @param file The path to file that will be used as thumb. * @param file The path to file that will be used as thumbnail source.
* @param key The key used in case of an EET file. * @param key The key used in case of an EET file.
* *
* The file can be an image or a video (in that case, acceptable extensions are: * The file can be an image or a video (in that case, acceptable
* avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the * extensions are: avi, mp4, ogv, mov, mpg and wmv). To start the
* function elm_thumb_animate(). * video animation, use the function elm_thumb_animate().
*
* @warning Not to be confused with elm_layout_file_set(), which sets
* the file giving the thumbnail objcet's @b decoration, not the
* thumbnail image's source.
* *
* @see elm_thumb_file_get() * @see elm_thumb_file_get()
* @see elm_thumb_reload() * @see elm_thumb_reload()