@gtkx/ffi 0.9.1 → 0.9.2

package/dist/generated/gio/application.d.ts

@@ -93,7 +93,7 @@ export declare class Application extends GObject.GObject {
      */
     activate(): void;
     /**
-     * Add an option to be handled by @application.
+     * Add an option to be handled by `application`.
      *
      * Calling this function is the equivalent of calling
      * g_application_add_main_option_entries() with a single #GOptionEntry
@@ -115,13 +115,14 @@ export declare class Application extends GObject.GObject {
      */
     addMainOption(longName: string, shortName: number, flags: GLib.OptionFlags, arg: GLib.OptionArg, description: string, argDescription?: string): void;
     /**
-     * Adds main option entries to be handled by @application.
+     * Adds main option entries to be handled by `application`.
      *
      * This function is comparable to g_option_context_add_main_entries().
      *
      * After the commandline arguments are parsed, the
      * #GApplication::handle-local-options signal will be emitted.  At this
-     * point, the application can inspect the values pointed to by `arg_data` in the given #GOptionEntrys.
+     * point, the application can inspect the values pointed to by `arg_data`
+     * in the given #GOptionEntrys.
      *
      * Unlike #GOptionContext, #GApplication supports giving a %NULL
      * `arg_data` for a non-callback #GOptionEntry.  This results in the
@@ -174,7 +175,7 @@ export declare class Application extends GObject.GObject {
      */
     addMainOptionEntries(entries: number[]): void;
     /**
-     * Adds a #GOptionGroup to the commandline handling of @application.
+     * Adds a #GOptionGroup to the commandline handling of `application`.
      *
      * This function is comparable to g_option_context_add_group().
      *
@@ -207,14 +208,14 @@ export declare class Application extends GObject.GObject {
      * `property` on `object` is %TRUE.
      *
      * The binding holds a reference to `application` while it is active, but
-     * not to @object. Instead, the binding is destroyed when `object` is
+     * not to `object`. Instead, the binding is destroyed when `object` is
      * finalized.
      * @param object - a #GObject
-     * @param property - the name of a boolean property of @object
+     * @param property - the name of a boolean property of `object`
      */
     bindBusyProperty(object: GObject.GObject, property: string): void;
     /**
-     * Gets the unique identifier for @application.
+     * Gets the unique identifier for `application`.
      */
     getApplicationId(): string | null;
     /**
@@ -251,7 +252,7 @@ export declare class Application extends GObject.GObject {
      */
     getDbusObjectPath(): string | null;
     /**
-     * Gets the flags for @application.
+     * Gets the flags for `application`.
      *
      * See #GApplicationFlags.
      */
@@ -289,17 +290,17 @@ export declare class Application extends GObject.GObject {
      */
     getIsRemote(): boolean;
     /**
-     * Gets the resource base path of @application.
+     * Gets the resource base path of `application`.
      *
      * See g_application_set_resource_base_path() for more information.
      */
     getResourceBasePath(): string | null;
     /**
-     * Gets the version of @application.
+     * Gets the version of `application`.
      */
     getVersion(): string | null;
     /**
-     * Increases the use count of @application.
+     * Increases the use count of `application`.
      *
      * Use this function to indicate that the application has a reason to
      * continue to run.  For example, g_application_hold() is called by GTK
@@ -309,7 +310,7 @@ export declare class Application extends GObject.GObject {
      */
     hold(): void;
     /**
-     * Increases the busy count of @application.
+     * Increases the busy count of `application`.
      *
      * Use this function to indicate that the application is busy, for instance
      * while a long running operation is pending.
@@ -384,7 +385,8 @@ export declare class Application extends GObject.GObject {
      * case).
      *
      * In the event of an error (such as `cancellable` being cancelled, or a
-     * failure to connect to the session bus), %FALSE is returned and `error` is set appropriately.
+     * failure to connect to the session bus), %FALSE is returned and `error`
+     * is set appropriately.
      *
      * Note: the return value of this function is not an indicator that this
      * instance is or is not the primary instance of the application.  See
@@ -393,7 +395,7 @@ export declare class Application extends GObject.GObject {
      */
     register(cancellable?: Cancellable): boolean;
     /**
-     * Decrease the use count of @application.
+     * Decrease the use count of `application`.
      *
      * When the use count reaches zero, the application will stop running.
      *
@@ -406,7 +408,7 @@ export declare class Application extends GObject.GObject {
      *
      * This function is intended to be run from main() and its return value
      * is intended to be returned by main(). Although you are expected to pass
-     * the @argc, `argv` parameters from main() to this function, it is possible
+     * the `argc`, `argv` parameters from main() to this function, it is possible
      * to pass %NULL if `argv` is not available or commandline handling is not
      * required.  Note that on Windows, `argc` and `argv` are ignored, and
      * g_win32_get_command_line() is called internally (for proper support
@@ -498,7 +500,7 @@ export declare class Application extends GObject.GObject {
      * example, "new-message" might be appropriate for a notification about
      * new messages.
      *
-     * If a previous notification was sent with the same @id, it will be
+     * If a previous notification was sent with the same `id`, it will be
      * replaced with `notification` and shown again as if it was a new
      * notification. This works even for notifications sent from a previous
      * execution of the application, as long as `id` is the same string.
@@ -507,7 +509,7 @@ export declare class Application extends GObject.GObject {
      * notifications without an id.
      *
      * If `notification` is no longer relevant, it can be withdrawn with
-     * [method@Gio.Application.withdraw_notification].
+     * {@link Gio.Application.withdraw_notification}.
      *
      * It is an error to call this function if `application` has no
      * application ID.
@@ -522,33 +524,33 @@ export declare class Application extends GObject.GObject {
      */
     setActionGroup(actionGroup?: ActionGroup): void;
     /**
-     * Sets the unique identifier for @application.
+     * Sets the unique identifier for `application`.
      *
      * The application id can only be modified if `application` has not yet
      * been registered.
      *
      * If non-%NULL, the application id must be valid.  See
      * g_application_id_is_valid().
-     * @param applicationId - the identifier for @application
+     * @param applicationId - the identifier for `application`
      */
     setApplicationId(applicationId?: string): void;
     /**
      * Sets or unsets the default application for the process, as returned
      * by g_application_get_default().
      *
-     * This function does not take its own reference on @application.  If
+     * This function does not take its own reference on `application`.  If
      * `application` is destroyed then the default application will revert
      * back to %NULL.
      */
     setDefault(): void;
     /**
-     * Sets the flags for @application.
+     * Sets the flags for `application`.
      *
      * The flags can only be modified if `application` has not yet been
      * registered.
      *
      * See #GApplicationFlags.
-     * @param flags - the flags for @application
+     * @param flags - the flags for `application`
      */
     setFlags(flags: ApplicationFlags): void;
     /**
@@ -571,12 +573,12 @@ export declare class Application extends GObject.GObject {
      */
     setOptionContextDescription(description?: string): void;
     /**
-     * Sets the parameter string to be used by the commandline handling of @application.
+     * Sets the parameter string to be used by the commandline handling of `application`.
      *
      * This function registers the argument to be passed to g_option_context_new()
      * when the internal #GOptionContext of `application` is created.
      *
-     * See g_option_context_new() for more information about @parameter_string.
+     * See g_option_context_new() for more information about `parameter_string`.
      * @param parameterString - a string which is displayed
      */
     setOptionContextParameterString(parameterString?: string): void;
@@ -588,10 +590,10 @@ export declare class Application extends GObject.GObject {
      */
     setOptionContextSummary(summary?: string): void;
     /**
-     * Sets (or unsets) the base resource path of @application.
+     * Sets (or unsets) the base resource path of `application`.
      *
      * The path is used to automatically load various
-     * [application resources][struct@Gio.Resource] such as menu layouts and
+     * [application resources]{@link Gio.Resource} such as menu layouts and
      * action descriptions. The various types of resources will be found at
      * fixed names relative to the given base path.
      *
@@ -625,12 +627,12 @@ export declare class Application extends GObject.GObject {
      */
     setResourceBasePath(resourcePath?: string): void;
     /**
-     * Sets the version number of @application. This will be used to implement
+     * Sets the version number of `application`. This will be used to implement
      * a `--version` command line argument
      *
      * The application version can only be modified if `application` has not yet
      * been registered.
-     * @param version - the version of @application
+     * @param version - the version of `application`
      */
     setVersion(version: string): void;
     /**
@@ -638,11 +640,11 @@ export declare class Application extends GObject.GObject {
      * `application` that was previously created with
      * g_application_bind_busy_property().
      * @param object - a #GObject
-     * @param property - the name of a boolean property of @object
+     * @param property - the name of a boolean property of `object`
      */
     unbindBusyProperty(object: GObject.GObject, property: string): void;
     /**
-     * Decreases the busy count of @application.
+     * Decreases the busy count of `application`.
      *
      * When the busy count reaches zero, the new state will be propagated
      * to other processes.
@@ -669,55 +671,55 @@ export declare class Application extends GObject.GObject {
      */
     withdrawNotification(id: string): void;
     /**
-     * Emits the [signal@Gio.ActionGroup::action-added] signal on @action_group.
+     * Emits the {@link Gio.ActionGroup.:action-added} signal on `action_group`.
      *
-     * This function should only be called by [type@Gio.ActionGroup] implementations.
+     * This function should only be called by {@link Gio.ActionGroup} implementations.
      * @param actionName - the name of an action in the group
      */
     actionAdded(actionName: string): void;
     /**
-     * Emits the [signal@Gio.ActionGroup::action-enabled-changed] signal on @action_group.
+     * Emits the {@link Gio.ActionGroup.:action-enabled-changed} signal on `action_group`.
      *
-     * This function should only be called by [type@Gio.ActionGroup] implementations.
+     * This function should only be called by {@link Gio.ActionGroup} implementations.
      * @param actionName - the name of an action in the group
      * @param enabled - whether the action is now enabled
      */
     actionEnabledChanged(actionName: string, enabled: boolean): void;
     /**
-     * Emits the [signal@Gio.ActionGroup::action-removed] signal on @action_group.
+     * Emits the {@link Gio.ActionGroup.:action-removed} signal on `action_group`.
      *
-     * This function should only be called by [type@Gio.ActionGroup] implementations.
+     * This function should only be called by {@link Gio.ActionGroup} implementations.
      * @param actionName - the name of an action in the group
      */
     actionRemoved(actionName: string): void;
     /**
-     * Emits the [signal@Gio.ActionGroup::action-state-changed] signal on @action_group.
+     * Emits the {@link Gio.ActionGroup.:action-state-changed} signal on `action_group`.
      *
-     * This function should only be called by [type@Gio.ActionGroup] implementations.
+     * This function should only be called by {@link Gio.ActionGroup} implementations.
      * @param actionName - the name of an action in the group
      * @param state - the new state of the named action
      */
     actionStateChanged(actionName: string, state: GLib.Variant): void;
     /**
-     * Activate the named action within @action_group.
+     * Activate the named action within `action_group`.
      *
      * If the action is expecting a parameter, then the correct type of
-     * parameter must be given as @parameter.  If the action is expecting no
+     * parameter must be given as `parameter`.  If the action is expecting no
      * parameters then `parameter` must be `NULL`.  See
-     * [method@Gio.ActionGroup.get_action_parameter_type].
+     * {@link Gio.ActionGroup.get_action_parameter_type}.
      *
-     * If the [type@Gio.ActionGroup] implementation supports asynchronous remote
+     * If the {@link Gio.ActionGroup} implementation supports asynchronous remote
      * activation over D-Bus, this call may return before the relevant
      * D-Bus traffic has been sent, or any replies have been received. In
      * order to block on such asynchronous activation calls,
-     * [method@Gio.DBusConnection.flush] should be called prior to the code, which
+     * {@link Gio.DBusConnection.flush} should be called prior to the code, which
      * depends on the result of the action activation. Without flushing
      * the D-Bus connection, there is no guarantee that the action would
      * have been activated.
      *
      * The following code which runs in a remote app instance, shows an
      * example of a ‘quit’ action being activated on the primary app
-     * instance over D-Bus. Here [method@Gio.DBusConnection.flush] is called
+     * instance over D-Bus. Here {@link Gio.DBusConnection.flush} is called
      * before `exit()`. Without `g_dbus_connection_flush()`, the ‘quit’ action
      * may fail to be activated on the primary instance.
      *
@@ -738,14 +740,14 @@ export declare class Application extends GObject.GObject {
     activateAction(actionName: string, parameter?: GLib.Variant): void;
     /**
      * Request for the state of the named action within `action_group` to be
-     * changed to @value.
+     * changed to `value`.
      *
      * The action must be stateful and `value` must be of the correct type.
-     * See [method@Gio.ActionGroup.get_action_state_type].
+     * See {@link Gio.ActionGroup.get_action_state_type}.
      *
      * This call merely requests a change.  The action may refuse to change
-     * its state or may change its state to something other than @value.
-     * See [method@Gio.ActionGroup.get_action_state_hint].
+     * its state or may change its state to something other than `value`.
+     * See {@link Gio.ActionGroup.get_action_state_hint}.
      *
      * If the `value` GVariant is floating, it is consumed.
      * @param actionName - the name of the action to request the change on
@@ -762,14 +764,14 @@ export declare class Application extends GObject.GObject {
     getActionEnabled(actionName: string): boolean;
     /**
      * Queries the type of the parameter that must be given when activating
-     * the named action within @action_group.
+     * the named action within `action_group`.
      *
-     * When activating the action using [method@Gio.ActionGroup.activate_action],
-     * the [type@GLib.Variant] given to that function must be of the type returned
+     * When activating the action using {@link Gio.ActionGroup.activate_action},
+     * the {@link GLib.Variant} given to that function must be of the type returned
      * by this function.
      *
      * In the case that this function returns `NULL`, you must not give any
-     * [type@GLib.Variant], but `NULL` instead.
+     * {@link GLib.Variant}, but `NULL` instead.
      *
      * The parameter type of a particular action will never change but it is
      * possible for an action to be removed and for a new action to be added
@@ -778,27 +780,27 @@ export declare class Application extends GObject.GObject {
      */
     getActionParameterType(actionName: string): GLib.VariantType | null;
     /**
-     * Queries the current state of the named action within @action_group.
+     * Queries the current state of the named action within `action_group`.
      *
      * If the action is not stateful then `NULL` will be returned.  If the
      * action is stateful then the type of the return value is the type
-     * given by [method@Gio.ActionGroup.get_action_state_type].
+     * given by {@link Gio.ActionGroup.get_action_state_type}.
      *
      * The return value (if non-`NULL`) should be freed with
-     * [method@GLib.Variant.unref] when it is no longer required.
+     * {@link GLib.Variant.unref} when it is no longer required.
      * @param actionName - the name of the action to query
      */
     getActionState(actionName: string): GLib.Variant | null;
     /**
      * Requests a hint about the valid range of values for the state of the
-     * named action within @action_group.
+     * named action within `action_group`.
      *
      * If `NULL` is returned it either means that the action is not stateful
      * or that there is no hint about the valid range of values for the
      * state of the action.
      *
-     * If a [type@GLib.Variant] array is returned then each item in the array is a
-     * possible value for the state.  If a [type@GLib.Variant] pair (ie: two-tuple) is
+     * If a {@link GLib.Variant} array is returned then each item in the array is a
+     * possible value for the state.  If a {@link GLib.Variant} pair (ie: two-tuple) is
      * returned then the tuple specifies the inclusive lower and upper bound
      * of valid values for the state.
      *
@@ -807,23 +809,23 @@ export declare class Application extends GObject.GObject {
      * within the range may fail.
      *
      * The return value (if non-`NULL`) should be freed with
-     * [method@GLib.Variant.unref] when it is no longer required.
+     * {@link GLib.Variant.unref} when it is no longer required.
      * @param actionName - the name of the action to query
      */
     getActionStateHint(actionName: string): GLib.Variant | null;
     /**
      * Queries the type of the state of the named action within
-     * @action_group.
+     * `action_group`.
      *
      * If the action is stateful then this function returns the
-     * [type@GLib.VariantType] of the state.  All calls to
-     * [method@Gio.ActionGroup.change_action_state] must give a [type@GLib.Variant] of this
-     * type and [method@Gio.ActionGroup.get_action_state] will return a [type@GLib.Variant]
+     * {@link GLib.VariantType} of the state.  All calls to
+     * {@link Gio.ActionGroup.change_action_state} must give a {@link GLib.Variant} of this
+     * type and {@link Gio.ActionGroup.get_action_state} will return a {@link GLib.Variant}
      * of the same type.
      *
      * If the action is not stateful then this function will return `NULL`.
-     * In that case, [method@Gio.ActionGroup.get_action_state] will return `NULL`
-     * and you must not call [method@Gio.ActionGroup.change_action_state].
+     * In that case, {@link Gio.ActionGroup.get_action_state} will return `NULL`
+     * and you must not call {@link Gio.ActionGroup.change_action_state}.
      *
      * The state type of a particular action will never change but it is
      * possible for an action to be removed and for a new action to be added
@@ -832,33 +834,33 @@ export declare class Application extends GObject.GObject {
      */
     getActionStateType(actionName: string): GLib.VariantType | null;
     /**
-     * Checks if the named action exists within @action_group.
+     * Checks if the named action exists within `action_group`.
      * @param actionName - the name of the action to check for
      */
     hasAction(actionName: string): boolean;
     /**
-     * Lists the actions contained within @action_group.
+     * Lists the actions contained within `action_group`.
      *
-     * The caller is responsible for freeing the list with [func@GLib.strfreev] when
+     * The caller is responsible for freeing the list with {@link GLib.strfreev} when
      * it is no longer required.
      */
     listActions(): string[];
     /**
-     * Queries all aspects of the named action within an @action_group.
+     * Queries all aspects of the named action within an `action_group`.
      *
      * This function acquires the information available from
-     * [method@Gio.ActionGroup.has_action], [method@Gio.ActionGroup.get_action_enabled],
-     * [method@Gio.ActionGroup.get_action_parameter_type],
-     * [method@Gio.ActionGroup.get_action_state_type],
-     * [method@Gio.ActionGroup.get_action_state_hint] and
-     * [method@Gio.ActionGroup.get_action_state] with a single function call.
+     * {@link Gio.ActionGroup.has_action}, {@link Gio.ActionGroup.get_action_enabled},
+     * {@link Gio.ActionGroup.get_action_parameter_type},
+     * {@link Gio.ActionGroup.get_action_state_type},
+     * {@link Gio.ActionGroup.get_action_state_hint} and
+     * {@link Gio.ActionGroup.get_action_state} with a single function call.
      *
      * This provides two main benefits.
      *
      * The first is the improvement in efficiency that comes with not having
      * to perform repeated lookups of the action in order to discover
      * different things about it.  The second is that implementing
-     * [type@Gio.ActionGroup] can now be done by only overriding this one virtual
+     * {@link Gio.ActionGroup} can now be done by only overriding this one virtual
      * function.
      *
      * The interface provides a default implementation of this function that
@@ -880,20 +882,20 @@ export declare class Application extends GObject.GObject {
      */
     queryAction(actionName: string, enabled: Ref<boolean>, parameterType?: Ref<GLib.VariantType>, stateType?: Ref<GLib.VariantType>, stateHint?: Ref<GLib.Variant>, state?: Ref<GLib.Variant>): boolean;
     /**
-     * Adds an action to the @action_map.
+     * Adds an action to the `action_map`.
      *
      * If the action map already contains an action with the same name
      * as `action` then the old action is dropped from the action map.
      *
-     * The action map takes its own reference on @action.
-     * @param action - a [iface@Gio.Action]
+     * The action map takes its own reference on `action`.
+     * @param action - a {@link Gio.Action}
      */
     addAction(action: Action): void;
     /**
-     * A convenience function for creating multiple [class@Gio.SimpleAction]
-     * instances and adding them to a [iface@Gio.ActionMap].
+     * A convenience function for creating multiple {@link Gio.SimpleAction}
+     * instances and adding them to a {@link Gio.ActionMap}.
      *
-     * Each action is constructed as per one [struct@Gio.ActionEntry].
+     * Each action is constructed as per one {@link Gio.ActionEntry}.
      *
      * ```c
      * static void
@@ -928,12 +930,12 @@ export declare class Application extends GObject.GObject {
      * }
      * ```
      * @param entries - a pointer to
-     * @param nEntries - the length of @entries, or -1 if `entries` is `NULL`-terminated
+     * @param nEntries - the length of `entries`, or -1 if `entries` is `NULL`-terminated
      * @param userData - the user data for signal connections
      */
     addActionEntries(entries: number[], nEntries: number, userData?: number): void;
     /**
-     * Looks up the action with the name `action_name` in @action_map.
+     * Looks up the action with the name `action_name` in `action_map`.
      *
      * If no such action exists, returns `NULL`.
      * @param actionName - the name of an action
@@ -947,9 +949,8 @@ export declare class Application extends GObject.GObject {
      */
     removeAction(actionName: string): void;
     /**
-     * Remove actions from a [iface@Gio.ActionMap]. This is meant as the reverse of
-     * [method@Gio.ActionMap.add_action_entries].
-     *
+     * Remove actions from a {@link Gio.ActionMap}. This is meant as the reverse of
+     * {@link Gio.ActionMap.add_action_entries}.
      *
      * ```c
      * static const GActionEntry entries[] = {
@@ -970,7 +971,7 @@ export declare class Application extends GObject.GObject {
      * }
      * ```
      * @param entries - a pointer to
-     * @param nEntries - the length of @entries, or -1 if `entries` is `NULL`-terminated
+     * @param nEntries - the length of `entries`, or -1 if `entries` is `NULL`-terminated
      */
     removeActionEntries(entries: number[], nEntries: number): void;
     connect(signal: "activate", handler: (self: Application) => void, after?: boolean): number;