Interface

Clutter-18 ▶ Clutter ▶ TransitionGroup ▶ SignalSignatures

interface SignalSignatures {
    completed: () => void;
    "marker-reached": (arg0: string, arg1: number) => void;
    "marker-reached::actor": (arg0: string, arg1: number) => void;
    "marker-reached::auto-reverse": (arg0: string, arg1: number) => void;
    "marker-reached::delay": (arg0: string, arg1: number) => void;
    "marker-reached::direction": (arg0: string, arg1: number) => void;
    "marker-reached::duration": (arg0: string, arg1: number) => void;
    "marker-reached::frame-clock": (arg0: string, arg1: number) => void;
    "marker-reached::progress-mode": (arg0: string, arg1: number) => void;
    "marker-reached::repeat-count": (arg0: string, arg1: number) => void;
    "new-frame": (arg0: number) => void;
    notify: (arg0: GObject.ParamSpec) => void;
    "notify::actor": (pspec: GObject.ParamSpec) => void;
    "notify::animatable": (pspec: GObject.ParamSpec) => void;
    "notify::auto-reverse": (pspec: GObject.ParamSpec) => void;
    "notify::delay": (pspec: GObject.ParamSpec) => void;
    "notify::direction": (pspec: GObject.ParamSpec) => void;
    "notify::duration": (pspec: GObject.ParamSpec) => void;
    "notify::frame-clock": (pspec: GObject.ParamSpec) => void;
    "notify::interval": (pspec: GObject.ParamSpec) => void;
    "notify::progress-mode": (pspec: GObject.ParamSpec) => void;
    "notify::remove-on-complete": (pspec: GObject.ParamSpec) => void;
    "notify::repeat-count": (pspec: GObject.ParamSpec) => void;
    paused: () => void;
    started: () => void;
    stopped: (arg0: boolean) => void;
    [key: `marker-reached::${string}`]: (arg0: string, arg1: number) => void;
    [key: `notify::${string}`]: (pspec: GObject.ParamSpec) => void;
}

Hierarchy (View Summary)

Indexable

  • [key: `marker-reached::${string}`]: (arg0: string, arg1: number) => void
  • [key: `notify::${string}`]: (pspec: GObject.ParamSpec) => void
Index

Properties

notify::actor notify::animatable notify::auto-reverse notify::delay notify::direction notify::duration notify::frame-clock notify::interval notify::progress-mode notify::remove-on-complete notify::repeat-count

Properties - Inherited from Clutter.Transition.SignalSignatures

completed marker-reached marker-reached::actor marker-reached::auto-reverse marker-reached::delay marker-reached::direction marker-reached::duration marker-reached::frame-clock marker-reached::progress-mode marker-reached::repeat-count new-frame notify paused started stopped

Properties

"notify::actor": (pspec: GObject.ParamSpec) => void
"notify::animatable": (pspec: GObject.ParamSpec) => void
"notify::auto-reverse": (pspec: GObject.ParamSpec) => void
"notify::delay": (pspec: GObject.ParamSpec) => void
"notify::direction": (pspec: GObject.ParamSpec) => void
"notify::duration": (pspec: GObject.ParamSpec) => void
"notify::frame-clock": (pspec: GObject.ParamSpec) => void
"notify::interval": (pspec: GObject.ParamSpec) => void
"notify::progress-mode": (pspec: GObject.ParamSpec) => void
"notify::remove-on-complete": (pspec: GObject.ParamSpec) => void
"notify::repeat-count": (pspec: GObject.ParamSpec) => void

Properties - Inherited from Clutter.Transition.SignalSignatures

completed: () => void

The signal is emitted when the timeline's elapsed time reaches the value of the Timeline.duration property.

This signal will be emitted even if the Clutter.Timeline is set to be repeating.

If you want to get notification on whether the Clutter.Timeline has been stopped or has finished its run, including its eventual repeats, you should use the Clutter.Timeline::stopped signal instead.

"marker-reached": (arg0: string, arg1: number) => void

The signal is emitted each time a timeline reaches a marker set with Timeline.add_marker_at_time.

