Gtk.ScrollInfo

Fields

None

Methods

class	new ()
	get_enable_horizontal ()
	get_enable_vertical ()
	ref ()
	set_enable_horizontal (horizontal)
	set_enable_vertical (vertical)
	unref ()

Details

class Gtk.ScrollInfo

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

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

New in version 4.12.

classmethod new()

Returns:

A new scroll info

Return type:

Gtk.ScrollInfo

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

New in version 4.12.

get_enable_horizontal()

Returns:

True if horizontal scrolling is enabled.

Return type:

bool

Checks if horizontal scrolling is enabled.

New in version 4.12.

get_enable_vertical()

Returns:

True if vertical scrolling is enabled.

Return type:

bool

Checks if vertical scrolling is enabled.

New in version 4.12.

ref()

Returns:

the passed in GtkScrollInfo.

Return type:

Gtk.ScrollInfo

Increases the reference count of a GtkScrollInfo by one.

New in version 4.12.

set_enable_horizontal(horizontal)

Parameters:

horizontal (bool) – if scrolling in the horizontal direction should happen

Turns horizontal scrolling on or off.

New in version 4.12.

set_enable_vertical(vertical)

Parameters:

vertical (bool) – if scrolling in the vertical direction should happen

Turns vertical scrolling on or off.

New in version 4.12.

unref()

Decreases the reference count of a GtkScrollInfo by one.

If the resulting reference count is zero, frees the self.

New in version 4.12.