API Reference for Enthought Tool Suite 3.0.1

Variables

• BOTTOM

  BOTTOM = 8
  
  

• BOTTOM_LEFT

  BOTTOM_LEFT = (BOTTOM + LEFT)
  
  

• BOTTOM_RIGHT

  BOTTOM_RIGHT = (BOTTOM + RIGHT)
  
  

• default_font

  default_font = str_to_font(None, None, default_font_name)
  
  

• default_font_name

  Pick a default font that should work on all platforms.

  default_font_name = 'modern 10'
  
  

• EMBOSSED

  EMBOSSED = 2
  
  

• empty_rectangle

  Special 'empty rectangle' indicator:

  empty_rectangle = -Const(1)
  
  

• ENGRAVED

  Text engraving style:

  ENGRAVED = 1
  
  

• engraving_style

  engraving_style = { Const('none') : Const(0), Const('engraved') : Name('ENGRAVED'), Const('embossed') : Name('EMBOSSED'), Const('shadowed') : Name('SHADOWED') }
  
  

• font_families

  font_families = { Const('default') : Name('DEFAULT'), Const('decorative') : Name('DECORATIVE'), Const('roman') : Name('ROMAN'), Const('script') : Name('SCRIPT'), Const('swiss') : Name('SWISS'), Const('modern') : Name('MODERN') }
  
  

• font_noise

  font_noise = [ 'pt', 'point', 'family' ]
  
  

• font_styles

  font_styles = { Const('italic') : Name('ITALIC') }
  
  

• font_weights

  font_weights = { Const('bold') : Name('BOLD') }
  
  

• gc_temp

  A dummy graphics context just used to calculate font metrics: gc_temp = GraphicsContext( ( 1, 1 ) )

  gc_temp = font_metrics_provider()
  
  

• half_pixel_bounds_inset

  Used to offset positions by half a pixel and bounding width/height by 1. TODO: Resolve this in a more intelligent manner.

  half_pixel_bounds_inset = (0.5, 0.5, -Const(1.0), -Const(1.0))
  
  

• HCENTER

  HCENTER = 2
  
  

• LEFT

  LEFT = 4
  
  

• RIGHT

  RIGHT = 1
  
  

• SHADOWED

  SHADOWED = 3
  
  

• TOP

  Positions:

  TOP = 32
  
  

• TOP_LEFT

  TOP_LEFT = (TOP + LEFT)
  
  

• TOP_RIGHT

  TOP_RIGHT = (TOP + RIGHT)
  
  

• VCENTER

  VCENTER = 16
  
  

Classes

• IDroppedOnHandler - Interface for draggable objects that handle the 'dropped_on' event

Function summary

• add_rectangles(rectangle1, rectangle2)
• bounding_box(components)
• bounding_coordinates(coordinates_list)
• bounds_to_coordinates(bounds)
• coordinates_to_bounds(coordinates)
• coordinates_to_size(coordinates)
• disjoint_intersect_coordinates(coordinates_list, coordinates)
• disjoint_union_coordinates(coordinates_list, coordinates)
• does_disjoint_intersect_coordinates(coordinates_list, coordinates)
• filled_rectangle(gc, position, bounds, bg_color = color_table['white'], border_color = color_table['black'], border_size = 1.0)
• gc_image_for(name, path = None)
• intersect_bounds(bounds1, bounds2)
• intersect_coordinates(coordinates1, coordinates2)
• send_event_to(components, event_name, event)
• str_to_font(object, name, value)
• subclasses_of(klass)
• union_bounds(bounds1, bounds2)
• union_coordinates(coordinates1, coordinates2)
• xy_in_bounds(x, y, bounds)

Functions

• add_rectangles(rectangle1, rectangle2)

  Add two bounds or coordinate rectangles

• bounding_box(components)

  Compute the bounding box for a set of components

• bounding_coordinates(coordinates_list)

  Return the bounding rectangle for a list of rectangles

• bounds_to_coordinates(bounds)

  Convert a bounds rectangle to a coordinate rectangle

• coordinates_to_bounds(coordinates)

  Convert a coordinates rectangle to a bounds rectangle

• coordinates_to_size(coordinates)

  Convert a coordinates rectangle to a size tuple

• disjoint_intersect_coordinates(coordinates_list, coordinates)

  Return the disjoint intersection of an already disjoint list of rectangles and a new rectangle:

  Note: The 'infinite' area rectangle is indicated by 'None'. The coordinates

  list may be empty.

• disjoint_union_coordinates(coordinates_list, coordinates)

  Return the disjoint union of an already disjoint list of rectangles and a new rectangle:

  Note: The 'infinite' area rectangle is indicated by 'None'. The coordinates

  list may be empty.

• does_disjoint_intersect_coordinates(coordinates_list, coordinates)

  Return whether a rectangle intersects a disjoint set of rectangles anywhere

• filled_rectangle(gc, position, bounds, bg_color = color_table['white'], border_color = color_table['black'], border_size = 1.0)

  Draws a filled rectangle with border.

• gc_image_for(name, path = None)

  Convert an image file name to a cached Kiva gc containing the image

• intersect_bounds(bounds1, bounds2)

  Compute the intersection of two bounds rectangles

• intersect_coordinates(coordinates1, coordinates2)

  Compute the intersection of two coordinate based rectangles

• send_event_to(components, event_name, event)

  Send an event to a specified set of components until it is 'handled'

• str_to_font(object, name, value)

  Converts a (somewhat) free-form string into a valid Font object.

• subclasses_of(klass)

  Generate all of the classes (and subclasses) for a specified class

• union_bounds(bounds1, bounds2)

  Compute the union of two bounds rectangles

• union_coordinates(coordinates1, coordinates2)

  Compute the union of two coordinate based rectangles

• xy_in_bounds(x, y, bounds)

  Test whether a specified (x,y) point is in a specified bounds

Imported Names

© Copyright 2002-2008 Enthought, Inc.