2019-07-04 16:02:43 -07:00
|
|
|
abstract @beta Efl.Ui.Spotlight.Indicator extends Efl.Object {
|
2019-09-02 07:24:26 -07:00
|
|
|
[[Object used by @Efl.Ui.Spotlight.Container to render an indication of the active widgets' position among
|
2019-07-04 16:02:43 -07:00
|
|
|
the rest of the container's widgets.
|
efl_ui_spotlight: migrate from active_index to active_element
after playing arround with the widget, we found out that it feels quite
weird to have a index, where most of the time you work with widgets.
We might want to add syntax suger in the future to make it easier to
just jump to the next element, or to the previous, but that still is to
be decided.
The event and the communication to the spotlight manager are still left
to be used with the index, reason for this is, that we might need to
fill there an invalid pointer, if a deletion is triggering an animation,
which seems quite weird. That needs further discussing.
Docx have been updated, the sitemarks about the shifting of the
active_index can be removed, as the element is not subject of change
during content adds/deletes.
ref T7991
Reviewed-by: Jaehyun Cho <jae_hyun.cho@samsung.com>
Differential Revision: https://phab.enlightenment.org/D9813
2019-09-02 01:26:40 -07:00
|
|
|
|
2019-05-29 08:35:19 -07:00
|
|
|
An example would be Android's little dots in the home screen.
|
|
|
|
]]
|
2019-04-28 03:28:55 -07:00
|
|
|
methods {
|
|
|
|
bind @pure_virtual {
|
2019-09-02 07:24:26 -07:00
|
|
|
[[This method is called the first time an @Efl.Ui.Spotlight.Indicator is assigned to an
|
|
|
|
@Efl.Ui.Spotlight.Container, binding them together.
|
2019-04-28 03:28:55 -07:00
|
|
|
|
2019-07-04 16:02:43 -07:00
|
|
|
This call can be used to setup the indicator part of the $spotlight.
|
2019-04-28 03:28:55 -07:00
|
|
|
|
2019-09-02 07:24:26 -07:00
|
|
|
The Active View of the container (if there is any) will be informed to the indicator by a later call to
|
|
|
|
@.position_update.
|
2019-04-28 03:28:55 -07:00
|
|
|
]]
|
|
|
|
params {
|
2019-07-04 16:02:43 -07:00
|
|
|
spotlight : Efl.Ui.Spotlight.Container; [[The container to bind this indicator to.]]
|
2019-04-28 03:28:55 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
content_add @pure_virtual {
|
efl_ui_spotlight: migrate from active_index to active_element
after playing arround with the widget, we found out that it feels quite
weird to have a index, where most of the time you work with widgets.
We might want to add syntax suger in the future to make it easier to
just jump to the next element, or to the previous, but that still is to
be decided.
The event and the communication to the spotlight manager are still left
to be used with the index, reason for this is, that we might need to
fill there an invalid pointer, if a deletion is triggering an animation,
which seems quite weird. That needs further discussing.
Docx have been updated, the sitemarks about the shifting of the
active_index can be removed, as the element is not subject of change
during content adds/deletes.
ref T7991
Reviewed-by: Jaehyun Cho <jae_hyun.cho@samsung.com>
Differential Revision: https://phab.enlightenment.org/D9813
2019-09-02 01:26:40 -07:00
|
|
|
[[A $subobj has been added at position $index in the bound container.]]
|
2019-04-28 03:28:55 -07:00
|
|
|
params {
|
2019-05-29 08:35:19 -07:00
|
|
|
subobj : Efl.Gfx.Entity; [[The new object that has been added to the container.]]
|
|
|
|
index : int; [[The index of the new object in the container's list.]]
|
2019-04-28 03:28:55 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
content_del @pure_virtual {
|
efl_ui_spotlight: migrate from active_index to active_element
after playing arround with the widget, we found out that it feels quite
weird to have a index, where most of the time you work with widgets.
We might want to add syntax suger in the future to make it easier to
just jump to the next element, or to the previous, but that still is to
be decided.
The event and the communication to the spotlight manager are still left
to be used with the index, reason for this is, that we might need to
fill there an invalid pointer, if a deletion is triggering an animation,
which seems quite weird. That needs further discussing.
Docx have been updated, the sitemarks about the shifting of the
active_index can be removed, as the element is not subject of change
during content adds/deletes.
ref T7991
Reviewed-by: Jaehyun Cho <jae_hyun.cho@samsung.com>
Differential Revision: https://phab.enlightenment.org/D9813
2019-09-02 01:26:40 -07:00
|
|
|
[[The $subobj at position $index in the bound container has been removed.]]
|
2019-04-28 03:28:55 -07:00
|
|
|
params {
|
2019-05-29 08:35:19 -07:00
|
|
|
subobj : Efl.Gfx.Entity; [[The object being removed from the container.]]
|
|
|
|
index : int; [[The index this object had in the container's list.]]
|
2019-04-28 03:28:55 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
position_update @pure_virtual {
|
efl_ui_spotlight: migrate from active_index to active_element
after playing arround with the widget, we found out that it feels quite
weird to have a index, where most of the time you work with widgets.
We might want to add syntax suger in the future to make it easier to
just jump to the next element, or to the previous, but that still is to
be decided.
The event and the communication to the spotlight manager are still left
to be used with the index, reason for this is, that we might need to
fill there an invalid pointer, if a deletion is triggering an animation,
which seems quite weird. That needs further discussing.
Docx have been updated, the sitemarks about the shifting of the
active_index can be removed, as the element is not subject of change
during content adds/deletes.
ref T7991
Reviewed-by: Jaehyun Cho <jae_hyun.cho@samsung.com>
Differential Revision: https://phab.enlightenment.org/D9813
2019-09-02 01:26:40 -07:00
|
|
|
[[This method tells the indicator that @Efl.Ui.Spotlight.Container.active_element has changed in the bound
|
2019-09-02 07:24:26 -07:00
|
|
|
container.
|
2019-05-29 08:35:19 -07:00
|
|
|
$position ranges from -1 to the number of views in the bound container (@Efl.Container.content_count).
|
2019-09-02 07:24:26 -07:00
|
|
|
Notice this allows moving to a position before the first view or past the last view, which might happen if the
|
|
|
|
view is thumb-scrolled out-of-bounds. Indicators can choose to render these out-of-bounds positions or not.
|
2019-04-28 03:28:55 -07:00
|
|
|
|
2019-09-02 07:24:26 -07:00
|
|
|
Fractional values indicate positions in-between two views and should be respected to obtain smooth transitions.
|
2019-04-28 03:28:55 -07:00
|
|
|
]]
|
|
|
|
params {
|
2019-09-02 07:24:26 -07:00
|
|
|
position : double; [[The index of the active view, or a value in-between views if a transition is currently
|
|
|
|
playing.]]
|
2019-04-28 03:28:55 -07:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|