@girs/amtk-4 4.0.0-3.0.0-beta.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/amtk-4.d.ts ADDED
@@ -0,0 +1,984 @@
1
+
2
+ /*
3
+ * Type Definitions for Gjs (https://gjs.guide/)
4
+ *
5
+ * These type definitions are automatically generated, do not edit them by hand.
6
+ * If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gjs
7
+ */
8
+ /**
9
+ * Amtk-4
10
+ */
11
+
12
+ import type Gtk from '@girs/gtk-3.0';
13
+ import type xlib from '@girs/xlib-2.0';
14
+ import type Gdk from '@girs/gdk-3.0';
15
+ import type cairo from '@girs/cairo-1.0';
16
+ import type Pango from '@girs/pango-1.0';
17
+ import type HarfBuzz from '@girs/harfbuzz-0.0';
18
+ import type freetype2 from '@girs/freetype2-2.0';
19
+ import type GObject from '@girs/gobject-2.0';
20
+ import type GLib from '@girs/glib-2.0';
21
+ import type Gio from '@girs/gio-2.0';
22
+ import type GdkPixbuf from '@girs/gdkpixbuf-2.0';
23
+ import type GModule from '@girs/gmodule-2.0';
24
+ import type Atk from '@girs/atk-1.0';
25
+
26
+ export namespace Amtk {
27
+
28
+ /**
29
+ * #AmtkFactoryFlags permits to control how a factory function creates the
30
+ * object, to ignore some steps.
31
+ * @bitfield
32
+ */
33
+ enum FactoryFlags {
34
+ /**
35
+ * No flags.
36
+ */
37
+ FLAGS_NONE,
38
+ /**
39
+ * Do not call gtk_actionable_set_action_name().
40
+ */
41
+ IGNORE_GACTION,
42
+ /**
43
+ * Do not set an icon.
44
+ */
45
+ IGNORE_ICON,
46
+ /**
47
+ * Do not set a label/short description.
48
+ */
49
+ IGNORE_LABEL,
50
+ /**
51
+ * Do not set a tooltip/long description.
52
+ */
53
+ IGNORE_TOOLTIP,
54
+ /**
55
+ * Ignore completely the accelerators.
56
+ */
57
+ IGNORE_ACCELS,
58
+ /**
59
+ * Ignore the accelerators for
60
+ * documentation purposes only. For example do not add/configure a
61
+ * #GtkAccelLabel.
62
+ */
63
+ IGNORE_ACCELS_FOR_DOC,
64
+ /**
65
+ * Do not call
66
+ * gtk_application_set_accels_for_action().
67
+ */
68
+ IGNORE_ACCELS_FOR_APP,
69
+ }
70
+ /**
71
+ * A wrapper function for g_action_map_add_action_entries() that checks
72
+ * duplicates.
73
+ *
74
+ * This function first checks - for each entry - that the `action_map` doesn't
75
+ * already contain a #GAction with the same name. A warning is printed if an old
76
+ * action will be dropped. In any case, it then calls
77
+ * g_action_map_add_action_entries() with the same arguments as passed to this
78
+ * function.
79
+ *
80
+ * This function also checks if there are duplicates in the `entries` array
81
+ * itself.
82
+ * @param action_map a #GActionMap.
83
+ * @param entries a pointer to the first item in an array of #GActionEntry structs.
84
+ * @param user_data the user data for signal connections.
85
+ */
86
+ function action_map_add_action_entries_check_dups(action_map: Gio.ActionMap, entries: Gio.ActionEntry[], user_data: any | null): void
87
+ /**
88
+ * Free the resources allocated by Amtk. For example it unrefs the singleton
89
+ * objects.
90
+ *
91
+ * It is not mandatory to call this function, it's just to be friendlier to
92
+ * memory debugging tools. This function is meant to be called at the end of
93
+ * main(). It can be called several times.
94
+ */
95
+ function finalize(): void
96
+ /**
97
+ * Initializes the Amtk library (e.g. for the internationalization).
98
+ *
99
+ * This function can be called several times, but is meant to be called at the
100
+ * beginning of main(), before any other Amtk function call.
101
+ */
102
+ function init(): void
103
+ function menu_item_get_long_description(menu_item: Gtk.MenuItem): string | null
104
+ /**
105
+ * Sets an icon to a #GtkMenuItem.
106
+ *
107
+ * If the child widget of `item` is already a #GtkBox, all #GtkImage widgets
108
+ * inside that box are first destroyed. A #GtkImage for `icon_name` is then
109
+ * inserted to the box.
110
+ *
111
+ * If the child widget of `item` is not a #GtkBox (it's usually the
112
+ * #GtkAccelLabel), it is replaced by a new #GtkBox and the initial child widget
113
+ * is inserted to the #GtkBox, alongside the icon.
114
+ *
115
+ * As a consequence, if you want to call functions on the #GtkAccelLabel, it's
116
+ * easier to do it before calling this function.
117
+ * @param item a #GtkMenuItem.
118
+ * @param icon_name an icon name.
119
+ */
120
+ function menu_item_set_icon_name(item: Gtk.MenuItem, icon_name: string | null): void
121
+ /**
122
+ * Sets the long description of `menu_item`. A possible use-case is to display it
123
+ * in a #GtkStatusbar, or as a tooltip.
124
+ * @param menu_item a #GtkMenuItem.
125
+ * @param long_description the long description, or %NULL to unset it.
126
+ */
127
+ function menu_item_set_long_description(menu_item: Gtk.MenuItem, long_description: string | null): void
128
+ /**
129
+ * Utility function to be able to port an application gradually to #GAction,
130
+ * when #GtkUIManager and #GtkAction are still used. Porting to #GAction should
131
+ * be the first step.
132
+ *
133
+ * For `detailed_g_action_name_without_prefix,` see the
134
+ * g_action_parse_detailed_name() function. The `"app."` or `"win."` prefix (or
135
+ * any other #GActionMap prefix) must not be included in
136
+ * `detailed_g_action_name_without_prefix`. For example a valid
137
+ * `detailed_g_action_name_without_prefix` is `"open"` or
138
+ * `"insert-command::foobar"`.
139
+ *
140
+ * The same #GAction can be bound to several #GtkAction's (with different
141
+ * parameter values for the #GAction), but the reverse is not true, one
142
+ * #GtkAction cannot be bound to several #GAction's.
143
+ *
144
+ * This function:
145
+ * - Calls g_action_activate() when the #GtkAction #GtkAction::activate signal
146
+ * is emitted.
147
+ * - Binds the #GAction #GAction:enabled property to the #GtkAction
148
+ * #GtkAction:sensitive property. The binding is done with the
149
+ * %G_BINDING_BIDIRECTIONAL and %G_BINDING_SYNC_CREATE flags, the source is
150
+ * the #GAction and the target is the #GtkAction.
151
+ *
152
+ * When using this function, you should set the callback to %NULL in the
153
+ * corresponding #GtkActionEntry.
154
+ * @param g_action_map a #GActionMap.
155
+ * @param detailed_g_action_name_without_prefix a detailed #GAction name without the #GActionMap prefix; the #GAction must be present in `g_action_map`.
156
+ * @param gtk_action_group a #GtkActionGroup.
157
+ * @param gtk_action_name a #GtkAction name present in `gtk_action_group`.
158
+ */
159
+ function utils_bind_g_action_to_gtk_action(g_action_map: Gio.ActionMap, detailed_g_action_name_without_prefix: string | null, gtk_action_group: Gtk.ActionGroup, gtk_action_name: string | null): void
160
+ /**
161
+ * Utility function to be able to port an application gradually to #GAction and
162
+ * #AmtkActionInfo, when #GtkUIManager is still used. This function goes one
163
+ * step further compared to amtk_utils_bind_g_action_to_gtk_action(). With
164
+ * amtk_utils_bind_g_action_to_gtk_action(), only the #GAction must exist. With
165
+ * amtk_utils_create_gtk_action(), both the #GAction and #AmtkActionInfo must
166
+ * exist (so typically you need to convert the #GtkActionEntry's into
167
+ * #AmtkActionInfoEntry's).
168
+ *
169
+ * This function creates a #GtkAction from a #GAction plus its corresponding
170
+ * #AmtkActionInfo.
171
+ *
172
+ * The #GtkAction is created with the information provided by the
173
+ * #AmtkActionInfo (retrieved with amtk_action_info_central_store_lookup() with
174
+ * `detailed_g_action_name_with_prefix` as argument). Only the first accelerator
175
+ * is taken into account.
176
+ *
177
+ * Once the #GtkAction is created, it is added to the `gtk_action_group,` and
178
+ * amtk_utils_bind_g_action_to_gtk_action() is called.
179
+ * @param g_action_map a #GActionMap.
180
+ * @param detailed_g_action_name_with_prefix a detailed #GAction name with the #GActionMap prefix; the #GAction must be present in `g_action_map`.
181
+ * @param gtk_action_group a #GtkActionGroup.
182
+ * @param gtk_action_name the name of the #GtkAction to create and add to `gtk_action_group`.
183
+ */
184
+ function utils_create_gtk_action(g_action_map: Gio.ActionMap, detailed_g_action_name_with_prefix: string | null, gtk_action_group: Gtk.ActionGroup, gtk_action_name: string | null): void
185
+ /**
186
+ * Gets the URI of `item`. `item` must be a child of `menu`. `menu` must be a
187
+ * #GtkRecentChooserMenu.
188
+ *
189
+ * This function has been written because the value returned by
190
+ * gtk_recent_chooser_get_current_uri() is not updated when #GtkMenuItem's of a
191
+ * #GtkRecentChooserMenu are selected/deselected.
192
+ * @param menu a #GtkRecentChooserMenu.
193
+ * @param item a #GtkMenuItem.
194
+ * @returns the URI of @item. Free with g_free() when no longer needed.
195
+ */
196
+ function utils_recent_chooser_menu_get_item_uri(menu: Gtk.RecentChooserMenu, item: Gtk.MenuItem): string | null
197
+ module ActionInfoCentralStore {
198
+
199
+ // Constructor properties interface
200
+
201
+ interface ConstructorProperties extends GObject.Object.ConstructorProperties {
202
+ }
203
+
204
+ }
205
+
206
+ interface ActionInfoCentralStore {
207
+
208
+ // Own fields of Amtk-4.Amtk.ActionInfoCentralStore
209
+
210
+ parent: GObject.Object
211
+ priv: ActionInfoCentralStorePrivate
212
+
213
+ // Owm methods of Amtk-4.Amtk.ActionInfoCentralStore
214
+
215
+ lookup(action_name: string | null): ActionInfo
216
+
217
+ // Class property signals of Amtk-4.Amtk.ActionInfoCentralStore
218
+
219
+ connect(sigName: string, callback: (...args: any[]) => void): number
220
+ connect_after(sigName: string, callback: (...args: any[]) => void): number
221
+ emit(sigName: string, ...args: any[]): void
222
+ disconnect(id: number): void
223
+ }
224
+
225
+ class ActionInfoCentralStore extends GObject.Object {
226
+
227
+ // Own properties of Amtk-4.Amtk.ActionInfoCentralStore
228
+
229
+ static name: string
230
+ static $gtype: GObject.GType<ActionInfoCentralStore>
231
+
232
+ // Constructors of Amtk-4.Amtk.ActionInfoCentralStore
233
+
234
+ constructor(config?: ActionInfoCentralStore.ConstructorProperties)
235
+ _init(config?: ActionInfoCentralStore.ConstructorProperties): void
236
+ static get_singleton(): ActionInfoCentralStore
237
+ }
238
+
239
+ module ActionInfoStore {
240
+
241
+ // Constructor properties interface
242
+
243
+ interface ConstructorProperties extends GObject.Object.ConstructorProperties {
244
+ }
245
+
246
+ }
247
+
248
+ interface ActionInfoStore {
249
+
250
+ // Own fields of Amtk-4.Amtk.ActionInfoStore
251
+
252
+ parent: GObject.Object
253
+ priv: ActionInfoStorePrivate
254
+
255
+ // Owm methods of Amtk-4.Amtk.ActionInfoStore
256
+
257
+ /**
258
+ * Inserts `info` into `store` and into the #AmtkActionInfoCentralStore. Both the
259
+ * `store` and central store must <emphasis>not</emphasis> already contain an
260
+ * #AmtkActionInfo with the same action name. The stores take their own
261
+ * reference on `info`.
262
+ * @param info an #AmtkActionInfo.
263
+ */
264
+ add(info: ActionInfo): void
265
+ /**
266
+ * Calls amtk_action_info_store_add() for each entry.
267
+ *
268
+ * If `translation_domain` is not %NULL, g_dgettext() is used to translate the
269
+ * `label` and `tooltip` of each entry before setting them to the #AmtkActionInfo.
270
+ *
271
+ * An API similar to g_action_map_add_action_entries().
272
+ * @param entries a pointer to the first item in an array of #AmtkActionInfoEntry structs.
273
+ * @param translation_domain a gettext domain, or %NULL.
274
+ */
275
+ add_entries(entries: ActionInfoEntry[], translation_domain: string | null): void
276
+ /**
277
+ * Checks for each #AmtkActionInfo of `store` that it has been used (see
278
+ * amtk_action_info_has_been_used()). If an #AmtkActionInfo has not been used, a
279
+ * warning is printed and might indicate dead code.
280
+ *
281
+ * You probably want to call this function on the application store after
282
+ * creating the menu and toolbar. But it can also be useful for a store provided
283
+ * by a library, to easily see which actions are not used by the application.
284
+ */
285
+ check_all_used(): void
286
+ lookup(action_name: string | null): ActionInfo
287
+
288
+ // Class property signals of Amtk-4.Amtk.ActionInfoStore
289
+
290
+ connect(sigName: string, callback: (...args: any[]) => void): number
291
+ connect_after(sigName: string, callback: (...args: any[]) => void): number
292
+ emit(sigName: string, ...args: any[]): void
293
+ disconnect(id: number): void
294
+ }
295
+
296
+ class ActionInfoStore extends GObject.Object {
297
+
298
+ // Own properties of Amtk-4.Amtk.ActionInfoStore
299
+
300
+ static name: string
301
+ static $gtype: GObject.GType<ActionInfoStore>
302
+
303
+ // Constructors of Amtk-4.Amtk.ActionInfoStore
304
+
305
+ constructor(config?: ActionInfoStore.ConstructorProperties)
306
+ constructor()
307
+ static new(): ActionInfoStore
308
+ _init(config?: ActionInfoStore.ConstructorProperties): void
309
+ }
310
+
311
+ module ApplicationWindow {
312
+
313
+ // Constructor properties interface
314
+
315
+ interface ConstructorProperties extends GObject.Object.ConstructorProperties {
316
+
317
+ // Own constructor properties of Amtk-4.Amtk.ApplicationWindow
318
+
319
+ /**
320
+ * The #GtkApplicationWindow.
321
+ */
322
+ application_window?: Gtk.ApplicationWindow | null
323
+ /**
324
+ * The #GtkStatusbar. %NULL by default.
325
+ */
326
+ statusbar?: Gtk.Statusbar | null
327
+ }
328
+
329
+ }
330
+
331
+ interface ApplicationWindow {
332
+
333
+ // Own properties of Amtk-4.Amtk.ApplicationWindow
334
+
335
+ /**
336
+ * The #GtkApplicationWindow.
337
+ */
338
+ readonly application_window: Gtk.ApplicationWindow
339
+ /**
340
+ * The #GtkStatusbar. %NULL by default.
341
+ */
342
+ statusbar: Gtk.Statusbar
343
+
344
+ // Own fields of Amtk-4.Amtk.ApplicationWindow
345
+
346
+ parent: GObject.Object
347
+ priv: ApplicationWindowPrivate
348
+
349
+ // Owm methods of Amtk-4.Amtk.ApplicationWindow
350
+
351
+ /**
352
+ * Connects to the #AmtkMenuShell::menu-item-selected and
353
+ * #AmtkMenuShell::menu-item-deselected signals of `menu_shell` to push/pop the
354
+ * long description of #GtkMenuItem's to the #AmtkApplicationWindow:statusbar.
355
+ *
356
+ * The long description is retrieved with amtk_menu_item_get_long_description().
357
+ * So amtk_menu_item_set_long_description() must have been called, which is the
358
+ * case if the #GtkMenuItem has been created with #AmtkFactory.
359
+ * @param menu_shell a #GtkMenuShell.
360
+ */
361
+ connect_menu_to_statusbar(menu_shell: Gtk.MenuShell): void
362
+ /**
363
+ * An alternative to gtk_recent_chooser_set_show_tips(). Shows the full path in
364
+ * the #AmtkApplicationWindow:statusbar when a #GtkMenuItem of `menu` is
365
+ * selected.
366
+ *
367
+ * The full path is retrieved with
368
+ * amtk_utils_recent_chooser_menu_get_item_uri().
369
+ * @param menu a #GtkRecentChooserMenu.
370
+ */
371
+ connect_recent_chooser_menu_to_statusbar(menu: Gtk.RecentChooserMenu): void
372
+ /**
373
+ * Creates a simple and generic #GtkRecentChooserMenu.
374
+ *
375
+ * The #GtkRecentChooser is configured to show files only recently used with the
376
+ * current application, as returned by g_get_application_name(). If recent files
377
+ * are added to the default #GtkRecentManager with
378
+ * gtk_recent_manager_add_item(), the files will normally show up in the
379
+ * #GtkRecentChooserMenu.
380
+ *
381
+ * The #GtkRecentChooserMenu is connected to the statusbar with
382
+ * amtk_application_window_connect_recent_chooser_menu_to_statusbar().
383
+ *
384
+ * When the #GtkRecentChooser::item-activated signal is emitted,
385
+ * g_application_open() is called (with an empty hint), so the #GApplication
386
+ * must have the %G_APPLICATION_HANDLES_OPEN flag set.
387
+ * @returns a new #GtkRecentChooserMenu.
388
+ */
389
+ create_open_recent_menu(): Gtk.Widget
390
+ /**
391
+ * Creates a #GtkMenuItem with a simple and generic #GtkRecentChooserMenu as
392
+ * submenu. The #GtkRecentChooserMenu is created with
393
+ * amtk_application_window_create_open_recent_menu().
394
+ * @returns a new #GtkMenuItem.
395
+ */
396
+ create_open_recent_menu_item(): Gtk.Widget
397
+ get_application_window(): Gtk.ApplicationWindow
398
+ get_statusbar(): Gtk.Statusbar | null
399
+ /**
400
+ * Sets the #AmtkApplicationWindow:statusbar property.
401
+ * @param statusbar a #GtkStatusbar, or %NULL.
402
+ */
403
+ set_statusbar(statusbar: Gtk.Statusbar | null): void
404
+
405
+ // Class property signals of Amtk-4.Amtk.ApplicationWindow
406
+
407
+ connect(sigName: "notify::application-window", callback: (($obj: ApplicationWindow, pspec: GObject.ParamSpec) => void)): number
408
+ connect_after(sigName: "notify::application-window", callback: (($obj: ApplicationWindow, pspec: GObject.ParamSpec) => void)): number
409
+ emit(sigName: "notify::application-window", ...args: any[]): void
410
+ connect(sigName: "notify::statusbar", callback: (($obj: ApplicationWindow, pspec: GObject.ParamSpec) => void)): number
411
+ connect_after(sigName: "notify::statusbar", callback: (($obj: ApplicationWindow, pspec: GObject.ParamSpec) => void)): number
412
+ emit(sigName: "notify::statusbar", ...args: any[]): void
413
+ connect(sigName: string, callback: (...args: any[]) => void): number
414
+ connect_after(sigName: string, callback: (...args: any[]) => void): number
415
+ emit(sigName: string, ...args: any[]): void
416
+ disconnect(id: number): void
417
+ }
418
+
419
+ class ApplicationWindow extends GObject.Object {
420
+
421
+ // Own properties of Amtk-4.Amtk.ApplicationWindow
422
+
423
+ static name: string
424
+ static $gtype: GObject.GType<ApplicationWindow>
425
+
426
+ // Constructors of Amtk-4.Amtk.ApplicationWindow
427
+
428
+ constructor(config?: ApplicationWindow.ConstructorProperties)
429
+ _init(config?: ApplicationWindow.ConstructorProperties): void
430
+ /**
431
+ * Returns the #AmtkApplicationWindow of `gtk_window`. The returned object is
432
+ * guaranteed to be the same for the lifetime of `gtk_window`.
433
+ * @param gtk_window a #GtkApplicationWindow.
434
+ * @returns the #AmtkApplicationWindow of @gtk_window.
435
+ */
436
+ static get_from_gtk_application_window(gtk_window: Gtk.ApplicationWindow): ApplicationWindow
437
+ }
438
+
439
+ module Factory {
440
+
441
+ // Constructor properties interface
442
+
443
+ interface ConstructorProperties extends GObject.Object.ConstructorProperties {
444
+
445
+ // Own constructor properties of Amtk-4.Amtk.Factory
446
+
447
+ /**
448
+ * The associated #GtkApplication (it is optional, it can be %NULL).
449
+ * #AmtkFactory has a weak reference to the #GtkApplication.
450
+ */
451
+ application?: Gtk.Application | null
452
+ /**
453
+ * The default #AmtkFactoryFlags.
454
+ */
455
+ default_flags?: FactoryFlags | null
456
+ }
457
+
458
+ }
459
+
460
+ interface Factory {
461
+
462
+ // Own properties of Amtk-4.Amtk.Factory
463
+
464
+ /**
465
+ * The associated #GtkApplication (it is optional, it can be %NULL).
466
+ * #AmtkFactory has a weak reference to the #GtkApplication.
467
+ */
468
+ readonly application: Gtk.Application
469
+ /**
470
+ * The default #AmtkFactoryFlags.
471
+ */
472
+ default_flags: FactoryFlags
473
+
474
+ // Own fields of Amtk-4.Amtk.Factory
475
+
476
+ parent: GObject.Object
477
+ priv: FactoryPrivate
478
+
479
+ // Owm methods of Amtk-4.Amtk.Factory
480
+
481
+ /**
482
+ * Creates a new #GtkCheckMenuItem for `action_name` with the
483
+ * #AmtkFactory:default-flags.
484
+ *
485
+ * See the documentation of amtk_factory_create_check_menu_item_full() for more
486
+ * information.
487
+ * @param action_name an action name.
488
+ * @returns a new #GtkCheckMenuItem for @action_name.
489
+ */
490
+ create_check_menu_item(action_name: string | null): Gtk.Widget
491
+ /**
492
+ * This function ignores the #AmtkFactory:default-flags property and takes the
493
+ * `flags` argument instead.
494
+ *
495
+ * Note that since it is a #GtkCheckMenuItem the icon is not set, even if it
496
+ * would be possible with amtk_menu_item_set_icon_name().
497
+ *
498
+ * If the action controls a boolean property, think about using
499
+ * #GPropertyAction.
500
+ * @param action_name an action name.
501
+ * @param flags #AmtkFactoryFlags.
502
+ * @returns a new #GtkCheckMenuItem for @action_name.
503
+ */
504
+ create_check_menu_item_full(action_name: string | null, flags: FactoryFlags): Gtk.Widget
505
+ /**
506
+ * Creates a new #GtkMenuItem for `action_name` with the
507
+ * #AmtkFactory:default-flags.
508
+ * @param action_name an action name.
509
+ * @returns a new #GtkMenuItem for @action_name.
510
+ */
511
+ create_menu_item(action_name: string | null): Gtk.Widget
512
+ /**
513
+ * This function ignores the #AmtkFactory:default-flags property and takes the
514
+ * `flags` argument instead.
515
+ * @param action_name an action name.
516
+ * @param flags #AmtkFactoryFlags.
517
+ * @returns a new #GtkMenuItem for @action_name.
518
+ */
519
+ create_menu_item_full(action_name: string | null, flags: FactoryFlags): Gtk.Widget
520
+ /**
521
+ * Creates a new #GtkMenuToolButton for `action_name` with the
522
+ * #AmtkFactory:default-flags.
523
+ *
524
+ * See the documentation of amtk_factory_create_menu_tool_button_full() for more
525
+ * information.
526
+ * @param action_name an action name.
527
+ * @returns a new #GtkMenuToolButton for @action_name.
528
+ */
529
+ create_menu_tool_button(action_name: string | null): Gtk.MenuToolButton
530
+ /**
531
+ * This function ignores the #AmtkFactory:default-flags property and takes the
532
+ * `flags` argument instead.
533
+ *
534
+ * After calling this function, you need to use the #GtkMenuToolButton API to
535
+ * set the menu and also possibly set a tooltip to the arrow.
536
+ * @param action_name an action name.
537
+ * @param flags #AmtkFactoryFlags.
538
+ * @returns a new #GtkMenuToolButton for @action_name.
539
+ */
540
+ create_menu_tool_button_full(action_name: string | null, flags: FactoryFlags): Gtk.MenuToolButton
541
+ /**
542
+ * Creates a new #GtkToolButton for `action_name` with the
543
+ * #AmtkFactory:default-flags.
544
+ * @param action_name an action name.
545
+ * @returns a new #GtkToolButton for @action_name.
546
+ */
547
+ create_tool_button(action_name: string | null): Gtk.ToolItem
548
+ /**
549
+ * This function ignores the #AmtkFactory:default-flags property and takes the
550
+ * `flags` argument instead.
551
+ * @param action_name an action name.
552
+ * @param flags #AmtkFactoryFlags.
553
+ * @returns a new #GtkToolButton for @action_name.
554
+ */
555
+ create_tool_button_full(action_name: string | null, flags: FactoryFlags): Gtk.ToolItem
556
+ get_application(): Gtk.Application | null
557
+ get_default_flags(): FactoryFlags
558
+ /**
559
+ * Sets the #AmtkFactory:default-flags property.
560
+ * @param default_flags the new value.
561
+ */
562
+ set_default_flags(default_flags: FactoryFlags): void
563
+
564
+ // Class property signals of Amtk-4.Amtk.Factory
565
+
566
+ connect(sigName: "notify::application", callback: (($obj: Factory, pspec: GObject.ParamSpec) => void)): number
567
+ connect_after(sigName: "notify::application", callback: (($obj: Factory, pspec: GObject.ParamSpec) => void)): number
568
+ emit(sigName: "notify::application", ...args: any[]): void
569
+ connect(sigName: "notify::default-flags", callback: (($obj: Factory, pspec: GObject.ParamSpec) => void)): number
570
+ connect_after(sigName: "notify::default-flags", callback: (($obj: Factory, pspec: GObject.ParamSpec) => void)): number
571
+ emit(sigName: "notify::default-flags", ...args: any[]): void
572
+ connect(sigName: string, callback: (...args: any[]) => void): number
573
+ connect_after(sigName: string, callback: (...args: any[]) => void): number
574
+ emit(sigName: string, ...args: any[]): void
575
+ disconnect(id: number): void
576
+ }
577
+
578
+ class Factory extends GObject.Object {
579
+
580
+ // Own properties of Amtk-4.Amtk.Factory
581
+
582
+ static name: string
583
+ static $gtype: GObject.GType<Factory>
584
+
585
+ // Constructors of Amtk-4.Amtk.Factory
586
+
587
+ constructor(config?: Factory.ConstructorProperties)
588
+ /**
589
+ * Creates a new #AmtkFactory object. Associating a #GtkApplication is optional,
590
+ * if it is %NULL gtk_application_set_accels_for_action() won't be called.
591
+ * @constructor
592
+ * @param application a #GtkApplication, or %NULL.
593
+ * @returns a new #AmtkFactory.
594
+ */
595
+ constructor(application: Gtk.Application | null)
596
+ /**
597
+ * Creates a new #AmtkFactory object. Associating a #GtkApplication is optional,
598
+ * if it is %NULL gtk_application_set_accels_for_action() won't be called.
599
+ * @constructor
600
+ * @param application a #GtkApplication, or %NULL.
601
+ * @returns a new #AmtkFactory.
602
+ */
603
+ static new(application: Gtk.Application | null): Factory
604
+ /**
605
+ * Calls amtk_factory_new() with g_application_get_default() (it must be a
606
+ * #GtkApplication).
607
+ * @constructor
608
+ * @returns a new #AmtkFactory with the default #GtkApplication.
609
+ */
610
+ static new_with_default_application(): Factory
611
+ _init(config?: Factory.ConstructorProperties): void
612
+ }
613
+
614
+ module MenuShell {
615
+
616
+ // Signal callback interfaces
617
+
618
+ /**
619
+ * Signal callback interface for `menu-item-deselected`
620
+ */
621
+ interface MenuItemDeselectedSignalCallback {
622
+ ($obj: MenuShell, menu_item: Gtk.MenuItem): void
623
+ }
624
+
625
+ /**
626
+ * Signal callback interface for `menu-item-selected`
627
+ */
628
+ interface MenuItemSelectedSignalCallback {
629
+ ($obj: MenuShell, menu_item: Gtk.MenuItem): void
630
+ }
631
+
632
+
633
+ // Constructor properties interface
634
+
635
+ interface ConstructorProperties extends GObject.Object.ConstructorProperties {
636
+
637
+ // Own constructor properties of Amtk-4.Amtk.MenuShell
638
+
639
+ /**
640
+ * The #GtkMenuShell.
641
+ */
642
+ menu_shell?: Gtk.MenuShell | null
643
+ }
644
+
645
+ }
646
+
647
+ interface MenuShell {
648
+
649
+ // Own properties of Amtk-4.Amtk.MenuShell
650
+
651
+ /**
652
+ * The #GtkMenuShell.
653
+ */
654
+ readonly menu_shell: Gtk.MenuShell
655
+
656
+ // Own fields of Amtk-4.Amtk.MenuShell
657
+
658
+ parent: GObject.Object
659
+ priv: MenuShellPrivate
660
+
661
+ // Owm methods of Amtk-4.Amtk.MenuShell
662
+
663
+ get_menu_shell(): Gtk.MenuShell
664
+
665
+ // Own virtual methods of Amtk-4.Amtk.MenuShell
666
+
667
+ vfunc_menu_item_deselected(menu_item: Gtk.MenuItem): void
668
+ vfunc_menu_item_selected(menu_item: Gtk.MenuItem): void
669
+
670
+ // Own signals of Amtk-4.Amtk.MenuShell
671
+
672
+ connect(sigName: "menu-item-deselected", callback: MenuShell.MenuItemDeselectedSignalCallback): number
673
+ connect_after(sigName: "menu-item-deselected", callback: MenuShell.MenuItemDeselectedSignalCallback): number
674
+ emit(sigName: "menu-item-deselected", menu_item: Gtk.MenuItem, ...args: any[]): void
675
+ connect(sigName: "menu-item-selected", callback: MenuShell.MenuItemSelectedSignalCallback): number
676
+ connect_after(sigName: "menu-item-selected", callback: MenuShell.MenuItemSelectedSignalCallback): number
677
+ emit(sigName: "menu-item-selected", menu_item: Gtk.MenuItem, ...args: any[]): void
678
+
679
+ // Class property signals of Amtk-4.Amtk.MenuShell
680
+
681
+ connect(sigName: "notify::menu-shell", callback: (($obj: MenuShell, pspec: GObject.ParamSpec) => void)): number
682
+ connect_after(sigName: "notify::menu-shell", callback: (($obj: MenuShell, pspec: GObject.ParamSpec) => void)): number
683
+ emit(sigName: "notify::menu-shell", ...args: any[]): void
684
+ connect(sigName: string, callback: (...args: any[]) => void): number
685
+ connect_after(sigName: string, callback: (...args: any[]) => void): number
686
+ emit(sigName: string, ...args: any[]): void
687
+ disconnect(id: number): void
688
+ }
689
+
690
+ class MenuShell extends GObject.Object {
691
+
692
+ // Own properties of Amtk-4.Amtk.MenuShell
693
+
694
+ static name: string
695
+ static $gtype: GObject.GType<MenuShell>
696
+
697
+ // Constructors of Amtk-4.Amtk.MenuShell
698
+
699
+ constructor(config?: MenuShell.ConstructorProperties)
700
+ _init(config?: MenuShell.ConstructorProperties): void
701
+ /**
702
+ * Returns the #AmtkMenuShell of `gtk_menu_shell`. The returned object is
703
+ * guaranteed to be the same for the lifetime of `gtk_menu_shell`.
704
+ * @param gtk_menu_shell a #GtkMenuShell.
705
+ * @returns the #AmtkMenuShell of @gtk_menu_shell.
706
+ */
707
+ static get_from_gtk_menu_shell(gtk_menu_shell: Gtk.MenuShell): MenuShell
708
+ }
709
+
710
+ interface ActionInfo {
711
+
712
+ // Owm methods of Amtk-4.Amtk.ActionInfo
713
+
714
+ copy(): ActionInfo
715
+ /**
716
+ * Returns the accelerators. This function never returns %NULL, it always
717
+ * returns a %NULL-terminated array, to be suitable for
718
+ * gtk_application_set_accels_for_action().
719
+ * @returns a %NULL-terminated array of accelerators in the format understood by gtk_accelerator_parse().
720
+ */
721
+ get_accels(): string[]
722
+ get_action_name(): string | null
723
+ get_icon_name(): string | null
724
+ /**
725
+ * Gets the label. The label has normally a mnemonic.
726
+ * @returns the label (i.e. a short description), or %NULL.
727
+ */
728
+ get_label(): string | null
729
+ get_tooltip(): string | null
730
+ /**
731
+ * Returns whether `info` has been used (for example by an #AmtkFactory
732
+ * function). See also amtk_action_info_store_check_all_used().
733
+ * @returns whether @info has been used.
734
+ */
735
+ has_been_used(): boolean
736
+ /**
737
+ * Mark `info` as used. An #AmtkFactory function that uses an #AmtkActionInfo
738
+ * should call this function. See amtk_action_info_store_check_all_used().
739
+ */
740
+ mark_as_used(): void
741
+ /**
742
+ * Increments the reference count of `info` by one.
743
+ * @returns the passed in @info.
744
+ */
745
+ ref(): ActionInfo
746
+ /**
747
+ * A function similar to gtk_application_set_accels_for_action().
748
+ *
749
+ * `accels` must not be %NULL, it must be a %NULL-terminated array, to be
750
+ * consistent with gtk_application_set_accels_for_action().
751
+ * @param accels a %NULL-terminated array of accelerators in the format understood by gtk_accelerator_parse().
752
+ */
753
+ set_accels(accels: string[]): void
754
+ /**
755
+ * Sets the action name, for example `"win.save"`.
756
+ * @param action_name the action name.
757
+ */
758
+ set_action_name(action_name: string | null): void
759
+ set_icon_name(icon_name: string | null): void
760
+ /**
761
+ * Sets the label with a mnemonic.
762
+ * @param label the label (i.e. a short description), or %NULL.
763
+ */
764
+ set_label(label: string | null): void
765
+ set_tooltip(tooltip: string | null): void
766
+ /**
767
+ * Decrements the reference count of `info` by one. If the reference count drops
768
+ * to 0, `info` is freed.
769
+ */
770
+ unref(): void
771
+ }
772
+
773
+ class ActionInfo {
774
+
775
+ // Own properties of Amtk-4.Amtk.ActionInfo
776
+
777
+ static name: string
778
+
779
+ // Constructors of Amtk-4.Amtk.ActionInfo
780
+
781
+ constructor()
782
+ static new(): ActionInfo
783
+ /**
784
+ * Creates a new #AmtkActionInfo from an #AmtkActionInfoEntry.
785
+ *
786
+ * If `translation_domain` is not %NULL, g_dgettext() is used to translate the
787
+ * `label` and `tooltip` before setting them to the #AmtkActionInfo.
788
+ * @constructor
789
+ * @param info_entry an #AmtkActionInfoEntry.
790
+ * @param translation_domain a gettext domain, or %NULL.
791
+ * @returns a new #AmtkActionInfo.
792
+ */
793
+ static new_from_entry(info_entry: ActionInfoEntry, translation_domain: string | null): ActionInfo
794
+ }
795
+
796
+ interface ActionInfoCentralStoreClass {
797
+
798
+ // Own fields of Amtk-4.Amtk.ActionInfoCentralStoreClass
799
+
800
+ parent_class: GObject.ObjectClass
801
+ padding: any[]
802
+ }
803
+
804
+ abstract class ActionInfoCentralStoreClass {
805
+
806
+ // Own properties of Amtk-4.Amtk.ActionInfoCentralStoreClass
807
+
808
+ static name: string
809
+ }
810
+
811
+ interface ActionInfoCentralStorePrivate {
812
+ }
813
+
814
+ class ActionInfoCentralStorePrivate {
815
+
816
+ // Own properties of Amtk-4.Amtk.ActionInfoCentralStorePrivate
817
+
818
+ static name: string
819
+ }
820
+
821
+ interface ActionInfoEntry {
822
+
823
+ // Own fields of Amtk-4.Amtk.ActionInfoEntry
824
+
825
+ /**
826
+ * the action name.
827
+ * @field
828
+ */
829
+ action_name: string | null
830
+ /**
831
+ * the icon name, or %NULL.
832
+ * @field
833
+ */
834
+ icon_name: string | null
835
+ /**
836
+ * the label (i.e. a short description) with a mnemonic, or %NULL.
837
+ * @field
838
+ */
839
+ label: string | null
840
+ /**
841
+ * the accelerator, in the format understood by gtk_accelerator_parse().
842
+ * Or %NULL.
843
+ * @field
844
+ */
845
+ accel: string | null
846
+ /**
847
+ * the tooltip (i.e. a long description), or %NULL.
848
+ * @field
849
+ */
850
+ tooltip: string | null
851
+ }
852
+
853
+ /**
854
+ * This struct defines a set of information for a single action. It is for use
855
+ * with amtk_action_info_store_add_entries().
856
+ *
857
+ * Like #GActionEntry, it is permissible to use an incomplete initialiser in
858
+ * order to leave some of the later values as %NULL. Additional optional fields
859
+ * may be added in the future.
860
+ * @record
861
+ */
862
+ class ActionInfoEntry {
863
+
864
+ // Own properties of Amtk-4.Amtk.ActionInfoEntry
865
+
866
+ static name: string
867
+ }
868
+
869
+ interface ActionInfoStoreClass {
870
+
871
+ // Own fields of Amtk-4.Amtk.ActionInfoStoreClass
872
+
873
+ parent_class: GObject.ObjectClass
874
+ padding: any[]
875
+ }
876
+
877
+ abstract class ActionInfoStoreClass {
878
+
879
+ // Own properties of Amtk-4.Amtk.ActionInfoStoreClass
880
+
881
+ static name: string
882
+ }
883
+
884
+ interface ActionInfoStorePrivate {
885
+ }
886
+
887
+ class ActionInfoStorePrivate {
888
+
889
+ // Own properties of Amtk-4.Amtk.ActionInfoStorePrivate
890
+
891
+ static name: string
892
+ }
893
+
894
+ interface ApplicationWindowClass {
895
+
896
+ // Own fields of Amtk-4.Amtk.ApplicationWindowClass
897
+
898
+ parent_class: GObject.ObjectClass
899
+ padding: any[]
900
+ }
901
+
902
+ abstract class ApplicationWindowClass {
903
+
904
+ // Own properties of Amtk-4.Amtk.ApplicationWindowClass
905
+
906
+ static name: string
907
+ }
908
+
909
+ interface ApplicationWindowPrivate {
910
+ }
911
+
912
+ class ApplicationWindowPrivate {
913
+
914
+ // Own properties of Amtk-4.Amtk.ApplicationWindowPrivate
915
+
916
+ static name: string
917
+ }
918
+
919
+ interface FactoryClass {
920
+
921
+ // Own fields of Amtk-4.Amtk.FactoryClass
922
+
923
+ parent_class: GObject.ObjectClass
924
+ padding: any[]
925
+ }
926
+
927
+ abstract class FactoryClass {
928
+
929
+ // Own properties of Amtk-4.Amtk.FactoryClass
930
+
931
+ static name: string
932
+ }
933
+
934
+ interface FactoryPrivate {
935
+ }
936
+
937
+ class FactoryPrivate {
938
+
939
+ // Own properties of Amtk-4.Amtk.FactoryPrivate
940
+
941
+ static name: string
942
+ }
943
+
944
+ interface MenuShellClass {
945
+
946
+ // Own fields of Amtk-4.Amtk.MenuShellClass
947
+
948
+ parent_class: GObject.ObjectClass
949
+ menu_item_selected: (amtk_menu_shell: MenuShell, menu_item: Gtk.MenuItem) => void
950
+ menu_item_deselected: (amtk_menu_shell: MenuShell, menu_item: Gtk.MenuItem) => void
951
+ padding: any[]
952
+ }
953
+
954
+ abstract class MenuShellClass {
955
+
956
+ // Own properties of Amtk-4.Amtk.MenuShellClass
957
+
958
+ static name: string
959
+ }
960
+
961
+ interface MenuShellPrivate {
962
+ }
963
+
964
+ class MenuShellPrivate {
965
+
966
+ // Own properties of Amtk-4.Amtk.MenuShellPrivate
967
+
968
+ static name: string
969
+ }
970
+
971
+ /**
972
+ * Name of the imported GIR library
973
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
974
+ */
975
+ const __name__: string
976
+ /**
977
+ * Version of the imported GIR library
978
+ * @see https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
979
+ */
980
+ const __version__: string
981
+ }
982
+
983
+ export default Amtk;
984
+ // END