1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
# (C) Copyright 2005-2025 Enthought, Inc., Austin, TX
# All rights reserved.
#
# This software is provided without warranty under the terms of the BSD
# license included in LICENSE.txt and may be redistributed only under
# the conditions described in the aforementioned license. The license
# is also available online at http://www.enthought.com/licenses/BSD.txt
#
# Thanks for using Enthought open source!
from traits.api import Event, Interface, Str
class ISelectionProvider(Interface):
""" Source of selections. """
#: Unique ID identifying the provider.
provider_id = Str()
#: Event triggered when the selection changes.
#: The content of the event is an :class:`~.ISelection` instance.
selection = Event
def get_selection(self):
"""Return the current selection.
Returns:
selection -- ISelection
Object representing the current selection.
"""
def set_selection(self, items, ignore_missing=False):
"""Set the current selection to the given items.
If ``ignore_missing`` is ``True``, items that are not available in the
selection provider are silently ignored. If it is ``False`` (default),
an :class:`~.ValueError` should be raised.
Arguments:
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.
"""
|
