/
Grl-0.1.d.ts
9027 lines (9024 loc) · 362 KB
/
Grl-0.1.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Type Definitions for Gjs (https://gjs.guide/)
*
* These type definitions are automatically generated, do not edit them by hand.
* If you found a bug fix it in ts-for-gir itself or create a bug report on https://github.com/sammydre/ts-for-gjs
*/
/**
* Grl-0.1
*/
import type * as Gjs from './Gjs';
import type GObject from './GObject-2.0';
import type GLib from './GLib-2.0';
import type GModule from './GModule-2.0';
export namespace Grl {
/**
* These constants identify all the available core errors
*/
enum CoreError {
BROWSE_FAILED,
SEARCH_FAILED,
SEARCH_NULL_UNSUPPORTED,
QUERY_FAILED,
METADATA_FAILED,
RESOLVE_FAILED,
MEDIA_NOT_FOUND,
STORE_FAILED,
REMOVE_FAILED,
SET_METADATA_FAILED,
MEDIA_FROM_URI_FAILED,
CONFIG_LOAD_FAILED,
CONFIG_FAILED,
UNREGISTER_SOURCE_FAILED,
LOAD_PLUGIN_FAILED,
UNLOAD_PLUGIN_FAILED,
REGISTER_METADATA_KEY_FAILED,
NOTIFY_CHANGED_FAILED,
OPERATION_CANCELLED,
}
/**
* Grilo log levels. Defines the level of verbosity selected in Grilo.
*/
enum LogLevel {
NONE,
ERROR,
WARNING,
MESSAGE,
INFO,
DEBUG,
LAST,
}
/**
* GrlMedia serialize type
*/
enum MediaSerializeType {
BASIC,
PARTIAL,
FULL,
}
/**
* Specifies which kind of change has happened in the plugin
*/
enum MediaSourceChangeType {
CHANGED,
ADDED,
REMOVED,
}
/**
* Module priority ranks. Defines the order in which the resolver
* (or similar rank-picking mechanisms) will choose this plugin
* over an alternative one with the same function.
*
* These constants serve as a rough guidance for defining the rank
* of a GrlPluginInfo. Any value is valid, including values bigger
* than GRL_PLUGIN_RANK_HIGHEST.
*/
enum PluginRank {
LOWEST,
LOW,
DEFAULT,
HIGH,
HIGHEST,
}
/**
* GrlMetadata resolution flags
*/
enum MetadataResolutionFlags {
NORMAL,
FULL,
IDLE_RELAY,
FAST_ONLY,
}
/**
* Flags for metadata writing operations.
*/
enum MetadataWritingFlags {
NORMAL,
FULL,
}
/**
* Bitwise flags which reflect the kind of operations that a
* #GrlMediaPlugin supports.
*/
enum SupportedOps {
NONE,
METADATA,
RESOLVE,
BROWSE,
SEARCH,
QUERY,
STORE,
STORE_PARENT,
REMOVE,
SET_METADATA,
MEDIA_FROM_URI,
NOTIFY_CHANGE,
}
const CONFIG_KEY_APIKEY: string
const CONFIG_KEY_APIKEY_BLOB: string
const CONFIG_KEY_APISECRET: string
const CONFIG_KEY_APITOKEN: string
const CONFIG_KEY_PASSWORD: string
const CONFIG_KEY_PLUGIN: string
const CONFIG_KEY_SOURCE: string
const CONFIG_KEY_USERNAME: string
const KEYID_FORMAT: string
const MEDIA_PLUGIN_AUTHOR: string
const MEDIA_PLUGIN_DESCRIPTION: string
const MEDIA_PLUGIN_LICENSE: string
const MEDIA_PLUGIN_NAME: string
const MEDIA_PLUGIN_SITE: string
const MEDIA_PLUGIN_VERSION: string
const METADATA_KEY_CHILDCOUNT_UNKNOWN: number
const PADDING: number
const PADDING_SMALL: number
const PLUGIN_LIST_VAR: string
const PLUGIN_PATH_VAR: string
const PLUGIN_RANKS_VAR: string
const SOURCE_REMAINING_UNKNOWN: number
function init(argv?: string[] | null): /* argv */ string[] | null
function log_configure(config: string): void
function marshal_VOID__BOXED_ENUM_BOOLEAN(closure: Function, return_value: any, n_param_values: number, param_values: any, invocation_hint: object, marshal_data: object): void
function metadata_key_get_desc(key: GObject.ParamSpec): string
function metadata_key_get_name(key: GObject.ParamSpec): string
function metadata_key_setup_system_keys(registry: PluginRegistry): void
function multiple_cancel(search_id: number): void
function multiple_get_media_from_uri(uri: string, keys: KeyID[], flags: MetadataResolutionFlags, callback: MediaSourceMetadataCb): void
function multiple_search(sources: MediaSource[] | null, text: string, keys: GObject.ParamSpec[], count: number, flags: MetadataResolutionFlags, callback: MediaSourceResultCb): number
function multiple_search_sync(sources: MediaSource[] | null, text: string, keys: GObject.ParamSpec[], count: number, flags: MetadataResolutionFlags): Media[]
function operation_cancel(operation_id: number): void
function operation_get_data(operation_id: number): object
function operation_set_data(operation_id: number, user_data: object): void
function paging_translate(skip: number, count: number, max_page_size: number, page_size: number, page_number: number, internal_offset: number): void
/**
* Prototype for the callback passed to grl_media_source_metadata()
*/
interface MediaSourceMetadataCb {
(source: MediaSource, operation_id: number, media: Media, error: number): void
}
/**
* Prototype for the callback passed to grl_media_source_remove()
*/
interface MediaSourceRemoveCb {
(source: MediaSource, media: Media, error: number): void
}
/**
* Prototype for the callback passed to the media sources' methods
*/
interface MediaSourceResultCb {
(source: MediaSource, operation_id: number, media: Media, remaining: number, error: number): void
}
/**
* Prototype for the callback passed to grl_media_source_store()
*/
interface MediaSourceStoreCb {
(source: MediaSource, parent: MediaBox, media: Media, error: number): void
}
/**
* Prototype for the callback passed to grl_metadata_source_resolve()
*/
interface MetadataSourceResolveCb {
(source: MetadataSource, operation_id: number, media: Media, error: number): void
}
/**
* Prototype for the callback passed to grl_metadata_source_set_metadata()
*/
interface MetadataSourceSetMetadataCb {
(source: MetadataSource, media: Media, failed_keys: GObject.ParamSpec[], error: number): void
}
interface Config_ConstructProps extends GObject.Object_ConstructProps {
}
class Config {
/* Fields of GObject-2.0.GObject.Object */
g_type_instance: GObject.TypeInstance
/* Methods of Grl-0.1.Grl.Config */
get_api_key(): string
get_api_key_blob(size: number): number
get_api_secret(): string
get_api_token(): string
get_binary(param: string, size: number): number
get_boolean(param: string): boolean
get_float(param: string): number
get_int(param: string): number
get_password(): string
get_plugin(): string
get_string(param: string): string
get_username(): string
/**
* otherwise.
* @param param the param
*/
has_param(param: string): boolean
set(param: string, value: any): void
/**
* Set the webservice API key in the configuration
* @param key the API key
*/
set_api_key(key: string): void
/**
* Set the binary API key in the configuration
* @param blob the binary API key blob
* @param size the size of the blob
*/
set_api_key_blob(blob: number, size: number): void
/**
* Set the webservice passphrase in the configuration
* @param secret the webservice passphrase
*/
set_api_secret(secret: string): void
/**
* Set the webservice API token in the configuration
* @param token the API token
*/
set_api_token(token: string): void
set_binary(param: string, blob: number, size: number): void
set_boolean(param: string, value: boolean): void
set_float(param: string, value: number): void
set_int(param: string, value: number): void
/**
* Set the password in the configuration
* @param password the password
*/
set_password(password: string): void
/**
* Set the plugin key in the configuration
* @param plugin the plugin id
*/
set_plugin(plugin: string): void
/**
* Set the plugin key in the configuration
* @param source the source id
*/
set_source(source: string): void
set_string(param: string, value: string): void
/**
* Set the username in the configuration
* @param username the username
*/
set_username(username: string): void
/* Methods of GObject-2.0.GObject.Object */
/**
* 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:
*
*
* ```c
* 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.
* @param source_property the property on `source` to bind
* @param target the target #GObject
* @param target_property the property on `target` to bind
* @param flags flags to pass to #GBinding
*/
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,` 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.
* @param source_property the property on `source` to bind
* @param target the target #GObject
* @param target_property the property on `target` to bind
* @param flags flags to pass to #GBinding
* @param transform_to a #GClosure wrapping the transformation function from the `source` to the `target,` or %NULL to use the default
* @param transform_from a #GClosure wrapping the transformation function from the `target` to the `source,` or %NULL to use the default
*/
bind_property_full(source_property: string, target: GObject.Object, target_property: string, flags: GObject.BindingFlags, transform_to: Function, transform_from: Function): GObject.Binding
/**
* 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().
*/
force_floating(): 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.
*/
freeze_notify(): void
/**
* Gets a named field from the objects table of associations (see g_object_set_data()).
* @param key name of the key for that association
*/
get_data(key: string): object | null
/**
* 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.
* @param property_name the name of the property to get
* @param value return location for the property value
*/
get_property(property_name: string, value: any): void
/**
* This function gets back user data pointers stored via
* g_object_set_qdata().
* @param quark A #GQuark, naming the user data pointer
*/
get_qdata(quark: GLib.Quark): object | null
/**
* 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.
* @param names the names of each property to get
* @param values the values of each property to get
*/
getv(names: string[], values: any[]): void
/**
* Checks whether `object` has a [floating][floating-ref] reference.
*/
is_floating(): boolean
/**
* 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.
* @param property_name the name of a property installed on the class of `object`.
*/
notify(property_name: string): 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.:
*
*
* ```c
* 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:
*
*
* ```c
* g_object_notify_by_pspec (self, properties[PROP_FOO]);
* ```
*
* @param pspec the #GParamSpec of a property installed on the class of `object`.
*/
notify_by_pspec(pspec: GObject.ParamSpec): 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.
*/
ref(): 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().
*/
ref_sink(): GObject.Object
/**
* Releases all references to other objects. This can be used to break
* reference cycles.
*
* This function should only be called from object system implementations.
*/
run_dispose(): 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.
* @param key name of the key
* @param data data to associate with that key
*/
set_data(key: string, data?: object | null): void
/**
* Sets a property on an object.
* @param property_name the name of the property to set
* @param value the value
*/
set_property(property_name: string, value: any): void
/**
* Remove a specified datum from the object's data associations,
* without invoking the association's destroy handler.
* @param key name of the key
*/
steal_data(key: string): object | null
/**
* 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:
*
* ```c
* 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().
* @param quark A #GQuark, naming the user data pointer
*/
steal_qdata(quark: GLib.Quark): object | null
/**
* 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.
*/
thaw_notify(): 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.
*/
unref(): 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.
* @param closure #GClosure to watch
*/
watch_closure(closure: Function): void
/* Virtual methods of GObject-2.0.GObject.Object */
vfunc_constructed(): void
vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: GObject.ParamSpec): void
vfunc_dispose(): void
vfunc_finalize(): void
vfunc_get_property(property_id: number, value: any, 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.
* @param pspec
*/
vfunc_notify(pspec: GObject.ParamSpec): void
vfunc_set_property(property_id: number, value: any, pspec: GObject.ParamSpec): void
/* Signals of GObject-2.0.GObject.Object */
/**
* The notify signal is emitted on an object when one of its properties has
* its value set through g_object_set_property(), g_object_set(), et al.
*
* Note that getting this signal doesn’t itself guarantee that the value of
* the property has actually changed. When it is emitted is determined by the
* derived GObject class. If the implementor did not create the property with
* %G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results
* in ::notify being emitted, even if the new value is the same as the old.
* If they did pass %G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only
* when they explicitly call g_object_notify() or g_object_notify_by_pspec(),
* and common practice is to do that only when the value has actually changed.
*
* This signal is typically used to obtain change notification for a
* single property, by specifying the property name as a detail in the
* g_signal_connect() call, like this:
*
*
* ```c
* g_signal_connect (text_view->buffer, "notify::paste-target-list",
* G_CALLBACK (gtk_text_view_target_list_notify),
* text_view)
* ```
*
*
* It is important to note that you must use
* [canonical parameter names][canonical-parameter-names] as
* detail strings for the notify signal.
* @param pspec the #GParamSpec of the property which changed.
*/
connect(sigName: "notify", callback: (($obj: Config, pspec: GObject.ParamSpec) => void)): number
connect_after(sigName: "notify", callback: (($obj: Config, pspec: GObject.ParamSpec) => void)): number
emit(sigName: "notify", pspec: GObject.ParamSpec): void
connect(sigName: string, callback: any): number
connect_after(sigName: string, callback: any): number
emit(sigName: string, ...args: any[]): void
disconnect(id: number): void
static name: string
constructor (config?: Config_ConstructProps)
_init (config?: Config_ConstructProps): void
/* Static methods and pseudo-constructors */
static new(plugin: string, source?: string | null): Config
static $gtype: GObject.Type
}
interface Data_ConstructProps extends GObject.Object_ConstructProps {
/* Constructor properties of Grl-0.1.Grl.Data */
overwrite?: boolean
}
class Data {
/* Properties of Grl-0.1.Grl.Data */
overwrite: boolean
/* Fields of GObject-2.0.GObject.Object */
g_type_instance: GObject.TypeInstance
/* Methods of Grl-0.1.Grl.Data */
/**
* Adds a new `key` to `data,` with no value. If key already exists, it does
* nothing.
* @param key key to add
*/
add(key: GObject.ParamSpec): void
/**
* Appends a new binary value for `key` in `data`.
* @param key key to append
* @param buf the buffer containing the new value
* @param size size of buffer
*/
add_binary(key: GObject.ParamSpec, buf: number, size: number): void
/**
* Appends a new float value for `key` in `data`.
* @param key key to append
* @param floatvalue the new value
*/
add_float(key: GObject.ParamSpec, floatvalue: number): void
/**
* Appends a new int value for `key` in `data`.
* @param key key to append
* @param intvalue the new value
*/
add_int(key: GObject.ParamSpec, intvalue: number): void
/**
* Adds a new set of values into `data`.
*
* All keys in `prop` must be related among them.
*
* `data` will take the ownership of `relkeys,` so do not modify it.
* @param relkeys a set of related properties with their values
*/
add_related_keys(relkeys: RelatedKeys): void
/**
* Appends a new string value for `key` in `data`.
* @param key key to append
* @param strvalue the new value
*/
add_string(key: GObject.ParamSpec, strvalue: string): void
/**
* Makes a deep copy of `data` and all its contents.
*/
dup(): Data
/**
* Get the first value from `data` associated with `key`.
*
* freed by user.
* @param key key to look up.
*/
get(key: GObject.ParamSpec): any
/**
* Returns all non-%NULL values for `key` from `data`. This ignores related keys.
*
* values. Do not change or free the values. Free the list with #g_list_free.
* @param key a metadata key
*/
get_all_single_related_keys(key: KeyID): any[]
/**
* Returns all non-%NULL values for `key` from `data`. `key` must have been
* registered as a string-type key. This ignores related keys.
*
* not change or free the strings. Free the list with #g_list_free.
* @param key a metadata key
*/
get_all_single_related_keys_string(key: KeyID): string[]
/**
* Returns the first binary value associated with `key` from `data`. If `key` has
* no first value, or value is not a gfloat, or `key` is not in data, then %NULL
* is returned.
*
* successful `size` will be set the to the buffer size.
* @param key key to use
*/
get_binary(key: GObject.ParamSpec): [ /* returnType */ number, /* size */ number ]
/**
* Returns the first float value associated with `key` from `data`. If `key` has no
* first value, or value is not a gfloat, or `key` is not in data, then 0 is
* returned.
* @param key key to use
*/
get_float(key: GObject.ParamSpec): number
/**
* Returns the first int value associated with `key` from `data`. If `key` has no
* first value, or value is not a gint, or `key` is not in data, then 0 is
* returned.
* @param key key to use
*/
get_int(key: GObject.ParamSpec): number
/**
* Returns a list with keys contained in `data`.
*
* keys. The content of the list should not be modified or freed. Use
* g_list_free() when done using the list.
*/
get_keys(): GObject.ParamSpec[]
/**
* Checks if old values are replaced when calling #grl_data_set.
*/
get_overwrite(): boolean
/**
* Returns a set containing the values for `key` and related keys at position
* `index` from `data`.
*
* If user changes any of the values in the related keys, the changes will
* become permanent.
* @param key a metadata key
* @param index element to retrieve, starting at 0
*/
get_related_keys(key: KeyID, index: number): RelatedKeys
/**
* Returns all non-%NULL values for `key` from `data`. This ignores related keys.
*
* values. Do not change or free the values. Free the list with #g_list_free.
* @param key a metadata key
*/
get_single_values_for_key(key: KeyID): any[]
/**
* Returns all non-%NULL values for `key` from `data`. `key` must have been
* registered as a string-type key. This ignores related keys.
*
* not change or free the strings. Free the list with #g_list_free.
* @param key a metadata key
*/
get_single_values_for_key_string(key: KeyID): string[]
/**
* Returns the first string value associated with `key` from `data`. If `key` has
* no first value, or value is not string, or `key` is not in `data,` then %NULL
* is returned.
*
* not change nor free the value.
* @param key key to use
*/
get_string(key: GObject.ParamSpec): string
/**
* Checks if `key` is in `data`.
* @param key key to search
*/
has_key(key: GObject.ParamSpec): boolean
/**
* Checks if the `key` has a first value in `data`.
* @param key key to search
*/
key_is_known(key: GObject.ParamSpec): boolean
/**
* Returns how many values `key` or related keys have in `data:` if `key` has no
* value, but a related key has, then it is counted as positive.
*
* As example, let's think in three related keys, K1, K2 and K3, and then thinks
* we have added several values for those keys, as:
*
* (V10, V20, V30),, (V11, NULL, V31), (V12, NULL, V32)
*
* Therefore, when invoking grl_data_length (data, K2) it will return 3:
* considering K2 and the related keys (K1 and K3), there are 3 values.
* @param key a metadata key
*/
length(key: KeyID): number
/**
* Removes the first value for `key` from `data`. If there are other keys related
* to `key` their values will also be removed from `data`.
* @param key key to remove
*/
remove(key: GObject.ParamSpec): void
/**
* Removes the value at position `index` for `key` from `data`. If there are other
* keys related to `key,` their values at position `index` will also be removed
* from `data`.
* @param key a metadata key
* @param index index of key to be removed, starting at 0
*/
remove_nth(key: KeyID, index: number): void
/**
* Sets the first value associated with `key` in `data`. If key already has a
* value old value is freed and the new one is set.
*
* Also, checks that `value` is compliant with `key` specification, modifying it
* accordingly. For instance, if `key` requires a number between 0 and 10, but
* `value` is outside this range, it will be adapted accordingly.
* @param key key to change or add
* @param value the new value
*/
set(key: GObject.ParamSpec, value: any): void
/**
* Sets the first binary value associated with `key` in `data`. If `key` already
* has a first value old value is replaced by the new one.
* @param key key to change or add
* @param buf buffer holding the data
* @param size size of the buffer
*/
set_binary(key: GObject.ParamSpec, buf: number, size: number): void
/**
* Sets the first float value associated with `key` in `data`. If `key` already has
* a first value old value is replaced by the new one.
* @param key key to change or add
* @param floatvalue the new value
*/
set_float(key: GObject.ParamSpec, floatvalue: number): void
/**
* Sets the first int value associated with `key` in `data`. If `key` already has a
* first value old value is replaced by the new one.
* @param key key to change or add
* @param intvalue the new value
*/
set_int(key: GObject.ParamSpec, intvalue: number): void
/**
* This controls if #grl_data_set will overwrite the current value of a property
* with the new one.
*
* Set it to %TRUE so old values are overwritten, or %FALSE in other case
* (default is %FALSE).
* @param overwrite if data can be overwritten
*/
set_overwrite(overwrite: boolean): void
/**
* Updates the values at position `index` in `data` with values in `relkeys`.
*
* `data` will take ownership of `relkeys,` so do not free it after invoking this
* function.
* @param relkeys a set of related keys
* @param index position to be updated, starting at 0
*/
set_related_keys(relkeys: RelatedKeys, index: number): void
/**
* Sets the first string value associated with `key` in `data`. If `key` already
* has a value old value is freed and the new one is set.
* @param key key to change or add
* @param strvalue the new value
*/
set_string(key: GObject.ParamSpec, strvalue: string): void
/* Methods of GObject-2.0.GObject.Object */
/**
* 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:
*
*
* ```c
* 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.
* @param source_property the property on `source` to bind
* @param target the target #GObject
* @param target_property the property on `target` to bind
* @param flags flags to pass to #GBinding
*/
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,` 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.
* @param source_property the property on `source` to bind
* @param target the target #GObject
* @param target_property the property on `target` to bind
* @param flags flags to pass to #GBinding
* @param transform_to a #GClosure wrapping the transformation function from the `source` to the `target,` or %NULL to use the default
* @param transform_from a #GClosure wrapping the transformation function from the `target` to the `source,` or %NULL to use the default
*/
bind_property_full(source_property: string, target: GObject.Object, target_property: string, flags: GObject.BindingFlags, transform_to: Function, transform_from: Function): GObject.Binding
/**
* 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().
*/
force_floating(): 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.
*/
freeze_notify(): void
/**
* Gets a named field from the objects table of associations (see g_object_set_data()).
* @param key name of the key for that association
*/
get_data(key: string): object | null
/**
* 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.
* @param property_name the name of the property to get
* @param value return location for the property value
*/
get_property(property_name: string, value: any): void
/**
* This function gets back user data pointers stored via
* g_object_set_qdata().
* @param quark A #GQuark, naming the user data pointer
*/
get_qdata(quark: GLib.Quark): object | null
/**
* 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.
* @param names the names of each property to get
* @param values the values of each property to get
*/
getv(names: string[], values: any[]): void
/**
* Checks whether `object` has a [floating][floating-ref] reference.