ooodev.adapter.awt.uno_control_spin_button_model_partial module

class ooodev.adapter.awt.uno_control_spin_button_model_partial.UnoControlSpinButtonModelPartial(component)[source]

Bases: UnoControlModelPartial

Partial class for UnoControlSpinButtonModel.

Parameters:: component (UnoControlSpinButtonModel) –

__init__(component)[source]

Constructor

Parameters:: component (Any) – Component that implements com.sun.star.awt.UnoControlSpinButtonModel service.

property background_color: Color

Gets/Set the background color of the control.

Returns:: Color
Return type:: Color

property border: BorderKind

Gets/Sets the border style of the control.

Note

Value can be set with BorderKind or int.

Hint

BorderKind can be imported from ooodev.utils.kind.border_kind.

Return type:: BorderKind

property border_color: Color | None

Gets/Sets the color of the border, if present

Not every border style (see Border) may support coloring. For instance, usually a border with 3D effect will ignore the border_color setting.

optional

Returns:: Color or None if not present.
Return type:: Color | None

property enabled: bool

Gets/Sets whether the control is enabled or disabled.

Return type:: bool

property help_text: str

Get/Sets the help text of the control.

Return type:: str

property help_url: str

Gets/Sets the help URL of the control.

Return type:: str

property mouse_wheel_behavior: MouseWheelBehaviorEnum | None

Gets/Sets how the mouse wheel can be used to scroll through the control’s content.

Usually, the mouse wheel scroll through the control’s entry list. Using this property,you can control under which circumstances this is possible.

optional

Note

Value can be set with MouseWheelBehaviorEnum or int.

Hint

MouseWheelBehaviorEnum can be imported from ooo.dyn.awt.mouse_wheel_behavior

Return type:: MouseWheelBehaviorEnum | None

property orientation: OrientationKind

Gets/Sets the orientation of the control.

Note

Value can be set with OrientationKind or int.

Hint

OrientationKind can be imported from ooodev.utils.kind.orientation_kind.

Return type:: OrientationKind

property printable: bool

Gets/Sets that the control will be printed with the document.

Return type:: bool

property repeat: bool

Gets/Sets whether the mouse should show repeating behavior, i.e. repeatedly trigger an action when keeping pressed.

Return type:: bool

property repeat_delay: int

Gets/Sets the mouse repeat delay, in milliseconds.

When the user presses a mouse in a control area where this triggers an action (such as spinning the value), then usual control implementations allow to repeatedly trigger this action, without the need to release the mouse button and to press it again. The delay between two such triggers is specified with this property.

Return type:: int

property spin_increment: int

Gets/Sets the increment by which the value is changed when using operating the spin button.

Return type:: int

property spin_value: int

Gets/Sets the current value of the control.

Return type:: int

property spin_value_max: int

Gets/Sets the maximum value of the control.

Return type:: int

property spin_value_min: int

Gets/Sets the minimum value of the control.

Return type:: int

property symbol_color: Color

Gets/Sets the color to be used when painting symbols which are part of the control’s appearance, such as the arrow buttons.

Returns:: Color
Return type:: Color