Gjsify LogoGjsify Logo

The #ClutterTimeline structure contains only private data and should be accessed using the provided API

Hierarchy

Index

Constructors

Properties

autoReverse: boolean

If the direction of the timeline should be automatically reversed when reaching the end.

delay: number

A delay, in milliseconds, that should be observed by the timeline before actually starting.

The direction of the timeline, either %CLUTTER_TIMELINE_FORWARD or %CLUTTER_TIMELINE_BACKWARD.

duration: number

Duration of the timeline in milliseconds, depending on the ClutterTimeline:fps value.

gTypeInstance: TypeInstance
loop: boolean

Whether the timeline should automatically rewind and restart.

As a side effect, setting this property to %TRUE will set the #ClutterTimeline:repeat-count property to -1, while setting this property to %FALSE will set the #ClutterTimeline:repeat-count property to 0.

progressMode: Clutter.AnimationMode

Controls the way a #ClutterTimeline computes the normalized progress.

repeatCount: number

Defines how many times the timeline should repeat.

If the repeat count is 0, the timeline does not repeat.

If the repeat count is set to -1, the timeline will repeat until it is stopped.

name: string

Methods

  • addMarker(markerName: string, progress: number): void
  • Adds a named marker that will be hit when the timeline has reached the specified progress.

    Markers are unique string identifiers for a given position on the timeline. Once timeline reaches the given progress of its duration, if will emit a ::marker-reached signal for each marker attached to that particular point.

    A marker can be removed with clutter_timeline_remove_marker(). The timeline can be advanced to a marker using clutter_timeline_advance_to_marker().

    See also: clutter_timeline_add_marker_at_time()

    Parameters

    • markerName: string

      the unique name for this marker

    • progress: number

      the normalized value of the position of the martke

    Returns void

  • addMarkerAtTime(markerName: string, msecs: number): void
  • Adds a named marker that will be hit when the timeline has been running for msecs milliseconds.

    Markers are unique string identifiers for a given position on the timeline. Once timeline reaches the given msecs, it will emit a ::marker-reached signal for each marker attached to that position.

    A marker can be removed with clutter_timeline_remove_marker(). The timeline can be advanced to a marker using clutter_timeline_advance_to_marker().

    See also: clutter_timeline_add_marker()

    Parameters

    • markerName: string

      the unique name for this marker

    • msecs: number

      position of the marker in milliseconds

    Returns void

  • advance(msecs: number): void
  • Advance timeline to the requested point. The point is given as a time in milliseconds since the timeline started.

    The timeline will not emit the #ClutterTimeline::new-frame signal for the given time. The first ::new-frame signal after the call to clutter_timeline_advance() will be emit the skipped markers.

    Parameters

    • msecs: number

      Time to advance to

    Returns void

  • advanceToMarker(markerName: string): void
  • Advances timeline to the time of the given marker_name.

    Like clutter_timeline_advance(), this function will not emit the #ClutterTimeline::new-frame for the time where marker_name is set, nor it will emit #ClutterTimeline::marker-reached for marker_name.

    Parameters

    • markerName: string

      the name of the marker

    Returns void

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • Create a new #ClutterTimeline instance which has property values matching that of supplied timeline. The cloned timeline will not be started and will not be positioned to the current position of the original timeline: you will have to start it with clutter_timeline_start().

    The only cloned properties are:

    • #ClutterTimeline:duration
    • #ClutterTimeline:loop
    • #ClutterTimeline:delay
    • #ClutterTimeline:direction

    Returns Clutter.Timeline

  • connect(sigName: "completed", callback: Timeline_CompletedSignalCallback): number
  • connect(sigName: "marker-reached", callback: Timeline_MarkerReachedSignalCallback): number
  • connect(sigName: "new-frame", callback: Timeline_NewFrameSignalCallback): number
  • connect(sigName: "paused", callback: Timeline_PausedSignalCallback): number
  • connect(sigName: "started", callback: Timeline_StartedSignalCallback): number
  • connect(sigName: "stopped", callback: Timeline_StoppedSignalCallback): number
  • connect(sigName: "notify::auto-reverse", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::delay", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::direction", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::duration", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::loop", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::progress-mode", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::repeat-count", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • emit(sigName: "completed", ...args: any[]): void
  • emit(sigName: "marker-reached", msecs: number, ...args: any[]): void
  • emit(sigName: "new-frame", ...args: any[]): void
  • emit(sigName: "paused", ...args: any[]): void
  • emit(sigName: "started", ...args: any[]): void
  • emit(sigName: "stopped", ...args: any[]): void
  • emit(sigName: "notify::auto-reverse", ...args: any[]): void
  • emit(sigName: "notify::delay", ...args: any[]): void
  • emit(sigName: "notify::direction", ...args: any[]): void
  • emit(sigName: "notify::duration", ...args: any[]): void
  • emit(sigName: "notify::loop", ...args: any[]): void
  • emit(sigName: "notify::progress-mode", ...args: any[]): void
  • emit(sigName: "notify::repeat-count", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

    • sigName: "completed"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "marker-reached"
    • msecs: number
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "new-frame"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "paused"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "started"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "stopped"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::auto-reverse"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::delay"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::direction"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::duration"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::loop"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::progress-mode"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: "notify::repeat-count"
    • Rest ...args: any[]

    Returns void

  • Parameters

    • sigName: string
    • Rest ...args: any[]

    Returns void

  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freezeNotify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • getAutoReverse(): boolean
  • Retrieves the value set by clutter_timeline_set_auto_reverse().

    Returns boolean

  • getCurrentRepeat(): number
  • Retrieves the current repeat for a timeline.

    Repeats start at 0.

    Returns number

  • getData(key?: string): object
  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Optional key: string

      name of the key for that association

    Returns object

  • getDelay(): number
  • getDelta(): number
  • Retrieves the amount of time elapsed since the last ClutterTimeline::new-frame signal.

    This function is only useful inside handlers for the ::new-frame signal, and its behaviour is undefined if the timeline is not playing.

    Returns number

  • getDuration(): number
  • Retrieves the duration of a #ClutterTimeline in milliseconds. See clutter_timeline_set_duration().

    Returns number

  • getDurationHint(): number
  • Retrieves the full duration of the timeline, taking into account the current value of the #ClutterTimeline:repeat-count property.

    If the #ClutterTimeline:repeat-count property is set to -1, this function will return %G_MAXINT64.

    The returned value is to be considered a hint, and it's only valid as long as the timeline hasn't been changed.

    Returns number

  • getElapsedTime(): number
  • getId(): string
  • getLoop(): boolean
  • getProgress(): number
  • The position of the timeline in a normalized [-1, 2] interval.

    The return value of this function is determined by the progress mode set using clutter_timeline_set_progress_mode(), or by the progress function set using clutter_timeline_set_progress_func().

    Returns number

  • getProperty(propertyName?: string, value?: any): void
  • Gets a property of an object.

    The value can be:

    • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a #GValue initialized with the expected type of the property
    • a #GValue initialized with a type to which the expected type of the property can be transformed

    In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

    Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

    Parameters

    • Optional propertyName: string

      the name of the property to get

    • Optional value: any

      return location for the property value

    Returns void

  • getQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • getRepeatCount(): number
  • Retrieves the number set using clutter_timeline_set_repeat_count().

    Returns number

  • getStepProgress(): [boolean, number, StepMode]
  • getv(names: string[], values: any[]): void
  • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

    Parameters

    • names: string[]

      the names of each property to get

    • values: any[]

      the values of each property to get

    Returns void

  • hasMarker(markerName: string): boolean
  • Checks whether timeline has a marker set with the given name.

    Parameters

    • markerName: string

      the name of the marker

    Returns boolean

  • isFloating(): boolean
  • isPlaying(): boolean
  • listMarkers(msecs: number): string[]
  • Retrieves the list of markers at time msecs. If msecs is a negative integer, all the markers attached to timeline will be returned.

    Parameters

    • msecs: number

      the time to check, or -1

    Returns string[]

  • notify(propertyName: string): void
  • Emits a "notify" signal for the property property_name on object.

    When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

    Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

    Parameters

    • propertyName: string

      the name of a property installed on the class of object.

    Returns void

  • Emits a "notify" signal for the property specified by pspec on object.

    This function omits the property name lookup, hence it is faster than g_object_notify().

    One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

      enum
    {
    PROP_0,
    PROP_FOO,
    PROP_LAST
    };

    static GParamSpec *properties[PROP_LAST];

    static void
    my_object_class_init (MyObjectClass *klass)
    {
    properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
    0, 100,
    50,
    G_PARAM_READWRITE);
    g_object_class_install_property (gobject_class,
    PROP_FOO,
    properties[PROP_FOO]);
    }

    and then notify a change on the "foo" property with:

      g_object_notify_by_pspec (self, properties[PROP_FOO]);
    

    Parameters

    • pspec: ParamSpec

      the #GParamSpec of a property installed on the class of object.

    Returns void

  • off(sigName: "completed", callback: Timeline_CompletedSignalCallback): EventEmitter
  • off(sigName: "marker-reached", callback: Timeline_MarkerReachedSignalCallback): EventEmitter
  • off(sigName: "new-frame", callback: Timeline_NewFrameSignalCallback): EventEmitter
  • off(sigName: "paused", callback: Timeline_PausedSignalCallback): EventEmitter
  • off(sigName: "started", callback: Timeline_StartedSignalCallback): EventEmitter
  • off(sigName: "stopped", callback: Timeline_StoppedSignalCallback): EventEmitter
  • off(sigName: "notify::auto-reverse", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::delay", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::direction", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::duration", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::loop", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::progress-mode", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::repeat-count", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::auto-reverse"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::delay"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::direction"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::duration"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::loop"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::progress-mode"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::repeat-count"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: "completed", callback: Timeline_CompletedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "marker-reached", callback: Timeline_MarkerReachedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "new-frame", callback: Timeline_NewFrameSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "paused", callback: Timeline_PausedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "started", callback: Timeline_StartedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "stopped", callback: Timeline_StoppedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::auto-reverse", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::delay", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::direction", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::duration", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::loop", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::progress-mode", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::repeat-count", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::auto-reverse"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::delay"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::direction"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::duration"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::loop"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::progress-mode"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::repeat-count"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: "completed", callback: Timeline_CompletedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "marker-reached", callback: Timeline_MarkerReachedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "new-frame", callback: Timeline_NewFrameSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "paused", callback: Timeline_PausedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "started", callback: Timeline_StartedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "stopped", callback: Timeline_StoppedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::auto-reverse", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::delay", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::direction", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::duration", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::loop", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::progress-mode", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::repeat-count", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    • sigName: "notify::auto-reverse"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::delay"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::direction"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::duration"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::loop"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::progress-mode"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::repeat-count"
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: string
    • callback: ((...args: any[]) => void)
        • (...args: any[]): void
        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parses the passed JSON node. The implementation must set the type of the passed #GValue pointer using g_value_init().

    Parameters

    • script: Clutter.Script

      the #ClutterScript creating the scriptable instance

    • value: any

      the generic value to be set

    • name: string

      the name of the node

    • node: Json.Node

      the JSON node to be parsed

    Returns boolean

  • pause(): void
  • Increases the reference count of object.

    Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

    Returns GObject.Object

  • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

    In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

    Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

    Returns GObject.Object

  • removeMarker(markerName: string): void
  • Removes marker_name, if found, from timeline.

    Parameters

    • markerName: string

      the name of the marker to remove

    Returns void

  • rewind(): void
  • Rewinds #ClutterTimeline to the first frame if its direction is %CLUTTER_TIMELINE_FORWARD and the last frame if it is %CLUTTER_TIMELINE_BACKWARD.

    Returns void

  • runDispose(): void
  • Releases all references to other objects. This can be used to break reference cycles.

    This function should only be called from object system implementations.

    Returns void

  • setAutoReverse(reverse: boolean): void
  • Sets whether timeline should reverse the direction after the emission of the #ClutterTimeline::completed signal.

    Setting the #ClutterTimeline:auto-reverse property to %TRUE is the equivalent of connecting a callback to the #ClutterTimeline::completed signal and changing the direction of the timeline from that callback; for instance, this code:

    |[ static void reverse_timeline (ClutterTimeline *timeline) { ClutterTimelineDirection dir = clutter_timeline_get_direction (timeline);

    if (dir == CLUTTER_TIMELINE_FORWARD) dir = CLUTTER_TIMELINE_BACKWARD; else dir = CLUTTER_TIMELINE_FORWARD;

    clutter_timeline_set_direction (timeline, dir); } ... timeline = clutter_timeline_new (1000); clutter_timeline_set_repeat_count (timeline, -1); g_signal_connect (timeline, "completed", G_CALLBACK (reverse_timeline), NULL);



    can be effectively replaced by:

    |[
    timeline = clutter_timeline_new (1000);
    clutter_timeline_set_repeat_count (timeline, -1);
    clutter_timeline_set_auto_reverse (timeline);

    Parameters

    • reverse: boolean

      %TRUE if the timeline should reverse the direction

    Returns void

  • Sets the #ClutterTimeline:progress-mode of timeline to %CLUTTER_CUBIC_BEZIER, and sets the two control points for the cubic bezier.

    The cubic bezier curve is between (0, 0) and (1, 1). The X coordinate of the two control points must be in the [ 0, 1 ] range, while the Y coordinate of the two control points can exceed this range.

    Parameters

    • c1: Clutter.Point

      the first control point for the cubic bezier

    • c2: Clutter.Point

      the second control point for the cubic bezier

    Returns void

  • setCustomProperty(script: Clutter.Script, name: string, value: any): void
  • Overrides the common properties setting. The underlying virtual function should be used when implementing custom properties.

    Parameters

    • script: Clutter.Script

      the #ClutterScript creating the scriptable instance

    • name: string

      the name of the property

    • value: any

      the value of the property

    Returns void

  • setData(key: string, data?: object): void
  • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

    If the object already had an association with that name, the old association will be destroyed.

    Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

    Parameters

    • key: string

      name of the key

    • Optional data: object

      data to associate with that key

    Returns void

  • setDelay(msecs: number): void
  • Sets the delay, in milliseconds, before timeline should start.

    Parameters

    • msecs: number

      delay in milliseconds

    Returns void

  • Sets the direction of timeline, either %CLUTTER_TIMELINE_FORWARD or %CLUTTER_TIMELINE_BACKWARD.

    Parameters

    Returns void

  • setDuration(msecs: number): void
  • Sets the duration of the timeline, in milliseconds. The speed of the timeline depends on the ClutterTimeline:fps setting.

    Parameters

    • msecs: number

      duration of the timeline in milliseconds

    Returns void

  • setId(id: string): void
  • Sets id_ as the unique Clutter script it for this instance of #ClutterScriptableIface.

    This name can be used by user interface designer applications to define a unique name for an object constructable using the UI definition language parsed by #ClutterScript.

    Parameters

    • id: string

      the #ClutterScript id of the object

    Returns void

  • setLoop(loop: boolean): void
  • Sets whether timeline should loop.

    This function is equivalent to calling clutter_timeline_set_repeat_count() with -1 if loop is %TRUE, and with 0 if loop is %FALSE.

    Parameters

    • loop: boolean

      %TRUE for enable looping

    Returns void

  • Sets a custom progress function for timeline. The progress function will be called by clutter_timeline_get_progress() and will be used to compute the progress value based on the elapsed time and the total duration of the timeline.

    If func is not %NULL, the #ClutterTimeline:progress-mode property will be set to %CLUTTER_CUSTOM_MODE.

    If func is %NULL, any previously set progress function will be unset, and the #ClutterTimeline:progress-mode property will be set to %CLUTTER_LINEAR.

    Parameters

    Returns void

  • Sets the progress function using a value from the #ClutterAnimationMode enumeration. The mode cannot be %CLUTTER_CUSTOM_MODE or bigger than %CLUTTER_ANIMATION_LAST.

    Parameters

    Returns void

  • setProperty(propertyName: string, value?: any): void
  • Sets a property on an object.

    Parameters

    • propertyName: string

      the name of the property to set

    • Optional value: any

      the value

    Returns void

  • setRepeatCount(count: number): void
  • Sets the number of times the timeline should repeat.

    If count is 0, the timeline never repeats.

    If count is -1, the timeline will always repeat until it's stopped.

    Parameters

    • count: number

      the number of times the timeline should repeat

    Returns void

  • setStepProgress(nSteps: number, stepMode: StepMode): void
  • Sets the #ClutterTimeline:progress-mode of the timeline to %CLUTTER_STEPS and provides the parameters of the step function.

    Parameters

    • nSteps: number

      the number of steps

    • stepMode: StepMode

      whether the change should happen at the start or at the end of the step

    Returns void

  • skip(msecs: number): void
  • Advance timeline by the requested time in milliseconds

    Parameters

    • msecs: number

      Amount of time to skip

    Returns void

  • start(): void
  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • stop(): void
  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    • propertyName: string

      name of a property to look up.

    Returns ParamSpec

  • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

    This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

    If pspec is a floating reference, it will be consumed.

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface.

    • pspec: ParamSpec

      the #GParamSpec for the new property

    Returns void

  • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

    Parameters

    • gIface: TypeInterface

      any interface vtable for the interface, or the default vtable for the interface

    Returns ParamSpec[]

  • Creates a new instance of a #GObject subtype and sets its properties.

    Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

    Parameters

    • objectType: GType<unknown>

      the type id of the #GObject subtype to instantiate

    • parameters: GObject.Parameter[]

      an array of #GParameter

    Returns GObject.Object

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method