@girs/xreaderview-1.5 1.5.0-4.0.0-beta.3
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 +86 -0
- package/package.json +66 -0
- package/tsconfig.json +23 -0
- package/typedoc.json +7 -0
- package/xreaderview-1.5-ambient.d.ts +12 -0
- package/xreaderview-1.5-ambient.js +2 -0
- package/xreaderview-1.5-import.d.ts +12 -0
- package/xreaderview-1.5-import.js +3 -0
- package/xreaderview-1.5.d.ts +2416 -0
- package/xreaderview-1.5.js +6 -0
|
@@ -0,0 +1,2416 @@
|
|
|
1
|
+
/*
|
|
2
|
+
* Type Definitions for Gjs (https://gjs.guide/)
|
|
3
|
+
*
|
|
4
|
+
* These type definitions are automatically generated, do not edit them by hand.
|
|
5
|
+
* If you found a bug fix it in `ts-for-gir` or create a bug report on https://github.com/gjsify/ts-for-gir
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
import './xreaderview-1.5-ambient.d.ts';
|
|
9
|
+
|
|
10
|
+
/**
|
|
11
|
+
* XreaderView-1.5
|
|
12
|
+
*/
|
|
13
|
+
|
|
14
|
+
import type XreaderDocument from '@girs/xreaderdocument-1.5';
|
|
15
|
+
import type Gtk from '@girs/gtk-3.0';
|
|
16
|
+
import type xlib from '@girs/xlib-2.0';
|
|
17
|
+
import type Gdk from '@girs/gdk-3.0';
|
|
18
|
+
import type cairo from '@girs/cairo-1.0';
|
|
19
|
+
import type GObject from '@girs/gobject-2.0';
|
|
20
|
+
import type GLib from '@girs/glib-2.0';
|
|
21
|
+
import type Pango from '@girs/pango-1.0';
|
|
22
|
+
import type HarfBuzz from '@girs/harfbuzz-0.0';
|
|
23
|
+
import type freetype2 from '@girs/freetype2-2.0';
|
|
24
|
+
import type Gio from '@girs/gio-2.0';
|
|
25
|
+
import type GdkPixbuf from '@girs/gdkpixbuf-2.0';
|
|
26
|
+
import type GModule from '@girs/gmodule-2.0';
|
|
27
|
+
import type Atk from '@girs/atk-1.0';
|
|
28
|
+
|
|
29
|
+
export namespace XreaderView {
|
|
30
|
+
enum JobPriority {
|
|
31
|
+
PRIORITY_URGENT,
|
|
32
|
+
PRIORITY_HIGH,
|
|
33
|
+
PRIORITY_LOW,
|
|
34
|
+
PRIORITY_NONE,
|
|
35
|
+
N_PRIORITIES,
|
|
36
|
+
}
|
|
37
|
+
enum JobRunMode {
|
|
38
|
+
THREAD,
|
|
39
|
+
MAIN_LOOP,
|
|
40
|
+
}
|
|
41
|
+
enum SizingMode {
|
|
42
|
+
BEST_FIT,
|
|
43
|
+
FIT_WIDTH,
|
|
44
|
+
FREE,
|
|
45
|
+
}
|
|
46
|
+
enum ViewSelectionMode {
|
|
47
|
+
TEXT,
|
|
48
|
+
RECTANGLE,
|
|
49
|
+
}
|
|
50
|
+
const STOCK_ATTACHMENT: string;
|
|
51
|
+
const STOCK_CLOSE: string;
|
|
52
|
+
const STOCK_INVERTED_COLORS: string;
|
|
53
|
+
const STOCK_RESIZE_SE: string;
|
|
54
|
+
const STOCK_RESIZE_SW: string;
|
|
55
|
+
const STOCK_ROTATE_LEFT: string;
|
|
56
|
+
const STOCK_ROTATE_RIGHT: string;
|
|
57
|
+
const STOCK_RUN_PRESENTATION: string;
|
|
58
|
+
const STOCK_VIEW_CONTINUOUS: string;
|
|
59
|
+
const STOCK_VIEW_DUAL: string;
|
|
60
|
+
const STOCK_VISIBLE: string;
|
|
61
|
+
const STOCK_ZOOM: string;
|
|
62
|
+
const STOCK_ZOOM_PAGE: string;
|
|
63
|
+
const STOCK_ZOOM_WIDTH: string;
|
|
64
|
+
/**
|
|
65
|
+
* Creates a new icon factory, adding the base stock icons to it.
|
|
66
|
+
*/
|
|
67
|
+
function stock_icons_init(): void;
|
|
68
|
+
function stock_icons_set_screen(screen: Gdk.Screen): void;
|
|
69
|
+
function stock_icons_shutdown(): void;
|
|
70
|
+
enum JobPageDataFlags {
|
|
71
|
+
NONE,
|
|
72
|
+
LINKS,
|
|
73
|
+
TEXT,
|
|
74
|
+
TEXT_MAPPING,
|
|
75
|
+
TEXT_LAYOUT,
|
|
76
|
+
IMAGES,
|
|
77
|
+
FORMS,
|
|
78
|
+
ANNOTS,
|
|
79
|
+
ALL,
|
|
80
|
+
}
|
|
81
|
+
module DocumentModel {
|
|
82
|
+
// Signal callback interfaces
|
|
83
|
+
|
|
84
|
+
interface PageChanged {
|
|
85
|
+
(object: number, p0: number): void;
|
|
86
|
+
}
|
|
87
|
+
|
|
88
|
+
// Constructor properties interface
|
|
89
|
+
|
|
90
|
+
interface ConstructorProps extends GObject.Object.ConstructorProps {
|
|
91
|
+
continuous: boolean;
|
|
92
|
+
document: XreaderDocument.Document;
|
|
93
|
+
dual_odd_left: boolean;
|
|
94
|
+
dualOddLeft: boolean;
|
|
95
|
+
dual_page: boolean;
|
|
96
|
+
dualPage: boolean;
|
|
97
|
+
fullscreen: boolean;
|
|
98
|
+
inverted_colors: boolean;
|
|
99
|
+
invertedColors: boolean;
|
|
100
|
+
page: number;
|
|
101
|
+
rotation: number;
|
|
102
|
+
rtl: boolean;
|
|
103
|
+
scale: number;
|
|
104
|
+
sizing_mode: SizingMode;
|
|
105
|
+
sizingMode: SizingMode;
|
|
106
|
+
}
|
|
107
|
+
}
|
|
108
|
+
|
|
109
|
+
class DocumentModel extends GObject.Object {
|
|
110
|
+
static $gtype: GObject.GType<DocumentModel>;
|
|
111
|
+
|
|
112
|
+
// Own properties of XreaderView.DocumentModel
|
|
113
|
+
|
|
114
|
+
get continuous(): boolean;
|
|
115
|
+
set continuous(val: boolean);
|
|
116
|
+
get document(): XreaderDocument.Document;
|
|
117
|
+
set document(val: XreaderDocument.Document);
|
|
118
|
+
get dual_odd_left(): boolean;
|
|
119
|
+
set dual_odd_left(val: boolean);
|
|
120
|
+
get dualOddLeft(): boolean;
|
|
121
|
+
set dualOddLeft(val: boolean);
|
|
122
|
+
get dual_page(): boolean;
|
|
123
|
+
set dual_page(val: boolean);
|
|
124
|
+
get dualPage(): boolean;
|
|
125
|
+
set dualPage(val: boolean);
|
|
126
|
+
get fullscreen(): boolean;
|
|
127
|
+
set fullscreen(val: boolean);
|
|
128
|
+
get inverted_colors(): boolean;
|
|
129
|
+
set inverted_colors(val: boolean);
|
|
130
|
+
get invertedColors(): boolean;
|
|
131
|
+
set invertedColors(val: boolean);
|
|
132
|
+
get page(): number;
|
|
133
|
+
set page(val: number);
|
|
134
|
+
get rotation(): number;
|
|
135
|
+
set rotation(val: number);
|
|
136
|
+
get rtl(): boolean;
|
|
137
|
+
set rtl(val: boolean);
|
|
138
|
+
get scale(): number;
|
|
139
|
+
set scale(val: number);
|
|
140
|
+
get sizing_mode(): SizingMode;
|
|
141
|
+
set sizing_mode(val: SizingMode);
|
|
142
|
+
get sizingMode(): SizingMode;
|
|
143
|
+
set sizingMode(val: SizingMode);
|
|
144
|
+
|
|
145
|
+
// Constructors of XreaderView.DocumentModel
|
|
146
|
+
|
|
147
|
+
constructor(properties?: Partial<DocumentModel.ConstructorProps>, ...args: any[]);
|
|
148
|
+
|
|
149
|
+
_init(...args: any[]): void;
|
|
150
|
+
|
|
151
|
+
static ['new'](): DocumentModel;
|
|
152
|
+
|
|
153
|
+
static new_with_document(document: XreaderDocument.Document): DocumentModel;
|
|
154
|
+
|
|
155
|
+
// Own signals of XreaderView.DocumentModel
|
|
156
|
+
|
|
157
|
+
connect(id: string, callback: (...args: any[]) => any): number;
|
|
158
|
+
connect_after(id: string, callback: (...args: any[]) => any): number;
|
|
159
|
+
emit(id: string, ...args: any[]): void;
|
|
160
|
+
connect(signal: 'page-changed', callback: (_source: this, object: number, p0: number) => void): number;
|
|
161
|
+
connect_after(signal: 'page-changed', callback: (_source: this, object: number, p0: number) => void): number;
|
|
162
|
+
emit(signal: 'page-changed', object: number, p0: number): void;
|
|
163
|
+
|
|
164
|
+
// Own methods of XreaderView.DocumentModel
|
|
165
|
+
|
|
166
|
+
get_continuous(): boolean;
|
|
167
|
+
/**
|
|
168
|
+
* Returns the #EvDocument referenced by the model.
|
|
169
|
+
* @returns a #EvDocument
|
|
170
|
+
*/
|
|
171
|
+
get_document(): XreaderDocument.Document;
|
|
172
|
+
get_dual_page(): boolean;
|
|
173
|
+
get_dual_page_odd_pages_left(): boolean;
|
|
174
|
+
get_fullscreen(): boolean;
|
|
175
|
+
get_inverted_colors(): boolean;
|
|
176
|
+
get_max_scale(): number;
|
|
177
|
+
get_min_scale(): number;
|
|
178
|
+
get_page(): number;
|
|
179
|
+
get_rotation(): number;
|
|
180
|
+
get_rtl(): boolean;
|
|
181
|
+
get_scale(): number;
|
|
182
|
+
get_sizing_mode(): SizingMode;
|
|
183
|
+
set_continuous(continuous: boolean): void;
|
|
184
|
+
set_document(document: XreaderDocument.Document): void;
|
|
185
|
+
set_dual_page(dual_page: boolean): void;
|
|
186
|
+
set_dual_page_odd_pages_left(odd_left: boolean): void;
|
|
187
|
+
set_fullscreen(fullscreen: boolean): void;
|
|
188
|
+
set_inverted_colors(inverted_colors: boolean): void;
|
|
189
|
+
set_max_scale(max_scale: number): void;
|
|
190
|
+
set_min_scale(min_scale: number): void;
|
|
191
|
+
set_page(page: number): void;
|
|
192
|
+
set_page_by_label(page_label: string): void;
|
|
193
|
+
set_rotation(rotation: number): void;
|
|
194
|
+
set_rtl(rtl: boolean): void;
|
|
195
|
+
set_scale(scale: number): void;
|
|
196
|
+
set_sizing_mode(mode: SizingMode): void;
|
|
197
|
+
}
|
|
198
|
+
|
|
199
|
+
module Job {
|
|
200
|
+
// Signal callback interfaces
|
|
201
|
+
|
|
202
|
+
interface Cancelled {
|
|
203
|
+
(): void;
|
|
204
|
+
}
|
|
205
|
+
|
|
206
|
+
interface Finished {
|
|
207
|
+
(): void;
|
|
208
|
+
}
|
|
209
|
+
|
|
210
|
+
// Constructor properties interface
|
|
211
|
+
|
|
212
|
+
interface ConstructorProps extends GObject.Object.ConstructorProps {}
|
|
213
|
+
}
|
|
214
|
+
|
|
215
|
+
abstract class Job extends GObject.Object {
|
|
216
|
+
static $gtype: GObject.GType<Job>;
|
|
217
|
+
|
|
218
|
+
// Own fields of XreaderView.Job
|
|
219
|
+
|
|
220
|
+
document: XreaderDocument.Document;
|
|
221
|
+
run_mode: JobRunMode;
|
|
222
|
+
cancelled: number;
|
|
223
|
+
finished: number;
|
|
224
|
+
error: GLib.Error;
|
|
225
|
+
cancellable: Gio.Cancellable;
|
|
226
|
+
idle_finished_id: number;
|
|
227
|
+
idle_cancelled_id: number;
|
|
228
|
+
|
|
229
|
+
// Constructors of XreaderView.Job
|
|
230
|
+
|
|
231
|
+
constructor(properties?: Partial<Job.ConstructorProps>, ...args: any[]);
|
|
232
|
+
|
|
233
|
+
_init(...args: any[]): void;
|
|
234
|
+
|
|
235
|
+
// Own signals of XreaderView.Job
|
|
236
|
+
|
|
237
|
+
connect(id: string, callback: (...args: any[]) => any): number;
|
|
238
|
+
connect_after(id: string, callback: (...args: any[]) => any): number;
|
|
239
|
+
emit(id: string, ...args: any[]): void;
|
|
240
|
+
connect(signal: 'cancelled', callback: (_source: this) => void): number;
|
|
241
|
+
connect_after(signal: 'cancelled', callback: (_source: this) => void): number;
|
|
242
|
+
emit(signal: 'cancelled'): void;
|
|
243
|
+
connect(signal: 'finished', callback: (_source: this) => void): number;
|
|
244
|
+
connect_after(signal: 'finished', callback: (_source: this) => void): number;
|
|
245
|
+
emit(signal: 'finished'): void;
|
|
246
|
+
|
|
247
|
+
// Own virtual methods of XreaderView.Job
|
|
248
|
+
|
|
249
|
+
vfunc_cancelled(): void;
|
|
250
|
+
vfunc_finished(): void;
|
|
251
|
+
vfunc_run(): boolean;
|
|
252
|
+
|
|
253
|
+
// Own methods of XreaderView.Job
|
|
254
|
+
|
|
255
|
+
cancel(): void;
|
|
256
|
+
failed_from_error(error: GLib.Error): void;
|
|
257
|
+
get_run_mode(): JobRunMode;
|
|
258
|
+
is_failed(): boolean;
|
|
259
|
+
is_finished(): boolean;
|
|
260
|
+
run(): boolean;
|
|
261
|
+
scheduler_push_job(priority: JobPriority): void;
|
|
262
|
+
scheduler_update_job(priority: JobPriority): void;
|
|
263
|
+
set_run_mode(run_mode: JobRunMode): void;
|
|
264
|
+
succeeded(): void;
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
module JobAnnots {
|
|
268
|
+
// Constructor properties interface
|
|
269
|
+
|
|
270
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
class JobAnnots extends Job {
|
|
274
|
+
static $gtype: GObject.GType<JobAnnots>;
|
|
275
|
+
|
|
276
|
+
// Own fields of XreaderView.JobAnnots
|
|
277
|
+
|
|
278
|
+
annots: any[];
|
|
279
|
+
|
|
280
|
+
// Constructors of XreaderView.JobAnnots
|
|
281
|
+
|
|
282
|
+
constructor(properties?: Partial<JobAnnots.ConstructorProps>, ...args: any[]);
|
|
283
|
+
|
|
284
|
+
_init(...args: any[]): void;
|
|
285
|
+
|
|
286
|
+
static ['new'](document: XreaderDocument.Document): JobAnnots;
|
|
287
|
+
}
|
|
288
|
+
|
|
289
|
+
module JobAttachments {
|
|
290
|
+
// Constructor properties interface
|
|
291
|
+
|
|
292
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
293
|
+
}
|
|
294
|
+
|
|
295
|
+
class JobAttachments extends Job {
|
|
296
|
+
static $gtype: GObject.GType<JobAttachments>;
|
|
297
|
+
|
|
298
|
+
// Own fields of XreaderView.JobAttachments
|
|
299
|
+
|
|
300
|
+
attachments: any[];
|
|
301
|
+
|
|
302
|
+
// Constructors of XreaderView.JobAttachments
|
|
303
|
+
|
|
304
|
+
constructor(properties?: Partial<JobAttachments.ConstructorProps>, ...args: any[]);
|
|
305
|
+
|
|
306
|
+
_init(...args: any[]): void;
|
|
307
|
+
|
|
308
|
+
static ['new'](document: XreaderDocument.Document): JobAttachments;
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
module JobExport {
|
|
312
|
+
// Constructor properties interface
|
|
313
|
+
|
|
314
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
315
|
+
}
|
|
316
|
+
|
|
317
|
+
class JobExport extends Job {
|
|
318
|
+
static $gtype: GObject.GType<JobExport>;
|
|
319
|
+
|
|
320
|
+
// Own fields of XreaderView.JobExport
|
|
321
|
+
|
|
322
|
+
page: number;
|
|
323
|
+
rc: XreaderDocument.RenderContext;
|
|
324
|
+
|
|
325
|
+
// Constructors of XreaderView.JobExport
|
|
326
|
+
|
|
327
|
+
constructor(properties?: Partial<JobExport.ConstructorProps>, ...args: any[]);
|
|
328
|
+
|
|
329
|
+
_init(...args: any[]): void;
|
|
330
|
+
|
|
331
|
+
static ['new'](document: XreaderDocument.Document): JobExport;
|
|
332
|
+
|
|
333
|
+
// Own methods of XreaderView.JobExport
|
|
334
|
+
|
|
335
|
+
set_page(page: number): void;
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
module JobFind {
|
|
339
|
+
// Signal callback interfaces
|
|
340
|
+
|
|
341
|
+
interface Updated {
|
|
342
|
+
(object: number): void;
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
// Constructor properties interface
|
|
346
|
+
|
|
347
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
348
|
+
}
|
|
349
|
+
|
|
350
|
+
class JobFind extends Job {
|
|
351
|
+
static $gtype: GObject.GType<JobFind>;
|
|
352
|
+
|
|
353
|
+
// Own fields of XreaderView.JobFind
|
|
354
|
+
|
|
355
|
+
start_page: number;
|
|
356
|
+
current_page: number;
|
|
357
|
+
n_pages: number;
|
|
358
|
+
total_count: number;
|
|
359
|
+
pages: any[];
|
|
360
|
+
results: number;
|
|
361
|
+
text: string;
|
|
362
|
+
case_sensitive: boolean;
|
|
363
|
+
|
|
364
|
+
// Constructors of XreaderView.JobFind
|
|
365
|
+
|
|
366
|
+
constructor(properties?: Partial<JobFind.ConstructorProps>, ...args: any[]);
|
|
367
|
+
|
|
368
|
+
_init(...args: any[]): void;
|
|
369
|
+
|
|
370
|
+
static ['new'](
|
|
371
|
+
document: XreaderDocument.Document,
|
|
372
|
+
start_page: number,
|
|
373
|
+
n_pages: number,
|
|
374
|
+
text: string,
|
|
375
|
+
case_sensitive: boolean,
|
|
376
|
+
): JobFind;
|
|
377
|
+
|
|
378
|
+
// Own signals of XreaderView.JobFind
|
|
379
|
+
|
|
380
|
+
connect(id: string, callback: (...args: any[]) => any): number;
|
|
381
|
+
connect_after(id: string, callback: (...args: any[]) => any): number;
|
|
382
|
+
emit(id: string, ...args: any[]): void;
|
|
383
|
+
connect(signal: 'updated', callback: (_source: this, object: number) => void): number;
|
|
384
|
+
connect_after(signal: 'updated', callback: (_source: this, object: number) => void): number;
|
|
385
|
+
emit(signal: 'updated', object: number): void;
|
|
386
|
+
|
|
387
|
+
// Own virtual methods of XreaderView.JobFind
|
|
388
|
+
|
|
389
|
+
vfunc_updated(page: number): void;
|
|
390
|
+
|
|
391
|
+
// Own methods of XreaderView.JobFind
|
|
392
|
+
|
|
393
|
+
get_n_results(pages: number): number;
|
|
394
|
+
get_progress(): number;
|
|
395
|
+
get_text(): string;
|
|
396
|
+
has_results(): boolean;
|
|
397
|
+
}
|
|
398
|
+
|
|
399
|
+
module JobFonts {
|
|
400
|
+
// Signal callback interfaces
|
|
401
|
+
|
|
402
|
+
interface Updated {
|
|
403
|
+
(object: number): void;
|
|
404
|
+
}
|
|
405
|
+
|
|
406
|
+
// Constructor properties interface
|
|
407
|
+
|
|
408
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
409
|
+
}
|
|
410
|
+
|
|
411
|
+
class JobFonts extends Job {
|
|
412
|
+
static $gtype: GObject.GType<JobFonts>;
|
|
413
|
+
|
|
414
|
+
// Own fields of XreaderView.JobFonts
|
|
415
|
+
|
|
416
|
+
scan_completed: boolean;
|
|
417
|
+
|
|
418
|
+
// Constructors of XreaderView.JobFonts
|
|
419
|
+
|
|
420
|
+
constructor(properties?: Partial<JobFonts.ConstructorProps>, ...args: any[]);
|
|
421
|
+
|
|
422
|
+
_init(...args: any[]): void;
|
|
423
|
+
|
|
424
|
+
static ['new'](document: XreaderDocument.Document): JobFonts;
|
|
425
|
+
|
|
426
|
+
// Own signals of XreaderView.JobFonts
|
|
427
|
+
|
|
428
|
+
connect(id: string, callback: (...args: any[]) => any): number;
|
|
429
|
+
connect_after(id: string, callback: (...args: any[]) => any): number;
|
|
430
|
+
emit(id: string, ...args: any[]): void;
|
|
431
|
+
connect(signal: 'updated', callback: (_source: this, object: number) => void): number;
|
|
432
|
+
connect_after(signal: 'updated', callback: (_source: this, object: number) => void): number;
|
|
433
|
+
emit(signal: 'updated', object: number): void;
|
|
434
|
+
|
|
435
|
+
// Own virtual methods of XreaderView.JobFonts
|
|
436
|
+
|
|
437
|
+
vfunc_updated(progress: number): void;
|
|
438
|
+
}
|
|
439
|
+
|
|
440
|
+
module JobLayers {
|
|
441
|
+
// Constructor properties interface
|
|
442
|
+
|
|
443
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
444
|
+
}
|
|
445
|
+
|
|
446
|
+
class JobLayers extends Job {
|
|
447
|
+
static $gtype: GObject.GType<JobLayers>;
|
|
448
|
+
|
|
449
|
+
// Own fields of XreaderView.JobLayers
|
|
450
|
+
|
|
451
|
+
model: Gtk.TreeModel;
|
|
452
|
+
|
|
453
|
+
// Constructors of XreaderView.JobLayers
|
|
454
|
+
|
|
455
|
+
constructor(properties?: Partial<JobLayers.ConstructorProps>, ...args: any[]);
|
|
456
|
+
|
|
457
|
+
_init(...args: any[]): void;
|
|
458
|
+
|
|
459
|
+
static ['new'](document: XreaderDocument.Document): JobLayers;
|
|
460
|
+
}
|
|
461
|
+
|
|
462
|
+
module JobLinks {
|
|
463
|
+
// Constructor properties interface
|
|
464
|
+
|
|
465
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
class JobLinks extends Job {
|
|
469
|
+
static $gtype: GObject.GType<JobLinks>;
|
|
470
|
+
|
|
471
|
+
// Own fields of XreaderView.JobLinks
|
|
472
|
+
|
|
473
|
+
model: Gtk.TreeModel;
|
|
474
|
+
|
|
475
|
+
// Constructors of XreaderView.JobLinks
|
|
476
|
+
|
|
477
|
+
constructor(properties?: Partial<JobLinks.ConstructorProps>, ...args: any[]);
|
|
478
|
+
|
|
479
|
+
_init(...args: any[]): void;
|
|
480
|
+
|
|
481
|
+
static ['new'](document: XreaderDocument.Document): JobLinks;
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
module JobLoad {
|
|
485
|
+
// Constructor properties interface
|
|
486
|
+
|
|
487
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
488
|
+
}
|
|
489
|
+
|
|
490
|
+
class JobLoad extends Job {
|
|
491
|
+
static $gtype: GObject.GType<JobLoad>;
|
|
492
|
+
|
|
493
|
+
// Own fields of XreaderView.JobLoad
|
|
494
|
+
|
|
495
|
+
uri: string;
|
|
496
|
+
password: string;
|
|
497
|
+
|
|
498
|
+
// Constructors of XreaderView.JobLoad
|
|
499
|
+
|
|
500
|
+
constructor(properties?: Partial<JobLoad.ConstructorProps>, ...args: any[]);
|
|
501
|
+
|
|
502
|
+
_init(...args: any[]): void;
|
|
503
|
+
|
|
504
|
+
static ['new'](uri: string): JobLoad;
|
|
505
|
+
|
|
506
|
+
// Own methods of XreaderView.JobLoad
|
|
507
|
+
|
|
508
|
+
set_password(password: string): void;
|
|
509
|
+
set_uri(uri: string): void;
|
|
510
|
+
}
|
|
511
|
+
|
|
512
|
+
module JobPageData {
|
|
513
|
+
// Constructor properties interface
|
|
514
|
+
|
|
515
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
516
|
+
}
|
|
517
|
+
|
|
518
|
+
class JobPageData extends Job {
|
|
519
|
+
static $gtype: GObject.GType<JobPageData>;
|
|
520
|
+
|
|
521
|
+
// Own fields of XreaderView.JobPageData
|
|
522
|
+
|
|
523
|
+
page: number;
|
|
524
|
+
flags: JobPageDataFlags;
|
|
525
|
+
text: string;
|
|
526
|
+
text_layout: XreaderDocument.Rectangle;
|
|
527
|
+
text_layout_length: number;
|
|
528
|
+
|
|
529
|
+
// Constructors of XreaderView.JobPageData
|
|
530
|
+
|
|
531
|
+
constructor(properties?: Partial<JobPageData.ConstructorProps>, ...args: any[]);
|
|
532
|
+
|
|
533
|
+
_init(...args: any[]): void;
|
|
534
|
+
|
|
535
|
+
static ['new'](document: XreaderDocument.Document, page: number, flags: JobPageDataFlags): JobPageData;
|
|
536
|
+
}
|
|
537
|
+
|
|
538
|
+
module JobPrint {
|
|
539
|
+
// Constructor properties interface
|
|
540
|
+
|
|
541
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
542
|
+
}
|
|
543
|
+
|
|
544
|
+
class JobPrint extends Job {
|
|
545
|
+
static $gtype: GObject.GType<JobPrint>;
|
|
546
|
+
|
|
547
|
+
// Own fields of XreaderView.JobPrint
|
|
548
|
+
|
|
549
|
+
page: number;
|
|
550
|
+
|
|
551
|
+
// Constructors of XreaderView.JobPrint
|
|
552
|
+
|
|
553
|
+
constructor(properties?: Partial<JobPrint.ConstructorProps>, ...args: any[]);
|
|
554
|
+
|
|
555
|
+
_init(...args: any[]): void;
|
|
556
|
+
|
|
557
|
+
static ['new'](document: XreaderDocument.Document): JobPrint;
|
|
558
|
+
|
|
559
|
+
// Own methods of XreaderView.JobPrint
|
|
560
|
+
|
|
561
|
+
set_cairo(cr: cairo.Context): void;
|
|
562
|
+
set_page(page: number): void;
|
|
563
|
+
}
|
|
564
|
+
|
|
565
|
+
module JobRender {
|
|
566
|
+
// Constructor properties interface
|
|
567
|
+
|
|
568
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
569
|
+
}
|
|
570
|
+
|
|
571
|
+
class JobRender extends Job {
|
|
572
|
+
static $gtype: GObject.GType<JobRender>;
|
|
573
|
+
|
|
574
|
+
// Own fields of XreaderView.JobRender
|
|
575
|
+
|
|
576
|
+
page: number;
|
|
577
|
+
rotation: number;
|
|
578
|
+
scale: number;
|
|
579
|
+
page_ready: boolean;
|
|
580
|
+
target_width: number;
|
|
581
|
+
target_height: number;
|
|
582
|
+
include_selection: boolean;
|
|
583
|
+
selection_points: XreaderDocument.Rectangle;
|
|
584
|
+
selection_style: XreaderDocument.SelectionStyle;
|
|
585
|
+
base: Gdk.Color;
|
|
586
|
+
text: Gdk.Color;
|
|
587
|
+
|
|
588
|
+
// Constructors of XreaderView.JobRender
|
|
589
|
+
|
|
590
|
+
constructor(properties?: Partial<JobRender.ConstructorProps>, ...args: any[]);
|
|
591
|
+
|
|
592
|
+
_init(...args: any[]): void;
|
|
593
|
+
|
|
594
|
+
static ['new'](
|
|
595
|
+
document: XreaderDocument.Document,
|
|
596
|
+
page: number,
|
|
597
|
+
rotation: number,
|
|
598
|
+
scale: number,
|
|
599
|
+
width: number,
|
|
600
|
+
height: number,
|
|
601
|
+
): JobRender;
|
|
602
|
+
|
|
603
|
+
// Own methods of XreaderView.JobRender
|
|
604
|
+
|
|
605
|
+
set_selection_info(
|
|
606
|
+
selection_points: XreaderDocument.Rectangle,
|
|
607
|
+
selection_style: XreaderDocument.SelectionStyle,
|
|
608
|
+
text: Gdk.Color,
|
|
609
|
+
base: Gdk.Color,
|
|
610
|
+
): void;
|
|
611
|
+
}
|
|
612
|
+
|
|
613
|
+
module JobSave {
|
|
614
|
+
// Constructor properties interface
|
|
615
|
+
|
|
616
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
617
|
+
}
|
|
618
|
+
|
|
619
|
+
class JobSave extends Job {
|
|
620
|
+
static $gtype: GObject.GType<JobSave>;
|
|
621
|
+
|
|
622
|
+
// Own fields of XreaderView.JobSave
|
|
623
|
+
|
|
624
|
+
uri: string;
|
|
625
|
+
document_uri: string;
|
|
626
|
+
|
|
627
|
+
// Constructors of XreaderView.JobSave
|
|
628
|
+
|
|
629
|
+
constructor(properties?: Partial<JobSave.ConstructorProps>, ...args: any[]);
|
|
630
|
+
|
|
631
|
+
_init(...args: any[]): void;
|
|
632
|
+
|
|
633
|
+
static ['new'](document: XreaderDocument.Document, uri: string, document_uri: string): JobSave;
|
|
634
|
+
}
|
|
635
|
+
|
|
636
|
+
module JobThumbnail {
|
|
637
|
+
// Constructor properties interface
|
|
638
|
+
|
|
639
|
+
interface ConstructorProps extends Job.ConstructorProps {}
|
|
640
|
+
}
|
|
641
|
+
|
|
642
|
+
class JobThumbnail extends Job {
|
|
643
|
+
static $gtype: GObject.GType<JobThumbnail>;
|
|
644
|
+
|
|
645
|
+
// Own fields of XreaderView.JobThumbnail
|
|
646
|
+
|
|
647
|
+
page: number;
|
|
648
|
+
rotation: number;
|
|
649
|
+
scale: number;
|
|
650
|
+
thumbnail: GdkPixbuf.Pixbuf;
|
|
651
|
+
|
|
652
|
+
// Constructors of XreaderView.JobThumbnail
|
|
653
|
+
|
|
654
|
+
constructor(properties?: Partial<JobThumbnail.ConstructorProps>, ...args: any[]);
|
|
655
|
+
|
|
656
|
+
_init(...args: any[]): void;
|
|
657
|
+
|
|
658
|
+
static ['new'](document: XreaderDocument.Document, page: number, rotation: number, scale: number): JobThumbnail;
|
|
659
|
+
}
|
|
660
|
+
|
|
661
|
+
module PrintOperation {
|
|
662
|
+
// Signal callback interfaces
|
|
663
|
+
|
|
664
|
+
interface BeginPrint {
|
|
665
|
+
(): void;
|
|
666
|
+
}
|
|
667
|
+
|
|
668
|
+
interface Done {
|
|
669
|
+
(object: Gtk.PrintOperationResult): void;
|
|
670
|
+
}
|
|
671
|
+
|
|
672
|
+
interface StatusChanged {
|
|
673
|
+
(): void;
|
|
674
|
+
}
|
|
675
|
+
|
|
676
|
+
// Constructor properties interface
|
|
677
|
+
|
|
678
|
+
interface ConstructorProps extends GObject.Object.ConstructorProps {
|
|
679
|
+
document: XreaderDocument.Document;
|
|
680
|
+
}
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
abstract class PrintOperation extends GObject.Object {
|
|
684
|
+
static $gtype: GObject.GType<PrintOperation>;
|
|
685
|
+
|
|
686
|
+
// Own properties of XreaderView.PrintOperation
|
|
687
|
+
|
|
688
|
+
set document(val: XreaderDocument.Document);
|
|
689
|
+
|
|
690
|
+
// Constructors of XreaderView.PrintOperation
|
|
691
|
+
|
|
692
|
+
constructor(properties?: Partial<PrintOperation.ConstructorProps>, ...args: any[]);
|
|
693
|
+
|
|
694
|
+
_init(...args: any[]): void;
|
|
695
|
+
|
|
696
|
+
static ['new'](document: XreaderDocument.Document): PrintOperation;
|
|
697
|
+
|
|
698
|
+
// Own signals of XreaderView.PrintOperation
|
|
699
|
+
|
|
700
|
+
connect(id: string, callback: (...args: any[]) => any): number;
|
|
701
|
+
connect_after(id: string, callback: (...args: any[]) => any): number;
|
|
702
|
+
emit(id: string, ...args: any[]): void;
|
|
703
|
+
connect(signal: 'begin-print', callback: (_source: this) => void): number;
|
|
704
|
+
connect_after(signal: 'begin-print', callback: (_source: this) => void): number;
|
|
705
|
+
emit(signal: 'begin-print'): void;
|
|
706
|
+
connect(signal: 'done', callback: (_source: this, object: Gtk.PrintOperationResult) => void): number;
|
|
707
|
+
connect_after(signal: 'done', callback: (_source: this, object: Gtk.PrintOperationResult) => void): number;
|
|
708
|
+
emit(signal: 'done', object: Gtk.PrintOperationResult): void;
|
|
709
|
+
connect(signal: 'status-changed', callback: (_source: this) => void): number;
|
|
710
|
+
connect_after(signal: 'status-changed', callback: (_source: this) => void): number;
|
|
711
|
+
emit(signal: 'status-changed'): void;
|
|
712
|
+
|
|
713
|
+
// Own static methods of XreaderView.PrintOperation
|
|
714
|
+
|
|
715
|
+
static exists_for_document(document: XreaderDocument.Document): boolean;
|
|
716
|
+
|
|
717
|
+
// Own methods of XreaderView.PrintOperation
|
|
718
|
+
|
|
719
|
+
cancel(): void;
|
|
720
|
+
get_embed_page_setup(): boolean;
|
|
721
|
+
get_error(): void;
|
|
722
|
+
get_job_name(): string;
|
|
723
|
+
get_progress(): number;
|
|
724
|
+
get_status(): string;
|
|
725
|
+
run(parent: Gtk.Window): void;
|
|
726
|
+
set_current_page(current_page: number): void;
|
|
727
|
+
set_default_page_setup(page_setup: Gtk.PageSetup): void;
|
|
728
|
+
set_embed_page_setup(embed: boolean): void;
|
|
729
|
+
set_job_name(job_name: string): void;
|
|
730
|
+
set_print_settings(print_settings: Gtk.PrintSettings): void;
|
|
731
|
+
}
|
|
732
|
+
|
|
733
|
+
module View {
|
|
734
|
+
// Signal callback interfaces
|
|
735
|
+
|
|
736
|
+
interface Activate {
|
|
737
|
+
(): void;
|
|
738
|
+
}
|
|
739
|
+
|
|
740
|
+
interface AnnotAdded {
|
|
741
|
+
(object: XreaderDocument.Annotation): void;
|
|
742
|
+
}
|
|
743
|
+
|
|
744
|
+
interface AnnotRemoved {
|
|
745
|
+
(object: XreaderDocument.Annotation): void;
|
|
746
|
+
}
|
|
747
|
+
|
|
748
|
+
interface BindingActivated {
|
|
749
|
+
(object: Gtk.ScrollType, p0: boolean): void;
|
|
750
|
+
}
|
|
751
|
+
|
|
752
|
+
interface ExternalLink {
|
|
753
|
+
(object: GObject.Object): void;
|
|
754
|
+
}
|
|
755
|
+
|
|
756
|
+
interface HandleLink {
|
|
757
|
+
(object: GObject.Object): void;
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
interface LayersChanged {
|
|
761
|
+
(): void;
|
|
762
|
+
}
|
|
763
|
+
|
|
764
|
+
interface Popup {
|
|
765
|
+
(object?: any | null): void;
|
|
766
|
+
}
|
|
767
|
+
|
|
768
|
+
interface SelectionChanged {
|
|
769
|
+
(): void;
|
|
770
|
+
}
|
|
771
|
+
|
|
772
|
+
interface SyncSource {
|
|
773
|
+
(object?: any | null): void;
|
|
774
|
+
}
|
|
775
|
+
|
|
776
|
+
// Constructor properties interface
|
|
777
|
+
|
|
778
|
+
interface ConstructorProps
|
|
779
|
+
extends Gtk.Container.ConstructorProps,
|
|
780
|
+
Atk.ImplementorIface.ConstructorProps,
|
|
781
|
+
Gtk.Buildable.ConstructorProps,
|
|
782
|
+
Gtk.Scrollable.ConstructorProps {}
|
|
783
|
+
}
|
|
784
|
+
|
|
785
|
+
class View extends Gtk.Container implements Atk.ImplementorIface, Gtk.Buildable, Gtk.Scrollable {
|
|
786
|
+
static $gtype: GObject.GType<View>;
|
|
787
|
+
|
|
788
|
+
// Constructors of XreaderView.View
|
|
789
|
+
|
|
790
|
+
constructor(properties?: Partial<View.ConstructorProps>, ...args: any[]);
|
|
791
|
+
|
|
792
|
+
_init(...args: any[]): void;
|
|
793
|
+
|
|
794
|
+
static ['new'](): View;
|
|
795
|
+
|
|
796
|
+
// Own signals of XreaderView.View
|
|
797
|
+
|
|
798
|
+
connect(id: string, callback: (...args: any[]) => any): number;
|
|
799
|
+
connect_after(id: string, callback: (...args: any[]) => any): number;
|
|
800
|
+
emit(id: string, ...args: any[]): void;
|
|
801
|
+
connect(signal: 'activate', callback: (_source: this) => void): number;
|
|
802
|
+
connect_after(signal: 'activate', callback: (_source: this) => void): number;
|
|
803
|
+
emit(signal: 'activate'): void;
|
|
804
|
+
connect(signal: 'annot-added', callback: (_source: this, object: XreaderDocument.Annotation) => void): number;
|
|
805
|
+
connect_after(
|
|
806
|
+
signal: 'annot-added',
|
|
807
|
+
callback: (_source: this, object: XreaderDocument.Annotation) => void,
|
|
808
|
+
): number;
|
|
809
|
+
emit(signal: 'annot-added', object: XreaderDocument.Annotation): void;
|
|
810
|
+
connect(signal: 'annot-removed', callback: (_source: this, object: XreaderDocument.Annotation) => void): number;
|
|
811
|
+
connect_after(
|
|
812
|
+
signal: 'annot-removed',
|
|
813
|
+
callback: (_source: this, object: XreaderDocument.Annotation) => void,
|
|
814
|
+
): number;
|
|
815
|
+
emit(signal: 'annot-removed', object: XreaderDocument.Annotation): void;
|
|
816
|
+
connect(
|
|
817
|
+
signal: 'binding-activated',
|
|
818
|
+
callback: (_source: this, object: Gtk.ScrollType, p0: boolean) => void,
|
|
819
|
+
): number;
|
|
820
|
+
connect_after(
|
|
821
|
+
signal: 'binding-activated',
|
|
822
|
+
callback: (_source: this, object: Gtk.ScrollType, p0: boolean) => void,
|
|
823
|
+
): number;
|
|
824
|
+
emit(signal: 'binding-activated', object: Gtk.ScrollType, p0: boolean): void;
|
|
825
|
+
connect(signal: 'external-link', callback: (_source: this, object: GObject.Object) => void): number;
|
|
826
|
+
connect_after(signal: 'external-link', callback: (_source: this, object: GObject.Object) => void): number;
|
|
827
|
+
emit(signal: 'external-link', object: GObject.Object): void;
|
|
828
|
+
connect(signal: 'handle-link', callback: (_source: this, object: GObject.Object) => void): number;
|
|
829
|
+
connect_after(signal: 'handle-link', callback: (_source: this, object: GObject.Object) => void): number;
|
|
830
|
+
emit(signal: 'handle-link', object: GObject.Object): void;
|
|
831
|
+
connect(signal: 'layers-changed', callback: (_source: this) => void): number;
|
|
832
|
+
connect_after(signal: 'layers-changed', callback: (_source: this) => void): number;
|
|
833
|
+
emit(signal: 'layers-changed'): void;
|
|
834
|
+
connect(signal: 'popup', callback: (_source: this, object: any | null) => void): number;
|
|
835
|
+
connect_after(signal: 'popup', callback: (_source: this, object: any | null) => void): number;
|
|
836
|
+
emit(signal: 'popup', object?: any | null): void;
|
|
837
|
+
connect(signal: 'selection-changed', callback: (_source: this) => void): number;
|
|
838
|
+
connect_after(signal: 'selection-changed', callback: (_source: this) => void): number;
|
|
839
|
+
emit(signal: 'selection-changed'): void;
|
|
840
|
+
connect(signal: 'sync-source', callback: (_source: this, object: any | null) => void): number;
|
|
841
|
+
connect_after(signal: 'sync-source', callback: (_source: this, object: any | null) => void): number;
|
|
842
|
+
emit(signal: 'sync-source', object?: any | null): void;
|
|
843
|
+
|
|
844
|
+
// Own methods of XreaderView.View
|
|
845
|
+
|
|
846
|
+
autoscroll_start(): void;
|
|
847
|
+
autoscroll_stop(): void;
|
|
848
|
+
begin_add_annotation(annot_type: XreaderDocument.AnnotationType): void;
|
|
849
|
+
can_zoom_in(): boolean;
|
|
850
|
+
can_zoom_out(): boolean;
|
|
851
|
+
cancel_add_annotation(): void;
|
|
852
|
+
copy(): void;
|
|
853
|
+
copy_link_address(action: XreaderDocument.LinkAction): void;
|
|
854
|
+
/**
|
|
855
|
+
* Disconnect all signal handlers from the model, to ensure error free operation of the webview,
|
|
856
|
+
* we have an equivalent function for the webview.
|
|
857
|
+
*/
|
|
858
|
+
disconnect_handlers(): void;
|
|
859
|
+
find_cancel(): void;
|
|
860
|
+
find_next(): void;
|
|
861
|
+
find_previous(): void;
|
|
862
|
+
find_search_changed(): void;
|
|
863
|
+
find_set_highlight_search(value: boolean): void;
|
|
864
|
+
focus_annotation(annot_mapping: XreaderDocument.Mapping): void;
|
|
865
|
+
get_has_selection(): boolean;
|
|
866
|
+
get_page_extents(page: number, page_area: Gdk.Rectangle, border: Gtk.Border): boolean;
|
|
867
|
+
handle_link(link: XreaderDocument.Link): void;
|
|
868
|
+
hide_cursor(): void;
|
|
869
|
+
highlight_forward_search(link: XreaderDocument.SourceLink): void;
|
|
870
|
+
next_page(): boolean;
|
|
871
|
+
previous_page(): boolean;
|
|
872
|
+
reload(): void;
|
|
873
|
+
remove_annotation(annot: XreaderDocument.Annotation): void;
|
|
874
|
+
scroll(scroll: Gtk.ScrollType, horizontal: boolean): void;
|
|
875
|
+
select_all(): void;
|
|
876
|
+
set_loading(loading: boolean): void;
|
|
877
|
+
set_model(model: DocumentModel): void;
|
|
878
|
+
/**
|
|
879
|
+
* Sets the maximum size in bytes that will be used to cache
|
|
880
|
+
* rendered pages. Use 0 to disable caching rendered pages.
|
|
881
|
+
*
|
|
882
|
+
* Note that this limit doesn't affect the current visible page range,
|
|
883
|
+
* which will always be rendered. In order to limit the total memory used
|
|
884
|
+
* you have to use ev_document_model_set_max_scale() too.
|
|
885
|
+
* @param cache_size
|
|
886
|
+
*/
|
|
887
|
+
set_page_cache_size(cache_size: number): void;
|
|
888
|
+
show_cursor(): void;
|
|
889
|
+
zoom_in(): void;
|
|
890
|
+
zoom_out(): void;
|
|
891
|
+
|
|
892
|
+
// Inherited properties
|
|
893
|
+
/**
|
|
894
|
+
* Horizontal #GtkAdjustment of the scrollable widget. This adjustment is
|
|
895
|
+
* shared between the scrollable widget and its parent.
|
|
896
|
+
*/
|
|
897
|
+
get hadjustment(): Gtk.Adjustment;
|
|
898
|
+
set hadjustment(val: Gtk.Adjustment);
|
|
899
|
+
/**
|
|
900
|
+
* Determines whether horizontal scrolling should start once the scrollable
|
|
901
|
+
* widget is allocated less than its minimum width or less than its natural width.
|
|
902
|
+
*/
|
|
903
|
+
get hscroll_policy(): Gtk.ScrollablePolicy;
|
|
904
|
+
set hscroll_policy(val: Gtk.ScrollablePolicy);
|
|
905
|
+
/**
|
|
906
|
+
* Determines whether horizontal scrolling should start once the scrollable
|
|
907
|
+
* widget is allocated less than its minimum width or less than its natural width.
|
|
908
|
+
*/
|
|
909
|
+
get hscrollPolicy(): Gtk.ScrollablePolicy;
|
|
910
|
+
set hscrollPolicy(val: Gtk.ScrollablePolicy);
|
|
911
|
+
/**
|
|
912
|
+
* Verical #GtkAdjustment of the scrollable widget. This adjustment is shared
|
|
913
|
+
* between the scrollable widget and its parent.
|
|
914
|
+
*/
|
|
915
|
+
get vadjustment(): Gtk.Adjustment;
|
|
916
|
+
set vadjustment(val: Gtk.Adjustment);
|
|
917
|
+
/**
|
|
918
|
+
* Determines whether vertical scrolling should start once the scrollable
|
|
919
|
+
* widget is allocated less than its minimum height or less than its natural height.
|
|
920
|
+
*/
|
|
921
|
+
get vscroll_policy(): Gtk.ScrollablePolicy;
|
|
922
|
+
set vscroll_policy(val: Gtk.ScrollablePolicy);
|
|
923
|
+
/**
|
|
924
|
+
* Determines whether vertical scrolling should start once the scrollable
|
|
925
|
+
* widget is allocated less than its minimum height or less than its natural height.
|
|
926
|
+
*/
|
|
927
|
+
get vscrollPolicy(): Gtk.ScrollablePolicy;
|
|
928
|
+
set vscrollPolicy(val: Gtk.ScrollablePolicy);
|
|
929
|
+
|
|
930
|
+
// Inherited methods
|
|
931
|
+
/**
|
|
932
|
+
* Returns the size of a non-scrolling border around the
|
|
933
|
+
* outside of the scrollable. An example for this would
|
|
934
|
+
* be treeview headers. GTK+ can use this information to
|
|
935
|
+
* display overlayed graphics, like the overshoot indication,
|
|
936
|
+
* at the right position.
|
|
937
|
+
* @returns %TRUE if @border has been set
|
|
938
|
+
*/
|
|
939
|
+
get_border(): [boolean, Gtk.Border];
|
|
940
|
+
/**
|
|
941
|
+
* Retrieves the #GtkAdjustment used for horizontal scrolling.
|
|
942
|
+
* @returns horizontal #GtkAdjustment.
|
|
943
|
+
*/
|
|
944
|
+
get_hadjustment(): Gtk.Adjustment;
|
|
945
|
+
/**
|
|
946
|
+
* Gets the horizontal #GtkScrollablePolicy.
|
|
947
|
+
* @returns The horizontal #GtkScrollablePolicy.
|
|
948
|
+
*/
|
|
949
|
+
get_hscroll_policy(): Gtk.ScrollablePolicy;
|
|
950
|
+
/**
|
|
951
|
+
* Retrieves the #GtkAdjustment used for vertical scrolling.
|
|
952
|
+
* @returns vertical #GtkAdjustment.
|
|
953
|
+
*/
|
|
954
|
+
get_vadjustment(): Gtk.Adjustment;
|
|
955
|
+
/**
|
|
956
|
+
* Gets the vertical #GtkScrollablePolicy.
|
|
957
|
+
* @returns The vertical #GtkScrollablePolicy.
|
|
958
|
+
*/
|
|
959
|
+
get_vscroll_policy(): Gtk.ScrollablePolicy;
|
|
960
|
+
/**
|
|
961
|
+
* Sets the horizontal adjustment of the #GtkScrollable.
|
|
962
|
+
* @param hadjustment a #GtkAdjustment
|
|
963
|
+
*/
|
|
964
|
+
set_hadjustment(hadjustment?: Gtk.Adjustment | null): void;
|
|
965
|
+
/**
|
|
966
|
+
* Sets the #GtkScrollablePolicy to determine whether
|
|
967
|
+
* horizontal scrolling should start below the minimum width or
|
|
968
|
+
* below the natural width.
|
|
969
|
+
* @param policy the horizontal #GtkScrollablePolicy
|
|
970
|
+
*/
|
|
971
|
+
set_hscroll_policy(policy: Gtk.ScrollablePolicy): void;
|
|
972
|
+
/**
|
|
973
|
+
* Sets the vertical adjustment of the #GtkScrollable.
|
|
974
|
+
* @param vadjustment a #GtkAdjustment
|
|
975
|
+
*/
|
|
976
|
+
set_vadjustment(vadjustment?: Gtk.Adjustment | null): void;
|
|
977
|
+
/**
|
|
978
|
+
* Sets the #GtkScrollablePolicy to determine whether
|
|
979
|
+
* vertical scrolling should start below the minimum height or
|
|
980
|
+
* below the natural height.
|
|
981
|
+
* @param policy the vertical #GtkScrollablePolicy
|
|
982
|
+
*/
|
|
983
|
+
set_vscroll_policy(policy: Gtk.ScrollablePolicy): void;
|
|
984
|
+
/**
|
|
985
|
+
* Returns the size of a non-scrolling border around the
|
|
986
|
+
* outside of the scrollable. An example for this would
|
|
987
|
+
* be treeview headers. GTK+ can use this information to
|
|
988
|
+
* display overlayed graphics, like the overshoot indication,
|
|
989
|
+
* at the right position.
|
|
990
|
+
*/
|
|
991
|
+
vfunc_get_border(): [boolean, Gtk.Border];
|
|
992
|
+
/**
|
|
993
|
+
* Creates a binding between `source_property` on `source` and `target_property`
|
|
994
|
+
* on `target`.
|
|
995
|
+
*
|
|
996
|
+
* Whenever the `source_property` is changed the `target_property` is
|
|
997
|
+
* updated using the same value. For instance:
|
|
998
|
+
*
|
|
999
|
+
*
|
|
1000
|
+
* ```c
|
|
1001
|
+
* g_object_bind_property (action, "active", widget, "sensitive", 0);
|
|
1002
|
+
* ```
|
|
1003
|
+
*
|
|
1004
|
+
*
|
|
1005
|
+
* Will result in the "sensitive" property of the widget #GObject instance to be
|
|
1006
|
+
* updated with the same value of the "active" property of the action #GObject
|
|
1007
|
+
* instance.
|
|
1008
|
+
*
|
|
1009
|
+
* If `flags` contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
|
|
1010
|
+
* if `target_property` on `target` changes then the `source_property` on `source`
|
|
1011
|
+
* will be updated as well.
|
|
1012
|
+
*
|
|
1013
|
+
* The binding will automatically be removed when either the `source` or the
|
|
1014
|
+
* `target` instances are finalized. To remove the binding without affecting the
|
|
1015
|
+
* `source` and the `target` you can just call g_object_unref() on the returned
|
|
1016
|
+
* #GBinding instance.
|
|
1017
|
+
*
|
|
1018
|
+
* Removing the binding by calling g_object_unref() on it must only be done if
|
|
1019
|
+
* the binding, `source` and `target` are only used from a single thread and it
|
|
1020
|
+
* is clear that both `source` and `target` outlive the binding. Especially it
|
|
1021
|
+
* is not safe to rely on this if the binding, `source` or `target` can be
|
|
1022
|
+
* finalized from different threads. Keep another reference to the binding and
|
|
1023
|
+
* use g_binding_unbind() instead to be on the safe side.
|
|
1024
|
+
*
|
|
1025
|
+
* A #GObject can have multiple bindings.
|
|
1026
|
+
* @param source_property the property on @source to bind
|
|
1027
|
+
* @param target the target #GObject
|
|
1028
|
+
* @param target_property the property on @target to bind
|
|
1029
|
+
* @param flags flags to pass to #GBinding
|
|
1030
|
+
* @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
|
|
1031
|
+
*/
|
|
1032
|
+
bind_property(
|
|
1033
|
+
source_property: string,
|
|
1034
|
+
target: GObject.Object,
|
|
1035
|
+
target_property: string,
|
|
1036
|
+
flags: GObject.BindingFlags,
|
|
1037
|
+
): GObject.Binding;
|
|
1038
|
+
/**
|
|
1039
|
+
* Complete version of g_object_bind_property().
|
|
1040
|
+
*
|
|
1041
|
+
* Creates a binding between `source_property` on `source` and `target_property`
|
|
1042
|
+
* on `target,` allowing you to set the transformation functions to be used by
|
|
1043
|
+
* the binding.
|
|
1044
|
+
*
|
|
1045
|
+
* If `flags` contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
|
|
1046
|
+
* if `target_property` on `target` changes then the `source_property` on `source`
|
|
1047
|
+
* will be updated as well. The `transform_from` function is only used in case
|
|
1048
|
+
* of bidirectional bindings, otherwise it will be ignored
|
|
1049
|
+
*
|
|
1050
|
+
* The binding will automatically be removed when either the `source` or the
|
|
1051
|
+
* `target` instances are finalized. This will release the reference that is
|
|
1052
|
+
* being held on the #GBinding instance; if you want to hold on to the
|
|
1053
|
+
* #GBinding instance, you will need to hold a reference to it.
|
|
1054
|
+
*
|
|
1055
|
+
* To remove the binding, call g_binding_unbind().
|
|
1056
|
+
*
|
|
1057
|
+
* A #GObject can have multiple bindings.
|
|
1058
|
+
*
|
|
1059
|
+
* The same `user_data` parameter will be used for both `transform_to`
|
|
1060
|
+
* and `transform_from` transformation functions; the `notify` function will
|
|
1061
|
+
* be called once, when the binding is removed. If you need different data
|
|
1062
|
+
* for each transformation function, please use
|
|
1063
|
+
* g_object_bind_property_with_closures() instead.
|
|
1064
|
+
* @param source_property the property on @source to bind
|
|
1065
|
+
* @param target the target #GObject
|
|
1066
|
+
* @param target_property the property on @target to bind
|
|
1067
|
+
* @param flags flags to pass to #GBinding
|
|
1068
|
+
* @param transform_to the transformation function from the @source to the @target, or %NULL to use the default
|
|
1069
|
+
* @param transform_from the transformation function from the @target to the @source, or %NULL to use the default
|
|
1070
|
+
* @param notify a function to call when disposing the binding, to free resources used by the transformation functions, or %NULL if not required
|
|
1071
|
+
* @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
|
|
1072
|
+
*/
|
|
1073
|
+
bind_property_full(
|
|
1074
|
+
source_property: string,
|
|
1075
|
+
target: GObject.Object,
|
|
1076
|
+
target_property: string,
|
|
1077
|
+
flags: GObject.BindingFlags,
|
|
1078
|
+
transform_to?: GObject.BindingTransformFunc | null,
|
|
1079
|
+
transform_from?: GObject.BindingTransformFunc | null,
|
|
1080
|
+
notify?: GLib.DestroyNotify | null,
|
|
1081
|
+
): GObject.Binding;
|
|
1082
|
+
// Conflicted with GObject.Object.bind_property_full
|
|
1083
|
+
bind_property_full(...args: never[]): any;
|
|
1084
|
+
/**
|
|
1085
|
+
* This function is intended for #GObject implementations to re-enforce
|
|
1086
|
+
* a [floating][floating-ref] object reference. Doing this is seldom
|
|
1087
|
+
* required: all #GInitiallyUnowneds are created with a floating reference
|
|
1088
|
+
* which usually just needs to be sunken by calling g_object_ref_sink().
|
|
1089
|
+
*/
|
|
1090
|
+
force_floating(): void;
|
|
1091
|
+
/**
|
|
1092
|
+
* Increases the freeze count on `object`. If the freeze count is
|
|
1093
|
+
* non-zero, the emission of "notify" signals on `object` is
|
|
1094
|
+
* stopped. The signals are queued until the freeze count is decreased
|
|
1095
|
+
* to zero. Duplicate notifications are squashed so that at most one
|
|
1096
|
+
* #GObject::notify signal is emitted for each property modified while the
|
|
1097
|
+
* object is frozen.
|
|
1098
|
+
*
|
|
1099
|
+
* This is necessary for accessors that modify multiple properties to prevent
|
|
1100
|
+
* premature notification while the object is still being modified.
|
|
1101
|
+
*/
|
|
1102
|
+
freeze_notify(): void;
|
|
1103
|
+
/**
|
|
1104
|
+
* Gets a named field from the objects table of associations (see g_object_set_data()).
|
|
1105
|
+
* @param key name of the key for that association
|
|
1106
|
+
* @returns the data if found, or %NULL if no such data exists.
|
|
1107
|
+
*/
|
|
1108
|
+
get_data(key: string): any | null;
|
|
1109
|
+
get_property(property_name: string): any;
|
|
1110
|
+
/**
|
|
1111
|
+
* This function gets back user data pointers stored via
|
|
1112
|
+
* g_object_set_qdata().
|
|
1113
|
+
* @param quark A #GQuark, naming the user data pointer
|
|
1114
|
+
* @returns The user data pointer set, or %NULL
|
|
1115
|
+
*/
|
|
1116
|
+
get_qdata(quark: GLib.Quark): any | null;
|
|
1117
|
+
/**
|
|
1118
|
+
* Gets `n_properties` properties for an `object`.
|
|
1119
|
+
* Obtained properties will be set to `values`. All properties must be valid.
|
|
1120
|
+
* Warnings will be emitted and undefined behaviour may result if invalid
|
|
1121
|
+
* properties are passed in.
|
|
1122
|
+
* @param names the names of each property to get
|
|
1123
|
+
* @param values the values of each property to get
|
|
1124
|
+
*/
|
|
1125
|
+
getv(names: string[], values: (GObject.Value | any)[]): void;
|
|
1126
|
+
/**
|
|
1127
|
+
* Checks whether `object` has a [floating][floating-ref] reference.
|
|
1128
|
+
* @returns %TRUE if @object has a floating reference
|
|
1129
|
+
*/
|
|
1130
|
+
is_floating(): boolean;
|
|
1131
|
+
/**
|
|
1132
|
+
* Emits a "notify" signal for the property `property_name` on `object`.
|
|
1133
|
+
*
|
|
1134
|
+
* When possible, eg. when signaling a property change from within the class
|
|
1135
|
+
* that registered the property, you should use g_object_notify_by_pspec()
|
|
1136
|
+
* instead.
|
|
1137
|
+
*
|
|
1138
|
+
* Note that emission of the notify signal may be blocked with
|
|
1139
|
+
* g_object_freeze_notify(). In this case, the signal emissions are queued
|
|
1140
|
+
* and will be emitted (in reverse order) when g_object_thaw_notify() is
|
|
1141
|
+
* called.
|
|
1142
|
+
* @param property_name the name of a property installed on the class of @object.
|
|
1143
|
+
*/
|
|
1144
|
+
notify(property_name: string): void;
|
|
1145
|
+
/**
|
|
1146
|
+
* Emits a "notify" signal for the property specified by `pspec` on `object`.
|
|
1147
|
+
*
|
|
1148
|
+
* This function omits the property name lookup, hence it is faster than
|
|
1149
|
+
* g_object_notify().
|
|
1150
|
+
*
|
|
1151
|
+
* One way to avoid using g_object_notify() from within the
|
|
1152
|
+
* class that registered the properties, and using g_object_notify_by_pspec()
|
|
1153
|
+
* instead, is to store the GParamSpec used with
|
|
1154
|
+
* g_object_class_install_property() inside a static array, e.g.:
|
|
1155
|
+
*
|
|
1156
|
+
*
|
|
1157
|
+
* ```c
|
|
1158
|
+
* typedef enum
|
|
1159
|
+
* {
|
|
1160
|
+
* PROP_FOO = 1,
|
|
1161
|
+
* PROP_LAST
|
|
1162
|
+
* } MyObjectProperty;
|
|
1163
|
+
*
|
|
1164
|
+
* static GParamSpec *properties[PROP_LAST];
|
|
1165
|
+
*
|
|
1166
|
+
* static void
|
|
1167
|
+
* my_object_class_init (MyObjectClass *klass)
|
|
1168
|
+
* {
|
|
1169
|
+
* properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
|
|
1170
|
+
* 0, 100,
|
|
1171
|
+
* 50,
|
|
1172
|
+
* G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
|
|
1173
|
+
* g_object_class_install_property (gobject_class,
|
|
1174
|
+
* PROP_FOO,
|
|
1175
|
+
* properties[PROP_FOO]);
|
|
1176
|
+
* }
|
|
1177
|
+
* ```
|
|
1178
|
+
*
|
|
1179
|
+
*
|
|
1180
|
+
* and then notify a change on the "foo" property with:
|
|
1181
|
+
*
|
|
1182
|
+
*
|
|
1183
|
+
* ```c
|
|
1184
|
+
* g_object_notify_by_pspec (self, properties[PROP_FOO]);
|
|
1185
|
+
* ```
|
|
1186
|
+
*
|
|
1187
|
+
* @param pspec the #GParamSpec of a property installed on the class of @object.
|
|
1188
|
+
*/
|
|
1189
|
+
notify_by_pspec(pspec: GObject.ParamSpec): void;
|
|
1190
|
+
/**
|
|
1191
|
+
* Increases the reference count of `object`.
|
|
1192
|
+
*
|
|
1193
|
+
* Since GLib 2.56, if `GLIB_VERSION_MAX_ALLOWED` is 2.56 or greater, the type
|
|
1194
|
+
* of `object` will be propagated to the return type (using the GCC typeof()
|
|
1195
|
+
* extension), so any casting the caller needs to do on the return type must be
|
|
1196
|
+
* explicit.
|
|
1197
|
+
* @returns the same @object
|
|
1198
|
+
*/
|
|
1199
|
+
ref(): GObject.Object;
|
|
1200
|
+
/**
|
|
1201
|
+
* Increase the reference count of `object,` and possibly remove the
|
|
1202
|
+
* [floating][floating-ref] reference, if `object` has a floating reference.
|
|
1203
|
+
*
|
|
1204
|
+
* In other words, if the object is floating, then this call "assumes
|
|
1205
|
+
* ownership" of the floating reference, converting it to a normal
|
|
1206
|
+
* reference by clearing the floating flag while leaving the reference
|
|
1207
|
+
* count unchanged. If the object is not floating, then this call
|
|
1208
|
+
* adds a new normal reference increasing the reference count by one.
|
|
1209
|
+
*
|
|
1210
|
+
* Since GLib 2.56, the type of `object` will be propagated to the return type
|
|
1211
|
+
* under the same conditions as for g_object_ref().
|
|
1212
|
+
* @returns @object
|
|
1213
|
+
*/
|
|
1214
|
+
ref_sink(): GObject.Object;
|
|
1215
|
+
/**
|
|
1216
|
+
* Releases all references to other objects. This can be used to break
|
|
1217
|
+
* reference cycles.
|
|
1218
|
+
*
|
|
1219
|
+
* This function should only be called from object system implementations.
|
|
1220
|
+
*/
|
|
1221
|
+
run_dispose(): void;
|
|
1222
|
+
/**
|
|
1223
|
+
* Each object carries around a table of associations from
|
|
1224
|
+
* strings to pointers. This function lets you set an association.
|
|
1225
|
+
*
|
|
1226
|
+
* If the object already had an association with that name,
|
|
1227
|
+
* the old association will be destroyed.
|
|
1228
|
+
*
|
|
1229
|
+
* Internally, the `key` is converted to a #GQuark using g_quark_from_string().
|
|
1230
|
+
* This means a copy of `key` is kept permanently (even after `object` has been
|
|
1231
|
+
* finalized) — so it is recommended to only use a small, bounded set of values
|
|
1232
|
+
* for `key` in your program, to avoid the #GQuark storage growing unbounded.
|
|
1233
|
+
* @param key name of the key
|
|
1234
|
+
* @param data data to associate with that key
|
|
1235
|
+
*/
|
|
1236
|
+
set_data(key: string, data?: any | null): void;
|
|
1237
|
+
set_property(property_name: string, value: any): void;
|
|
1238
|
+
/**
|
|
1239
|
+
* Remove a specified datum from the object's data associations,
|
|
1240
|
+
* without invoking the association's destroy handler.
|
|
1241
|
+
* @param key name of the key
|
|
1242
|
+
* @returns the data if found, or %NULL if no such data exists.
|
|
1243
|
+
*/
|
|
1244
|
+
steal_data(key: string): any | null;
|
|
1245
|
+
/**
|
|
1246
|
+
* This function gets back user data pointers stored via
|
|
1247
|
+
* g_object_set_qdata() and removes the `data` from object
|
|
1248
|
+
* without invoking its destroy() function (if any was
|
|
1249
|
+
* set).
|
|
1250
|
+
* Usually, calling this function is only required to update
|
|
1251
|
+
* user data pointers with a destroy notifier, for example:
|
|
1252
|
+
*
|
|
1253
|
+
* ```c
|
|
1254
|
+
* void
|
|
1255
|
+
* object_add_to_user_list (GObject *object,
|
|
1256
|
+
* const gchar *new_string)
|
|
1257
|
+
* {
|
|
1258
|
+
* // the quark, naming the object data
|
|
1259
|
+
* GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
|
|
1260
|
+
* // retrieve the old string list
|
|
1261
|
+
* GList *list = g_object_steal_qdata (object, quark_string_list);
|
|
1262
|
+
*
|
|
1263
|
+
* // prepend new string
|
|
1264
|
+
* list = g_list_prepend (list, g_strdup (new_string));
|
|
1265
|
+
* // this changed 'list', so we need to set it again
|
|
1266
|
+
* g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
|
|
1267
|
+
* }
|
|
1268
|
+
* static void
|
|
1269
|
+
* free_string_list (gpointer data)
|
|
1270
|
+
* {
|
|
1271
|
+
* GList *node, *list = data;
|
|
1272
|
+
*
|
|
1273
|
+
* for (node = list; node; node = node->next)
|
|
1274
|
+
* g_free (node->data);
|
|
1275
|
+
* g_list_free (list);
|
|
1276
|
+
* }
|
|
1277
|
+
* ```
|
|
1278
|
+
*
|
|
1279
|
+
* Using g_object_get_qdata() in the above example, instead of
|
|
1280
|
+
* g_object_steal_qdata() would have left the destroy function set,
|
|
1281
|
+
* and thus the partial string list would have been freed upon
|
|
1282
|
+
* g_object_set_qdata_full().
|
|
1283
|
+
* @param quark A #GQuark, naming the user data pointer
|
|
1284
|
+
* @returns The user data pointer set, or %NULL
|
|
1285
|
+
*/
|
|
1286
|
+
steal_qdata(quark: GLib.Quark): any | null;
|
|
1287
|
+
/**
|
|
1288
|
+
* Reverts the effect of a previous call to
|
|
1289
|
+
* g_object_freeze_notify(). The freeze count is decreased on `object`
|
|
1290
|
+
* and when it reaches zero, queued "notify" signals are emitted.
|
|
1291
|
+
*
|
|
1292
|
+
* Duplicate notifications for each property are squashed so that at most one
|
|
1293
|
+
* #GObject::notify signal is emitted for each property, in the reverse order
|
|
1294
|
+
* in which they have been queued.
|
|
1295
|
+
*
|
|
1296
|
+
* It is an error to call this function when the freeze count is zero.
|
|
1297
|
+
*/
|
|
1298
|
+
thaw_notify(): void;
|
|
1299
|
+
/**
|
|
1300
|
+
* Decreases the reference count of `object`. When its reference count
|
|
1301
|
+
* drops to 0, the object is finalized (i.e. its memory is freed).
|
|
1302
|
+
*
|
|
1303
|
+
* If the pointer to the #GObject may be reused in future (for example, if it is
|
|
1304
|
+
* an instance variable of another object), it is recommended to clear the
|
|
1305
|
+
* pointer to %NULL rather than retain a dangling pointer to a potentially
|
|
1306
|
+
* invalid #GObject instance. Use g_clear_object() for this.
|
|
1307
|
+
*/
|
|
1308
|
+
unref(): void;
|
|
1309
|
+
/**
|
|
1310
|
+
* This function essentially limits the life time of the `closure` to
|
|
1311
|
+
* the life time of the object. That is, when the object is finalized,
|
|
1312
|
+
* the `closure` is invalidated by calling g_closure_invalidate() on
|
|
1313
|
+
* it, in order to prevent invocations of the closure with a finalized
|
|
1314
|
+
* (nonexisting) object. Also, g_object_ref() and g_object_unref() are
|
|
1315
|
+
* added as marshal guards to the `closure,` to ensure that an extra
|
|
1316
|
+
* reference count is held on `object` during invocation of the
|
|
1317
|
+
* `closure`. Usually, this function will be called on closures that
|
|
1318
|
+
* use this `object` as closure data.
|
|
1319
|
+
* @param closure #GClosure to watch
|
|
1320
|
+
*/
|
|
1321
|
+
watch_closure(closure: GObject.Closure): void;
|
|
1322
|
+
vfunc_constructed(): void;
|
|
1323
|
+
vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: GObject.ParamSpec): void;
|
|
1324
|
+
vfunc_dispose(): void;
|
|
1325
|
+
vfunc_finalize(): void;
|
|
1326
|
+
vfunc_get_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
|
|
1327
|
+
/**
|
|
1328
|
+
* Emits a "notify" signal for the property `property_name` on `object`.
|
|
1329
|
+
*
|
|
1330
|
+
* When possible, eg. when signaling a property change from within the class
|
|
1331
|
+
* that registered the property, you should use g_object_notify_by_pspec()
|
|
1332
|
+
* instead.
|
|
1333
|
+
*
|
|
1334
|
+
* Note that emission of the notify signal may be blocked with
|
|
1335
|
+
* g_object_freeze_notify(). In this case, the signal emissions are queued
|
|
1336
|
+
* and will be emitted (in reverse order) when g_object_thaw_notify() is
|
|
1337
|
+
* called.
|
|
1338
|
+
* @param pspec
|
|
1339
|
+
*/
|
|
1340
|
+
vfunc_notify(pspec: GObject.ParamSpec): void;
|
|
1341
|
+
vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
|
|
1342
|
+
disconnect(id: number): void;
|
|
1343
|
+
set(properties: { [key: string]: any }): void;
|
|
1344
|
+
block_signal_handler(id: number): any;
|
|
1345
|
+
unblock_signal_handler(id: number): any;
|
|
1346
|
+
stop_emission_by_name(detailedName: string): any;
|
|
1347
|
+
}
|
|
1348
|
+
|
|
1349
|
+
module ViewPresentation {
|
|
1350
|
+
// Signal callback interfaces
|
|
1351
|
+
|
|
1352
|
+
interface ChangePage {
|
|
1353
|
+
(object: Gtk.ScrollType): void;
|
|
1354
|
+
}
|
|
1355
|
+
|
|
1356
|
+
interface ExternalLink {
|
|
1357
|
+
(object: GObject.Object): void;
|
|
1358
|
+
}
|
|
1359
|
+
|
|
1360
|
+
interface Finished {
|
|
1361
|
+
(): void;
|
|
1362
|
+
}
|
|
1363
|
+
|
|
1364
|
+
// Constructor properties interface
|
|
1365
|
+
|
|
1366
|
+
interface ConstructorProps
|
|
1367
|
+
extends Gtk.Widget.ConstructorProps,
|
|
1368
|
+
Atk.ImplementorIface.ConstructorProps,
|
|
1369
|
+
Gtk.Buildable.ConstructorProps {
|
|
1370
|
+
current_page: number;
|
|
1371
|
+
currentPage: number;
|
|
1372
|
+
document: XreaderDocument.Document;
|
|
1373
|
+
inverted_colors: boolean;
|
|
1374
|
+
invertedColors: boolean;
|
|
1375
|
+
rotation: number;
|
|
1376
|
+
}
|
|
1377
|
+
}
|
|
1378
|
+
|
|
1379
|
+
class ViewPresentation extends Gtk.Widget implements Atk.ImplementorIface, Gtk.Buildable {
|
|
1380
|
+
static $gtype: GObject.GType<ViewPresentation>;
|
|
1381
|
+
|
|
1382
|
+
// Own properties of XreaderView.ViewPresentation
|
|
1383
|
+
|
|
1384
|
+
set current_page(val: number);
|
|
1385
|
+
set currentPage(val: number);
|
|
1386
|
+
set document(val: XreaderDocument.Document);
|
|
1387
|
+
set inverted_colors(val: boolean);
|
|
1388
|
+
set invertedColors(val: boolean);
|
|
1389
|
+
get rotation(): number;
|
|
1390
|
+
set rotation(val: number);
|
|
1391
|
+
|
|
1392
|
+
// Constructors of XreaderView.ViewPresentation
|
|
1393
|
+
|
|
1394
|
+
constructor(properties?: Partial<ViewPresentation.ConstructorProps>, ...args: any[]);
|
|
1395
|
+
|
|
1396
|
+
_init(...args: any[]): void;
|
|
1397
|
+
|
|
1398
|
+
static ['new'](
|
|
1399
|
+
document: XreaderDocument.Document,
|
|
1400
|
+
current_page: number,
|
|
1401
|
+
rotation: number,
|
|
1402
|
+
inverted_colors: boolean,
|
|
1403
|
+
): ViewPresentation;
|
|
1404
|
+
|
|
1405
|
+
// Own signals of XreaderView.ViewPresentation
|
|
1406
|
+
|
|
1407
|
+
connect(id: string, callback: (...args: any[]) => any): number;
|
|
1408
|
+
connect_after(id: string, callback: (...args: any[]) => any): number;
|
|
1409
|
+
emit(id: string, ...args: any[]): void;
|
|
1410
|
+
connect(signal: 'change-page', callback: (_source: this, object: Gtk.ScrollType) => void): number;
|
|
1411
|
+
connect_after(signal: 'change-page', callback: (_source: this, object: Gtk.ScrollType) => void): number;
|
|
1412
|
+
emit(signal: 'change-page', object: Gtk.ScrollType): void;
|
|
1413
|
+
connect(signal: 'external-link', callback: (_source: this, object: GObject.Object) => void): number;
|
|
1414
|
+
connect_after(signal: 'external-link', callback: (_source: this, object: GObject.Object) => void): number;
|
|
1415
|
+
emit(signal: 'external-link', object: GObject.Object): void;
|
|
1416
|
+
connect(signal: 'finished', callback: (_source: this) => void): number;
|
|
1417
|
+
connect_after(signal: 'finished', callback: (_source: this) => void): number;
|
|
1418
|
+
emit(signal: 'finished'): void;
|
|
1419
|
+
|
|
1420
|
+
// Own methods of XreaderView.ViewPresentation
|
|
1421
|
+
|
|
1422
|
+
get_current_page(): number;
|
|
1423
|
+
get_rotation(): number;
|
|
1424
|
+
next_page(): void;
|
|
1425
|
+
previous_page(): void;
|
|
1426
|
+
set_rotation(rotation: number): void;
|
|
1427
|
+
set_rtl(rtl: boolean): void;
|
|
1428
|
+
|
|
1429
|
+
// Inherited methods
|
|
1430
|
+
/**
|
|
1431
|
+
* Adds a child to `buildable`. `type` is an optional string
|
|
1432
|
+
* describing how the child should be added.
|
|
1433
|
+
* @param builder a #GtkBuilder
|
|
1434
|
+
* @param child child to add
|
|
1435
|
+
* @param type kind of child or %NULL
|
|
1436
|
+
*/
|
|
1437
|
+
add_child(builder: Gtk.Builder, child: GObject.Object, type?: string | null): void;
|
|
1438
|
+
/**
|
|
1439
|
+
* Constructs a child of `buildable` with the name `name`.
|
|
1440
|
+
*
|
|
1441
|
+
* #GtkBuilder calls this function if a “constructor” has been
|
|
1442
|
+
* specified in the UI definition.
|
|
1443
|
+
* @param builder #GtkBuilder used to construct this object
|
|
1444
|
+
* @param name name of child to construct
|
|
1445
|
+
* @returns the constructed child
|
|
1446
|
+
*/
|
|
1447
|
+
construct_child<T = GObject.Object>(builder: Gtk.Builder, name: string): T;
|
|
1448
|
+
/**
|
|
1449
|
+
* This is similar to gtk_buildable_parser_finished() but is
|
|
1450
|
+
* called once for each custom tag handled by the `buildable`.
|
|
1451
|
+
* @param builder a #GtkBuilder
|
|
1452
|
+
* @param child child object or %NULL for non-child tags
|
|
1453
|
+
* @param tagname the name of the tag
|
|
1454
|
+
* @param data user data created in custom_tag_start
|
|
1455
|
+
*/
|
|
1456
|
+
custom_finished(builder: Gtk.Builder, child: GObject.Object | null, tagname: string, data?: any | null): void;
|
|
1457
|
+
/**
|
|
1458
|
+
* This is called at the end of each custom element handled by
|
|
1459
|
+
* the buildable.
|
|
1460
|
+
* @param builder #GtkBuilder used to construct this object
|
|
1461
|
+
* @param child child object or %NULL for non-child tags
|
|
1462
|
+
* @param tagname name of tag
|
|
1463
|
+
* @param data user data that will be passed in to parser functions
|
|
1464
|
+
*/
|
|
1465
|
+
custom_tag_end(builder: Gtk.Builder, child: GObject.Object | null, tagname: string, data?: any | null): void;
|
|
1466
|
+
/**
|
|
1467
|
+
* This is called for each unknown element under `<child>`.
|
|
1468
|
+
* @param builder a #GtkBuilder used to construct this object
|
|
1469
|
+
* @param child child object or %NULL for non-child tags
|
|
1470
|
+
* @param tagname name of tag
|
|
1471
|
+
* @returns %TRUE if a object has a custom implementation, %FALSE if it doesn't.
|
|
1472
|
+
*/
|
|
1473
|
+
custom_tag_start(
|
|
1474
|
+
builder: Gtk.Builder,
|
|
1475
|
+
child: GObject.Object | null,
|
|
1476
|
+
tagname: string,
|
|
1477
|
+
): [boolean, GLib.MarkupParser, any];
|
|
1478
|
+
/**
|
|
1479
|
+
* Get the internal child called `childname` of the `buildable` object.
|
|
1480
|
+
* @param builder a #GtkBuilder
|
|
1481
|
+
* @param childname name of child
|
|
1482
|
+
* @returns the internal child of the buildable object
|
|
1483
|
+
*/
|
|
1484
|
+
get_internal_child<T = GObject.Object>(builder: Gtk.Builder, childname: string): T;
|
|
1485
|
+
/**
|
|
1486
|
+
* Gets the name of the `buildable` object.
|
|
1487
|
+
*
|
|
1488
|
+
* #GtkBuilder sets the name based on the
|
|
1489
|
+
* [GtkBuilder UI definition][BUILDER-UI]
|
|
1490
|
+
* used to construct the `buildable`.
|
|
1491
|
+
* @returns the name set with gtk_buildable_set_name()
|
|
1492
|
+
*/
|
|
1493
|
+
get_name(): string;
|
|
1494
|
+
/**
|
|
1495
|
+
* Called when the builder finishes the parsing of a
|
|
1496
|
+
* [GtkBuilder UI definition][BUILDER-UI].
|
|
1497
|
+
* Note that this will be called once for each time
|
|
1498
|
+
* gtk_builder_add_from_file() or gtk_builder_add_from_string()
|
|
1499
|
+
* is called on a builder.
|
|
1500
|
+
* @param builder a #GtkBuilder
|
|
1501
|
+
*/
|
|
1502
|
+
parser_finished(builder: Gtk.Builder): void;
|
|
1503
|
+
/**
|
|
1504
|
+
* Sets the property name `name` to `value` on the `buildable` object.
|
|
1505
|
+
* @param builder a #GtkBuilder
|
|
1506
|
+
* @param name name of property
|
|
1507
|
+
* @param value value of property
|
|
1508
|
+
*/
|
|
1509
|
+
set_buildable_property(builder: Gtk.Builder, name: string, value: GObject.Value | any): void;
|
|
1510
|
+
/**
|
|
1511
|
+
* Sets the name of the `buildable` object.
|
|
1512
|
+
* @param name name to set
|
|
1513
|
+
*/
|
|
1514
|
+
set_name(name: string): void;
|
|
1515
|
+
/**
|
|
1516
|
+
* Adds a child to `buildable`. `type` is an optional string
|
|
1517
|
+
* describing how the child should be added.
|
|
1518
|
+
* @param builder a #GtkBuilder
|
|
1519
|
+
* @param child child to add
|
|
1520
|
+
* @param type kind of child or %NULL
|
|
1521
|
+
*/
|
|
1522
|
+
vfunc_add_child(builder: Gtk.Builder, child: GObject.Object, type?: string | null): void;
|
|
1523
|
+
/**
|
|
1524
|
+
* Constructs a child of `buildable` with the name `name`.
|
|
1525
|
+
*
|
|
1526
|
+
* #GtkBuilder calls this function if a “constructor” has been
|
|
1527
|
+
* specified in the UI definition.
|
|
1528
|
+
* @param builder #GtkBuilder used to construct this object
|
|
1529
|
+
* @param name name of child to construct
|
|
1530
|
+
*/
|
|
1531
|
+
vfunc_construct_child<T = GObject.Object>(builder: Gtk.Builder, name: string): T;
|
|
1532
|
+
/**
|
|
1533
|
+
* This is similar to gtk_buildable_parser_finished() but is
|
|
1534
|
+
* called once for each custom tag handled by the `buildable`.
|
|
1535
|
+
* @param builder a #GtkBuilder
|
|
1536
|
+
* @param child child object or %NULL for non-child tags
|
|
1537
|
+
* @param tagname the name of the tag
|
|
1538
|
+
* @param data user data created in custom_tag_start
|
|
1539
|
+
*/
|
|
1540
|
+
vfunc_custom_finished(
|
|
1541
|
+
builder: Gtk.Builder,
|
|
1542
|
+
child: GObject.Object | null,
|
|
1543
|
+
tagname: string,
|
|
1544
|
+
data?: any | null,
|
|
1545
|
+
): void;
|
|
1546
|
+
/**
|
|
1547
|
+
* This is called at the end of each custom element handled by
|
|
1548
|
+
* the buildable.
|
|
1549
|
+
* @param builder #GtkBuilder used to construct this object
|
|
1550
|
+
* @param child child object or %NULL for non-child tags
|
|
1551
|
+
* @param tagname name of tag
|
|
1552
|
+
* @param data user data that will be passed in to parser functions
|
|
1553
|
+
*/
|
|
1554
|
+
vfunc_custom_tag_end(
|
|
1555
|
+
builder: Gtk.Builder,
|
|
1556
|
+
child: GObject.Object | null,
|
|
1557
|
+
tagname: string,
|
|
1558
|
+
data?: any | null,
|
|
1559
|
+
): void;
|
|
1560
|
+
/**
|
|
1561
|
+
* This is called for each unknown element under `<child>`.
|
|
1562
|
+
* @param builder a #GtkBuilder used to construct this object
|
|
1563
|
+
* @param child child object or %NULL for non-child tags
|
|
1564
|
+
* @param tagname name of tag
|
|
1565
|
+
*/
|
|
1566
|
+
vfunc_custom_tag_start(
|
|
1567
|
+
builder: Gtk.Builder,
|
|
1568
|
+
child: GObject.Object | null,
|
|
1569
|
+
tagname: string,
|
|
1570
|
+
): [boolean, GLib.MarkupParser, any];
|
|
1571
|
+
/**
|
|
1572
|
+
* Get the internal child called `childname` of the `buildable` object.
|
|
1573
|
+
* @param builder a #GtkBuilder
|
|
1574
|
+
* @param childname name of child
|
|
1575
|
+
*/
|
|
1576
|
+
vfunc_get_internal_child<T = GObject.Object>(builder: Gtk.Builder, childname: string): T;
|
|
1577
|
+
/**
|
|
1578
|
+
* Gets the name of the `buildable` object.
|
|
1579
|
+
*
|
|
1580
|
+
* #GtkBuilder sets the name based on the
|
|
1581
|
+
* [GtkBuilder UI definition][BUILDER-UI]
|
|
1582
|
+
* used to construct the `buildable`.
|
|
1583
|
+
*/
|
|
1584
|
+
vfunc_get_name(): string;
|
|
1585
|
+
/**
|
|
1586
|
+
* Called when the builder finishes the parsing of a
|
|
1587
|
+
* [GtkBuilder UI definition][BUILDER-UI].
|
|
1588
|
+
* Note that this will be called once for each time
|
|
1589
|
+
* gtk_builder_add_from_file() or gtk_builder_add_from_string()
|
|
1590
|
+
* is called on a builder.
|
|
1591
|
+
* @param builder a #GtkBuilder
|
|
1592
|
+
*/
|
|
1593
|
+
vfunc_parser_finished(builder: Gtk.Builder): void;
|
|
1594
|
+
/**
|
|
1595
|
+
* Sets the property name `name` to `value` on the `buildable` object.
|
|
1596
|
+
* @param builder a #GtkBuilder
|
|
1597
|
+
* @param name name of property
|
|
1598
|
+
* @param value value of property
|
|
1599
|
+
*/
|
|
1600
|
+
vfunc_set_buildable_property(builder: Gtk.Builder, name: string, value: GObject.Value | any): void;
|
|
1601
|
+
/**
|
|
1602
|
+
* Sets the name of the `buildable` object.
|
|
1603
|
+
* @param name name to set
|
|
1604
|
+
*/
|
|
1605
|
+
vfunc_set_name(name: string): void;
|
|
1606
|
+
/**
|
|
1607
|
+
* Creates a binding between `source_property` on `source` and `target_property`
|
|
1608
|
+
* on `target`.
|
|
1609
|
+
*
|
|
1610
|
+
* Whenever the `source_property` is changed the `target_property` is
|
|
1611
|
+
* updated using the same value. For instance:
|
|
1612
|
+
*
|
|
1613
|
+
*
|
|
1614
|
+
* ```c
|
|
1615
|
+
* g_object_bind_property (action, "active", widget, "sensitive", 0);
|
|
1616
|
+
* ```
|
|
1617
|
+
*
|
|
1618
|
+
*
|
|
1619
|
+
* Will result in the "sensitive" property of the widget #GObject instance to be
|
|
1620
|
+
* updated with the same value of the "active" property of the action #GObject
|
|
1621
|
+
* instance.
|
|
1622
|
+
*
|
|
1623
|
+
* If `flags` contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
|
|
1624
|
+
* if `target_property` on `target` changes then the `source_property` on `source`
|
|
1625
|
+
* will be updated as well.
|
|
1626
|
+
*
|
|
1627
|
+
* The binding will automatically be removed when either the `source` or the
|
|
1628
|
+
* `target` instances are finalized. To remove the binding without affecting the
|
|
1629
|
+
* `source` and the `target` you can just call g_object_unref() on the returned
|
|
1630
|
+
* #GBinding instance.
|
|
1631
|
+
*
|
|
1632
|
+
* Removing the binding by calling g_object_unref() on it must only be done if
|
|
1633
|
+
* the binding, `source` and `target` are only used from a single thread and it
|
|
1634
|
+
* is clear that both `source` and `target` outlive the binding. Especially it
|
|
1635
|
+
* is not safe to rely on this if the binding, `source` or `target` can be
|
|
1636
|
+
* finalized from different threads. Keep another reference to the binding and
|
|
1637
|
+
* use g_binding_unbind() instead to be on the safe side.
|
|
1638
|
+
*
|
|
1639
|
+
* A #GObject can have multiple bindings.
|
|
1640
|
+
* @param source_property the property on @source to bind
|
|
1641
|
+
* @param target the target #GObject
|
|
1642
|
+
* @param target_property the property on @target to bind
|
|
1643
|
+
* @param flags flags to pass to #GBinding
|
|
1644
|
+
* @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
|
|
1645
|
+
*/
|
|
1646
|
+
bind_property(
|
|
1647
|
+
source_property: string,
|
|
1648
|
+
target: GObject.Object,
|
|
1649
|
+
target_property: string,
|
|
1650
|
+
flags: GObject.BindingFlags,
|
|
1651
|
+
): GObject.Binding;
|
|
1652
|
+
/**
|
|
1653
|
+
* Complete version of g_object_bind_property().
|
|
1654
|
+
*
|
|
1655
|
+
* Creates a binding between `source_property` on `source` and `target_property`
|
|
1656
|
+
* on `target,` allowing you to set the transformation functions to be used by
|
|
1657
|
+
* the binding.
|
|
1658
|
+
*
|
|
1659
|
+
* If `flags` contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
|
|
1660
|
+
* if `target_property` on `target` changes then the `source_property` on `source`
|
|
1661
|
+
* will be updated as well. The `transform_from` function is only used in case
|
|
1662
|
+
* of bidirectional bindings, otherwise it will be ignored
|
|
1663
|
+
*
|
|
1664
|
+
* The binding will automatically be removed when either the `source` or the
|
|
1665
|
+
* `target` instances are finalized. This will release the reference that is
|
|
1666
|
+
* being held on the #GBinding instance; if you want to hold on to the
|
|
1667
|
+
* #GBinding instance, you will need to hold a reference to it.
|
|
1668
|
+
*
|
|
1669
|
+
* To remove the binding, call g_binding_unbind().
|
|
1670
|
+
*
|
|
1671
|
+
* A #GObject can have multiple bindings.
|
|
1672
|
+
*
|
|
1673
|
+
* The same `user_data` parameter will be used for both `transform_to`
|
|
1674
|
+
* and `transform_from` transformation functions; the `notify` function will
|
|
1675
|
+
* be called once, when the binding is removed. If you need different data
|
|
1676
|
+
* for each transformation function, please use
|
|
1677
|
+
* g_object_bind_property_with_closures() instead.
|
|
1678
|
+
* @param source_property the property on @source to bind
|
|
1679
|
+
* @param target the target #GObject
|
|
1680
|
+
* @param target_property the property on @target to bind
|
|
1681
|
+
* @param flags flags to pass to #GBinding
|
|
1682
|
+
* @param transform_to the transformation function from the @source to the @target, or %NULL to use the default
|
|
1683
|
+
* @param transform_from the transformation function from the @target to the @source, or %NULL to use the default
|
|
1684
|
+
* @param notify a function to call when disposing the binding, to free resources used by the transformation functions, or %NULL if not required
|
|
1685
|
+
* @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
|
|
1686
|
+
*/
|
|
1687
|
+
bind_property_full(
|
|
1688
|
+
source_property: string,
|
|
1689
|
+
target: GObject.Object,
|
|
1690
|
+
target_property: string,
|
|
1691
|
+
flags: GObject.BindingFlags,
|
|
1692
|
+
transform_to?: GObject.BindingTransformFunc | null,
|
|
1693
|
+
transform_from?: GObject.BindingTransformFunc | null,
|
|
1694
|
+
notify?: GLib.DestroyNotify | null,
|
|
1695
|
+
): GObject.Binding;
|
|
1696
|
+
// Conflicted with GObject.Object.bind_property_full
|
|
1697
|
+
bind_property_full(...args: never[]): any;
|
|
1698
|
+
/**
|
|
1699
|
+
* This function is intended for #GObject implementations to re-enforce
|
|
1700
|
+
* a [floating][floating-ref] object reference. Doing this is seldom
|
|
1701
|
+
* required: all #GInitiallyUnowneds are created with a floating reference
|
|
1702
|
+
* which usually just needs to be sunken by calling g_object_ref_sink().
|
|
1703
|
+
*/
|
|
1704
|
+
force_floating(): void;
|
|
1705
|
+
/**
|
|
1706
|
+
* Increases the freeze count on `object`. If the freeze count is
|
|
1707
|
+
* non-zero, the emission of "notify" signals on `object` is
|
|
1708
|
+
* stopped. The signals are queued until the freeze count is decreased
|
|
1709
|
+
* to zero. Duplicate notifications are squashed so that at most one
|
|
1710
|
+
* #GObject::notify signal is emitted for each property modified while the
|
|
1711
|
+
* object is frozen.
|
|
1712
|
+
*
|
|
1713
|
+
* This is necessary for accessors that modify multiple properties to prevent
|
|
1714
|
+
* premature notification while the object is still being modified.
|
|
1715
|
+
*/
|
|
1716
|
+
freeze_notify(): void;
|
|
1717
|
+
/**
|
|
1718
|
+
* Gets a named field from the objects table of associations (see g_object_set_data()).
|
|
1719
|
+
* @param key name of the key for that association
|
|
1720
|
+
* @returns the data if found, or %NULL if no such data exists.
|
|
1721
|
+
*/
|
|
1722
|
+
get_data(key: string): any | null;
|
|
1723
|
+
get_property(property_name: string): any;
|
|
1724
|
+
/**
|
|
1725
|
+
* This function gets back user data pointers stored via
|
|
1726
|
+
* g_object_set_qdata().
|
|
1727
|
+
* @param quark A #GQuark, naming the user data pointer
|
|
1728
|
+
* @returns The user data pointer set, or %NULL
|
|
1729
|
+
*/
|
|
1730
|
+
get_qdata(quark: GLib.Quark): any | null;
|
|
1731
|
+
/**
|
|
1732
|
+
* Gets `n_properties` properties for an `object`.
|
|
1733
|
+
* Obtained properties will be set to `values`. All properties must be valid.
|
|
1734
|
+
* Warnings will be emitted and undefined behaviour may result if invalid
|
|
1735
|
+
* properties are passed in.
|
|
1736
|
+
* @param names the names of each property to get
|
|
1737
|
+
* @param values the values of each property to get
|
|
1738
|
+
*/
|
|
1739
|
+
getv(names: string[], values: (GObject.Value | any)[]): void;
|
|
1740
|
+
/**
|
|
1741
|
+
* Checks whether `object` has a [floating][floating-ref] reference.
|
|
1742
|
+
* @returns %TRUE if @object has a floating reference
|
|
1743
|
+
*/
|
|
1744
|
+
is_floating(): boolean;
|
|
1745
|
+
/**
|
|
1746
|
+
* Emits a "notify" signal for the property `property_name` on `object`.
|
|
1747
|
+
*
|
|
1748
|
+
* When possible, eg. when signaling a property change from within the class
|
|
1749
|
+
* that registered the property, you should use g_object_notify_by_pspec()
|
|
1750
|
+
* instead.
|
|
1751
|
+
*
|
|
1752
|
+
* Note that emission of the notify signal may be blocked with
|
|
1753
|
+
* g_object_freeze_notify(). In this case, the signal emissions are queued
|
|
1754
|
+
* and will be emitted (in reverse order) when g_object_thaw_notify() is
|
|
1755
|
+
* called.
|
|
1756
|
+
* @param property_name the name of a property installed on the class of @object.
|
|
1757
|
+
*/
|
|
1758
|
+
notify(property_name: string): void;
|
|
1759
|
+
/**
|
|
1760
|
+
* Emits a "notify" signal for the property specified by `pspec` on `object`.
|
|
1761
|
+
*
|
|
1762
|
+
* This function omits the property name lookup, hence it is faster than
|
|
1763
|
+
* g_object_notify().
|
|
1764
|
+
*
|
|
1765
|
+
* One way to avoid using g_object_notify() from within the
|
|
1766
|
+
* class that registered the properties, and using g_object_notify_by_pspec()
|
|
1767
|
+
* instead, is to store the GParamSpec used with
|
|
1768
|
+
* g_object_class_install_property() inside a static array, e.g.:
|
|
1769
|
+
*
|
|
1770
|
+
*
|
|
1771
|
+
* ```c
|
|
1772
|
+
* typedef enum
|
|
1773
|
+
* {
|
|
1774
|
+
* PROP_FOO = 1,
|
|
1775
|
+
* PROP_LAST
|
|
1776
|
+
* } MyObjectProperty;
|
|
1777
|
+
*
|
|
1778
|
+
* static GParamSpec *properties[PROP_LAST];
|
|
1779
|
+
*
|
|
1780
|
+
* static void
|
|
1781
|
+
* my_object_class_init (MyObjectClass *klass)
|
|
1782
|
+
* {
|
|
1783
|
+
* properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
|
|
1784
|
+
* 0, 100,
|
|
1785
|
+
* 50,
|
|
1786
|
+
* G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
|
|
1787
|
+
* g_object_class_install_property (gobject_class,
|
|
1788
|
+
* PROP_FOO,
|
|
1789
|
+
* properties[PROP_FOO]);
|
|
1790
|
+
* }
|
|
1791
|
+
* ```
|
|
1792
|
+
*
|
|
1793
|
+
*
|
|
1794
|
+
* and then notify a change on the "foo" property with:
|
|
1795
|
+
*
|
|
1796
|
+
*
|
|
1797
|
+
* ```c
|
|
1798
|
+
* g_object_notify_by_pspec (self, properties[PROP_FOO]);
|
|
1799
|
+
* ```
|
|
1800
|
+
*
|
|
1801
|
+
* @param pspec the #GParamSpec of a property installed on the class of @object.
|
|
1802
|
+
*/
|
|
1803
|
+
notify_by_pspec(pspec: GObject.ParamSpec): void;
|
|
1804
|
+
/**
|
|
1805
|
+
* Increases the reference count of `object`.
|
|
1806
|
+
*
|
|
1807
|
+
* Since GLib 2.56, if `GLIB_VERSION_MAX_ALLOWED` is 2.56 or greater, the type
|
|
1808
|
+
* of `object` will be propagated to the return type (using the GCC typeof()
|
|
1809
|
+
* extension), so any casting the caller needs to do on the return type must be
|
|
1810
|
+
* explicit.
|
|
1811
|
+
* @returns the same @object
|
|
1812
|
+
*/
|
|
1813
|
+
ref(): GObject.Object;
|
|
1814
|
+
/**
|
|
1815
|
+
* Increase the reference count of `object,` and possibly remove the
|
|
1816
|
+
* [floating][floating-ref] reference, if `object` has a floating reference.
|
|
1817
|
+
*
|
|
1818
|
+
* In other words, if the object is floating, then this call "assumes
|
|
1819
|
+
* ownership" of the floating reference, converting it to a normal
|
|
1820
|
+
* reference by clearing the floating flag while leaving the reference
|
|
1821
|
+
* count unchanged. If the object is not floating, then this call
|
|
1822
|
+
* adds a new normal reference increasing the reference count by one.
|
|
1823
|
+
*
|
|
1824
|
+
* Since GLib 2.56, the type of `object` will be propagated to the return type
|
|
1825
|
+
* under the same conditions as for g_object_ref().
|
|
1826
|
+
* @returns @object
|
|
1827
|
+
*/
|
|
1828
|
+
ref_sink(): GObject.Object;
|
|
1829
|
+
/**
|
|
1830
|
+
* Releases all references to other objects. This can be used to break
|
|
1831
|
+
* reference cycles.
|
|
1832
|
+
*
|
|
1833
|
+
* This function should only be called from object system implementations.
|
|
1834
|
+
*/
|
|
1835
|
+
run_dispose(): void;
|
|
1836
|
+
/**
|
|
1837
|
+
* Each object carries around a table of associations from
|
|
1838
|
+
* strings to pointers. This function lets you set an association.
|
|
1839
|
+
*
|
|
1840
|
+
* If the object already had an association with that name,
|
|
1841
|
+
* the old association will be destroyed.
|
|
1842
|
+
*
|
|
1843
|
+
* Internally, the `key` is converted to a #GQuark using g_quark_from_string().
|
|
1844
|
+
* This means a copy of `key` is kept permanently (even after `object` has been
|
|
1845
|
+
* finalized) — so it is recommended to only use a small, bounded set of values
|
|
1846
|
+
* for `key` in your program, to avoid the #GQuark storage growing unbounded.
|
|
1847
|
+
* @param key name of the key
|
|
1848
|
+
* @param data data to associate with that key
|
|
1849
|
+
*/
|
|
1850
|
+
set_data(key: string, data?: any | null): void;
|
|
1851
|
+
set_property(property_name: string, value: any): void;
|
|
1852
|
+
/**
|
|
1853
|
+
* Remove a specified datum from the object's data associations,
|
|
1854
|
+
* without invoking the association's destroy handler.
|
|
1855
|
+
* @param key name of the key
|
|
1856
|
+
* @returns the data if found, or %NULL if no such data exists.
|
|
1857
|
+
*/
|
|
1858
|
+
steal_data(key: string): any | null;
|
|
1859
|
+
/**
|
|
1860
|
+
* This function gets back user data pointers stored via
|
|
1861
|
+
* g_object_set_qdata() and removes the `data` from object
|
|
1862
|
+
* without invoking its destroy() function (if any was
|
|
1863
|
+
* set).
|
|
1864
|
+
* Usually, calling this function is only required to update
|
|
1865
|
+
* user data pointers with a destroy notifier, for example:
|
|
1866
|
+
*
|
|
1867
|
+
* ```c
|
|
1868
|
+
* void
|
|
1869
|
+
* object_add_to_user_list (GObject *object,
|
|
1870
|
+
* const gchar *new_string)
|
|
1871
|
+
* {
|
|
1872
|
+
* // the quark, naming the object data
|
|
1873
|
+
* GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
|
|
1874
|
+
* // retrieve the old string list
|
|
1875
|
+
* GList *list = g_object_steal_qdata (object, quark_string_list);
|
|
1876
|
+
*
|
|
1877
|
+
* // prepend new string
|
|
1878
|
+
* list = g_list_prepend (list, g_strdup (new_string));
|
|
1879
|
+
* // this changed 'list', so we need to set it again
|
|
1880
|
+
* g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
|
|
1881
|
+
* }
|
|
1882
|
+
* static void
|
|
1883
|
+
* free_string_list (gpointer data)
|
|
1884
|
+
* {
|
|
1885
|
+
* GList *node, *list = data;
|
|
1886
|
+
*
|
|
1887
|
+
* for (node = list; node; node = node->next)
|
|
1888
|
+
* g_free (node->data);
|
|
1889
|
+
* g_list_free (list);
|
|
1890
|
+
* }
|
|
1891
|
+
* ```
|
|
1892
|
+
*
|
|
1893
|
+
* Using g_object_get_qdata() in the above example, instead of
|
|
1894
|
+
* g_object_steal_qdata() would have left the destroy function set,
|
|
1895
|
+
* and thus the partial string list would have been freed upon
|
|
1896
|
+
* g_object_set_qdata_full().
|
|
1897
|
+
* @param quark A #GQuark, naming the user data pointer
|
|
1898
|
+
* @returns The user data pointer set, or %NULL
|
|
1899
|
+
*/
|
|
1900
|
+
steal_qdata(quark: GLib.Quark): any | null;
|
|
1901
|
+
/**
|
|
1902
|
+
* Reverts the effect of a previous call to
|
|
1903
|
+
* g_object_freeze_notify(). The freeze count is decreased on `object`
|
|
1904
|
+
* and when it reaches zero, queued "notify" signals are emitted.
|
|
1905
|
+
*
|
|
1906
|
+
* Duplicate notifications for each property are squashed so that at most one
|
|
1907
|
+
* #GObject::notify signal is emitted for each property, in the reverse order
|
|
1908
|
+
* in which they have been queued.
|
|
1909
|
+
*
|
|
1910
|
+
* It is an error to call this function when the freeze count is zero.
|
|
1911
|
+
*/
|
|
1912
|
+
thaw_notify(): void;
|
|
1913
|
+
/**
|
|
1914
|
+
* Decreases the reference count of `object`. When its reference count
|
|
1915
|
+
* drops to 0, the object is finalized (i.e. its memory is freed).
|
|
1916
|
+
*
|
|
1917
|
+
* If the pointer to the #GObject may be reused in future (for example, if it is
|
|
1918
|
+
* an instance variable of another object), it is recommended to clear the
|
|
1919
|
+
* pointer to %NULL rather than retain a dangling pointer to a potentially
|
|
1920
|
+
* invalid #GObject instance. Use g_clear_object() for this.
|
|
1921
|
+
*/
|
|
1922
|
+
unref(): void;
|
|
1923
|
+
/**
|
|
1924
|
+
* This function essentially limits the life time of the `closure` to
|
|
1925
|
+
* the life time of the object. That is, when the object is finalized,
|
|
1926
|
+
* the `closure` is invalidated by calling g_closure_invalidate() on
|
|
1927
|
+
* it, in order to prevent invocations of the closure with a finalized
|
|
1928
|
+
* (nonexisting) object. Also, g_object_ref() and g_object_unref() are
|
|
1929
|
+
* added as marshal guards to the `closure,` to ensure that an extra
|
|
1930
|
+
* reference count is held on `object` during invocation of the
|
|
1931
|
+
* `closure`. Usually, this function will be called on closures that
|
|
1932
|
+
* use this `object` as closure data.
|
|
1933
|
+
* @param closure #GClosure to watch
|
|
1934
|
+
*/
|
|
1935
|
+
watch_closure(closure: GObject.Closure): void;
|
|
1936
|
+
vfunc_constructed(): void;
|
|
1937
|
+
vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: GObject.ParamSpec): void;
|
|
1938
|
+
vfunc_dispose(): void;
|
|
1939
|
+
vfunc_finalize(): void;
|
|
1940
|
+
vfunc_get_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
|
|
1941
|
+
/**
|
|
1942
|
+
* Emits a "notify" signal for the property `property_name` on `object`.
|
|
1943
|
+
*
|
|
1944
|
+
* When possible, eg. when signaling a property change from within the class
|
|
1945
|
+
* that registered the property, you should use g_object_notify_by_pspec()
|
|
1946
|
+
* instead.
|
|
1947
|
+
*
|
|
1948
|
+
* Note that emission of the notify signal may be blocked with
|
|
1949
|
+
* g_object_freeze_notify(). In this case, the signal emissions are queued
|
|
1950
|
+
* and will be emitted (in reverse order) when g_object_thaw_notify() is
|
|
1951
|
+
* called.
|
|
1952
|
+
* @param pspec
|
|
1953
|
+
*/
|
|
1954
|
+
vfunc_notify(pspec: GObject.ParamSpec): void;
|
|
1955
|
+
vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
|
|
1956
|
+
disconnect(id: number): void;
|
|
1957
|
+
set(properties: { [key: string]: any }): void;
|
|
1958
|
+
block_signal_handler(id: number): any;
|
|
1959
|
+
unblock_signal_handler(id: number): any;
|
|
1960
|
+
stop_emission_by_name(detailedName: string): any;
|
|
1961
|
+
}
|
|
1962
|
+
|
|
1963
|
+
module WebView {
|
|
1964
|
+
// Constructor properties interface
|
|
1965
|
+
|
|
1966
|
+
interface ConstructorProps
|
|
1967
|
+
extends Gtk.Container.ConstructorProps,
|
|
1968
|
+
Atk.ImplementorIface.ConstructorProps,
|
|
1969
|
+
Gtk.Buildable.ConstructorProps {}
|
|
1970
|
+
}
|
|
1971
|
+
|
|
1972
|
+
class WebView extends Gtk.Container implements Atk.ImplementorIface, Gtk.Buildable {
|
|
1973
|
+
static $gtype: GObject.GType<WebView>;
|
|
1974
|
+
|
|
1975
|
+
// Constructors of XreaderView.WebView
|
|
1976
|
+
|
|
1977
|
+
constructor(properties?: Partial<WebView.ConstructorProps>, ...args: any[]);
|
|
1978
|
+
|
|
1979
|
+
_init(...args: any[]): void;
|
|
1980
|
+
|
|
1981
|
+
static ['new'](): WebView;
|
|
1982
|
+
|
|
1983
|
+
// Own methods of XreaderView.WebView
|
|
1984
|
+
|
|
1985
|
+
copy(): void;
|
|
1986
|
+
/**
|
|
1987
|
+
* This function call will disconnect all model signal handlers from the webview, to ensure smooth operation of the Xreader-view.
|
|
1988
|
+
* Equivalent to function ev_view_disconnect_handlers in ev-view.c
|
|
1989
|
+
*/
|
|
1990
|
+
disconnect_handlers(): void;
|
|
1991
|
+
find_cancel(): void;
|
|
1992
|
+
find_changed(results: number, text: string, case_sensitive: boolean): void;
|
|
1993
|
+
find_next(): void;
|
|
1994
|
+
find_previous(): void;
|
|
1995
|
+
find_search_changed(): void;
|
|
1996
|
+
find_set_highlight_search(visible: boolean): void;
|
|
1997
|
+
get_has_selection(): boolean;
|
|
1998
|
+
handle_link(link: XreaderDocument.Link): void;
|
|
1999
|
+
next_page(): boolean;
|
|
2000
|
+
previous_page(): boolean;
|
|
2001
|
+
reload(): void;
|
|
2002
|
+
reload_page(page: number): void;
|
|
2003
|
+
select_all(): void;
|
|
2004
|
+
set_handler(visible: boolean): void;
|
|
2005
|
+
set_model(model: DocumentModel): void;
|
|
2006
|
+
zoom_in(): boolean;
|
|
2007
|
+
zoom_out(): boolean;
|
|
2008
|
+
zoom_reset(): boolean;
|
|
2009
|
+
|
|
2010
|
+
// Inherited methods
|
|
2011
|
+
/**
|
|
2012
|
+
* Creates a binding between `source_property` on `source` and `target_property`
|
|
2013
|
+
* on `target`.
|
|
2014
|
+
*
|
|
2015
|
+
* Whenever the `source_property` is changed the `target_property` is
|
|
2016
|
+
* updated using the same value. For instance:
|
|
2017
|
+
*
|
|
2018
|
+
*
|
|
2019
|
+
* ```c
|
|
2020
|
+
* g_object_bind_property (action, "active", widget, "sensitive", 0);
|
|
2021
|
+
* ```
|
|
2022
|
+
*
|
|
2023
|
+
*
|
|
2024
|
+
* Will result in the "sensitive" property of the widget #GObject instance to be
|
|
2025
|
+
* updated with the same value of the "active" property of the action #GObject
|
|
2026
|
+
* instance.
|
|
2027
|
+
*
|
|
2028
|
+
* If `flags` contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
|
|
2029
|
+
* if `target_property` on `target` changes then the `source_property` on `source`
|
|
2030
|
+
* will be updated as well.
|
|
2031
|
+
*
|
|
2032
|
+
* The binding will automatically be removed when either the `source` or the
|
|
2033
|
+
* `target` instances are finalized. To remove the binding without affecting the
|
|
2034
|
+
* `source` and the `target` you can just call g_object_unref() on the returned
|
|
2035
|
+
* #GBinding instance.
|
|
2036
|
+
*
|
|
2037
|
+
* Removing the binding by calling g_object_unref() on it must only be done if
|
|
2038
|
+
* the binding, `source` and `target` are only used from a single thread and it
|
|
2039
|
+
* is clear that both `source` and `target` outlive the binding. Especially it
|
|
2040
|
+
* is not safe to rely on this if the binding, `source` or `target` can be
|
|
2041
|
+
* finalized from different threads. Keep another reference to the binding and
|
|
2042
|
+
* use g_binding_unbind() instead to be on the safe side.
|
|
2043
|
+
*
|
|
2044
|
+
* A #GObject can have multiple bindings.
|
|
2045
|
+
* @param source_property the property on @source to bind
|
|
2046
|
+
* @param target the target #GObject
|
|
2047
|
+
* @param target_property the property on @target to bind
|
|
2048
|
+
* @param flags flags to pass to #GBinding
|
|
2049
|
+
* @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
|
|
2050
|
+
*/
|
|
2051
|
+
bind_property(
|
|
2052
|
+
source_property: string,
|
|
2053
|
+
target: GObject.Object,
|
|
2054
|
+
target_property: string,
|
|
2055
|
+
flags: GObject.BindingFlags,
|
|
2056
|
+
): GObject.Binding;
|
|
2057
|
+
/**
|
|
2058
|
+
* Complete version of g_object_bind_property().
|
|
2059
|
+
*
|
|
2060
|
+
* Creates a binding between `source_property` on `source` and `target_property`
|
|
2061
|
+
* on `target,` allowing you to set the transformation functions to be used by
|
|
2062
|
+
* the binding.
|
|
2063
|
+
*
|
|
2064
|
+
* If `flags` contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual:
|
|
2065
|
+
* if `target_property` on `target` changes then the `source_property` on `source`
|
|
2066
|
+
* will be updated as well. The `transform_from` function is only used in case
|
|
2067
|
+
* of bidirectional bindings, otherwise it will be ignored
|
|
2068
|
+
*
|
|
2069
|
+
* The binding will automatically be removed when either the `source` or the
|
|
2070
|
+
* `target` instances are finalized. This will release the reference that is
|
|
2071
|
+
* being held on the #GBinding instance; if you want to hold on to the
|
|
2072
|
+
* #GBinding instance, you will need to hold a reference to it.
|
|
2073
|
+
*
|
|
2074
|
+
* To remove the binding, call g_binding_unbind().
|
|
2075
|
+
*
|
|
2076
|
+
* A #GObject can have multiple bindings.
|
|
2077
|
+
*
|
|
2078
|
+
* The same `user_data` parameter will be used for both `transform_to`
|
|
2079
|
+
* and `transform_from` transformation functions; the `notify` function will
|
|
2080
|
+
* be called once, when the binding is removed. If you need different data
|
|
2081
|
+
* for each transformation function, please use
|
|
2082
|
+
* g_object_bind_property_with_closures() instead.
|
|
2083
|
+
* @param source_property the property on @source to bind
|
|
2084
|
+
* @param target the target #GObject
|
|
2085
|
+
* @param target_property the property on @target to bind
|
|
2086
|
+
* @param flags flags to pass to #GBinding
|
|
2087
|
+
* @param transform_to the transformation function from the @source to the @target, or %NULL to use the default
|
|
2088
|
+
* @param transform_from the transformation function from the @target to the @source, or %NULL to use the default
|
|
2089
|
+
* @param notify a function to call when disposing the binding, to free resources used by the transformation functions, or %NULL if not required
|
|
2090
|
+
* @returns the #GBinding instance representing the binding between the two #GObject instances. The binding is released whenever the #GBinding reference count reaches zero.
|
|
2091
|
+
*/
|
|
2092
|
+
bind_property_full(
|
|
2093
|
+
source_property: string,
|
|
2094
|
+
target: GObject.Object,
|
|
2095
|
+
target_property: string,
|
|
2096
|
+
flags: GObject.BindingFlags,
|
|
2097
|
+
transform_to?: GObject.BindingTransformFunc | null,
|
|
2098
|
+
transform_from?: GObject.BindingTransformFunc | null,
|
|
2099
|
+
notify?: GLib.DestroyNotify | null,
|
|
2100
|
+
): GObject.Binding;
|
|
2101
|
+
// Conflicted with GObject.Object.bind_property_full
|
|
2102
|
+
bind_property_full(...args: never[]): any;
|
|
2103
|
+
/**
|
|
2104
|
+
* This function is intended for #GObject implementations to re-enforce
|
|
2105
|
+
* a [floating][floating-ref] object reference. Doing this is seldom
|
|
2106
|
+
* required: all #GInitiallyUnowneds are created with a floating reference
|
|
2107
|
+
* which usually just needs to be sunken by calling g_object_ref_sink().
|
|
2108
|
+
*/
|
|
2109
|
+
force_floating(): void;
|
|
2110
|
+
/**
|
|
2111
|
+
* Increases the freeze count on `object`. If the freeze count is
|
|
2112
|
+
* non-zero, the emission of "notify" signals on `object` is
|
|
2113
|
+
* stopped. The signals are queued until the freeze count is decreased
|
|
2114
|
+
* to zero. Duplicate notifications are squashed so that at most one
|
|
2115
|
+
* #GObject::notify signal is emitted for each property modified while the
|
|
2116
|
+
* object is frozen.
|
|
2117
|
+
*
|
|
2118
|
+
* This is necessary for accessors that modify multiple properties to prevent
|
|
2119
|
+
* premature notification while the object is still being modified.
|
|
2120
|
+
*/
|
|
2121
|
+
freeze_notify(): void;
|
|
2122
|
+
/**
|
|
2123
|
+
* Gets a named field from the objects table of associations (see g_object_set_data()).
|
|
2124
|
+
* @param key name of the key for that association
|
|
2125
|
+
* @returns the data if found, or %NULL if no such data exists.
|
|
2126
|
+
*/
|
|
2127
|
+
get_data(key: string): any | null;
|
|
2128
|
+
get_property(property_name: string): any;
|
|
2129
|
+
/**
|
|
2130
|
+
* This function gets back user data pointers stored via
|
|
2131
|
+
* g_object_set_qdata().
|
|
2132
|
+
* @param quark A #GQuark, naming the user data pointer
|
|
2133
|
+
* @returns The user data pointer set, or %NULL
|
|
2134
|
+
*/
|
|
2135
|
+
get_qdata(quark: GLib.Quark): any | null;
|
|
2136
|
+
/**
|
|
2137
|
+
* Gets `n_properties` properties for an `object`.
|
|
2138
|
+
* Obtained properties will be set to `values`. All properties must be valid.
|
|
2139
|
+
* Warnings will be emitted and undefined behaviour may result if invalid
|
|
2140
|
+
* properties are passed in.
|
|
2141
|
+
* @param names the names of each property to get
|
|
2142
|
+
* @param values the values of each property to get
|
|
2143
|
+
*/
|
|
2144
|
+
getv(names: string[], values: (GObject.Value | any)[]): void;
|
|
2145
|
+
/**
|
|
2146
|
+
* Checks whether `object` has a [floating][floating-ref] reference.
|
|
2147
|
+
* @returns %TRUE if @object has a floating reference
|
|
2148
|
+
*/
|
|
2149
|
+
is_floating(): boolean;
|
|
2150
|
+
/**
|
|
2151
|
+
* Emits a "notify" signal for the property `property_name` on `object`.
|
|
2152
|
+
*
|
|
2153
|
+
* When possible, eg. when signaling a property change from within the class
|
|
2154
|
+
* that registered the property, you should use g_object_notify_by_pspec()
|
|
2155
|
+
* instead.
|
|
2156
|
+
*
|
|
2157
|
+
* Note that emission of the notify signal may be blocked with
|
|
2158
|
+
* g_object_freeze_notify(). In this case, the signal emissions are queued
|
|
2159
|
+
* and will be emitted (in reverse order) when g_object_thaw_notify() is
|
|
2160
|
+
* called.
|
|
2161
|
+
* @param property_name the name of a property installed on the class of @object.
|
|
2162
|
+
*/
|
|
2163
|
+
notify(property_name: string): void;
|
|
2164
|
+
/**
|
|
2165
|
+
* Emits a "notify" signal for the property specified by `pspec` on `object`.
|
|
2166
|
+
*
|
|
2167
|
+
* This function omits the property name lookup, hence it is faster than
|
|
2168
|
+
* g_object_notify().
|
|
2169
|
+
*
|
|
2170
|
+
* One way to avoid using g_object_notify() from within the
|
|
2171
|
+
* class that registered the properties, and using g_object_notify_by_pspec()
|
|
2172
|
+
* instead, is to store the GParamSpec used with
|
|
2173
|
+
* g_object_class_install_property() inside a static array, e.g.:
|
|
2174
|
+
*
|
|
2175
|
+
*
|
|
2176
|
+
* ```c
|
|
2177
|
+
* typedef enum
|
|
2178
|
+
* {
|
|
2179
|
+
* PROP_FOO = 1,
|
|
2180
|
+
* PROP_LAST
|
|
2181
|
+
* } MyObjectProperty;
|
|
2182
|
+
*
|
|
2183
|
+
* static GParamSpec *properties[PROP_LAST];
|
|
2184
|
+
*
|
|
2185
|
+
* static void
|
|
2186
|
+
* my_object_class_init (MyObjectClass *klass)
|
|
2187
|
+
* {
|
|
2188
|
+
* properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
|
|
2189
|
+
* 0, 100,
|
|
2190
|
+
* 50,
|
|
2191
|
+
* G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
|
|
2192
|
+
* g_object_class_install_property (gobject_class,
|
|
2193
|
+
* PROP_FOO,
|
|
2194
|
+
* properties[PROP_FOO]);
|
|
2195
|
+
* }
|
|
2196
|
+
* ```
|
|
2197
|
+
*
|
|
2198
|
+
*
|
|
2199
|
+
* and then notify a change on the "foo" property with:
|
|
2200
|
+
*
|
|
2201
|
+
*
|
|
2202
|
+
* ```c
|
|
2203
|
+
* g_object_notify_by_pspec (self, properties[PROP_FOO]);
|
|
2204
|
+
* ```
|
|
2205
|
+
*
|
|
2206
|
+
* @param pspec the #GParamSpec of a property installed on the class of @object.
|
|
2207
|
+
*/
|
|
2208
|
+
notify_by_pspec(pspec: GObject.ParamSpec): void;
|
|
2209
|
+
/**
|
|
2210
|
+
* Increases the reference count of `object`.
|
|
2211
|
+
*
|
|
2212
|
+
* Since GLib 2.56, if `GLIB_VERSION_MAX_ALLOWED` is 2.56 or greater, the type
|
|
2213
|
+
* of `object` will be propagated to the return type (using the GCC typeof()
|
|
2214
|
+
* extension), so any casting the caller needs to do on the return type must be
|
|
2215
|
+
* explicit.
|
|
2216
|
+
* @returns the same @object
|
|
2217
|
+
*/
|
|
2218
|
+
ref(): GObject.Object;
|
|
2219
|
+
/**
|
|
2220
|
+
* Increase the reference count of `object,` and possibly remove the
|
|
2221
|
+
* [floating][floating-ref] reference, if `object` has a floating reference.
|
|
2222
|
+
*
|
|
2223
|
+
* In other words, if the object is floating, then this call "assumes
|
|
2224
|
+
* ownership" of the floating reference, converting it to a normal
|
|
2225
|
+
* reference by clearing the floating flag while leaving the reference
|
|
2226
|
+
* count unchanged. If the object is not floating, then this call
|
|
2227
|
+
* adds a new normal reference increasing the reference count by one.
|
|
2228
|
+
*
|
|
2229
|
+
* Since GLib 2.56, the type of `object` will be propagated to the return type
|
|
2230
|
+
* under the same conditions as for g_object_ref().
|
|
2231
|
+
* @returns @object
|
|
2232
|
+
*/
|
|
2233
|
+
ref_sink(): GObject.Object;
|
|
2234
|
+
/**
|
|
2235
|
+
* Releases all references to other objects. This can be used to break
|
|
2236
|
+
* reference cycles.
|
|
2237
|
+
*
|
|
2238
|
+
* This function should only be called from object system implementations.
|
|
2239
|
+
*/
|
|
2240
|
+
run_dispose(): void;
|
|
2241
|
+
/**
|
|
2242
|
+
* Each object carries around a table of associations from
|
|
2243
|
+
* strings to pointers. This function lets you set an association.
|
|
2244
|
+
*
|
|
2245
|
+
* If the object already had an association with that name,
|
|
2246
|
+
* the old association will be destroyed.
|
|
2247
|
+
*
|
|
2248
|
+
* Internally, the `key` is converted to a #GQuark using g_quark_from_string().
|
|
2249
|
+
* This means a copy of `key` is kept permanently (even after `object` has been
|
|
2250
|
+
* finalized) — so it is recommended to only use a small, bounded set of values
|
|
2251
|
+
* for `key` in your program, to avoid the #GQuark storage growing unbounded.
|
|
2252
|
+
* @param key name of the key
|
|
2253
|
+
* @param data data to associate with that key
|
|
2254
|
+
*/
|
|
2255
|
+
set_data(key: string, data?: any | null): void;
|
|
2256
|
+
set_property(property_name: string, value: any): void;
|
|
2257
|
+
/**
|
|
2258
|
+
* Remove a specified datum from the object's data associations,
|
|
2259
|
+
* without invoking the association's destroy handler.
|
|
2260
|
+
* @param key name of the key
|
|
2261
|
+
* @returns the data if found, or %NULL if no such data exists.
|
|
2262
|
+
*/
|
|
2263
|
+
steal_data(key: string): any | null;
|
|
2264
|
+
/**
|
|
2265
|
+
* This function gets back user data pointers stored via
|
|
2266
|
+
* g_object_set_qdata() and removes the `data` from object
|
|
2267
|
+
* without invoking its destroy() function (if any was
|
|
2268
|
+
* set).
|
|
2269
|
+
* Usually, calling this function is only required to update
|
|
2270
|
+
* user data pointers with a destroy notifier, for example:
|
|
2271
|
+
*
|
|
2272
|
+
* ```c
|
|
2273
|
+
* void
|
|
2274
|
+
* object_add_to_user_list (GObject *object,
|
|
2275
|
+
* const gchar *new_string)
|
|
2276
|
+
* {
|
|
2277
|
+
* // the quark, naming the object data
|
|
2278
|
+
* GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
|
|
2279
|
+
* // retrieve the old string list
|
|
2280
|
+
* GList *list = g_object_steal_qdata (object, quark_string_list);
|
|
2281
|
+
*
|
|
2282
|
+
* // prepend new string
|
|
2283
|
+
* list = g_list_prepend (list, g_strdup (new_string));
|
|
2284
|
+
* // this changed 'list', so we need to set it again
|
|
2285
|
+
* g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
|
|
2286
|
+
* }
|
|
2287
|
+
* static void
|
|
2288
|
+
* free_string_list (gpointer data)
|
|
2289
|
+
* {
|
|
2290
|
+
* GList *node, *list = data;
|
|
2291
|
+
*
|
|
2292
|
+
* for (node = list; node; node = node->next)
|
|
2293
|
+
* g_free (node->data);
|
|
2294
|
+
* g_list_free (list);
|
|
2295
|
+
* }
|
|
2296
|
+
* ```
|
|
2297
|
+
*
|
|
2298
|
+
* Using g_object_get_qdata() in the above example, instead of
|
|
2299
|
+
* g_object_steal_qdata() would have left the destroy function set,
|
|
2300
|
+
* and thus the partial string list would have been freed upon
|
|
2301
|
+
* g_object_set_qdata_full().
|
|
2302
|
+
* @param quark A #GQuark, naming the user data pointer
|
|
2303
|
+
* @returns The user data pointer set, or %NULL
|
|
2304
|
+
*/
|
|
2305
|
+
steal_qdata(quark: GLib.Quark): any | null;
|
|
2306
|
+
/**
|
|
2307
|
+
* Reverts the effect of a previous call to
|
|
2308
|
+
* g_object_freeze_notify(). The freeze count is decreased on `object`
|
|
2309
|
+
* and when it reaches zero, queued "notify" signals are emitted.
|
|
2310
|
+
*
|
|
2311
|
+
* Duplicate notifications for each property are squashed so that at most one
|
|
2312
|
+
* #GObject::notify signal is emitted for each property, in the reverse order
|
|
2313
|
+
* in which they have been queued.
|
|
2314
|
+
*
|
|
2315
|
+
* It is an error to call this function when the freeze count is zero.
|
|
2316
|
+
*/
|
|
2317
|
+
thaw_notify(): void;
|
|
2318
|
+
/**
|
|
2319
|
+
* Decreases the reference count of `object`. When its reference count
|
|
2320
|
+
* drops to 0, the object is finalized (i.e. its memory is freed).
|
|
2321
|
+
*
|
|
2322
|
+
* If the pointer to the #GObject may be reused in future (for example, if it is
|
|
2323
|
+
* an instance variable of another object), it is recommended to clear the
|
|
2324
|
+
* pointer to %NULL rather than retain a dangling pointer to a potentially
|
|
2325
|
+
* invalid #GObject instance. Use g_clear_object() for this.
|
|
2326
|
+
*/
|
|
2327
|
+
unref(): void;
|
|
2328
|
+
/**
|
|
2329
|
+
* This function essentially limits the life time of the `closure` to
|
|
2330
|
+
* the life time of the object. That is, when the object is finalized,
|
|
2331
|
+
* the `closure` is invalidated by calling g_closure_invalidate() on
|
|
2332
|
+
* it, in order to prevent invocations of the closure with a finalized
|
|
2333
|
+
* (nonexisting) object. Also, g_object_ref() and g_object_unref() are
|
|
2334
|
+
* added as marshal guards to the `closure,` to ensure that an extra
|
|
2335
|
+
* reference count is held on `object` during invocation of the
|
|
2336
|
+
* `closure`. Usually, this function will be called on closures that
|
|
2337
|
+
* use this `object` as closure data.
|
|
2338
|
+
* @param closure #GClosure to watch
|
|
2339
|
+
*/
|
|
2340
|
+
watch_closure(closure: GObject.Closure): void;
|
|
2341
|
+
vfunc_constructed(): void;
|
|
2342
|
+
vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: GObject.ParamSpec): void;
|
|
2343
|
+
vfunc_dispose(): void;
|
|
2344
|
+
vfunc_finalize(): void;
|
|
2345
|
+
vfunc_get_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
|
|
2346
|
+
/**
|
|
2347
|
+
* Emits a "notify" signal for the property `property_name` on `object`.
|
|
2348
|
+
*
|
|
2349
|
+
* When possible, eg. when signaling a property change from within the class
|
|
2350
|
+
* that registered the property, you should use g_object_notify_by_pspec()
|
|
2351
|
+
* instead.
|
|
2352
|
+
*
|
|
2353
|
+
* Note that emission of the notify signal may be blocked with
|
|
2354
|
+
* g_object_freeze_notify(). In this case, the signal emissions are queued
|
|
2355
|
+
* and will be emitted (in reverse order) when g_object_thaw_notify() is
|
|
2356
|
+
* called.
|
|
2357
|
+
* @param pspec
|
|
2358
|
+
*/
|
|
2359
|
+
vfunc_notify(pspec: GObject.ParamSpec): void;
|
|
2360
|
+
vfunc_set_property(property_id: number, value: GObject.Value | any, pspec: GObject.ParamSpec): void;
|
|
2361
|
+
disconnect(id: number): void;
|
|
2362
|
+
set(properties: { [key: string]: any }): void;
|
|
2363
|
+
block_signal_handler(id: number): any;
|
|
2364
|
+
unblock_signal_handler(id: number): any;
|
|
2365
|
+
stop_emission_by_name(detailedName: string): any;
|
|
2366
|
+
}
|
|
2367
|
+
|
|
2368
|
+
type DocumentModelClass = typeof DocumentModel;
|
|
2369
|
+
type JobAnnotsClass = typeof JobAnnots;
|
|
2370
|
+
type JobAttachmentsClass = typeof JobAttachments;
|
|
2371
|
+
type JobClass = typeof Job;
|
|
2372
|
+
type JobExportClass = typeof JobExport;
|
|
2373
|
+
type JobFindClass = typeof JobFind;
|
|
2374
|
+
type JobFontsClass = typeof JobFonts;
|
|
2375
|
+
type JobLayersClass = typeof JobLayers;
|
|
2376
|
+
type JobLinksClass = typeof JobLinks;
|
|
2377
|
+
type JobLoadClass = typeof JobLoad;
|
|
2378
|
+
type JobPageDataClass = typeof JobPageData;
|
|
2379
|
+
type JobPrintClass = typeof JobPrint;
|
|
2380
|
+
type JobRenderClass = typeof JobRender;
|
|
2381
|
+
type JobSaveClass = typeof JobSave;
|
|
2382
|
+
type JobThumbnailClass = typeof JobThumbnail;
|
|
2383
|
+
abstract class JobWebThumbnail {
|
|
2384
|
+
static $gtype: GObject.GType<JobWebThumbnail>;
|
|
2385
|
+
|
|
2386
|
+
// Constructors of XreaderView.JobWebThumbnail
|
|
2387
|
+
|
|
2388
|
+
_init(...args: any[]): void;
|
|
2389
|
+
}
|
|
2390
|
+
|
|
2391
|
+
abstract class JobWebThumbnailClass {
|
|
2392
|
+
static $gtype: GObject.GType<JobWebThumbnailClass>;
|
|
2393
|
+
|
|
2394
|
+
// Constructors of XreaderView.JobWebThumbnailClass
|
|
2395
|
+
|
|
2396
|
+
_init(...args: any[]): void;
|
|
2397
|
+
}
|
|
2398
|
+
|
|
2399
|
+
type PrintOperationClass = typeof PrintOperation;
|
|
2400
|
+
type ViewClass = typeof View;
|
|
2401
|
+
type ViewPresentationClass = typeof ViewPresentation;
|
|
2402
|
+
type WebViewClass = typeof WebView;
|
|
2403
|
+
/**
|
|
2404
|
+
* Name of the imported GIR library
|
|
2405
|
+
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L188
|
|
2406
|
+
*/
|
|
2407
|
+
const __name__: string;
|
|
2408
|
+
/**
|
|
2409
|
+
* Version of the imported GIR library
|
|
2410
|
+
* `see` https://gitlab.gnome.org/GNOME/gjs/-/blob/master/gi/ns.cpp#L189
|
|
2411
|
+
*/
|
|
2412
|
+
const __version__: string;
|
|
2413
|
+
}
|
|
2414
|
+
|
|
2415
|
+
export default XreaderView;
|
|
2416
|
+
// END
|