Gjsify LogoGjsify Logo

Contains only private data that should be read and manipulated using the functions below.

Hierarchy

Index

Constructors

Properties

backendPerProcess: number
gTypeInstance: TypeInstance
registry: SourceRegistry
reloadSupported: boolean
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

  • constructPath(): string
  • emit(sigName: "files-loaded", ...args: any[]): void
  • emit(sigName: "load-error", error: GLib.Error, ...args: any[]): void
  • emit(sigName: "source-added", ...args: any[]): void
  • emit(sigName: "source-removed", ...args: any[]): void
  • emit(sigName: "tweak-key-file", uid: string, ...args: any[]): void
  • emit(sigName: "notify::backend-per-process", ...args: any[]): void
  • emit(sigName: "notify::registry", ...args: any[]): void
  • emit(sigName: "notify::reload-supported", ...args: any[]): void
  • emit(sigName: string, ...args: any[]): void
  • Examines source and its ancestors and returns the "deepest" #ESource having an #ESourceExtension with the given extension_name. If neither source nor any of its ancestors have such an extension, the function returns %NULL.

    This function is useful in cases when an #ESourceExtension is meant to apply to both the #ESource it belongs to and the #ESource's descendants.

    A common example is the #ESourceCollection extension, where descendants of an #ESource having an #ESourceCollection extension are implied to be members of that collection. In that example, this function can be used to test whether source is a member of a collection.

    The returned #ESource is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

    Note the function returns the #ESource containing the #ESourceExtension instead of the #ESourceExtension itself because extension instances are not to be referenced directly (see e_source_get_extension()).

    Parameters

    • source: EDataServer.Source

      an #ESource

    • extensionName: string

      the extension name to find

    Returns EDataServer.Source

  • 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

  • Asynchronously obtains the OAuth 2.0 access token for source along with its expiry in seconds from the current time (or 0 if unknown).

    When the operation is finished, callback will be called. You can then call e_oauth2_support_get_access_token_finish() to get the result of the operation.

    Parameters

    Returns void

  • getAccessTokenFinish(result: AsyncResult): [boolean, string, number]
  • Finishes the operation started with e_oauth2_support_get_access_token().

    Free the returned access token with g_free() when finished with it. If an error occurred, the function will set error and return %FALSE.

    Parameters

    Returns [boolean, string, number]

  • Obtains the OAuth 2.0 access token for source along with its expiry in seconds from the current time (or 0 if unknown).

    Free the returned access token with g_free() when finished with it. If an error occurs, the function will set error and return %FALSE.

    Parameters

    Returns [boolean, string, number]

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

  • 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

  • getReloadSupported(): boolean
  • 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(): void
  • Increases the use count of server.

    Use this function to indicate that the server has a reason to continue to run. To cancel the hold, call e_dbus_server_release().

    Returns void

  • 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

  • isFloating(): boolean
  • Returns a list of #EExtension objects bound to extensible whose types are ancestors of extension_type. For a complete list of extension objects bound to extensible, pass %E_TYPE_EXTENSION.

    The list itself should be freed with g_list_free(). The extension objects are owned by extensible and should not be unreferenced.

    Parameters

    • extensionType: GType<unknown>

      the type of extensions to list

    Returns EDataServer.Extension[]

  • Lists the currently opened backends.

    The sources returned in the list are referenced for thread-safety. They must each be unreferenced with g_object_unref() when finished with them. Free the returned #GSList itself with g_slist_free().

    An easy way to free the list properly in one step is as follows:

    |[ g_slist_free_full (list, g_object_unref);

    
    

    Returns EBackend.Backend[]

  • Returns a list of registered sources, sorted by display name. If extension_name is given, restrict the list to sources having that extension name.

    The sources returned in the list are referenced for thread-safety. They must each be unreferenced with g_object_unref() when finished with them. Free the returned #GList itself with g_list_free().

    An easy way to free the list properly in one step is as follows:

    |[ g_list_free_full (list, g_object_unref);


    @param extensionName an extension name, or %NULL

    Parameters

    • extensionName: string

    Returns EDataServer.Source[]

  • Loads data source key files in path. Because multiple errors can occur when loading multiple files, error is only set if path can not be opened. If a key file fails to load, the error is broadcast through the #ESourceRegistryServer::load-error signal.

    If the #E_SOURCE_PERMISSION_REMOVABLE flag is given, then the server will emit signals on the D-Bus interface when key files are created or deleted in path.

    Parameters

    • path: string

      the path to the directory to load

    • flags: SourcePermissionFlags

      permission flags for files loaded from path

    Returns boolean

  • Emits the #ESourceRegistryServer::load-error signal.

    Parameters

    • file: Gio.File

      the #GFile that failed to load

    • error: GLib.Error

      a #GError describing the load error

    Returns void

  • loadExtensions(): void
  • Creates an instance of all instantiable subtypes of #EExtension which target the class of extensible. The lifetimes of these newly created #EExtension objects are bound to extensible such that they are finalized when extensible is finalized.

    Returns void

  • Creates an #ESource for a native key file and adds it to server. If an error occurs, the function returns %NULL and sets error.

    The returned #ESource is referenced for thread-safety. Unreference the #ESource with g_object_unref() when finished with it.

    Parameters

    Returns EDataServer.Source

  • loadModules(): void
  • This function should be called once during server initialization to load all available library modules to extend the server's functionality.

    Returns void

  • Loads data source key files from resource by enumerating the children at path and calling e_source_registry_server_load_file() on each child. Because multiple errors can occur when loading multiple files, error is only set if path is invalid. If a key file fails to load, the error is broadcast through the #ESourceRegistryServer::load-error signal.

    Parameters

    • resource: Gio.Resource

      a #GResource containing data source key files

    • path: string

      the path to the data source key files inside resource

    • flags: SourcePermissionFlags

      permission flags for files loaded from path

    Returns 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

  • Emits the #EDBusServer::quit signal with the given code.

    By default the server will quit its main loop and cause e_dbus_server_run() to return code.

    Parameters

    Returns 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

  • Returns the #ECollectionBackend associated with source, or %NULL if there is no #ECollectionBackend associated with source.

    An #ESource is associated with an #ECollectionBackend if the #ESource has an #ESourceCollection extension, or if it is a hierarchical descendant of another #ESource which has an #ESourceCollection extension.

    The returned #ECollectionBackend is referenced for thread-safety. Unreference the #ECollectionBackend with g_object_unref() when finished with it.

    Parameters

    Returns CollectionBackend

  • Returns the #ECollectionBackendFactory for source, if available. If source does not have an #ESourceCollection extension, or if the #ESourceCollection extension names an #ESourceBackend:backend-name for which there is no corresponding #ECollectionBackendFactory, the function returns %NULL.

    The returned #ECollectionBackendFactory is referenced for thread-safety. Unreference the #ECollectionBackendFactory with g_object_unref() when finished with it.

    Parameters

    Returns CollectionBackendFactory

  • Returns the #EBackendFactory for "backend_name:``extension_name", or %NULL if no such factory is registered.

    The returned #EBackendFactory is referenced for thread-safety. Unreference the #EBackendFactory with g_object_unref() when finished with it.

    Parameters

    • backendName: string

      a backend name

    • Optional extensionName: string

      an extension name

    Returns BackendFactory

  • Parameters

    • Rest ...args: any[]

    Returns any

  • Parameters

    • args_or_backendName: string | any[]
    • Optional extensionName: string

    Returns any

  • Returns the default #EOAuth2Support implementation, which can be used when the source doesn't have it overwritten.

    Free the returned object with g_object_unref(), when no longer needed.

    Returns OAuth2Support

  • 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

  • Looks up an #ESource in server by its unique identifier string.

    The returned #ESource is referenced for thread-safety and must be unreferenced with g_object_unref() when finished with it.

    Parameters

    • uid: string

      a unique identifier string

    Returns EDataServer.Source

  • release(): void
  • Decreates the use count of server.

    When the use count reaches zero, the server will stop running.

    Never call this function except to cancel the effect of a previous call to e_dbus_server_hold().

    Returns void

  • Emits the #EDBusServer::run signal.

    By default the server will start its main loop and attempt to acquire its well-known session bus name. If the server's main loop is already running, the function will immediately return #E_DBUS_SERVER_EXIT_NONE. Otherwise the function blocks until e_dbus_server_quit() is called.

    If wait_for_client is %TRUE, the server will continue running until the first client connection is made instead of quitting on its own if no client connection is made within the first few seconds.

    Parameters

    • waitForClient: boolean

      continue running until a client connects

    Returns DBusServerExitCode

  • 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
  • spawnSubprocessBackend(invocation: DBusMethodInvocation, uid: string, extensionName: string, subprocessPath: string): void
  • Spawns a new subprocess for a backend type and returns the object path of the new subprocess to the client, in the way the client can talk directly to the running backend. If the backend already has a subprocess running, the used object path is returned to the client.

    Parameters

    • invocation: DBusMethodInvocation

      a #GDBusMethodInvocation

    • uid: string

      an #ESource UID

    • extensionName: string

      an extension name

    • subprocessPath: string

      a path of an executable responsible for running the subprocess

    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

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