Gcr-4 ▶ Gcr ▶ Prompt

Internal$signals

_init

• _init(...args: any[]): void

  Parameters

  • ...args: any[]

  Returns void

bind_property

• bind_property(
      source_property: string,
      target: GObject.Object,
      target_property: string,
      flags: GObject.BindingFlags,
  ): GObject.Binding

  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);
  Copy

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

  If flags contains GObject.BindingFlags.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 GObject.Binding 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.Object can have multiple bindings.

  Parameters

  • source_property: string

    the property on source to bind

  • target: GObject.Object

    the target GObject.Object

  • target_property: string

    the property on target to bind

  • flags: GObject.BindingFlags

    flags to pass to GObject.Binding

  Returns GObject.Binding

  the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

bind_property_full

• bind_property_full(
      source_property: string,
      target: GObject.Object,
      target_property: string,
      flags: GObject.BindingFlags,
      transform_to?: BindingTransformFunc,
      transform_from?: BindingTransformFunc,
      notify?: DestroyNotify,
  ): GObject.Binding

  Complete version of g_object_bind_property().

  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.

  If flags contains GObject.BindingFlags.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 transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

  The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

  To remove the binding, call g_binding_unbind().

  A GObject.Object can have multiple bindings.

  The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

  Parameters

  • source_property: string

    the property on source to bind

  • target: GObject.Object

    the target GObject.Object

  • target_property: string

    the property on target to bind

  • flags: GObject.BindingFlags

    flags to pass to GObject.Binding

  • Optionaltransform_to: BindingTransformFunc

    the transformation function from the source to the target, or null to use the default

  • Optionaltransform_from: BindingTransformFunc

    the transformation function from the target to the source, or null to use the default

  • Optionalnotify: DestroyNotify

    a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

  Returns GObject.Binding

  the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

• bind_property_full(
      source_property: string,
      target: GObject.Object,
      target_property: string,
      flags: GObject.BindingFlags,
      transform_to: Closure<any, any>,
      transform_from: Closure<any, any>,
  ): GObject.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

  • source_property: string

    the property on source to bind

  • target: GObject.Object

    the target GObject.Object

  • target_property: string

    the property on target to bind

  • flags: GObject.BindingFlags

    flags to pass to GObject.Binding

  • transform_to: Closure<any, any>

    a GObject.Closure wrapping the transformation function from the source to the target, or null to use the default

  • transform_from: Closure<any, any>

    a GObject.Closure wrapping the transformation function from the target to the source, or null to use the default

  Returns GObject.Binding

  the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

block_signal_handler

• block_signal_handler(id: number): void

  Blocks a handler of an instance so it will not be called during any signal emissions

  Parameters

  • id: number

    Handler ID of the handler to be blocked

  Returns void

Signalconnect

• connect<K extends "notify">(
      signal: K,
      callback: SignalCallback<Gcr.Prompt, GObject.Object.SignalSignatures[K]>,
  ): number

  Type Parameters

  • K extends "notify"

  Parameters

  • signal: K
  • callback: SignalCallback<Gcr.Prompt, GObject.Object.SignalSignatures[K]>

  Returns number

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

  Parameters

  • signal: string
  • callback: (...args: any[]) => any

  Returns number

Signalconnect_after

• connect_after<K extends "notify">(
      signal: K,
      callback: SignalCallback<Gcr.Prompt, GObject.Object.SignalSignatures[K]>,
  ): number

  Type Parameters

  • K extends "notify"

  Parameters

  • signal: K
  • callback: SignalCallback<Gcr.Prompt, GObject.Object.SignalSignatures[K]>

  Returns number

• connect_after(signal: string, callback: (...args: any[]) => any): number

  Parameters

  • signal: string
  • callback: (...args: any[]) => any

  Returns number

disconnect

• disconnect(id: number): void

  Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

  Parameters

  • id: number

    Handler ID of the handler to be disconnected

  Returns void

Signalemit

