A thumbnail object is used for displaying the thumbnail of an image or video. You must have compiled Elementary with Ethumb_Client
support. Also, Ethumb's DBus service must be present and auto-activated in order to have thumbnails generated. You must also have a session bus, not a system one.
Once the thumbnail object becomes visible, it will check if there is a previously generated thumbnail image for the file set on it. If not, it will start generating this thumbnail.
Different configuration settings will cause different thumbnails to be generated even on the same file.
Generated thumbnails are stored under $HOME/
.thumbnails/. Check Ethumb's documentation to change this path, and to see other configuration options.
If you set formatting features such as, aspect, size, format, orientation, crop, compression, or quality after the thumbnail has been shown, it needs to be reloaded with elm_thumb_reload.
This widget emits the following signals:
"clicked"
- This is called when a user has clicked the thumbnail object without dragging it around.
"clicked,double"
- This is called when a user has double-clicked the thumbnail object.
"press"
- This is called when a user has pressed down over the thumbnail object.
"generate,start"
- The thumbnail generation has started.
"generate,stop"
- The generation process has stopped.
"generate,error"
- The thumbnail generation failed.
"load,error"
- The thumbnail image loading failed.
Available styles:
An example of use of thumbnail:
Used to set if a video thumbnail is animating or not.
Enumerator |
---|
ELM_THUMB_ANIMATION_START |
Play animation once.
|
ELM_THUMB_ANIMATION_LOOP |
Keep playing animation until stop is requested.
|
ELM_THUMB_ANIMATION_STOP |
Stop playing the animation.
|
Get the animation state for the thumb object.
- Returns
- getting The animation setting or
ELM_THUMB_ANIMATION_LAST
, on errors.
- See also
- elm_thumb_animate_set()
- Parameters
-
setting | The animation setting. |
Get the animation state for the thumb object.
- Returns
- getting The animation setting or
ELM_THUMB_ANIMATION_LAST
, on errors.
- See also
- elm_thumb_animate_set()
- Parameters
-
setting | The animation setting. |
Ethumb_Thumb_Aspect elm_thumb::aspect_get |
( |
| ) |
const |
|
inline |
Get the aspect of the thumb object.
- Since
- 1.8
- Returns
- getting The aspect setting.
- See also
- elm_thumb_aspect_set()
- Parameters
-
aspect | The aspect setting. |
void elm_thumb::aspect_set |
( |
Ethumb_Thumb_Aspect |
aspect_ | ) |
const |
|
inline |
Get the aspect of the thumb object.
- Since
- 1.8
- Returns
- getting The aspect setting.
- See also
- elm_thumb_aspect_set()
- Parameters
-
aspect | The aspect setting. |
void elm_thumb::compress_get |
( |
int * |
compress_ | ) |
const |
|
inline |
Get the compression of the thumb object.
- Since
- 1.8
- Returns
- getting The compress setting.
- See also
- elm_thumb_compress_set()
- Parameters
-
compress | The compression of the thumb. |
void elm_thumb::compress_set |
( |
int |
compress_ | ) |
const |
|
inline |
Get the compression of the thumb object.
- Since
- 1.8
- Returns
- getting The compress setting.
- See also
- elm_thumb_compress_set()
- Parameters
-
compress | The compression of the thumb. |
void elm_thumb::crop_align_get |
( |
double * |
cropx_, |
|
|
double * |
cropy_ |
|
) |
| const |
|
inline |
Get the crop alignment of the thumb object.
- Since
- 1.8
- Returns
- getting The crop align setting.
- See also
- elm_thumb_crop_align_set()
- Parameters
-
cropx | The x coordinate of the crop. |
cropy | The y coordinate of the crop. |
void elm_thumb::crop_align_set |
( |
double |
cropx_, |
|
|
double |
cropy_ |
|
) |
| const |
|
inline |
Get the crop alignment of the thumb object.
- Since
- 1.8
- Returns
- getting The crop align setting.
- See also
- elm_thumb_crop_align_set()
- Parameters
-
cropx | The x coordinate of the crop. |
cropy | The y coordinate of the crop. |
bool elm_thumb::editable_get |
( |
| ) |
const |
|
inline |
Make the thumbnail 'editable'.
- Returns
- Editability.
This means the thumbnail is a valid drag target for drag and drop, and can be cut or pasted too.
- See also
- elm_thumb_editable_set()
- Parameters
-
edit | Turn on or off editability. Default is EINA_FALSE . |
bool elm_thumb::editable_set |
( |
bool |
edit_ | ) |
const |
|
inline |
Make the thumbnail 'editable'.
- Returns
- Editability.
This means the thumbnail is a valid drag target for drag and drop, and can be cut or pasted too.
- See also
- elm_thumb_editable_set()
- Parameters
-
edit | Turn on or off editability. Default is EINA_FALSE . |
Eina_Bool elm_need_ethumb |
( |
void |
| ) |
|
Request that your elementary application needs ethumb.
This initializes the Ethumb library when called and if support exists it returns EINA_TRUE
, otherwise returns EINA_FALSE
. This must be called before any other function that deals with elm_thumb objects or ethumb_client instances.
- Examples:
- fileselector_example.c, and thumb_example_01.c.
Evas_Object* elm_thumb_add |
( |
Evas_Object * |
parent | ) |
|
Eina_Bool elm_thumb_ethumb_client_connected_get |
( |
void |
| ) |
|
Get the ethumb_client connection state.
- Returns
EINA_TRUE
if the client is connected to the server or EINA_FALSE
otherwise.
void* elm_thumb_ethumb_client_get |
( |
void |
| ) |
|
Get the ethumb_client handle so custom configuration can be made.
- Returns
- Ethumb_Client instance or NULL.
The ethumb client handle returned may or may not be NULL. It may or may not survive into the future (ethumbd may become disconnected). Do not use this unless you know what you are doing.
void elm_thumb_file_get |
( |
const Eo * |
obj, |
|
|
const char ** |
file, |
|
|
const char ** |
key |
|
) |
| |
Get the image or video path and key used to generate the thumbnail.
- See also
- elm_thumb_file_set()
-
elm_thumb_path_get()
- Parameters
-
[out] | file | The path to file that will be used as thumbnail source. |
[out] | key | The key used in case of an EET file. |
void elm_thumb_file_set |
( |
Eo * |
obj, |
|
|
const char * |
file, |
|
|
const char * |
key |
|
) |
| |
Set the file that will be used as thumbnail source.
The file can be an image or a video (in that case, acceptable extensions are: avi, mp4, ogv, mov, mpg and wmv). To start the video animation, use the function elm_thumb_animate().
- See also
- elm_thumb_file_get()
-
elm_thumb_reload()
-
elm_thumb_animate()
- Parameters
-
[in] | file | The path to file that will be used as thumbnail source. |
[in] | key | The key used in case of an EET file. |
Ethumb_Thumb_FDO_Size elm_thumb::fdo_size_get |
( |
| ) |
const |
|
inline |
Get the fdo size of the thumb object.
- Since
- 1.8
- Returns
- getting The FDO size setting.
- See also
- elm_thumb_fdo_size_set()
- Parameters
-
size | The FDO size setting. |
void elm_thumb::fdo_size_set |
( |
Ethumb_Thumb_FDO_Size |
size_ | ) |
const |
|
inline |
Get the fdo size of the thumb object.
- Since
- 1.8
- Returns
- getting The FDO size setting.
- See also
- elm_thumb_fdo_size_set()
- Parameters
-
size | The FDO size setting. |
Ethumb_Thumb_Format elm_thumb::format_get |
( |
| ) |
const |
|
inline |
Get the format of the thumb object.
- Since
- 1.8
- Returns
- getting The Format setting.
- See also
- elm_thumb_format_set()
- Parameters
-
format | The format setting. |
void elm_thumb::format_set |
( |
Ethumb_Thumb_Format |
format_ | ) |
const |
|
inline |
Get the format of the thumb object.
- Since
- 1.8
- Returns
- getting The Format setting.
- See also
- elm_thumb_format_set()
- Parameters
-
format | The format setting. |
Ethumb_Thumb_Orientation elm_thumb::orientation_get |
( |
| ) |
const |
|
inline |
Get the orientation of the thumb object.
- Since
- 1.8
- Returns
- getting The orientation setting.
- See also
- elm_thumb_orientation_set()
- Parameters
-
orient | The orientation setting. |
void elm_thumb::orientation_set |
( |
Ethumb_Thumb_Orientation |
orient_ | ) |
const |
|
inline |
Get the orientation of the thumb object.
- Since
- 1.8
- Returns
- getting The orientation setting.
- See also
- elm_thumb_orientation_set()
- Parameters
-
orient | The orientation setting. |
void elm_thumb::path_get |
( |
const char ** |
file_, |
|
|
const char ** |
key_ |
|
) |
| const |
|
inline |
Get the path and key to the image or video thumbnail generated by ethumb.
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.
- See also
- elm_thumb_file_get()
- Parameters
-
file | Pointer to thumb path. |
key | Pointer to thumb key. |
void elm_thumb::quality_get |
( |
int * |
quality_ | ) |
const |
|
inline |
Get the quality of the thumb object.
- Since
- 1.8
- Returns
- getting The quality setting.
- See also
- elm_thumb_quality_set()
- Parameters
-
quality | The quality of the thumb. |
void elm_thumb::quality_set |
( |
int |
quality_ | ) |
const |
|
inline |
Get the quality of the thumb object.
- Since
- 1.8
- Returns
- getting The quality setting.
- See also
- elm_thumb_quality_set()
- Parameters
-
quality | The quality of the thumb. |
void elm_thumb::reload |
( |
| ) |
const |
|
inline |
Reload thumbnail if it was generated before.
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().
If the options didn't change, the thumbnail won't be generated again, but the old one will still be used.
- See also
- elm_thumb_file_set()
void elm_thumb::size_get |
( |
int * |
tw_, |
|
|
int * |
th_ |
|
) |
| const |
|
inline |
Get the size of the thumb object.
- Since
- 1.8
- Returns
- getting The size setting.
- See also
- elm_thumb_size_set()
- Parameters
-
tw | The width of the thumb. |
th | The height of the thumb. |
void elm_thumb::size_set |
( |
int |
tw_, |
|
|
int |
th_ |
|
) |
| const |
|
inline |
Get the size of the thumb object.
- Since
- 1.8
- Returns
- getting The size setting.
- See also
- elm_thumb_size_set()
- Parameters
-
tw | The width of the thumb. |
th | The height of the thumb. |