API Reference for Enthought Tool Suite 2.7.1

Variables

• apply_trait

  apply_trait = Bool(True, desc = "whether to add an 'Apply' button to the view")
  
  

• cancel_trait

  cancel_trait = Bool(True, desc = "whether to add a 'Cancel' button to the view")
  
  

• close_result_trait

  The result that should be returned if the user clicks the window or dialog close button or icon

  close_result_trait = Enum(None, True, False, desc = 'the result to return when the user clicks the window or dialog close button or icon')
  
  

• content_trait

  Contents of the view trait (i.e., a single Group object)

  content_trait = Instance(Group, desc = 'the content of the view')
  
  

• handler_trait

  Reference to a Handler object trait

  handler_trait = Any(desc = 'the handler for the view')
  
  

• height_trait

  height_trait = Float(-Const(1000000.0), desc = 'the height of the view window')
  
  

• help_trait

  help_trait = Bool(True, desc = "whether to add a 'Help' button to the view")
  
  

• id_trait

  Name of the view trait

  id_trait = Str(desc = 'the name of the view')
  
  

• imports_trait

  The valid categories of imported elements that can be dragged into the view

  imports_trait = List(Str, desc = 'the categories of elements that can be dragged into the view')
  
  

• kind_trait

  User interface 'kind' trait. The values have the following meanings:

  • 'panel': An embeddable panel. This type of window is intended to be used as part of a larger interface.
  • 'subpanel': An embeddable panel that does not display command buttons, even if the View specifies them.
  • 'modal': A modal dialog box that operates on a clone of the object until the user commits the change.
  • 'nonmodal': A nonmodal dialog box that operates on a clone of the object until the user commits the change
  • 'live': A nonmodal dialog box that immediately updates the object.
  • 'livemodal': A modal dialog box that immediately updates the object.
  • 'wizard': A wizard modal dialog box. A wizard contains a sequence of pages, which can be accessed by clicking Next and Back buttons. Changes to attribute values are applied only when the user clicks the Finish button on the last page.

  kind_trait = Trait('live', TraitPrefixList('panel', 'subpanel', 'modal', 'nonmodal', 'livemodal', 'live', 'wizard'), desc = 'the kind of view window to create', cols = 4)
  
  

• model_view_trait

  An optional model/view factory for converting the model into a viewable 'model_view' object

  model_view_trait = Callable(desc = 'the factory function for converting amodel into a model/view object')
  
  

• ok_trait

  ok_trait = Bool(True, desc = "whether to add an 'OK' button to the view")
  
  

• on_apply_trait

  on_apply_trait = Callable(desc = 'the routine to call when modal changes are applied or reverted')
  
  

• resizable_trait

  Is the dialog window is resizable?

  resizable_trait = Bool(False, desc = 'whether dialog can be resized or not')
  
  

• revert_trait

  revert_trait = Bool(True, desc = "whether to add a 'Revert' button to the view")
  
  

• scrollable_trait

  Is the view scrollable?

  scrollable_trait = Bool(False, desc = 'whether view should be scrollable or not')
  
  

• title_trait

  Dialog window title trait

  title_trait = Str(desc = 'the window title for the view')
  
  

• undo_trait

  undo_trait = Bool(True, desc = "whether to add 'Undo' and 'Redo' buttons to the view")
  
  

• width_trait

  width_trait = Float(-Const(1000000.0), desc = 'the width of the view window')
  
  

• x_trait

  x_trait = Float(-Const(1000000.0), desc = 'the x coordinate of the view window')
  
  

• y_trait

  y_trait = Float(-Const(1000000.0), desc = 'the y coordinate of the view window')
  
  

Classes

• View - A Traits-based user interface for one or more objects

Imported Names

Copyright © 2002-2008 Enthought, Inc.