API Reference for Enthought Tool Suite 3.2.0

Variables

• AHandler

  Reference to a Handler object trait:

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

• AKeyBindings

  The KeyBindings trait:

  AKeyBindings = Instance('enthought.traits.ui.key_bindings.KeyBindings', desc = 'the global key bindings for the view')
  
  

• AKind

  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.
  • 'popup': A temporary, frameless popup dialog that immediately updates the object and is active only while the mouse pointer is in the dialog.
  • 'info': A temporary, frameless popup dialog that immediately updates the object and is active only while the dialog is still over the invoking control.
  • '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.

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

• AModelView

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

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

• AnId

  Name of the view trait:

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

• ATitle

  Dialog window title trait:

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

• CloseResult

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

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

• Content

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

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

• Height

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

• ImportTypes

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

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

• IsResizable

  Is the dialog window resizable?

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

• IsScrollable

  Is the view scrollable?

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

• OnApply

  Apply changes handler:

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

• Width

  The view position and size traits:

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

• XCoordinate

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

• YCoordinate

  YCoordinate = 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-2009 Enthought, Inc.