Gjsify LogoGjsify Logo

The #IdeBuildPipeline is responsible for managing the build process for Builder. It consists of multiple build "phases" (see #IdeBuildPhase for the individual phases). An #IdeBuildStage can be attached with a priority to each phase and is the primary mechanism that plugins use to perform their operations in the proper ordering.

For example, the flatpak plugin provides its download stage as part of the %IDE_BUILD_PHASE_DOWNLOAD phase. The autotools plugin provides stages to phases such as %IDE_BUILD_PHASE_AUTOGEN, %IDE_BUILD_PHASE_CONFIGURE, %IDE_BUILD_PHASE_BUILD, and %IDE_BUILD_PHASE_INSTALL.

If you want ensure a particular phase is performed as part of a build, then fall ide_build_pipeline_request_phase() with the phase you are interested in seeing complete successfully.

If your plugin has discovered that something has changed that invalidates a given phase, use ide_build_pipeline_invalidate_phase() to ensure that the phase is re-executed the next time a requested phase of higher precidence is requested.

It can be useful to perform operations before or after a given stage (but still be executed as part of that stage) so the %IDE_BUILD_PHASE_BEFORE and %IDE_BUILD_PHASE_AFTER flags may be xor'd with the requested phase. If more precise ordering is required, you may use the priority parameter to order the operation with regards to other stages in that phase.

Transient stages may be added to the pipeline and they will be removed after the ide_build_pipeline_execute_async() operation has completed successfully or has failed. You can mark a stage as trandient with ide_build_stage_set_transient(). This may be useful to perform operations such as an "export tarball" stage which should only run once as determined by the user requesting a "make dist" style operation.

Hierarchy

Index

Constructors

Properties

busy: boolean

Gets the "busy" property. If %TRUE, the pipeline is busy executing.

configuration: Ide.Configuration

The configuration to use for the build pipeline.

context: Ide.Context
gTypeInstance: TypeInstance
message: string
parentInstance: GObject.Object
phase: BuildPhase

The current build phase during execution of the pipeline.

name: string

