API Reference for Enthought Tool Suite 3.2.0
Adds a 'connect' feature to DockWindow which allows users to dynamically connect (i.e. synchronize) traits on one object with another. To make an object 'connectable' the developer must specify the 'connect' metadata on any trait that can be connected to another object's trait. The value of the 'connect' metadata should be: 'to|from|both[:[:]description]', indicating the direction of synchronization supported (i.e. to, from or both), as well as an optional description to display in the feature's tooltip. If a double colon (i.e. ::) precedes the description, then the description is also used as a type, meaning that both ends of the connection must specify the same type information. This is useful when using simple trait types list Str or File, and you want to add an additional level of type checking to the connection.
connections_image = ImageResource('connections_feature')
Menu to display when there are no available connections/disconnections:
no_connections = Menu(Action(name = 'No connections available', enabled = False), name = 'popup')
no_connections_image = ImageResource('no_connections_feature')
PermanentConnections = 'enthought.developer.features.ConnectFeature.permanent_connections'
supported_protocols = ('to', 'from', 'both')
| Local name | Refers to |
|---|---|
| Action | enthought.traits.ui.menu.Action |
| Any | enthought.traits.trait_types.Any |
| Dict | enthought.traits.trait_types.Dict |
| DockWindowFeature | enthought.pyface.dock.dock_window_feature.DockWindowFeature |
| Enum | enthought.traits.trait_types.Enum |
| get_pickle | enthought.developer.helper.pickle.get_pickle |
| HasPrivateTraits | enthought.traits.has_traits.HasPrivateTraits |
| HasTraits | enthought.traits.has_traits.HasTraits |
| ImageResource | enthought.pyface.image_resource.ImageResource |
| Instance | enthought.traits.trait_types.Instance |
| List | enthought.traits.trait_types.List |
| Menu | enthought.pyface.action.menu_manager.MenuManager |
| set_pickle | enthought.developer.helper.pickle.set_pickle |
| Str | enthought.traits.trait_types.Str |
© Copyright 2002-2009 Enthought, Inc.