Skip to content

AbstractSliderMixin

Base classes

Name Children Inherits
WidgetMixin
prettyqt.widgets.widget

Subclasses

Class Module Description
AbstractSlider prettyqt.widgets.abstractslider
ScrollBarMixin prettyqt.widgets.scrollbar
Slider prettyqt.widgets.slider
Dial prettyqt.widgets.dial

â‹” Inheritance diagram

graph TD
  1473293701904["widgets.AbstractSliderMixin"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473293688240 --> 1473293701904
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480

🛈 DocStrings

Bases: WidgetMixin

Source code in prettyqt\widgets\abstractslider.py 
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
class AbstractSliderMixin(widgets.WidgetMixin):
    value_changed = core.Signal(int)

    def _get_map(self):
        maps = super()._get_map()
        maps |= {
            "orientation": constants.ORIENTATION,
        }
        return maps

    def on_value_change(self):
        self.value_changed.emit(self.value())

    def is_horizontal(self) -> bool:
        """Check if silder is horizontal.

        Returns:
            True if horizontal, else False
        """
        return self.orientation() == constants.HORIZONTAL

    def is_vertical(self) -> bool:
        """Check if silder is vertical.

        Returns:
            True if vertical, else False
        """
        return self.orientation() == constants.VERTICAL

    def set_horizontal(self):
        """Set slider orientation to horizontal."""
        self.setOrientation(constants.HORIZONTAL)

    def set_vertical(self):
        """Set slider orientation to vertical."""
        self.setOrientation(constants.VERTICAL)

    def set_orientation(
        self, orientation: constants.OrientationStr | constants.Orientation
    ):
        """Set the orientation of the slider.

        Args:
            orientation: orientation for the slider
        """
        self.setOrientation(constants.ORIENTATION.get_enum_value(orientation))

    def get_orientation(self) -> constants.OrientationStr:
        """Return current orientation.

        Returns:
            orientation
        """
        return constants.ORIENTATION.inverse[self.orientation()]

    def scroll_to_min(self):
        """Scroll to the minimum value of the slider."""
        self.setValue(self.minimum())

    def scroll_to_max(self):
        """Scroll to the maximum value of the slider."""
        self.setValue(self.maximum())

    def set_range(self, min_val: int, max_val: int):
        self.setRange(min_val, max_val)

    def set_step_size(self, step_size: int):
        self.setSingleStep(step_size)

    def set_repeat_action(
        self,
        action: SliderActionStr | widgets.QAbstractSlider.SliderAction,
        threshold: int = 500,
        repeat_time: int = 50,
    ):
        """Set the repeat action.

        Args:
            action: repeat action
            threshold: initial delay in ms
            repeat_time: repeat time in ms
        """
        self.setRepeatAction(SLIDER_ACTION.get_enum_value(action), threshold, repeat_time)

    def get_repeat_action(self) -> SliderActionStr:
        """Get current repeat action.

        Returns:
            current repeat action
        """
        return SLIDER_ACTION.inverse[self.repeatAction()]

    def trigger_action(
        self, action: SliderActionStr | widgets.QAbstractSlider.SliderAction
    ):
        """Trigger slider action."""
        self.triggerAction(SLIDER_ACTION.get_enum_value(action))

    def get_value(self) -> int:
        return self.value()

    def set_value(self, value: int):
        self.setValue(value)

    def on_scrollbar_range_changed(self, minval: int, maxval: int):
        if self.value() >= self.maximum() - 1:
            self.setValue(maxval)

    def set_auto_scroll_to_end(self, scroll: bool = True):
        """Set to always scroll to the end when range changes."""
        if scroll:
            self.rangeChanged.connect(self.on_scrollbar_range_changed)
        else:
            self.rangeChanged.disconnect(self.on_scrollbar_range_changed)

get_orientation() -> constants.OrientationStr

Return current orientation.

Source code in prettyqt\widgets\abstractslider.py 
79
80
81
82
83
84
85
def get_orientation(self) -> constants.OrientationStr:
    """Return current orientation.

    Returns:
        orientation
    """
    return constants.ORIENTATION.inverse[self.orientation()]

get_repeat_action() -> SliderActionStr

Get current repeat action.

Source code in prettyqt\widgets\abstractslider.py 
116
117
118
119
120
121
122
def get_repeat_action(self) -> SliderActionStr:
    """Get current repeat action.

    Returns:
        current repeat action
    """
    return SLIDER_ACTION.inverse[self.repeatAction()]

is_horizontal() -> bool

Check if silder is horizontal.

Source code in prettyqt\widgets\abstractslider.py 
45
46
47
48
49
50
51
def is_horizontal(self) -> bool:
    """Check if silder is horizontal.

    Returns:
        True if horizontal, else False
    """
    return self.orientation() == constants.HORIZONTAL

is_vertical() -> bool

Check if silder is vertical.

Source code in prettyqt\widgets\abstractslider.py 
53
54
55
56
57
58
59
def is_vertical(self) -> bool:
    """Check if silder is vertical.

    Returns:
        True if vertical, else False
    """
    return self.orientation() == constants.VERTICAL

scroll_to_max()

Scroll to the maximum value of the slider.

Source code in prettyqt\widgets\abstractslider.py 
91
92
93
def scroll_to_max(self):
    """Scroll to the maximum value of the slider."""
    self.setValue(self.maximum())

scroll_to_min()

Scroll to the minimum value of the slider.

Source code in prettyqt\widgets\abstractslider.py 
87
88
89
def scroll_to_min(self):
    """Scroll to the minimum value of the slider."""
    self.setValue(self.minimum())

set_auto_scroll_to_end(scroll: bool = True)

Set to always scroll to the end when range changes.

Source code in prettyqt\widgets\abstractslider.py 
140
141
142
143
144
145
def set_auto_scroll_to_end(self, scroll: bool = True):
    """Set to always scroll to the end when range changes."""
    if scroll:
        self.rangeChanged.connect(self.on_scrollbar_range_changed)
    else:
        self.rangeChanged.disconnect(self.on_scrollbar_range_changed)

set_horizontal()

Set slider orientation to horizontal.

Source code in prettyqt\widgets\abstractslider.py 
61
62
63
def set_horizontal(self):
    """Set slider orientation to horizontal."""
    self.setOrientation(constants.HORIZONTAL)

set_orientation(orientation: constants.OrientationStr | constants.Orientation)

Set the orientation of the slider.

Parameters:

Name Type Description Default
orientation OrientationStr | Orientation

orientation for the slider

 required
Source code in prettyqt\widgets\abstractslider.py 
69
70
71
72
73
74
75
76
77
def set_orientation(
    self, orientation: constants.OrientationStr | constants.Orientation
):
    """Set the orientation of the slider.

    Args:
        orientation: orientation for the slider
    """
    self.setOrientation(constants.ORIENTATION.get_enum_value(orientation))

set_repeat_action(action: SliderActionStr | widgets.QAbstractSlider.SliderAction, threshold: int = 500, repeat_time: int = 50)

Set the repeat action.

Parameters:

Name Type Description Default
action SliderActionStr | SliderAction

repeat action

 required
threshold int

initial delay in ms

 500
repeat_time int

repeat time in ms

 50
Source code in prettyqt\widgets\abstractslider.py 
101
102
103
104
105
106
107
108
109
110
111
112
113
114
def set_repeat_action(
    self,
    action: SliderActionStr | widgets.QAbstractSlider.SliderAction,
    threshold: int = 500,
    repeat_time: int = 50,
):
    """Set the repeat action.

    Args:
        action: repeat action
        threshold: initial delay in ms
        repeat_time: repeat time in ms
    """
    self.setRepeatAction(SLIDER_ACTION.get_enum_value(action), threshold, repeat_time)

set_vertical()

Set slider orientation to vertical.

Source code in prettyqt\widgets\abstractslider.py 
65
66
67
def set_vertical(self):
    """Set slider orientation to vertical."""
    self.setOrientation(constants.VERTICAL)

trigger_action(action: SliderActionStr | widgets.QAbstractSlider.SliderAction)

Trigger slider action.

Source code in prettyqt\widgets\abstractslider.py 
124
125
126
127
128
def trigger_action(
    self, action: SliderActionStr | widgets.QAbstractSlider.SliderAction
):
    """Trigger slider action."""
    self.triggerAction(SLIDER_ACTION.get_enum_value(action))