API Reference for Enthought Tool Suite 3.0.1

Variables

• BGColor

  Normal background color:

  BGColor = None
  
  

• Bounds

  Bounds (i.e. x, y, dx, dy):

  Bounds = Tuple(Int, Int, Int, Int)
  
  

• CloseDragSize

  CloseDragSize = 7
  
  

• CloseTabSize

  Images sizes (in pixels):

  CloseTabSize = 10
  
  

• DOCK_BAR

  DOCK_BAR = 6
  
  

• DOCK_BOTTOM

  DOCK_BOTTOM = 1
  
  

• DOCK_EXPORT

  DOCK_EXPORT = 9
  
  

• DOCK_LEFT

  DOCK_LEFT = 2
  
  

• DOCK_NONE

  DOCK_NONE = 7
  
  

• DOCK_RIGHT

  DOCK_RIGHT = 3
  
  

• DOCK_SPLITTER

  DOCK_SPLITTER = 8
  
  

• DOCK_TAB

  DOCK_TAB = 4
  
  

• DOCK_TABADD

  DOCK_TABADD = 5
  
  

• DOCK_TOP

  Drop Info kinds:

  DOCK_TOP = 0
  
  

• DockColorBrush

  Color used to update the screen while showing a docking operation in progress:

  DockColorBrush = (255, 0, 0, 96)
  
  

• DockStyle

  Docking drag bar style:

  DockStyle = Enum('horizontal', 'vertical', 'tab', 'fixed')
  
  

• DragBarSize

  Size of a drag bar (in pixels):

  DragBarSize = 14
  
  

• DragColor

  Color used to update the screen while dragging a splitter bar:

  DragColor = (96, 96, 96)
  
  

• FEATURE_CHANGED

  FEATURE_CHANGED = 1
  
  

• FEATURE_DISABLED

  FEATURE_DISABLED = 3
  
  

• FEATURE_DROP

  FEATURE_DROP = 2
  
  

• FEATURE_DROP_VISIBLE

  FEATURE_DROP_VISIBLE = 5
  
  

• FEATURE_END_DROP

  FEATURE_END_DROP = (FEATURE_DROP, FEATURE_VISIBLE, FEATURE_DROP_VISIBLE)
  
  

• FEATURE_EXTERNAL_DRAG

  FEATURE_EXTERNAL_DRAG = 256
  
  

• FEATURE_NONE

  Feature modes:

  FEATURE_NONE = -Const(1)
  
  

• FEATURE_NORMAL

  FEATURE_NORMAL = 0
  
  

• FEATURE_PRE_NORMAL

  FEATURE_PRE_NORMAL = 6
  
  

• FEATURE_VISIBLE

  FEATURE_VISIBLE = 4
  
  

• FeatureBrushColor

  Feature overlay colors:

  FeatureBrushColor = (255, 255, 255)
  
  

• FeaturePenColor

  FeaturePenColor = (92, 92, 92)
  
  

• features

  The list of available DockWindowFeatures:

  features = [  ]
  
  

• FEATURES_VISIBLE

  FEATURES_VISIBLE = (FEATURE_VISIBLE, FEATURE_DROP_VISIBLE)
  
  

• is_mac

  is_mac = sys.platform== 'darwin'
  
  

• MaxTabLength

  Maximum allowed length of a tab label:

  MaxTabLength = 30
  
  

• no_clip

  Empty clipping area:

  no_clip = (0, 0, 0, 0)
  
  

• no_dock_info

  Create a reusable DockInfo indicating no information available:

  no_dock_info = DockInfo(kind = DOCK_NONE)
  
  

• NO_FEATURE_ICON

  Feature sets:

  NO_FEATURE_ICON = (FEATURE_NONE, FEATURE_DISABLED, FEATURE_VISIBLE, FEATURE_DROP_VISIBLE)
  
  

• NORMAL_FEATURES

  NORMAL_FEATURES = (FEATURE_NORMAL, FEATURE_DISABLED)
  
  

• NormalStates

  NormalStates = (TabInactive, TabActive)
  
  

• NotActiveStates

  NotActiveStates = (TabInactive, TabHover)
  
  

• SCROLL_LEFT

  Tab scrolling directions:

  SCROLL_LEFT = 1
  
  

• SCROLL_RIGHT

  SCROLL_RIGHT = 2
  
  

• SCROLL_TO

  SCROLL_TO = 3
  
  

• SequenceType

  Valid sequence types:

  SequenceType = (list, tuple)
  
  

• SPLIT_HBOTTOM

  SPLIT_HBOTTOM = 5
  
  

• SPLIT_HMIDDLE

  SPLIT_HMIDDLE = 4
  
  

• SPLIT_HTOP

  SPLIT_HTOP = 3
  
  

• SPLIT_VLEFT

  Splitter states:

  SPLIT_VLEFT = 0
  
  

• SPLIT_VMIDDLE

  SPLIT_VMIDDLE = 1
  
  

• SPLIT_VRIGHT

  SPLIT_VRIGHT = 2
  
  

• standard_font

  Standard font used by the DockWindow:

  standard_font = None
  
  

• TabActive

  TabActive = 1
  
  

• TabHover

  TabHover = 2
  
  

• TabInactive

  Tab drawing states:

  TabInactive = 0
  
  

• text_dy

  Standard font text height:

  text_dy = 13
  
  

• wx_26

  Define version dependent values:

  wx_26 = wx.__version__[:3== '2.6'
  
  

Traits

• DockImages

  Creates a singleton instance of the class:

  DockImages = DockImages()
  
  

Classes

• DockControl
• DockGroup
• DockImages
• DockInfo
• DockItem
• DockRegion
• DockSection
• DockSizer
• DockSplitter
• SetStructureHandler

Function summary

• add_feature(feature_class)
• clear_window(window)
• get_dc(window)
• set_standard_font(dc)
• top_level_window_for(control)

Functions

• add_feature(feature_class)

  Adds a new DockWindowFeature class to the list of available features.

• clear_window(window)

  Clears a window to the standard background color.

• get_dc(window)

  Gets a temporary device context for a specified window to draw in.

• set_standard_font(dc)

  Sets the standard font to use for a specified device context.

• top_level_window_for(control)

  Returns the top-level window for a specified control.

Imported Names

© Copyright 2002-2008 Enthought, Inc.