Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

gTypeInstance: TypeInstance
object: GObject.Object
name: string

Methods

  • 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

  • cancel(id: number): boolean
  • Cancels a job not yet executed. This may fail for the following reasons: the job id could not be found, either because it has already been treated or because it does not exist or because it was created in another thread the job id is currently being treated by the worker thread

    Parameters

    • id: number

      the ID of a job as returned by gda_thread_wrapper_execute() or gda_thread_wrapper_execute_void()

    Returns boolean

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

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

          • Rest ...args: any[]

          Returns void

    Returns number

  • connectRaw(instance: object, sigName: string, privateThread: boolean, privateJob: boolean, callback: ThreadWrapperCallback): number
  • Connects a callback function to a signal for a particular object. The difference with g_signal_connect() and similar functions are: the callback argument is not a #GCallback function, so the callback signature is not dependent on the signal itself the signal handler must not have to return any value the callback function will be called asynchronously, the caller may need to use gda_thread_wrapper_iterate() to get the notification if private_job and private_thread control in which case the signal is propagated.

    Also note that signal handling is done asynchronously: when emitted in the worker thread, it will be "queued" to be processed in the user thread when it has the chance (when gda_thread_wrapper_iterate() is called directly or indirectly). The side effect is that the callback function is usually called long after the object emitting the signal has finished emitting it.

    To disconnect a signal handler, don't use any of the g_signal_handler_*() functions but the gda_thread_wrapper_disconnect() method.

    Parameters

    • instance: object

      the instance to connect to

    • sigName: string

      a string of the form "signal-name::detail"

    • privateThread: boolean

      set to %TRUE if callback is to be invoked only if the signal has been emitted while in wrapper's private sub thread (ie. used when wrapper is executing some functions specified by gda_thread_wrapper_execute() or gda_thread_wrapper_execute_void()), and to %FALSE if the callback is to be invoked whenever the signal is emitted, independently of the thread in which the signal is emitted.

    • privateJob: boolean

      set to %TRUE if callback is to be invoked only if the signal has been emitted when a job created for the calling thread is being executed, and to %FALSE if callback has to be called whenever the sig_name signal is emitted by instance. Note that this argument is not taken into account if private_thread is set to %FALSE.

    • callback: ThreadWrapperCallback

      a #GdaThreadWrapperCallback function

    Returns number

  • disconnect(id: number): void
  • Disconnects the emission of a signal, does the opposite of gda_thread_wrapper_connect_raw().

    As soon as this method returns, the callback function set when gda_thread_wrapper_connect_raw() was called will not be called anymore (even if the object has emitted the signal in the worker thread and this signal has not been handled in the user thread).

    Parameters

    • id: number

      a handler ID, as returned by gda_thread_wrapper_connect_raw()

    Returns void

  • emit(sigName: string, ...args: any[]): void
  • Make wrapper execute the func function with the arg argument (along with a #GError which is not error) in the sub thread managed by wrapper. To execute a function which does not return anything, use gda_thread_wrapper_execute_void().

    This method returns immediately, and the caller then needs to use gda_thread_wrapper_fetch_result() to check if the execution has finished and get the result.

    Once func's execution is finished, if arg is not %NULL, the arg_destroy_func destruction function is called on arg. This call occurs in the thread calling gda_thread_wrapper_fetch_result().

    If an error occurred in this function, then the arg_destroy_func function is not called to free arg.

    Parameters

    • func: ThreadWrapperFunc

      the function to execute, not %NULL

    • arg: object

      argument to pass to func, or %NULL

    Returns number

  • Make wrapper execute the func function with the arg argument (along with a #GError which is not error) in the sub thread managed by wrapper. To execute a function which returns some pointer, use gda_thread_wrapper_execute().

    This method returns immediately. Calling gda_thread_wrapper_fetch_result() is not necessary as func does not return any result. However, it may be necessary to call gda_thread_wrapper_iterate() to give wrapper a chance to execute the arg_destroy_func function if not %NULL (note that gda_thread_wrapper_iterate() is called by gda_thread_wrapper_fetch_result() itself).

    Once func's execution is finished, if arg is not %NULL, the arg_destroy_func destruction function is called on arg. This call occurs in the thread calling gda_thread_wrapper_fetch_result().

    If an error occurred in this function, then the arg_destroy_func function is not called to free arg.

    Parameters

    Returns number

  • fetchResult(mayLock: boolean, expId: number): object
  • Use this method to check if the execution of a function is finished. The function's execution must have been requested using gda_thread_wrapper_execute().

    Parameters

    • mayLock: boolean

      TRUE if this funct must lock the caller untill a result is available

    • expId: number

      ID of the job for which a result is expected

    Returns object

  • 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

  • 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

  • Allow wrapper to notify when an execution job is finished, by making its exec ID readable through a new #GIOChannel. This function is useful when the notification needs to be included into a main loop. This also notifies that signals (emitted by objects in wrapper's internal thread) are available.

    The returned #GIOChannel will have something to read everytime an execution job is finished for an execution job submitted from the calling thread. The user whould read #GdaThreadNotification structures from the channel and analyse its contents to call gda_thread_wrapper_iterate() or gda_thread_wrapper_fetch_result().

    Note1: the new communication channel will only be operational for jobs submitted after this function returns, and for signals which have been connected after this function returns. A safe practice is to call this function before the wrapper object has been used.

    Note2: this function will return the same #GIOChannel everytime it's called from the same thread.

    Note3: if the usage of the returned #GIOChannel reveals an error, then g_io_channel_shutdown() and g_io_channel_unref() should be called on the #GIOChannel to let wrapper know it should not use that object anymore.

    Returns IOChannel

  • 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

  • getWaitingSize(): number
  • Use this method to query the number of functions which have been queued to be executed but which have not yet been executed.

    Returns number

  • 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

  • isFloating(): boolean
  • iterate(mayBlock: boolean): void
  • This method gives wrapper a chance to check if some functions to be executed have finished for the calling thread. In this case it handles the execution result and makes it ready to be processed using gda_thread_wrapper_fetch_result().

    This method also allows wrapper to handle signals which may have been emitted by objects while in the worker thread, and call the callback function specified when gda_thread_wrapper_connect_raw() was used.

    If may_block is %TRUE, then it will block untill there is one finished execution (functions returning void and signals are ignored regarding this argument).

    Parameters

    • mayBlock: boolean

      whether the call may block

    Returns void

  • 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: string, callback: ((...args: any[]) => void)): EventEmitter
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    Returns EventEmitter

  • on(sigName: string, callback: ((...args: any[]) => void), after?: boolean): EventEmitter
  • Parameters

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

          • Rest ...args: any[]

          Returns void

    • Optional after: boolean

    Returns EventEmitter

  • once(sigName: string, callback: ((...args: any[]) => void), after?: boolean): 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

  • 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

  • stealSignal(id: number): void
  • Requests that the signal which ID is id (which has been obtained using gda_thread_wrapper_connect_raw()) be treated by the calling thread instead of by the thread in which gda_thread_wrapper_connect_raw() was called.

    Parameters

    • id: number

      a signal ID

    Returns 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

  • unsetIoChannel(): void
  • Does the opposite of gda_thread_wrapper_get_io_channel()

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