ooodev.format.draw.direct.text.animation.scroll_through module

class ooodev.format.draw.direct.text.animation.scroll_through.ScrollThrough(start_inside=None, visible_on_exit=None, increment=None, delay=None, direction=None, count=None)[source]

Bases: ScrollThrough

This class represents the text Animation of an object that supports com.sun.star.drawing.TextProperties.

See also

New in version 0.17.6.

__init__(start_inside=None, visible_on_exit=None, increment=None, delay=None, direction=None, count=None)[source]

Constructor.

Parameters:

  • start_inside (bool | None) – bool, optional): Start inside. If this value is True, the text is visible at the start of the animation.

  • visible_on_exit (bool, optional) – Visible on exit. If this value is True, the text is visible at the end of the animation.

  • increment (float, UnitT, optional) – Increment value. A positive float represents MM units, a negative value represents pixels, or a UnitT instance can be passed in.

  • delay (int, optional) – Delay in milliseconds. This is the delay in thousandths of a second (milliseconds) between each of the animation steps. A value of 0 means automatic delay.

  • direction (TextAnimationDirection, optional) – This enumeration defines the direction in which the text moves.

  • count (int, optional) – This number defines how many times the text animation is repeated. If this is set to 0, the repeat is endless.

Return type:

None

See also