Gjsify LogoGjsify Logo

Hierarchy

Index

Constructors

Properties

gTypeInstance: TypeInstance
object: GObject.Object
name: string

Methods

  • addCase(testExpr: number, elseExpr: number, whenArray: number[], thenArray: number[]): number
  • Creates a new CASE ... WHEN ... THEN ... ELSE ... END expression. The WHEN expression and the THEN expression IDs are taken from the when_array and then_array at the same index, for each index inferior to args_size.

    Parameters

    • testExpr: number

      the expression ID representing the test of the CASE, or %0

    • elseExpr: number

      the expression ID representing the ELSE expression, or %0

    • whenArray: number[]

      an array containing each WHEN expression ID, having at least args_size elements

    • thenArray: number[]

      an array containing each THEN expression ID, having at least args_size elements

    Returns number

  • Builds a new expression which represents a condition (or operation).

    Parameters

    • op: Gda.SqlOperatorType

      type of condition

    • op1: number

      the ID of the 1st argument (not 0)

    • op2: number

      the ID of the 2nd argument (may be %0 if op needs only one operand)

    • op3: number

      the ID of the 3rd argument (may be %0 if op needs only one or two operand)

    Returns number

  • Builds a new expression which represents a condition (or operation).

    As a side case, if ops_ids_size is 1, then op is ignored, and the returned ID represents op_ids[0] (this avoids any problem for example when op is GDA_SQL_OPERATOR_TYPE_AND and there is in fact only one operand).

    Parameters

    • op: Gda.SqlOperatorType

      type of condition

    • opIds: number[]

      an array of ID for the arguments (not %0)

    Returns number

  • Defines an expression in builder which may be reused to build other parts of a statement.

    The new expression will contain the value passed as the value argument.

    If value's type is a string then it is possible to customize how the value has to be interpreted by passing a specific #GdaDataHandler object as dh. This feature is very rarely used and the dh argument should generally be %NULL.

    Parameters

    • dh: Gda.DataHandler

      deprecated useless argument, just pass %NULL

    • value: any

      value to set the expression to, or %NULL or a GDA_TYPE_NULL value to represent an SQL NULL

    Returns number

  • addFieldId(fieldName: string, tableName: string): number
  • Defines an expression representing a field in builder, which may be reused to build other parts of a statement, for instance as a parameter to gda_sql_builder_add_cond() or gda_sql_builder_add_field_value_id().

    Calling this with a %NULL table_name is equivalent to calling gda_sql_builder_add_id().

    For SELECT queries, see gda_sql_builder_select_add_field().

    Parameters

    • fieldName: string

      a field name

    • tableName: string

      a table name, or %NULL

    Returns number

  • addFieldValueAsGvalue(fieldName: string, value: any): void
  • Valid only for: INSERT, UPDATE statements.

    Specifies that the field represented by field_name will be set to the value identified by value

    Parameters

    • fieldName: string

      a field name

    • value: any

      value to set the field to, or %NULL or a GDA_TYPE_NULL value to represent an SQL NULL

    Returns void

  • addFieldValueId(fieldId: number, valueId: number): void
  • Valid only for: INSERT, UPDATE, SELECT statements For UPDATE: specifies that the field represented by field_id will be set to the value identified by value_id. For SELECT: add a selected item to the statement, and if value_id is not %0, then use it as an alias For INSERT: if field_id represents an SQL identifier (obtained using gda_sql_builder_add_id()): then if value_id is not %0 then specifies that the field represented by field_id will be set to the value identified by value_id, otherwise just specifies a named field to be given a value. If field_id represents a sub SELECT (obtained using gda_sql_builder_add_sub_select()), then this method call defines the sub SELECT from which values to insert are taken.

    See also gda_sql_builder_add_field_value() and gda_sql_builder_add_field_value_as_gvalue().

    Parameters

    • fieldId: number

      the ID of the field's name or definition

    • valueId: number

      the ID of the value to set the field to, or %0

    Returns void

  • addFunction(funcName: string, args: number[]): number
  • Builds a new expression which represents a function applied to some arguments

    Parameters

    • funcName: string

      the functions's name

    • args: number[]

      an array of IDs representing the function's arguments

    Returns number

  • addId(str: string): number
  • Defines an expression representing an identifier in builder, which may be reused to build other parts of a statement, for instance as a parameter to gda_sql_builder_add_cond() or gda_sql_builder_add_field_value_id().

    The new expression will contain the str literal. For example: gda_sql_builder_add_id (b, "name") gda_sql_builder_add_id (b, "date")

    will be rendered as SQL as: name "date"

    because "date" is an SQL reserved keyword.

    For fields, see gda_sql_builder_add_field_id().

    Parameters

    • str: string

      a string

    Returns number

  • addParam(paramName: string, type: GType<unknown>, nullok: boolean): number
  • Defines a parameter in builder which may be reused to build other parts of a statement.

    The new expression will contain the string literal. For example: gda_sql_builder_add_param (b, "age", G_TYPE_INT, FALSE)

    will be rendered as SQL as:

    Parameters

    • paramName: string

      parameter's name

    • type: GType<unknown>

      parameter's type

    • nullok: boolean

      TRUE if the parameter can be set to %NULL

    Returns number

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

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

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • sourceProperty: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • targetProperty: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transformTo: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transformFrom: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • Add a sub select to a COMPOUND statement

    Parameters

    • subselect: Gda.SqlBuilder

      a #GdaSqlBuilder, which has to be a SELECT or compound SELECT. This will be copied.

    Returns void

  • 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

  • emit(sigName: string, ...args: any[]): void
  • forceFloating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • 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

  • 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

  • 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

  • importExpressionFromBuilder(query: Gda.SqlBuilder, exprId: number): number
  • Imports the an expression located in query into builder.

    Parameters

    • query: Gda.SqlBuilder

      a #GdaSqlBuilder object to get expression from

    • exprId: number

      a #GdaSqlBuilderId of the expression in query

    Returns number

  • isFloating(): boolean
  • joinAddField(joinId: number, fieldName: string): void
  • Alter a join in a SELECT statement to make its condition use equal field values in the fields named field_name in both tables, via the USING keyword.

    Parameters

    • joinId: number

      the ID of the join to modify (not %0)

    • fieldName: string

      the name of the field to use in the join condition (not %NULL)

    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

  • selectAddField(fieldName: string, tableName: string, alias: string): number
  • Valid only for: SELECT statements.

    Add a selected selected item to the SELECT statement.

    For non-SELECT statements, see gda_sql_builder_add_field_id().

    Parameters

    • fieldName: string

      a field name

    • tableName: string

      a table name, or %NULL

    • alias: string

      an alias (eg. for the "AS" clause), or %NULL

    Returns number

  • selectAddTarget(tableName: string, alias: string): number
  • Adds a new target to a SELECT statement

    Parameters

    • tableName: string

      the name of the target table

    • alias: string

      the alias to give to the target, or %NULL

    Returns number

  • selectAddTargetId(tableId: number, alias: string): number
  • Adds a new target to a SELECT statement. If there already exists a target representing the same table and the same alias (or with the same absence of alias) then the same target ID is returned instead of the ID of a new target.

    Parameters

    • tableId: number

      the ID of the expression holding a table reference (not %0)

    • alias: string

      the alias to give to the target, or %NULL

    Returns number

  • selectGroupBy(exprId: number): void
  • Valid only for: SELECT statements

    Adds the expr_id expression to the GROUP BY clause's expressions list

    Parameters

    • exprId: number

      the ID of the expression to set use in the GROUP BY clause, or 0 to unset any previous GROUP BY clause

    Returns void

  • selectOrderBy(exprId: number, asc: boolean, collationName: string): void
  • Adds a new ORDER BY expression to a SELECT statement.

    Parameters

    • exprId: number

      the ID of the expression to use during sorting (not %0)

    • asc: boolean

      %TRUE for an ascending sorting

    • collationName: string

      name of the collation to use when sorting, or %NULL

    Returns void

  • selectSetDistinct(distinct: boolean, exprId: number): void
  • Defines (if distinct is %TRUE) or removes (if distinct is %FALSE) a DISTINCT clause for a SELECT statement.

    If distinct is %TRUE, then the ID of an expression can be specified as the expr_id argument: if not %0, this is the expression used to apply the DISTINCT clause on (the resuting SQL will then usually be "... DISTINCT ON <expression>...").

    Parameters

    • distinct: boolean

      set to %TRUE to have the DISTINCT requirement

    • exprId: number

      the ID of the DISTINCT ON expression, or %0 if no expression is to be used. It is ignored if distinct is %FALSE.

    Returns void

  • selectSetHaving(condId: number): void
  • Valid only for: SELECT statements

    Sets the HAVING condition of the statement

    Parameters

    • condId: number

      the ID of the expression to set as HAVING condition, or 0 to unset any previous HAVING condition

    Returns void

  • selectSetLimit(limitCountExprId: number, limitOffsetExprId: number): void
  • If limit_count_expr_id is not %0, defines the maximum number of rows in the #GdaDataModel resulting from the execution of the built statement. In this case, the offset from which the rows must be collected can be defined by the limit_offset_expr_id expression if not %0 (note that this feature may not be supported by all the database providers).

    If limit_count_expr_id is %0, then removes any LIMIT which may have been imposed by a previous call to this method.

    Parameters

    • limitCountExprId: number

      the ID of the LIMIT expression, or %0

    • limitOffsetExprId: number

      the ID of the OFFSET expression, or %0

    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

  • setTable(tableName: string): void
  • Valid only for: INSERT, UPDATE, DELETE statements

    Sets the name of the table on which the built statement operates.

    Parameters

    • tableName: string

      a table name

    Returns void

  • setWhere(condId: number): void
  • Valid only for: UPDATE, DELETE, SELECT statements

    Sets the WHERE condition of the statement

    Parameters

    • condId: number

      the ID of the expression to set as WHERE condition, or 0 to unset any previous WHERE condition

    Returns void

  • stealData(key?: string): object
  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Optional key: string

      name of the key

    Returns object

  • stealQdata(quark: number): object
  • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

    void
    object_add_to_user_list (GObject *object,
    const gchar *new_string)
    {
    // the quark, naming the object data
    GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
    // retrieve the old string list
    GList *list = g_object_steal_qdata (object, quark_string_list);

    // prepend new string
    list = g_list_prepend (list, g_strdup (new_string));
    // this changed 'list', so we need to set it again
    g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
    }
    static void
    free_string_list (gpointer data)
    {
    GList *node, *list = data;

    for (node = list; node; node = node->next)
    g_free (node->data);
    g_list_free (list);
    }

    Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

    Parameters

    • quark: number

      A #GQuark, naming the user data pointer

    Returns object

  • thawNotify(): void
  • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

    Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

    It is an error to call this function when the freeze count is zero.

    Returns void

  • unref(): void
  • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

    If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

    Returns void

  • watchClosure(closure: TClosure<any, any>): void
  • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

    Parameters

    • closure: TClosure<any, any>

      #GClosure to watch

    Returns void

  • compatControl(what: number, data: object): number
  • 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