Inherits from
- Container: enthought.enable.container.Container
Attributes
- alternate_vsb
An alternate vertical scroll bar to control this Scrolled, instead of the default one that lives outside the scrolled region.
alternate_vsb = Instance(Component)
- always_show_sb
Should the scrollbars always be shown?
always_show_sb = Bool(False)
- auto_size
Override the default value of this inherited trait
auto_size = False
- bgcolor
The background color to use for filling in the padding area.
bgcolor = ColorTrait('white') - component
The component that we are viewing
component = Instance(Component)
- continuous_drag_update
Should the viewport update continuously as the scrollbar is dragged, or only when drag terminates (i.e. the user releases the mouse button)
continuous_drag_update = Bool(True)
- horiz_scrollbar
Should the horizontal scrollbar be shown?
horiz_scrollbar = Bool(True)
- inside_border_color
The inside border is a border drawn on the inner edge of the inside padding area to highlight the viewport.
inside_border_color = ColorTrait('black') - inside_border_width
inside_border_width = Int(0)
- inside_padding_width
Inside padding is a background drawn area between the edges or scrollbars and the scrolled area/left component.
inside_padding_width = Int(5)
- leftborder
The size of the left border space
leftborder = Float(0)
- leftcomponent
A component to lay out to the left of the viewport area (e.g. a depth scale track)
leftcomponent = Any
- mousewheel_scroll
Should the mouse wheel scroll the viewport?
mousewheel_scroll = Bool(True)
- vert_scrollbar
Should the vertical scrollbar be shown?
vert_scrollbar = Bool(True)
- viewport_component
The viewport onto our component
viewport_component = Instance(Viewport)
Inherited from base classes
- accepts_focus
- active_tool
- aspect_ratio
- auto_center
- auto_handle_event
- backbuffer_padding
- border_color
- border_dash
- border_visible
- border_width
- bounds
- classes
- container
- controller
- cursor_color
- cursor_style
- draw_layer
- draw_order
- draw_valid
- drawn_outer_bounds
- drawn_outer_position
- event_state
- fill_padding
- height
- hpadding
- id
- inset_border
- invisible_layout
- layout_needed
- on_trait_event
- outer_bounds
- outer_height
- outer_position
- outer_width
- outer_x
- outer_x2
- outer_y
- outer_y2
- overlay_border
- overlays
- padding
- padding_accepts_focus
- padding_bottom
- padding_left
- padding_right
- padding_top
- pointer
- position
- resizable
- set
- tools
- tooltip
- trait_added
- trait_modified
- underlays
- unified_draw
- use_backbuffer
- use_selection
- viewports
- visible
- vpadding
- width
- window
- wrappers
- x
- x2
- y
- y2
Method summary
- __getstate__(self)
- __init__(self, component, **traits)
- freeze_scroll_bounds(self)
- sb_height(self)
- sb_width(self)
- unfreeze_scroll_bounds(self)
- update_bounds(self)
- update_from_viewport(self)
Inherited from base classes
- __deepcopy__(self, memo)
- __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)
- as_coordinates(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)
- dispatch(self, event, suffix)
- do_layout(self, size = None, force = False)
- draw(self, gc, view_bounds = None, mode = 'default')
- draw_select_box(self, gc, position, bounds, width, dash, inset, color, bgcolor, marker_size)
- edit_traits(self, view = None, parent = None, kind = None, context = None, handler = None, id = '', scrollable = None, **args)
- editable_traits(self)
- get_absolute_coords(self, *coords)
- get_preferred_size(self)
- has_traits_interface(self, *interfaces)
- invalidate_and_redraw(self)
- invalidate_draw(self, damaged_regions = None, self_relative = False)
- is_in(self, x, y)
- 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 = '')
- request_redraw(self)
- reset_traits(self, traits = None, **metadata)
- set_outer_bounds(self, ndx, val)
- set_outer_position(self, ndx, val)
- 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
- __getstate__(self)
- __init__(self, component, **traits)
- freeze_scroll_bounds(self)
Prevents the scroll bounds on the scrollbar from updating until unfreeze_scroll_bounds() is called. This is useful on components with view-dependent bounds; when the user is interacting with the scrollbar or the viewport, this prevents the scrollbar from resizing underneath them.
- sb_height(self)
Returns the standard scroll bar height
- sb_width(self)
Returns the standard scroll bar width
- unfreeze_scroll_bounds(self)
Allows the scroll bounds to be updated by various trait changes. See freeze_scroll_bounds().
- update_bounds(self)
- update_from_viewport(self)
Repositions the scrollbars based on the current position/bounds of viewport_component.