enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 6 Projects Releases Wiki Activity

flip: convert docs

This commit is contained in:
Daniel Kolesa 2015-08-07 13:30:06 +01:00
parent b34db8299f
commit abee9b89f2
1 changed files with 139 additions and 186 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

325
legacy/elementary/src/lib/elm_flip.eo
View File

@ -39,237 +39,190 @@ class Elm.Flip (Elm.Container)
methods { methods {
@property interaction { @property interaction {
set { set {
/*@ [[Set the interactive flip mode.
@brief Set the interactive flip mode
This sets if the flip should be interactive (allow user to click and This sets if the flip should be interactive (allow user to
drag a side of the flip to reveal the back page and cause it to flip). click and drag a side of the flip to reveal the back page
By default a flip is not interactive. You may also need to set which and cause it to flip). By default a flip is not interactive.
sides of the flip are "active" for flipping and how much space they use You may also need to set which sides of the flip are "active"
(a minimum of a finger size) with elm_flip_interaction_direction_enabled_set() for flipping and how much space they use (a minimum of a
and elm_flip_interaction_direction_hitsize_set() finger size) with \@ref @.interaction_direction_enabled_set
and @.interaction_direction_hitsize_set.
The four available mode of interaction are: The four available mode of interaction are
@li #ELM_FLIP_INTERACTION_NONE - No interaction is allowed #ELM_FLIP_INTERACTION_NONE, #ELM_FLIP_INTERACTION_ROTATE,
@li #ELM_FLIP_INTERACTION_ROTATE - Interaction will cause rotate animation #ELM_FLIP_INTERACTION_CUBE and #ELM_FLIP_INTERACTION_PAGE.
@li #ELM_FLIP_INTERACTION_CUBE - Interaction will cause cube animation
@li #ELM_FLIP_INTERACTION_PAGE - Interaction will cause page animation
@note #ELM_FLIP_INTERACTION_ROTATE won't cause Note: #ELM_FLIP_INTERACTION_ROTATE won't cause
#ELM_FLIP_ROTATE_XZ_CENTER_AXIS or #ELM_FLIP_ROTATE_YZ_CENTER_AXIS to #ELM_FLIP_ROTATE_XZ_CENTER_AXIS or #ELM_FLIP_ROTATE_YZ_CENTER_AXIS
happen, those can only be achieved with elm_flip_go(); to happen, those can only be achieved with @.go.
]]
@ingroup Flip */
} }
get { get {
/*@ [[Get the interactive flip mode.]]
@brief Get the interactive flip mode
@return The interactive flip mode
Returns the interactive flip mode set by elm_flip_interaction_set()
@ingroup Flip */
} }
values { values {
mode: Elm.Flip.Interaction; /*@ The interactive flip mode to use */ mode: Elm.Flip.Interaction; [[The interactive flip mode to use.]]
} }
} }
@property front_visible { @property front_visible {
get { get {
/*@ [[Get flip front visibility state.]]
@brief Get flip front visibility state return: bool; [[$true if front front is showing, $false if
the back is showing.]]
@return true if front front is showing, false if the back is
showing.
@ingroup Flip */
return: bool;
} }
} }
interaction_direction_hitsize_set { interaction_direction_hitsize_set {
/*@ [[Set the amount of the flip that is sensitive to interactive flip.
@brief Set the amount of the flip that is sensitive to interactive flip
Set the amount of the flip that is sensitive to interactive flip, with 0 Set the amount of the flip that is sensitive to interactive flip,
representing no area in the flip and 1 representing the entire flip. There with 0 representing no area in the flip and 1 representing the
is however a consideration to be made in that the area will never be entire flip. There is however a consideration to be made in that
smaller than the finger size set (as set in your Elementary configuration), the area will never be smaller than the finger size set (as set
and dragging must always start from the opposite half of the flip (eg. right in your Elementary configuration), and dragging must always start
half of the flip when dragging to the left). from the opposite half of the flip (eg. right half of the flip
when dragging to the left).
Note that the $dir parameter is not actually related to the direction of Note: The $dir parameter is not actually related to the direction
the drag, it only refers to the area in the flip where interaction can of the drag, it only refers to the area in the flip where
occur (top, bottom, left, right). interaction can occur (top, bottom, left, right).
Negative values of $hitsize will disable this hit area. Negative values of $hitsize will disable this hit area.
@see elm_flip_interaction_set()
@ingroup Flip */
See also @.interaction.set.
]]
params { params {
@in dir: Elm.Flip.Direction; /*@ The hit area to set */ @in dir: Elm.Flip.Direction; [[The hit area to set.]]
@in hitsize: double; /*@ The amount of that dimension (0.0 to 1.0) to use */ @in hitsize: double; [[The amount of that dimension (0.0 to 1.0) to use.]]
} }
} }
interaction_direction_hitsize_get { interaction_direction_hitsize_get {
/*@ [[Get the amount of the flip that is sensitive to interactive flip.]]
@brief Get the amount of the flip that is sensitive to interactive flip return: double; [[The size set for that direction.]]
@return The size set for that direction
Returns the amount of sensitive area set by
elm_flip_interaction_direction_hitsize_set().
@ingroup Flip */
return: double;
params { params {
@in dir: Elm.Flip.Direction; /*@ The direction to check */ @in dir: Elm.Flip.Direction; [[The direction to check.]]
} }
} }
interaction_direction_enabled_set { interaction_direction_enabled_set {
/*@ [[Set which directions of the flip respond to interactive flip
@brief Set which directions of the flip respond to interactive flip
By default all directions are disabled, so you may want to enable the By default all directions are disabled, so you may want to
desired directions for flipping if you need interactive flipping. You must enable the desired directions for flipping if you need
call this function once for each direction that should be enabled. interactive flipping. You must call this function once for
each direction that should be enabled.
You can also set the appropriate hit area size by calling
$elm_flip_interaction_direction_hitsize_set(). By default, a minimum
hit area will be created on the opposite edge of the flip.
@see elm_flip_interaction_set()
@ingroup Flip */
You can also set the appropriate hit area size by calling
@.interaction_direction_hitsize_set. By default, a minimum
hit area will be created on the opposite edge of the flip.
]]
params { params {
@in dir: Elm.Flip.Direction; /*@ The direction to change */ @in dir: Elm.Flip.Direction; [[The direction to change.]]
@in enabled: bool; /*@ If that direction is enabled or not */ @in enabled: bool; [[If that direction is enabled or not.]]
} }
} }
interaction_direction_enabled_get { interaction_direction_enabled_get {
/*@ [[Get the enabled state of that flip direction.]]
@brief Get the enabled state of that flip direction return: bool; [[If that direction is enabled or not.]]
@return If that direction is enabled or not
Get the enabled state set by elm_flip_interaction_direction_enabled_set()
@see elm_flip_interaction_set()
@ingroup Flip */
return: bool;
params { params {
@in dir: Elm.Flip.Direction; /*@ The direction to check */ @in dir: Elm.Flip.Direction; [[The direction to check.]]
} }
} }
go { go {
/*@ [[Runs the flip animation.
@brief Runs the flip animation
Flips the front and back contents using the $mode animation. This Flips the front and back contents using the $mode animation.
effectively hides the currently visible content and shows the hidden one. This effectively hides the currently visible content and shows
the hidden one.
There a number of possible animations to use for the flipping:
@li #ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
around a horizontal axis in the middle of its height, the other content
is shown as the other side of the flip.
@li #ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
around a vertical axis in the middle of its width, the other content is
shown as the other side of the flip.
@li #ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
around a diagonal axis in the middle of its width, the other content is
shown as the other side of the flip.
@li #ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
around a diagonal axis in the middle of its height, the other content is
shown as the other side of the flip.
@li #ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
as if the flip was a cube, the other content is show as the right face of
the cube.
@li #ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
right as if the flip was a cube, the other content is show as the left
face of the cube.
@li #ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
flip was a cube, the other content is show as the bottom face of the cube.
@li #ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
the flip was a cube, the other content is show as the upper face of the
cube.
@li #ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
if the flip was a book, the other content is shown as the page below that.
@li #ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
as if the flip was a book, the other content is shown as the page below
that.
@li #ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
flip was a book, the other content is shown as the page below that.
@li #ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
flip was a book, the other content is shown as the page below that.
@image html elm_flip.png
@image latex elm_flip.eps width=\textwidth
@see elm_flip_go_to()
@ingroup Flip */
There a number of possible animations to use for the flipping,
these being #ELM_FLIP_ROTATE_X_CENTER_AXIS (rotate the currently
visible content around a horizontal axis in the middle of its
height, the other content is shown as the other side of the flip),
#ELM_FLIP_ROTATE_Y_CENTER_AXIS (rotate the currently visible
content around a vertical axis in the middle of its width, the
other content is shown as the other side of the flip),
#ELM_FLIP_ROTATE_XZ_CENTER_AXIS (rotate the currently visible
content around a diagonal axis in the middle of its width, the
other content is shown as the other side of the flip),
#ELM_FLIP_ROTATE_YZ_CENTER_AXIS (rotate the currently visible
content around a diagonal axis in the middle of its height, the
other content is hown as the other side of the flip).
#ELM_FLIP_CUBE_LEFT (rotate the currently visible content to the
left as if the flip was a cube, the other content is show as the
right face of the cube), #ELM_FLIP_CUBE_RIGHT (rotate the
currently visible content to the right as if the flip was a
cube, the other content is show as the left face of the cube),
#ELM_FLIP_CUBE_UP (rotate the currently visible content up as if
the flip was a cube, the other content is show as the bottom face
of the cube), #ELM_FLIP_CUBE_DOWN (rotate the currently visible
content down as if the flip was a cube, the other content is show
as the upper face of the cube), #ELM_FLIP_PAGE_LEFT (move the
currently visible content to the left as if the flip was a book,
the other content is shown as the page below that),
#ELM_FLIP_PAGE_RIGHT (move the currently visible content to the
right s if the flip was a book, the other content is shown as the
page below that), #ELM_FLIP_PAGE_UP (move the currently visible
content up as if the flip was a book, the other content is shown
as the page below that) and #ELM_FLIP_PAGE_DOWN (move the
currently visible content down as if the flip was a book, the
other content is shown as the page below that).
]]
/* FIXME-doc
* @image html elm_flip.png
* @image latex elm_flip.eps width=\textwidth
*/
params { params {
@in mode: Elm.Flip.Mode; /*@ The mode type */ @in mode: Elm.Flip.Mode; [[The mode type.]]
} }
} }
go_to { go_to {
/*@ [[Runs the flip animation to front or back.
@brief Runs the flip animation to front or back.
Flips the front and back contents using the $mode animation. This Flips the front and back contents using the $mode animation.
effectively hides the currently visible content and shows the hidden one. This effectively hides the currently visible content and shows
he hidden one.
There a number of possible animations to use for the flipping:
@li #ELM_FLIP_ROTATE_X_CENTER_AXIS - Rotate the currently visible content
around a horizontal axis in the middle of its height, the other content
is shown as the other side of the flip.
@li #ELM_FLIP_ROTATE_Y_CENTER_AXIS - Rotate the currently visible content
around a vertical axis in the middle of its width, the other content is
shown as the other side of the flip.
@li #ELM_FLIP_ROTATE_XZ_CENTER_AXIS - Rotate the currently visible content
around a diagonal axis in the middle of its width, the other content is
shown as the other side of the flip.
@li #ELM_FLIP_ROTATE_YZ_CENTER_AXIS - Rotate the currently visible content
around a diagonal axis in the middle of its height, the other content is
shown as the other side of the flip.
@li #ELM_FLIP_CUBE_LEFT - Rotate the currently visible content to the left
as if the flip was a cube, the other content is show as the right face of
the cube.
@li #ELM_FLIP_CUBE_RIGHT - Rotate the currently visible content to the
right as if the flip was a cube, the other content is show as the left
face of the cube.
@li #ELM_FLIP_CUBE_UP - Rotate the currently visible content up as if the
flip was a cube, the other content is show as the bottom face of the cube.
@li #ELM_FLIP_CUBE_DOWN - Rotate the currently visible content down as if
the flip was a cube, the other content is show as the upper face of the
cube.
@li #ELM_FLIP_PAGE_LEFT - Move the currently visible content to the left as
if the flip was a book, the other content is shown as the page below that.
@li #ELM_FLIP_PAGE_RIGHT - Move the currently visible content to the right
as if the flip was a book, the other content is shown as the page below
that.
@li #ELM_FLIP_PAGE_UP - Move the currently visible content up as if the
flip was a book, the other content is shown as the page below that.
@li #ELM_FLIP_PAGE_DOWN - Move the currently visible content down as if the
flip was a book, the other content is shown as the page below that.
@image html elm_flip.png
@image latex elm_flip.eps width=\textwidth
@since 1.7
@ingroup Flip */
There a number of possible animations to use for the flipping,
these being #ELM_FLIP_ROTATE_X_CENTER_AXIS (rotate the currently
visible content around a horizontal axis in the middle of its
height, the other content is shown as the other side of the flip),
#ELM_FLIP_ROTATE_Y_CENTER_AXIS (rotate the currently visible
content around a vertical axis in the middle of its width, the
other content is shown as the other side of the flip),
#ELM_FLIP_ROTATE_XZ_CENTER_AXIS (rotate the currently visible
content around a diagonal axis in the middle of its width, the
other content is shown as the other side of the flip),
#ELM_FLIP_ROTATE_YZ_CENTER_AXIS (rotate the currently visible
content around a diagonal axis in the middle of its height, the
other content is hown as the other side of the flip).
#ELM_FLIP_CUBE_LEFT (rotate the currently visible content to the
left as if the flip was a cube, the other content is show as the
right face of the cube), #ELM_FLIP_CUBE_RIGHT (rotate the
currently visible content to the right as if the flip was a
cube, the other content is show as the left face of the cube),
#ELM_FLIP_CUBE_UP (rotate the currently visible content up as if
the flip was a cube, the other content is show as the bottom face
of the cube), #ELM_FLIP_CUBE_DOWN (rotate the currently visible
content down as if the flip was a cube, the other content is show
as the upper face of the cube), #ELM_FLIP_PAGE_LEFT (move the
currently visible content to the left as if the flip was a book,
the other content is shown as the page below that),
#ELM_FLIP_PAGE_RIGHT (move the currently visible content to the
right s if the flip was a book, the other content is shown as the
page below that), #ELM_FLIP_PAGE_UP (move the currently visible
content up as if the flip was a book, the other content is shown
as the page below that) and #ELM_FLIP_PAGE_DOWN (move the
currently visible content down as if the flip was a book, the
other content is shown as the page below that).
]]
/* FIXME-doc
* @image html elm_flip.png
* @image latex elm_flip.eps width=\textwidth
*/
params { params {
@in front: bool; /*@ if $true, makes front visible, otherwise makes back. */ @in front: bool; [[If $true, makes front visible, otherwise
@in mode: Elm.Flip.Mode; /*@ The mode type */ makes back.]]
@in mode: Elm.Flip.Mode; [[The mode type.]]
} }
} }
} }