• emit<K extends "notify">(
      signal: K,
      ...args: GjsParameters<GObject.Object.SignalSignatures[K]> extends [
          any,
          ...Q[],
      ]
          ? Q
          : never,
  ): void

  Type Parameters

  • K extends "notify"

  Parameters

  • signal: K
  • ...args: GjsParameters<GObject.Object.SignalSignatures[K]> extends [any, ...Q[]]
        ? Q
        : never

  Returns void

• emit(signal: string, ...args: any[]): void

  Parameters

  • signal: string
  • ...args: any[]

  Returns void

force_floating

• force_floating(): void

  This function is intended for GObject.Object implementations to re-enforce a floating 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

freeze_notify

• freeze_notify(): 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.Object::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

get_data

• get_data(key: string): any

  Gets a named field from the objects table of associations (see g_object_set_data()).

  Parameters

  • key: string

    name of the key for that association

  Returns any

  the data if found, or null if no such data exists.

get_property

• get_property(property_name: string, value: any): any

  Gets a property of an object.

  The value can be:

  • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
  • a GObject.Value initialized with the expected type of the property
  • a GObject.Value 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 GObject.Value.unset.

  Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

  Parameters

  • property_name: string

    The name of the property to get

  • value: any

    Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

  Returns any

get_qdata

• get_qdata(quark: number): any

  This function gets back user data pointers stored via g_object_set_qdata().

  Parameters

  • quark: number

    A GLib.Quark, naming the user data pointer

  Returns any

  The user data pointer set, or null

getv

• 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

is_floating

• is_floating(): boolean

  Checks whether object has a floating reference.

  Returns boolean

  true if object has a floating reference

notify

• notify(property_name: 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

  • property_name: string

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

  Returns void

notify_by_pspec

• notify_by_pspec(pspec: GObject.ParamSpec): 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.:

    typedef enum
    {
      PROP_FOO = 1,
      PROP_LAST
    } MyObjectProperty;
  
    static GParamSpec *properties[PROP_LAST];
  
    static void
    my_object_class_init (MyObjectClass *klass)
    {
      properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
                                               0, 100,
                                               50,
                                               G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
      g_object_class_install_property (gobject_class,
                                       PROP_FOO,
                                       properties[PROP_FOO]);
    }
  Copy

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

    g_object_notify_by_pspec (self, properties[PROP_FOO]);
  Copy

  Parameters

  • pspec: GObject.ParamSpec

    the GObject.ParamSpec of a property installed on the class of object.

  Returns void

ref

• ref(): GObject.Object

  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

  the same object

ref_sink

• ref_sink(): GObject.Object

  Increase the reference count of object, and possibly remove the floating 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

  object

run_dispose

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

set

• set(properties: { [key: string]: any }): void

  Sets multiple properties of an object at once. The properties argument should be a dictionary mapping property names to values.

  Parameters

  • properties: { [key: string]: any }

    Object containing the properties to set

  Returns void

set_data

• set_data(key: string, data?: any): 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 GLib.Quark 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 GLib.Quark storage growing unbounded.

  Parameters

  • key: string

    name of the key

  • Optionaldata: any

    data to associate with that key

  Returns void

set_property

• set_property(property_name: string, value: any): void

  Sets a property on an object.

  Parameters

  • property_name: string

    The name of the property to set

  • value: any

    The value to set the property to

  Returns void

steal_data

• steal_data(key: string): any

  Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

  Parameters

  • key: string

    name of the key

  Returns any

  the data if found, or null if no such data exists.

steal_qdata

• steal_qdata(quark: number): any

  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);
  }
  Copy

  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 GLib.Quark, naming the user data pointer

  Returns any

  The user data pointer set, or null

stop_emission_by_name

• stop_emission_by_name(detailedName: string): void

  Stops a signal's emission by the given signal name. This will prevent the default handler and any subsequent signal handlers from being invoked.

  Parameters

  • detailedName: string

    Name of the signal to stop emission of

  Returns void

thaw_notify

• thaw_notify(): 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.Object::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

unblock_signal_handler