This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the Clutter.Timeline::marker-reached signal for a specific marker with:

  clutter_timeline_add_marker_at_time (timeline, "foo", 500);
  clutter_timeline_add_marker_at_time (timeline, "bar", 750);

  g_signal_connect (timeline, "marker-reached",
                    G_CALLBACK (each_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::foo",
                    G_CALLBACK (foo_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::bar",
                    G_CALLBACK (bar_marker_reached), NULL);

In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively.

"marker-reached::actor": (arg0: string, arg1: number) => void

The signal is emitted each time a timeline reaches a marker set with Timeline.add_marker_at_time.

This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the Clutter.Timeline::marker-reached signal for a specific marker with:

  clutter_timeline_add_marker_at_time (timeline, "foo", 500);
  clutter_timeline_add_marker_at_time (timeline, "bar", 750);

  g_signal_connect (timeline, "marker-reached",
                    G_CALLBACK (each_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::foo",
                    G_CALLBACK (foo_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::bar",
                    G_CALLBACK (bar_marker_reached), NULL);

In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively.

"marker-reached::auto-reverse": (arg0: string, arg1: number) => void

The signal is emitted each time a timeline reaches a marker set with Timeline.add_marker_at_time.

This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the Clutter.Timeline::marker-reached signal for a specific marker with:

  clutter_timeline_add_marker_at_time (timeline, "foo", 500);
  clutter_timeline_add_marker_at_time (timeline, "bar", 750);

  g_signal_connect (timeline, "marker-reached",
                    G_CALLBACK (each_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::foo",
                    G_CALLBACK (foo_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::bar",
                    G_CALLBACK (bar_marker_reached), NULL);

In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively.

"marker-reached::delay": (arg0: string, arg1: number) => void

The signal is emitted each time a timeline reaches a marker set with Timeline.add_marker_at_time.

This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the Clutter.Timeline::marker-reached signal for a specific marker with:

  clutter_timeline_add_marker_at_time (timeline, "foo", 500);
  clutter_timeline_add_marker_at_time (timeline, "bar", 750);

  g_signal_connect (timeline, "marker-reached",
                    G_CALLBACK (each_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::foo",
                    G_CALLBACK (foo_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::bar",
                    G_CALLBACK (bar_marker_reached), NULL);

In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively.

"marker-reached::direction": (arg0: string, arg1: number) => void

The signal is emitted each time a timeline reaches a marker set with Timeline.add_marker_at_time.

This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the Clutter.Timeline::marker-reached signal for a specific marker with:

  clutter_timeline_add_marker_at_time (timeline, "foo", 500);
  clutter_timeline_add_marker_at_time (timeline, "bar", 750);

  g_signal_connect (timeline, "marker-reached",
                    G_CALLBACK (each_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::foo",
                    G_CALLBACK (foo_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::bar",
                    G_CALLBACK (bar_marker_reached), NULL);

In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively.

"marker-reached::duration": (arg0: string, arg1: number) => void

The signal is emitted each time a timeline reaches a marker set with Timeline.add_marker_at_time.

This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the Clutter.Timeline::marker-reached signal for a specific marker with:

  clutter_timeline_add_marker_at_time (timeline, "foo", 500);
  clutter_timeline_add_marker_at_time (timeline, "bar", 750);

  g_signal_connect (timeline, "marker-reached",
                    G_CALLBACK (each_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::foo",
                    G_CALLBACK (foo_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::bar",
                    G_CALLBACK (bar_marker_reached), NULL);

In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively.

"marker-reached::frame-clock": (arg0: string, arg1: number) => void

The signal is emitted each time a timeline reaches a marker set with Timeline.add_marker_at_time.

This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the Clutter.Timeline::marker-reached signal for a specific marker with:

  clutter_timeline_add_marker_at_time (timeline, "foo", 500);
  clutter_timeline_add_marker_at_time (timeline, "bar", 750);

  g_signal_connect (timeline, "marker-reached",
                    G_CALLBACK (each_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::foo",
                    G_CALLBACK (foo_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::bar",
                    G_CALLBACK (bar_marker_reached), NULL);

In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively.

"marker-reached::progress-mode": (arg0: string, arg1: number) => void

The signal is emitted each time a timeline reaches a marker set with Timeline.add_marker_at_time.

This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the Clutter.Timeline::marker-reached signal for a specific marker with:

  clutter_timeline_add_marker_at_time (timeline, "foo", 500);
  clutter_timeline_add_marker_at_time (timeline, "bar", 750);

  g_signal_connect (timeline, "marker-reached",
                    G_CALLBACK (each_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::foo",
                    G_CALLBACK (foo_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::bar",
                    G_CALLBACK (bar_marker_reached), NULL);

In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively.

"marker-reached::repeat-count": (arg0: string, arg1: number) => void

The signal is emitted each time a timeline reaches a marker set with Timeline.add_marker_at_time.

This signal is detailed with the name of the marker as well, so it is possible to connect a callback to the Clutter.Timeline::marker-reached signal for a specific marker with:

  clutter_timeline_add_marker_at_time (timeline, "foo", 500);
  clutter_timeline_add_marker_at_time (timeline, "bar", 750);

  g_signal_connect (timeline, "marker-reached",
                    G_CALLBACK (each_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::foo",
                    G_CALLBACK (foo_marker_reached), NULL);
  g_signal_connect (timeline, "marker-reached::bar",
                    G_CALLBACK (bar_marker_reached), NULL);

In the example, the first callback will be invoked for both the "foo" and "bar" marker, while the second and third callbacks will be invoked for the "foo" or "bar" markers, respectively.

"new-frame": (arg0: number) => void

The signal is emitted for each timeline running timeline before a new frame is drawn to give animations a chance to update the scene.

notify: (arg0: GObject.ParamSpec) => void

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with GObject.ParamFlags.EXPLICIT_NOTIFY, then any call to g_object_set_property() results in ::notify being emitted, even if the new value is the same as the old. If they did pass GObject.ParamFlags.EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use [canonical parameter names][class@GObject.ParamSpec#parameter-names] as detail strings for the notify signal.

paused: () => void

The signal is emitted when Timeline.pause is invoked.

started: () => void

The signal is emitted when the timeline starts its run. This might be as soon as Timeline.start is invoked or after the delay set in the Timeline.delay property has expired.

stopped: (arg0: boolean) => void

The signal is emitted when the timeline has been stopped, either because Timeline.stop has been called, or because it has been exhausted.

This is different from the Clutter.Timeline::completed signal, which gets emitted after every repeat finishes.

If the Clutter.Timeline has is marked as infinitely repeating, this signal will never be emitted.