Inherits from
- HasPrivateTraits: enthought.traits.has_traits.HasPrivateTraits
Attributes
- activated
Event fired when the current list canvas item is activated:
activated = Event
- adapters
The list of optional delegated adapters:
adapters = List(IListCanvasAdapter, update = True)
- cache
Cache of attribute handlers:
cache = Any({ })
- can_clone
Can the current list canvas item be cloned?
can_clone = Bool(False)
- can_close
Can the current list canvas item be closed? The possible values are:
- True: Yes.
- False: No.
- Modified: The item has been modified. Prompt the user whether the item should be closed before closing it.
can_close = Enum(True, False, Modified)
- can_delete
Can the current list canvas item be deleted (i.e. is close allowed)?
can_delete = Bool(False)
- can_drag
Can the current list canvas item be dragged?
can_drag = Bool(False)
- can_drop
Can the current drag object be dropped on the current item (or on the canvas itself if the current item is an instance of ListCanvas)?
can_drop = Property
- can_minimize
Can the current list canvas item be minimized/restored?
can_minimize = Bool(True)
- can_move
Can the current list canvas item be moved?
can_move = Bool(True)
- can_resize
Can the current list canvas item be resized?
can_resize = Bool(True)
- clone
Specifies the clone of the current list canvas item:
clone = Any(Missing)
- closed
Event fired when the current list canvas item is closed:
closed = Event
- deactivated
Event fired when the current list canvas item is de-activated:
deactivated = Event
- debug
Specifies whether the list canvas item should be drawn in debug mode (lines showing the theme border, content and label regions are overdrawn on top of the theme):
debug = Bool(False)
- drag
Returns the draggable form of the current list canvas item (or None if the current item can not be dragged):
drag = Any(Missing)
- drop
The current item being dropped (if any):
drop = Instance(HasTraits)
- dropped
The item or list of items to be added to the canvas when the current drag object is dropped on the current item (or on the canvas itself of the current item is an instance of ListCanvas). A value of None means that no object should be added to the canvas:
dropped = Property
- item
The current list canvas item (an instance of ListCanvas means the entire canvas):
item = Instance(HasTraits)
- monitor
Specifies the 'ListCanvasItemMonitor' object used to monitor the current list canvas item:
monitor = Instance('ListCanvasItemMonitor')
- mutable_theme
Specifies whether the themes used by the list canvas item are mutable or not (i.e. whether the theme's contents are changeable or not):
mutable_theme = Bool(False)
- position
Specifies the initial position of the current canvas list item when it is added to the canvas. The value is a tuple of the form: (x,y), where x and y values have the following meaning:
- value <= 0
- Use the default coordinate.
- 0 < value <= 1
- Use the specified fraction of the corresponding width or height dimension as the coordinate value.
- value > 1
- Use int(value) as the actual x or y coordinate specified in pixels.
position = Tuple(Float, Float)
- size
Specifies the initial size to make the current canvas list item when it is added to the canvas. The value is a tuple of the form: (width,height), where the width and height values have the following meaning:
- value <= 0
- Use the default size.
- 0 < value <= 1
- Use the specified fraction of the corresponding width or height dimension.
- value > 1
- Use int(value) as the actual width or height specified in pixels.
size = Tuple(Float, Float)
- status
Specifies the current message to display on the list canvas status line:
status = Str
- theme_active
The default theme to use for the current active list canvas item:
theme_active = ATheme(Theme('default_active', label = (13, 13, 10, 5), content = (0, 0)))
- theme_hover
The default theme to use while the pointer hovers over the current inactive list canvas item (if None is returned, the value of theme_inactive is used):
theme_hover = ATheme(Theme('default_hover', label = (13, 13, 10, 5), content = (0, 0)))
- theme_inactive
The default theme to use for the current inactive list canvas item (if None is returned, the value of theme_active is used):
theme_inactive = ATheme(Theme('default_inactive', label = (13, 13, 10, 5), content = (0, 0)))
- title
The title to use for the current list canvas item:
title = Property
- tooltip
Specifies the tooltip to display for the current list canvas item:
tooltip = Str
- unique_id
The unique id of the current list canvas item:
unique_id = Str
- view
Specifies the Traits UI View to use for the current canvas list item when it is added to the canvas:
view = AView
- view_model
Specifies the view model used to represent the current canvas list item when it is added to the canvas:
view_model = Instance(HasTraits)
Inherited from base classes
Method summary
- get_can_clone(self, item)
- get_can_close(self, item)
- get_can_delete(self, item)
- get_can_drag(self, item)
- get_can_drop(self, item, drop)
- get_can_minimize(self, item)
- get_can_move(self, item)
- get_can_resize(self, item)
- get_clone(self, item)
- get_debug(self, item)
- get_drag(self, item)
- get_dropped(self, item, drop)
- get_monitor(self, item)
- get_mutable_theme(self, item)
- get_position(self, item)
- get_size(self, item)
- get_theme_active(self, item)
- get_theme_hover(self, item)
- get_theme_inactive(self, item)
- get_title(self, item)
- get_tooltip(self, item)
- get_unique_id(self, item)
- get_view(self, item)
- get_view_model(self, item)
- set_activated(self, item)
- set_closed(self, item)
- set_deactivated(self, item)
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
- get_can_clone(self, item)
Returns whether or not the specified item can be cloned on the canvas.
- get_can_close(self, item)
Returns whether or not the specified item can be closed on the canvas.
- get_can_delete(self, item)
Returns whether or not the specified item can be deleted from the canvas.
- get_can_drag(self, item)
Returns whether or not the specified item can be dragged.
- get_can_drop(self, item, drop)
Returns whether or not the specified droppable object can be dropped on the specified item.
- get_can_minimize(self, item)
Returns whether or not the specified item can be minimized/restored on the canvas.
- get_can_move(self, item)
Returns whether or not the specified item can be moved on the canvas.
- get_can_resize(self, item)
Returns whether or not the specified item can be resized on the canvas.
- get_clone(self, item)
Returns the clone of the specified item.
- get_debug(self, item)
Specifies whether the list canvas item should be drawn in debug mode (lines showing the theme border, content and label regions are overdrawn on top of the theme).
- get_drag(self, item)
Returns the draggable form of the specified item.
- get_dropped(self, item, drop)
Returns the item (or list of items) to be added to the canvas when the specified droppable object is dropped on the specified item (or canvas).
- get_monitor(self, item)
Returns the 'ListCanvasItemMonitor' object used to monitor the specified item when it is added to the canvas.
- get_mutable_theme(self, item)
Returns whether or not the themes used by the list canvas item are mutable or not (i.e. whether the theme's contents are changeable or not).
- get_position(self, item)
Returns the position to use for the view of the specified item when it is added to the canvas.
- get_size(self, item)
Returns the size to use for the view of the specified item when it is added to the canvas.
- get_theme_active(self, item)
Returns the theme to use for the specified item when it is active.
- get_theme_hover(self, item)
Returns the theme to use for the specified item when it is inactive and the mouse pointer is hovering over it.
- get_theme_inactive(self, item)
Returns the theme to use for the specified item when it is inactive.
- get_title(self, item)
Returns the title to use for the specified item.
- get_tooltip(self, item)
Returns the tooltip to display for the specified item when the mouse pointer is over its view on the canvas.
- get_unique_id(self, item)
Returns the unique id for the specified item.
- get_view(self, item)
Returns the view to use for the specified item when it is added to the canvas.
- get_view_model(self, item)
Returns the view model to use for the specified item when it is added to the canvas.
- set_activated(self, item)
Notifies that the specified item has been activated on the canvas.
- set_closed(self, item)
Notifies that the specified item has been closed on the canvas.
- set_deactivated(self, item)
Notifies that the specified item has been deactivated on the canvas.