API Reference for Enthought Tool Suite 2.7.1

Classes

• PreferenceBinding - A helper object for managing the binding of a trait to a preference.

Function summary

• bind_preference(obj, trait_name, preferences, pref_name, deflt, save_binding = True)

Functions

• bind_preference(obj, trait_name, preferences, pref_name, deflt, save_binding = True)

  Binds a trait to a preference value.

  Parameters

  obj : instance

  The object whose trait is being bound.

  trait_name : string

  The name of the trait to bind.

  preferences: Preferences

  The set of preferences in which to look for the preference to bind to.

  pref_name : string

  The name of the preference to bind.

  deflt

  The default value

  save_binding : Boolean

  Whether to save the binding in a private trait on obj. If this is False, then the caller must save the binding.

  Description

  This method sets the value of obj.trait_name to the preference value and sets up a listener so that if the preference value is changed, the trait is updated. It also sets up a trait handler so that if the trait value is otherwise set, the preference listener is removed.

  This method returns a binding object. If save_binding is False, the binding object must be saved by the caller; if it is True, this method saves the binding object in a private trait on obj before returning.

Imported Names

Copyright © 2002-2008 Enthought, Inc.