• unblock_signal_handler(id: number): void

  Unblocks a handler so it will be called again during any signal emissions

  Parameters

  • id: number

    Handler ID of the handler to be unblocked

  Returns void

unref

• 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.Object 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.Object instance. Use g_clear_object() for this.

  Returns void

Virtualvfunc_constructed

• vfunc_constructed(): void

  the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

  Returns void

Virtualvfunc_dispatch_properties_changed

• vfunc_dispatch_properties_changed(
      n_pspecs: number,
      pspecs: GObject.ParamSpec,
  ): void

  emits property change notification for a bunch of properties. Overriding dispatch_properties_changed should be rarely needed.

  Parameters

  • n_pspecs: number
  • pspecs: GObject.ParamSpec

  Returns void

Virtualvfunc_dispose

• vfunc_dispose(): void

  the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

  Returns void

Virtualvfunc_finalize

• vfunc_finalize(): void

  instance finalization function, should finish the finalization of the instance begun in dispose and chain up to the finalize method of the parent class.

  Returns void

Virtualvfunc_get_property

• vfunc_get_property(
      property_id: number,
      value: any,
      pspec: GObject.ParamSpec,
  ): void

  the generic getter for all properties of this type. Should be overridden for every type with properties.

  Parameters

  • property_id: number
  • value: any
  • pspec: GObject.ParamSpec

  Returns void

Virtualvfunc_notify

• vfunc_notify(pspec: GObject.ParamSpec): 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

  • pspec: GObject.ParamSpec

  Returns void

Virtualvfunc_set_property

• vfunc_set_property(
      property_id: number,
      value: any,
      pspec: GObject.ParamSpec,
  ): void

  the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

  Parameters

  • property_id: number
  • value: any
  • pspec: GObject.ParamSpec

  Returns void

watch_closure

• watch_closure(closure: Closure): 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: Closure

    GObject.Closure to watch

  Returns void

Virtualvfunc_prompt_close

• vfunc_prompt_close(): void

  close a prompt

  Returns void

Virtualvfunc_prompt_confirm_async

• vfunc_prompt_confirm_async(
      cancellable?: Gio.Cancellable,
      callback?: AsyncReadyCallback<Gcr.Prompt>,
  ): void

  Prompts for confirmation asking a cancel/continue style question. Set the various properties on the prompt before calling this method to represent the question correctly.

  This method will return immediately and complete asynchronously.

  Parameters

  • Optionalcancellable: Gio.Cancellable

    optional cancellation object

  • Optionalcallback: AsyncReadyCallback<Gcr.Prompt>

    called when the operation completes

  Returns void

Virtualvfunc_prompt_confirm_finish

• vfunc_prompt_confirm_finish(result: Gio.AsyncResult): PromptReply

  Complete an operation to prompt for confirmation.

  Gcr.PromptReply.CONTINUE will be returned if the user confirms the prompt. The return value will also be Gcr.PromptReply.CANCEL if the user cancels or if an error occurs. Check the error argument to tell the difference.

  Parameters

  • result: Gio.AsyncResult

    asynchronous result passed to callback

  Returns PromptReply

Virtualvfunc_prompt_password_async

• vfunc_prompt_password_async(
      cancellable?: Gio.Cancellable,
      callback?: AsyncReadyCallback<Gcr.Prompt>,
  ): void

  Prompts for password. Set the various properties on the prompt before calling this method to explain which password should be entered.

  This method will return immediately and complete asynchronously.

  Parameters

  • Optionalcancellable: Gio.Cancellable

    optional cancellation object

  • Optionalcallback: AsyncReadyCallback<Gcr.Prompt>

    called when the operation completes

  Returns void

Virtualvfunc_prompt_password_finish

• vfunc_prompt_password_finish(result: Gio.AsyncResult): string

  Complete an operation to prompt for a password.

  A password will be returned if the user enters a password successfully. The returned password is valid until the next time a method is called to display another prompt.

  null will be returned if the user cancels or if an error occurs. Check the error argument to tell the difference.

  Parameters

  • result: Gio.AsyncResult

    asynchronous result passed to callback

  Returns string