Skip to content

AbstractScrollAreaMixin

Base classes

Name Children Inherits
FrameMixin
prettyqt.widgets.frame

Subclasses

Class Module Description
AbstractScrollArea prettyqt.widgets.abstractscrollarea
AbstractItemViewMixin prettyqt.widgets.abstractitemview
ScrollArea prettyqt.widgets.scrollarea
GraphicsViewMixin prettyqt.widgets.graphicsview
MdiArea prettyqt.widgets.mdiarea
TextEditMixin prettyqt.widgets.textedit
PlainTextEditMixin prettyqt.widgets.plaintextedit
PdfView prettyqt.pdfwidgets.pdfview

â‹” Inheritance diagram

graph TD
  1473293679456["widgets.AbstractScrollAreaMixin"]
  1473293662864["widgets.FrameMixin"]
  1473293688240["widgets.WidgetMixin"]
  1473299815024["core.ObjectMixin"]
  140713234304496["builtins.object"]
  1473245548480["gui.PaintDeviceMixin"]
  1473293662864 --> 1473293679456
  1473293688240 --> 1473293662864
  1473299815024 --> 1473293688240
  140713234304496 --> 1473299815024
  1473245548480 --> 1473293688240
  140713234304496 --> 1473245548480

🛈 DocStrings

Bases: FrameMixin

