3
6ßL]â  ã               @   s8   d dl mZmZ d dlmZmZmZ G dd„ deƒZdS )é    )ÚDictÚ	HasTraits)ÚProviderNotRegisteredErrorÚIDConflictErrorÚListenerNotConnectedErrorc               @   sv   e Zd ZdZdd„ Zdd„ Zdd„ Zdd	„ Zddd„Zdd„ Z	dd„ Z
eƒ Zeƒ Zdd„ Zdd„ Zdd„ Zdd„ ZdS )ÚSelectionServicea}   The selection service connects selection providers and listeners.

    The selection service is a register of selection providers, i.e., objects
    that publish their current selection.

    Selections can be requested actively, by explicitly requesting the current
    selection in a provider (:meth:`get_selection(id)`), or passively by
    connecting selection listeners.
    c             C   s<   |j }| j|ƒrt|d�‚|| j|< || jkr8| j|ƒ dS )aN   Add a selection provider.

        The provider is identified by its ID. If a provider with the same
        ID has been already registered, an :class:`~.IDConflictError`
        is raised.

        Arguments:
            provider -- ISelectionProvider
                The selection provider added to the internal registry.

        )Úprovider_idN)r   Úhas_selection_providerr   Ú
_providersÚ
_listenersÚ_connect_all_listeners)ÚselfÚproviderr   © r   úJ/tmp/pip-install-5sebvq2j/apptools/apptools/selection/selection_service.pyÚadd_selection_provider   s    



z'SelectionService.add_selection_providerc             C   s
   || j kS )z3 Has a provider with the given ID been registered? )r
   )r   r   r   r   r   r	   *   s    z'SelectionService.has_selection_providerc             C   s0   |j }| j|ƒ || jkr$| j|ƒ | j|= dS )a   Remove a selection provider.

        If the provider has not been registered, a
        :class:`~.ProviderNotRegisteredError` is raised.

        Arguments:
            provider -- ISelectionProvider
                The selection provider added to the internal registry.
        N)r   Ú_raise_if_not_registeredr   Ú_disconnect_all_listenersr
   )r   r   r   r   r   r   Úremove_selection_provider.   s
    



z*SelectionService.remove_selection_providerc             C   s   | j |ƒ | j| }|jƒ S )aŒ   Return the current selection of the provider with the given ID.

        If a provider with that ID has not been registered, a
        :class:`~.ProviderNotRegisteredError` is raised.

        Arguments:
            provider_id -- str
                The selection provider ID.

        Returns:
            selection -- ISelection
                The current selection of the provider.
        )r   r
   Úget_selection)r   r   r   r   r   r   r   @   s    

zSelectionService.get_selectionFc             C   s"   | j |ƒ | j| }|j||d�S )ac   Set the current selection in a provider to the given items.

        If a provider with the given ID has not been registered, a
        :class:`~.ProviderNotRegisteredError` is raised.

        If ``ignore_missing`` is ``True``, items that are not available in the
        selection provider are silently ignored. If it is ``False`` (default),
        a :class:`ValueError` should be raised.

        Arguments:
            provider_id -- str
                The selection provider ID.

            items -- list
                List of items to be selected.

            ignore_missing -- bool
                If ``False`` (default), the provider raises an exception if any
                of the items in ``items`` is not available to be selected.
                Otherwise, missing elements are silently ignored, and the rest
                is selected.
        )Úignore_missing)r   r
   Úset_selection)r   r   Úitemsr   r   r   r   r   r   R   s    

zSelectionService.set_selectionc             C   s<   | j j|g ƒ | j | j|ƒ | j|ƒr8| j||dd� dS )a   Connect a listener to selection events from a specific provider.

        The signature if the listener callback is ``func(i_selection)``.
        The listener is called:

        1) When a provider with the given ID is registered, with its initial
           selection as argument, or

        2) whenever the provider fires a selection event.

        It is perfectly valid to connect a listener before a provider with the
        given ID is registered. The listener will remain connected even if
        the provider is repeatedly connected and disconnected.

        Arguments:
            provider_id -- str
                The selection provider ID.
            func -- callable(i_selection)
                A callable object that is notified when the selection changes.
        F)ÚremoveN)r   Ú
setdefaultÚappendr	   Ú_toggle_listener)r   r   Úfuncr   r   r   Úconnect_selection_listenerm   s    
z+SelectionService.connect_selection_listenerc             C   sX   | j |ƒr| j||dd� y| j| j|ƒ W n$ ttfk
rR   t||d�‚Y nX dS )a   Disconnect a listener from a specific provider.

        Arguments:
            provider_id -- str
                The selection provider ID.
            func -- callable(provider_id, i_selection)
                A callable object that is notified when the selection changes.
        T)r   )r   ZlistenerN)r	   r   r   r   Ú
ValueErrorÚKeyErrorr   )r   r   r   r   r   r   Údisconnect_selection_listenerˆ   s    

z.SelectionService.disconnect_selection_listenerc             C   s   | j | }|j|d|d� d S )NÚ	selection)r   )r
   Zon_trait_change)r   r   r   r   r   r   r   r   r   ¡   s    
z!SelectionService._toggle_listenerc             C   sB   | j | }|jƒ }x*| j| D ]}| j||dd� ||ƒ qW dS )z„ Connect all listeners connected to a provider.

        As soon as they are connected, they receive the initial selection.
        F)r   N)r
   r   r   r   )r   r   r   r"   r   r   r   r   r   ¥   s
    
z'SelectionService._connect_all_listenersc             C   s(   x"| j | D ]}| j||dd� qW d S )NT)r   )r   r   )r   r   r   r   r   r   r   ²   s    z*SelectionService._disconnect_all_listenersc             C   s   | j |ƒst|d�‚d S )N)r   )r	   r   )r   r   r   r   r   r   ¶   s    
z)SelectionService._raise_if_not_registeredN)F)Ú__name__Ú
__module__Ú__qualname__Ú__doc__r   r	   r   r   r   r   r!   r   r   r
   r   r   r   r   r   r   r   r   r      s   	
r   N)Z
traits.apir   r   Zapptools.selection.errorsr   r   r   r   r   r   r   r   Ú<module>   s   