widget_int.py
183 lines
| 7.3 KiB
| text/x-python
|
PythonLexer
|
r17598 | """Int class. | ||
|
r14283 | |||
Represents an unbounded int using a widget. | ||||
""" | ||||
#----------------------------------------------------------------------------- | ||||
# Copyright (c) 2013, the IPython Development Team. | ||||
# | ||||
# Distributed under the terms of the Modified BSD License. | ||||
# | ||||
# The full license is in the file COPYING.txt, distributed with this software. | ||||
#----------------------------------------------------------------------------- | ||||
#----------------------------------------------------------------------------- | ||||
# Imports | ||||
#----------------------------------------------------------------------------- | ||||
|
r14540 | from .widget import DOMWidget | ||
|
r17729 | from IPython.utils.traitlets import Unicode, CInt, Bool, CaselessStrEnum, Tuple | ||
|
r17598 | from IPython.utils.warn import DeprecatedClass | ||
|
r14266 | |||
|
r14283 | #----------------------------------------------------------------------------- | ||
# Classes | ||||
#----------------------------------------------------------------------------- | ||||
|
r17598 | class _Int(DOMWidget): | ||
|
r17602 | """Base class used to create widgets that represent an int.""" | ||
|
r14603 | value = CInt(0, help="Int value", sync=True) | ||
|
r14588 | disabled = Bool(False, help="Enable or disable user changes", sync=True) | ||
description = Unicode(help="Description of the value this widget represents", sync=True) | ||||
|
r14670 | |||
|
r17598 | class _BoundedInt(_Int): | ||
|
r17602 | """Base class used to create widgets that represent a int that is bounded | ||
by a minium and maximum.""" | ||||
|
r14670 | step = CInt(1, help="Minimum step that the value can take (ignored by some views)", sync=True) | ||
max = CInt(100, help="Max value", sync=True) | ||||
min = CInt(0, help="Min value", sync=True) | ||||
def __init__(self, *pargs, **kwargs): | ||||
"""Constructor""" | ||||
DOMWidget.__init__(self, *pargs, **kwargs) | ||||
self.on_trait_change(self._validate, ['value', 'min', 'max']) | ||||
def _validate(self, name, old, new): | ||||
"""Validate value, max, min.""" | ||||
if self.min > new or new > self.max: | ||||
self.value = min(max(new, self.min), self.max) | ||||
|
r17598 | class IntText(_Int): | ||
|
r17602 | """Textbox widget that represents a int.""" | ||
|
r14701 | _view_name = Unicode('IntTextView', sync=True) | ||
|
r14670 | |||
|
r17598 | class BoundedIntText(_BoundedInt): | ||
|
r17602 | """Textbox widget that represents a int bounded by a minimum and maximum value.""" | ||
|
r14701 | _view_name = Unicode('IntTextView', sync=True) | ||
|
r14670 | |||
|
r17598 | class IntSlider(_BoundedInt): | ||
|
r17602 | """Slider widget that represents a int bounded by a minimum and maximum value.""" | ||
|
r14701 | _view_name = Unicode('IntSliderView', sync=True) | ||
|
r17729 | orientation = CaselessStrEnum(values=['horizontal', 'vertical'], | ||
default_value='horizontal', allow_none=False, | ||||
|
r14670 | help="Vertical or horizontal.", sync=True) | ||
|
r17703 | _range = Bool(False, help="Display a range selector", sync=True) | ||
|
r15159 | readout = Bool(True, help="Display the current value of the slider next to it.", sync=True) | ||
|
r17723 | slider_color = Unicode(sync=True) | ||
|
r14670 | |||
|
r17598 | class IntProgress(_BoundedInt): | ||
|
r17602 | """Progress bar that represents a int bounded by a minimum and maximum value.""" | ||
|
r14701 | _view_name = Unicode('ProgressView', sync=True) | ||
|
r17059 | |||
|
r17729 | bar_style = CaselessStrEnum( | ||
values=['success', 'info', 'warning', 'danger', ''], | ||||
default_value='', allow_none=True, sync=True, help="""Use a | ||||
predefined styling for the progess bar.""") | ||||
|
r17698 | class _IntRange(_Int): | ||
|
r17682 | value = Tuple(CInt, CInt, default_value=(0, 1), help="Tuple of (lower, upper) bounds", sync=True) | ||
lower = CInt(0, help="Lower bound", sync=False) | ||||
upper = CInt(1, help="Upper bound", sync=False) | ||||
def __init__(self, *pargs, **kwargs): | ||||
value_given = 'value' in kwargs | ||||
|
r17705 | lower_given = 'lower' in kwargs | ||
upper_given = 'upper' in kwargs | ||||
if value_given and (lower_given or upper_given): | ||||
raise ValueError("Cannot specify both 'value' and 'lower'/'upper' for range widget") | ||||
if lower_given != upper_given: | ||||
raise ValueError("Must specify both 'lower' and 'upper' for range widget") | ||||
|
r17682 | |||
DOMWidget.__init__(self, *pargs, **kwargs) | ||||
# ensure the traits match, preferring whichever (if any) was given in kwargs | ||||
if value_given: | ||||
self.lower, self.upper = self.value | ||||
else: | ||||
self.value = (self.lower, self.upper) | ||||
self.on_trait_change(self._validate, ['value', 'upper', 'lower']) | ||||
def _validate(self, name, old, new): | ||||
if name == 'value': | ||||
self.lower, self.upper = min(new), max(new) | ||||
elif name == 'lower': | ||||
self.value = (new, self.value[1]) | ||||
elif name == 'upper': | ||||
self.value = (self.value[0], new) | ||||
|
r17059 | |||
|
r17698 | class _BoundedIntRange(_IntRange): | ||
|
r17059 | step = CInt(1, help="Minimum step that the value can take (ignored by some views)", sync=True) | ||
max = CInt(100, help="Max value", sync=True) | ||||
min = CInt(0, help="Min value", sync=True) | ||||
def __init__(self, *pargs, **kwargs): | ||||
|
r17682 | any_value_given = 'value' in kwargs or 'upper' in kwargs or 'lower' in kwargs | ||
|
r17698 | _IntRange.__init__(self, *pargs, **kwargs) | ||
|
r17682 | |||
# ensure a minimal amount of sanity | ||||
if self.min > self.max: | ||||
raise ValueError("min must be <= max") | ||||
|
r17705 | if any_value_given: | ||
# if a value was given, clamp it within (min, max) | ||||
self._validate("value", None, self.value) | ||||
else: | ||||
# otherwise, set it to 25-75% to avoid the handles overlapping | ||||
|
r17591 | self.value = (0.75*self.min + 0.25*self.max, | ||
0.25*self.min + 0.75*self.max) | ||||
|
r17682 | # callback already set for 'value', 'lower', 'upper' | ||
self.on_trait_change(self._validate, ['min', 'max']) | ||||
|
r17059 | |||
def _validate(self, name, old, new): | ||||
|
r17682 | if name == "min": | ||
if new > self.max: | ||||
raise ValueError("setting min > max") | ||||
self.min = new | ||||
elif name == "max": | ||||
if new < self.min: | ||||
raise ValueError("setting max < min") | ||||
self.max = new | ||||
low, high = self.value | ||||
|
r17059 | if name == "value": | ||
|
r17682 | low, high = min(new), max(new) | ||
elif name == "upper": | ||||
if new < self.lower: | ||||
raise ValueError("setting upper < lower") | ||||
high = new | ||||
elif name == "lower": | ||||
if new > self.upper: | ||||
raise ValueError("setting lower > upper") | ||||
low = new | ||||
low = max(self.min, min(low, self.max)) | ||||
high = min(self.max, max(high, self.min)) | ||||
# determine the order in which we should update the | ||||
# lower, upper traits to avoid a temporary inverted overlap | ||||
lower_first = high < self.lower | ||||
self.value = (low, high) | ||||
if lower_first: | ||||
self.lower = low | ||||
self.upper = high | ||||
|
r17127 | else: | ||
|
r17682 | self.upper = high | ||
self.lower = low | ||||
|
r17059 | |||
|
r17698 | class IntRangeSlider(_BoundedIntRange): | ||
|
r17059 | _view_name = Unicode('IntSliderView', sync=True) | ||
|
r17731 | orientation = CaselessStrEnum(values=['horizontal', 'vertical'], | ||
default_value='horizontal', allow_none=False, | ||||
|
r17059 | help="Vertical or horizontal.", sync=True) | ||
|
r17703 | _range = Bool(True, help="Display a range selector", sync=True) | ||
|
r17059 | readout = Bool(True, help="Display the current value of the slider next to it.", sync=True) | ||
|
r17947 | slider_color = Unicode(sync=True) | ||
|
r17602 | |||
# Remove in IPython 4.0 | ||||
|
r17598 | IntTextWidget = DeprecatedClass(IntText, 'IntTextWidget') | ||
BoundedIntTextWidget = DeprecatedClass(BoundedIntText, 'BoundedIntTextWidget') | ||||
IntSliderWidget = DeprecatedClass(IntSlider, 'IntSliderWidget') | ||||
IntProgressWidget = DeprecatedClass(IntProgress, 'IntProgressWidget') | ||||