Inherits from
- HasPrivateTraits: enthought.traits.has_traits.HasPrivateTraits
Attributes
- active_features
Current active set of features:
active_features = Property
- bounds
Bounds of the item:
bounds = Bounds
- drag_bounds
Bounds of the item's drag bar or tab:
drag_bounds = Bounds
- drop_features
The list of drag data compatible drop features for this item:
drop_features = List
- feature_mode
The current feature mode:
feature_mode = Enum(FEATURE_NONE, FEATURE_NORMAL, FEATURE_CHANGED, FEATURE_DROP, FEATURE_VISIBLE, FEATURE_DROP_VISIBLE, FEATURE_DISABLED, FEATURE_PRE_NORMAL)
- feature_popup_position
The position where the feature popup should appear:
feature_popup_position = Property
- features
The list of features for this item:
features = List
- height
Current height of the item:
height = Int(-Const(1))
- owner
The DockWindow that owns this item:
owner = Property(depends_on = 'parent')
- parent
The parent of this item:
parent = Any
- tab_name
The tab displayable version of the control's UI name:
tab_name = Property(depends_on = 'name')
- tab_state
The current tab state:
tab_state = Any
- tab_theme
The theme for the current tab state:
tab_theme = Property
- tab_width
Width of the item's tab:
tab_width = Property(depends_on = 'control, tab_state, tab_name')
- theme
The DockWindowTheme for this item's DockWindow:
theme = Property
- width
Current width of the item:
width = Int(-Const(1))
Inherited from base classes
Method summary
- __init__(self, **kw)
- begin_draw(self, dc, ox = 0, oy = 0)
- dock_info_at(self, x, y, tdx, is_control)
- draw_fixed(self, dc)
- draw_horizontal(self, dc)
- draw_tab(self, dc, state)
- draw_vertical(self, dc)
- end_draw(self, dc)
- feature_activate(self, event, drag_object = Undefined)
- feature_bar_closed(self)
- fill_bg_color(self, dc, x, y, dx, dy)
- get_cursor(self, event)
- hover_enter(self, event)
- hover_exit(self, event)
- is_at(self, x, y, bounds = None)
- is_in(self, event, x, y, dx, dy)
- mark_bounds(self, begin)
- mouse_down(self, event)
- mouse_move(self, event)
- mouse_up(self, event)
- post_drag(self, tag = 0)
- post_drag_all(self)
- pre_drag(self, object, tag = 0)
- pre_drag_all(self, object)
- reset_feature_popup(self)
- set_drag_bounds(self, x, y, dx, dy)
- set_feature_mode(self, changed = True)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __prefix_trait__(self, name, is_set)
- __reduce_ex__(self, protocol)
- __setstate__(self, state, trait_change_notify = True)
- add_class_trait(cls, name, *trait)
- add_trait(self, name, *trait)
- add_trait_category(cls, category)
- add_trait_listener(self, object, prefix = '')
- all_trait_names(self)
- base_trait(self, name)
- class_default_traits_view(cls)
- class_editable_traits(cls)
- class_trait_names(cls, **metadata)
- class_trait_view(cls, name = None, view_element = None)
- class_trait_view_elements(cls)
- class_traits(cls, **metadata)
- clone_traits(self, traits = None, memo = None, copy = None, **metadata)
- configure_traits(self, filename = None, view = None, kind = None, edit = True, context = None, handler = None, id = '', scrollable = None, **args)
- copy_traits(self, other, traits = None, memo = None, copy = None, **metadata)
- copyable_trait_names(self, **metadata)
- default_traits_view(self)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- has_traits_interface(self, *interfaces)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_traits(self, traits = None, **metadata)
- set_trait_dispatch_handler(cls, name, klass, override = False)
- sync_trait(self, trait_name, object, alias = None, mutual = True, remove = False)
- trait(self, name, force = False, copy = False)
- trait_context(self)
- trait_get(self, *names, **metadata)
- trait_monitor(cls, handler, remove = False)
- trait_names(self, **metadata)
- trait_set(self, trait_change_notify = True, **traits)
- trait_setq(self, **traits)
- trait_subclasses(cls, all = False)
- trait_view(self, name = None, view_element = None)
- trait_view_elements(self)
- trait_views(self, klass = None)
- traits(self, **metadata)
- validate_trait(self, name, value)
Methods
- __init__(self, **kw)
- begin_draw(self, dc, ox = 0, oy = 0)
Prepares for drawing into a device context.
- dock_info_at(self, x, y, tdx, is_control)
Gets the DockInfo object for a specified window position.
- draw_fixed(self, dc)
Draws a fixed drag bar.
- draw_horizontal(self, dc)
Draws a horizontal drag bar.
- draw_tab(self, dc, state)
- draw_vertical(self, dc)
Draws a vertical drag bar.
- end_draw(self, dc)
Terminates drawing into a device context.
- feature_activate(self, event, drag_object = Undefined)
- feature_bar_closed(self)
- fill_bg_color(self, dc, x, y, dx, dy)
Fills a specified region with the control's background color.
- get_cursor(self, event)
Gets the cursor to use when the mouse is over the item.
- hover_enter(self, event)
Handles the mouse hovering over the item.
- hover_exit(self, event)
Handles the mouse exiting from hovering over the item.
- is_at(self, x, y, bounds = None)
Returns whether or not the item is at a specified window position.
- is_in(self, event, x, y, dx, dy)
Returns whether or not an event is within a specified bounds.
- mark_bounds(self, begin)
Marks/Unmarks the bounds of the bounding DockWindow.
- mouse_down(self, event)
Handles the left mouse button being pressed.
- mouse_move(self, event)
Handles the mouse moving while the left mouse button is pressed.
- mouse_up(self, event)
Handles the left mouse button being released.
- post_drag(self, tag = 0)
Restore this DockControl after a drag operation is completed.
- post_drag_all(self)
Restore all DockControls in the associated DockWindow after a drag operation is completed.
- pre_drag(self, object, tag = 0)
Prepare this DockControl for being dragged over.
- pre_drag_all(self, object)
Prepare all DockControls in the associated DockWindow for being dragged over.
- reset_feature_popup(self)
- set_drag_bounds(self, x, y, dx, dy)
Sets the control's drag bounds.
- set_feature_mode(self, changed = True)