Source code in prettyqt\widgets\abstractscrollarea.py 
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
class AbstractScrollAreaMixin(widgets.FrameMixin):
    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        self.setHorizontalScrollBar(widgets.ScrollBar(parent=self))
        self.setVerticalScrollBar(widgets.ScrollBar(parent=self))

    def _get_map(self):
        maps = super()._get_map()
        maps |= {
            "horizontalScrollBarPolicy": constants.SCROLLBAR_POLICY,
            "sizeAdjustPolicy": SIZE_ADJUST_POLICY,
            "verticalScrollBarPolicy": constants.SCROLLBAR_POLICY,
        }
        return maps

    @property
    def h_scrollbar(self) -> widgets.ScrollBar:
        return self.horizontalScrollBar()

    @h_scrollbar.setter
    def h_scrollbar(self, scrollbar: widgets.ScrollBar):
        self.setHorizontalScrollBar(scrollbar)

    @property
    def v_scrollbar(self) -> widgets.ScrollBar:
        return self.verticalScrollBar()

    @v_scrollbar.setter
    def v_scrollbar(self, scrollbar: widgets.ScrollBar):
        self.setVerticalScrollBar(scrollbar)

    def scroll_by_pixels(self, x: int = 0, y: int = 0):
        new_x = self.h_scrollbar.value() + x
        x_val = max(min(new_x, self.h_scrollbar.maximum()), self.h_scrollbar.minimum())
        new_y = self.h_scrollbar.value() + y
        y_val = max(min(new_y, self.v_scrollbar.maximum()), self.v_scrollbar.minimum())
        self.h_scrollbar.setValue(x_val)
        self.v_scrollbar.setValue(y_val)

    def set_size_adjust_policy(self, policy: SizeAdjustPolicyStr | area.SizeAdjustPolicy):
        """Set size adjust policy.

        Args:
            policy: size adjust policy to use
        """
        self.setSizeAdjustPolicy(SIZE_ADJUST_POLICY.get_enum_value(policy))

    def get_size_adjust_policy(self) -> SizeAdjustPolicyStr:
        """Return size adjust policy.

        Returns:
            size adjust policy
        """
        return SIZE_ADJUST_POLICY.inverse[self.sizeAdjustPolicy()]

    def set_scrollbar_smooth(
        self,
        value: bool = True,
        animation_duration: int = 500,
        easing: core.easingcurve.TypeStr | core.QEasingCurve.Type = "out_cubic",
    ):
        from prettyqt import custom_widgets

        if value:
            self.h_scrollbar = custom_widgets.SmoothScrollBar(
                "horizontal",
                parent=self,
                animation_duration=animation_duration,
                easing=easing,
            )
            self.v_scrollbar = custom_widgets.SmoothScrollBar(
                "vertical",
                parent=self,
                animation_duration=animation_duration,
                easing=easing,
            )
        else:
            self.h_scrollbar = widgets.ScrollBar(parent=self)
            self.v_scrollbar = widgets.ScrollBar(parent=self)

    def set_scrollbar_policy(
        self, mode: constants.ScrollBarPolicyStr | constants.ScrollBarPolicy
    ):
        """Set the policy for both scrollbars.

        Args:
            mode: visibilty to set
        """
        self.setHorizontalScrollBarPolicy(constants.SCROLLBAR_POLICY.get_enum_value(mode))
        self.setVerticalScrollBarPolicy(constants.SCROLLBAR_POLICY.get_enum_value(mode))

    def set_horizontal_scrollbar_policy(
        self, mode: constants.ScrollBarPolicyStr | constants.ScrollBarPolicy
    ):
        """Set the horizontal scrollbar visibility.

        Args:
            mode: visibilty to set
        """
        self.setHorizontalScrollBarPolicy(constants.SCROLLBAR_POLICY[mode])

    def get_horizontal_scrollbar_policy(self) -> constants.ScrollBarPolicyStr:
        return constants.SCROLLBAR_POLICY.inverse[self.horizontalScrollBarPolicy()]

    def set_vertical_scrollbar_policy(
        self, mode: constants.ScrollBarPolicyStr | constants.ScrollBarPolicy
    ):
        """Set the vertical scrollbar visibility.

        Args:
            mode: visibilty to set
        """
        self.setVerticalScrollBarPolicy(constants.SCROLLBAR_POLICY.get_enum_value(mode))

    def get_vertical_scrollbar_policy(self) -> constants.ScrollBarPolicyStr:
        return constants.SCROLLBAR_POLICY.inverse[self.verticalScrollBarPolicy()]

    def set_scrollbar_width(self, width: int):
        """Set the width for both scrollbars.

        Args:
            width: width in pixels
        """
        self.set_horizontal_scrollbar_width(width)
        self.set_vertical_scrollbar_width(width)

    def set_horizontal_scrollbar_width(self, width: int):
        """Set the horizontal scrollbar width.

        Args:
            width: width in pixels
        """
        with self.h_scrollbar.edit_stylesheet() as ss:
            ss.QScrollBar.horizontal.height.setValue(f"{width}px")

    def set_vertical_scrollbar_width(self, width: int):
        """Set the vertical scrollbar width.

        Args:
            width: width in pixels
        """
        with self.v_scrollbar.edit_stylesheet() as ss:
            ss.QScrollBar.horizontal.height.setValue(f"{width}px")

    def scroll_to_top(self):
        """Scroll to the top of the scroll area."""
        self.verticalScrollBar().scroll_to_min()

    def scroll_to_bottom(self):
        """Scroll to the bottom of the scroll area."""
        self.verticalScrollBar().scroll_to_max()

    def set_viewport_margins(self, margins: int):
        self.setViewportMargins(margins, margins, margins, margins)

    def add_scrollbar_widget(
        self,
        widget: widgets.QWidget,
        alignment: constants.AlignmentStr | constants.AlignmentFlag,
    ):
        alignment = constants.ALIGNMENTS.get_enum_value(alignment)
        self.addScrollBarWidget(widget, alignment)

get_size_adjust_policy() -> SizeAdjustPolicyStr

Return size adjust policy.

Source code in prettyqt\widgets\abstractscrollarea.py 
67
68
69
70
71
72
73
def get_size_adjust_policy(self) -> SizeAdjustPolicyStr:
    """Return size adjust policy.

    Returns:
        size adjust policy
    """
    return SIZE_ADJUST_POLICY.inverse[self.sizeAdjustPolicy()]

scroll_to_bottom()

Scroll to the bottom of the scroll area.

Source code in prettyqt\widgets\abstractscrollarea.py 
168
169
170
def scroll_to_bottom(self):
    """Scroll to the bottom of the scroll area."""
    self.verticalScrollBar().scroll_to_max()

scroll_to_top()

Scroll to the top of the scroll area.

Source code in prettyqt\widgets\abstractscrollarea.py 
164
165
166
def scroll_to_top(self):
    """Scroll to the top of the scroll area."""
    self.verticalScrollBar().scroll_to_min()

set_horizontal_scrollbar_policy(mode: constants.ScrollBarPolicyStr | constants.ScrollBarPolicy)

Set the horizontal scrollbar visibility.

Parameters:

Name Type Description Default
mode ScrollBarPolicyStr | ScrollBarPolicy

