Class ModelScrollBar

class ooodev.dialog.dl_control.model.model_scroll_bar.ModelScrollBar(model)[source]

Bases: ModelPropPartial, UnoControlScrollBarModelPartial, ModelDialogElementPartial

__init__(model)[source]

Constructor

Parameters:

component (UnoControlModel) – UNO Component that implements com.sun.star.awt.UnoControlModel service.
model (com.sun.star.awt.UnoControlModel) –

Return type:

None

add_event_listener(listener)

Adds an event listener to the component.

Parameters:: listener (XEventListener) – The event listener to be added.
Return type:: None

add_property_change_listener(name, listener)

Adds a listener for property changes.

Parameters:

name (str) – The name of the property.
listener (Any) – The listener to be added.

Return type:

None

add_vetoable_change_listener(name, listener)

Adds a listener for vetoable changes.

Parameters:

name (str) – The name of the property.
listener (Any) – The listener to be added.

Return type:

None

create_clone()

Creates a clone of the object.

Returns:: The clone.
Return type:: XCloneable

dispose()

Disposes the component.

Return type:: None

get_property_set_info()

Returns the property set info.

Returns:: The property set info.
Return type:: XPropertySetInfo

get_property_value(name)

Returns the value of a property.

Parameters:: name (str) – The name of the property.
Returns:: The value of the property.
Return type:: Any

remove_event_listener(listener)

Removes an event listener from the component.

Parameters:: listener (XEventListener) – The event listener to be removed.
Return type:: None

remove_property_change_listener(name, listener)

Removes a listener for property changes.

Parameters:

name (str) – The name of the property.
listener (Any) – The listener to be removed.

Return type:

None

remove_vetoable_change_listener(name, listener)

Removes a listener for vetoable changes.

Parameters:

name (str) – The name of the property.
listener (Any) – The listener to be removed.

Return type:

None

set_property_value(name, value)

Sets the value of a property.

Parameters:

name (str) – The name of the property.
value (Any) – The value of the property.

Return type:

None

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

Get or set the context_writing_mode property.

Return type:: int

property enable_visible: bool

Get or set the enable_visible property.

Return type:: bool

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 model: com.sun.star.awt.UnoControlModel

Uno Control Model

Return type:: UnoControlModel

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 picture: str

Gets/Sets the picture for the control

When setting the value it can be a string or a Path object. If a string is passed it can be a URL or a path to a file. Value such as file:///path/to/image.png and /path/to/image.png are valid. Relative paths are supported.

Returns:: The picture URL in the format of file:///path/to/image.png or empty string if no picture is set.
Return type:: str

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