Source code for enamlnative.widgets.swipe_refresh_layout

"""
Copyright (c) 2017-2022, CodeLV.

Distributed under the terms of the MIT License.

The full license is in the file LICENSE, distributed with this software.

Created on Oct 22, 2017

 
"""
from atom.api import Bool, Event, ForwardTyped, Int, Str, Typed, observe
from enaml.core.declarative import d_
from .view_group import ProxyViewGroup, ViewGroup


class ProxySwipeRefreshLayout(ProxyViewGroup):
    """The abstract definition of a proxy SwipeRefreshLayout object."""

    #: A reference to the Label declaration.
    declaration = ForwardTyped(lambda: SwipeRefreshLayout)

    def set_indicator_background_color(self, color):
        raise NotImplementedError

    def set_indicator_color(self, color):
        raise NotImplementedError

    def set_trigger_distance(self, distance):
        raise NotImplementedError


[docs]class SwipeRefreshLayout(ViewGroup):
    """SwipeRefreshLayout is a view group that displays
    child views in relative positions.

    """

    #: Enabled
    enabled = d_(Bool(True))

    #: Must be a
    indicator_color = d_(Str())

    #: Must be a
    indicator_background_color = d_(Str())

    #: Set the distance to trigger a sync in dips
    trigger_distance = d_(Int())

    #: Triggered when the user swipes
    refreshed = d_(Event())

    #: A reference to the proxy object.
    proxy = Typed(ProxySwipeRefreshLayout)

    # -------------------------------------------------------------------------
    # Observers
    # -------------------------------------------------------------------------
    @observe(
        "enabled",
        "indicator_color",
        "indicator_background_color",
        "trigger_distance",
    )
    def _update_proxy(self, change):

        if change["type"] == "event":
            self.proxy.set_refreshed(True)
        else:
            super()._update_proxy(change)