Class CtlScrollBar

Introduction

Class for working with scroll bar controls in a dialog.

EventArgsCallbackT

All EventArgsCallbackT callbacks include control_src as a keyword argument.

A callback can be in the format of:

def on_some_event(
    src: Any, event: EventArgs, control_src: CtlScrollBar, *args, **kwargs
) -> None:
    pass

or

def on_some_event(src: Any, event: EventArgs, *args, **kwargs) -> None:
    # can get control from kwargs
    ctl = cast(CtlScrollBar, kwargs['control_src'])

Example

For an example see Progress Bar and Scroll Bar Example

Class

class ooodev.dialog.dl_control.CtlScrollBar(ctl)[source]

Bases: DialogControlBase, UnoControlScrollBarModelPartial, AdjustmentEvents

Class for Scroll Bar Control

Parameters:

args (Any) –
kwargs (Any) –

Return type:

Any

__init__(ctl)[source]

Constructor

Parameters:: ctl (UnoControlScrollBar) – Scroll Bar Control
Return type:: None

add_event_adjustment_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_adjustment_value_changed(cb)

Adds a listener for an event.

Event is invoked when the adjustment has changed.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.AdjustmentEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_focus_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_focus_gained(cb)

Adds a listener for an event.

Event is invoked when a window gains the keyboard focus.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.FocusEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_focus_lost(cb)

Adds a listener for an event.

Event is invoked when a window loses the keyboard focus.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.FocusEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_key_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_key_pressed(cb)

Adds a listener for an event.

Event is invoked when a key has been pressed.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.KeyEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_key_released(cb)

Adds a listener for an event.

Event is invoked when a key has been released.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.KeyEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_listener(listener)

Adds an event listener to the component.

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

add_event_mouse_dragged(cb)

Adds a listener for an event.

Event is invoked when a mouse button is pressed on a window and then dragged.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_entered(cb)

Adds a listener for an event.

Event is invoked when the mouse enters a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_exited(cb)

Adds a listener for an event.

Event is invoked when the mouse exits a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_motion_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_moved(cb)

Adds a listener for an event.

Event Is invoked when the mouse pointer has been moved on a window (with no buttons down).

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_pressed(cb)

Adds a listener for an event.

Event is invoked when a mouse button has been pressed on a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_mouse_released(cb)

Adds a listener for an event.

Event is invoked when a mouse button has been released on a window.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.MouseEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_observers(*args)

Adds observers that gets their trigger method called when this class trigger method is called.

Parameters:: args (EventObserver) – One or more observers to add.
Return type:: None

Note

Observers are removed automatically when they are out of scope.

add_event_paint_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_properties_change(names, cb)

Add properties to listen for changes.

Parameters:

names (Iterable[str]) – One or more property names to listen for changes.
cb (EventArgsCallbackT) – Callback that is invoked when an event is triggered.

Raises:

ValueError – If names is empty.

Return type:

None

Note

The callback EventArgs.event_data will contain a tuple of com.sun.star.beans.PropertyChangeEvent objects.

Each time this method is called, the previous names are removed and the new names are added.

add_event_property_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_property_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_vetoable_change(name, cb)

Adds a listener for an event.

Event is invoked when property is changed.

The callback EventArgs.event_data will contain a com.sun.star.beans.PropertyChangeEvent struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_vetoable_change_events_disposing(name, cb)

Adds a listener for an event.

Event is invoked when the property listener is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Parameters:

name (str) – Property Name
cb (EventArgsCallbackT) – Callback

Return type:

None

add_event_window_events_disposing(cb)

Adds a listener for an event.

Event is invoked when the broadcaster is about to be disposed.

The callback EventArgs.event_data will contain a UNO com.sun.star.lang.EventObject struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_hidden(cb)

Adds a listener for an event.

Event is invoked when the window has been hidden.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_moved(cb)

Adds a listener for an event.

Event is invoked when the window has been moved.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_paint(cb)

Adds a listener for an event.

Event Is invoked when a region of the window became invalid, e.g. when another window has been moved away.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.PaintEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_resized(cb)

Adds a listener for an event.

Event is invoked when the window has been resized.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

add_event_window_shown(cb)

Adds a listener for an event.

Event is invoked when the window has been shown.

The callback EventArgs.event_data will contain a UNO com.sun.star.awt.WindowEvent struct.

Return type:: None
Parameters:: cb (Any) –

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

apply_styles(*styles)

Applies styles to control

Parameters:: *styles (StyleT) – Styles to apply
Return type:: None

create_clone()

Creates a clone of the object.

Returns:: The clone.
Return type:: XCloneable

dispose()

Disposes the component.

Return type:: None

fire_event_properties_change(names)

Fires a sequence of PropertyChangeEvents

Parameters:: names (Iterable[str]) – Sequence of property names to fire event for.
Return type:: None

get_control_kind()[source]

Gets the control kind. Returns DialogControlKind.SCROLL_BAR

Return type:: DialogControlKind

get_control_named_kind()[source]

Gets the control named kind. Returns DialogControlNamedKind.SCROLL_BAR

Return type:: DialogControlNamedKind

get_control_props()

Gets property set for a control model

Parameters:: control_model (Any) – control model
Returns:: Property set
Return type:: XPropertySet | None

get_model()[source]

Gets the Model for the control

Return type:: UnoControlScrollBarModel

get_property_set()

Gets the property set for this control

Return type:: XPropertySet

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

get_uno_srv_name()[source]

Returns com.sun.star.awt.UnoControlScrollBar

