519 lines
16 KiB
C
519 lines
16 KiB
C
/**
|
|
* @defgroup Photocam Photocam
|
|
* @ingroup Elementary
|
|
*
|
|
* @image html photocam_inheritance_tree.png
|
|
* @image latex photocam_inheritance_tree.eps
|
|
*
|
|
* @image html img/widget/photocam/preview-00.png
|
|
* @image latex img/widget/photocam/preview-00.eps
|
|
*
|
|
* Photocam is a widget meant specifically for displaying
|
|
* high-resolution digital camera photos, giving speedy feedback (fast
|
|
* load), zooming and panning as well as fitting logic, all with low
|
|
* memory footprint. It is entirely focused on @b jpeg images, and
|
|
* takes advantage of properties of the jpeg format (via Evas loader
|
|
* features in the jpeg loader).
|
|
*
|
|
* Signals that you can add callbacks for are:
|
|
* @li @c "clicked" - This is called when a user has clicked the photo
|
|
* without dragging around.
|
|
* @li @c "press" - This is called when a user has pressed down on the
|
|
* photo.
|
|
* @li @c "longpressed" - This is called when a user has pressed down
|
|
* on the photo for a long time without dragging around.
|
|
* @li @c "clicked,double" - This is called when a user has
|
|
* double-clicked the photo.
|
|
* @li @c "load" - Photo load begins.
|
|
* @li @c "loaded" - This is called when the image file load is
|
|
* complete for the first view (low resolution blurry version).
|
|
* @li @c "load,detail" - Photo detailed data load begins.
|
|
* @li @c "loaded,detail" - This is called when the image file load is
|
|
* complete for the detailed image data (full resolution
|
|
* needed).
|
|
* @li @c "zoom,start" - Zoom animation started.
|
|
* @li @c "zoom,stop" - Zoom animation stopped.
|
|
* @li @c "zoom,change" - Zoom changed when using an auto zoom mode.
|
|
* @li @c "scroll" - the content has been scrolled (moved)
|
|
* @li @c "scroll,anim,start" - scrolling animation has started
|
|
* @li @c "scroll,anim,stop" - scrolling animation has stopped
|
|
* @li @c "scroll,drag,start" - dragging the contents around has started
|
|
* @li @c "scroll,drag,stop" - dragging the contents around has stopped
|
|
*
|
|
* This widget implements the @b @ref elm-scrollable-interface
|
|
* interface, so that all (non-deprecated) functions for the base @ref
|
|
* Scroller widget also work for photocam objects.
|
|
*
|
|
* Some calls on the photocam's API are marked as @b deprecated, as
|
|
* they just wrap the scrollable widgets counterpart functions. Use
|
|
* the ones we point you to, for each case of deprecation here,
|
|
* instead -- eventually the deprecated ones will be discarded (next
|
|
* major release).
|
|
*
|
|
* @ref tutorial_photocam shows the API in action.
|
|
* @{
|
|
*/
|
|
|
|
#define ELM_OBJ_PHOTOCAM_PAN_CLASS elm_obj_photocam_pan_class_get()
|
|
|
|
const Eo_Class *elm_obj_photocam_pan_class_get(void) EINA_CONST;
|
|
|
|
/**
|
|
* @brief Types of zoom available.
|
|
*/
|
|
typedef enum
|
|
{
|
|
ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0, /**< Zoom controlled normally by elm_photocam_zoom_set */
|
|
ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, /**< Zoom until photo fits in photocam */
|
|
ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, /**< Zoom until photo fills photocam */
|
|
ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN, /**< Zoom in until photo fits in photocam */
|
|
ELM_PHOTOCAM_ZOOM_MODE_LAST
|
|
} Elm_Photocam_Zoom_Mode;
|
|
|
|
#define ELM_OBJ_PHOTOCAM_CLASS elm_obj_photocam_class_get()
|
|
|
|
const Eo_Class *elm_obj_photocam_class_get(void) EINA_CONST;
|
|
|
|
extern EAPI Eo_Op ELM_OBJ_PHOTOCAM_BASE_ID;
|
|
|
|
enum
|
|
{
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_FILE_SET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_FILE_GET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_ZOOM_SET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_ZOOM_GET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_ZOOM_MODE_SET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_ZOOM_MODE_GET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_IMAGE_SIZE_GET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_IMAGE_REGION_GET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_IMAGE_REGION_SHOW,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_PAUSED_SET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_PAUSED_GET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_INTERNAL_IMAGE_GET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_GESTURE_ENABLED_SET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_GESTURE_ENABLED_GET,
|
|
ELM_OBJ_PHOTOCAM_SUB_ID_LAST
|
|
};
|
|
|
|
#define ELM_OBJ_PHOTOCAM_ID(sub_id) (ELM_OBJ_PHOTOCAM_BASE_ID + sub_id)
|
|
|
|
|
|
/**
|
|
* @def elm_obj_photocam_file_set
|
|
* @since 1.8
|
|
*
|
|
* @brief Set the photo file to be shown
|
|
*
|
|
* @param[in] file
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_photocam_file_set
|
|
*/
|
|
#define elm_obj_photocam_file_set(file, ret) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_FILE_SET), EO_TYPECHECK(const char *, file), EO_TYPECHECK(Evas_Load_Error *, ret)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_file_get
|
|
* @since 1.8
|
|
*
|
|
* @brief Returns the path of the current image file
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_photocam_file_get
|
|
*/
|
|
#define elm_obj_photocam_file_get(ret) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_FILE_GET), EO_TYPECHECK(const char **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_zoom_set
|
|
* @since 1.8
|
|
*
|
|
* @brief Set the zoom level of the photo
|
|
*
|
|
* @param[in] zoom
|
|
*
|
|
* @see elm_photocam_zoom_set
|
|
*/
|
|
#define elm_obj_photocam_zoom_set(zoom) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_ZOOM_SET), EO_TYPECHECK(double, zoom)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_zoom_get
|
|
* @since 1.8
|
|
*
|
|
* @brief Get the zoom level of the photo
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_photocam_zoom_get
|
|
*/
|
|
#define elm_obj_photocam_zoom_get(ret) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_ZOOM_GET), EO_TYPECHECK(double *, ret)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_zoom_mode_set
|
|
* @since 1.8
|
|
*
|
|
* @brief Set the zoom mode
|
|
*
|
|
* @param[in] mode
|
|
*
|
|
* @see elm_photocam_zoom_mode_set
|
|
*/
|
|
#define elm_obj_photocam_zoom_mode_set(mode) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_ZOOM_MODE_SET), EO_TYPECHECK(Elm_Photocam_Zoom_Mode, mode)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_zoom_mode_get
|
|
* @since 1.8
|
|
*
|
|
* @brief Get the zoom mode
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_photocam_zoom_mode_get
|
|
*/
|
|
#define elm_obj_photocam_zoom_mode_get(ret) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_ZOOM_MODE_GET), EO_TYPECHECK(Elm_Photocam_Zoom_Mode *, ret)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_image_size_get
|
|
* @since 1.8
|
|
*
|
|
* @brief Get the current image pixel width and height
|
|
*
|
|
* @param[out] w
|
|
* @param[out] h
|
|
*
|
|
* @see elm_photocam_image_size_get
|
|
*/
|
|
#define elm_obj_photocam_image_size_get(w, h) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_IMAGE_SIZE_GET), EO_TYPECHECK(int *, w), EO_TYPECHECK(int *, h)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_image_region_get
|
|
* @since 1.8
|
|
*
|
|
* @brief Get the region of the image that is currently shown
|
|
*
|
|
* @param[out] x
|
|
* @param[out] y
|
|
* @param[out] w
|
|
* @param[out] h
|
|
*
|
|
* @see elm_photocam_image_region_get
|
|
*/
|
|
#define elm_obj_photocam_image_region_get(x, y, w, h) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_IMAGE_REGION_GET), EO_TYPECHECK(int *, x), EO_TYPECHECK(int *, y), EO_TYPECHECK(int *, w), EO_TYPECHECK(int *, h)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_image_region_show
|
|
* @since 1.8
|
|
*
|
|
* @brief Set the viewed region of the image
|
|
*
|
|
* @param[in] x
|
|
* @param[in] y
|
|
* @param[in] w
|
|
* @param[in] h
|
|
*
|
|
* @see elm_photocam_image_region_show
|
|
*/
|
|
#define elm_obj_photocam_image_region_show(x, y, w, h) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_IMAGE_REGION_SHOW), EO_TYPECHECK(int, x), EO_TYPECHECK(int, y), EO_TYPECHECK(int, w), EO_TYPECHECK(int, h)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_paused_set
|
|
* @since 1.8
|
|
*
|
|
* @brief Set the paused state for photocam
|
|
*
|
|
* @param[in] paused
|
|
*
|
|
* @see elm_photocam_paused_set
|
|
*/
|
|
#define elm_obj_photocam_paused_set(paused) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_PAUSED_SET), EO_TYPECHECK(Eina_Bool, paused)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_paused_get
|
|
* @since 1.8
|
|
*
|
|
* @brief Get the paused state for photocam
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_photocam_paused_get
|
|
*/
|
|
#define elm_obj_photocam_paused_get(ret) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_PAUSED_GET), EO_TYPECHECK(Eina_Bool *, ret)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_internal_image_get
|
|
* @since 1.8
|
|
*
|
|
* @brief Get the internal low-res image used for photocam
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_photocam_internal_image_get
|
|
*/
|
|
#define elm_obj_photocam_internal_image_get(ret) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_INTERNAL_IMAGE_GET), EO_TYPECHECK(Evas_Object **, ret)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_gesture_enabled_set
|
|
* @since 1.8
|
|
*
|
|
* @brief Set the gesture state for photocam.
|
|
*
|
|
* @param[in] gesture
|
|
*
|
|
* @see elm_photocam_gesture_enabled_set
|
|
*/
|
|
#define elm_obj_photocam_gesture_enabled_set(gesture) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_GESTURE_ENABLED_SET), EO_TYPECHECK(Eina_Bool, gesture)
|
|
|
|
/**
|
|
* @def elm_obj_photocam_gesture_enabled_get
|
|
* @since 1.8
|
|
*
|
|
* @brief Get the gesture state for photocam.
|
|
*
|
|
* @param[out] ret
|
|
*
|
|
* @see elm_photocam_gesture_enabled_get
|
|
*/
|
|
#define elm_obj_photocam_gesture_enabled_get(ret) ELM_OBJ_PHOTOCAM_ID(ELM_OBJ_PHOTOCAM_SUB_ID_GESTURE_ENABLED_GET), EO_TYPECHECK(Eina_Bool *, ret)
|
|
|
|
/**
|
|
* @brief Add a new Photocam object
|
|
*
|
|
* @param parent The parent object
|
|
* @return The new object or NULL if it cannot be created
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI Evas_Object *elm_photocam_add(Evas_Object *parent);
|
|
|
|
/**
|
|
* @brief Set the photo file to be shown
|
|
*
|
|
* @param obj The photocam object
|
|
* @param file The photo file
|
|
* @return The return error (see EVAS_LOAD_ERROR_NONE, EVAS_LOAD_ERROR_GENERIC etc.)
|
|
*
|
|
* This sets (and shows) the specified file (with a relative or absolute
|
|
* path) and will return a load error (same error that
|
|
* evas_object_image_load_error_get() will return). The image will change and
|
|
* adjust its size at this point and begin a background load process for this
|
|
* photo that at some time in the future will be displayed at the full
|
|
* quality needed.
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI Evas_Load_Error elm_photocam_file_set(Evas_Object *obj, const char *file);
|
|
|
|
/**
|
|
* @brief Returns the path of the current image file
|
|
*
|
|
* @param obj The photocam object
|
|
* @return Returns the path
|
|
*
|
|
* @see elm_photocam_file_set()
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI const char *elm_photocam_file_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the zoom level of the photo
|
|
*
|
|
* @param obj The photocam object
|
|
* @param zoom The zoom level to set
|
|
*
|
|
* This sets the zoom level. 1 will be 1:1 pixel for pixel. 2 will be 2:1
|
|
* (that is 2x2 photo pixels will display as 1 on-screen pixel). 4:1 will be
|
|
* 4x4 photo pixels as 1 screen pixel, and so on. The @p zoom parameter must
|
|
* be greater than 0. It is suggested to stick to powers of 2. (1, 2, 4, 8,
|
|
* 16, 32, etc.).
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI void elm_photocam_zoom_set(Evas_Object *obj, double zoom);
|
|
|
|
/**
|
|
* @brief Get the zoom level of the photo
|
|
*
|
|
* @param obj The photocam object
|
|
* @return The current zoom level
|
|
*
|
|
* This returns the current zoom level of the photocam object. Note that if
|
|
* you set the fill mode to other than ELM_PHOTOCAM_ZOOM_MODE_MANUAL
|
|
* (which is the default), the zoom level may be changed at any time by the
|
|
* photocam object itself to account for photo size and photocam viewport
|
|
* size.
|
|
*
|
|
* @see elm_photocam_zoom_set()
|
|
* @see elm_photocam_zoom_mode_set()
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI double elm_photocam_zoom_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the zoom mode
|
|
*
|
|
* @param obj The photocam object
|
|
* @param mode The desired mode
|
|
*
|
|
* This sets the zoom mode to manual or one of several automatic levels.
|
|
* Manual (ELM_PHOTOCAM_ZOOM_MODE_MANUAL) means that zoom is set manually by
|
|
* elm_photocam_zoom_set() and will stay at that level until changed by code
|
|
* or until zoom mode is changed. This is the default mode. The Automatic
|
|
* modes will allow the photocam object to automatically adjust zoom mode
|
|
* based on properties. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT) will adjust zoom so
|
|
* the photo fits EXACTLY inside the scroll frame with no pixels outside this
|
|
* region. ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL will be similar but ensure no
|
|
* pixels within the frame are left unfilled.
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI void elm_photocam_zoom_mode_set(Evas_Object *obj, Elm_Photocam_Zoom_Mode mode);
|
|
|
|
/**
|
|
* @brief Get the zoom mode
|
|
*
|
|
* @param obj The photocam object
|
|
* @return The current zoom mode
|
|
*
|
|
* This gets the current zoom mode of the photocam object.
|
|
*
|
|
* @see elm_photocam_zoom_mode_set()
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Get the current image pixel width and height
|
|
*
|
|
* @param obj The photocam object
|
|
* @param w A pointer to the width return
|
|
* @param h A pointer to the height return
|
|
*
|
|
* This gets the current photo pixel width and height (for the original).
|
|
* The size will be returned in the integers @p w and @p h that are pointed
|
|
* to.
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI void elm_photocam_image_size_get(const Evas_Object *obj, int *w, int *h);
|
|
|
|
/**
|
|
* @brief Get the region of the image that is currently shown
|
|
*
|
|
* @param obj
|
|
* @param x A pointer to the X-coordinate of region
|
|
* @param y A pointer to the Y-coordinate of region
|
|
* @param w A pointer to the width
|
|
* @param h A pointer to the height
|
|
*
|
|
* @see elm_photocam_image_region_show()
|
|
* @see elm_photocam_image_region_bring_in()
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI void elm_photocam_image_region_get(const Evas_Object *obj, int *x, int *y, int *w, int *h);
|
|
|
|
/**
|
|
* @brief Set the viewed region of the image
|
|
*
|
|
* @param obj The photocam object
|
|
* @param x X-coordinate of region in image original pixels
|
|
* @param y Y-coordinate of region in image original pixels
|
|
* @param w Width of region in image original pixels
|
|
* @param h Height of region in image original pixels
|
|
*
|
|
* This shows the region of the image without using animation.
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI void elm_photocam_image_region_show(Evas_Object *obj, int x, int y, int w, int h);
|
|
|
|
/**
|
|
* @brief Bring in the viewed portion of the image
|
|
*
|
|
* @param obj The photocam object
|
|
* @param x X-coordinate of region in image original pixels
|
|
* @param y Y-coordinate of region in image original pixels
|
|
* @param w Width of region in image original pixels
|
|
* @param h Height of region in image original pixels
|
|
*
|
|
* This shows the region of the image using animation.
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI void elm_photocam_image_region_bring_in(Evas_Object *obj, int x, int y, int w, int h);
|
|
|
|
/**
|
|
* @brief Set the paused state for photocam
|
|
*
|
|
* @param obj The photocam object
|
|
* @param paused The pause state to set
|
|
*
|
|
* This sets the paused state to on(EINA_TRUE) or off (EINA_FALSE) for
|
|
* photocam. The default is off. This will stop zooming using animation on
|
|
* zoom level changes and change instantly. This will stop any existing
|
|
* animations that are running.
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI void elm_photocam_paused_set(Evas_Object *obj, Eina_Bool paused);
|
|
|
|
/**
|
|
* @brief Get the paused state for photocam
|
|
*
|
|
* @param obj The photocam object
|
|
* @return The current paused state
|
|
*
|
|
* This gets the current paused state for the photocam object.
|
|
*
|
|
* @see elm_photocam_paused_set()
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI Eina_Bool elm_photocam_paused_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Get the internal low-res image used for photocam
|
|
*
|
|
* @param obj The photocam object
|
|
* @return The internal image object handle, or NULL if none exists
|
|
*
|
|
* This gets the internal image object inside photocam. Do not modify it. It
|
|
* is for inspection only, and hooking callbacks to. Nothing else. It may be
|
|
* deleted at any time as well.
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI Evas_Object *elm_photocam_internal_image_get(const Evas_Object *obj);
|
|
|
|
/**
|
|
* @brief Set the gesture state for photocam.
|
|
*
|
|
* @param obj The photocam object
|
|
* @param gesture The gesture state to set
|
|
*
|
|
* This sets the gesture state to on(EINA_TRUE) or off (EINA_FALSE) for
|
|
* photocam. The default is off. This will start multi touch zooming.
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI void elm_photocam_gesture_enabled_set(Evas_Object *obj, Eina_Bool gesture);
|
|
|
|
/**
|
|
* @brief Get the gesture state for photocam.
|
|
*
|
|
* @param obj The photocam object
|
|
* @return The current gesture state
|
|
*
|
|
* This gets the current gesture state for the photocam object.
|
|
*
|
|
* @see elm_photocam_gesture_enabled_set()
|
|
*
|
|
* @ingroup Photocam
|
|
*/
|
|
EAPI Eina_Bool elm_photocam_gesture_enabled_get(const Evas_Object *obj);
|
|
/**
|
|
* @}
|
|
*/
|