Photocam

Enumerations

enum  Elm_Photocam_Zoom_Mode {
  ELM_PHOTOCAM_ZOOM_MODE_MANUAL = 0,
  ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT,
  ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL,
  ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN
}
 Types of zoom available. More...

Functions

Evas_Object * elm_photocam_add (Evas_Object *parent)
 Add a new Photocam object.
Evas_Load_Error elm_photocam_file_set (Evas_Object *obj, const char *file)
 Set the photo file to be shown.
const char * elm_photocam_file_get (const Evas_Object *obj)
 Returns the path of the current image file.
void elm_photocam_zoom_set (Evas_Object *obj, double zoom)
 Set the zoom level of the photo.
double elm_photocam_zoom_get (const Evas_Object *obj)
 Get the zoom level of the photo.
void elm_photocam_zoom_mode_set (Evas_Object *obj, Elm_Photocam_Zoom_Mode mode)
 Set the zoom mode.
Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get (const Evas_Object *obj)
 Get the zoom mode.
void elm_photocam_image_size_get (const Evas_Object *obj, int *w, int *h)
 Get the current image pixel width and height.
void elm_photocam_image_region_get (const Evas_Object *obj, int *x, int *y, int *w, int *h)
 Get the region of the image that is currently shown.
void elm_photocam_image_region_show (Evas_Object *obj, int x, int y, int w, int h)
 Set the viewed region of the image.
void elm_photocam_image_region_bring_in (Evas_Object *obj, int x, int y, int w, int h)
 Bring in the viewed portion of the image.
void elm_photocam_paused_set (Evas_Object *obj, Eina_Bool paused)
 Set the paused state for photocam.
Eina_Bool elm_photocam_paused_get (const Evas_Object *obj)
 Get the paused state for photocam.
Evas_Object * elm_photocam_internal_image_get (const Evas_Object *obj)
 Get the internal low-res image used for photocam.
EINA_DEPRECATED void elm_photocam_bounce_set (Evas_Object *obj, Eina_Bool h_bounce, Eina_Bool v_bounce)
 Set the photocam scrolling bouncing.
EINA_DEPRECATED void elm_photocam_bounce_get (const Evas_Object *obj, Eina_Bool *h_bounce, Eina_Bool *v_bounce)
 Get the photocam scrolling bouncing.
void elm_photocam_gesture_enabled_set (Evas_Object *obj, Eina_Bool gesture)
 Set the gesture state for photocam.
Eina_Bool elm_photocam_gesture_enabled_get (const Evas_Object *obj)
 Get the gesture state for photocam.

Detailed Description

photocam_inheritance_tree.png
preview-00.png

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 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:

  • "clicked" - This is called when a user has clicked the photo without dragging around.
  • "press" - This is called when a user has pressed down on the photo.
  • "longpressed" - This is called when a user has pressed down on the photo for a long time without dragging around.
  • "clicked,double" - This is called when a user has double-clicked the photo.
  • "load" - Photo load begins.
  • "loaded" - This is called when the image file load is complete for the first view (low resolution blurry version).
  • "load,detail" - Photo detailed data load begins.
  • "loaded,detail" - This is called when the image file load is complete for the detailed image data (full resolution needed).
  • "zoom,start" - Zoom animation started.
  • "zoom,stop" - Zoom animation stopped.
  • "zoom,change" - Zoom changed when using an auto zoom mode.
  • "scroll" - the content has been scrolled (moved)
  • "scroll,anim,start" - scrolling animation has started
  • "scroll,anim,stop" - scrolling animation has stopped
  • "scroll,drag,start" - dragging the contents around has started
  • "scroll,drag,stop" - dragging the contents around has stopped

This widget implements the elm-scrollable-interface interface, so that all (non-deprecated) functions for the base Scroller widget also work for photocam objects.

Some calls on the photocam's API are marked as 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).

Photocam example shows the API in action.


Enumeration Type Documentation

Types of zoom available.

Enumerator:
ELM_PHOTOCAM_ZOOM_MODE_MANUAL 

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.


Function Documentation

Evas_Object* elm_photocam_add ( Evas_Object *  parent)

Add a new Photocam object.

Parameters:
parentThe parent object
Returns:
The new object or NULL if it cannot be created
EINA_DEPRECATED void elm_photocam_bounce_get ( const Evas_Object *  obj,
Eina_Bool *  h_bounce,
Eina_Bool *  v_bounce 
)

Get the photocam scrolling bouncing.

Parameters:
objThe photocam object
h_bouncehorizontal bouncing
v_bouncevertical bouncing
See also:
elm_photocam_bounce_set()
Deprecated:
Use elm_scroller_bounce_get() instead.
EINA_DEPRECATED void elm_photocam_bounce_set ( Evas_Object *  obj,
Eina_Bool  h_bounce,
Eina_Bool  v_bounce 
)

Set the photocam scrolling bouncing.

