Inherits from
- DockItem: enthought.pyface.dock.dock_sizer.DockItem
Attributes
- activated
Event fired when the control's notebook tab is activated by the user:
activated = Event
- closeable
Can the control be closed?
closeable = Bool(False)
- control
The control this object describes:
control = Instance(wx.Window, allow_none = True)
- dock_controls
List of all other DockControl's in the same DockWindow:
dock_controls = Property
- dockable
(Optional) object that allows the control to be docked with a different DockWindow:
dockable = Instance(IDockable, allow_none = True)
- export
Category of control when it is dragged out of the DockWindow:
export = Str
- feature_changed
A feature associated with the DockControl has been changed:
feature_changed = Event
- id
The id of this control:
id = Str
- image
The image to display for this control:
image = Instance(ImageResource, allow_none = True)
- locked
Is the control's drag bar locked?
locked = Bool(False)
- name
The UI name of this control:
name = Str
- num_features
The number of global DockWindowFeature's that were available the last the time the feature set was checked:
num_features = Int
- object
The object (if any) associated with this control:
object = Property
- on_close
Function to call when a DockControl is requesting to be closed:
on_close = Callable
- resizable
Can the control be resized?
resizable = Bool(True)
- style
Style of drag bar/tab:
style = DockStyle
- user_name
Has the user set the name of the control?
user_name = Bool(False)
- user_style
Has the user set the style for this control:
user_style = Bool(False)
- visible
Is the control visible?
visible = Bool(True)
Inherited from base classes
Method summary
- activate(self, layout = True)
- calc_min(self, use_size = False)
- check_features(self)
- close(self, layout = True, force = False)
- draw(self, dc)
- dump(self, indent)
- get_controls(self, visible_only = True)
- get_image(self)
- get_structure(self)
- object_at(self, x, y)
- recalc_sizes(self, x, y, dx, dy)
- reset_features(self)
- reset_tab(self)
- set_name(self, name, layout = True)
- set_visibility(self, visible)
- show(self, visible = True, layout = True)
- 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)
- 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)
- 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)
- get_cursor(self, event)
- 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)
- mouse_down(self, event)
- mouse_move(self, event)
- mouse_up(self, event)
- 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, layout = True)
Activates a control (i.e. makes it the active page within its containing notebook).
- calc_min(self, use_size = False)
Calculates the minimum size of the control.
- check_features(self)
Checks to make sure that all applicable DockWindowFeatures have been applied.
- close(self, layout = True, force = False)
Closes the control.
- draw(self, dc)
Draws the contents of the control.
- dump(self, indent)
Prints the contents of the control.
- get_controls(self, visible_only = True)
Returns all DockControl objects contained in the control.
- get_image(self)
Gets the image (if any) associated with the control.
- get_structure(self)
Returns a copy of the control 'structure', minus the actual content.
- 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.
- reset_features(self)
Resets all currently defined features.
- reset_tab(self)
Resets the state of the tab.
- set_name(self, name, layout = True)
Sets a new name for the control.
- set_visibility(self, visible)
Sets the visibility of the control.
- show(self, visible = True, layout = True)
Hides or shows the control.
- toggle_lock(self)
Toggles the 'lock' status of the control.