@girs/xed-1.0 4.3.0 → 4.4.0
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/README.md +1 -1
- package/package.json +16 -16
- package/xed-1.0-surface.d.ts +20 -0
- package/xed-1.0-surface.js +6 -0
- package/xed-1.0.d.ts +121 -0
package/README.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|

|
|
6
6
|
|
|
7
7
|
|
|
8
|
-
GJS TypeScript type definitions for Xed-1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.
|
|
8
|
+
GJS TypeScript type definitions for Xed-1.0 using [ts-for-gir](https://github.com/gjsify/ts-for-gir) v4.4.0.
|
|
9
9
|
|
|
10
10
|
## Install
|
|
11
11
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@girs/xed-1.0",
|
|
3
|
-
"version": "4.
|
|
3
|
+
"version": "4.4.0",
|
|
4
4
|
"description": "GJS TypeScript type definitions for Xed-1.0",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"module": "xed-1.0.js",
|
|
@@ -36,21 +36,21 @@
|
|
|
36
36
|
"test": "tsc --project tsconfig.json"
|
|
37
37
|
},
|
|
38
38
|
"dependencies": {
|
|
39
|
-
"@girs/gjs": "^4.
|
|
40
|
-
"@girs/gtksource-4": "^4.
|
|
41
|
-
"@girs/gtk-3.0": "^4.
|
|
42
|
-
"@girs/xlib-2.0": "^4.
|
|
43
|
-
"@girs/gdk-3.0": "^4.
|
|
44
|
-
"@girs/cairo-1.0": "^4.
|
|
45
|
-
"@girs/gobject-2.0": "^4.
|
|
46
|
-
"@girs/glib-2.0": "^4.
|
|
47
|
-
"@girs/pango-1.0": "^4.
|
|
48
|
-
"@girs/harfbuzz-0.0": "^4.
|
|
49
|
-
"@girs/freetype2-2.0": "^4.
|
|
50
|
-
"@girs/gio-2.0": "^4.
|
|
51
|
-
"@girs/gmodule-2.0": "^4.
|
|
52
|
-
"@girs/gdkpixbuf-2.0": "^4.
|
|
53
|
-
"@girs/atk-1.0": "^4.
|
|
39
|
+
"@girs/gjs": "^4.4.0",
|
|
40
|
+
"@girs/gtksource-4": "^4.4.0",
|
|
41
|
+
"@girs/gtk-3.0": "^4.4.0",
|
|
42
|
+
"@girs/xlib-2.0": "^4.4.0",
|
|
43
|
+
"@girs/gdk-3.0": "^4.4.0",
|
|
44
|
+
"@girs/cairo-1.0": "^4.4.0",
|
|
45
|
+
"@girs/gobject-2.0": "^4.4.0",
|
|
46
|
+
"@girs/glib-2.0": "^4.4.0",
|
|
47
|
+
"@girs/pango-1.0": "^4.4.0",
|
|
48
|
+
"@girs/harfbuzz-0.0": "^4.4.0",
|
|
49
|
+
"@girs/freetype2-2.0": "^4.4.0",
|
|
50
|
+
"@girs/gio-2.0": "^4.4.0",
|
|
51
|
+
"@girs/gmodule-2.0": "^4.4.0",
|
|
52
|
+
"@girs/gdkpixbuf-2.0": "^4.4.0",
|
|
53
|
+
"@girs/atk-1.0": "^4.4.0" },
|
|
54
54
|
"devDependencies": {
|
|
55
55
|
"typescript": "*"
|
|
56
56
|
},
|
package/xed-1.0-surface.d.ts
CHANGED
|
@@ -202,6 +202,23 @@ export interface Widgets {
|
|
|
202
202
|
/** Every GType this namespace can create. A consumer derives its own tag map. */
|
|
203
203
|
export type WidgetGType = keyof Widgets;
|
|
204
204
|
|
|
205
|
+
// ---------------------------------------------------------------------------
|
|
206
|
+
// Child holders — the same shape, for objects that CARRY a widget without being one.
|
|
207
|
+
//
|
|
208
|
+
// `GtkListItem`, `GtkListHeader`, `GtkColumnViewCell` and `AdwToggle` descend from
|
|
209
|
+
// `GObject.Object` and hold a widget through `set_child`/`get_child`. A renderer places
|
|
210
|
+
// them exactly like a container, so they belong in the vocabulary; a check asking "is
|
|
211
|
+
// this a widget" must still be able to say no. Hence a sibling table rather than four
|
|
212
|
+
// more rows in `Widgets`: concatenate them when you mean both.
|
|
213
|
+
// ---------------------------------------------------------------------------
|
|
214
|
+
|
|
215
|
+
export interface ChildHolders {
|
|
216
|
+
|
|
217
|
+
}
|
|
218
|
+
|
|
219
|
+
/** Every GType this namespace holds a child in without it being a widget. */
|
|
220
|
+
export type ChildHolderGType = keyof ChildHolders;
|
|
221
|
+
|
|
205
222
|
/** The writable, optional, GObject-keyed property surface of one GType. */
|
|
206
223
|
export type PropsOf<G extends WidgetGType> = Widgets[G]['props'];
|
|
207
224
|
|
|
@@ -237,6 +254,9 @@ export const OWN_SIGNALS: Readonly<Record<string, readonly string[]>>;
|
|
|
237
254
|
/** Widget GType -> every declaration its members come from, self first. */
|
|
238
255
|
export const DECLS: Readonly<Record<string, readonly string[]>>;
|
|
239
256
|
|
|
257
|
+
/** The GTypes in `DECLS` that hold a widget without being one — see `ChildHolders`. */
|
|
258
|
+
export const CHILD_HOLDERS: readonly string[];
|
|
259
|
+
|
|
240
260
|
/** Enum GType -> the nicks this surface offers. */
|
|
241
261
|
export const ENUM_NICKS: Readonly<Record<string, readonly string[]>>;
|
|
242
262
|
|
package/xed-1.0-surface.js
CHANGED
|
@@ -35,6 +35,12 @@ export const DECLS = {
|
|
|
35
35
|
XedWindow: ['XedWindow', 'GtkApplicationWindow', 'GtkWindow', 'GtkBin', 'GtkContainer', 'GtkWidget', 'GtkBuildable'],
|
|
36
36
|
};
|
|
37
37
|
|
|
38
|
+
// The GTypes above that are NOT widgets: they hold one through `set_child`/`get_child`
|
|
39
|
+
// and descend from `GObject.Object`. A renderer places them like a container; a check
|
|
40
|
+
// asking "is this a widget" must not count them. Derived from the accessor pair, never
|
|
41
|
+
// from a list — the count is in the provenance line above.
|
|
42
|
+
export const CHILD_HOLDERS = [];
|
|
43
|
+
|
|
38
44
|
export const ENUM_NICKS = {
|
|
39
45
|
XedSearchMode: ['search', 'replace'],
|
|
40
46
|
XedTabState: ['state-normal', 'state-loading', 'state-reverting', 'state-saving', 'state-printing', 'state-print-previewing', 'state-showing-print-preview', 'state-generic-not-editable', 'state-loading-error', 'state-reverting-error', 'state-saving-error', 'state-generic-error', 'state-closing', 'state-externally-modified-notification', 'num-of-states'],
|
package/xed-1.0.d.ts
CHANGED
|
@@ -1005,12 +1005,14 @@ export namespace Xed {
|
|
|
1005
1005
|
* @param cell a {@link Gtk.CellRenderer}
|
|
1006
1006
|
* @param attribute an attribute on the renderer
|
|
1007
1007
|
* @param column the column position on the model to get the attribute from
|
|
1008
|
+
* @since 2.4
|
|
1008
1009
|
*/
|
|
1009
1010
|
add_attribute(cell: Gtk.CellRenderer, attribute: string, column: number): void;
|
|
1010
1011
|
|
|
1011
1012
|
/**
|
|
1012
1013
|
* Unsets all the mappings on all renderers on `cell_layout` and
|
|
1013
1014
|
* removes all renderers from `cell_layout`.
|
|
1015
|
+
* @since 2.4
|
|
1014
1016
|
*/
|
|
1015
1017
|
clear(): void;
|
|
1016
1018
|
|
|
@@ -1018,6 +1020,7 @@ export namespace Xed {
|
|
|
1018
1020
|
* Clears all existing attributes previously set with
|
|
1019
1021
|
* `gtk_cell_layout_set_attributes()`.
|
|
1020
1022
|
* @param cell a {@link Gtk.CellRenderer} to clear the attribute mapping on
|
|
1023
|
+
* @since 2.4
|
|
1021
1024
|
*/
|
|
1022
1025
|
clear_attributes(cell: Gtk.CellRenderer): void;
|
|
1023
1026
|
|
|
@@ -1026,12 +1029,14 @@ export namespace Xed {
|
|
|
1026
1029
|
* if called on a {@link Gtk.CellArea} or might be `null` if no {@link Gtk.CellArea}
|
|
1027
1030
|
* is used by `cell_layout`.
|
|
1028
1031
|
* @returns the cell area used by `cell_layout`, or `null` in case no cell area is used.
|
|
1032
|
+
* @since 3.0
|
|
1029
1033
|
*/
|
|
1030
1034
|
get_area(): Gtk.CellArea | null;
|
|
1031
1035
|
|
|
1032
1036
|
/**
|
|
1033
1037
|
* Returns the cell renderers which have been added to `cell_layout`.
|
|
1034
1038
|
* @returns a list of cell renderers. The list, but not the renderers has been newly allocated and should be freed with `g_list_free()` when no longer needed.
|
|
1039
|
+
* @since 2.12
|
|
1035
1040
|
*/
|
|
1036
1041
|
get_cells(): Gtk.CellRenderer[];
|
|
1037
1042
|
|
|
@@ -1043,6 +1048,7 @@ export namespace Xed {
|
|
|
1043
1048
|
* Note that reusing the same cell renderer is not supported.
|
|
1044
1049
|
* @param cell a {@link Gtk.CellRenderer}
|
|
1045
1050
|
* @param expand `true` if `cell` is to be given extra space allocated to `cell_layout`
|
|
1051
|
+
* @since 2.4
|
|
1046
1052
|
*/
|
|
1047
1053
|
pack_end(cell: Gtk.CellRenderer, expand: boolean): void;
|
|
1048
1054
|
|
|
@@ -1054,6 +1060,7 @@ export namespace Xed {
|
|
|
1054
1060
|
* Note that reusing the same cell renderer is not supported.
|
|
1055
1061
|
* @param cell a {@link Gtk.CellRenderer}
|
|
1056
1062
|
* @param expand `true` if `cell` is to be given extra space allocated to `cell_layout`
|
|
1063
|
+
* @since 2.4
|
|
1057
1064
|
*/
|
|
1058
1065
|
pack_start(cell: Gtk.CellRenderer, expand: boolean): void;
|
|
1059
1066
|
|
|
@@ -1064,6 +1071,7 @@ export namespace Xed {
|
|
|
1064
1071
|
* for this to function properly.
|
|
1065
1072
|
* @param cell a {@link Gtk.CellRenderer} to reorder
|
|
1066
1073
|
* @param position new position to insert `cell` at
|
|
1074
|
+
* @since 2.4
|
|
1067
1075
|
*/
|
|
1068
1076
|
reorder(cell: Gtk.CellRenderer, position: number): void;
|
|
1069
1077
|
|
|
@@ -1077,6 +1085,7 @@ export namespace Xed {
|
|
|
1077
1085
|
* `func` may be `null` to remove a previously set function.
|
|
1078
1086
|
* @param cell a {@link Gtk.CellRenderer}
|
|
1079
1087
|
* @param func the {@link Gtk.CellLayoutDataFunc} to use, or `null`
|
|
1088
|
+
* @since 2.4
|
|
1080
1089
|
*/
|
|
1081
1090
|
set_cell_data_func(cell: Gtk.CellRenderer, func: Gtk.CellLayoutDataFunc | null): void;
|
|
1082
1091
|
|
|
@@ -1090,6 +1099,7 @@ export namespace Xed {
|
|
|
1090
1099
|
* @param cell a {@link Gtk.CellRenderer}
|
|
1091
1100
|
* @param attribute an attribute on the renderer
|
|
1092
1101
|
* @param column the column position on the model to get the attribute from
|
|
1102
|
+
* @since 2.4
|
|
1093
1103
|
* @virtual
|
|
1094
1104
|
*/
|
|
1095
1105
|
vfunc_add_attribute(cell: Gtk.CellRenderer, attribute: string, column: number): void;
|
|
@@ -1097,6 +1107,7 @@ export namespace Xed {
|
|
|
1097
1107
|
/**
|
|
1098
1108
|
* Unsets all the mappings on all renderers on `cell_layout` and
|
|
1099
1109
|
* removes all renderers from `cell_layout`.
|
|
1110
|
+
* @since 2.4
|
|
1100
1111
|
* @virtual
|
|
1101
1112
|
*/
|
|
1102
1113
|
vfunc_clear(): void;
|
|
@@ -1105,6 +1116,7 @@ export namespace Xed {
|
|
|
1105
1116
|
* Clears all existing attributes previously set with
|
|
1106
1117
|
* `gtk_cell_layout_set_attributes()`.
|
|
1107
1118
|
* @param cell a {@link Gtk.CellRenderer} to clear the attribute mapping on
|
|
1119
|
+
* @since 2.4
|
|
1108
1120
|
* @virtual
|
|
1109
1121
|
*/
|
|
1110
1122
|
vfunc_clear_attributes(cell: Gtk.CellRenderer): void;
|
|
@@ -1113,12 +1125,14 @@ export namespace Xed {
|
|
|
1113
1125
|
* Returns the underlying {@link Gtk.CellArea} which might be `cell_layout`
|
|
1114
1126
|
* if called on a {@link Gtk.CellArea} or might be `null` if no {@link Gtk.CellArea}
|
|
1115
1127
|
* is used by `cell_layout`.
|
|
1128
|
+
* @since 3.0
|
|
1116
1129
|
* @virtual
|
|
1117
1130
|
*/
|
|
1118
1131
|
vfunc_get_area(): Gtk.CellArea | null;
|
|
1119
1132
|
|
|
1120
1133
|
/**
|
|
1121
1134
|
* Returns the cell renderers which have been added to `cell_layout`.
|
|
1135
|
+
* @since 2.12
|
|
1122
1136
|
* @virtual
|
|
1123
1137
|
*/
|
|
1124
1138
|
vfunc_get_cells(): Gtk.CellRenderer[];
|
|
@@ -1131,6 +1145,7 @@ export namespace Xed {
|
|
|
1131
1145
|
* Note that reusing the same cell renderer is not supported.
|
|
1132
1146
|
* @param cell a {@link Gtk.CellRenderer}
|
|
1133
1147
|
* @param expand `true` if `cell` is to be given extra space allocated to `cell_layout`
|
|
1148
|
+
* @since 2.4
|
|
1134
1149
|
* @virtual
|
|
1135
1150
|
*/
|
|
1136
1151
|
vfunc_pack_end(cell: Gtk.CellRenderer, expand: boolean): void;
|
|
@@ -1143,6 +1158,7 @@ export namespace Xed {
|
|
|
1143
1158
|
* Note that reusing the same cell renderer is not supported.
|
|
1144
1159
|
* @param cell a {@link Gtk.CellRenderer}
|
|
1145
1160
|
* @param expand `true` if `cell` is to be given extra space allocated to `cell_layout`
|
|
1161
|
+
* @since 2.4
|
|
1146
1162
|
* @virtual
|
|
1147
1163
|
*/
|
|
1148
1164
|
vfunc_pack_start(cell: Gtk.CellRenderer, expand: boolean): void;
|
|
@@ -1154,6 +1170,7 @@ export namespace Xed {
|
|
|
1154
1170
|
* for this to function properly.
|
|
1155
1171
|
* @param cell a {@link Gtk.CellRenderer} to reorder
|
|
1156
1172
|
* @param position new position to insert `cell` at
|
|
1173
|
+
* @since 2.4
|
|
1157
1174
|
* @virtual
|
|
1158
1175
|
*/
|
|
1159
1176
|
vfunc_reorder(cell: Gtk.CellRenderer, position: number): void;
|
|
@@ -1168,6 +1185,7 @@ export namespace Xed {
|
|
|
1168
1185
|
* `func` may be `null` to remove a previously set function.
|
|
1169
1186
|
* @param cell a {@link Gtk.CellRenderer}
|
|
1170
1187
|
* @param func the {@link Gtk.CellLayoutDataFunc} to use, or `null`
|
|
1188
|
+
* @since 2.4
|
|
1171
1189
|
* @virtual
|
|
1172
1190
|
*/
|
|
1173
1191
|
vfunc_set_cell_data_func(cell: Gtk.CellRenderer, func: Gtk.CellLayoutDataFunc | null): void;
|
|
@@ -1194,6 +1212,7 @@ export namespace Xed {
|
|
|
1194
1212
|
* Returns whether the widget should grab focus when it is clicked with the mouse.
|
|
1195
1213
|
* See `gtk_widget_set_focus_on_click()`.
|
|
1196
1214
|
* @returns `true` if the widget should grab focus when it is clicked with the mouse.
|
|
1215
|
+
* @since 3.20
|
|
1197
1216
|
*/
|
|
1198
1217
|
get_focus_on_click(): boolean;
|
|
1199
1218
|
|
|
@@ -1203,6 +1222,7 @@ export namespace Xed {
|
|
|
1203
1222
|
* you don’t want the keyboard focus removed from the main area of the
|
|
1204
1223
|
* application.
|
|
1205
1224
|
* @param focus_on_click whether the widget should grab focus when clicked with the mouse
|
|
1225
|
+
* @since 3.20
|
|
1206
1226
|
*/
|
|
1207
1227
|
set_focus_on_click(focus_on_click: boolean): void;
|
|
1208
1228
|
}
|
|
@@ -1503,6 +1523,7 @@ export namespace Xed {
|
|
|
1503
1523
|
* @param label user-visible label for the added choice
|
|
1504
1524
|
* @param options ids for the options of the choice, or `null` for a boolean choice
|
|
1505
1525
|
* @param option_labels user-visible labels for the options, must be the same length as `options`
|
|
1526
|
+
* @since 3.22
|
|
1506
1527
|
*/
|
|
1507
1528
|
add_choice(id: string, label: string, options: string[] | null, option_labels: string[] | null): void;
|
|
1508
1529
|
|
|
@@ -1514,6 +1535,7 @@ export namespace Xed {
|
|
|
1514
1535
|
* Note that the `chooser` takes ownership of the filter, so you have to
|
|
1515
1536
|
* ref and sink it if you want to keep a reference.
|
|
1516
1537
|
* @param filter a {@link Gtk.FileFilter}
|
|
1538
|
+
* @since 2.4
|
|
1517
1539
|
*/
|
|
1518
1540
|
add_filter(filter: Gtk.FileFilter): void;
|
|
1519
1541
|
|
|
@@ -1524,6 +1546,7 @@ export namespace Xed {
|
|
|
1524
1546
|
* “/usr/share/mydrawprogram/Clipart” folder to the volume list.
|
|
1525
1547
|
* @param folder filename of the folder to add
|
|
1526
1548
|
* @returns `true` if the folder could be added successfully, `false` otherwise. In the latter case, the `error` will be set as appropriate.
|
|
1549
|
+
* @since 2.4
|
|
1527
1550
|
*/
|
|
1528
1551
|
add_shortcut_folder(folder: string): boolean;
|
|
1529
1552
|
|
|
@@ -1534,6 +1557,7 @@ export namespace Xed {
|
|
|
1534
1557
|
* “file:///usr/share/mydrawprogram/Clipart” folder to the volume list.
|
|
1535
1558
|
* @param uri URI of the folder to add
|
|
1536
1559
|
* @returns `true` if the folder could be added successfully, `false` otherwise. In the latter case, the `error` will be set as appropriate.
|
|
1560
|
+
* @since 2.4
|
|
1537
1561
|
*/
|
|
1538
1562
|
add_shortcut_folder_uri(uri: string): boolean;
|
|
1539
1563
|
|
|
@@ -1541,6 +1565,7 @@ export namespace Xed {
|
|
|
1541
1565
|
* Gets the type of operation that the file chooser is performing; see
|
|
1542
1566
|
* `gtk_file_chooser_set_action()`.
|
|
1543
1567
|
* @returns the action that the file selector is performing
|
|
1568
|
+
* @since 2.4
|
|
1544
1569
|
*/
|
|
1545
1570
|
get_action(): Gtk.FileChooserAction;
|
|
1546
1571
|
|
|
@@ -1548,6 +1573,7 @@ export namespace Xed {
|
|
|
1548
1573
|
* Gets the currently selected option in the 'choice' with the given ID.
|
|
1549
1574
|
* @param id the ID of the choice to get
|
|
1550
1575
|
* @returns the ID of the currenly selected option
|
|
1576
|
+
* @since 3.22
|
|
1551
1577
|
*/
|
|
1552
1578
|
get_choice(id: string): string;
|
|
1553
1579
|
|
|
@@ -1555,6 +1581,7 @@ export namespace Xed {
|
|
|
1555
1581
|
* Gets whether file choser will offer to create new folders.
|
|
1556
1582
|
* See `gtk_file_chooser_set_create_folders()`.
|
|
1557
1583
|
* @returns `true` if the Create Folder button should be displayed.
|
|
1584
|
+
* @since 2.18
|
|
1558
1585
|
*/
|
|
1559
1586
|
get_create_folders(): boolean;
|
|
1560
1587
|
|
|
@@ -1570,6 +1597,7 @@ export namespace Xed {
|
|
|
1570
1597
|
* currently-selected folder in that mode, use `gtk_file_chooser_get_uri()` as the
|
|
1571
1598
|
* usual way to get the selection.
|
|
1572
1599
|
* @returns the full path of the current folder, or `null` if the current path cannot be represented as a local filename. Free with `g_free()`. This function will also return `null` if the file chooser was unable to load the last folder that was requested from it; for example, as would be for calling `gtk_file_chooser_set_current_folder()` on a nonexistent folder.
|
|
1600
|
+
* @since 2.4
|
|
1573
1601
|
*/
|
|
1574
1602
|
get_current_folder(): string | null;
|
|
1575
1603
|
|
|
@@ -1577,6 +1605,7 @@ export namespace Xed {
|
|
|
1577
1605
|
* Gets the current folder of `chooser` as {@link Gio.File}.
|
|
1578
1606
|
* See `gtk_file_chooser_get_current_folder_uri()`.
|
|
1579
1607
|
* @returns the {@link Gio.File} for the current folder.
|
|
1608
|
+
* @since 2.14
|
|
1580
1609
|
*/
|
|
1581
1610
|
get_current_folder_file(): Gio.File | null;
|
|
1582
1611
|
|
|
@@ -1592,6 +1621,7 @@ export namespace Xed {
|
|
|
1592
1621
|
* currently-selected folder in that mode, use `gtk_file_chooser_get_uri()` as the
|
|
1593
1622
|
* usual way to get the selection.
|
|
1594
1623
|
* @returns the URI for the current folder. Free with `g_free()`. This function will also return `null` if the file chooser was unable to load the last folder that was requested from it; for example, as would be for calling `gtk_file_chooser_set_current_folder_uri()` on a nonexistent folder.
|
|
1624
|
+
* @since 2.4
|
|
1595
1625
|
*/
|
|
1596
1626
|
get_current_folder_uri(): string | null;
|
|
1597
1627
|
|
|
@@ -1605,6 +1635,7 @@ export namespace Xed {
|
|
|
1605
1635
|
* change the extension of the typed filename based on the chosen format, say,
|
|
1606
1636
|
* from “.jpg” to “.png”.
|
|
1607
1637
|
* @returns The raw text from the file chooser’s “Name” entry. Free this with `g_free()`. Note that this string is not a full pathname or URI; it is whatever the contents of the entry are. Note also that this string is in UTF-8 encoding, which is not necessarily the system’s encoding for filenames.
|
|
1638
|
+
* @since 3.10
|
|
1608
1639
|
*/
|
|
1609
1640
|
get_current_name(): string;
|
|
1610
1641
|
|
|
@@ -1612,6 +1643,7 @@ export namespace Xed {
|
|
|
1612
1643
|
* Queries whether a file chooser is set to confirm for overwriting when the user
|
|
1613
1644
|
* types a file name that already exists.
|
|
1614
1645
|
* @returns `true` if the file chooser will present a confirmation dialog; `false` otherwise.
|
|
1646
|
+
* @since 2.8
|
|
1615
1647
|
*/
|
|
1616
1648
|
get_do_overwrite_confirmation(): boolean;
|
|
1617
1649
|
|
|
@@ -1619,6 +1651,7 @@ export namespace Xed {
|
|
|
1619
1651
|
* Gets the current extra widget; see
|
|
1620
1652
|
* `gtk_file_chooser_set_extra_widget()`.
|
|
1621
1653
|
* @returns the current extra widget, or `null`
|
|
1654
|
+
* @since 2.4
|
|
1622
1655
|
*/
|
|
1623
1656
|
get_extra_widget(): Gtk.Widget | null;
|
|
1624
1657
|
|
|
@@ -1630,6 +1663,7 @@ export namespace Xed {
|
|
|
1630
1663
|
* If the file chooser is in folder mode, this function returns the selected
|
|
1631
1664
|
* folder.
|
|
1632
1665
|
* @returns a selected {@link Gio.File}. You own the returned file; use `g_object_unref()` to release it.
|
|
1666
|
+
* @since 2.14
|
|
1633
1667
|
*/
|
|
1634
1668
|
get_file(): Gio.File;
|
|
1635
1669
|
|
|
@@ -1642,6 +1676,7 @@ export namespace Xed {
|
|
|
1642
1676
|
* If the file chooser is in folder mode, this function returns the selected
|
|
1643
1677
|
* folder.
|
|
1644
1678
|
* @returns The currently selected filename, or `null` if no file is selected, or the selected file can't be represented with a local filename. Free with `g_free()`.
|
|
1679
|
+
* @since 2.4
|
|
1645
1680
|
*/
|
|
1646
1681
|
get_filename(): string | null;
|
|
1647
1682
|
|
|
@@ -1651,6 +1686,7 @@ export namespace Xed {
|
|
|
1651
1686
|
* folder cannot be represented as local filenames they will be ignored. (See
|
|
1652
1687
|
* `gtk_file_chooser_get_uris()`)
|
|
1653
1688
|
* @returns a {@link GLib.SList} containing the filenames of all selected files and subfolders in the current folder. Free the returned list with `g_slist_free()`, and the filenames with `g_free()`.
|
|
1689
|
+
* @since 2.4
|
|
1654
1690
|
*/
|
|
1655
1691
|
get_filenames(): string[];
|
|
1656
1692
|
|
|
@@ -1658,12 +1694,14 @@ export namespace Xed {
|
|
|
1658
1694
|
* Lists all the selected files and subfolders in the current folder of `chooser`
|
|
1659
1695
|
* as {@link Gio.File}. An internal function, see `gtk_file_chooser_get_uris()`.
|
|
1660
1696
|
* @returns a {@link GLib.SList} containing a {@link Gio.File} for each selected file and subfolder in the current folder. Free the returned list with `g_slist_free()`, and the files with `g_object_unref()`.
|
|
1697
|
+
* @since 2.14
|
|
1661
1698
|
*/
|
|
1662
1699
|
get_files(): Gio.File[];
|
|
1663
1700
|
|
|
1664
1701
|
/**
|
|
1665
1702
|
* Gets the current filter; see `gtk_file_chooser_set_filter()`.
|
|
1666
1703
|
* @returns the current filter, or `null`
|
|
1704
|
+
* @since 2.4
|
|
1667
1705
|
*/
|
|
1668
1706
|
get_filter(): Gtk.FileFilter | null;
|
|
1669
1707
|
|
|
@@ -1671,6 +1709,7 @@ export namespace Xed {
|
|
|
1671
1709
|
* Gets whether only local files can be selected in the
|
|
1672
1710
|
* file selector. See `gtk_file_chooser_set_local_only()`
|
|
1673
1711
|
* @returns `true` if only local files can be selected.
|
|
1712
|
+
* @since 2.4
|
|
1674
1713
|
*/
|
|
1675
1714
|
get_local_only(): boolean;
|
|
1676
1715
|
|
|
@@ -1678,6 +1717,7 @@ export namespace Xed {
|
|
|
1678
1717
|
* Gets the {@link Gio.File} that should be previewed in a custom preview
|
|
1679
1718
|
* Internal function, see `gtk_file_chooser_get_preview_uri()`.
|
|
1680
1719
|
* @returns the {@link Gio.File} for the file to preview, or `null` if no file is selected. Free with `g_object_unref()`.
|
|
1720
|
+
* @since 2.14
|
|
1681
1721
|
*/
|
|
1682
1722
|
get_preview_file(): Gio.File | null;
|
|
1683
1723
|
|
|
@@ -1685,6 +1725,7 @@ export namespace Xed {
|
|
|
1685
1725
|
* Gets the filename that should be previewed in a custom preview
|
|
1686
1726
|
* widget. See `gtk_file_chooser_set_preview_widget()`.
|
|
1687
1727
|
* @returns the filename to preview, or `null` if no file is selected, or if the selected file cannot be represented as a local filename. Free with `g_free()`
|
|
1728
|
+
* @since 2.4
|
|
1688
1729
|
*/
|
|
1689
1730
|
get_preview_filename(): string | null;
|
|
1690
1731
|
|
|
@@ -1692,6 +1733,7 @@ export namespace Xed {
|
|
|
1692
1733
|
* Gets the URI that should be previewed in a custom preview
|
|
1693
1734
|
* widget. See `gtk_file_chooser_set_preview_widget()`.
|
|
1694
1735
|
* @returns the URI for the file to preview, or `null` if no file is selected. Free with `g_free()`.
|
|
1736
|
+
* @since 2.4
|
|
1695
1737
|
*/
|
|
1696
1738
|
get_preview_uri(): string | null;
|
|
1697
1739
|
|
|
@@ -1699,6 +1741,7 @@ export namespace Xed {
|
|
|
1699
1741
|
* Gets the current preview widget; see
|
|
1700
1742
|
* `gtk_file_chooser_set_preview_widget()`.
|
|
1701
1743
|
* @returns the current preview widget, or `null`
|
|
1744
|
+
* @since 2.4
|
|
1702
1745
|
*/
|
|
1703
1746
|
get_preview_widget(): Gtk.Widget | null;
|
|
1704
1747
|
|
|
@@ -1707,6 +1750,7 @@ export namespace Xed {
|
|
|
1707
1750
|
* should be shown for the current filename. See
|
|
1708
1751
|
* `gtk_file_chooser_set_preview_widget_active()`.
|
|
1709
1752
|
* @returns `true` if the preview widget is active for the current filename.
|
|
1753
|
+
* @since 2.4
|
|
1710
1754
|
*/
|
|
1711
1755
|
get_preview_widget_active(): boolean;
|
|
1712
1756
|
|
|
@@ -1714,6 +1758,7 @@ export namespace Xed {
|
|
|
1714
1758
|
* Gets whether multiple files can be selected in the file
|
|
1715
1759
|
* selector. See `gtk_file_chooser_set_select_multiple()`.
|
|
1716
1760
|
* @returns `true` if multiple files can be selected.
|
|
1761
|
+
* @since 2.4
|
|
1717
1762
|
*/
|
|
1718
1763
|
get_select_multiple(): boolean;
|
|
1719
1764
|
|
|
@@ -1721,6 +1766,7 @@ export namespace Xed {
|
|
|
1721
1766
|
* Gets whether hidden files and folders are displayed in the file selector.
|
|
1722
1767
|
* See `gtk_file_chooser_set_show_hidden()`.
|
|
1723
1768
|
* @returns `true` if hidden files and folders are displayed.
|
|
1769
|
+
* @since 2.6
|
|
1724
1770
|
*/
|
|
1725
1771
|
get_show_hidden(): boolean;
|
|
1726
1772
|
|
|
@@ -1732,6 +1778,7 @@ export namespace Xed {
|
|
|
1732
1778
|
* If the file chooser is in folder mode, this function returns the selected
|
|
1733
1779
|
* folder.
|
|
1734
1780
|
* @returns The currently selected URI, or `null` if no file is selected. If `gtk_file_chooser_set_local_only()` is set to `true` (the default) a local URI will be returned for any FUSE locations. Free with `g_free()`
|
|
1781
|
+
* @since 2.4
|
|
1735
1782
|
*/
|
|
1736
1783
|
get_uri(): string | null;
|
|
1737
1784
|
|
|
@@ -1739,6 +1786,7 @@ export namespace Xed {
|
|
|
1739
1786
|
* Lists all the selected files and subfolders in the current folder of
|
|
1740
1787
|
* `chooser`. The returned names are full absolute URIs.
|
|
1741
1788
|
* @returns a {@link GLib.SList} containing the URIs of all selected files and subfolders in the current folder. Free the returned list with `g_slist_free()`, and the filenames with `g_free()`.
|
|
1789
|
+
* @since 2.4
|
|
1742
1790
|
*/
|
|
1743
1791
|
get_uris(): string[];
|
|
1744
1792
|
|
|
@@ -1753,6 +1801,7 @@ export namespace Xed {
|
|
|
1753
1801
|
* Lists the current set of user-selectable filters; see
|
|
1754
1802
|
* `gtk_file_chooser_add_filter()`, `gtk_file_chooser_remove_filter()`.
|
|
1755
1803
|
* @returns a {@link GLib.SList} containing the current set of user selectable filters. The contents of the list are owned by GTK+, but you must free the list itself with `g_slist_free()` when you are done with it.
|
|
1804
|
+
* @since 2.4
|
|
1756
1805
|
*/
|
|
1757
1806
|
list_filters(): Gtk.FileFilter[];
|
|
1758
1807
|
|
|
@@ -1760,6 +1809,7 @@ export namespace Xed {
|
|
|
1760
1809
|
* Queries the list of shortcut folders in the file chooser, as set by
|
|
1761
1810
|
* `gtk_file_chooser_add_shortcut_folder_uri()`.
|
|
1762
1811
|
* @returns A list of folder URIs, or `null` if there are no shortcut folders. Free the returned list with `g_slist_free()`, and the URIs with `g_free()`.
|
|
1812
|
+
* @since 2.4
|
|
1763
1813
|
*/
|
|
1764
1814
|
list_shortcut_folder_uris(): string[] | null;
|
|
1765
1815
|
|
|
@@ -1767,18 +1817,21 @@ export namespace Xed {
|
|
|
1767
1817
|
* Queries the list of shortcut folders in the file chooser, as set by
|
|
1768
1818
|
* `gtk_file_chooser_add_shortcut_folder()`.
|
|
1769
1819
|
* @returns A list of folder filenames, or `null` if there are no shortcut folders. Free the returned list with `g_slist_free()`, and the filenames with `g_free()`.
|
|
1820
|
+
* @since 2.4
|
|
1770
1821
|
*/
|
|
1771
1822
|
list_shortcut_folders(): string[] | null;
|
|
1772
1823
|
|
|
1773
1824
|
/**
|
|
1774
1825
|
* Removes a 'choice' that has been added with `gtk_file_chooser_add_choice()`.
|
|
1775
1826
|
* @param id the ID of the choice to remove
|
|
1827
|
+
* @since 3.22
|
|
1776
1828
|
*/
|
|
1777
1829
|
remove_choice(id: string): void;
|
|
1778
1830
|
|
|
1779
1831
|
/**
|
|
1780
1832
|
* Removes `filter` from the list of filters that the user can select between.
|
|
1781
1833
|
* @param filter a {@link Gtk.FileFilter}
|
|
1834
|
+
* @since 2.4
|
|
1782
1835
|
*/
|
|
1783
1836
|
remove_filter(filter: Gtk.FileFilter): void;
|
|
1784
1837
|
|
|
@@ -1786,6 +1839,7 @@ export namespace Xed {
|
|
|
1786
1839
|
* Removes a folder from a file chooser’s list of shortcut folders.
|
|
1787
1840
|
* @param folder filename of the folder to remove
|
|
1788
1841
|
* @returns `true` if the operation succeeds, `false` otherwise. In the latter case, the `error` will be set as appropriate. See also: `gtk_file_chooser_add_shortcut_folder()`
|
|
1842
|
+
* @since 2.4
|
|
1789
1843
|
*/
|
|
1790
1844
|
remove_shortcut_folder(folder: string): boolean;
|
|
1791
1845
|
|
|
@@ -1793,11 +1847,13 @@ export namespace Xed {
|
|
|
1793
1847
|
* Removes a folder URI from a file chooser’s list of shortcut folders.
|
|
1794
1848
|
* @param uri URI of the folder to remove
|
|
1795
1849
|
* @returns `true` if the operation succeeds, `false` otherwise. In the latter case, the `error` will be set as appropriate. See also: `gtk_file_chooser_add_shortcut_folder_uri()`
|
|
1850
|
+
* @since 2.4
|
|
1796
1851
|
*/
|
|
1797
1852
|
remove_shortcut_folder_uri(uri: string): boolean;
|
|
1798
1853
|
|
|
1799
1854
|
/**
|
|
1800
1855
|
* Selects all the files in the current folder of a file chooser.
|
|
1856
|
+
* @since 2.4
|
|
1801
1857
|
*/
|
|
1802
1858
|
select_all(): void;
|
|
1803
1859
|
|
|
@@ -1806,6 +1862,7 @@ export namespace Xed {
|
|
|
1806
1862
|
* _gtk_file_chooser_select_uri().
|
|
1807
1863
|
* @param file the file to select
|
|
1808
1864
|
* @returns Not useful.
|
|
1865
|
+
* @since 2.14
|
|
1809
1866
|
*/
|
|
1810
1867
|
select_file(file: Gio.File): boolean;
|
|
1811
1868
|
|
|
@@ -1815,6 +1872,7 @@ export namespace Xed {
|
|
|
1815
1872
|
* be changed to the folder containing `filename`.
|
|
1816
1873
|
* @param filename the filename to select
|
|
1817
1874
|
* @returns Not useful. See also: `gtk_file_chooser_set_filename()`
|
|
1875
|
+
* @since 2.4
|
|
1818
1876
|
*/
|
|
1819
1877
|
select_filename(filename: string): boolean;
|
|
1820
1878
|
|
|
@@ -1824,6 +1882,7 @@ export namespace Xed {
|
|
|
1824
1882
|
* `chooser` will be changed to the folder containing `filename`.
|
|
1825
1883
|
* @param uri the URI to select
|
|
1826
1884
|
* @returns Not useful.
|
|
1885
|
+
* @since 2.4
|
|
1827
1886
|
*/
|
|
1828
1887
|
select_uri(uri: string): boolean;
|
|
1829
1888
|
|
|
@@ -1834,6 +1893,7 @@ export namespace Xed {
|
|
|
1834
1893
|
* {@link Gtk.FileChooserAction.SAVE} but not if the action is
|
|
1835
1894
|
* {@link Gtk.FileChooserAction.OPEN}.
|
|
1836
1895
|
* @param action the action that the file selector is performing
|
|
1896
|
+
* @since 2.4
|
|
1837
1897
|
*/
|
|
1838
1898
|
set_action(action: Gtk.FileChooserAction): void;
|
|
1839
1899
|
|
|
@@ -1843,6 +1903,7 @@ export namespace Xed {
|
|
|
1843
1903
|
* possible options are "true" and "false".
|
|
1844
1904
|
* @param id the ID of the choice to set
|
|
1845
1905
|
* @param option the ID of the option to select
|
|
1906
|
+
* @since 3.22
|
|
1846
1907
|
*/
|
|
1847
1908
|
set_choice(id: string, option: string): void;
|
|
1848
1909
|
|
|
@@ -1851,6 +1912,7 @@ export namespace Xed {
|
|
|
1851
1912
|
* This is only relevant if the action is not set to be
|
|
1852
1913
|
* {@link Gtk.FileChooserAction.OPEN}.
|
|
1853
1914
|
* @param create_folders `true` if the Create Folder button should be displayed
|
|
1915
|
+
* @since 2.18
|
|
1854
1916
|
*/
|
|
1855
1917
|
set_create_folders(create_folders: boolean): void;
|
|
1856
1918
|
|
|
@@ -1864,6 +1926,7 @@ export namespace Xed {
|
|
|
1864
1926
|
* for the rationale behind this.
|
|
1865
1927
|
* @param filename the full path of the new current folder
|
|
1866
1928
|
* @returns Not useful.
|
|
1929
|
+
* @since 2.4
|
|
1867
1930
|
*/
|
|
1868
1931
|
set_current_folder(filename: string): boolean;
|
|
1869
1932
|
|
|
@@ -1872,6 +1935,7 @@ export namespace Xed {
|
|
|
1872
1935
|
* Internal function, see `gtk_file_chooser_set_current_folder_uri()`.
|
|
1873
1936
|
* @param file the {@link Gio.File} for the new folder
|
|
1874
1937
|
* @returns `true` if the folder could be changed successfully, `false` otherwise.
|
|
1938
|
+
* @since 2.14
|
|
1875
1939
|
*/
|
|
1876
1940
|
set_current_folder_file(file: Gio.File): boolean;
|
|
1877
1941
|
|
|
@@ -1885,6 +1949,7 @@ export namespace Xed {
|
|
|
1885
1949
|
* for the rationale behind this.
|
|
1886
1950
|
* @param uri the URI for the new current folder
|
|
1887
1951
|
* @returns `true` if the folder could be changed successfully, `false` otherwise.
|
|
1952
|
+
* @since 2.4
|
|
1888
1953
|
*/
|
|
1889
1954
|
set_current_folder_uri(uri: string): boolean;
|
|
1890
1955
|
|
|
@@ -1900,6 +1965,7 @@ export namespace Xed {
|
|
|
1900
1965
|
* Please see the documentation for those functions for an example of using
|
|
1901
1966
|
* `gtk_file_chooser_set_current_name()` as well.
|
|
1902
1967
|
* @param name the filename to use, as a UTF-8 string
|
|
1968
|
+
* @since 2.4
|
|
1903
1969
|
*/
|
|
1904
1970
|
set_current_name(name: string): void;
|
|
1905
1971
|
|
|
@@ -1916,12 +1982,14 @@ export namespace Xed {
|
|
|
1916
1982
|
* {@link Gtk.FileChooser.SignalSignatures.confirm_overwrite | Gtk.FileChooser::confirm-overwrite} signal; please refer to its documentation
|
|
1917
1983
|
* for the details.
|
|
1918
1984
|
* @param do_overwrite_confirmation whether to confirm overwriting in save mode
|
|
1985
|
+
* @since 2.8
|
|
1919
1986
|
*/
|
|
1920
1987
|
set_do_overwrite_confirmation(do_overwrite_confirmation: boolean): void;
|
|
1921
1988
|
|
|
1922
1989
|
/**
|
|
1923
1990
|
* Sets an application-supplied widget to provide extra options to the user.
|
|
1924
1991
|
* @param extra_widget widget for extra options
|
|
1992
|
+
* @since 2.4
|
|
1925
1993
|
*/
|
|
1926
1994
|
set_extra_widget(extra_widget: Gtk.Widget): void;
|
|
1927
1995
|
|
|
@@ -1963,6 +2031,7 @@ export namespace Xed {
|
|
|
1963
2031
|
*
|
|
1964
2032
|
* @param file the {@link Gio.File} to set as current
|
|
1965
2033
|
* @returns Not useful.
|
|
2034
|
+
* @since 2.14
|
|
1966
2035
|
*/
|
|
1967
2036
|
set_file(file: Gio.File): boolean;
|
|
1968
2037
|
|
|
@@ -2003,6 +2072,7 @@ export namespace Xed {
|
|
|
2003
2072
|
* is already known, so the file chooser will use it.
|
|
2004
2073
|
* @param filename the filename to set as current
|
|
2005
2074
|
* @returns Not useful.
|
|
2075
|
+
* @since 2.4
|
|
2006
2076
|
*/
|
|
2007
2077
|
set_filename(filename: string): boolean;
|
|
2008
2078
|
|
|
@@ -2014,6 +2084,7 @@ export namespace Xed {
|
|
|
2014
2084
|
* filters is empty is useful if you want to restrict the displayed
|
|
2015
2085
|
* set of files without letting the user change it.
|
|
2016
2086
|
* @param filter a {@link Gtk.FileFilter}
|
|
2087
|
+
* @since 2.4
|
|
2017
2088
|
*/
|
|
2018
2089
|
set_filter(filter: Gtk.FileFilter): void;
|
|
2019
2090
|
|
|
@@ -2032,6 +2103,7 @@ export namespace Xed {
|
|
|
2032
2103
|
* available using the native filesystem via a userspace
|
|
2033
2104
|
* filesystem (FUSE).
|
|
2034
2105
|
* @param local_only `true` if only local files can be selected
|
|
2106
|
+
* @since 2.4
|
|
2035
2107
|
*/
|
|
2036
2108
|
set_local_only(local_only: boolean): void;
|
|
2037
2109
|
|
|
@@ -2049,6 +2121,7 @@ export namespace Xed {
|
|
|
2049
2121
|
* application-supplied preview widget is not active, the file chooser
|
|
2050
2122
|
* will display no preview at all.
|
|
2051
2123
|
* @param preview_widget widget for displaying preview.
|
|
2124
|
+
* @since 2.4
|
|
2052
2125
|
*/
|
|
2053
2126
|
set_preview_widget(preview_widget: Gtk.Widget): void;
|
|
2054
2127
|
|
|
@@ -2060,6 +2133,7 @@ export namespace Xed {
|
|
|
2060
2133
|
* or it may display no preview at all. See
|
|
2061
2134
|
* `gtk_file_chooser_set_preview_widget()` for more details.
|
|
2062
2135
|
* @param active whether to display the user-specified preview widget
|
|
2136
|
+
* @since 2.4
|
|
2063
2137
|
*/
|
|
2064
2138
|
set_preview_widget_active(active: boolean): void;
|
|
2065
2139
|
|
|
@@ -2068,12 +2142,14 @@ export namespace Xed {
|
|
|
2068
2142
|
* only relevant if the action is set to be {@link Gtk.FileChooserAction.OPEN} or
|
|
2069
2143
|
* {@link Gtk.FileChooserAction.SELECT_FOLDER}.
|
|
2070
2144
|
* @param select_multiple `true` if multiple files can be selected.
|
|
2145
|
+
* @since 2.4
|
|
2071
2146
|
*/
|
|
2072
2147
|
set_select_multiple(select_multiple: boolean): void;
|
|
2073
2148
|
|
|
2074
2149
|
/**
|
|
2075
2150
|
* Sets whether hidden files and folders are displayed in the file selector.
|
|
2076
2151
|
* @param show_hidden `true` if hidden files and folders should be displayed.
|
|
2152
|
+
* @since 2.6
|
|
2077
2153
|
*/
|
|
2078
2154
|
set_show_hidden(show_hidden: boolean): void;
|
|
2079
2155
|
|
|
@@ -2114,6 +2190,7 @@ export namespace Xed {
|
|
|
2114
2190
|
* is already known, so the file chooser will use it.
|
|
2115
2191
|
* @param uri the URI to set as current
|
|
2116
2192
|
* @returns Not useful.
|
|
2193
|
+
* @since 2.4
|
|
2117
2194
|
*/
|
|
2118
2195
|
set_uri(uri: string): boolean;
|
|
2119
2196
|
|
|
@@ -2125,11 +2202,13 @@ export namespace Xed {
|
|
|
2125
2202
|
*
|
|
2126
2203
|
* See also: `gtk_file_chooser_set_preview_widget()`
|
|
2127
2204
|
* @param use_label whether to display a stock label with the name of the previewed file
|
|
2205
|
+
* @since 2.4
|
|
2128
2206
|
*/
|
|
2129
2207
|
set_use_preview_label(use_label: boolean): void;
|
|
2130
2208
|
|
|
2131
2209
|
/**
|
|
2132
2210
|
* Unselects all the files in the current folder of a file chooser.
|
|
2211
|
+
* @since 2.4
|
|
2133
2212
|
*/
|
|
2134
2213
|
unselect_all(): void;
|
|
2135
2214
|
|
|
@@ -2137,6 +2216,7 @@ export namespace Xed {
|
|
|
2137
2216
|
* Unselects the file referred to by `file`. If the file is not in the current
|
|
2138
2217
|
* directory, does not exist, or is otherwise not currently selected, does nothing.
|
|
2139
2218
|
* @param file a {@link Gio.File}
|
|
2219
|
+
* @since 2.14
|
|
2140
2220
|
*/
|
|
2141
2221
|
unselect_file(file: Gio.File): void;
|
|
2142
2222
|
|
|
@@ -2145,6 +2225,7 @@ export namespace Xed {
|
|
|
2145
2225
|
* is not in the current directory, does not exist, or
|
|
2146
2226
|
* is otherwise not currently selected, does nothing.
|
|
2147
2227
|
* @param filename the filename to unselect
|
|
2228
|
+
* @since 2.4
|
|
2148
2229
|
*/
|
|
2149
2230
|
unselect_filename(filename: string): void;
|
|
2150
2231
|
|
|
@@ -2153,6 +2234,7 @@ export namespace Xed {
|
|
|
2153
2234
|
* is not in the current directory, does not exist, or
|
|
2154
2235
|
* is otherwise not currently selected, does nothing.
|
|
2155
2236
|
* @param uri the URI to unselect
|
|
2237
|
+
* @since 2.4
|
|
2156
2238
|
*/
|
|
2157
2239
|
unselect_uri(uri: string): void;
|
|
2158
2240
|
}
|
|
@@ -3226,12 +3308,14 @@ export namespace Xed {
|
|
|
3226
3308
|
/**
|
|
3227
3309
|
* Retrieves the orientation of the `orientable`.
|
|
3228
3310
|
* @returns the orientation of the `orientable`.
|
|
3311
|
+
* @since 2.16
|
|
3229
3312
|
*/
|
|
3230
3313
|
get_orientation(): Gtk.Orientation;
|
|
3231
3314
|
|
|
3232
3315
|
/**
|
|
3233
3316
|
* Sets the orientation of the `orientable`.
|
|
3234
3317
|
* @param orientation the orientable’s new orientation.
|
|
3318
|
+
* @since 2.16
|
|
3235
3319
|
*/
|
|
3236
3320
|
set_orientation(orientation: Gtk.Orientation): void;
|
|
3237
3321
|
}
|
|
@@ -3569,12 +3653,14 @@ export namespace Xed {
|
|
|
3569
3653
|
/**
|
|
3570
3654
|
* Retrieves the orientation of the `orientable`.
|
|
3571
3655
|
* @returns the orientation of the `orientable`.
|
|
3656
|
+
* @since 2.16
|
|
3572
3657
|
*/
|
|
3573
3658
|
get_orientation(): Gtk.Orientation;
|
|
3574
3659
|
|
|
3575
3660
|
/**
|
|
3576
3661
|
* Sets the orientation of the `orientable`.
|
|
3577
3662
|
* @param orientation the orientable’s new orientation.
|
|
3663
|
+
* @since 2.16
|
|
3578
3664
|
*/
|
|
3579
3665
|
set_orientation(orientation: Gtk.Orientation): void;
|
|
3580
3666
|
}
|
|
@@ -4120,6 +4206,7 @@ export namespace Xed {
|
|
|
4120
4206
|
*
|
|
4121
4207
|
* This function should only be called by {@link Gio.ActionGroup} implementations.
|
|
4122
4208
|
* @param action_name the name of an action in the group
|
|
4209
|
+
* @since 2.28
|
|
4123
4210
|
*/
|
|
4124
4211
|
action_added(action_name: string): void;
|
|
4125
4212
|
|
|
@@ -4129,6 +4216,7 @@ export namespace Xed {
|
|
|
4129
4216
|
* This function should only be called by {@link Gio.ActionGroup} implementations.
|
|
4130
4217
|
* @param action_name the name of an action in the group
|
|
4131
4218
|
* @param enabled whether the action is now enabled
|
|
4219
|
+
* @since 2.28
|
|
4132
4220
|
*/
|
|
4133
4221
|
action_enabled_changed(action_name: string, enabled: boolean): void;
|
|
4134
4222
|
|
|
@@ -4137,6 +4225,7 @@ export namespace Xed {
|
|
|
4137
4225
|
*
|
|
4138
4226
|
* This function should only be called by {@link Gio.ActionGroup} implementations.
|
|
4139
4227
|
* @param action_name the name of an action in the group
|
|
4228
|
+
* @since 2.28
|
|
4140
4229
|
*/
|
|
4141
4230
|
action_removed(action_name: string): void;
|
|
4142
4231
|
|
|
@@ -4146,6 +4235,7 @@ export namespace Xed {
|
|
|
4146
4235
|
* This function should only be called by {@link Gio.ActionGroup} implementations.
|
|
4147
4236
|
* @param action_name the name of an action in the group
|
|
4148
4237
|
* @param state the new state of the named action
|
|
4238
|
+
* @since 2.28
|
|
4149
4239
|
*/
|
|
4150
4240
|
action_state_changed(action_name: string, state: GLib.Variant): void;
|
|
4151
4241
|
|
|
@@ -4185,6 +4275,7 @@ export namespace Xed {
|
|
|
4185
4275
|
* ```
|
|
4186
4276
|
* @param action_name the name of the action to activate
|
|
4187
4277
|
* @param parameter parameters to the activation
|
|
4278
|
+
* @since 2.28
|
|
4188
4279
|
*/
|
|
4189
4280
|
activate_action(action_name: string, parameter: GLib.Variant | null): void;
|
|
4190
4281
|
|
|
@@ -4202,6 +4293,7 @@ export namespace Xed {
|
|
|
4202
4293
|
* If the `value` GVariant is floating, it is consumed.
|
|
4203
4294
|
* @param action_name the name of the action to request the change on
|
|
4204
4295
|
* @param value the new state
|
|
4296
|
+
* @since 2.28
|
|
4205
4297
|
*/
|
|
4206
4298
|
change_action_state(action_name: string, value: GLib.Variant): void;
|
|
4207
4299
|
|
|
@@ -4212,6 +4304,7 @@ export namespace Xed {
|
|
|
4212
4304
|
* have its state changed from outside callers.
|
|
4213
4305
|
* @param action_name the name of the action to query
|
|
4214
4306
|
* @returns whether the action is currently enabled
|
|
4307
|
+
* @since 2.28
|
|
4215
4308
|
*/
|
|
4216
4309
|
get_action_enabled(action_name: string): boolean;
|
|
4217
4310
|
|
|
@@ -4231,6 +4324,7 @@ export namespace Xed {
|
|
|
4231
4324
|
* with the same name but a different parameter type.
|
|
4232
4325
|
* @param action_name the name of the action to query
|
|
4233
4326
|
* @returns the parameter type
|
|
4327
|
+
* @since 2.28
|
|
4234
4328
|
*/
|
|
4235
4329
|
get_action_parameter_type(action_name: string): GLib.VariantType | null;
|
|
4236
4330
|
|
|
@@ -4245,6 +4339,7 @@ export namespace Xed {
|
|
|
4245
4339
|
* {@link GLib.Variant.unref} when it is no longer required.
|
|
4246
4340
|
* @param action_name the name of the action to query
|
|
4247
4341
|
* @returns the current state of the action
|
|
4342
|
+
* @since 2.28
|
|
4248
4343
|
*/
|
|
4249
4344
|
get_action_state(action_name: string): GLib.Variant | null;
|
|
4250
4345
|
|
|
@@ -4269,6 +4364,7 @@ export namespace Xed {
|
|
|
4269
4364
|
* {@link GLib.Variant.unref} when it is no longer required.
|
|
4270
4365
|
* @param action_name the name of the action to query
|
|
4271
4366
|
* @returns the state range hint
|
|
4367
|
+
* @since 2.28
|
|
4272
4368
|
*/
|
|
4273
4369
|
get_action_state_hint(action_name: string): GLib.Variant | null;
|
|
4274
4370
|
|
|
@@ -4291,6 +4387,7 @@ export namespace Xed {
|
|
|
4291
4387
|
* with the same name but a different state type.
|
|
4292
4388
|
* @param action_name the name of the action to query
|
|
4293
4389
|
* @returns the state type, if the action is stateful
|
|
4390
|
+
* @since 2.28
|
|
4294
4391
|
*/
|
|
4295
4392
|
get_action_state_type(action_name: string): GLib.VariantType | null;
|
|
4296
4393
|
|
|
@@ -4298,6 +4395,7 @@ export namespace Xed {
|
|
|
4298
4395
|
* Checks if the named action exists within `action_group`.
|
|
4299
4396
|
* @param action_name the name of the action to check for
|
|
4300
4397
|
* @returns whether the named action exists
|
|
4398
|
+
* @since 2.28
|
|
4301
4399
|
*/
|
|
4302
4400
|
has_action(action_name: string): boolean;
|
|
4303
4401
|
|
|
@@ -4307,6 +4405,7 @@ export namespace Xed {
|
|
|
4307
4405
|
* The caller is responsible for freeing the list with {@link GLib.strfreev} when
|
|
4308
4406
|
* it is no longer required.
|
|
4309
4407
|
* @returns a `NULL`-terminated array of the names of the actions in the group
|
|
4408
|
+
* @since 2.28
|
|
4310
4409
|
*/
|
|
4311
4410
|
list_actions(): string[];
|
|
4312
4411
|
|
|
@@ -4340,6 +4439,7 @@ export namespace Xed {
|
|
|
4340
4439
|
* fields may or may not have been modified.
|
|
4341
4440
|
* @param action_name the name of an action in the group
|
|
4342
4441
|
* @returns `TRUE` if the action exists, else `FALSE`
|
|
4442
|
+
* @since 2.32
|
|
4343
4443
|
*/
|
|
4344
4444
|
query_action(action_name: string): [boolean, boolean, GLib.VariantType | null, GLib.VariantType | null, GLib.Variant | null, GLib.Variant | null];
|
|
4345
4445
|
|
|
@@ -4348,6 +4448,7 @@ export namespace Xed {
|
|
|
4348
4448
|
*
|
|
4349
4449
|
* This function should only be called by {@link Gio.ActionGroup} implementations.
|
|
4350
4450
|
* @param action_name the name of an action in the group
|
|
4451
|
+
* @since 2.28
|
|
4351
4452
|
* @virtual
|
|
4352
4453
|
*/
|
|
4353
4454
|
vfunc_action_added(action_name: string): void;
|
|
@@ -4358,6 +4459,7 @@ export namespace Xed {
|
|
|
4358
4459
|
* This function should only be called by {@link Gio.ActionGroup} implementations.
|
|
4359
4460
|
* @param action_name the name of an action in the group
|
|
4360
4461
|
* @param enabled whether the action is now enabled
|
|
4462
|
+
* @since 2.28
|
|
4361
4463
|
* @virtual
|
|
4362
4464
|
*/
|
|
4363
4465
|
vfunc_action_enabled_changed(action_name: string, enabled: boolean): void;
|
|
@@ -4367,6 +4469,7 @@ export namespace Xed {
|
|
|
4367
4469
|
*
|
|
4368
4470
|
* This function should only be called by {@link Gio.ActionGroup} implementations.
|
|
4369
4471
|
* @param action_name the name of an action in the group
|
|
4472
|
+
* @since 2.28
|
|
4370
4473
|
* @virtual
|
|
4371
4474
|
*/
|
|
4372
4475
|
vfunc_action_removed(action_name: string): void;
|
|
@@ -4377,6 +4480,7 @@ export namespace Xed {
|
|
|
4377
4480
|
* This function should only be called by {@link Gio.ActionGroup} implementations.
|
|
4378
4481
|
* @param action_name the name of an action in the group
|
|
4379
4482
|
* @param state the new state of the named action
|
|
4483
|
+
* @since 2.28
|
|
4380
4484
|
* @virtual
|
|
4381
4485
|
*/
|
|
4382
4486
|
vfunc_action_state_changed(action_name: string, state: GLib.Variant): void;
|
|
@@ -4417,6 +4521,7 @@ export namespace Xed {
|
|
|
4417
4521
|
* ```
|
|
4418
4522
|
* @param action_name the name of the action to activate
|
|
4419
4523
|
* @param parameter parameters to the activation
|
|
4524
|
+
* @since 2.28
|
|
4420
4525
|
* @virtual
|
|
4421
4526
|
*/
|
|
4422
4527
|
vfunc_activate_action(action_name: string, parameter: GLib.Variant | null): void;
|
|
@@ -4435,6 +4540,7 @@ export namespace Xed {
|
|
|
4435
4540
|
* If the `value` GVariant is floating, it is consumed.
|
|
4436
4541
|
* @param action_name the name of the action to request the change on
|
|
4437
4542
|
* @param value the new state
|
|
4543
|
+
* @since 2.28
|
|
4438
4544
|
* @virtual
|
|
4439
4545
|
*/
|
|
4440
4546
|
vfunc_change_action_state(action_name: string, value: GLib.Variant): void;
|
|
@@ -4445,6 +4551,7 @@ export namespace Xed {
|
|
|
4445
4551
|
* An action must be enabled in order to be activated or in order to
|
|
4446
4552
|
* have its state changed from outside callers.
|
|
4447
4553
|
* @param action_name the name of the action to query
|
|
4554
|
+
* @since 2.28
|
|
4448
4555
|
* @virtual
|
|
4449
4556
|
*/
|
|
4450
4557
|
vfunc_get_action_enabled(action_name: string): boolean;
|
|
@@ -4464,6 +4571,7 @@ export namespace Xed {
|
|
|
4464
4571
|
* possible for an action to be removed and for a new action to be added
|
|
4465
4572
|
* with the same name but a different parameter type.
|
|
4466
4573
|
* @param action_name the name of the action to query
|
|
4574
|
+
* @since 2.28
|
|
4467
4575
|
* @virtual
|
|
4468
4576
|
*/
|
|
4469
4577
|
vfunc_get_action_parameter_type(action_name: string): GLib.VariantType | null;
|
|
@@ -4478,6 +4586,7 @@ export namespace Xed {
|
|
|
4478
4586
|
* The return value (if non-`NULL`) should be freed with
|
|
4479
4587
|
* {@link GLib.Variant.unref} when it is no longer required.
|
|
4480
4588
|
* @param action_name the name of the action to query
|
|
4589
|
+
* @since 2.28
|
|
4481
4590
|
* @virtual
|
|
4482
4591
|
*/
|
|
4483
4592
|
vfunc_get_action_state(action_name: string): GLib.Variant | null;
|
|
@@ -4502,6 +4611,7 @@ export namespace Xed {
|
|
|
4502
4611
|
* The return value (if non-`NULL`) should be freed with
|
|
4503
4612
|
* {@link GLib.Variant.unref} when it is no longer required.
|
|
4504
4613
|
* @param action_name the name of the action to query
|
|
4614
|
+
* @since 2.28
|
|
4505
4615
|
* @virtual
|
|
4506
4616
|
*/
|
|
4507
4617
|
vfunc_get_action_state_hint(action_name: string): GLib.Variant | null;
|
|
@@ -4524,6 +4634,7 @@ export namespace Xed {
|
|
|
4524
4634
|
* possible for an action to be removed and for a new action to be added
|
|
4525
4635
|
* with the same name but a different state type.
|
|
4526
4636
|
* @param action_name the name of the action to query
|
|
4637
|
+
* @since 2.28
|
|
4527
4638
|
* @virtual
|
|
4528
4639
|
*/
|
|
4529
4640
|
vfunc_get_action_state_type(action_name: string): GLib.VariantType | null;
|
|
@@ -4531,6 +4642,7 @@ export namespace Xed {
|
|
|
4531
4642
|
/**
|
|
4532
4643
|
* Checks if the named action exists within `action_group`.
|
|
4533
4644
|
* @param action_name the name of the action to check for
|
|
4645
|
+
* @since 2.28
|
|
4534
4646
|
* @virtual
|
|
4535
4647
|
*/
|
|
4536
4648
|
vfunc_has_action(action_name: string): boolean;
|
|
@@ -4540,6 +4652,7 @@ export namespace Xed {
|
|
|
4540
4652
|
*
|
|
4541
4653
|
* The caller is responsible for freeing the list with {@link GLib.strfreev} when
|
|
4542
4654
|
* it is no longer required.
|
|
4655
|
+
* @since 2.28
|
|
4543
4656
|
* @virtual
|
|
4544
4657
|
*/
|
|
4545
4658
|
vfunc_list_actions(): string[];
|
|
@@ -4573,6 +4686,7 @@ export namespace Xed {
|
|
|
4573
4686
|
* filled. If the action doesn’t exist, `FALSE` is returned and the
|
|
4574
4687
|
* fields may or may not have been modified.
|
|
4575
4688
|
* @param action_name the name of an action in the group
|
|
4689
|
+
* @since 2.32
|
|
4576
4690
|
* @virtual
|
|
4577
4691
|
*/
|
|
4578
4692
|
vfunc_query_action(action_name: string): [boolean, boolean, GLib.VariantType | null, GLib.VariantType | null, GLib.Variant | null, GLib.Variant | null];
|
|
@@ -4585,6 +4699,7 @@ export namespace Xed {
|
|
|
4585
4699
|
*
|
|
4586
4700
|
* The action map takes its own reference on `action`.
|
|
4587
4701
|
* @param action a {@link Gio.Action}
|
|
4702
|
+
* @since 2.32
|
|
4588
4703
|
*/
|
|
4589
4704
|
add_action(action: Gio.Action): void;
|
|
4590
4705
|
|
|
@@ -4601,6 +4716,7 @@ export namespace Xed {
|
|
|
4601
4716
|
* If no such action exists, returns `NULL`.
|
|
4602
4717
|
* @param action_name the name of an action
|
|
4603
4718
|
* @returns a {@link Gio.Action}
|
|
4719
|
+
* @since 2.32
|
|
4604
4720
|
*/
|
|
4605
4721
|
lookup_action(action_name: string): Gio.Action | null;
|
|
4606
4722
|
|
|
@@ -4609,6 +4725,7 @@ export namespace Xed {
|
|
|
4609
4725
|
*
|
|
4610
4726
|
* If no action of this name is in the map then nothing happens.
|
|
4611
4727
|
* @param action_name the name of the action
|
|
4728
|
+
* @since 2.32
|
|
4612
4729
|
*/
|
|
4613
4730
|
remove_action(action_name: string): void;
|
|
4614
4731
|
|
|
@@ -4636,6 +4753,7 @@ export namespace Xed {
|
|
|
4636
4753
|
* }
|
|
4637
4754
|
* ```
|
|
4638
4755
|
* @param entries a pointer to the first item in an array of {@link Gio.ActionEntry} structs
|
|
4756
|
+
* @since 2.78
|
|
4639
4757
|
*/
|
|
4640
4758
|
remove_action_entries(entries: Gio.ActionEntry[]): void;
|
|
4641
4759
|
|
|
@@ -4647,6 +4765,7 @@ export namespace Xed {
|
|
|
4647
4765
|
*
|
|
4648
4766
|
* The action map takes its own reference on `action`.
|
|
4649
4767
|
* @param action a {@link Gio.Action}
|
|
4768
|
+
* @since 2.32
|
|
4650
4769
|
* @virtual
|
|
4651
4770
|
*/
|
|
4652
4771
|
vfunc_add_action(action: Gio.Action): void;
|
|
@@ -4656,6 +4775,7 @@ export namespace Xed {
|
|
|
4656
4775
|
*
|
|
4657
4776
|
* If no such action exists, returns `NULL`.
|
|
4658
4777
|
* @param action_name the name of an action
|
|
4778
|
+
* @since 2.32
|
|
4659
4779
|
* @virtual
|
|
4660
4780
|
*/
|
|
4661
4781
|
vfunc_lookup_action(action_name: string): Gio.Action | null;
|
|
@@ -4665,6 +4785,7 @@ export namespace Xed {
|
|
|
4665
4785
|
*
|
|
4666
4786
|
* If no action of this name is in the map then nothing happens.
|
|
4667
4787
|
* @param action_name the name of the action
|
|
4788
|
+
* @since 2.32
|
|
4668
4789
|
* @virtual
|
|
4669
4790
|
*/
|
|
4670
4791
|
vfunc_remove_action(action_name: string): void;
|