:right-sidebar: True

ScrollInfo
===================================================================

.. currentmodule:: gi.repository.Gtk


.. versionadded:: 4.12




.. class:: ScrollInfo(**kwargs)
   :no-contents-entry:






The ``GtkScrollInfo`` can be used to provide more accurate data on how a scroll
operation should be performed.

Scrolling functions usually allow passing a :const:`None` scroll info which will cause
the default values to be used and just scroll the element into view.


Constructors
------------

.. rst-class:: interim-class

.. class:: ScrollInfo
   :no-index:


   .. classmethod:: new() -> ~gi.repository.Gtk.ScrollInfo

      Creates a new scroll info for scrolling an element into view.


      .. versionadded:: 4.12












Methods
-------

.. rst-class:: interim-class

.. class:: ScrollInfo
   :no-index:


   .. method:: get_enable_horizontal() -> bool

      Checks if horizontal scrolling is enabled.


      .. versionadded:: 4.12








   .. method:: get_enable_vertical() -> bool

      Checks if vertical scrolling is enabled.


      .. versionadded:: 4.12








   .. method:: set_enable_horizontal(horizontal: bool) -> None

      Turns horizontal scrolling on or off.


      .. versionadded:: 4.12





      :param horizontal: if scrolling in the horizontal direction
             should happen




   .. method:: set_enable_vertical(vertical: bool) -> None

      Turns vertical scrolling on or off.


      .. versionadded:: 4.12





      :param vertical: if scrolling in the vertical direction
             should happen