API Reference for Enthought Tool Suite 3.2.0

Variables

• AdaptMap

  Allowed values and mappings for the 'adapt' keyword:

  AdaptMap = { Const('no') : Const(0), Const('yes') : Const(1), Const('default') : Const(2) }
  
  

• Date

  -- Date Trait definition ----------------------------------------------------

  Date = BaseInstance(datetime.date, editor = date_editor)
  
  

• DictStrAny

  Only a dictionary of string:Any values can be assigned; only string keys can be inserted. The default value is {}.

  DictStrAny = Dict(str, Any)
  
  

• DictStrBool

  Only a dictionary of string:Boolean values can be assigned; only string keys with Boolean values can be inserted. The default value is {}.

  DictStrBool = Dict(str, bool)
  
  

• DictStrFloat

  Only a dictionary of string:float values can be assigned; only string keys with float values can be inserted. The default value is {}.

  DictStrFloat = Dict(str, float)
  
  

• DictStrInt

  Only a dictionary of string:integer values can be assigned; only string keys with integer values can be inserted. The default value is {}.

  DictStrInt = Dict(str, int)
  
  

• DictStrList

  Only a dictionary of string:list values can be assigned; only string keys with list values can be assigned. The default value is {}.

  DictStrList = Dict(str, list)
  
  

• DictStrLong

  Only a dictionary of string:long-integer values can be assigned; only string keys with long-integer values can be inserted. The default value is {}.

  DictStrLong = Dict(str, long)
  
  

• DictStrStr

  Only a dictionary of string:string values can be assigned; only string keys with string values can be inserted. The default value is {}.

  DictStrStr = Dict(str, str)
  
  

• false

  Synonym for Bool; default value is False.

  false = Bool
  
  

• ListBool

  List of Boolean values; default value is [].

  ListBool = List(bool)
  
  

• ListClass

  List of class values; default value is [].

  ListClass = List(ClassType)
  
  

• ListComplex

  List of complex values; default value is [].

  ListComplex = List(complex)
  
  

• ListFloat

  List of float values; default value is [].

  ListFloat = List(float)
  
  

• ListFunction

  List of function values; default value is [].

  ListFunction = List(FunctionType)
  
  

• ListInstance

  List of instance values; default value is [].

  ListInstance = List(InstanceType)
  
  

• ListInt

  List of integer values; default value is [].

  ListInt = List(int)
  
  

• ListMethod

  List of method values; default value is [].

  ListMethod = List(MethodType)
  
  

• ListStr

  List of string values; default value is [].

  ListStr = List(str)
  
  

• ListThis

  List of container type values; default value is [].

  ListThis = List(ThisClass)
  
  

• ListUnicode

  List of Unicode string values; default value is [].

  ListUnicode = List(unicode)
  
  

• MutableTypes

  MutableTypes = (list, dict)
  
  

• SetTypes

  SetTypes = (SequenceTypes + (set))
  
  

• Time

  -- Time Trait definition ----------------------------------------------------

  Time = BaseInstance(datetime.time, editor = time_editor)
  
  

• true

  Boolean values only; default value is True.

  true = Bool(True)
  
  

• undefined

  Allows any value to be assigned; no type-checking is performed. Default value is Undefined.

  undefined = Any(Undefined)
  
  

Traits

• Disallow

  Create a singleton instance as the trait:

  Disallow = Disallow()
  
  

• missing

  Create a singleton instance as the trait:

  missing = missing()
  
  

• ReadOnly

  Create a singleton instance as the trait:

  ReadOnly = ReadOnly()
  
  

Classes

