1 .\" Copyright (c) 2014-2016 Bert Burgemeister <trebbu@googlemail.com>
3 .\" Permission is hereby granted, free of charge, to any person obtaining
4 .\" a copy of this software and associated documentation files (the
5 .\" "Software"), to deal in the Software without restriction, including
6 .\" without limitation the rights to use, copy, modify, merge, publish,
7 .\" distribute, sublicense, and/or sell copies of the Software, and to
8 .\" permit persons to whom the Software is furnished to do so, subject to
9 .\" the following conditions:
11 .\" The above copyright notice and this permission notice shall be
12 .\" included in all copies or substantial portions of the Software.
14 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15 .\" EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17 .\" NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18 .\" LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19 .\" OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20 .\" WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
27 .Nd pipe-driven GTK+ interface
34 .Op Fl u Ar builder-file
35 .Op Fl e Ar parent-xid
38 .Op Fl -display Ar X-server
43 is a helper program that displays graphical user
44 interfaces for other programs.
45 It renders the GUI definition found in a GtkBuilder XML file
46 (typically created using the
48 interface designer), and communicates with the main program solely
49 through plain text messages via pipes or fifos.
50 It provides access to a subset of features of a subset of widgets of
52 Simple one-shot dialogs as well as more complex, long-running programs
62 if necessary, sets its permissions to
64 and uses it for command input.
66 A command is a line of text.
68 .Qq Ar id Ns Cm \&: Ns Ar action Bq Ar data ,
70 being the name of the receiving widget;
72 is separated from the rest of the command by a single whitespace
74 Commands whose first non-whitespace character is
76 are considered comments and ignored silently, as are empty input lines.
77 Any occurences of the two-character sequences
81 will be converted into newline or carriage return, respectively.
82 Every other character following a backslash will be left unchanged,
83 but the backslash will be removed.
84 Invalid commands are reported on
86 and are otherwise ignored.
89 for applicable commands.
93 exists but is not a named pipe.
96 is deleted upon successful program termination.
98 Default command input is
103 if necessary, sets its permissions to
105 and uses it for output of feedback messages from the
106 graphical user interface.
108 A feedback message is a line of text; its format is
109 .Qq Ar id Ns Cm \&: Ns Ar info Bq Ar data ,
111 being the name of the sending widget.
114 for possible feedback messages.
118 exists but is not a named pipe.
121 is deleted upon successful program termination.
123 Default feedback-message output is
128 in the background after printing its process ID to
131 It is an error if option
138 .It Fl u Ar builder-file
139 Displays the graphical user interface
141 which should be created using the
143 user interface designer and saved in GtkBuilder (.ui) format.
144 Widget ids should consist of alphanumeric ASCII characters including
145 hyphens and underscores.
146 The main window must must be given the id
151 .It Fl e Ar parent-xid
152 Embeds the main window into the XEmbed socket
156 Appends for each command a line of
161 being the number of microseconds elapsed during
166 are separated by a tab character.
180 appending its output to
186 .It Fl -display Ar X-server
189 for user interaction.
191 Prints a help message and exits.
193 Prints the versions of the underlying GTK+ and cairo libraries and
201 The widget classes able to communicate through
212 .Sx GtkComboBoxText ,
218 .Sx GtkFileChooserButton ,
219 .Sx GtkFileChooserDialog ,
224 .Sx GtkImageMenuItem ,
236 .Sx GtkPrintUnixDialog ,
240 .Sx GtkScrolledWindow ,
242 .Sx GtkSeparatorMenuItem ,
250 .Sx GtkToggleButton ,
252 .Sx GtkTreeViewColumn ,
259 references a widget by the
261 attribute it is given in Glade.
269 .Dl <object class="GtkWindow" id="foo"> .
271 .\" Commands most widgets understand:
283 .Ss Unspecific Widget
284 .Bl -tag -width indent
288 .Qq Ar id Ns Cm :load Ar file
295 is required but ignored.
297 commands may be nested but on attempts to read from the same file, the
308 .Qq Ar id Ns Cm :main_quit
309 kills the user interface.
312 is required but ignored.
316 .Bl -tag -width indent
320 .Qq Ar id Ns Cm :set_label Ar text
321 replaces the frame label text with
324 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
325 makes the frame and its content grayed out
330 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
333 the frame, or makes it visible
336 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
337 sets the frame's tooltip.
338 Default is disabling the tooltip.
340 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
341 writes a snapshot of the frame to an image file of the specified
344 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
345 sets the widget's minimum size to
349 Default is the frame's natural size.
353 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
366 .Bl -tag -width indent
370 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
371 makes the box grayed out
376 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
379 the box, or makes it visible
381 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
382 sets the box's tooltip.
383 Default is disabling the tooltip.
385 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
386 writes a snapshot of the box to an image file of the specified
389 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
390 sets the box's minimum size to
394 Default is the box's natural size.
398 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
411 .Bl -tag -width indent
415 .Qq Ar id Ns Cm :set_label Ar string
416 replaces the button text with
419 .Qq Ar id Ns Cm :grab_focus
420 puts the keyboard focus onto the button.
422 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
423 makes the button grayed out
428 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
431 the button, or makes it visible
434 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
440 Initially, the button is unblocked.
442 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
443 sets the button's tooltip.
444 Default is disabling the tooltip.
446 .Qq Ar id Ns Cm :force
447 simulates a click on the button.
449 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
450 writes a snapshot of the button to an image file of the specified
453 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
454 sets the button's minimum size to
458 Default is the button's natural size.
462 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
471 .Qq Ar id Ns Cm \&:clicked
475 .Cm _ok , _apply , _cancel , _send_text ,
478 may work differently; see
479 .Sx GtkDialog , GtkFileChooserDialog ,
486 .Bl -tag -width indent
490 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
491 makes the box grayed out
496 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
499 the box, or makes it visible
502 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
503 sets the box's tooltip.
504 Default is disabling the tooltip.
506 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
507 writes a snapshot of the box to an image file of the specified
510 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
511 sets the box's minimum size to
515 Default is the box's natural size.
519 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
532 .Bl -tag -width indent
536 .Qq Ar id Ns Cm :select_date Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
537 selects the date on the calendar.
539 .Qq Ar id Ns Cm :mark_day Ar day
544 .Qq Ar id Ns Cm :clear_marks
545 unmarks all days on the calendar.
547 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
548 makes the calendar grayed out
553 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
556 the calendar, or makes it visible
559 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
565 Initially, the calendar is unblocked.
567 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
568 sets the calendar's tooltip.
569 Default is disabling the tooltip.
571 .Qq Ar id Ns Cm :force
572 simulates a click on the currently selected date.
574 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
575 writes a snapshot of the calendar to an image file of the specified
578 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
579 sets the calendar's minimum size to
583 Default is the widget's natural size.
587 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
589 sets the calendar's style.
596 .Qq Ar id Ns Cm \&:clicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
598 .Qq Ar id Ns Cm \&:doubleclicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
602 .Bl -tag -width indent
606 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
607 switches the check mark off
612 .Qq Ar id Ns Cm :set_label Ar string
613 replaces the button text with
616 .Qq Ar id Ns Cm :grab_focus
617 puts the keyboard focus onto the button.
619 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
620 makes the button grayed out
625 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
628 the button, or makes it visible
631 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
637 Initially, the button is unblocked.
639 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
640 sets the button's tooltip.
641 Default is disabling the tooltip.
643 .Qq Ar id Ns Cm :force
644 simulates a click on the button.
646 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
647 writes a snapshot of the button to an image file of the specified
650 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
651 sets the button's minimum size to
655 Default is the widget's natural size.
659 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
661 sets the button's style.
675 .Bl -tag -width indent
679 .Qq Ar id Ns Cm :set_color Ar color
680 preselects the color; see
683 .Qq Ar id Ns Cm :grab_focus
684 puts the keyboard focus onto the button.
686 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
687 makes the button grayed out
692 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
695 the button, or makes it visible
698 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
704 Initially, the button is unblocked.
706 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
707 sets the button's tooltip.
708 Default is disabling the tooltip.
710 .Qq Ar id Ns Cm :force
711 opens the dialog window.
713 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
714 writes a snapshot of the button to an image file of the specified
717 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
718 sets the button's minimum size to
722 Default is the widget's natural size.
726 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
728 sets the button's style.
735 .Qq Ar id Ns Cm \&:color Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&)
737 .Qq Ar id Ns Cm \&:color Cm rgba( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&, Ns Ar alpha Ns Cm \&) .
741 lie between 0 and 255, and
751 .Bl -tag -width indent
755 .Qq Ar id Ns Cm :prepend_text Ar string
757 .Qq Ar id Ns Cm :append_text Ar string
758 prepend/append a new selectable item marked
761 .Qq Ar id Ns Cm :insert_text Ar position string
767 .Qq Ar id Ns Cm :remove Ar position
771 .Qq Ar id Ns Cm :grab_focus
772 puts the keyboard focus onto the combo box.
774 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
775 makes the combo box grayed out
780 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
783 the combo box, or makes it visible
786 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
792 Initially, the combo box is unblocked.
794 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
796 Default is disabling the tooltip.
798 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
799 writes a snapshot of the combo box to an image file of the specified
802 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
803 sets the combo box's minimum size to
807 Default is the natural size.
811 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
820 .Qq Ar entry_id Ns Cm \&:text Ar text ,
822 being the id of the child
836 .Ar foo Ns Cm _invoke .
844 .Ar foo Ns Cm _cancel
846 if the dialog is the sole window of the GUI and therefore named
857 it will take care of hiding the dialog window.
858 .Bl -tag -width indent
862 .Qq Ar id Ns Cm :set_title Ar string
863 replaces the text in the title bar with
866 .Qq Ar id Ns Cm :resize Bq Ar width height
867 changes the size of the dialog window to
871 pixels if specified, or to the default size.
873 .Qq Ar id Ns Cm :move Ar x y
874 moves the dialog window to position
877 .Qq Ar id Ns Cm :fullscreen
879 .Qq Ar id Ns Cm :unfullscreen
880 switch fullscreen mode on and off.
882 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
883 makes the dialog grayed out
888 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
891 the dialog, or makes it visible
894 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
899 feedback messages from the dialog window.
900 Initially, the window is unblocked.
902 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
903 sets the dialog window's tooltip.
904 Default is disabling the tooltip.
906 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
907 writes a snapshot of the dialog window to an image file of the
910 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
911 sets the dialog window's minimum size to
915 Default is its natural size.
919 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
921 sets the dialog window's style.
928 .Qq Ar id Ns Cm \&:closed
931 window was closed by the window manager.
936 expect a context parameter of the form
937 .Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
940 is an arbitrary non-negative integer that can be used later to
941 reference the command.
944 appends its command to the current list of drawing operations.
947 replaces the first drawing operation with context parameter
951 .Ar n Ns Cm < Ns Ar m ,
952 inserts its command before the first drawing operation with context
955 Both second and third form fall back to appending.
957 The default coordinate system is a left-handed system with its origin
958 in the upper-left corner.
959 Angles increase from the positive X axis towards the positve Y axis
960 .Pq clockwise in the default system .
961 .Bl -tag -width indent
965 .Qq Ar id Ns Cm :arc Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc x y radius angle1 angle2
966 adds a circular arc to the current path.
967 The arc is centered at
975 .Qq Ar id Ns Cm :arc_negative Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc x y radius angle1 angle2
976 adds a circular arc to the current path.
977 The arc is centered at
979 and proceeds in the direction of decreasing angles from
985 .Qq Ar id Ns Cm :close_path Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
986 adds a line segment from the current point to the point most recently
988 .Ar id Ns Cm :move_to
990 .Ar id Ns Cm :rel_move_to .
992 .Qq Ar id Ns Cm :curve_to Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc x1 y1 x2 y2 x3 y3
993 adds a cubic Bezier spline from the current point to
1000 If there is no current point, the curve will start at
1003 .Qq Ar id Ns Cm :fill Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
1004 fills the current path and clears it.
1006 .Qq Ar id Ns Cm :fill_preserve Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
1007 fills the current path without clearing it.
1009 .Qq Ar id Ns Cm :line_to Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc x y
1010 adds a line from the current point to
1012 or creates a new current point at
1015 .Qq Ar id Ns Cm :move_to Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc x y
1016 sets the current point to
1019 .Qq Ar id Ns Cm :rectangle Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc x y width height
1020 adds a rectangle to the current path.
1021 The top left corner is at
1024 .Qq Ar id Ns Cm :rel_curve_to Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc dx1 dy1 dx2 dy2 dx3 dy3
1025 adds a cubic Bezier spline from the current point to
1032 All coordinates are offsets relative to the current point.
1034 .Qq Ar id Ns Cm :rel_line_to Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc dx dy
1035 adds a line from the current point to a point offset from there by
1038 .Qo Ar id Ns Cm :rel_move_for Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
1039 .Brq Cm c Ns | Ns Cm e Ns | Ns Cm n Ns | Ns Cm ne Ns | Ns Cm nw Ns | Ns Cm s Ns | Ns Cm se Ns | Ns Cm sw Ns | Ns Cm w
1042 moves the current point such that
1043 .Qq Ar id Ns Cm :show_text Ar n text
1044 will place the specified reference point of
1046 on the original current point.
1048 .Qq Ar id Ns Cm :rel_move_to Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc dx dy
1049 moves the current point by
1052 .Qq Ar id Ns Cm :remove Ar n
1053 removes the elements with context parameter
1056 .Cm GtkDrawingArea Ar id .
1058 .Qq Ar id Ns Cm :rotate Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc Ar angle
1059 rotates the user space axes by
1063 .Qq Ar id Ns Cm :scale Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc Ar sx sy
1064 scales the user space axes by
1067 .Qq Ar id Ns Cm :set_dash Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc l
1068 sets the dash pattern to
1074 .Qq Ar id Ns Cm :set_dash Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc l1on l1off l2on l2off ...
1075 resets the dash pattern to a line with arbitrary on/off portions.
1077 .Qq Ar id Ns Cm :set_dash Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
1078 resets the dash pattern to a solid line.
1080 .Qo Ar id Ns Cm :set_font_face Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
1081 .Brq Cm normal | italic | oblique
1082 .Brq Cm normal | bold
1085 sets the font face for subsequent calls of
1086 .Ar id Ns Cm :show_text .
1088 .Qq Ar id Ns Cm :set_font_size Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc size
1089 sets the font size for subsequent calls of
1090 .Ar id Ns Cm :show_text .
1092 .Qq Ar id Ns Cm :set_line_cap Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc Brq Cm butt | round | square
1093 sets the line cap style.
1097 .Qq Ar id Ns Cm :set_line_join Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc Brq Cm miter | round | bevel
1098 sets the line junction style.
1102 .Qq Ar id Ns Cm :set_line_width Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc width
1103 sets the line width.
1108 .Qq Ar id Ns Cm :set_source_rgba Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc color
1112 .Qq Ar id Ns Cm :show_text Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc text
1115 beginning at the current point.
1117 .Qq Ar id Ns Cm :stroke Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
1118 strokes the current path and clears it.
1120 .Qq Ar id Ns Cm :stroke_preserve Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
1121 strokes the current path without clearing it.
1123 .Qq Ar id Ns Cm :transform Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc Bq Ar xx yx xy yy x0 y0
1124 modifies the current transformation matrix such that
1126 .Dl Va x' Li = Ar xx Va x Li + Ar xy Va y Li + Ar x0 ,
1127 .Dl Va y' Li = Ar yx Va y Li + Ar yy Va y Li + Ar y0 .
1129 Default is resetting the current transformation matrix.
1131 .Qq Ar id Ns Cm :translate Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc Ar tx ty
1132 translates the user space origin by
1135 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1138 the drawing area, or makes it visible
1141 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1142 sets the drawing area's tooltip.
1143 Default is disabling the tooltip.
1145 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1146 writes a snapshot of the drawing area to an image file of the specified
1149 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1150 sets the drawing areas's minimum size to
1154 Default is the natural size.
1163 .Bl -tag -width indent
1167 .Qq Ar id Ns Cm :set_text Ar string
1168 replaces the user-editable text with
1171 .Qq Ar id Ns Cm :set_placeholder_text Ar string
1174 that is displayed when the entry is empty and unfocused.
1176 .Qq Ar id Ns Cm :grab_focus
1177 puts the keyboard focus into the entry.
1179 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1180 makes the entry grayed out
1185 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1188 the entry, or makes it visible
1191 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1197 Initially, the entry is unblocked.
1199 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1200 sets the entry's tooltip.
1201 Default is disabling the tooltip.
1203 .Qq Ar id Ns Cm :force
1204 lets the entry report its current content.
1206 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1207 writes a snapshot of the entry to an image file of the specified
1210 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1211 sets the entry's minimum size to
1215 Default is the entry's natural size.
1219 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1228 .Qq Ar id Ns Cm \&:text Ar text ,
1229 once for each change of
1235 are mouse pointer coordinates relative to the
1237 .Bl -tag -width indent
1241 .Qq Ar id Ns Cm :grab_focus
1242 puts the keyboard focus onto the event box.
1244 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1245 makes the event box insensitive
1250 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1256 Initially, the event box is unblocked.
1258 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1259 sets the tooltip of the event box.
1260 Default is disabling the tooltip.
1262 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1263 writes a snapshot of the event box to an image file of the specified
1266 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1267 sets the minimum size to
1271 Default is the natural size of the event box.
1275 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1277 sets the widget style.
1284 .Qq Ar id Ns Cm \&:button_press Ar b x y ,
1285 .Qq Ar id Ns Cm \&:button_release Ar b x y
1288 is the mouse button (normally 1, 2, or 3 for the left, middle, and
1289 right button; others may exist).
1291 .Qq Ar id Ns Cm \&:motion Ar x y
1292 is reported repeatedly while the mouse is being moved with a button
1295 .Qq Ar id Ns Cm \&:key_press Ar key ,
1297 being the key's name
1306 .Bl -tag -width indent
1310 .Qq Ar id Ns Cm :set_label Ar string
1311 replaces the expander label text with
1314 .Qq Ar id Ns Cm :set_expanded Brq Cm 0 Ns | Ns 1
1317 the child widget, or makes it visible
1320 .Qq Ar id Ns Cm :grab_focus
1321 puts the keyboard focus onto the expander.
1323 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1324 makes the expander grayed out
1329 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1332 the expander, or makes it visible
1335 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1336 sets the expander's tooltip.
1337 Default is disabling the tooltip.
1339 .Qq Ar id Ns Cm :force
1340 toggles the expansion state.
1342 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1343 writes a snapshot of the expander to an image file of the specified
1346 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1347 sets the expander's minimum size to
1351 Default is the natural size.
1355 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1368 .Bl -tag -width indent
1372 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1375 the grid, or makes it visible
1378 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1379 sets the grid's tooltip.
1380 Default is disabling the tooltip.
1382 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1383 writes a snapshot of the grid to an image file of the specified
1386 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1387 sets the grid's minimum size to
1391 Default is the grid's natural size.
1395 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1407 .Ss GtkFileChooserButton
1408 .Bl -tag -width indent
1412 .Qq Ar id Ns Cm :set_filename Ar path
1415 to the extent it exists.
1417 .Qq Ar id Ns Cm :grab_focus
1418 puts the keyboard focus onto the button.
1420 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1421 makes the button grayed out
1426 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1429 the button, or makes it visible
1432 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1438 Initially, the button is unblocked.
1440 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1441 sets the button's tooltip.
1442 Default is disabling the tooltip.
1444 .Qq Ar id Ns Cm :force
1445 simulates fresh selection of the currently selected pathname.
1447 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1448 writes a snapshot of the button to an image file of the specified
1451 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1452 sets the button's minimum size to
1456 Default is the widget's natural size.
1460 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1469 .Qq Ar id Ns Cm \&:file Ar pathname
1470 if the selection has changed.
1473 .Ss GtkFileChooserDialog
1475 .Cm GtkFileChooserDialog
1478 will be invoked by a
1481 .Sx GtkImageMenuItem
1483 .Ar foo Ns Cm _invoke .
1486 .Cm GtkFileChooserDialog
1493 if the dialog is the sole window of the GUI and therefore named
1498 .Cm GtkFileChooserDialog
1503 .Ar foo Ns Cm _cancel
1505 if the dialog is the sole window of the GUI and therefore named
1510 .Cm GtkFileChooserDialog
1515 .Ar foo Ns Cm _apply
1517 if the dialog is the sole window of the GUI and therefore named
1520 .Bl -tag -width indent
1524 .Qq Ar id Ns Cm :set_filename Ar path
1527 to the extent it exists.
1529 .Qq Ar id Ns Cm :set_current_name Ar string
1532 the suggested filename, which may not yet exist.
1534 should either resemble an absolute path, or the
1536 must be set separately by
1537 .Ar id Ns Cm :set_filename Ar directory .
1539 .Qq Ar id Ns Cm :set_title Ar string
1540 replaces the text in the title bar with
1543 .Qq Ar id Ns Cm :resize Bq Ar width height
1544 changes the size of the dialog window to
1548 pixels if specified, or to the default size.
1550 .Qq Ar id Ns Cm :move Ar x y
1551 moves the dialog window to position
1554 .Qq Ar id Ns Cm :fullscreen
1556 .Qq Ar id Ns Cm :unfullscreen
1557 switch fullscreen mode on and off.
1559 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1560 makes the dialog grayed out
1565 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1568 the dialog, or makes it visible
1571 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1576 feedback messages form the dialog window.
1577 Initially, the widget is unblocked.
1579 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1580 sets the dialog window's tooltip.
1581 Default is disabling the tooltip.
1583 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1584 writes a snapshot of the widget to an image file of the specified
1587 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1588 sets the widget's minimum size to
1592 Default is the widget's natural size.
1596 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1598 sets the widget style.
1605 .Qq Ar id Ns Cm \&:file Ar pathname
1607 .Qq Ar id Ns Cm \&:folder Ar pathname
1609 .Qq Ar id Ns Cm \&:closed
1611 .Cm GtkFileChooserDialog
1612 window was closed by the window manager.
1616 .Bl -tag -width indent
1620 .Qq Ar id Ns Cm :set_font_name Ar fontname
1621 preselects the font.
1623 .Qq Ar id Ns Cm :grab_focus
1624 puts the keyboard focus onto the button.
1626 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1627 makes the button grayed out
1632 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1635 the button, or makes it visible
1638 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1644 Initially, the button is unblocked.
1646 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1647 sets the button's tooltip.
1648 Default is disabling the tooltip.
1650 .Qq Ar id Ns Cm :force
1651 opens the dialog window.
1653 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1654 writes a snapshot of the button to an image file of the specified
1657 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1658 sets the button's minimum size to
1662 Default is the button's natural size.
1666 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1675 .Qq Ar id Ns Cm \&:font Ar fontname
1679 .Bl -tag -width indent
1683 .Qq Ar id Ns Cm :set_label Ar text
1684 replaces the frame label text with
1687 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1688 makes the frame and its content grayed out
1693 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1696 the frame, or makes it visible
1699 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1700 sets the frame's tooltip.
1701 Default is disabling the tooltip.
1703 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1704 writes a snapshot of the frame to an image file of the specified
1707 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1708 sets the widget's minimum size to
1712 Default is the frame's natural size.
1716 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1729 .Bl -tag -width indent
1733 .Qq Ar id Ns Cm :set_from_icon_name Ar icon-name
1734 replaces the image with one of the standard icons.
1736 .Qq Ar id Ns Cm :set_from_file Ar path
1737 replaces the image by the one found at
1740 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1743 the image, or makes it visible
1746 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1747 sets the image's tooltip.
1748 Default is disabling the tooltip.
1750 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1751 writes a snapshot of the image to an image file of the specified
1754 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1755 sets the images's minimum size to
1759 Default is the image's natural size.
1763 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1776 .Bl -tag -width indent
1780 .Qq Ar id Ns Cm :popup ,
1781 .Qq Ar id Ns Cm :popdown
1782 displays the menu at mouse position or closes it, respectively.
1784 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1785 makes the menu grayed out
1790 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1791 sets the menu's tooltip.
1792 Default is disabling the tooltip.
1794 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1795 writes a snapshot of the (popped-up) menu to an image file of the
1798 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1799 sets the menu's minimum size to
1803 Default is the menu's natural size.
1807 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1809 sets the menu's style.
1820 .Bl -tag -width indent
1824 .Qq Ar id Ns Cm :grab_focus
1825 puts the keyboard focus onto the button.
1827 .Qq Ar id Ns Cm :force
1828 simulates a click onto the button.
1830 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1831 makes the button grayed out
1836 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1839 the button, or makes it visible
1842 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1843 sets the button's tooltip.
1844 Default is disabling the tooltip.
1846 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
1847 writes a snapshot of the button to an image file of the specified
1850 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1851 sets the button's minimum size to
1855 Default is the button's natural size.
1859 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1861 sets the button's style.
1871 .Ss GtkImageMenuItem
1872 .Cm GtkImageMenuItem
1874 .Bl -tag -width indent
1878 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1879 makes the item grayed out
1884 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1887 the item, or makes it visible
1890 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1896 Initially, the item is unblocked.
1898 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1899 sets the item's tooltip.
1900 Default is disabling the tooltip.
1902 .Qq Ar id Ns Cm :force
1903 simulates a click on the menu item.
1905 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1906 sets the item's minimum size to
1910 Default is the item's natural size.
1914 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1916 sets the item's style.
1924 .Cm GtkImageMenuItem
1926 .Ar foo Ns Cm _invoke
1930 .Sx GtkFileChooserDialog
1934 If there isn't any dialog attached to the
1935 .Cm GtkImageMenuItem ,
1937 .Qq Ar id Ns Cm \&:active Ar label .
1941 .Bl -tag -width indent
1945 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1946 makes the info bar grayed out
1951 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1954 the info bar, or makes it visible
1957 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1958 sets the info bar's tooltip.
1959 Default is disabling the tooltip.
1961 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1962 sets the info bar's minimum size to
1966 Default is the info bar's natural size.
1970 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1983 .Bl -tag -width indent
1987 .Qq Ar id Ns Cm :set_text Ar string
1988 replaces the label text with
1991 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1992 makes the label grayed out
1997 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2000 the label, or makes it visible
2003 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2004 sets the label's tooltip.
2005 Default is disabling the tooltip.
2007 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2008 writes a snapshot of the label to an image file of the specified
2011 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2012 sets the label's minimum size to
2016 Default is the natural size.
2020 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2022 sets the label's style.
2033 .Bl -tag -width indent
2037 .Qq Ar id Ns Cm :set_visited Brq Cm 0 Ns | Ns Cm 1
2038 gives the button text the appearance of an unvisited
2039 .Pq Cm 0 , No default
2044 .Qq Ar id Ns Cm :set_label Ar string
2045 replaces the button text with
2048 .Qq Ar id Ns Cm :grab_focus
2049 puts the keyboard focus onto the button.
2051 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2052 makes the button grayed out
2057 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2060 the button, or makes it visible
2063 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2069 Initially, the button is unblocked.
2071 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2072 sets the button's tooltip.
2073 Default is disabling the tooltip.
2075 .Qq Ar id Ns Cm :force
2076 simulates a click on the button.
2078 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2079 writes a snapshot of the button to an image file of the specified
2082 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2083 sets the button's minimum size to
2087 Default is the button's natural size.
2091 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2100 .Qq Ar id Ns Cm \&:clicked
2104 .Bl -tag -width indent
2108 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2109 makes the menu bar grayed out
2114 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2117 the menu bar, or makes it visible
2120 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2121 sets the menu bar's tooltip.
2122 Default is disabling the tooltip.
2124 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2125 sets the menu bar's minimum size to
2129 Default is its natural size.
2133 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2135 sets the menu bar's style.
2146 .Bl -tag -width indent
2150 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2151 makes the item grayed out
2156 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2159 the item, or makes it visible
2162 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2168 Initially, the item is unblocked.
2170 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2171 sets the item's tooltip.
2172 Default is disabling the tooltip.
2174 .Qq Ar id Ns Cm :force
2175 simulates a click on the menu item.
2177 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2178 sets the item's minimum size to
2182 Default is the item's natural size.
2186 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2188 sets the item's style.
2198 .Ar foo Ns Cm _invoke
2202 .Sx GtkFileChooserDialog
2206 If there isn't any dialog attached to the
2209 .Qq Ar id Ns Cm \&:active Ar label .
2213 .Bl -tag -width indent
2217 .Qq Ar id Ns Cm :set_current_page Ar n
2218 switches to zero-based page number
2221 .Qq Ar id Ns Cm :grab_focus
2222 puts the keyboard focus onto the notebook.
2224 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2225 makes the notebook grayed out
2230 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2233 the notebook, or makes it visible
2236 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2237 sets the notebook's tooltip.
2238 Default is disabling the tooltip.
2240 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2241 writes a snapshot of the notebook to an image file of the specified
2244 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2245 sets the notebooks's minimum size to
2249 Default is the widget's natural size.
2253 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2255 sets the notebook's style.
2266 .Bl -tag -width indent
2270 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2271 makes the overlay grayed out
2276 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2279 the overlay, or makes it visible
2282 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2283 sets the overlay's tooltip.
2284 Default is disabling the tooltip.
2286 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2287 writes a snapshot of the overlay to an image file of the specified
2290 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2291 sets the overlay's minimum size to
2295 Default is the overlay's natural size.
2299 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2312 .Bl -tag -width indent
2316 .Qq Ar id Ns Cm :grab_focus
2317 puts the keyboard focus onto the handle.
2319 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2320 makes the widget grayed out
2325 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2328 the widget, or makes it visible
2331 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2332 sets the widget's tooltip.
2333 Default is disabling the tooltip.
2335 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2336 writes a snapshot of the widget to an image file of the specified
2339 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2340 sets the widget's minimum size to
2344 Default is the widget's natural size.
2348 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2361 The main window can be turned into a
2363 and embedded into the XEmbed socket of another process; see
2367 .Ss GtkPrintUnixDialog
2368 .Bl -tag -width indent
2372 .Qq Ar id Ns Cm :print Ar file.ps
2373 opens the print dialog.
2378 to the printer the user selected in the dialog.
2380 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2381 makes the dialog grayed out
2386 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2389 the dialog, or makes it visible
2392 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2398 Initially, the dialog is unblocked.
2400 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2401 sets the dialog's tooltip.
2402 Default is disabling the tooltip.
2404 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2405 writes a snapshot of the dialog to an image file of the specified
2408 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2409 sets the dialog's minimum size to
2413 Default is the dialog's natural size.
2417 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2419 sets the widget style.
2426 .Qq Ar id Ns Cm \&:closed
2428 .Cm GtkPrintUnixDialog
2429 window was closed by the window manager.
2433 .Bl -tag -width indent
2437 .Qq Ar id Ns Cm :set_fraction Ar x
2438 moves the progress bar to
2440 .Pq between 0 and 1 .
2442 .Qq Ar id Ns Cm :set_text Bq Ar string
2443 replaces the text of the progress bar with
2445 Default is the progress percentage.
2447 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2450 the progress bar, or makes it visible
2453 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2454 sets the tooltip of the progressbar.
2455 Default is disabling the tooltip.
2457 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2458 writes a snapshot of the progress bar to an image file of the
2461 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2462 sets the minimum size of the progress bar to
2466 Default is the natural size.
2470 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2483 .Bl -tag -width indent
2487 .Qq Ar id Ns Cm :set_active 1
2488 switches the button on.
2489 All other buttons of the same group will go off automatically.
2491 .Qq Ar id Ns Cm :set_label Ar string
2492 replaces the button text with
2495 .Qq Ar id Ns Cm :grab_focus
2496 puts the keyboard focus onto the button.
2498 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2499 makes the button grayed out
2504 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2507 the button, or makes it visible
2510 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2516 Initially, the button is unblocked.
2518 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2519 sets the button's tooltip.
2520 Default is disabling the tooltip.
2522 .Qq Ar id Ns Cm :force
2523 simulates a click on the button.
2525 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2526 writes a snapshot of the button to an image file of the specified
2529 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2530 sets the button's minimum size to
2534 Default is the button's natural size.
2538 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2547 .Qq Ar id Ns Cm \&:1
2549 .Qq Ar id Ns Cm \&:0
2554 .Bl -tag -width indent
2558 .Qq Ar id Ns Cm :set_value Ar x
2559 moves the slider to value
2562 .Qq Ar id Ns Cm :set_fill_level Bq Ar x
2563 moves the fill level indicator to value
2565 Default is hiding the fill level indicator.
2567 .Qq Ar id Ns Cm :set_range Ar min max
2570 .Qq Ar id Ns Cm :set_increments Ar step page
2571 sets the steps the slider moves while pressing arrow keys and
2573 .Pf / Ql Page_Down ,
2576 .Qq Ar id Ns Cm :grab_focus
2577 puts the keyboard focus onto the scale.
2579 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2580 makes the scale grayed out
2585 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2588 the scale, or makes it visible
2591 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2597 Initially, the scale is unblocked.
2599 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2600 sets the scale's tooltip.
2601 Default is disabling the tooltip.
2603 .Qq Ar id Ns Cm :force
2604 simulates fresh selection of the current value.
2606 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2607 writes a snapshot of the scale to an image file of the specified
2610 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2611 sets the scale's minimum size to
2615 Default is the natural size.
2619 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2628 .Qq Ar id Ns Cm \&:value Ar number
2631 .Ss GtkScrolledWindow
2632 .Bl -tag -width indent
2636 .Qq Ar id Ns Cm :hscroll Ar position
2638 .Qq Ar id Ns Cm :vscroll Ar position
2641 to the left or top edge of the
2642 .Cm GtkScrolledWindow ,
2645 .Qq Ar id Ns Cm :hscroll_to_range Ar pos0 pos1
2647 .Qq Ar id Ns Cm :vscroll_to_range Ar pos0 pos1
2648 scroll, if necessary, the range between
2653 .Cm GtkScrolledWindow .
2654 If the range is greater than the window, the initial part of the range
2657 .Qq Ar id Ns Cm :grab_focus
2658 puts the keyboard focus onto the widget.
2660 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2661 makes the widget grayed out
2666 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2669 the widget, or makes it visible
2672 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2673 sets the widget's tooltip.
2674 Default is disabling the tooltip.
2676 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2677 writes a snapshot of the widget to an image file of the specified
2680 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2681 sets the minimum size to
2685 Default is the widget's natural size.
2689 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2702 .Bl -tag -width indent
2706 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2707 makes the separator insensitive
2712 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2713 sets the tooltip of the separator.
2714 Default is disabling the tooltip.
2716 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2719 the separator, or makes it visible
2722 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2723 writes a snapshot of the separator to an image file of the specified
2726 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2727 sets the minimum size to
2731 Default is the natural size of the separator.
2735 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2737 sets the widget style.
2747 .Ss GtkSeparatorMenuItem
2748 .Bl -tag -width indent
2752 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2753 makes the menu item insensitive
2758 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2761 the menu item, or makes it visible
2764 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2765 sets the tooltip of the menu item.
2766 Default is disabling the tooltip.
2768 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2769 writes a snapshot of the menu item to an image file of the specified
2772 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2773 sets the minimum size to
2777 Default is the natural size of the menu item.
2781 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2783 sets the widget style.
2794 .Bl -tag -width indent
2808 may be unsupported by Glade, but its definition can be inserted
2809 manually into the GtkBuilder
2812 .Bd -literal -offset indent
2814 <object class="GtkSocket" id="socket1">
2815 <property name="visible">True</property>
2816 <property name="can_focus">True</property>
2819 <property name="expand">True</property>
2820 <property name="fill">True</property>
2821 <property name="position">1</property>
2825 .Bl -tag -width indent
2830 requests a feedback message containing the socket
2833 .Qq Ar id Ns Cm :grab_focus
2834 puts the keyboard focus onto the socket.
2836 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2837 makes the socket grayed out
2842 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2845 the socket, or makes it visible
2848 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2849 sets the socket's tooltip.
2850 Default is disabling the tooltip.
2851 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2852 writes a snapshot of the socket to an image file of the specified
2855 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2856 sets the socket's minimum size to
2860 Default is the socket's natural size.
2864 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2873 .Qq Ar id Ns Cm :id Ar xid
2874 can be used by another process to XEmbed its widgets into the
2877 .Qq Ar id Ns Cm \&:plug-added ,
2879 .Ar id Ns Cm \&:plug-removed
2881 Notification that the other process has inserted its widgets into or
2882 removed them from the
2887 .Bl -tag -width indent
2891 .Qq Ar id Ns Cm :set_text Ar string
2892 sets the selected value to
2895 .Qq Ar id Ns Cm :set_range Ar min max
2898 .Qq Ar id Ns Cm :set_increments Ar step page
2899 sets the steps the value changes while pressing arrow keys/left mouse
2902 .Pf / Ql Page_Down Ns
2903 /middle mouse button,
2906 .Qq Ar id Ns Cm :grab_focus
2907 puts the keyboard focus onto the button.
2909 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2910 makes the button grayed out
2915 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2918 the button, or makes it visible
2921 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2927 Initially, the button is unblocked.
2929 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2930 sets the button's tooltip.
2931 Default is disabling the tooltip.
2933 .Qq Ar id Ns Cm :force
2934 simulates fresh selection of the current value
2936 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2937 writes a snapshot of the button to an image file of the specified
2940 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2941 sets the button's minimum size to
2945 Default is the widget's natural size.
2949 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2951 sets the button's style.
2958 .Qq Ar id Ns Cm \&:text Ar text
2962 .Bl -tag -width indent
2966 .Qq Ar id Ns Cm :start
2968 .Qq Ar id Ns Cm :stop
2969 start and stop the spinner.
2971 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2972 makes the spinner grayed out
2977 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2980 the spinner, or makes it visible
2983 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2984 sets the spinner's tooltip.
2985 Default is disabling the tooltip.
2987 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
2988 writes a snapshot of the spinner to an image file of the specified
2991 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2992 sets the spinner's minimum size to
2996 Default is the natural size.
3000 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3013 The context parameter
3015 is an arbitrary non-whitespace string.
3016 .Bl -tag -width indent
3020 .Qq Ar id Ns Cm :push_id Ar c string ,
3021 .Qq Ar id Ns Cm :push Ar string
3024 with context parameter
3028 respectively, and display it in the statusbar.
3030 .Qq Ar id Ns Cm :pop_id Ar c ,
3031 .Qq Ar id Ns Cm :pop
3032 remove the latest entry associated with context parameter
3036 respectively, from the statusbar.
3038 .Qq Ar id Ns Cm :remove_all_id Ar c ,
3039 .Qq Ar id Ns Cm :remove_all
3040 remove the entries associated with context parameter
3044 respectively, from the statusbar.
3046 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3047 makes the statusbar grayed out
3052 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3055 the statusbar, or makes it visible
3058 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3059 sets the statusbar's tooltip.
3060 Default is disabling the tooltip.
3062 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
3063 writes a snapshot of the statusbar to an image file of the specified
3066 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3067 sets the statusbar's minimum size to
3071 Default is the natural size.
3075 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3077 sets the statusbar's style.
3088 .Bl -tag -width indent
3092 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
3093 turns the switch off
3098 .Qq Ar id Ns Cm :grab_focus
3099 puts the keyboard focus onto the switch.
3101 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3102 makes the switch grayed out
3107 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3110 the switch, or makes it visible
3113 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3119 Initially, the switch is unblocked.
3121 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3122 sets the tooltip of the switch.
3123 Default is disabling the tooltip.
3125 .Qq Ar id Ns Cm :force
3126 simulates a click on the switch.
3128 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
3129 writes a snapshot of the switch to an image file of the specified
3132 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3133 sets the switch's minimum size to
3137 Default is the natural size.
3141 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3150 .Qq Ar id Ns Cm \&:1
3152 .Qq Ar id Ns Cm \&:0
3157 There should be a dedicated
3159 for sending (parts of) the text.
3167 .Ar foo Ns Cm _send_text
3168 will send the content of the
3173 .Ar foo Ns Cm _send_selection
3174 will send the highlighted part the
3176 .Bl -tag -width indent
3180 .Qq Ar id Ns Cm :set_text Ar string
3181 replaces the user-editable text with (potentially empty)
3184 .Qq Ar id Ns Cm :delete
3187 .Qq Ar id Ns Cm :insert_at_cursor Ar string
3192 .Qq Ar id Ns Cm :place_cursor Brq Ar position | Cm end
3193 places the text cursor at
3195 or at the end of the text.
3197 .Qq Ar id Ns Cm :place_cursor_at_line Ar line
3198 places the text cursor at the beginning of
3201 .Qq Ar id Ns Cm :scroll_to_cursor
3202 scrolls to the cursor position if necessary.
3204 .Qq Ar id Ns Cm :save Ar file
3209 command containing the text.
3211 .Qq Ar id Ns Cm :grab_focus
3212 puts the keyboard focus into the textview.
3214 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3215 makes the text view grayed out
3220 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3223 the text view, or makes it visible
3226 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3227 sets the tooltip of the text view.
3228 Default is disabling the tooltip.
3230 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
3231 writes a snapshot of the text view to an image file of the specified
3234 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3235 sets the minimum size to
3239 Default is the natural size.
3243 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3252 .Qq Ar button_id Ns Cm \&:text Ar text ,
3260 and backslashes are replaced by
3265 .Bl -tag -width indent
3269 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
3270 switches the button off
3275 .Qq Ar id Ns Cm :set_label Ar string
3276 replaces the button text with
3279 .Qq Ar id Ns Cm :grab_focus
3280 puts the keyboard focus onto the button.
3282 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3283 makes the button grayed out
3288 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3291 the button, or makes it visible
3294 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3300 Initially, the button is unblocked.
3302 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3303 sets the button's tooltip.
3304 Default is disabling the tooltip.
3306 .Qq Ar id Ns Cm :force
3307 simulates a click on the button.
3309 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
3310 writes a snapshot of the button to an image file of the specified
3313 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3314 sets the button's minimum size to
3318 Default is the button's natural size.
3322 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3324 sets the button's style.
3331 .Qq Ar id Ns Cm \&:1
3333 .Qq Ar id Ns Cm \&:0
3339 can deal with columns of type
3340 .Cm gboolean , gint , guint , glong , gulong , gint64 , guint64 , gfloat , gdouble ,
3347 refer to the underlying model
3350 .Cm GtkTreeStore ) .
3352 is a sequence of one or more colon-separated integers, e.g.
3356 .Bl -tag -width indent
3360 .Qq Ar id Ns Cm :set Ar row column data
3361 replaces the content at
3365 (which should be compatible with the type of
3367 If necessary, new tree nodes are created to obtain the minimal tree
3368 structure needed to support
3371 .Qq Ar id Ns Cm :insert_row Brq Ar row Bo Cm as_child Bc | Cm end
3372 inserts a new, empty row; either as a sibling of
3378 or at the end of the list, respectively.
3380 .Qq Ar id Ns Cm :move_row Ar origin Brq Ar destination | Cm end
3383 within its current level to
3387 .Qq Ar id Ns Cm :remove_row Ar row
3388 removes the row at position
3391 .Qq Ar id Ns Cm :clear
3394 .Qq Ar id Ns Cm :expand Ar row
3395 expands one level of the subtree below
3398 .Qq Ar id Ns Cm :expand_all Bq Ar row
3399 expands the subtree below
3403 .Qq Ar id Ns Cm :collapse Bq Ar row
3404 collapses the subtree below
3408 .Qq Ar id Ns Cm :set_cursor Bq Ar row
3413 .Qq Ar id Ns Cm :scroll Ar row column
3418 .Qq Ar id Ns Cm :save Ar file
3419 stores the content of the underlying model as a sequence of
3424 .Qq Ar id Ns Cm :grab_focus
3425 puts the keyboard focus onto the tree view.
3427 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3428 makes the tree view grayed out
3433 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3436 the tree view, or makes it visible
3439 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3445 Initially, the widget is unblocked.
3447 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3448 sets the tooltip of the tree view.
3449 Default is disabling the tooltip.
3451 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
3452 writes a snapshot of the tree view to an image file of the specified
3455 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3456 sets the minimum size of the tree view to
3460 Default is the widget's natural size.
3464 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3473 .Qq Ar id Ns Cm \&:clicked
3475 .Qq Ar id Ns Cm \&: Ns Ar column_type row column value ,
3476 one message per cell in the underlying model for each selected row; or
3478 .Qq Ar id Ns Cm \&: Ns Ar column_type row column new_value ,
3484 .Ss GtkTreeViewColumn
3485 .Bl -tag -width indent
3489 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3495 Initially, the widget is unblocked.
3500 .Qq Ar id Ns Cm \&:clicked
3504 .Bl -tag -width indent
3508 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3509 makes the viewport insensitive
3514 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3517 the viewport, or makes it visible
3520 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3521 sets the tooltip of the viewport.
3522 Default is disabling the tooltip.
3524 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
3525 writes a snapshot of the viewport to an image file of the specified
3528 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3529 sets the minimum size to
3533 Default is the natural size of the viewport.
3537 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3539 sets the widget style.
3550 .Bl -tag -width indent
3554 .Qq Ar id Ns Cm :set_title Ar string
3555 replaces the text in the title bar with
3558 .Qq Ar id Ns Cm :resize Bq Ar width height
3559 changes the window size to
3563 pixels if specified, or to the default size.
3565 .Qq Ar id Ns Cm :move Ar x y
3566 moves the window to position
3569 .Qq Ar id Ns Cm :fullscreen
3571 .Qq Ar id Ns Cm :unfullscreen
3572 switch fullscreen mode on and off.
3574 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3575 makes the widget grayed out
3580 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3583 the widget, or makes it visible
3586 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3592 Initially, the widget is unblocked.
3594 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3595 sets the window's tooltip.
3596 Default is disabling the tooltip.
3597 .Qq Ar id Ns Cm :snapshot Ar file Ns Brq Cm .ps Ns | Ns Cm .eps Ns | Ns Cm .epsf Ns | Ns Cm .pdf Ns | Ns Cm .svg
3598 writes a snapshot of the window to an image file of the specified
3601 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3602 sets the window's minimum size to
3606 Default is the widget's natural size.
3610 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3619 .Qq Ar id Ns Cm \&:closed
3622 was closed by the window manager.
3629 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3633 of the widget style to
3635 Properties not explicitly specified are reset to their default values.
3637 .Bl -dash -offset indent -compact
3639 .Ql label1:style font:Bold 11; background-color:green
3641 .Ql label1:style font-style:italic; font-weight:bold; color:blue
3643 .Ql button1:style background-image:url("q.png")
3645 .Ql treeview1:style background-image:linear-gradient(45deg, yellow, blue);
3647 .Ql frame1:style border-color:red yellow; border-width:5px
3649 .Ql frame1:style border-radius:10px; transition:10s
3651 For color notations see
3658 .Bl -dash -offset indent -compact
3660 standard X11 colors names like
3662 .Ql Dark Sea Green ,
3668 hexadecimal values in the form
3669 .Cm # Ns Ar rgb , Cm # Ns Ar rrggbb , Cm # Ns Ar rrrgggbbb ,
3671 .Cm # Ns Ar rrrrggggbbbb ;
3673 RGB colors in the form
3674 .Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&)
3676 RGBA colors in the form
3677 .Cm rgba( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns
3678 .Ar blue Ns Cm \&, Ns Ar alpha Ns Cm \&) ;
3679 .Ar red , green , blue
3680 between 0 and 255 and
3684 color expressions like
3687 .Ql lighter(currentColor) .
3692 .Ss Discovering Pipeglade Interactively
3693 Suppose the interface in
3696 .Sx GtkLabel Ql label1
3698 .Sx GtkButton Ql button1 .
3704 .Sx GtkButton , Ql button1:clicked
3705 will be reported on the terminal.
3708 .Dl label1:set_text The Button
3710 will change the text shown on the label into
3712 .Ss One-Shot File Dialog
3713 Suppose the interface in
3714 .Pa ./simple_open.ui
3716 .Sx GtkFileChooserDialog
3724 .Dl pipeglade -u simple_open.ui
3726 will open the dialog; pressing
3728 will close it after sending the selected filename to
3730 .Ss One-Shot User Notification
3732 .Pa ./simple_dialog.ui
3734 .Sx GtkLabel Ql label1 ,
3736 .Bd -literal -offset indent
3737 pipeglade -u simple_dialog.ui <<< \e
3738 "label1:set_text NOW READ THIS!"
3740 will set the label text accordingly and wait for user input.
3741 .Ss Continuous Input
3742 The following shell command displays a running clock:
3743 .Bd -literal -offset indent
3745 echo "label1:set_text `date`";
3747 done | pipeglade -u simple_dialog.ui
3749 .Ss Continuous Input and Output
3750 The following shell script fragment sets up
3752 for continuous communication with another program,
3754 .Bd -literal -offset indent
3755 pipeglade -i in.fifo -o out.fifo -b
3756 main_prog <out.fifo >in.fifo
3769 .An Bert Burgemeister
3770 .Aq Mt trebbu@googlemail.com .
3772 Due to what appears to be a bug in cairo v1.14.0,
3774 used with this library version occasionally crashes on