ooodev.adapter.awt.scroll_bar_partial module

class ooodev.adapter.awt.scroll_bar_partial.ScrollBarPartial(component, interface=com.sun.star.awt.XScrollBar)

Bases: object

Partial class for XScrollBar.

Parameters:

• component (XScrollBar) –

• interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.awt.XScrollBar)

Constructor

Parameters:

• component (XScrollBar) – UNO Component that implements com.sun.star.awt.XScrollBar interface.

• interface (UnoInterface, optional) – The interface to be validated. Defaults to XScrollBar.

Return type:

None

add_adjustment_listener(listener)

Registers an adjustment event listener.

Return type:

None

Parameters:

listener (com.sun.star.awt.XAdjustmentListener) –

get_block_increment()

Gets the currently set increment for a block move.

Return type:

int

get_line_increment()

Gets the currently set increment for a single line move.

Return type:

int

get_maximum()

Gets the currently set maximum scroll value of the scroll bar.

Return type:

int

get_orientation()

Gets the currently set ScrollBarOrientation of the scroll bar.

Return type:

ScrollBarOrientationEnum

get_value()

Gets the current scroll value of the scroll bar.

Return type:

int

get_visible_size()

returns the currently visible size of the scroll bar.

Return type:

UnitPX

remove_adjustment_listener(listener)

Un-registers an adjustment event listener.

Return type:

None

Parameters:

listener (com.sun.star.awt.XAdjustmentListener) –

set_block_increment(n)

Sets the increment for a block move.

Return type:

None

Parameters:

n (int) –

set_line_increment(n)

Sets the increment for a single line move.

Return type:

None

Parameters:

n (int) –

set_maximum(n)

Sets the maximum scroll value of the scroll bar.

Return type:

None

Parameters:

n (int) –

set_orientation(n)

Sets the ScrollBarOrientation of the scroll bar.

• 0: HORIZONTAL

• 1: VERTICAL

Parameters:

n (int | ScrollBarOrientationEnum) – ScrollBarOrientation value.

Return type:

None

set_value(n)

Sets the scroll value of the scroll bar.

Return type:

None

Parameters:

n (int) –

set_values(val, visible, max_scroll)

Sets the scroll value, visible area and maximum scroll value of the scroll bar.

Return type:

None

Parameters:

• val (int) –

• visible (int) –

• max_scroll (int) –

set_visible_size(size)

Sets the visible size of the scroll bar.

Return type:

None

Parameters:

size (int | UnitT) –