AyatanaIdo3.Timeline¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

class	`calculate_progress` (linear_progress, progress_type)
class	`new` (duration)
class	`new_for_screen` (duration, screen)
	`get_direction` ()
	`get_duration` ()
	`get_fps` ()
	`get_loop` ()
	`get_progress` ()
	`get_screen` ()
	`is_running` ()
	`pause` ()
	`rewind` ()
	`set_direction` (direction)
	`set_duration` (duration)
	`set_fps` (fps)
	`set_loop` (loop)
	`set_progress` (progress)
	`set_screen` (screen)
	`start` ()

Virtual Methods¶

Inherited:: GObject.Object (7)

	`do_finished` ()
	`do_frame` (progress)
	`do_paused` ()
	`do_started` ()

Properties¶

Name	Type	Flags	Short Description
`duration`	`int`	r/w	Animation Duration
`fps`	`int`	r/w	Frames per second for the timeline
`loop`	`bool`	r/w	Whether the timeline loops or not
`screen`	`Gdk.Screen`	r/w	`xlib.Screen` to get the settings from

Signals¶

Inherited:: GObject.Object (1)

Name	Short Description
`finished`	The `::paused` signal is emitted when the timeline finishes.
`frame`	The `::frame` signal is emitted when a frame should be drawn.
`paused`	The `::paused` signal is emitted when the timeline pauses.
`started`	The `::started` signal is emitted when the timeline starts.

Fields¶

Inherited:: GObject.Object (1)

Name	Type	Access	Description
parent_instance	`GObject.Object`	r

Class Details¶

class AyatanaIdo3.Timeline(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: AyatanaIdo3.TimelineClass

classmethod calculate_progress(linear_progress, progress_type)¶

Parameters:

linear_progress (float) – The progress from 0.0 (start) to 1.0 (end)
progress_type (AyatanaIdo3.TimelineProgressType) – The progress transform to apply

Returns:

the progress position using the provided transform.

Return type:

float

Transform a linear progress position using the given transform.

classmethod new(duration)¶

Parameters:: duration (int) – duration in milliseconds for the timeline
Returns:: the newly created AyatanaIdo3.Timeline
Return type:: AyatanaIdo3.Timeline

Creates a new AyatanaIdo3.Timeline with the specified number of frames.

classmethod new_for_screen(duration, screen)¶

Parameters:

duration (int) – duration in milliseconds for the timeline
screen (Gdk.Screen) – xlib.Screen to start on.

Returns:

the newly created AyatanaIdo3.Timeline

Return type:

AyatanaIdo3.Timeline

Creates a new AyatanaIdo3.Timeline with the specified number of frames on the given screen.

get_direction()¶

Returns:: direction
Return type:: AyatanaIdo3.TimelineDirection

Returns the direction of the timeline.

get_duration()¶

Returns:: Duration in milliseconds.
Return type:: int

Set the animation duration.

get_fps()¶

Returns:: frames per second
Return type:: int

Returns the number of frames per second.

get_loop()¶

Returns:: True if the timeline loops
Return type:: bool

Returns whether the timeline loops to the beginning when it has reached the end.

get_progress()¶

Returns:: The progress from 0.0 (start) to 1.0 (end)
Return type:: float

Get the progress on the timeline.

get_screen()¶

Returns:: The Gdk.Screen this timeline is running on.
Return type:: Gdk.Screen

Get the screen this timeline is running on.

is_running()¶

Returns:: True if the timeline is running
Return type:: bool

Returns whether the timeline is running or not.

pause()¶: Pauses the timeline.

rewind()¶: Rewinds the timeline.

set_direction(direction)¶

Parameters:: direction (AyatanaIdo3.TimelineDirection) – direction

Sets the direction of the timeline.

set_duration(duration)¶

Parameters:: duration (int) – Duration in milliseconds.

Set the animation duration.

set_fps(fps)¶

Parameters:: fps (int) – frames per second

Sets the number of frames per second that the timeline will play.

set_loop(loop)¶

Parameters:: loop (bool) – True to make the timeline loop

Sets whether the timeline loops to the beginning when it has reached the end.

set_progress(progress)¶

Parameters:: progress (float) – The progress from 0.0 (start) to 1.0 (end)

Set the progress on the timeline.

set_screen(screen)¶

Parameters:: screen (Gdk.Screen) – A Gdk.Screen to use

Set the screen the timeline is running on.

start()¶: Runs the timeline from the current frame.

do_finished() virtual¶

do_frame(progress) virtual¶

Parameters:: progress (float) –

do_paused() virtual¶

do_started() virtual¶

Signal Details¶

AyatanaIdo3.Timeline.signals.finished(timeline)¶

Signal Name:: finished
Flags:: RUN_LAST
Parameters:: timeline (AyatanaIdo3.Timeline) – The object which received the signal

The ::paused signal is emitted when the timeline finishes.

AyatanaIdo3.Timeline.signals.frame(timeline, progress)¶

Signal Name:

frame

Flags:

RUN_LAST

Parameters:

timeline (AyatanaIdo3.Timeline) – The object which received the signal
progress (float) – The progress position for this frame from 0.0 (start) to 1.0 (end).

The ::frame signal is emitted when a frame should be drawn.

AyatanaIdo3.Timeline.signals.paused(timeline)¶

Signal Name:: paused
Flags:: RUN_LAST
Parameters:: timeline (AyatanaIdo3.Timeline) – The object which received the signal

The ::paused signal is emitted when the timeline pauses.

AyatanaIdo3.Timeline.signals.started(timeline)¶

Signal Name:: started
Flags:: RUN_LAST
Parameters:: timeline (AyatanaIdo3.Timeline) – The object which received the signal

The ::started signal is emitted when the timeline starts.

Property Details¶

AyatanaIdo3.Timeline.props.duration¶

Name:: duration
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE

Animation Duration

AyatanaIdo3.Timeline.props.fps¶

Name:: fps
Type:: int
Default Value:: 30
Flags:: READABLE, WRITABLE

Frames per second for the timeline

AyatanaIdo3.Timeline.props.loop¶

Name:: loop
Type:: bool
Default Value:: False
Flags:: READABLE, WRITABLE

Whether the timeline loops or not

AyatanaIdo3.Timeline.props.screen¶

Name:: screen
Type:: Gdk.Screen
Default Value:: None
Flags:: READABLE, WRITABLE

xlib.Screen to get the settings from