1 .\" Copyright (c) 2014-2017 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 "commands "
287 .Qq Ar id Ns Cm :load Ar file
294 is required but ignored.
296 commands may be nested but on attempts to read from the same file, the
307 .Qq Ar id Ns Cm :main_quit
308 kills the user interface.
311 is required but ignored.
314 .Bl -tag -width "commands "
316 .Qq Ar id Ns Cm :set_label Ar text
317 replaces the frame label text with
320 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
321 makes the frame and its content grayed out
326 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
329 the frame, or makes it visible
332 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
333 sets the frame's tooltip.
334 Default is disabling the tooltip.
336 .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
337 writes a snapshot of the frame to an image file of the specified
340 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
341 sets the widget's minimum size to
345 Default is the frame's natural size.
349 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
355 .Qq Ar id Ns Cm :ping Bq Ar text
356 triggers a feedback message.
358 .Qq Ar id Ns Cm :ping Ar text
364 .Bl -tag -width "commands "
366 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
367 makes the box grayed out
372 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
375 the box, or makes it visible
377 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
378 sets the box's tooltip.
379 Default is disabling the tooltip.
381 .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
382 writes a snapshot of the box to an image file of the specified
385 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
386 sets the box's minimum size to
390 Default is the box's natural size.
394 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
400 .Qq Ar id Ns Cm :ping Bq Ar text
401 triggers a feedback message.
403 .Qq Ar id Ns Cm :ping Ar text
409 .Bl -tag -width "commands "
411 .Qq Ar id Ns Cm :set_label Ar string
412 replaces the button text with
415 .Qq Ar id Ns Cm :grab_focus
416 puts the keyboard focus onto the button.
418 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
419 makes the button grayed out
424 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
427 the button, or makes it visible
430 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
436 Initially, the button is unblocked.
438 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
439 sets the button's tooltip.
440 Default is disabling the tooltip.
442 .Qq Ar id Ns Cm :force
443 simulates a click on the button.
445 .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
446 writes a snapshot of the button to an image file of the specified
449 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
450 sets the button's minimum size to
454 Default is the button's natural size.
458 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
464 .Qq Ar id Ns Cm :ping Bq Ar text
465 triggers a feedback message.
467 .Qq Ar id Ns Cm \&:clicked
471 .Cm _ok , _apply , _cancel , _send_text ,
474 may work differently; see
475 .Sx GtkDialog , GtkFileChooserDialog ,
480 .Qq Ar id Ns Cm :ping Ar text
486 .Bl -tag -width "commands "
488 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
489 makes the box grayed out
494 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
497 the box, or makes it visible
500 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
501 sets the box's tooltip.
502 Default is disabling the tooltip.
504 .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
505 writes a snapshot of the box to an image file of the specified
508 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
509 sets the box's minimum size to
513 Default is the box's natural size.
517 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
523 .Qq Ar id Ns Cm :ping Bq Ar text
524 triggers a feedback message.
526 .Qq Ar id Ns Cm :ping Ar text
532 .Bl -tag -width "commands "
534 .Qq Ar id Ns Cm :select_date Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
535 selects the date on the calendar.
537 .Qq Ar id Ns Cm :mark_day Ar day
542 .Qq Ar id Ns Cm :clear_marks
543 unmarks all days on the calendar.
545 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
546 makes the calendar grayed out
551 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
554 the calendar, or makes it visible
557 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
563 Initially, the calendar is unblocked.
565 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
566 sets the calendar's tooltip.
567 Default is disabling the tooltip.
569 .Qq Ar id Ns Cm :force
570 simulates a click on the currently selected date.
572 .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
573 writes a snapshot of the calendar to an image file of the specified
576 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
577 sets the calendar's minimum size to
581 Default is the widget's natural size.
585 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
587 sets the calendar's style.
591 .Qq Ar id Ns Cm :ping Bq Ar text
592 triggers a feedback message.
594 .Qq Ar id Ns Cm \&:clicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
596 .Qq Ar id Ns Cm \&:doubleclicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
598 .Qq Ar id Ns Cm :ping Ar text
604 .Bl -tag -width "commands "
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.
665 .Qq Ar id Ns Cm :ping Bq Ar text
666 triggers a feedback message.
673 .Qq Ar id Ns Cm :ping Ar text
679 .Bl -tag -width "commands "
681 .Qq Ar id Ns Cm :set_color Ar color
682 preselects the color; see
685 .Qq Ar id Ns Cm :grab_focus
686 puts the keyboard focus onto the button.
688 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
689 makes the button grayed out
694 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
697 the button, or makes it visible
700 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
706 Initially, the button is unblocked.
708 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
709 sets the button's tooltip.
710 Default is disabling the tooltip.
712 .Qq Ar id Ns Cm :force
713 opens the dialog window.
715 .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
716 writes a snapshot of the button to an image file of the specified
719 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
720 sets the button's minimum size to
724 Default is the widget's natural size.
728 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
730 sets the button's style.
734 .Qq Ar id Ns Cm :ping Bq Ar text
735 triggers a feedback message.
737 .Qq Ar id Ns Cm \&:color Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&)
739 .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 \&) .
743 lie between 0 and 255, and
747 .Qq Ar id Ns Cm :ping Ar text
757 .Bl -tag -width "commands "
759 .Qq Ar id Ns Cm :prepend_text Ar string
761 .Qq Ar id Ns Cm :append_text Ar string
762 prepend/append a new selectable item marked
765 .Qq Ar id Ns Cm :insert_text Ar position string
771 .Qq Ar id Ns Cm :remove Ar position
775 .Qq Ar id Ns Cm :grab_focus
776 puts the keyboard focus onto the combo box.
778 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
779 makes the combo box grayed out
784 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
787 the combo box, or makes it visible
790 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
796 Initially, the combo box is unblocked.
798 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
800 Default is disabling the tooltip.
802 .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
803 writes a snapshot of the combo box to an image file of the specified
806 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
807 sets the combo box's minimum size to
811 Default is the natural size.
815 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
821 .Qq Ar id Ns Cm :ping Bq Ar text
822 triggers a feedback message.
824 .Qq Ar entry_id Ns Cm \&:text Ar text ,
826 being the id of the child
829 .Qq Ar id Ns Cm :ping Ar text
844 .Ar foo Ns Cm _invoke .
852 .Ar foo Ns Cm _cancel
854 if the dialog is the sole window of the GUI and therefore named
865 it will take care of hiding the dialog window.
866 .Bl -tag -width "commands "
868 .Qq Ar id Ns Cm :set_title Ar string
869 replaces the text in the title bar with
872 .Qq Ar id Ns Cm :resize Bq Ar width height
873 changes the size of the dialog window to
877 pixels if specified, or to the default size.
879 .Qq Ar id Ns Cm :move Ar x y
880 moves the dialog window to position
883 .Qq Ar id Ns Cm :fullscreen
885 .Qq Ar id Ns Cm :unfullscreen
886 switch fullscreen mode on and off.
888 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
889 makes the dialog grayed out
894 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
897 the dialog, or makes it visible
900 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
905 feedback messages from the dialog window.
906 Initially, the window is unblocked.
908 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
909 sets the dialog window's tooltip.
910 Default is disabling the tooltip.
912 .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
913 writes a snapshot of the dialog window to an image file of the
916 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
917 sets the dialog window's minimum size to
921 Default is its natural size.
925 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
927 sets the dialog window's style.
931 .Qq Ar id Ns Cm :ping Bq Ar text
932 triggers a feedback message.
934 .Qq Ar id Ns Cm \&:closed
937 window was closed by the window manager.
939 .Qq Ar id Ns Cm :ping Ar text
946 expect a context parameter of the form
947 .Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
950 is an arbitrary non-negative integer that can be used later to
951 reference the command.
954 appends its command to the current list of drawing operations.
957 replaces the first drawing operation with context parameter
961 .Ar n Ns Cm < Ns Ar m ,
962 inserts its command before the first drawing operation with context
965 Both second and third form fall back to appending.
967 The default coordinate system is a left-handed system with its origin
968 in the upper-left corner.
969 Angles increase from the positive X axis towards the positve Y axis
970 .Pq clockwise in the default system .
971 .Bl -tag -width "commands "
973 .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
974 adds a circular arc to the current path.
975 The arc is centered at
983 .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
984 adds a circular arc to the current path.
985 The arc is centered at
987 and proceeds in the direction of decreasing angles from
993 .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
994 adds a line segment from the current point to the point most recently
996 .Ar id Ns Cm :move_to
998 .Ar id Ns Cm :rel_move_to .
1000 .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
1001 adds a cubic Bezier spline from the current point to
1008 If there is no current point, the curve will start at
1011 .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
1012 fills the current path and clears it.
1014 .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
1015 fills the current path without clearing it.
1017 .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
1018 adds a line from the current point to
1020 or creates a new current point at
1023 .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
1024 sets the current point to
1027 .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
1028 adds a rectangle to the current path.
1029 The top left corner is at
1032 .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
1033 adds a cubic Bezier spline from the current point to
1040 All coordinates are offsets relative to the current point.
1042 .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
1043 adds a line from the current point to a point offset from there by
1046 .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
1047 .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
1050 moves the current point such that
1051 .Qq Ar id Ns Cm :show_text Ar n text
1052 will place the specified reference point of
1054 on the original current point.
1056 .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
1057 moves the current point by
1060 .Qq Ar id Ns Cm :remove Ar n
1061 removes the elements with context parameter
1064 .Cm GtkDrawingArea Ar id .
1066 .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
1067 rotates the user space axes by
1071 .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
1072 scales the user space axes by
1075 .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
1076 sets the dash pattern to
1082 .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 ...
1083 resets the dash pattern to a line with arbitrary on/off portions.
1085 .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
1086 resets the dash pattern to a solid line.
1088 .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
1089 .Brq Cm normal | italic | oblique
1090 .Brq Cm normal | bold
1093 sets the font face for subsequent calls of
1094 .Ar id Ns Cm :show_text .
1096 .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
1097 sets the font size for subsequent calls of
1098 .Ar id Ns Cm :show_text .
1100 .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
1101 sets the line cap style.
1105 .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
1106 sets the line junction style.
1110 .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
1111 sets the line width.
1116 .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
1120 .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
1123 beginning at the current point.
1125 .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
1126 strokes the current path and clears it.
1128 .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
1129 strokes the current path without clearing it.
1131 .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
1132 modifies the current transformation matrix such that
1134 .Dl Va x' Li = Ar xx Va x Li + Ar xy Va y Li + Ar x0 ,
1135 .Dl Va y' Li = Ar yx Va y Li + Ar yy Va y Li + Ar y0 .
1137 Default is resetting the current transformation matrix.
1139 .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
1140 translates the user space origin by
1143 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1146 the drawing area, or makes it visible
1149 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1150 sets the drawing area's tooltip.
1151 Default is disabling the tooltip.
1153 .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
1154 writes a snapshot of the drawing area to an image file of the specified
1157 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1158 sets the drawing areas's minimum size to
1162 Default is the natural size.
1164 .Qq Ar id Ns Cm :ping Bq Ar text
1165 triggers a feedback message.
1167 .Qq Ar id Ns Cm :ping Ar text
1173 .Bl -tag -width "commands "
1175 .Qq Ar id Ns Cm :set_text Ar string
1176 replaces the user-editable text with
1179 .Qq Ar id Ns Cm :set_placeholder_text Ar string
1182 that is displayed when the entry is empty and unfocused.
1184 .Qq Ar id Ns Cm :grab_focus
1185 puts the keyboard focus into the entry.
1187 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1188 makes the entry grayed out
1193 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1196 the entry, or makes it visible
1199 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1205 Initially, the entry is unblocked.
1207 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1208 sets the entry's tooltip.
1209 Default is disabling the tooltip.
1211 .Qq Ar id Ns Cm :force
1212 lets the entry report its current content.
1214 .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
1215 writes a snapshot of the entry to an image file of the specified
1218 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1219 sets the entry's minimum size to
1223 Default is the entry's natural size.
1227 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1233 .Qq Ar id Ns Cm :ping Bq Ar text
1234 triggers a feedback message.
1236 .Qq Ar id Ns Cm \&:text Ar text ,
1237 once for each change of
1240 .Qq Ar id Ns Cm :ping Ar text
1247 are mouse pointer coordinates relative to the
1249 .Bl -tag -width "commands "
1251 .Qq Ar id Ns Cm :grab_focus
1252 puts the keyboard focus onto the event box.
1254 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1255 makes the event box insensitive
1260 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1266 Initially, the event box is unblocked.
1268 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1269 sets the tooltip of the event box.
1270 Default is disabling the tooltip.
1272 .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
1273 writes a snapshot of the event box to an image file of the specified
1276 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1277 sets the minimum size to
1281 Default is the natural size of the event box.
1285 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1287 sets the widget style.
1291 .Qq Ar id Ns Cm :ping Bq Ar text
1292 triggers a feedback message.
1294 .Qq Ar id Ns Cm \&:button_press Ar b x y ,
1295 .Qq Ar id Ns Cm \&:button_release Ar b x y
1298 is the mouse button (normally 1, 2, or 3 for the left, middle, and
1299 right button; others may exist).
1301 .Qq Ar id Ns Cm \&:motion Ar x y
1302 is reported repeatedly while the mouse is being moved with a button
1305 .Qq Ar id Ns Cm \&:key_press Ar key ,
1307 being the key's name
1314 .Qq Ar id Ns Cm :ping Ar text
1320 .Bl -tag -width "commands "
1322 .Qq Ar id Ns Cm :set_label Ar string
1323 replaces the expander label text with
1326 .Qq Ar id Ns Cm :set_expanded Brq Cm 0 Ns | Ns 1
1329 the child widget, or makes it visible
1332 .Qq Ar id Ns Cm :grab_focus
1333 puts the keyboard focus onto the expander.
1335 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1336 makes the expander grayed out
1341 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1344 the expander, or makes it visible
1347 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1348 sets the expander's tooltip.
1349 Default is disabling the tooltip.
1351 .Qq Ar id Ns Cm :force
1352 toggles the expansion state.
1354 .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
1355 writes a snapshot of the expander to an image file of the specified
1358 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1359 sets the expander's minimum size to
1363 Default is the natural size.
1367 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1373 .Qq Ar id Ns Cm :ping Bq Ar text
1374 triggers a feedback message.
1376 .Qq Ar id Ns Cm :ping Ar text
1382 .Bl -tag -width "commands "
1384 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1387 the grid, or makes it visible
1389 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1390 sets the grid's tooltip.
1391 Default is disabling the tooltip.
1393 .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
1394 writes a snapshot of the grid to an image file of the specified
1397 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1398 sets the grid's minimum size to
1402 Default is the grid's natural size.
1406 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1412 .Qq Ar id Ns Cm :ping Bq Ar text
1413 triggers a feedback message.
1415 .Qq Ar id Ns Cm :ping Ar text
1420 .Ss GtkFileChooserButton
1421 .Bl -tag -width "commands "
1423 .Qq Ar id Ns Cm :set_filename Ar path
1426 to the extent it exists.
1428 .Qq Ar id Ns Cm :grab_focus
1429 puts the keyboard focus onto the button.
1431 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1432 makes the button grayed out
1437 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1440 the button, or makes it visible
1443 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1449 Initially, the button is unblocked.
1451 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1452 sets the button's tooltip.
1453 Default is disabling the tooltip.
1455 .Qq Ar id Ns Cm :force
1456 simulates fresh selection of the currently selected pathname.
1458 .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
1459 writes a snapshot of the button to an image file of the specified
1462 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1463 sets the button's minimum size to
1467 Default is the widget's natural size.
1471 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1477 .Qq Ar id Ns Cm :ping Bq Ar text
1478 triggers a feedback message.
1480 .Qq Ar id Ns Cm \&:file Ar pathname
1481 if the selection has changed.
1483 .Qq Ar id Ns Cm :ping Ar text
1488 .Ss GtkFileChooserDialog
1490 .Cm GtkFileChooserDialog
1493 will be invoked by a
1496 .Sx GtkImageMenuItem
1498 .Ar foo Ns Cm _invoke .
1501 .Cm GtkFileChooserDialog
1508 if the dialog is the sole window of the GUI and therefore named
1513 .Cm GtkFileChooserDialog
1518 .Ar foo Ns Cm _cancel
1520 if the dialog is the sole window of the GUI and therefore named
1525 .Cm GtkFileChooserDialog
1530 .Ar foo Ns Cm _apply
1532 if the dialog is the sole window of the GUI and therefore named
1535 .Bl -tag -width "commands "
1537 .Qq Ar id Ns Cm :set_filename Ar path
1540 to the extent it exists.
1542 .Qq Ar id Ns Cm :set_current_name Ar string
1545 the suggested filename, which may not yet exist.
1547 should either resemble an absolute path, or the
1549 must be set separately by
1550 .Ar id Ns Cm :set_filename Ar directory .
1552 .Qq Ar id Ns Cm :set_title Ar string
1553 replaces the text in the title bar with
1556 .Qq Ar id Ns Cm :resize Bq Ar width height
1557 changes the size of the dialog window to
1561 pixels if specified, or to the default size.
1563 .Qq Ar id Ns Cm :move Ar x y
1564 moves the dialog window to position
1567 .Qq Ar id Ns Cm :fullscreen
1569 .Qq Ar id Ns Cm :unfullscreen
1570 switch fullscreen mode on and off.
1572 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1573 makes the dialog grayed out
1578 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1581 the dialog, or makes it visible
1584 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1589 feedback messages form the dialog window.
1590 Initially, the widget is unblocked.
1592 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1593 sets the dialog window's tooltip.
1594 Default is disabling the tooltip.
1596 .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
1597 writes a snapshot of the widget to an image file of the specified
1600 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1601 sets the widget's minimum size to
1605 Default is the widget's natural size.
1609 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1611 sets the widget style.
1615 .Qq Ar id Ns Cm :ping Bq Ar text
1616 triggers a feedback message.
1618 .Qq Ar id Ns Cm \&:file Ar pathname
1620 .Qq Ar id Ns Cm \&:folder Ar pathname
1622 .Qq Ar id Ns Cm \&:closed
1624 .Cm GtkFileChooserDialog
1625 window was closed by the window manager.
1627 .Qq Ar id Ns Cm :ping Ar text
1633 .Bl -tag -width "commands "
1635 .Qq Ar id Ns Cm :set_font_name Ar fontname
1636 preselects the font.
1638 .Qq Ar id Ns Cm :grab_focus
1639 puts the keyboard focus onto the button.
1641 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1642 makes the button grayed out
1647 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1650 the button, or makes it visible
1653 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1659 Initially, the button is unblocked.
1661 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1662 sets the button's tooltip.
1663 Default is disabling the tooltip.
1665 .Qq Ar id Ns Cm :force
1666 opens the dialog window.
1668 .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
1669 writes a snapshot of the button to an image file of the specified
1672 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1673 sets the button's minimum size to
1677 Default is the button's natural size.
1681 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1687 .Qq Ar id Ns Cm :ping Bq Ar text
1688 triggers a feedback message.
1690 .Qq Ar id Ns Cm \&:font Ar fontname
1692 .Qq Ar id Ns Cm :ping Ar text
1698 .Bl -tag -width "commands "
1700 .Qq Ar id Ns Cm :set_label Ar text
1701 replaces the frame label text with
1704 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1705 makes the frame and its content grayed out
1710 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1713 the frame, or makes it visible
1716 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1717 sets the frame's tooltip.
1718 Default is disabling the tooltip.
1720 .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
1721 writes a snapshot of the frame to an image file of the specified
1724 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1725 sets the widget's minimum size to
1729 Default is the frame's natural size.
1733 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1739 .Qq Ar id Ns Cm :ping Bq Ar text
1740 triggers a feedback message.
1742 .Qq Ar id Ns Cm :ping Ar text
1748 .Bl -tag -width "commands "
1750 .Qq Ar id Ns Cm :set_from_icon_name Ar icon-name
1751 replaces the image with one of the standard icons.
1753 .Qq Ar id Ns Cm :set_from_file Ar path
1754 replaces the image by the one found at
1757 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1760 the image, or makes it visible
1763 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1764 sets the image's tooltip.
1765 Default is disabling the tooltip.
1767 .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
1768 writes a snapshot of the image to an image file of the specified
1771 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1772 sets the images's minimum size to
1776 Default is the image's natural size.
1780 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1786 .Qq Ar id Ns Cm :ping Bq Ar text
1787 triggers a feedback message.
1789 .Qq Ar id Ns Cm :ping Ar text
1795 .Bl -tag -width "commands "
1797 .Qq Ar id Ns Cm :popup ,
1798 .Qq Ar id Ns Cm :popdown
1799 displays the menu at mouse position or closes it, respectively.
1801 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1802 makes the menu grayed out
1807 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1808 sets the menu's tooltip.
1809 Default is disabling the tooltip.
1811 .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
1812 writes a snapshot of the (popped-up) menu to an image file of the
1815 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1816 sets the menu's minimum size to
1820 Default is the menu's natural size.
1824 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1826 sets the menu's style.
1830 .Qq Ar id Ns Cm :ping Bq Ar text
1831 triggers a feedback message.
1833 .Qq Ar id Ns Cm :ping Ar text
1839 .Bl -tag -width "commands "
1841 .Qq Ar id Ns Cm :grab_focus
1842 puts the keyboard focus onto the button.
1844 .Qq Ar id Ns Cm :force
1845 simulates a click onto the button.
1847 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1848 makes the button grayed out
1853 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1856 the button, or makes it visible
1859 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1860 sets the button's tooltip.
1861 Default is disabling the tooltip.
1863 .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
1864 writes a snapshot of the button to an image file of the specified
1867 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1868 sets the button's minimum size to
1872 Default is the button's natural size.
1876 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1878 sets the button's style.
1882 .Qq Ar id Ns Cm :ping Bq Ar text
1883 triggers a feedback message.
1885 .Qq Ar id Ns Cm :ping Ar text
1890 .Ss GtkImageMenuItem
1891 .Cm GtkImageMenuItem
1893 .Bl -tag -width "commands "
1895 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1896 makes the item grayed out
1901 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1904 the item, or makes it visible
1907 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1913 Initially, the item is unblocked.
1915 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1916 sets the item's tooltip.
1917 Default is disabling the tooltip.
1919 .Qq Ar id Ns Cm :force
1920 simulates a click on the menu item.
1922 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1923 sets the item's minimum size to
1927 Default is the item's natural size.
1931 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1933 sets the item's style.
1937 .Qq Ar id Ns Cm :ping Bq Ar text
1938 triggers a feedback message.
1941 .Cm GtkImageMenuItem
1943 .Ar foo Ns Cm _invoke
1947 .Sx GtkFileChooserDialog
1951 If there isn't any dialog attached to the
1952 .Cm GtkImageMenuItem ,
1954 .Qq Ar id Ns Cm \&:active Ar label .
1956 .Qq Ar id Ns Cm :ping Ar text
1962 .Bl -tag -width "commands "
1964 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1965 makes the info bar grayed out
1970 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1973 the info bar, or makes it visible
1976 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1977 sets the info bar's tooltip.
1978 Default is disabling the tooltip.
1980 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1981 sets the info bar's minimum size to
1985 Default is the info bar's natural size.
1989 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1995 .Qq Ar id Ns Cm :ping Bq Ar text
1996 triggers a feedback message.
1998 .Qq Ar id Ns Cm :ping Ar text
2004 .Bl -tag -width "commands "
2006 .Qq Ar id Ns Cm :set_text Ar string
2007 replaces the label text with
2010 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2011 makes the label grayed out
2016 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2019 the label, or makes it visible
2022 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2023 sets the label's tooltip.
2024 Default is disabling the tooltip.
2026 .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
2027 writes a snapshot of the label to an image file of the specified
2030 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2031 sets the label's minimum size to
2035 Default is the natural size.
2039 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2041 sets the label's style.
2045 .Qq Ar id Ns Cm :ping Bq Ar text
2046 triggers a feedback message.
2048 .Qq Ar id Ns Cm :ping Ar text
2054 .Bl -tag -width "commands "
2056 .Qq Ar id Ns Cm :set_visited Brq Cm 0 Ns | Ns Cm 1
2057 gives the button text the appearance of an unvisited
2058 .Pq Cm 0 , No default
2063 .Qq Ar id Ns Cm :set_label Ar string
2064 replaces the button text with
2067 .Qq Ar id Ns Cm :grab_focus
2068 puts the keyboard focus onto the button.
2070 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2071 makes the button grayed out
2076 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2079 the button, or makes it visible
2082 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2088 Initially, the button is unblocked.
2090 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2091 sets the button's tooltip.
2092 Default is disabling the tooltip.
2094 .Qq Ar id Ns Cm :force
2095 simulates a click on the button.
2097 .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
2098 writes a snapshot of the button to an image file of the specified
2101 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2102 sets the button's minimum size to
2106 Default is the button's natural size.
2110 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2116 .Qq Ar id Ns Cm :ping Bq Ar text
2117 triggers a feedback message.
2119 .Qq Ar id Ns Cm \&:clicked
2121 .Qq Ar id Ns Cm :ping Ar text
2127 .Bl -tag -width "commands "
2129 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2130 makes the menu bar grayed out
2135 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2138 the menu bar, or makes it visible
2141 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2142 sets the menu bar's tooltip.
2143 Default is disabling the tooltip.
2145 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2146 sets the menu bar's minimum size to
2150 Default is its natural size.
2154 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2156 sets the menu bar's style.
2160 .Qq Ar id Ns Cm :ping Bq Ar text
2161 triggers a feedback message.
2163 .Qq Ar id Ns Cm :ping Ar text
2169 .Bl -tag -width "commands "
2171 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2172 makes the item grayed out
2177 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2180 the item, or makes it visible
2183 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2189 Initially, the item is unblocked.
2191 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2192 sets the item's tooltip.
2193 Default is disabling the tooltip.
2195 .Qq Ar id Ns Cm :force
2196 simulates a click on the menu item.
2198 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2199 sets the item's minimum size to
2203 Default is the item's natural size.
2207 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2209 sets the item's style.
2213 .Qq Ar id Ns Cm :ping Bq Ar text
2214 triggers a feedback message.
2219 .Ar foo Ns Cm _invoke
2223 .Sx GtkFileChooserDialog
2227 If there isn't any dialog attached to the
2230 .Qq Ar id Ns Cm \&:active Ar label .
2232 .Qq Ar id Ns Cm :ping Ar text
2238 .Bl -tag -width "commands "
2240 .Qq Ar id Ns Cm :set_current_page Ar n
2241 switches to zero-based page number
2244 .Qq Ar id Ns Cm :grab_focus
2245 puts the keyboard focus onto the notebook.
2247 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2248 makes the notebook grayed out
2253 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2256 the notebook, or makes it visible
2259 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2260 sets the notebook's tooltip.
2261 Default is disabling the tooltip.
2263 .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
2264 writes a snapshot of the notebook to an image file of the specified
2267 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2268 sets the notebooks's minimum size to
2272 Default is the widget's natural size.
2276 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2278 sets the notebook's style.
2282 .Qq Ar id Ns Cm :ping Bq Ar text
2283 triggers a feedback message.
2285 .Qq Ar id Ns Cm :ping Ar text
2291 .Bl -tag -width "commands "
2293 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2294 makes the overlay grayed out
2299 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2302 the overlay, or makes it visible
2305 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2306 sets the overlay's tooltip.
2307 Default is disabling the tooltip.
2309 .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
2310 writes a snapshot of the overlay to an image file of the specified
2313 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2314 sets the overlay's minimum size to
2318 Default is the overlay's natural size.
2322 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2328 .Qq Ar id Ns Cm :ping Bq Ar text
2329 triggers a feedback message.
2331 .Qq Ar id Ns Cm :ping Ar text
2337 .Bl -tag -width "commands "
2339 .Qq Ar id Ns Cm :grab_focus
2340 puts the keyboard focus onto the handle.
2342 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2343 makes the widget grayed out
2348 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2351 the widget, or makes it visible
2354 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2355 sets the widget's tooltip.
2356 Default is disabling the tooltip.
2358 .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
2359 writes a snapshot of the widget to an image file of the specified
2362 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2363 sets the widget's minimum size to
2367 Default is the widget's natural size.
2371 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2377 .Qq Ar id Ns Cm :ping Bq Ar text
2378 triggers a feedback message.
2380 .Qq Ar id Ns Cm :ping Ar text
2386 The main window can be turned into a
2388 and embedded into the XEmbed socket of another process; see
2392 .Ss GtkPrintUnixDialog
2393 .Bl -tag -width "commands "
2395 .Qq Ar id Ns Cm :print Ar file.ps
2396 opens the print dialog.
2401 to the printer the user selected in the dialog.
2403 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2404 makes the dialog grayed out
2409 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2412 the dialog, or makes it visible
2415 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2421 Initially, the dialog is unblocked.
2423 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2424 sets the dialog's tooltip.
2425 Default is disabling the tooltip.
2427 .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
2428 writes a snapshot of the dialog to an image file of the specified
2431 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2432 sets the dialog's minimum size to
2436 Default is the dialog's natural size.
2440 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2442 sets the widget style.
2446 .Qq Ar id Ns Cm :ping Bq Ar text
2447 triggers a feedback message.
2449 .Qq Ar id Ns Cm \&:closed
2451 .Cm GtkPrintUnixDialog
2452 window was closed by the window manager.
2454 .Qq Ar id Ns Cm :ping Ar text
2460 .Bl -tag -width "commands "
2462 .Qq Ar id Ns Cm :set_fraction Ar x
2463 moves the progress bar to
2465 .Pq between 0 and 1 .
2467 .Qq Ar id Ns Cm :set_text Bq Ar string
2468 replaces the text of the progress bar with
2470 Default is the progress percentage.
2472 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2475 the progress bar, or makes it visible
2478 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2479 sets the tooltip of the progressbar.
2480 Default is disabling the tooltip.
2482 .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
2483 writes a snapshot of the progress bar to an image file of the
2486 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2487 sets the minimum size of the progress bar to
2491 Default is the natural size.
2495 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2501 .Qq Ar id Ns Cm :ping Bq Ar text
2502 triggers a feedback message.
2504 .Qq Ar id Ns Cm :ping Ar text
2510 .Bl -tag -width "commands "
2512 .Qq Ar id Ns Cm :set_active 1
2513 switches the button on.
2514 All other buttons of the same group will go off automatically.
2516 .Qq Ar id Ns Cm :set_label Ar string
2517 replaces the button text with
2520 .Qq Ar id Ns Cm :grab_focus
2521 puts the keyboard focus onto the button.
2523 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2524 makes the button grayed out
2529 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2532 the button, or makes it visible
2535 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2541 Initially, the button is unblocked.
2543 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2544 sets the button's tooltip.
2545 Default is disabling the tooltip.
2547 .Qq Ar id Ns Cm :force
2548 simulates a click on the button.
2550 .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
2551 writes a snapshot of the button to an image file of the specified
2554 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2555 sets the button's minimum size to
2559 Default is the button's natural size.
2563 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2569 .Qq Ar id Ns Cm :ping Bq Ar text
2570 triggers a feedback message.
2572 .Qq Ar id Ns Cm \&:1
2574 .Qq Ar id Ns Cm \&:0
2577 .Qq Ar id Ns Cm :ping Ar text
2583 .Bl -tag -width "commands "
2585 .Qq Ar id Ns Cm :set_value Ar x
2586 moves the slider to value
2589 .Qq Ar id Ns Cm :set_fill_level Bq Ar x
2590 moves the fill level indicator to value
2592 Default is hiding the fill level indicator.
2594 .Qq Ar id Ns Cm :set_range Ar min max
2597 .Qq Ar id Ns Cm :set_increments Ar step page
2598 sets the steps the slider moves while pressing arrow keys and
2600 .Pf / Ql Page_Down ,
2603 .Qq Ar id Ns Cm :grab_focus
2604 puts the keyboard focus onto the scale.
2606 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2607 makes the scale grayed out
2612 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2615 the scale, or makes it visible
2618 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2624 Initially, the scale is unblocked.
2626 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2627 sets the scale's tooltip.
2628 Default is disabling the tooltip.
2630 .Qq Ar id Ns Cm :force
2631 simulates fresh selection of the current value.
2633 .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
2634 writes a snapshot of the scale to an image file of the specified
2637 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2638 sets the scale's minimum size to
2642 Default is the natural size.
2646 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2652 .Qq Ar id Ns Cm :ping Bq Ar text
2653 triggers a feedback message.
2655 .Qq Ar id Ns Cm \&:value Ar number
2657 .Qq Ar id Ns Cm :ping Ar text
2662 .Ss GtkScrolledWindow
2663 .Bl -tag -width "commands "
2665 .Qq Ar id Ns Cm :hscroll Ar position
2667 .Qq Ar id Ns Cm :vscroll Ar position
2670 to the left or top edge of the
2671 .Cm GtkScrolledWindow ,
2674 .Qq Ar id Ns Cm :hscroll_to_range Ar pos0 pos1
2676 .Qq Ar id Ns Cm :vscroll_to_range Ar pos0 pos1
2677 scroll, if necessary, the range between
2682 .Cm GtkScrolledWindow .
2683 If the range is greater than the window, the initial part of the range
2686 .Qq Ar id Ns Cm :grab_focus
2687 puts the keyboard focus onto the widget.
2689 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2690 makes the widget grayed out
2695 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2698 the widget, or makes it visible
2701 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2702 sets the widget's tooltip.
2703 Default is disabling the tooltip.
2705 .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
2706 writes a snapshot of the widget to an image file of the specified
2709 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2710 sets the minimum size to
2714 Default is the widget's natural size.
2718 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2724 .Qq Ar id Ns Cm :ping Bq Ar text
2725 triggers a feedback message.
2727 .Qq Ar id Ns Cm :ping Ar text
2733 .Bl -tag -width "commands "
2735 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2736 makes the separator insensitive
2741 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2742 sets the tooltip of the separator.
2743 Default is disabling the tooltip.
2745 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2748 the separator, or makes it visible
2751 .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
2752 writes a snapshot of the separator to an image file of the specified
2755 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2756 sets the minimum size to
2760 Default is the natural size of the separator.
2764 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2766 sets the widget style.
2770 .Qq Ar id Ns Cm :ping Bq Ar text
2771 triggers a feedback message.
2773 .Qq Ar id Ns Cm :ping Ar text
2778 .Ss GtkSeparatorMenuItem
2779 .Bl -tag -width "commands "
2781 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2782 makes the menu item insensitive
2787 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2790 the menu item, or makes it visible
2793 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2794 sets the tooltip of the menu item.
2795 Default is disabling the tooltip.
2797 .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
2798 writes a snapshot of the menu item to an image file of the specified
2801 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2802 sets the minimum size to
2806 Default is the natural size of the menu item.
2810 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2812 sets the widget style.
2816 .Qq Ar id Ns Cm :ping Bq Ar text
2817 triggers a feedback message.
2819 .Qq Ar id Ns Cm :ping Ar text
2825 .Bl -tag -width "commands "
2827 .Qq Ar id Ns Cm :ping Bq Ar text
2828 triggers a feedback message.
2830 .Qq Ar id Ns Cm :ping Ar text
2837 may be unsupported by Glade, but its definition can be inserted
2838 manually into the GtkBuilder
2841 .Bd -literal -offset indent
2843 <object class="GtkSocket" id="socket1">
2844 <property name="visible">True</property>
2845 <property name="can_focus">True</property>
2848 <property name="expand">True</property>
2849 <property name="fill">True</property>
2850 <property name="position">1</property>
2854 .Bl -tag -width "commands "
2857 requests a feedback message containing the socket
2860 .Qq Ar id Ns Cm :grab_focus
2861 puts the keyboard focus onto the socket.
2863 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2864 makes the socket grayed out
2869 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2872 the socket, or makes it visible
2875 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2876 sets the socket's tooltip.
2877 Default is disabling the tooltip.
2878 .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
2879 writes a snapshot of the socket to an image file of the specified
2882 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2883 sets the socket's minimum size to
2887 Default is the socket's natural size.
2891 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2897 .Qq Ar id Ns Cm :ping Bq Ar text
2898 triggers a feedback message.
2900 .Qq Ar id Ns Cm :id Ar xid
2901 can be used by another process to XEmbed its widgets into the
2904 .Qq Ar id Ns Cm \&:plug-added ,
2906 .Ar id Ns Cm \&:plug-removed
2908 Notification that the other process has inserted its widgets into or
2909 removed them from the
2912 .Qq Ar id Ns Cm :ping Ar text
2918 .Bl -tag -width "commands "
2920 .Qq Ar id Ns Cm :set_text Ar string
2921 sets the selected value to
2924 .Qq Ar id Ns Cm :set_range Ar min max
2927 .Qq Ar id Ns Cm :set_increments Ar step page
2928 sets the steps the value changes while pressing arrow keys/left mouse
2931 .Pf / Ql Page_Down Ns
2932 /middle mouse button,
2935 .Qq Ar id Ns Cm :grab_focus
2936 puts the keyboard focus onto the button.
2938 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2939 makes the button grayed out
2944 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2947 the button, or makes it visible
2950 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2956 Initially, the button is unblocked.
2958 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2959 sets the button's tooltip.
2960 Default is disabling the tooltip.
2962 .Qq Ar id Ns Cm :force
2963 simulates fresh selection of the current value
2965 .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
2966 writes a snapshot of the button to an image file of the specified
2969 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2970 sets the button's minimum size to
2974 Default is the widget's natural size.
2978 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2980 sets the button's style.
2984 .Qq Ar id Ns Cm :ping Bq Ar text
2985 triggers a feedback message.
2987 .Qq Ar id Ns Cm \&:text Ar text
2989 .Qq Ar id Ns Cm :ping Ar text
2995 .Bl -tag -width "commands "
2997 .Qq Ar id Ns Cm :start
2999 .Qq Ar id Ns Cm :stop
3000 start and stop the spinner.
3002 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3003 makes the spinner grayed out
3008 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3011 the spinner, or makes it visible
3014 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3015 sets the spinner's tooltip.
3016 Default is disabling the tooltip.
3018 .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
3019 writes a snapshot of the spinner to an image file of the specified
3022 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3023 sets the spinner's minimum size to
3027 Default is the natural size.
3031 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3037 .Qq Ar id Ns Cm :ping Bq Ar text
3038 triggers a feedback message.
3040 .Qq Ar id Ns Cm :ping Ar text
3046 The context parameter
3048 is an arbitrary non-whitespace string.
3049 .Bl -tag -width "commands "
3051 .Qq Ar id Ns Cm :push_id Ar c string ,
3052 .Qq Ar id Ns Cm :push Ar string
3055 with context parameter
3059 respectively, and display it in the statusbar.
3061 .Qq Ar id Ns Cm :pop_id Ar c ,
3062 .Qq Ar id Ns Cm :pop
3063 remove the latest entry associated with context parameter
3067 respectively, from the statusbar.
3069 .Qq Ar id Ns Cm :remove_all_id Ar c ,
3070 .Qq Ar id Ns Cm :remove_all
3071 remove the entries associated with context parameter
3075 respectively, from the statusbar.
3077 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3078 makes the statusbar grayed out
3083 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3086 the statusbar, or makes it visible
3089 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3090 sets the statusbar's tooltip.
3091 Default is disabling the tooltip.
3093 .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
3094 writes a snapshot of the statusbar to an image file of the specified
3097 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3098 sets the statusbar's minimum size to
3102 Default is the natural size.
3106 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3108 sets the statusbar's style.
3112 .Qq Ar id Ns Cm :ping Bq Ar text
3113 triggers a feedback message.
3115 .Qq Ar id Ns Cm :ping Ar text
3121 .Bl -tag -width "commands "
3123 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
3124 turns the switch off
3129 .Qq Ar id Ns Cm :grab_focus
3130 puts the keyboard focus onto the switch.
3132 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3133 makes the switch grayed out
3138 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3141 the switch, or makes it visible
3144 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3150 Initially, the switch is unblocked.
3152 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3153 sets the tooltip of the switch.
3154 Default is disabling the tooltip.
3156 .Qq Ar id Ns Cm :force
3157 simulates a click on the switch.
3159 .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
3160 writes a snapshot of the switch to an image file of the specified
3163 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3164 sets the switch's minimum size to
3168 Default is the natural size.
3172 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3178 .Qq Ar id Ns Cm :ping Bq Ar text
3179 triggers a feedback message.
3181 .Qq Ar id Ns Cm \&:1
3183 .Qq Ar id Ns Cm \&:0
3186 .Qq Ar id Ns Cm :ping Ar text
3192 There should be a dedicated
3194 for sending (parts of) the text.
3202 .Ar foo Ns Cm _send_text
3203 will send the content of the
3208 .Ar foo Ns Cm _send_selection
3209 will send the highlighted part the
3211 .Bl -tag -width "commands "
3213 .Qq Ar id Ns Cm :set_text Ar string
3214 replaces the user-editable text with (potentially empty)
3217 .Qq Ar id Ns Cm :delete
3220 .Qq Ar id Ns Cm :insert_at_cursor Ar string
3225 .Qq Ar id Ns Cm :place_cursor Brq Ar position | Cm end
3226 places the text cursor at
3228 or at the end of the text.
3230 .Qq Ar id Ns Cm :place_cursor_at_line Ar line
3231 places the text cursor at the beginning of
3234 .Qq Ar id Ns Cm :scroll_to_cursor
3235 scrolls to the cursor position if necessary.
3237 .Qq Ar id Ns Cm :save Ar file
3242 command containing the text.
3244 .Qq Ar id Ns Cm :grab_focus
3245 puts the keyboard focus into the textview.
3247 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3248 makes the text view grayed out
3253 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3256 the text view, or makes it visible
3259 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3260 sets the tooltip of the text view.
3261 Default is disabling the tooltip.
3263 .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
3264 writes a snapshot of the text view to an image file of the specified
3267 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3268 sets the minimum size to
3272 Default is the natural size.
3276 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3282 .Qq Ar id Ns Cm :ping Bq Ar text
3283 triggers a feedback message.
3285 .Qq Ar button_id Ns Cm \&:text Ar text ,
3293 and backslashes are replaced by
3296 .Qq Ar id Ns Cm :ping Ar text
3302 .Bl -tag -width "commands "
3304 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
3305 switches the button off
3310 .Qq Ar id Ns Cm :set_label Ar string
3311 replaces the button text with
3314 .Qq Ar id Ns Cm :grab_focus
3315 puts the keyboard focus onto the button.
3317 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3318 makes the button grayed out
3323 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3326 the button, or makes it visible
3329 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3335 Initially, the button is unblocked.
3337 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3338 sets the button's tooltip.
3339 Default is disabling the tooltip.
3341 .Qq Ar id Ns Cm :force
3342 simulates a click on the button.
3344 .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
3345 writes a snapshot of the button to an image file of the specified
3348 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3349 sets the button's minimum size to
3353 Default is the button's natural size.
3357 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3359 sets the button's style.
3363 .Qq Ar id Ns Cm :ping Bq Ar text
3364 triggers a feedback message.
3366 .Qq Ar id Ns Cm \&:1
3368 .Qq Ar id Ns Cm \&:0
3371 .Qq Ar id Ns Cm :ping Ar text
3378 can deal with columns of type
3379 .Cm gboolean , gint , guint , glong , gulong , gint64 , guint64 , gfloat , gdouble ,
3386 refer to the underlying model
3389 .Cm GtkTreeStore ) .
3391 is a sequence of one or more colon-separated integers, e.g.
3395 .Bl -tag -width "commands "
3397 .Qq Ar id Ns Cm :set Ar row column data
3398 replaces the content at
3402 (which should be compatible with the type of
3404 If necessary, new tree nodes are created to obtain the minimal tree
3405 structure needed to support
3408 .Qq Ar id Ns Cm :insert_row Brq Ar row Bo Cm as_child Bc | Cm end
3409 inserts a new, empty row; either as a sibling of
3415 or at the end of the list, respectively.
3417 .Qq Ar id Ns Cm :move_row Ar origin Brq Ar destination | Cm end
3420 within its current level to
3424 .Qq Ar id Ns Cm :remove_row Ar row
3425 removes the row at position
3428 .Qq Ar id Ns Cm :clear
3431 .Qq Ar id Ns Cm :expand Ar row
3432 expands one level of the subtree below
3435 .Qq Ar id Ns Cm :expand_all Bq Ar row
3436 expands the subtree below
3440 .Qq Ar id Ns Cm :collapse Bq Ar row
3441 collapses the subtree below
3445 .Qq Ar id Ns Cm :set_cursor Bq Ar row
3450 .Qq Ar id Ns Cm :scroll Ar row column
3455 .Qq Ar id Ns Cm :save Ar file
3456 stores the content of the underlying model as a sequence of
3461 .Qq Ar id Ns Cm :grab_focus
3462 puts the keyboard focus onto the tree view.
3464 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3465 makes the tree view grayed out
3470 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3473 the tree view, or makes it visible
3476 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3482 Initially, the widget is unblocked.
3484 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3485 sets the tooltip of the tree view.
3486 Default is disabling the tooltip.
3488 .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
3489 writes a snapshot of the tree view to an image file of the specified
3492 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3493 sets the minimum size of the tree view to
3497 Default is the widget's natural size.
3501 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3507 .Qq Ar id Ns Cm :ping Bq Ar text
3508 triggers a feedback message.
3510 .Qq Ar id Ns Cm \&:clicked
3512 .Qq Ar id Ns Cm \&: Ns Ar column_type row column value ,
3513 one message per cell in the underlying model for each selected row; or
3515 .Qq Ar id Ns Cm \&: Ns Ar column_type row column new_value ,
3520 .Qq Ar id Ns Cm :ping Ar text
3525 .Ss GtkTreeViewColumn
3526 .Bl -tag -width "commands "
3528 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3534 Initially, the widget is unblocked.
3536 .Qq Ar id Ns Cm :ping Bq Ar text
3537 triggers a feedback message.
3539 .Qq Ar id Ns Cm \&:clicked
3541 .Qq Ar id Ns Cm :ping Ar text
3547 .Bl -tag -width "commands "
3549 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3550 makes the viewport insensitive
3555 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3558 the viewport, or makes it visible
3561 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3562 sets the tooltip of the viewport.
3563 Default is disabling the tooltip.
3565 .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
3566 writes a snapshot of the viewport to an image file of the specified
3569 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3570 sets the minimum size to
3574 Default is the natural size of the viewport.
3578 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3580 sets the widget style.
3584 .Qq Ar id Ns Cm :ping Bq Ar text
3585 triggers a feedback message.
3587 .Qq Ar id Ns Cm :ping Ar text
3593 .Bl -tag -width "commands "
3595 .Qq Ar id Ns Cm :set_title Ar string
3596 replaces the text in the title bar with
3599 .Qq Ar id Ns Cm :resize Bq Ar width height
3600 changes the window size to
3604 pixels if specified, or to the default size.
3606 .Qq Ar id Ns Cm :move Ar x y
3607 moves the window to position
3610 .Qq Ar id Ns Cm :fullscreen
3612 .Qq Ar id Ns Cm :unfullscreen
3613 switch fullscreen mode on and off.
3615 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3616 makes the widget grayed out
3621 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3624 the widget, or makes it visible
3627 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3633 Initially, the widget is unblocked.
3635 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3636 sets the window's tooltip.
3637 Default is disabling the tooltip.
3638 .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
3639 writes a snapshot of the window to an image file of the specified
3642 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3643 sets the window's minimum size to
3647 Default is the widget's natural size.
3651 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3657 .Qq Ar id Ns Cm :ping Bq Ar text
3658 triggers a feedback message.
3660 .Qq Ar id Ns Cm \&:closed
3663 was closed by the window manager.
3665 .Qq Ar id Ns Cm :ping Ar text
3674 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3678 of the widget style to
3680 Properties not explicitly specified are reset to their default values.
3682 .Bl -dash -offset indent -compact
3684 .Ql label1:style font:Bold 11; background-color:green
3686 .Ql label1:style font-style:italic; font-weight:bold; color:blue
3688 .Ql button1:style background-image:url("q.png")
3690 .Ql treeview1:style background-image:linear-gradient(45deg, yellow, blue);
3692 .Ql frame1:style border-color:red yellow; border-width:5px
3694 .Ql frame1:style border-radius:10px; transition:10s
3696 For color notations see
3703 .Bl -dash -offset indent -compact
3705 standard X11 colors names like
3707 .Ql Dark Sea Green ,
3713 hexadecimal values in the form
3714 .Cm # Ns Ar rgb , Cm # Ns Ar rrggbb , Cm # Ns Ar rrrgggbbb ,
3716 .Cm # Ns Ar rrrrggggbbbb ;
3718 RGB colors in the form
3719 .Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&)
3721 RGBA colors in the form
3722 .Cm rgba( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns
3723 .Ar blue Ns Cm \&, Ns Ar alpha Ns Cm \&) ;
3724 .Ar red , green , blue
3725 between 0 and 255 and
3729 color expressions like
3732 .Ql lighter(currentColor) .
3737 .Ss Discovering Pipeglade Interactively
3738 Suppose the interface in
3741 .Sx GtkLabel Ql label1
3743 .Sx GtkButton Ql button1 .
3749 .Sx GtkButton , Ql button1:clicked
3750 will be reported on the terminal.
3753 .Dl label1:set_text The Button
3755 will change the text shown on the label into
3757 .Ss One-Shot File Dialog
3758 Suppose the interface in
3759 .Pa ./simple_open.ui
3761 .Sx GtkFileChooserDialog
3769 .Dl pipeglade -u simple_open.ui
3771 will open the dialog; pressing
3773 will close it after sending the selected filename to
3775 .Ss One-Shot User Notification
3777 .Pa ./simple_dialog.ui
3779 .Sx GtkLabel Ql label1 ,
3781 .Bd -literal -offset indent
3782 pipeglade -u simple_dialog.ui <<< \e
3783 "label1:set_text NOW READ THIS!"
3785 will set the label text accordingly and wait for user input.
3786 .Ss Continuous Input
3787 The following shell command displays a running clock:
3788 .Bd -literal -offset indent
3790 echo "label1:set_text `date`";
3792 done | pipeglade -u simple_dialog.ui
3794 .Ss Continuous Input and Output
3795 The following shell script fragment sets up
3797 for continuous communication with another program,
3799 .Bd -literal -offset indent
3800 pipeglade -i in.fifo -o out.fifo -b
3801 main_prog <out.fifo >in.fifo
3814 .An Bert Burgemeister
3815 .Aq Mt trebbu@googlemail.com .
3817 Due to what appears to be a bug in cairo v1.14.0,
3819 used with this library version occasionally crashes on