Class enthought.traits.trait_handlers.TraitPrefixMap

API Reference for Enthought Tool Suite 3.2.0

A cross between the TraitPrefixList and TraitMap classes.

Like TraitMap, TraitPrefixMap is created using a dictionary, but in this case, the keys of the dictionary must be strings. Like TraitPrefixList, a string v is a valid value for the trait attribute if it is a prefix of one and only one key k in the dictionary. The actual values assigned to the trait attribute is k, and its corresponding mapped attribute is map*[*k].

Example

boolean_map = Trait('true', TraitPrefixMap( {
                                'true': 1,
                                'yes': 1,
                                'false': 0,
                                'no': 0 } ))

This example defines a Boolean trait that accepts any prefix of 'true', 'yes', 'false', or 'no', and maps them to 1 or 0.

Base classes
Attributes
Methods

Inherits from

TraitMap: enthought.traits.trait_handlers.TraitMap

Attributes

Inherited from base classes

Method summary

__init__(self, map)
info(self)
validate(self, object, name, value)

Inherited from base classes

arg_error(self, method, arg_num, object, name, value)
create_editor(self)
dup_arg_error(self, method, arg_num, object, name)
error(self, object, name, value)
full_info(self, object, name, value)
inner_traits(self)
is_valid(self, object, name, value)
keyword_error(self, method, object, name, value)
missing_arg_error(self, method, arg_num, object, name)
repr(self, value)
return_error(self, method, object, value)

Methods

__init__(self, map)

Creates a TraitPrefixMap handler.

Parameters

map : dictionary

A dictionary whose keys are strings that are valid values for the trait attribute, and whose corresponding values are the values for the shadow trait attribute.
info(self)
validate(self, object, name, value)

© Copyright 2002-2009 Enthought, Inc.