• AdaptedTo
• AdaptsTo
• Any - Defines a trait whose value can be anything.
• BaseBool - Defines a trait whose value must be a Python boolean.
• BaseCBool - Defines a trait whose value must be a Python boolean and which supports coercions of non-boolean values to boolean.
• BaseCComplex - Defines a trait whose value must be a Python complex and which supports coercions of non-complex values to complex.
• BaseCFloat - Defines a trait whose value must be a Python float and which supports coercions of non-float values to float.
• BaseCInt - Defines a trait whose value must be a Python int and which supports coercions of non-int values to int.
• BaseClass - Base class for types which have an associated class which can be determined dynamically by specifying a string name for the class (e.g
• BaseCLong - Defines a trait whose value must be a Python long and which supports coercions of non-long values to long.
• BaseComplex - Defines a trait whose value must be a Python complex.
• BaseCStr - Defines a trait whose value must be a Python string and which supports coercions of non-string values to string.
• BaseCUnicode - Defines a trait whose value must be a Python unicode string and which supports coercions of non-unicode values to unicode.
• BaseDirectory - Defines a trait whose value must be the name of a directory.
• BaseEnum - Defines a trait whose value must be one of a specified set of values.
• BaseFile - Defines a trait whose value must be the name of a file.
• BaseFloat - Defines a trait whose value must be a Python float.
• BaseInstance - Defines a trait whose value must be an instance of a specified class, or one of its subclasses.
• BaseInt - Defines a trait whose value must be a Python int.
• BaseLong - Defines a trait whose value must be a Python long.
• BaseRange - Defines a trait whose numeric value must be in a specified range.
• BaseStr - Defines a trait whose value must be a Python string.
• BaseTuple - Defines a trait whose value must be a tuple of specified trait types.
• BaseType - Defines a trait whose value must be an instance of a simple Python type.
• BaseUnicode - Defines a trait whose value must be a Python unicode string.
• Bool - Defines a trait whose value must be a Python boolean using a C-level fast validator.
• Button - Defines a trait whose UI editor is a button.
• Callable - Defines a trait whose value must be a Python callable.
• CBool - Defines a trait whose value must be a Python boolean and which supports coercions of non-boolean values to boolean using a C-level fast validator.
• CComplex - Defines a trait whose value must be a Python complex and which supports coercions of non-complex values to complex using a C-level fast validator.
• CFloat - Defines a trait whose value must be a Python float and which supports coercions of non-float values to float using a C-level fast validator.
• CInt - Defines a trait whose value must be a Python int and which supports coercions of non-int values to int using a C-level fast validator.
• Class - Defines a trait whose value must be an old-style Python class.
• CList - Defines a trait whose values must be a list whose items are of the specified trait type or which can be coerced to a list whose values are of the specified trait type.
• CLong - Defines a trait whose value must be a Python long and which supports coercions of non-long values to long using a C-level fast validator.
• Code - Defines a trait whose value is a Python string that represents source code in some language.
• Complex - Defines a trait whose value must be a Python complex using a C-level fast validator.
• Constant - Defines a trait whose value is a constant.
• CSet - Defines a trait whose values must be a set whose items are of the specified trait type or which can be coerced to a set whose values are of the specified trait type.
• CStr - Defines a trait whose value must be a Python string and which supports coercions of non-string values to string using a C-level fast validator.
• CUnicode - Defines a trait whose value must be a Python unicode string and which supports coercions of non-unicode values to unicode using a C-level fast validator.
• Delegate - Defines a trait whose value is delegated to a trait on another object.
• DelegatesTo - Defines a trait delegate that matches the standard 'delegate' design pattern.
• Dict - Defines a trait whose value must be a dictionary, optionally with specified types for keys and values.
• Directory - Defines a trait whose value must be the name of a directory using a C-level fast validator.
• Disallow - Defines a trait that prevents any value from being assigned or read
• Either - Defines a trait whose value can be any of of a specified list of traits.
• Enum - Defines a trait whose value must be one of a specified set of values using a C-level fast validator.
• Event
• Expression - Defines a trait whose value must be a valid Python expression
• File - Defines a trait whose value must be the name of a file using a C-level fast validator.
• Float - Defines a trait whose value must be a Python float using a C-level fast validator.
• Function - Defines a trait whose value must be a Python function.
• Generic - Defines a trait whose value can be anything and whose definition can be redefined via assignment using a TraitValue object.
• HandleWeakRef
• HTML - Defines a trait whose value must be a string that is interpreted as being HTML
• Instance - Defines a trait whose value must be an instance of a specified class, or one of its subclasses using a C-level fast validator.
• Int - Defines a trait whose value must be a Python int using a C-level fast validator.
• List - Defines a trait whose value must be a list whose items are of the specified trait type.
• Long - Defines a trait whose value must be a Python long using a C-level fast validator.
• Method - Defines a trait whose value must be a Python method.
• missing - Defines a trait used to indicate that a parameter is missing from a type-checked method signature
• Module - Defines a trait whose value must be a Python module.
• Password - Defines a trait whose value must be a string, optionally of constrained length or matching a regular expression
• PrototypedFrom - Defines a trait delegate that matches the standard 'prototype' design pattern.
• Python - Defines a trait that provides behavior identical to a standard Python attribute
• PythonValue - Defines a trait whose value can be of any type, and whose default editor is a Python shell.
• Range - Defines a trait whose numeric value must be in a specified range using a C-level fast validator.
• ReadOnly - Defines a trait that is write-once, and then read-only
• Regex - Defines a trait whose value is a Python string that matches a specified regular expression.
• self - Defines a trait whose value must be an instance of the defining class and whose default value is the object containing the trait.
• Set - Defines a trait whose value must be a set whose items are of the specified trait type.
• Str - Defines a trait whose value must be a Python string using a C-level fast validator.
• String - Defines a trait whose value must be a Python string whose length is optionally in a specified range, and which optionally matches a specified regular expression.
• Symbol
• This - Defines a trait whose value must be an instance of the defining class.
• Title - Defines a string type which by default uses the traits ui TitleEditor when used in a View.
• ToolbarButton - Defines a trait whose UI editor is a button that can be used on a toolbar.
• Tuple - Defines a trait whose value must be a tuple of specified trait types using a C-level fast validator.
• Type - Defines a trait whose value must be a subclass of a specified class.
• Unicode - Defines a trait whose value must be a Python unicode string using a C-level fast validator.
• WeakRef - Returns a trait whose value must be an instance of the same type (or a subclass) of the specified klass, which can be a class or an instance

Function summary

• default_text_editor(trait, type = None)
• validate_implements(value, klass, unused = None)

Functions

• default_text_editor(trait, type = None)
• validate_implements(value, klass, unused = None)

  Checks to see if a specified value implements the instance class interface (if it is an interface).

Imported Names

© Copyright 2002-2009 Enthought, Inc.