ooodev.adapter.awt.uno_control_scroll_bar_model_partial module

class ooodev.adapter.awt.uno_control_scroll_bar_model_partial.UnoControlScrollBarModelPartial(component)[source]

Bases: UnoControlModelPartial

Partial class for UnoControlScrollBarModel.

Parameters:: component (UnoControlScrollBarModel) –

__init__(component)[source]

Constructor

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

property background_color: Color | None

Gets/Set the background color of the control.

optional

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

property block_increment: int

Gets/Sets the increment for a block move.

Return type:: int

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 line_increment: int

Gets/Sets the increment for a single line move.

Return type:: int

property live_scroll: bool | None

Gets/Sets the scrolling behavior of the control.

TRUE means, that when the user moves the slider in the scroll bar, the content of the window is updated immediately. FALSE means, that the window is only updated after the user has released the mouse button.

optional

Return type:: bool | 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_delay: int | None

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.

optional

Return type:: int | None

property scroll_value: int

Gets/Sets the scroll value of the control.

Return type:: int

property scroll_value_max: int

Gets/Sets the maximum scroll value of the control.

Return type:: int

property scroll_value_min: int | None

Gets/Sets the minimum scroll value of the control.

If this optional property is not present, clients of the component should assume a minimal scroll value of 0.

optional

Return type:: int | None

property tabstop: bool | None

Gets/Sets that the control can be reached with the TAB key.

optional

Return type:: bool | None

property visible_size: int | None

Gets/Sets the visible size of the scroll bar.

optional

Return type:: int | None