Inherits from
- DockGroup: enthought.pyface.dock.dock_sizer.DockGroup
Attributes
- active
Index of the currently active 'contents' DockControl:
active = Int
- is_notebook
Is the region drawn as a notebook or not:
is_notebook = Property
- left_tab
The index of the current leftmost visible tab:
left_tab = Int
- max_tab
The current maximum value for 'left_tab':
max_tab = Int
- modified
Contents have been modified property:
modified = Property
- tab_scroll_index
Index of the tab scroll image to use (-1 = No tab scroll):
tab_scroll_index = Int(-Const(1))
Inherited from base classes
Method summary
- activate(self, control, layout = True)
- add(self, control, before = None, after = None, activate = True)
- calc_min(self, use_size = False)
- dock_info_at(self, x, y, tdx, is_control)
- draw(self, dc)
- dump(self, indent)
- get_structure(self)
- make_active_tab_visible(self)
- mouse_down(self, event)
- mouse_move(self, event)
- mouse_up(self, event)
- object_at(self, x, y)
- recalc_sizes(self, x, y, dx, dy)
- remove(self, item)
- scroll(self, type, left_tab = 0)
- set_visibility(self, visible)
- show_hide(self, control)
- tab_clicked(self, control)
- toggle_lock(self)
Inherited from base classes
- __deepcopy__(self, memo)
- __getstate__(self)
- __init__(self, **kw)
- __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)
- begin_draw(self, dc, ox = 0, oy = 0)
- 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)
- draw_fixed(self, dc)
- draw_horizontal(self, dc)
- draw_tab(self, dc, state)
- draw_vertical(self, dc)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- end_draw(self, dc)
- feature_activate(self, event, drag_object = Undefined)
- feature_bar_closed(self)
- fill_bg_color(self, dc, x, y, dx, dy)
- has_traits_interface(self, *interfaces)
- 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)
- on_trait_change(self, handler, name = None, remove = False, dispatch = 'same', priority = False, deferred = False)
- post_drag(self, tag = 0)
- post_drag_all(self)
- pre_drag(self, object, tag = 0)
- pre_drag_all(self, object)
- print_traits(self, show_help = False, **metadata)
- remove_trait(self, name)
- remove_trait_listener(self, object, prefix = '')
- reset_feature_popup(self)
- reset_traits(self, traits = None, **metadata)
- set_drag_bounds(self, x, y, dx, dy)
- set_feature_mode(self, changed = True)
- 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
- activate(self, control, layout = True)
Activates a specified control (i.e. makes it the current notebook tab).
- add(self, control, before = None, after = None, activate = True)
Adds a new control before a specified control.
- calc_min(self, use_size = False)
Calculates the minimum size of the region.
- dock_info_at(self, x, y, tdx, is_control)
Gets the DockInfo object for a specified window position.
- draw(self, dc)
Draws the contents of the region.
- dump(self, indent)
Prints the contents of the region.
- get_structure(self)
Returns a copy of the region 'structure', minus the actual content.
- make_active_tab_visible(self)
Makes sure the active control's tab is completely visible (if possible).
- 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.
- object_at(self, x, y)
Returns the object at a specified window position.
- recalc_sizes(self, x, y, dx, dy)
Layout the contents of the region based on the specified bounds.
- remove(self, item)
Removes a specified item.
- scroll(self, type, left_tab = 0)
Handles the user clicking an active scroll button.
- set_visibility(self, visible)
Sets the visibility of the region.
- show_hide(self, control)
Handles a contained DockControl item being hidden or shown.
- tab_clicked(self, control)
Handles a contained notebook tab being clicked.
- toggle_lock(self)
Toggles the 'lock' status of every control in the group.