API Reference for Enthought Tool Suite 3.0.1

Function summary

• ArrayEditor(*args, **traits)
• BooleanEditor(*args, **traits)
• ButtonEditor(*args, **traits)
• CheckListEditor(*args, **traits)
• CodeEditor(*args, **traits)
• ColorEditor(*args, **traits)
• ColorTrait(*args, **traits)
• CompoundEditor(*args, **traits)
• CustomEditor(*args, **traits)
• DirectoryEditor(*args, **traits)
• DNDEditor(*args, **traits)
• DropEditor(*args, **traits)
• EnumEditor(*args, **traits)
• FileEditor(*args, **traits)
• FontEditor(*args, **traits)
• FontTrait(*args, **traits)
• HistoryEditor(*args, **traits)
• HTMLEditor(*args, **traits)
• ImageEditor(*args, **traits)
• ImageEnumEditor(*args, **traits)
• InstanceEditor(*args, **traits)
• KeyBindingEditor(*args, **traits)
• ListEditor(*args, **traits)
• ListStrEditor(*args, **traits)
• NullEditor(*args, **traits)
• PopupEditor(*args, **traits)
• RangeEditor(*args, **traits)
• RGBColorEditor(*args, **traits)
• RGBColorTrait(*args, **traits)
• ScrubberEditor(*args, **traits)
• SetEditor(*args, **traits)
• ShellEditor(*args, **traits)
• TableEditor(*args, **traits)
• TabularEditor(*args, **traits)
• TextEditor(*args, **traits)
• TitleEditor(*args, **traits)
• TreeEditor(*args, **traits)
• TupleEditor(*args, **traits)
• ValueEditor(*args, **traits)

Functions

• ArrayEditor(*args, **traits)

  Allows the user to edit 2-D Numeric arrays.

• BooleanEditor(*args, **traits)

  Allows the user to select a true or false condition.

• ButtonEditor(*args, **traits)

  Allows the user to click a button; this editor is typically used with an event trait to fire the event.

• CheckListEditor(*args, **traits)

  Allows the user to select zero, one, or more values from a finite set of possibilities.

  Note that the "simple" style is limited to selecting a single value.

• CodeEditor(*args, **traits)

  Allows the user to edit a multi-line string.

  The "simple" and "custom" styles of this editor display multiple lines of the string, with line numbers.

• ColorEditor(*args, **traits)

  Allows the user to select a color.

• ColorTrait(*args, **traits)
• CompoundEditor(*args, **traits)

  Allows the user to select a value based on a compound trait.

  Because a compound trait is composed of multiple trait definitions, this editor factory displays trait editors for each of the constituent traits. For example, consider the following trait attribute, defined as a compound that accepts integer values in the range of 1 to 6, or text strings corresponding to those integers:

  compound = Trait(1, Range(1, 6), 'one', 'two', 'three', 'four',
                      'five', 'six')
  

  The editor displayed for this trait attribute combines editors for integer ranges and for enumerations.

• CustomEditor(*args, **traits)

  Creates a developer-specified custom editor.

• DirectoryEditor(*args, **traits)

  Allows the user to specify a directory.

• DNDEditor(*args, **traits)

  Allows dragging and dropping an object.

• DropEditor(*args, **traits)

  Allows dropping an object to set a value.

• EnumEditor(*args, **traits)

  Allows the user to select a single value from an enumerated list of values.

• FileEditor(*args, **traits)

  Allows the user to select a file.

• FontEditor(*args, **traits)

  Allows the user to select a typeface and type size.

• FontTrait(*args, **traits)
• HistoryEditor(*args, **traits)

  Displays a text field with a history of prior values.

• HTMLEditor(*args, **traits)

  Displays formatted HTML text.

• ImageEditor(*args, **traits)

  Allows an image to be imbedded ina traits ui.

• ImageEnumEditor(*args, **traits)

  Allows the user to select an image that represents a value in an enumerated list of values.

• InstanceEditor(*args, **traits)

  Allows the user to modify a trait attribute whose value is an instance, by modifying the trait attribute values on the instance.

• KeyBindingEditor(*args, **traits)
• ListEditor(*args, **traits)

  Allows the user to modify a list of values.

  The user can add, delete, or reorder items, or change the content of items.

• ListStrEditor(*args, **traits)

  Allows the user to modify a list of strings (or values that can be mapped to strings).

• NullEditor(*args, **traits)

  Defines an empty (placeholder) editor.

• PopupEditor(*args, **traits)

  Allows the user to use a clickable popup editor.

• RangeEditor(*args, **traits)

  Allows the user to specify a value within a range.

• RGBColorEditor(*args, **traits)
• RGBColorTrait(*args, **traits)
• ScrubberEditor(*args, **traits)
• SetEditor(*args, **traits)
• ShellEditor(*args, **traits)
• TableEditor(*args, **traits)

  Allows the user to modify a list of objects using a table editor.

• TabularEditor(*args, **traits)

  Allows the user to modify a list of objects using a table editor.

• TextEditor(*args, **traits)

  Allows the user to modify a text string.

  The string value entered by the user is coerced to the appropriate type for the trait attribute being modified.

• TitleEditor(*args, **traits)

  Displays a dynamic value using a title control.

• TreeEditor(*args, **traits)

  Allows the user to modify a tree data structure.

• TupleEditor(*args, **traits)
• ValueEditor(*args, **traits)

Imported Names

© Copyright 2002-2008 Enthought, Inc.