Inherits from
- HasPrivateTraits: enthought.traits.has_traits.HasPrivateTraits
Attributes
- auto_close
Close the parent window if the DockWindow becomes empty:
auto_close = false
- control
The wx.Window being used as the DockWindow:
control = Instance(wx.Window)
- handler
The handler used to determine how certain events should be processed:
handler = Any(dock_window_handler)
- handler_args
The 'extra' arguments to be passed to each handler call:
handler_args = Tuple
- id
The id used to identify this DockWindow:
id = Str
- sizer
Return the sizer associated with the control (i.e. window)
sizer = Property
- style
Default style for external objects dragged into the window:
style = DockStyle
- theme
The DockWindow graphical theme style information:
theme = Instance(DockWindowTheme, allow_none = False)
Inherited from base classes
Method summary
- __init__(self, parent, wid = -Const(1), pos = wx.DefaultPosition, size = wx.DefaultSize, style = wx.FULL_REPAINT_ON_RESIZE, **traits)
- add_to_menu(self, menu_item)
- add_to_toolbar(self, toolbar_item)
- can_add_to_menu(self, action)
- can_add_to_toolbar(self, action)
- close(self)
- dock_window_empty(self)
- feature_bar_popup(self, dock_control)
- min_max(self, dock_control)
- on_delete_layout(self, name)
- on_disable_all_features(self, action)
- on_edit(self, object = None)
- on_enable_all_features(self, action)
- on_hide(self)
- on_lock_layout(self)
- on_min_max(self)
- on_restore_layout(self, name)
- on_save_layout(self)
- on_show(self)
- on_switch_layout(self)
- on_toggle_feature(self, action)
- on_undock(self)
- perform(self, action_object)
- release_mouse(self)
- right_up(self, event)
- set_cursor(self, cursor = wx.CURSOR_ARROW)
- update_layout(self)
- wx_drag_any(self, x, y, data, drag_result)
- wx_drag_leave(self, data)
- wx_dropped_on(self, x, y, data, drag_result)
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, parent, wid = -Const(1), pos = wx.DefaultPosition, size = wx.DefaultSize, style = wx.FULL_REPAINT_ON_RESIZE, **traits)
- add_to_toolbar(self, toolbar_item)
Adds a tool bar item to the tool bar being constructed.
- can_add_to_toolbar(self, action)
Returns whether the toolbar action should be defined in the user interface.
- close(self)
Closes the dock window. In this case, all event handlers are unregistered. Other cleanup operations go here, but at the moment Linux (and other non-Windows platforms?) are less forgiving when things like event handlers arent unregistered.
- dock_window_empty(self)
Notifies the DockWindow that its contents are empty.
- feature_bar_popup(self, dock_control)
Pops up the feature bar for a specified DockControl.
- min_max(self, dock_control)
Minimizes/maximizes a specified DockControl.
- on_delete_layout(self, name)
Handles the user reqesting a specified layout to be deleted.
- on_disable_all_features(self, action)
Disables all features.
- on_edit(self, object = None)
Handles the user requesting to edit an item.
- on_enable_all_features(self, action)
Enables all features.
- on_hide(self)
Handles the user requesting an element to be hidden.
- on_lock_layout(self)
Handles the user requesting that the layout be locked/unlocked.
- on_min_max(self)
Handles the user asking for a DockControl to be maximized/restored.
- on_restore_layout(self, name)
Handles the user requesting a specified layout to be restored.
- on_save_layout(self)
Handles the user requesting that the layout be saved.
- on_show(self)
Handles the user requesting an element to be shown.
- on_switch_layout(self)
Handles the user requesting that the current layout be switched.
- on_toggle_feature(self, action)
Toggles the enabled/disabled state of the action's associated feature.
- on_undock(self)
Handles the user requesting an element to be undocked.
- perform(self, action_object)
Performs the action described by a specified Action object.
- release_mouse(self)
Releases ownership of the mouse capture.
- right_up(self, event)
Handles the right mouse button being released.
- set_cursor(self, cursor = wx.CURSOR_ARROW)
Sets the cursor to a specified cursor shape.
- update_layout(self)
Updates the layout of the window.
- wx_drag_any(self, x, y, data, drag_result)
Handles a Python object being dragged over the control.
- wx_drag_leave(self, data)
Handles a dragged Python object leaving the window.
- wx_dropped_on(self, x, y, data, drag_result)
Handles a Python object being dropped on the window.