GTKX

API Reference / @gtkx/runtime / setProperty

Function: setProperty() ​

Call Signature ​

setProperty<TObject, TPropertyMap, TName>(obj, propertyName, jsValue): void

Defined in: packages/runtime/src/object.ts:231

Writes a GObject property using the object's generated writable property types.

Type Parameters ​

TObject ​

TObject extends object

TPropertyMap ​

TPropertyMap extends object = Extract<WritableProperties<TObject>, object>

TName ​

TName extends string = Extract<NoInfer<keyof TPropertyMap>, string>

Parameters ​

obj ​

TObject

The object to write to.

propertyName ​

TName

The property name.

jsValue ​

NoInfer<TPropertyMap>[TName]

The value to set.

Returns ​

void

Call Signature ​

setProperty(obj, propertyName, descriptor, jsValue): void

Defined in: packages/runtime/src/object.ts:245

Writes a JavaScript value to a GObject property, converting it to native form using the descriptor.

Parameters ​

obj ​

object

The object to write to.

propertyName ​

string

The property name.

descriptor ​

Descriptor

Describes the property's type.

jsValue ​

unknown

The value to set.

Returns ​

void