Parameters:
objThe photocam object
h_bounceset this to EINA_TRUE for horizontal bouncing
v_bounceset this to EINA_TRUE for vertical bouncing
Deprecated:
Use elm_scroller_bounce_set() instead.
const char* elm_photocam_file_get ( const Evas_Object *  obj)

Returns the path of the current image file.

Parameters:
objThe photocam object
Returns:
Returns the path
See also:
elm_photocam_file_set()
Evas_Load_Error elm_photocam_file_set ( Evas_Object *  obj,
const char *  file 
)

Set the photo file to be shown.

Parameters:
objThe photocam object
fileThe photo file
Returns:
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.

References elm_photocam_zoom_set(), and ELM_WIDGET_DATA.

Eina_Bool elm_photocam_gesture_enabled_get ( const Evas_Object *  obj)

Get the gesture state for photocam.

Parameters:
objThe photocam object
Returns:
The current gesture state

This gets the current gesture state for the photocam object.

See also:
elm_photocam_gesture_enabled_set()
void elm_photocam_gesture_enabled_set ( Evas_Object *  obj,
Eina_Bool  gesture 
)

Set the gesture state for photocam.

Parameters:
objThe photocam object
gestureThe 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.

References elm_gesture_layer_add(), elm_gesture_layer_attach(), elm_gesture_layer_cb_set(), ELM_GESTURE_STATE_ABORT, ELM_GESTURE_STATE_END, ELM_GESTURE_STATE_MOVE, ELM_GESTURE_STATE_START, and ELM_GESTURE_ZOOM.

void elm_photocam_image_region_bring_in ( Evas_Object *  obj,
int  x,
int  y,
int  w,
int  h 
)

Bring in the viewed portion of the image.

Parameters:
objThe photocam object
xX-coordinate of region in image original pixels
yY-coordinate of region in image original pixels
wWidth of region in image original pixels
hHeight of region in image original pixels

This shows the region of the image using animation.

void elm_photocam_image_region_get ( const Evas_Object *  obj,
int *  x,
int *  y,
int *  w,
int *  h 
)

Get the region of the image that is currently shown.

Parameters:
obj
xA pointer to the X-coordinate of region
yA pointer to the Y-coordinate of region
wA pointer to the width
hA pointer to the height
See also:
elm_photocam_image_region_show()
elm_photocam_image_region_bring_in()
void elm_photocam_image_region_show ( Evas_Object *  obj,
int  x,
int  y,
int  w,
int  h 
)

Set the viewed region of the image.

Parameters:
objThe photocam object
xX-coordinate of region in image original pixels
yY-coordinate of region in image original pixels
wWidth of region in image original pixels
hHeight of region in image original pixels

This shows the region of the image without using animation.

void elm_photocam_image_size_get ( const Evas_Object *  obj,
int *  w,
int *  h 
)

Get the current image pixel width and height.

Parameters:
objThe photocam object
wA pointer to the width return
hA 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 w and h that are pointed to.

Evas_Object* elm_photocam_internal_image_get ( const Evas_Object *  obj)

Get the internal low-res image used for photocam.

Parameters:
objThe photocam object
Returns:
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.

Eina_Bool elm_photocam_paused_get ( const Evas_Object *  obj)

Get the paused state for photocam.

Parameters:
objThe photocam object
Returns:
The current paused state

This gets the current paused state for the photocam object.

See also:
elm_photocam_paused_set()
void elm_photocam_paused_set ( Evas_Object *  obj,
Eina_Bool  paused 
)

Set the paused state for photocam.

Parameters:
objThe photocam object
pausedThe 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.

double elm_photocam_zoom_get ( const Evas_Object *  obj)

Get the zoom level of the photo.

Parameters:
objThe photocam object
Returns:
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 also:
elm_photocam_zoom_set()
elm_photocam_zoom_mode_set()
Elm_Photocam_Zoom_Mode elm_photocam_zoom_mode_get ( const Evas_Object *  obj)

Get the zoom mode.

Parameters:
objThe photocam object
Returns:
The current zoom mode

This gets the current zoom mode of the photocam object.

See also:
elm_photocam_zoom_mode_set()
void elm_photocam_zoom_mode_set ( Evas_Object *  obj,
Elm_Photocam_Zoom_Mode  mode 
)

Set the zoom mode.

Parameters:
objThe photocam object
modeThe 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.

References elm_photocam_zoom_set(), and ELM_WIDGET_DATA.

void elm_photocam_zoom_set ( Evas_Object *  obj,
double  zoom 
)

Set the zoom level of the photo.

Parameters:
objThe photocam object
zoomThe 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 zoom parameter must be greater than 0. It is suggested to stick to powers of 2. (1, 2, 4, 8, 16, 32, etc.).

References ELM_PHOTOCAM_ZOOM_MODE_AUTO_FILL, ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT, ELM_PHOTOCAM_ZOOM_MODE_AUTO_FIT_IN, and ELM_PHOTOCAM_ZOOM_MODE_MANUAL.

Referenced by elm_photocam_file_set(), and elm_photocam_zoom_mode_set().