API Reference for Enthought Tool Suite 2.7.1

Variables

• BGColor

  Normal background color:

  BGColor = None
  
  

• BGColor

  Initialize the various colors:

  BGColor = color_tuple_for(wx.SYS_COLOUR_BTNFACE)
  
  

• 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
  
  

• DockBarSize

  Size of a docking marker bar:

  DockBarSize = 6
  
  

• DockColor

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

  DockColor = (32, 255, 255)
  
  

• 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)
  
  

• DragDarkColor

  DragDarkColor = (172, 168, 153)
  
  

• DragDarkColor

  DragDarkColor = color_tuple_for(wx.SYS_COLOUR_BTNSHADOW)
  
  

• DragLightColor

  Colors used to draw a grab bar:

  DragLightColor = (255, 255, 255)
  
  

• DragLightColor

  DragLightColor = color_tuple_for(wx.SYS_COLOUR_WINDOW)
  
  

• 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)
  
  

• MarkColor

  Color used to mark the DockWindow boundary while dragging:

  MarkColor = (255, 255, 0)
  
  

• MaxTabLength

  Maximum allowed length of a tab label:

  MaxTabLength = 30
  
  

• NBBGColor

  Colors used to draw a notebook:

  NBBGColor = (252, 252, 254)
  
  

• NBBGColor

  NBBGColor = color_tuple_for(wx.SYS_COLOUR_MENU)
  
  

• NBBGTabAColor

  NBBGTabAColor = (252, 252, 254)
  
  

• NBBGTabAColor

  NBBGTabAColor = color_tuple_for(wx.SYS_COLOUR_MENU)
  
  

• NBBGTabIColor

  NBBGTabIColor = (246, 246, 243)
  
  

• NBBGTabIColor

  NBBGTabIColor = color_tuple_for(wx.SYS_COLOUR_MENU)
  
  

• NBBGTabXColor

  NBBGTabXColor = (255, 199, 60)
  
  

• NBEdgeColor

  NBEdgeColor = (145, 155, 156)
  
  

• NBEdgeColor

  NBEdgeColor = color_tuple_for(wx.SYS_COLOUR_BTNSHADOW)
  
  

• NBEdgeTabAColor

  NBEdgeTabAColor = (145, 155, 156)
  
  

• NBEdgeTabIColor

  NBEdgeTabIColor = (145, 155, 156)
  
  

• NBEdgeTabXColor

  NBEdgeTabXColor = (230, 139, 44)
  
  

• NBMarginBottom

  NBMarginBottom = 9
  
  

• NBMarginLeft

  Notebook margin and padding sizes:

  NBMarginLeft = 7
  
  

• NBMarginRight

  NBMarginRight = 9
  
  

• NBMarginTop

  NBMarginTop = 3
  
  

• NBPadding

  NBPadding = 4
  
  

• NBShadow1Color

  NBShadow1Color = (208, 206, 191)
  
  

• NBShadow1Color

  NBShadow1Color = color_tuple_for(wx.SYS_COLOUR_BTNSHADOW)
  
  

• NBShadow2Color

  NBShadow2Color = (227, 224, 208)
  
  

• NBShadow2Color

  NBShadow2Color = color_tuple_for(wx.SYS_COLOUR_3DLIGHT)
  
  

• 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)
  
  

• 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
  
  

• SplitterSizeH

  Size of a splitter bar:

  SplitterSizeH = 9
  
  

• SplitterSizeV

  SplitterSizeV = 12
  
  

• standard_font

  Standard font used by the DockWindow:

  standard_font = None
  
  

• TabActive

  TabActive = 1
  
  

• TabHeight

  Height of a notebook tab (in pixels):

  TabHeight = 26
  
  

• TabHover

  TabHover = 2
  
  

• TabInactive

  Tab drawing states:

  TabInactive = 0
  
  

• TabMargin

  Width of a notebook tab's margin (in pixels):

  TabMargin = 8
  
  

• 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)
• color_tuple_for(id)
• set_standard_font(dc)

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.

• color_tuple_for(id)

  Returns an (R, G, B) tuple for a specified wxPython system colour.

• set_standard_font(dc)

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

Imported Names

Copyright © 2002-2008 Enthought, Inc.