Return type:: str

get_view()

Return type:: XControl

get_view_ctl()[source]

Return type:: UnoControlScrollBar

remove_event_adjustment_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_adjustment_value_changed(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_focus_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_focus_gained(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_focus_lost(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_key_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_key_pressed(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_key_released(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (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_event_mouse_dragged(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_entered(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_exited(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_motion_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_moved(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_pressed(cb)

Removes a listener for an event.

Event is invoked when a mouse button has been pressed on a window.

Return type:: None
Parameters:: cb (Any) –

remove_event_mouse_released(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_observer(observer)

Removes an observer

Parameters:: observer (EventObserver) – One or more observers to add.
Returns:: True if observer has been removed; Otherwise, False.
Return type:: bool

remove_event_paint_events_disposing(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_properties_listener()

Remove Properties Listener

Return type:: None

remove_event_property_change(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_property_change_events_disposing(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_vetoable_change(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_vetoable_change_events_disposing(name)

Removes a listener for an event

Parameters:: name (str) – Property Name
Return type:: None

remove_event_window_events_disposing(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_hidden(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_moved(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_paint(cb)

Removes a listener for an event

Return type:: None
Parameters:: cb (Any) –

remove_event_window_resized(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

remove_event_window_shown(cb)

Removes a listener for an event.

Return type:: None
Parameters:: cb (Any) –

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

subscribe_event(event_name, callback)

Add an event listener to current instance.

Parameters:

event_name (str) – Event Name.
callback (EventCallback) – Callback of the event listener.

Return type:

None

trigger_event(event_name, event_args)

Trigger an event on current instance.

Parameters:

event_name (str) – Event Name.
event_args (EventArgsT) – Event Args.

Return type:

None

unsubscribe_event(event_name, callback)

Remove an event listener from current instance.

Parameters:

event_name (str) – Event Name.
callback (EventCallback) – Callback of the event listener.

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 enabled: bool

Gets/Sets whether the control is enabled or disabled.

Return type:: bool

property event_observer: EventObserver

Gets/Sets The Event Observer for this instance.

Return type:: EventObserver

property events_listener_adjustment: AdjustmentListener

Returns listener

Return type:: AdjustmentListener

property events_listener_focus: FocusListener

Returns listener

Return type:: FocusListener

property events_listener_key: KeyListener

Returns listener

Return type:: KeyListener

property events_listener_mouse: MouseListener

Returns listener

Return type:: MouseListener

property events_listener_mouse_motion: MouseMotionListener

Returns listener

Return type:: MouseMotionListener

property events_listener_paint: PaintListener

Returns listener

Return type:: PaintListener

property events_listener_properties_change_implement: PropertiesChangeListener

Returns listener

Return type:: PropertiesChangeListener

property events_listener_window: WindowListener

Returns listener

Return type:: WindowListener

property height: UnitPX

Gets/Sets the height of the control in Pixel units.

When setting can be an integer in Pixels Units or a UnitT.

Returns:: Height of the control.
Return type:: UnitPX

Note

The Height is in Pixel units; however, the model is in AppFont units. This property will convert the AppFont units to Pixel units. When set using UnitAppFontHeight no conversion is done.

property help_text: str

Gets/Sets the tip text

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 lo_inst: LoInst

Lo Instance

Return type:: LoInst

property max_value: int

Gets the maximum value of the scroll bar. Same as scroll_value_max property.

Return type:: int

property min_value: int

Gets the minimum value of the scroll bar. Same as scroll_value_min property.

Return type:: int

property model: com.sun.star.awt.UnoControlScrollBarModel

Uno Control Model

Return type:: UnoControlScrollBarModel

property model_ex: ModelScrollBar

Gets the extended Model for the control.

This is a wrapped instance for the model property. It add some additional properties and methods to the model.

Return type:: ModelScrollBar

property name: str

Gets/Sets the name of the control.

Return type:: str

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

Gets/Sets the step

Return type:: int

property tab_index: int

Gets/Sets the tab index

Return type:: int

property tabstop: bool | None

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

optional

Return type:: bool | None

property tag: str

Gets/Sets the tag

Return type:: str

property tip_text: str

Gets/Sets the tip text

Return type:: str

property value: int

Gets or sets the current value of the scroll bar

Return type:: int

property view: com.sun.star.awt.UnoControlScrollBar

Uno Control

Return type:: UnoControlScrollBar

property view_ex: ViewScrollBar

Gets the extended View for the control.

This is a wrapped instance for the view property. It add some additional properties and methods to the view.

Return type:: ViewScrollBar

property visible: bool

Gets/Sets the visible state for the control

Return type:: bool

property visible_size: int | None

Gets/Sets the visible size of the scroll bar.

optional

Return type:: int | None

property width: UnitPX

Gets the width of the control

Return type:: UnitPX

property x: UnitPX

Gets/Sets the X position for the control in pixel units.

When setting can be an integer in Pixels Units or a UnitT.

Returns:: X position of the control.
Return type:: UnitPX

Note

The X is in Pixel units; however, the model is in AppFont units. This property will convert the AppFont units to Pixel units. When set using UnitAppFontX no conversion is done.

property y: UnitPX

Gets/Sets the Y position for the control in pixel units.

When setting can be an integer in Pixels Units or a UnitT.

Returns:: Y position of the control.
Return type:: UnitPX

Note

The Y is in Pixel units; however, the model is in AppFont units. This property will convert the AppFont units to Pixel units. When set using UnitAppFontY no conversion is done.