Methods

  • This can be used to add a regex that will extract errors from standard output. This is similar to the "errorformat" feature of vim to extract warnings from standard output.

    The regex should used named capture groups to pass information to the extraction process.

    Supported group names are:

    • filename (a string path) • line (an integer) • column (an integer) • level (a string) • message (a string)

    For example, to extract warnings from GCC you might do something like the following:

    "(?[a-zA-Z0-9\-\.\/]+):" "(?\d+):" "(?\d+): " "(?[\w\s]+): " "(?.*)"

    To remove the regex, use the ide_build_pipeline_remove_error_format() function with the resulting format id returned from this function.

    The resulting format id will be > 0 if successful.

    Parameters

    Returns number

  • 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

  • connect(sigName: "diagnostic", callback: BuildPipeline_DiagnosticSignalCallback): number
  • connect(sigName: "finished", callback: BuildPipeline_FinishedSignalCallback): number
  • connect(sigName: "started", callback: BuildPipeline_StartedSignalCallback): number
  • connect(sigName: "notify::busy", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::configuration", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::message", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::phase", callback: ((...args: any[]) => void)): number
  • connect(sigName: "notify::context", callback: ((...args: any[]) => void)): number
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • This creates a new stage that will spawn a process using launcher and log the output of stdin/stdout.

    It is a programmer error to modify launcher after passing it to this function.

    Parameters

    • phase: BuildPhase

      An #IdeBuildPhase

    • priority: number

      an optional priority for sorting within the phase

    • launcher: Ide.SubprocessLauncher

      An #IdeSubprocessLauncher

    Returns number

  • This is a convenience function to create a new #IdeSubprocessLauncher using the configuration and runtime associated with the pipeline.

    Returns Ide.SubprocessLauncher

  • disconnect(stageId: number): void
  • This removes the stage matching stage_id. You are returned a stage_id when inserting a stage with functions such as ide_build_pipeline_connect() or ide_build_pipeline_connect_launcher().

    Plugins should use this function to remove their stages when the plugin is unloading.

    Parameters

    • stageId: number

      An identifier returned from adding a stage

    Returns void

  • emit(sigName: "diagnostic", ...args: any[]): void
  • emit(sigName: "finished", ...args: any[]): void
  • emit(sigName: "started", ...args: any[]): void
  • emit(sigName: "notify::busy", ...args: any[]): void
  • emit(sigName: "notify::configuration", ...args: any[]): void
  • emit(sigName: "notify::message", ...args: any[]): void
  • emit(sigName: "notify::phase", ...args: any[]): void
  • emit(sigName: "notify::context", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Asynchronously starts the build pipeline.

    Any phase that has been invalidated up to the requested phase will be executed until a stage has failed.

    Upon completion, callback will be executed and should call ide_build_pipeline_execute_finish() to get the status of the operation.

    Parameters

    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

  • foreachStage(stageCallback: GLib.Func): void
  • This function will call stage_callback for every #IdeBuildStage registered in the pipeline.

    Parameters

    • stageCallback: GLib.Func

      A callback for each #IdePipelineStage

    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

  • getBuilddir(): string
  • Gets the "builddir" to be used for the build process. This is generally the location that build systems will use for out-of-tree builds.

    Returns string

  • getBusy(): boolean
  • 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

  • getMessage(): string
  • Gets the current message for the build pipeline. This can be shown to users in UI elements to signify progress in the build.

    Returns string

  • 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

  • getSrcdir(): string
  • Gets the "srcdir" of the project. This is equivalent to the IdeVcs:working-directory property as a string.

    Returns string

  • Gets the stage matching the identifier stage_id as returned from ide_build_pipeline_connect().

    Parameters

    • stageId: number

      the identfier of the stage

    Returns BuildStage

  • 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

  • hold(): boolean
  • This function will acquire a reference to the IdeContext that the object is a part of. This is useful if you are going to be doing a long running task (such as something in a thread) and want to ensure the context cannot be unloaded during your operation.

    You should call ide_object_release() an equivalent number of times to ensure the context may be freed afterwards.

    You should check the return value of this function to ensure that the context is not already in shutdown.

    Returns boolean

  • Initializes the object implementing the interface.

    This method is intended for language bindings. If writing in C, g_initable_new() should typically be used instead.

    The object must be initialized before any real use after initial construction, either with this function or g_async_initable_init_async().

    Implementations may also support cancellation. If cancellable is not %NULL, then initialization can be cancelled by triggering the cancellable object from another thread. If the operation was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. If cancellable is not %NULL and the object doesn't support cancellable initialization the error %G_IO_ERROR_NOT_SUPPORTED will be returned.

    If the object is not initialized, or initialization returns with an error, then all operations on the object except g_object_ref() and g_object_unref() are considered to be invalid, and have undefined behaviour. See the [introduction][ginitable] for more details.

    Callers should not assume that a class which implements #GInitable can be initialized multiple times, unless the class explicitly documents itself as supporting this. Generally, a class’ implementation of init() can assume (and assert) that it will only be called once. Previously, this documentation recommended all #GInitable implementations should be idempotent; that recommendation was relaxed in GLib 2.54.

    If a class explicitly supports being initialized multiple times, it is recommended that the method is idempotent: multiple calls with the same arguments should return the same results. Only the first call initializes the object; further calls return the result of the first call.

    One reason why a class might need to support idempotent initialization is if it is designed to be used via the singleton pattern, with a #GObjectClass.constructor that sometimes returns an existing instance. In this pattern, a caller would expect to be able to call g_initable_init() on the result of g_object_new(), regardless of whether it is in fact a new instance.

    Parameters

    • Optional cancellable: Gio.Cancellable

      optional #GCancellable object, %NULL to ignore.

    Returns boolean

  • Invalidates the phases matching phases flags.

    If the requested phases include the phases invalidated here, the next execution of the pipeline will execute thse phases.

    This should be used by plugins to ensure a particular phase is re-executed upon discovering its state is no longer valid. Such an example might be invalidating the %IDE_BUILD_PHASE_AUTOGEN phase when the an autotools projects autogen.sh file has been changed.

    Parameters

    Returns void

  • isFloating(): boolean
  • 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: "diagnostic", callback: BuildPipeline_DiagnosticSignalCallback): EventEmitter
  • off(sigName: "finished", callback: BuildPipeline_FinishedSignalCallback): EventEmitter
  • off(sigName: "started", callback: BuildPipeline_StartedSignalCallback): EventEmitter
  • off(sigName: "notify::busy", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::configuration", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::message", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::phase", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: "notify::context", callback: ((...args: any[]) => void)): EventEmitter
  • off(sigName: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • Parameters

    • sigName: "notify::context"
    • 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: "diagnostic", callback: BuildPipeline_DiagnosticSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "finished", callback: BuildPipeline_FinishedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "started", callback: BuildPipeline_StartedSignalCallback, after?: boolean): EventEmitter
  • on(sigName: "notify::busy", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::configuration", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::message", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::phase", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • on(sigName: "notify::context", 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

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::context"
    • 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: "diagnostic", callback: BuildPipeline_DiagnosticSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "finished", callback: BuildPipeline_FinishedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "started", callback: BuildPipeline_StartedSignalCallback, after?: boolean): EventEmitter
  • once(sigName: "notify::busy", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::configuration", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::message", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::phase", callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • once(sigName: "notify::context", 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

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • Parameters

    • sigName: "notify::context"
    • 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

  • 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

  • release(): void
  • Releases a successful hold on the context previously created with ide_object_hold().

    Returns void

  • removeErrorFormat(errorFormatId: number): boolean
  • Removes an error format that was registered with ide_build_pipeline_add_error_format().

    Parameters

    • errorFormatId: number

      an identifier for the error format.

    Returns boolean

  • removeLogObserver(observerId: number): boolean
  • Requests that the next execution of the pipeline will build up to phase including all stages that were previously invalidated.

    Parameters

    Returns boolean

  • 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

  • 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

  • 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

  • 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

  • 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

  • notifyInMain(instance: object, pspec: ParamSpec): void

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