ooodev.adapter.awt.spin_value_partial module

class ooodev.adapter.awt.spin_value_partial.SpinValuePartial(component, interface=com.sun.star.awt.XSpinValue)[source]

Bases: object

Partial class for XSpinValue.

Parameters:

component (XSpinValue) –
interface (UnoInterface | None) –

__init__(component, interface=com.sun.star.awt.XSpinValue)[source]

Constructor

Parameters:

component (XSpinValue) – UNO Component that implements com.sun.star.awt.XSpinValue interface.
interface (UnoInterface, optional) – The interface to be validated. Defaults to XSpinValue.

Return type:

None

add_adjustment_listener(listener)[source]

Registers an adjustment event listener.

Return type:: None
Parameters:: listener (com.sun.star.awt.XAdjustmentListener) –

get_maximum()[source]

Gets the currently set maximum value of the control

Return type:: int

get_minimum()[source]

returns the currently set minimum value of the control

Return type:: int

get_orientation()[source]

returns the current orientation of the control

Return type:: int

get_spin_increment()[source]

Returns the value by which the current value of the control should be incremented or decremented upon spinning.

Return type:: int

get_value()[source]

returns the current value of the control.

Return type:: int

remove_adjustment_listener(listener)[source]

Un-registers an adjustment event listener.

Return type:: None
Parameters:: listener (com.sun.star.awt.XAdjustmentListener) –

set_maximum(max_value)[source]

Sets the maximum value which can be set on the control

Return type:: None
Parameters:: max_value (int) –

set_minimum(min_value)[source]

Sets the minimum value which can be set on the control

Return type:: None
Parameters:: min_value (int) –

set_orientation(orientation)[source]

controls the orientation of the control

Raises:: com.sun.star.lang.NoSupportException – NoSupportException
Return type:: None
Parameters:: orientation (int) –

set_spin_increment(spin_increment)[source]

sets the value by which the current value of the control should be incremented or decremented upon spinning.

Return type:: None
Parameters:: spin_increment (int) –

set_value(value)[source]

Sets the current value of the control

Return type:: None
Parameters:: value (int) –

set_values(min_value, max_value, current_value)[source]

Sets the value and value range of the control

Return type:

None

Parameters:

min_value (int) –
max_value (int) –
current_value (int) –