-
Notifications
You must be signed in to change notification settings - Fork 64
/
Vte-0.0.gir
2840 lines (2840 loc) · 128 KB
/
Vte-0.0.gir
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<?xml version="1.0"?>
<!-- This file was automatically generated from C sources - DO NOT EDIT!
To affect the contents of this file, edit the original C definitions,
and/or use gtk-doc annotations. -->
<repository version="1.2"
xmlns="http://www.gtk.org/introspection/core/1.0"
xmlns:c="http://www.gtk.org/introspection/c/1.0"
xmlns:glib="http://www.gtk.org/introspection/glib/1.0">
<include name="Atk" version="1.0"/>
<include name="GLib" version="2.0"/>
<include name="GModule" version="2.0"/>
<include name="GObject" version="2.0"/>
<include name="Gdk" version="2.0"/>
<include name="GdkPixbuf" version="2.0"/>
<include name="Gio" version="2.0"/>
<include name="Gtk" version="2.0"/>
<include name="Pango" version="1.0"/>
<include name="cairo" version="1.0"/>
<namespace name="Vte"
version="0.0"
shared-library="libvte.so.9"
c:identifier-prefixes="Vte"
c:symbol-prefixes="vte">
<class name="Pty"
c:symbol-prefix="pty"
c:type="VtePty"
version="0.26"
parent="GObject.Object"
glib:type-name="VtePty"
glib:get-type="vte_pty_get_type"
glib:type-struct="PtyClass">
<implements name="Gio.Initable"/>
<constructor name="new"
c:identifier="vte_pty_new"
version="0.26"
throws="1">
<doc xml:whitespace="preserve">Allocates a new pseudo-terminal.
You can later use fork() or the g_spawn_async() familty of functions
to start a process on the PTY.
If using fork(), you MUST call vte_pty_child_setup() in the child.
If using g_spawn_async() and friends, you MUST either use
vte_pty_child_setup () directly as the child setup function, or call
vte_pty_child_setup() from your own child setup function supplied.
Also, you MUST pass the %G_SPAWN_DO_NOT_REAP_CHILD flag.
When using the GNOME PTY Helper,
unless some of the %VTE_PTY_NO_LASTLOG, %VTE_PTY_NO_UTMP or
%VTE_PTY_NO_WTMP flags are passed in @flags, the
session is logged in the corresponding lastlog, utmp or wtmp
system files.
When passing %VTE_PTY_NO_HELPER in @flags, the
GNOME PTY Helper bypassed entirely.
When passing %VTE_PTY_NO_FALLBACK in @flags,
and opening a PTY using the PTY helper fails, there will
be no fallback to allocate a PTY using Unix98 PTY functions.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #VtePty, or %NULL on error with @error filled in</doc>
<type name="Pty" c:type="VtePty*"/>
</return-value>
<parameters>
<parameter name="flags" transfer-ownership="none">
<doc xml:whitespace="preserve">flags from #VtePtyFlags</doc>
<type name="PtyFlags" c:type="VtePtyFlags"/>
</parameter>
</parameters>
</constructor>
<constructor name="new_foreign"
c:identifier="vte_pty_new_foreign"
version="0.26"
throws="1">
<doc xml:whitespace="preserve">Creates a new #VtePty for the PTY master @fd.
No entry will be made in the lastlog, utmp or wtmp system files.
Note that the newly created #VtePty will take ownership of @fd
and close it on finalize.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #VtePty for @fd, or %NULL on error with @error filled in</doc>
<type name="Pty" c:type="VtePty*"/>
</return-value>
<parameters>
<parameter name="fd" transfer-ownership="full">
<doc xml:whitespace="preserve">a file descriptor to the PTY</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</constructor>
<method name="child_setup"
c:identifier="vte_pty_child_setup"
version="0.26">
<doc xml:whitespace="preserve">FIXMEchpe</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
<method name="close" c:identifier="vte_pty_close" version="0.26">
<doc xml:whitespace="preserve">Cleans up the PTY, specifically any logging performed for the session.
The file descriptor to the PTY master remains open.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
<method name="get_fd" c:identifier="vte_pty_get_fd">
<doc xml:whitespace="preserve">file descriptor belongs to @pty and must not be closed</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the file descriptor of the PTY master in @pty. The</doc>
<type name="gint" c:type="int"/>
</return-value>
</method>
<method name="get_size"
c:identifier="vte_pty_get_size"
version="0.26"
throws="1">
<doc xml:whitespace="preserve">Reads the pseudo terminal's window size.
If getting the window size failed, @error will be set to a #GIOError.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure with @error filled in</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="rows"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">a location to store the number of rows, or %NULL</doc>
<type name="gint" c:type="int*"/>
</parameter>
<parameter name="columns"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">a location to store the number of columns, or %NULL</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</method>
<method name="set_size"
c:identifier="vte_pty_set_size"
version="0.26"
throws="1">
<doc xml:whitespace="preserve">Attempts to resize the pseudo terminal's window size. If successful, the
OS kernel will send #SIGWINCH to the child process group.
If setting the window size failed, @error will be set to a #GIOError.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure with @error filled in</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="rows" transfer-ownership="none">
<doc xml:whitespace="preserve">the desired number of rows</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="columns" transfer-ownership="none">
<doc xml:whitespace="preserve">the desired number of columns</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="set_term" c:identifier="vte_pty_set_term" version="0.26">
<doc xml:whitespace="preserve">Sets what value of the TERM environment variable to set just after forking.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="emulation" transfer-ownership="none" allow-none="1">
<doc xml:whitespace="preserve">the name of a terminal description, or %NULL</doc>
<type name="utf8" c:type="char*"/>
</parameter>
</parameters>
</method>
<method name="set_utf8"
c:identifier="vte_pty_set_utf8"
version="0.26"
throws="1">
<doc xml:whitespace="preserve">Tells the kernel whether the terminal is UTF-8 or not, in case it can make
use of the info. Linux 2.6.5 or so defines IUTF8 to make the line
discipline do multibyte backspace correctly.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE on success, %FALSE on failure with @error filled in</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="utf8" transfer-ownership="none">
<doc xml:whitespace="preserve">whether or not the pty is in UTF-8 mode</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<property name="fd"
version="0.26"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:whitespace="preserve">The file descriptor of the PTY master.</doc>
<type name="gint"/>
</property>
<property name="flags"
version="0.26"
writable="1"
construct-only="1"
transfer-ownership="none">
<doc xml:whitespace="preserve">Controls how the session is recorded in lastlog, utmp, and wtmp,
and whether to use the GNOME PTY helper.</doc>
<type name="PtyFlags"/>
</property>
<property name="term"
version="0.26"
writable="1"
transfer-ownership="none">
<doc xml:whitespace="preserve">The value to set for the TERM environment variable just after
forking.</doc>
<type name="utf8"/>
</property>
</class>
<record name="PtyClass"
c:type="VtePtyClass"
disguised="1"
glib:is-gtype-struct-for="Pty">
</record>
<enumeration name="PtyError"
version="0.26"
glib:type-name="VtePtyError"
glib:get-type="vte_pty_error_get_type"
c:type="VtePtyError"
glib:error-quark="vte_pty_error_quark">
<member name="pty_helper_failed"
value="0"
c:identifier="VTE_PTY_ERROR_PTY_HELPER_FAILED"
glib:nick="pty-helper-failed"/>
<member name="pty98_failed"
value="1"
c:identifier="VTE_PTY_ERROR_PTY98_FAILED"
glib:nick="pty98-failed"/>
</enumeration>
<bitfield name="PtyFlags"
version="0.26"
glib:type-name="VtePtyFlags"
glib:get-type="vte_pty_flags_get_type"
c:type="VtePtyFlags">
<member name="no_lastlog"
value="1"
c:identifier="VTE_PTY_NO_LASTLOG"
glib:nick="no-lastlog"/>
<member name="no_utmp"
value="2"
c:identifier="VTE_PTY_NO_UTMP"
glib:nick="no-utmp"/>
<member name="no_wtmp"
value="4"
c:identifier="VTE_PTY_NO_WTMP"
glib:nick="no-wtmp"/>
<member name="no_helper"
value="8"
c:identifier="VTE_PTY_NO_HELPER"
glib:nick="no-helper"/>
<member name="no_fallback"
value="16"
c:identifier="VTE_PTY_NO_FALLBACK"
glib:nick="no-fallback"/>
<member name="default"
value="0"
c:identifier="VTE_PTY_DEFAULT"
glib:nick="default"/>
</bitfield>
<callback name="SelectionFunc" c:type="VteSelectionFunc">
<doc xml:whitespace="preserve">Specifies the type of a selection function used to check whether
a cell has to be selected or not.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if cell has to be selected; %FALSE if otherwise.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="terminal" transfer-ownership="none">
<doc xml:whitespace="preserve">terminal in which the cell is.</doc>
<type name="Terminal" c:type="VteTerminal*"/>
</parameter>
<parameter name="column" transfer-ownership="none">
<doc xml:whitespace="preserve">column in which the cell is.</doc>
<type name="glong" c:type="glong"/>
</parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:whitespace="preserve">row in which the cell is.</doc>
<type name="glong" c:type="glong"/>
</parameter>
<parameter name="data" transfer-ownership="none">
<doc xml:whitespace="preserve">user data.</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
</parameters>
</callback>
<class name="Terminal"
c:symbol-prefix="terminal"
c:type="VteTerminal"
parent="Gtk.Widget"
glib:type-name="VteTerminal"
glib:get-type="vte_terminal_get_type"
glib:type-struct="TerminalClass">
<doc xml:whitespace="preserve">All of these fields should be considered read-only and deprecated.</doc>
<implements name="Atk.ImplementorIface"/>
<implements name="Gtk.Buildable"/>
<constructor name="new" c:identifier="vte_terminal_new">
<doc xml:whitespace="preserve">Creates a new terminal widget.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #VteTerminal object</doc>
<type name="Terminal"/>
</return-value>
</constructor>
<method name="copy_clipboard" c:identifier="vte_terminal_copy_clipboard">
<doc xml:whitespace="preserve">Places the selected text in the terminal in the #GDK_SELECTION_CLIPBOARD
selection.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
<method name="copy_primary" c:identifier="vte_terminal_copy_primary">
<doc xml:whitespace="preserve">Places the selected text in the terminal in the #GDK_SELECTION_PRIMARY
selection.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
<method name="feed" c:identifier="vte_terminal_feed" introspectable="0">
<doc xml:whitespace="preserve">Interprets @data as if it were data received from a child process. This
can either be used to drive the terminal without a child process, or just
to mess with your users.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="none">
<doc xml:whitespace="preserve">a string in the terminal's current encoding</doc>
<array length="1" zero-terminated="0" c:type="char*">
<type c:type="uint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:whitespace="preserve">the length of the string</doc>
<type name="glong" c:type="glong"/>
</parameter>
</parameters>
</method>
<method name="feed_child"
c:identifier="vte_terminal_feed_child"
introspectable="0">
<doc xml:whitespace="preserve">Sends a block of UTF-8 text to the child as if it were entered by the user
at the keyboard.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="text" transfer-ownership="none">
<doc xml:whitespace="preserve">data to send to the child</doc>
<array length="1" zero-terminated="0" c:type="char*">
<type c:type="uint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:whitespace="preserve">length of @text in bytes, or -1 if @text is NUL-terminated</doc>
<type name="glong" c:type="glong"/>
</parameter>
</parameters>
</method>
<method name="feed_child_binary"
c:identifier="vte_terminal_feed_child_binary"
version="0.12.1"
introspectable="0">
<doc xml:whitespace="preserve">Sends a block of binary data to the child.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="data" transfer-ownership="none">
<doc xml:whitespace="preserve">data to send to the child</doc>
<array length="1" zero-terminated="0" c:type="char*">
<type c:type="uint8"/>
</array>
</parameter>
<parameter name="length" transfer-ownership="none">
<doc xml:whitespace="preserve">length of @data</doc>
<type name="glong" c:type="glong"/>
</parameter>
</parameters>
</method>
<method name="fork_command_full"
c:identifier="vte_terminal_fork_command_full"
version="0.26"
introspectable="0"
throws="1">
<doc xml:whitespace="preserve">Starts the specified command under a newly-allocated controlling
pseudo-terminal. The @argv and @envv lists should be %NULL-terminated.
The "TERM" environment variable is automatically set to reflect the
terminal widget's emulation setting.
Note that %G_SPAWN_DO_NOT_REAP_CHILD will always be added to @spawn_flags.
Note that unless @spawn_flags contains %G_SPAWN_LEAVE_DESCRIPTORS_OPEN, all file
descriptors except stdin/stdout/stderr will be closed before calling exec()
in the child.
See vte_pty_new(), g_spawn_async() and vte_terminal_watch_child() for more information.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE on success, or %FALSE on error with @error filled in</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="pty_flags" transfer-ownership="none">
<doc xml:whitespace="preserve">flags from #VtePtyFlags</doc>
<type name="PtyFlags" c:type="VtePtyFlags"/>
</parameter>
<parameter name="working_directory"
transfer-ownership="none"
allow-none="1">
<doc xml:whitespace="preserve">the name of a directory the command should start in, or %NULL to use the current working directory</doc>
<type name="filename"/>
</parameter>
<parameter name="argv" transfer-ownership="none">
<doc xml:whitespace="preserve">child's argument vector</doc>
<array c:type="char**">
<type name="filename"/>
</array>
</parameter>
<parameter name="envv" transfer-ownership="none" allow-none="1">
<doc xml:whitespace="preserve">a list of environment variables to be added to the environment before starting the process, or %NULL</doc>
<array c:type="char**">
<type name="filename"/>
</array>
</parameter>
<parameter name="spawn_flags" transfer-ownership="none">
<doc xml:whitespace="preserve">flags from #GSpawnFlags</doc>
<type name="GLib.SpawnFlags" c:type="GSpawnFlags"/>
</parameter>
<parameter name="child_setup"
transfer-ownership="none"
allow-none="1"
closure="6">
<doc xml:whitespace="preserve">function to run in the child just before exec(), or %NULL</doc>
<type name="GLib.SpawnChildSetupFunc"
c:type="GSpawnChildSetupFunc"/>
</parameter>
<parameter name="child_setup_data" transfer-ownership="none">
<doc xml:whitespace="preserve">user data for @child_setup</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="child_pid"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">a location to store the child PID, or %NULL</doc>
<type name="GLib.Pid" c:type="GPid*"/>
</parameter>
</parameters>
</method>
<method name="get_adjustment"
c:identifier="vte_terminal_get_adjustment"
deprecated="Use gtk_scrollable_get_vadjustment() instead"
deprecated-version="0.28">
<doc xml:whitespace="preserve">An accessor function provided for the benefit of language bindings.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the contents of @terminal's adjustment field</doc>
<type name="Gtk.Adjustment" c:type="GtkAdjustment*"/>
</return-value>
</method>
<method name="get_allow_bold" c:identifier="vte_terminal_get_allow_bold">
<doc xml:whitespace="preserve">Checks whether or not the terminal will attempt to draw bold text by
repainting text with a one-pixel offset.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if bolding is enabled, %FALSE if not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
</method>
<method name="get_audible_bell"
c:identifier="vte_terminal_get_audible_bell">
<doc xml:whitespace="preserve">Checks whether or not the terminal will beep when the child outputs the
"bl" sequence.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if audible bell is enabled, %FALSE if not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
</method>
<method name="get_char_height"
c:identifier="vte_terminal_get_char_height">
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the height of a character cell</doc>
<type name="glong" c:type="glong"/>
</return-value>
</method>
<method name="get_char_width" c:identifier="vte_terminal_get_char_width">
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the width of a character cell</doc>
<type name="glong" c:type="glong"/>
</return-value>
</method>
<method name="get_child_exit_status"
c:identifier="vte_terminal_get_child_exit_status"
version="0.20">
<doc xml:whitespace="preserve">Gets the exit status of the command started by vte_terminal_fork_command().
See your C library's documentation for more details on how to interpret the
exit status.
Note that this function may only be called from the signal handler of
the #VteTerminal::child-exited signal.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the child's exit status</doc>
<type name="gint" c:type="int"/>
</return-value>
</method>
<method name="get_column_count"
c:identifier="vte_terminal_get_column_count">
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the number of columns</doc>
<type name="glong" c:type="glong"/>
</return-value>
</method>
<method name="get_cursor_blink_mode"
c:identifier="vte_terminal_get_cursor_blink_mode"
version="0.17.1">
<doc xml:whitespace="preserve">Returns the currently set cursor blink mode.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">cursor blink mode.</doc>
<type name="TerminalCursorBlinkMode"
c:type="VteTerminalCursorBlinkMode"/>
</return-value>
</method>
<method name="get_cursor_position"
c:identifier="vte_terminal_get_cursor_position">
<doc xml:whitespace="preserve">Reads the location of the insertion cursor and returns it. The row
coordinate is absolute.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="column"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">a location to store the column, or %NULL</doc>
<type name="glong" c:type="glong*"/>
</parameter>
<parameter name="row" transfer-ownership="none">
<type name="glong" c:type="glong*"/>
</parameter>
</parameters>
</method>
<method name="get_cursor_shape"
c:identifier="vte_terminal_get_cursor_shape"
version="0.17.6">
<doc xml:whitespace="preserve">Returns the currently set cursor shape.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">cursor shape.</doc>
<type name="TerminalCursorShape" c:type="VteTerminalCursorShape"/>
</return-value>
</method>
<method name="get_default_emulation"
c:identifier="vte_terminal_get_default_emulation"
version="0.11.11">
<doc xml:whitespace="preserve">Queries the terminal for its default emulation, which is attempted if the
terminal type passed to vte_terminal_set_emulation() is %NULL.
type the widget attempts to emulate</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">an interned string containing the name of the default terminal</doc>
<type name="utf8"/>
</return-value>
</method>
<method name="get_emulation" c:identifier="vte_terminal_get_emulation">
<doc xml:whitespace="preserve">Queries the terminal for its current emulation, as last set by a call to
vte_terminal_set_emulation().
widget is attempting to emulate</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">an interned string containing the name of the terminal type the</doc>
<type name="utf8" c:type="char*"/>
</return-value>
</method>
<method name="get_encoding" c:identifier="vte_terminal_get_encoding">
<doc xml:whitespace="preserve">Determines the name of the encoding in which the terminal expects data to be
encoded.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the current encoding for the terminal</doc>
<type name="utf8" c:type="char*"/>
</return-value>
</method>
<method name="get_font" c:identifier="vte_terminal_get_font">
<doc xml:whitespace="preserve">Queries the terminal for information about the fonts which will be
used to draw text in the terminal.
currently using to render text</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">a #PangoFontDescription describing the font the terminal is</doc>
<type name="Pango.FontDescription" c:type="PangoFontDescription*"/>
</return-value>
</method>
<method name="get_has_selection"
c:identifier="vte_terminal_get_has_selection">
<doc xml:whitespace="preserve">Checks if the terminal currently contains selected text. Note that this
is different from determining if the terminal is the owner of any
#GtkClipboard items.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if part of the text in the terminal is selected.</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
</method>
<method name="get_icon_title" c:identifier="vte_terminal_get_icon_title">
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the icon title</doc>
<type name="utf8" c:type="char*"/>
</return-value>
</method>
<method name="get_mouse_autohide"
c:identifier="vte_terminal_get_mouse_autohide">
<doc xml:whitespace="preserve">Determines the value of the terminal's mouse autohide setting. When
autohiding is enabled, the mouse cursor will be hidden when the user presses
a key and shown when the user moves the mouse. This setting can be changed
using vte_terminal_set_mouse_autohide().</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if autohiding is enabled, %FALSE if not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
</method>
<method name="get_pty_object"
c:identifier="vte_terminal_get_pty_object"
version="0.26">
<doc xml:whitespace="preserve">Returns the #VtePty of @terminal.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">a #VtePty, or %NULL</doc>
<type name="Pty" c:type="VtePty*"/>
</return-value>
</method>
<method name="get_row_count" c:identifier="vte_terminal_get_row_count">
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the number of rows</doc>
<type name="glong" c:type="glong"/>
</return-value>
</method>
<method name="get_status_line"
c:identifier="vte_terminal_get_status_line">
<doc xml:whitespace="preserve">Some terminal emulations specify a status line which is separate from the
main display area, and define a means for applications to move the cursor
to the status line and back.
For terminals like "xterm", this will usually be the empty string. The string
must not be modified or freed by the caller.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the current contents of the terminal's status line.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
</method>
<method name="get_text"
c:identifier="vte_terminal_get_text"
introspectable="0">
<doc xml:whitespace="preserve">Extracts a view of the visible part of the terminal. If @is_selected is not
%NULL, characters will only be read if @is_selected returns %TRUE after being
passed the column and row, respectively. A #VteCharAttributes structure
is added to @attributes for each byte added to the returned string detailing
the character's position, colors, and other characteristics.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a newly allocated text string, or %NULL.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="is_selected" transfer-ownership="none" closure="1">
<doc xml:whitespace="preserve">a #VteSelectionFunc callback</doc>
<type name="SelectionFunc" c:type="VteSelectionFunc"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:whitespace="preserve">user data to be passed to the callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="attributes"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">location for storing text attributes</doc>
<array name="GLib.Array" c:type="GArray*">
<type name="CharAttributes"/>
</array>
</parameter>
</parameters>
</method>
<method name="get_text_include_trailing_spaces"
c:identifier="vte_terminal_get_text_include_trailing_spaces"
version="0.11.11"
introspectable="0">
<doc xml:whitespace="preserve">Extracts a view of the visible part of the terminal. If @is_selected is not
%NULL, characters will only be read if @is_selected returns %TRUE after being
passed the column and row, respectively. A #VteCharAttributes structure
is added to @attributes for each byte added to the returned string detailing
the character's position, colors, and other characteristics. This function
differs from vte_terminal_get_text() in that trailing spaces at the end of
lines are included.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a newly allocated text string, or %NULL.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="is_selected" transfer-ownership="none" closure="1">
<doc xml:whitespace="preserve">a #VteSelectionFunc callback</doc>
<type name="SelectionFunc" c:type="VteSelectionFunc"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:whitespace="preserve">user data to be passed to the callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="attributes"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">location for storing text attributes</doc>
<array name="GLib.Array" c:type="GArray*">
<type name="CharAttributes"/>
</array>
</parameter>
</parameters>
</method>
<method name="get_text_range"
c:identifier="vte_terminal_get_text_range"
introspectable="0">
<doc xml:whitespace="preserve">Extracts a view of the visible part of the terminal. If @is_selected is not
%NULL, characters will only be read if @is_selected returns %TRUE after being
passed the column and row, respectively. A #VteCharAttributes structure
is added to @attributes for each byte added to the returned string detailing
the character's position, colors, and other characteristics. The
entire scrollback buffer is scanned, so it is possible to read the entire
contents of the buffer using this function.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a newly allocated text string, or %NULL.</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="start_row" transfer-ownership="none">
<doc xml:whitespace="preserve">first row to search for data</doc>
<type name="glong" c:type="glong"/>
</parameter>
<parameter name="start_col" transfer-ownership="none">
<doc xml:whitespace="preserve">first column to search for data</doc>
<type name="glong" c:type="glong"/>
</parameter>
<parameter name="end_row" transfer-ownership="none">
<doc xml:whitespace="preserve">last row to search for data</doc>
<type name="glong" c:type="glong"/>
</parameter>
<parameter name="end_col" transfer-ownership="none">
<doc xml:whitespace="preserve">last column to search for data</doc>
<type name="glong" c:type="glong"/>
</parameter>
<parameter name="is_selected" transfer-ownership="none" closure="5">
<doc xml:whitespace="preserve">a #VteSelectionFunc callback</doc>
<type name="SelectionFunc" c:type="VteSelectionFunc"/>
</parameter>
<parameter name="user_data" transfer-ownership="none">
<doc xml:whitespace="preserve">user data to be passed to the callback</doc>
<type name="gpointer" c:type="gpointer"/>
</parameter>
<parameter name="attributes"
direction="out"
caller-allocates="0"
transfer-ownership="full">
<doc xml:whitespace="preserve">location for storing text attributes</doc>
<array name="GLib.Array" c:type="GArray*">
<type name="CharAttributes"/>
</array>
</parameter>
</parameters>
</method>
<method name="get_visible_bell"
c:identifier="vte_terminal_get_visible_bell">
<doc xml:whitespace="preserve">Checks whether or not the terminal will present a visible bell to the
user when the child outputs the "bl" sequence. The terminal
will clear itself to the default foreground color and then repaint itself.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if visible bell is enabled, %FALSE if not</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
</method>
<method name="get_window_title"
c:identifier="vte_terminal_get_window_title">
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">the window title</doc>
<type name="utf8" c:type="char*"/>
</return-value>
</method>
<method name="im_append_menuitems"
c:identifier="vte_terminal_im_append_menuitems">
<doc xml:whitespace="preserve">Appends menu items for various input methods to the given menu. The
user can select one of these items to modify the input method used by
the terminal.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="menushell" transfer-ownership="none">
<doc xml:whitespace="preserve">a GtkMenuShell</doc>
<type name="Gtk.MenuShell" c:type="GtkMenuShell*"/>
</parameter>
</parameters>
</method>
<method name="is_word_char" c:identifier="vte_terminal_is_word_char">
<doc xml:whitespace="preserve">Checks if a particular character is considered to be part of a word or not,
based on the values last passed to vte_terminal_set_word_chars().</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if the character is considered to be part of a word</doc>
<type name="gboolean" c:type="gboolean"/>
</return-value>
<parameters>
<parameter name="c" transfer-ownership="none">
<doc xml:whitespace="preserve">a candidate Unicode code point</doc>
<type name="gunichar" c:type="gunichar"/>
</parameter>
</parameters>
</method>
<method name="match_add_gregex"
c:identifier="vte_terminal_match_add_gregex"
version="0.17.1">
<doc xml:whitespace="preserve">Adds the regular expression @regex to the list of matching expressions. When the
user moves the mouse cursor over a section of displayed text which matches
this expression, the text will be highlighted.</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">an integer associated with this expression</doc>
<type name="gint" c:type="int"/>
</return-value>
<parameters>
<parameter name="regex" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GRegex</doc>
<type name="GLib.Regex" c:type="GRegex*"/>
</parameter>
<parameter name="flags" transfer-ownership="none">
<doc xml:whitespace="preserve">the #GRegexMatchFlags to use when matching the regex</doc>
<type name="GLib.RegexMatchFlags" c:type="GRegexMatchFlags"/>
</parameter>
</parameters>
</method>
<method name="match_check" c:identifier="vte_terminal_match_check">
<doc xml:whitespace="preserve">Checks if the text in and around the specified position matches any of the
regular expressions previously set using vte_terminal_match_add(). If a
match exists, the text string is returned and if @tag is not %NULL, the number
associated with the matched regular expression will be stored in @tag.
If more than one regular expression has been set with
vte_terminal_match_add(), then expressions are checked in the order in
which they were added.
set regular expressions</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a newly allocated string which matches one of the previously</doc>
<type name="utf8" c:type="char*"/>
</return-value>
<parameters>
<parameter name="column" transfer-ownership="none">
<doc xml:whitespace="preserve">the text column</doc>
<type name="glong" c:type="glong"/>
</parameter>
<parameter name="row" transfer-ownership="none">
<doc xml:whitespace="preserve">the text row</doc>
<type name="glong" c:type="glong"/>
</parameter>
<parameter name="tag"
direction="out"
caller-allocates="0"
transfer-ownership="full"
allow-none="1">
<doc xml:whitespace="preserve">a location to store the tag, or %NULL</doc>
<type name="gint" c:type="int*"/>
</parameter>
</parameters>
</method>
<method name="match_clear_all"
c:identifier="vte_terminal_match_clear_all">
<doc xml:whitespace="preserve">Clears the list of regular expressions the terminal uses to highlight text
when the user moves the mouse cursor.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
<method name="match_remove" c:identifier="vte_terminal_match_remove">
<doc xml:whitespace="preserve">Removes the regular expression which is associated with the given @tag from
the list of expressions which the terminal will highlight when the user
moves the mouse cursor over matching text.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tag" transfer-ownership="none">
<doc xml:whitespace="preserve">the tag of the regex to remove</doc>
<type name="gint" c:type="int"/>
</parameter>
</parameters>
</method>
<method name="match_set_cursor"
c:identifier="vte_terminal_match_set_cursor"
version="0.11">
<doc xml:whitespace="preserve">Sets which cursor the terminal will use if the pointer is over the pattern
specified by @tag. The terminal keeps a reference to @cursor.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tag" transfer-ownership="none">
<doc xml:whitespace="preserve">the tag of the regex which should use the specified cursor</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="cursor" transfer-ownership="none" allow-none="1">
<doc xml:whitespace="preserve">the #GdkCursor which the terminal should use when the pattern is highlighted, or %NULL to use the standard cursor</doc>
<type name="Gdk.Cursor" c:type="GdkCursor*"/>
</parameter>
</parameters>
</method>
<method name="match_set_cursor_name"
c:identifier="vte_terminal_match_set_cursor_name"
version="0.17.1">
<doc xml:whitespace="preserve">Sets which cursor the terminal will use if the pointer is over the pattern
specified by @tag.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tag" transfer-ownership="none">
<doc xml:whitespace="preserve">the tag of the regex which should use the specified cursor</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="cursor_name" transfer-ownership="none">
<doc xml:whitespace="preserve">the name of the cursor</doc>
<type name="utf8" c:type="char*"/>
</parameter>
</parameters>
</method>
<method name="match_set_cursor_type"
c:identifier="vte_terminal_match_set_cursor_type"
version="0.11.9">
<doc xml:whitespace="preserve">Sets which cursor the terminal will use if the pointer is over the pattern
specified by @tag.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="tag" transfer-ownership="none">
<doc xml:whitespace="preserve">the tag of the regex which should use the specified cursor</doc>
<type name="gint" c:type="int"/>
</parameter>
<parameter name="cursor_type" transfer-ownership="none">
<doc xml:whitespace="preserve">a #GdkCursorType</doc>
<type name="Gdk.CursorType" c:type="GdkCursorType"/>
</parameter>
</parameters>
</method>
<method name="paste_clipboard"
c:identifier="vte_terminal_paste_clipboard">
<doc xml:whitespace="preserve">Sends the contents of the #GDK_SELECTION_CLIPBOARD selection to the
terminal's child. If necessary, the data is converted from UTF-8 to the
terminal's current encoding. It's called on paste menu item, or when
user presses Shift+Insert.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
<method name="paste_primary" c:identifier="vte_terminal_paste_primary">
<doc xml:whitespace="preserve">Sends the contents of the #GDK_SELECTION_PRIMARY selection to the terminal's
child. If necessary, the data is converted from UTF-8 to the terminal's
current encoding. The terminal will call also paste the
#GDK_SELECTION_PRIMARY selection when the user clicks with the the second
mouse button.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
</method>
<method name="pty_new"
c:identifier="vte_terminal_pty_new"
version="0.26"
throws="1">
<doc xml:whitespace="preserve">Creates a new #VtePty, and sets the emulation property
from #VteTerminal:emulation.
See vte_pty_new() for more information.</doc>
<return-value transfer-ownership="full">
<doc xml:whitespace="preserve">a new #VtePty</doc>
<type name="Pty" c:type="VtePty*"/>
</return-value>
<parameters>
<parameter name="flags" transfer-ownership="none">
<doc xml:whitespace="preserve">flags from #VtePtyFlags</doc>
<type name="PtyFlags" c:type="VtePtyFlags"/>
</parameter>
</parameters>
</method>
<method name="reset" c:identifier="vte_terminal_reset">
<doc xml:whitespace="preserve">Resets as much of the terminal's internal state as possible, discarding any
unprocessed input data, resetting character attributes, cursor state,
national character set state, status line, terminal modes (insert/delete),
selection state, and encoding.</doc>
<return-value transfer-ownership="none">
<type name="none" c:type="void"/>
</return-value>
<parameters>
<parameter name="clear_tabstops" transfer-ownership="none">
<doc xml:whitespace="preserve">whether to reset tabstops</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
<parameter name="clear_history" transfer-ownership="none">
<doc xml:whitespace="preserve">whether to empty the terminal's scrollback buffer</doc>
<type name="gboolean" c:type="gboolean"/>
</parameter>
</parameters>
</method>
<method name="search_find_next"
c:identifier="vte_terminal_search_find_next"
version="0.26">
<doc xml:whitespace="preserve">Searches the next string matching the search regex set with
vte_terminal_search_set_gregex().</doc>
<return-value transfer-ownership="none">
<doc xml:whitespace="preserve">%TRUE if a match was found</doc>
<type name="gboolean" c:type="gboolean"/>