visibilty to set

 required
Source code in prettyqt\widgets\abstractscrollarea.py 
111
112
113
114
115
116
117
118
119
def set_horizontal_scrollbar_policy(
    self, mode: constants.ScrollBarPolicyStr | constants.ScrollBarPolicy
):
    """Set the horizontal scrollbar visibility.

    Args:
        mode: visibilty to set
    """
    self.setHorizontalScrollBarPolicy(constants.SCROLLBAR_POLICY[mode])

set_horizontal_scrollbar_width(width: int)

Set the horizontal scrollbar width.

Parameters:

Name Type Description Default
width int

width in pixels

 required
Source code in prettyqt\widgets\abstractscrollarea.py 
146
147
148
149
150
151
152
153
def set_horizontal_scrollbar_width(self, width: int):
    """Set the horizontal scrollbar width.

    Args:
        width: width in pixels
    """
    with self.h_scrollbar.edit_stylesheet() as ss:
        ss.QScrollBar.horizontal.height.setValue(f"{width}px")

set_scrollbar_policy(mode: constants.ScrollBarPolicyStr | constants.ScrollBarPolicy)

Set the policy for both scrollbars.

Parameters:

Name Type Description Default
mode ScrollBarPolicyStr | ScrollBarPolicy

visibilty to set

 required
Source code in prettyqt\widgets\abstractscrollarea.py 
100
101
102
103
104
105
106
107
108
109
def set_scrollbar_policy(
    self, mode: constants.ScrollBarPolicyStr | constants.ScrollBarPolicy
):
    """Set the policy for both scrollbars.

    Args:
        mode: visibilty to set
    """
    self.setHorizontalScrollBarPolicy(constants.SCROLLBAR_POLICY.get_enum_value(mode))
    self.setVerticalScrollBarPolicy(constants.SCROLLBAR_POLICY.get_enum_value(mode))

set_scrollbar_width(width: int)

Set the width for both scrollbars.

Parameters:

Name Type Description Default
width int

width in pixels

 required
Source code in prettyqt\widgets\abstractscrollarea.py 
137
138
139
140
141
142
143
144
def set_scrollbar_width(self, width: int):
    """Set the width for both scrollbars.

    Args:
        width: width in pixels
    """
    self.set_horizontal_scrollbar_width(width)
    self.set_vertical_scrollbar_width(width)

set_size_adjust_policy(policy: SizeAdjustPolicyStr | area.SizeAdjustPolicy)

Set size adjust policy.

Parameters:

Name Type Description Default
policy SizeAdjustPolicyStr | SizeAdjustPolicy

size adjust policy to use

 required
Source code in prettyqt\widgets\abstractscrollarea.py 
59
60
61
62
63
64
65
def set_size_adjust_policy(self, policy: SizeAdjustPolicyStr | area.SizeAdjustPolicy):
    """Set size adjust policy.

    Args:
        policy: size adjust policy to use
    """
    self.setSizeAdjustPolicy(SIZE_ADJUST_POLICY.get_enum_value(policy))

set_vertical_scrollbar_policy(mode: constants.ScrollBarPolicyStr | constants.ScrollBarPolicy)

Set the vertical scrollbar visibility.

Parameters:

Name Type Description Default
mode ScrollBarPolicyStr | ScrollBarPolicy

visibilty to set

 required
Source code in prettyqt\widgets\abstractscrollarea.py 
124
125
126
127
128
129
130
131
132
def set_vertical_scrollbar_policy(
    self, mode: constants.ScrollBarPolicyStr | constants.ScrollBarPolicy
):
    """Set the vertical scrollbar visibility.

    Args:
        mode: visibilty to set
    """
    self.setVerticalScrollBarPolicy(constants.SCROLLBAR_POLICY.get_enum_value(mode))

set_vertical_scrollbar_width(width: int)

Set the vertical scrollbar width.

Parameters:

Name Type Description Default
width int

width in pixels

 required
Source code in prettyqt\widgets\abstractscrollarea.py 
155
156
157
158
159
160
161
162
def set_vertical_scrollbar_width(self, width: int):
    """Set the vertical scrollbar width.

    Args:
        width: width in pixels
    """
    with self.v_scrollbar.edit_stylesheet() as ss:
        ss.QScrollBar.horizontal.height.setValue(f"{width}px")