efl/legacy/elementary/src/lib/elm_photo_legacy.h

99 lines
2.7 KiB
C

/**
* Add a new photo to the parent
*
* @param parent The parent object
* @return The new object or NULL if it cannot be created
*
* @ingroup Photo
*/
EAPI Evas_Object *elm_photo_add(Evas_Object *parent);
/**
* Set the file that will be used as the photo widget's image.
*
* @param obj The photo object
* @param file The path to file that will be used as @a obj's image.
*
* @return @c EINA_TRUE on success, @c EINA_FALSE otherwise
*
* @note Use @c NULL on @a file to set the photo widget back to it's
* initial state, which indicates "no photo".
*
* @ingroup Photo
*/
EAPI Eina_Bool elm_photo_file_set(Evas_Object *obj, const char *file);
/**
* Set the file that will be used as thumbnail in the photo.
*
* @param obj The photo object.
* @param file The path to file that will be used as thumbnail.
* @param group The key used in case of an EET file.
*
* @ingroup Photo
*/
EAPI void elm_photo_thumb_set(const Evas_Object *obj, const char *file, const char *group);
/**
* Set the size that will be used on the photo
*
* @param obj The photo object
* @param size The size of the photo
*
* @ingroup Photo
*/
EAPI void elm_photo_size_set(Evas_Object *obj, int size);
/**
* Set if the photo should be completely visible or not.
*
* @param obj The photo object
* @param fill if true the photo will be completely visible
*
* @ingroup Photo
*/
EAPI void elm_photo_fill_inside_set(Evas_Object *obj, Eina_Bool fill);
/**
* Set editability of the photo.
*
* 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
* the image will delete the existing content.
*
* @param obj The photo object.
* @param set To set of clear editability.
*/
EAPI void elm_photo_editable_set(Evas_Object *obj, Eina_Bool set);
/**
* Set whether the original aspect ratio of the photo should be kept on resize.
*
* @param obj The photo object.
* @param fixed @c EINA_TRUE if the photo should fix the aspect,
* @c EINA_FALSE otherwise.
*
* The original aspect ratio (width / height) of the photo is usually
* distorted to match the object's size. Enabling this option will fix
* this original aspect, and the way that the photo is fit into
* the object's area
*
* @see elm_photo_aspect_fixed_get()
*
* @ingroup Photo
*/
EAPI void elm_photo_aspect_fixed_set(Evas_Object *obj, Eina_Bool fixed);
/**
* Get if the object keeps the original aspect ratio.
*
* @param obj The photo object.
* @return @c EINA_TRUE if the object keeps the original aspect, @c EINA_FALSE
* otherwise.
*
* @ingroup Photo
*/
EAPI Eina_Bool elm_photo_aspect_fixed_get(const Evas_Object *obj);