photocam: convert docs
This commit is contained in:
Daniel Kolesa
parent
c3c4c660fb
commit
73223214fb
|
|
@ -7,218 +7,168 @@ class Elm.Photocam (Elm.Widget, Elm_Interface_Scrollable,
|
|||
methods {
|
||||
@property paused {
|
||||
set {
|
||||
/*@
|
||||
@brief Set the paused state for photocam
|
||||
[[Set the paused state for photocam
|
||||
|
||||
This sets the paused state to on(@c EINA_TRUE) or off (@c 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 */
|
||||
This sets the paused state to on or off 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.
|
||||
]]
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get the paused state for photocam
|
||||
[[Get the paused state for photocam
|
||||
|
||||
@return The current paused state
|
||||
|
||||
This gets the current paused state for the photocam object.
|
||||
|
||||
@see elm_photocam_paused_set()
|
||||
|
||||
@ingroup Photocam */
|
||||
This gets the current paused state for the photocam object.
|
||||
]]
|
||||
}
|
||||
values {
|
||||
paused: bool; /*@ The pause state to set */
|
||||
paused: bool; [[The pause state.]]
|
||||
}
|
||||
}
|
||||
@property gesture_enabled {
|
||||
set {
|
||||
/*@
|
||||
@brief Set the gesture state for photocam.
|
||||
[[Set the gesture state for photocam.
|
||||
|
||||
This sets the gesture state to on(@c EINA_TRUE) or off (@c EINA_FALSE) for
|
||||
photocam. The default is off. This will start multi touch zooming.
|
||||
|
||||
@ingroup Photocam */
|
||||
This sets the gesture state to on or off for photocam. The
|
||||
default is off. This will start multi touch zooming.
|
||||
]]
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get the gesture state for photocam.
|
||||
[[Get the gesture state for photocam.
|
||||
|
||||
@return The current gesture state
|
||||
|
||||
This gets the current gesture state for the photocam object.
|
||||
|
||||
@see elm_photocam_gesture_enabled_set()
|
||||
|
||||
@ingroup Photocam */
|
||||
This gets the current gesture state for the photocam object.
|
||||
]]
|
||||
}
|
||||
values {
|
||||
gesture: bool; /*@ The gesture state to set */
|
||||
gesture: bool; [[The gesture state.]]
|
||||
}
|
||||
}
|
||||
@property zoom {
|
||||
set {
|
||||
/*@
|
||||
@brief Set the zoom level of the photo
|
||||
[[Set the zoom level of the photo
|
||||
|
||||
This sets the zoom level. If @p zoom is 1, it means no zoom. If it's smaller
|
||||
than 1, it means zoom in. If it's bigger than 1, it means zoom out. For
|
||||
example, @p zoom 1 will be 1:1 pixel for pixel. @p zoom 2 will be 2:1
|
||||
(that is 2x2 photo pixels will display as 1 on-screen pixel) which is a zoom
|
||||
out. 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 */
|
||||
This sets the zoom level. If $zoom is 1, it means no zoom. If
|
||||
it's smaller than 1, it means zoom in. If it's bigger than 1,
|
||||
it means zoom out. For example, $zoom 1 will be 1:1 pixel for
|
||||
pixel. $zoom 2 will be 2:1 (that is 2x2 photo pixels will
|
||||
display as 1 on-screen pixel) which is a zoom out. 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.).
|
||||
]]
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get the zoom level of the photo
|
||||
[[Get the zoom level of the photo
|
||||
|
||||
@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 */
|
||||
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.
|
||||
]]
|
||||
}
|
||||
values {
|
||||
zoom: double; /*@ The zoom level to set */
|
||||
zoom: double; [[The zoom level to set]]
|
||||
}
|
||||
}
|
||||
@property zoom_mode {
|
||||
set {
|
||||
/*@
|
||||
@brief Set the zoom mode
|
||||
[[Set the zoom 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.
|
||||
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 @.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.
|
||||
|
||||
@ingroup Photocam */
|
||||
#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.
|
||||
]]
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
@brief Get the zoom mode
|
||||
[[Get the zoom mode
|
||||
|
||||
@return The current zoom mode
|
||||
|
||||
This gets the current zoom mode of the photocam object.
|
||||
|
||||
@see elm_photocam_zoom_mode_set()
|
||||
|
||||
@ingroup Photocam */
|
||||
This gets the current zoom mode of the photocam object.
|
||||
]]
|
||||
}
|
||||
values {
|
||||
mode: Elm_Photocam_Zoom_Mode; /*@ The desired mode */
|
||||
mode: Elm_Photocam_Zoom_Mode; [[The zoom mode.]]
|
||||
}
|
||||
}
|
||||
@property image_region {
|
||||
get {
|
||||
/*@
|
||||
@brief Get the region of the image that is currently shown
|
||||
[[Get the region of the image that is currently shown
|
||||
|
||||
@see elm_photocam_image_region_show()
|
||||
@see elm_photocam_image_region_bring_in()
|
||||
|
||||
@ingroup Photocam */
|
||||
See also @.image_region_show.
|
||||
]]
|
||||
}
|
||||
values {
|
||||
x: int; /*@ A pointer to the X-coordinate of region */
|
||||
y: int; /*@ A pointer to the Y-coordinate of region */
|
||||
w: int; /*@ A pointer to the width */
|
||||
h: int; /*@ A pointer to the height */
|
||||
x: int; [[A pointer to the X-coordinate of region]]
|
||||
y: int; [[A pointer to the Y-coordinate of region]]
|
||||
w: int; [[A pointer to the width]]
|
||||
h: int; [[A pointer to the height]]
|
||||
}
|
||||
}
|
||||
@property internal_image {
|
||||
get {
|
||||
/*@
|
||||
@brief Get the internal low-res image used for photocam
|
||||
[[Get the internal low-res image used for photocam
|
||||
|
||||
@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 */
|
||||
return: Evas.Object *;
|
||||
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.
|
||||
]]
|
||||
return: Evas.Object *; [[The internal image object handle or $null]]
|
||||
}
|
||||
}
|
||||
@property image_size {
|
||||
get {
|
||||
/*@
|
||||
@brief Get the current image pixel width and height
|
||||
[[Get the current image pixel width and height
|
||||
|
||||
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 */
|
||||
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.
|
||||
]]
|
||||
}
|
||||
values {
|
||||
w: int; /*@ A pointer to the width return */
|
||||
h: int; /*@ A pointer to the height return */
|
||||
w: int; [[A pointer to the width return]]
|
||||
h: int; [[A pointer to the height return]]
|
||||
}
|
||||
}
|
||||
@property image_orient {
|
||||
set {
|
||||
/*@
|
||||
Set the photocam image orientation.
|
||||
[[Set the photocam image orientation.
|
||||
|
||||
This function allows to rotate or flip the photocam image.
|
||||
This function allows to rotate or flip the photocam image.
|
||||
|
||||
@see elm_photocam_image_orient_get()
|
||||
@see @ref Evas_Image_Orient
|
||||
|
||||
@since 1.14
|
||||
@ingroup Photocam */
|
||||
@since 1.14
|
||||
]]
|
||||
}
|
||||
get {
|
||||
/*@
|
||||
Get the photocam image orientation.
|
||||
[[Get the photocam image orientation.
|
||||
|
||||
@return The photocam image orientation @ref Evas_Image_Orient
|
||||
|
||||
@see elm_photocam_image_orient_set()
|
||||
@see @ref Evas_Image_Orient
|
||||
|
||||
@since 1.14
|
||||
@ingroup Photocam */
|
||||
@since 1.14
|
||||
]]
|
||||
}
|
||||
values {
|
||||
orient: Evas_Image_Orient; /*@ The photocam image orientation @ref Evas_Image_Orient
|
||||
Default is #EVAS_IMAGE_ORIENT_NONE. */
|
||||
orient: Evas_Image_Orient; [[The photocam image orientation
|
||||
\@ref Evas_Image_Orient. Default is
|
||||
#EVAS_IMAGE_ORIENT_NONE.
|
||||
]]
|
||||
}
|
||||
}
|
||||
image_region_show {
|
||||
/*@
|
||||
@brief Set the viewed region of the image
|
||||
|
||||
This shows the region of the image without using animation.
|
||||
|
||||
@ingroup Photocam */
|
||||
[[Set the viewed region of the image
|
||||
|
||||
This shows the region of the image without using animation.
|
||||
]]
|
||||
params {
|
||||
@in x: int; /*@ X-coordinate of region in image original pixels */
|
||||
@in y: int; /*@ Y-coordinate of region in image original pixels */
|
||||
@in w: int; /*@ Width of region in image original pixels */
|
||||
@in h: int; /*@ Height of region in image original pixels */
|
||||
@in x: int; [[X-coordinate of region in image original pixels]]
|
||||
@in y: int; [[Y-coordinate of region in image original pixels]]
|
||||
@in w: int; [[Width of region in image original pixels]]
|
||||
@in h: int; [[Height of region in image original pixels]]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Reference in New Issue