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 "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
358 .Bl -tag -width "commands "
360 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
361 makes the box grayed out
366 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
369 the box, or makes it visible
371 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
372 sets the box's tooltip.
373 Default is disabling the tooltip.
375 .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
376 writes a snapshot of the box to an image file of the specified
379 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
380 sets the box's minimum size to
384 Default is the box's natural size.
388 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
397 .Bl -tag -width "commands "
399 .Qq Ar id Ns Cm :set_label Ar string
400 replaces the button text with
403 .Qq Ar id Ns Cm :grab_focus
404 puts the keyboard focus onto the button.
406 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
407 makes the button grayed out
412 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
415 the button, or makes it visible
418 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
424 Initially, the button is unblocked.
426 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
427 sets the button's tooltip.
428 Default is disabling the tooltip.
430 .Qq Ar id Ns Cm :force
431 simulates a click on the button.
433 .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
434 writes a snapshot of the button to an image file of the specified
437 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
438 sets the button's minimum size to
442 Default is the button's natural size.
446 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
452 .Qq Ar id Ns Cm \&:clicked
456 .Cm _ok , _apply , _cancel , _send_text ,
459 may work differently; see
460 .Sx GtkDialog , GtkFileChooserDialog ,
466 .Bl -tag -width "commands "
468 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
469 makes the box grayed out
474 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
477 the box, or makes it visible
480 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
481 sets the box's tooltip.
482 Default is disabling the tooltip.
484 .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
485 writes a snapshot of the box to an image file of the specified
488 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
489 sets the box's minimum size to
493 Default is the box's natural size.
497 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
506 .Bl -tag -width "commands "
508 .Qq Ar id Ns Cm :select_date Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
509 selects the date on the calendar.
511 .Qq Ar id Ns Cm :mark_day Ar day
516 .Qq Ar id Ns Cm :clear_marks
517 unmarks all days on the calendar.
519 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
520 makes the calendar grayed out
525 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
528 the calendar, or makes it visible
531 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
537 Initially, the calendar is unblocked.
539 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
540 sets the calendar's tooltip.
541 Default is disabling the tooltip.
543 .Qq Ar id Ns Cm :force
544 simulates a click on the currently selected date.
546 .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
547 writes a snapshot of the calendar to an image file of the specified
550 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
551 sets the calendar's minimum size to
555 Default is the widget's natural size.
559 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
561 sets the calendar's style.
565 .Qq Ar id Ns Cm \&:clicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
567 .Qq Ar id Ns Cm \&:doubleclicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
570 .Bl -tag -width "commands "
572 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
573 switches the check mark off
578 .Qq Ar id Ns Cm :set_label Ar string
579 replaces the button text with
582 .Qq Ar id Ns Cm :grab_focus
583 puts the keyboard focus onto the button.
585 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
586 makes the button grayed out
591 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
594 the button, or makes it visible
597 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
603 Initially, the button is unblocked.
605 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
606 sets the button's tooltip.
607 Default is disabling the tooltip.
609 .Qq Ar id Ns Cm :force
610 simulates a click on the button.
612 .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
613 writes a snapshot of the button to an image file of the specified
616 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
617 sets the button's minimum size to
621 Default is the widget's natural size.
625 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
627 sets the button's style.
637 .Bl -tag -width "commands "
639 .Qq Ar id Ns Cm :set_color Ar color
640 preselects the color; see
643 .Qq Ar id Ns Cm :grab_focus
644 puts the keyboard focus onto the button.
646 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
647 makes the button grayed out
652 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
655 the button, or makes it visible
658 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
664 Initially, the button is unblocked.
666 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
667 sets the button's tooltip.
668 Default is disabling the tooltip.
670 .Qq Ar id Ns Cm :force
671 opens the dialog window.
673 .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
674 writes a snapshot of the button to an image file of the specified
677 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
678 sets the button's minimum size to
682 Default is the widget's natural size.
686 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
688 sets the button's style.
692 .Qq Ar id Ns Cm \&:color Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&)
694 .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 \&) .
698 lie between 0 and 255, and
707 .Bl -tag -width "commands "
709 .Qq Ar id Ns Cm :prepend_text Ar string
711 .Qq Ar id Ns Cm :append_text Ar string
712 prepend/append a new selectable item marked
715 .Qq Ar id Ns Cm :insert_text Ar position string
721 .Qq Ar id Ns Cm :remove Ar position
725 .Qq Ar id Ns Cm :grab_focus
726 puts the keyboard focus onto the combo box.
728 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
729 makes the combo box grayed out
734 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
737 the combo box, or makes it visible
740 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
746 Initially, the combo box is unblocked.
748 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
750 Default is disabling the tooltip.
752 .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
753 writes a snapshot of the combo box to an image file of the specified
756 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
757 sets the combo box's minimum size to
761 Default is the natural size.
765 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
771 .Qq Ar entry_id Ns Cm \&:text Ar text ,
773 being the id of the child
786 .Ar foo Ns Cm _invoke .
794 .Ar foo Ns Cm _cancel
796 if the dialog is the sole window of the GUI and therefore named
807 it will take care of hiding the dialog window.
808 .Bl -tag -width "commands "
810 .Qq Ar id Ns Cm :set_title Ar string
811 replaces the text in the title bar with
814 .Qq Ar id Ns Cm :resize Bq Ar width height
815 changes the size of the dialog window to
819 pixels if specified, or to the default size.
821 .Qq Ar id Ns Cm :move Ar x y
822 moves the dialog window to position
825 .Qq Ar id Ns Cm :fullscreen
827 .Qq Ar id Ns Cm :unfullscreen
828 switch fullscreen mode on and off.
830 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
831 makes the dialog grayed out
836 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
839 the dialog, or makes it visible
842 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
847 feedback messages from the dialog window.
848 Initially, the window is unblocked.
850 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
851 sets the dialog window's tooltip.
852 Default is disabling the tooltip.
854 .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
855 writes a snapshot of the dialog window to an image file of the
858 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
859 sets the dialog window's minimum size to
863 Default is its natural size.
867 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
869 sets the dialog window's style.
873 .Qq Ar id Ns Cm \&:closed
876 window was closed by the window manager.
880 expect a context parameter of the form
881 .Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
884 is an arbitrary non-negative integer that can be used later to
885 reference the command.
888 appends its command to the current list of drawing operations.
891 replaces the first drawing operation with context parameter
895 .Ar n Ns Cm < Ns Ar m ,
896 inserts its command before the first drawing operation with context
899 Both second and third form fall back to appending.
901 The default coordinate system is a left-handed system with its origin
902 in the upper-left corner.
903 Angles increase from the positive X axis towards the positve Y axis
904 .Pq clockwise in the default system .
905 .Bl -tag -width "commands "
907 .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
908 adds a circular arc to the current path.
909 The arc is centered at
917 .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
918 adds a circular arc to the current path.
919 The arc is centered at
921 and proceeds in the direction of decreasing angles from
927 .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
928 adds a line segment from the current point to the point most recently
930 .Ar id Ns Cm :move_to
932 .Ar id Ns Cm :rel_move_to .
934 .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
935 adds a cubic Bezier spline from the current point to
942 If there is no current point, the curve will start at
945 .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
946 fills the current path and clears it.
948 .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
949 fills the current path without clearing it.
951 .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
952 adds a line from the current point to
954 or creates a new current point at
957 .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
958 sets the current point to
961 .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
962 adds a rectangle to the current path.
963 The top left corner is at
966 .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
967 adds a cubic Bezier spline from the current point to
974 All coordinates are offsets relative to the current point.
976 .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
977 adds a line from the current point to a point offset from there by
980 .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
981 .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
984 moves the current point such that
985 .Qq Ar id Ns Cm :show_text Ar n text
986 will place the specified reference point of
988 on the original current point.
990 .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
991 moves the current point by
994 .Qq Ar id Ns Cm :remove Ar n
995 removes the elements with context parameter
998 .Cm GtkDrawingArea Ar id .
1000 .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
1001 rotates the user space axes by
1005 .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
1006 scales the user space axes by
1009 .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
1010 sets the dash pattern to
1016 .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 ...
1017 resets the dash pattern to a line with arbitrary on/off portions.
1019 .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
1020 resets the dash pattern to a solid line.
1022 .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
1023 .Brq Cm normal | italic | oblique
1024 .Brq Cm normal | bold
1027 sets the font face for subsequent calls of
1028 .Ar id Ns Cm :show_text .
1030 .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
1031 sets the font size for subsequent calls of
1032 .Ar id Ns Cm :show_text .
1034 .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
1035 sets the line cap style.
1039 .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
1040 sets the line junction style.
1044 .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
1045 sets the line width.
1050 .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
1054 .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
1057 beginning at the current point.
1059 .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
1060 strokes the current path and clears it.
1062 .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
1063 strokes the current path without clearing it.
1065 .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
1066 modifies the current transformation matrix such that
1068 .Dl Va x' Li = Ar xx Va x Li + Ar xy Va y Li + Ar x0 ,
1069 .Dl Va y' Li = Ar yx Va y Li + Ar yy Va y Li + Ar y0 .
1071 Default is resetting the current transformation matrix.
1073 .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
1074 translates the user space origin by
1077 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1080 the drawing area, or makes it visible
1083 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1084 sets the drawing area's tooltip.
1085 Default is disabling the tooltip.
1087 .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
1088 writes a snapshot of the drawing area to an image file of the specified
1091 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1092 sets the drawing areas's minimum size to
1096 Default is the natural size.
1101 .Bl -tag -width "commands "
1103 .Qq Ar id Ns Cm :set_text Ar string
1104 replaces the user-editable text with
1107 .Qq Ar id Ns Cm :set_placeholder_text Ar string
1110 that is displayed when the entry is empty and unfocused.
1112 .Qq Ar id Ns Cm :grab_focus
1113 puts the keyboard focus into the entry.
1115 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1116 makes the entry grayed out
1121 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1124 the entry, or makes it visible
1127 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1133 Initially, the entry is unblocked.
1135 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1136 sets the entry's tooltip.
1137 Default is disabling the tooltip.
1139 .Qq Ar id Ns Cm :force
1140 lets the entry report its current content.
1142 .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
1143 writes a snapshot of the entry to an image file of the specified
1146 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1147 sets the entry's minimum size to
1151 Default is the entry's natural size.
1155 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1161 .Qq Ar id Ns Cm \&:text Ar text ,
1162 once for each change of
1167 are mouse pointer coordinates relative to the
1169 .Bl -tag -width "commands "
1171 .Qq Ar id Ns Cm :grab_focus
1172 puts the keyboard focus onto the event box.
1174 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1175 makes the event box insensitive
1180 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1186 Initially, the event box is unblocked.
1188 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1189 sets the tooltip of the event box.
1190 Default is disabling the tooltip.
1192 .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
1193 writes a snapshot of the event box to an image file of the specified
1196 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1197 sets the minimum size to
1201 Default is the natural size of the event box.
1205 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1207 sets the widget style.
1211 .Qq Ar id Ns Cm \&:button_press Ar b x y ,
1212 .Qq Ar id Ns Cm \&:button_release Ar b x y
1215 is the mouse button (normally 1, 2, or 3 for the left, middle, and
1216 right button; others may exist).
1218 .Qq Ar id Ns Cm \&:motion Ar x y
1219 is reported repeatedly while the mouse is being moved with a button
1222 .Qq Ar id Ns Cm \&:key_press Ar key ,
1224 being the key's name
1232 .Bl -tag -width "commands "
1234 .Qq Ar id Ns Cm :set_label Ar string
1235 replaces the expander label text with
1238 .Qq Ar id Ns Cm :set_expanded Brq Cm 0 Ns | Ns 1
1241 the child widget, or makes it visible
1244 .Qq Ar id Ns Cm :grab_focus
1245 puts the keyboard focus onto the expander.
1247 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1248 makes the expander grayed out
1253 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1256 the expander, or makes it visible
1259 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1260 sets the expander's tooltip.
1261 Default is disabling the tooltip.
1263 .Qq Ar id Ns Cm :force
1264 toggles the expansion state.
1266 .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
1267 writes a snapshot of the expander to an image file of the specified
1270 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1271 sets the expander's minimum size to
1275 Default is the natural size.
1279 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1288 .Bl -tag -width "commands "
1290 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1293 the grid, or makes it visible
1295 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1296 sets the grid's tooltip.
1297 Default is disabling the tooltip.
1299 .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
1300 writes a snapshot of the grid to an image file of the specified
1303 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1304 sets the grid's minimum size to
1308 Default is the grid's natural size.
1312 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1320 .Ss GtkFileChooserButton
1321 .Bl -tag -width "commands "
1323 .Qq Ar id Ns Cm :set_filename Ar path
1326 to the extent it exists.
1328 .Qq Ar id Ns Cm :grab_focus
1329 puts the keyboard focus onto the button.
1331 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1332 makes the button grayed out
1337 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1340 the button, or makes it visible
1343 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1349 Initially, the button is unblocked.
1351 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1352 sets the button's tooltip.
1353 Default is disabling the tooltip.
1355 .Qq Ar id Ns Cm :force
1356 simulates fresh selection of the currently selected pathname.
1358 .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
1359 writes a snapshot of the button to an image file of the specified
1362 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1363 sets the button's minimum size to
1367 Default is the widget's natural size.
1371 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1377 .Qq Ar id Ns Cm \&:file Ar pathname
1378 if the selection has changed.
1380 .Ss GtkFileChooserDialog
1382 .Cm GtkFileChooserDialog
1385 will be invoked by a
1388 .Sx GtkImageMenuItem
1390 .Ar foo Ns Cm _invoke .
1393 .Cm GtkFileChooserDialog
1400 if the dialog is the sole window of the GUI and therefore named
1405 .Cm GtkFileChooserDialog
1410 .Ar foo Ns Cm _cancel
1412 if the dialog is the sole window of the GUI and therefore named
1417 .Cm GtkFileChooserDialog
1422 .Ar foo Ns Cm _apply
1424 if the dialog is the sole window of the GUI and therefore named
1427 .Bl -tag -width "commands "
1429 .Qq Ar id Ns Cm :set_filename Ar path
1432 to the extent it exists.
1434 .Qq Ar id Ns Cm :set_current_name Ar string
1437 the suggested filename, which may not yet exist.
1439 should either resemble an absolute path, or the
1441 must be set separately by
1442 .Ar id Ns Cm :set_filename Ar directory .
1444 .Qq Ar id Ns Cm :set_title Ar string
1445 replaces the text in the title bar with
1448 .Qq Ar id Ns Cm :resize Bq Ar width height
1449 changes the size of the dialog window to
1453 pixels if specified, or to the default size.
1455 .Qq Ar id Ns Cm :move Ar x y
1456 moves the dialog window to position
1459 .Qq Ar id Ns Cm :fullscreen
1461 .Qq Ar id Ns Cm :unfullscreen
1462 switch fullscreen mode on and off.
1464 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1465 makes the dialog grayed out
1470 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1473 the dialog, or makes it visible
1476 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1481 feedback messages form the dialog window.
1482 Initially, the widget is unblocked.
1484 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1485 sets the dialog window's tooltip.
1486 Default is disabling the tooltip.
1488 .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
1489 writes a snapshot of the widget to an image file of the specified
1492 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1493 sets the widget's minimum size to
1497 Default is the widget's natural size.
1501 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1503 sets the widget style.
1507 .Qq Ar id Ns Cm \&:file Ar pathname
1509 .Qq Ar id Ns Cm \&:folder Ar pathname
1511 .Qq Ar id Ns Cm \&:closed
1513 .Cm GtkFileChooserDialog
1514 window was closed by the window manager.
1517 .Bl -tag -width "commands "
1519 .Qq Ar id Ns Cm :set_font_name Ar fontname
1520 preselects the font.
1522 .Qq Ar id Ns Cm :grab_focus
1523 puts the keyboard focus onto the button.
1525 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1526 makes the button grayed out
1531 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1534 the button, or makes it visible
1537 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1543 Initially, the button is unblocked.
1545 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1546 sets the button's tooltip.
1547 Default is disabling the tooltip.
1549 .Qq Ar id Ns Cm :force
1550 opens the dialog window.
1552 .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
1553 writes a snapshot of the button to an image file of the specified
1556 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1557 sets the button's minimum size to
1561 Default is the button's natural size.
1565 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1571 .Qq Ar id Ns Cm \&:font Ar fontname
1574 .Bl -tag -width "commands "
1576 .Qq Ar id Ns Cm :set_label Ar text
1577 replaces the frame label text with
1580 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1581 makes the frame and its content grayed out
1586 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1589 the frame, or makes it visible
1592 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1593 sets the frame'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 frame 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 frame's natural size.
1609 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1618 .Bl -tag -width "commands "
1620 .Qq Ar id Ns Cm :set_from_icon_name Ar icon-name
1621 replaces the image with one of the standard icons.
1623 .Qq Ar id Ns Cm :set_from_file Ar path
1624 replaces the image by the one found at
1627 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1630 the image, or makes it visible
1633 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1634 sets the image's tooltip.
1635 Default is disabling the tooltip.
1637 .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
1638 writes a snapshot of the image to an image file of the specified
1641 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1642 sets the images's minimum size to
1646 Default is the image's natural size.
1650 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1659 .Bl -tag -width "commands "
1661 .Qq Ar id Ns Cm :popup ,
1662 .Qq Ar id Ns Cm :popdown
1663 displays the menu at mouse position or closes it, respectively.
1665 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1666 makes the menu grayed out
1671 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1672 sets the menu's tooltip.
1673 Default is disabling the tooltip.
1675 .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
1676 writes a snapshot of the (popped-up) menu to an image file of the
1679 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1680 sets the menu's minimum size to
1684 Default is the menu's natural size.
1688 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1690 sets the menu's style.
1697 .Bl -tag -width "commands "
1699 .Qq Ar id Ns Cm :grab_focus
1700 puts the keyboard focus onto the button.
1702 .Qq Ar id Ns Cm :force
1703 simulates a click onto the button.
1705 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1706 makes the button grayed out
1711 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1714 the button, or makes it visible
1717 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1718 sets the button's tooltip.
1719 Default is disabling the tooltip.
1721 .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
1722 writes a snapshot of the button to an image file of the specified
1725 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1726 sets the button's minimum size to
1730 Default is the button's natural size.
1734 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1736 sets the button's style.
1742 .Ss GtkImageMenuItem
1743 .Cm GtkImageMenuItem
1745 .Bl -tag -width "commands "
1747 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1748 makes the item grayed out
1753 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1756 the item, or makes it visible
1759 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1765 Initially, the item is unblocked.
1767 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1768 sets the item's tooltip.
1769 Default is disabling the tooltip.
1771 .Qq Ar id Ns Cm :force
1772 simulates a click on the menu item.
1774 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1775 sets the item's minimum size to
1779 Default is the item's natural size.
1783 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1785 sets the item's style.
1790 .Cm GtkImageMenuItem
1792 .Ar foo Ns Cm _invoke
1796 .Sx GtkFileChooserDialog
1800 If there isn't any dialog attached to the
1801 .Cm GtkImageMenuItem ,
1803 .Qq Ar id Ns Cm \&:active Ar label .
1806 .Bl -tag -width "commands "
1808 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1809 makes the info bar grayed out
1814 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1817 the info bar, or makes it visible
1820 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1821 sets the info bar's tooltip.
1822 Default is disabling the tooltip.
1824 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1825 sets the info bar's minimum size to
1829 Default is the info bar's natural size.
1833 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1842 .Bl -tag -width "commands "
1844 .Qq Ar id Ns Cm :set_text Ar string
1845 replaces the label text with
1848 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1849 makes the label grayed out
1854 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1857 the label, or makes it visible
1860 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1861 sets the label's tooltip.
1862 Default is disabling the tooltip.
1864 .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
1865 writes a snapshot of the label to an image file of the specified
1868 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1869 sets the label's minimum size to
1873 Default is the natural size.
1877 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1879 sets the label's style.
1886 .Bl -tag -width "commands "
1888 .Qq Ar id Ns Cm :set_visited Brq Cm 0 Ns | Ns Cm 1
1889 gives the button text the appearance of an unvisited
1890 .Pq Cm 0 , No default
1895 .Qq Ar id Ns Cm :set_label Ar string
1896 replaces the button text with
1899 .Qq Ar id Ns Cm :grab_focus
1900 puts the keyboard focus onto the button.
1902 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1903 makes the button grayed out
1908 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1911 the button, or makes it visible
1914 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1920 Initially, the button is unblocked.
1922 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1923 sets the button's tooltip.
1924 Default is disabling the tooltip.
1926 .Qq Ar id Ns Cm :force
1927 simulates a click on the button.
1929 .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
1930 writes a snapshot of the button to an image file of the specified
1933 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1934 sets the button's minimum size to
1938 Default is the button's natural size.
1942 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1948 .Qq Ar id Ns Cm \&:clicked
1951 .Bl -tag -width "commands "
1953 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1954 makes the menu bar grayed out
1959 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1962 the menu bar, or makes it visible
1965 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1966 sets the menu bar's tooltip.
1967 Default is disabling the tooltip.
1969 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1970 sets the menu bar's minimum size to
1974 Default is its natural size.
1978 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1980 sets the menu bar's style.
1987 .Bl -tag -width "commands "
1989 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1990 makes the item grayed out
1995 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1998 the item, or makes it visible
2001 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2007 Initially, the item is unblocked.
2009 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2010 sets the item's tooltip.
2011 Default is disabling the tooltip.
2013 .Qq Ar id Ns Cm :force
2014 simulates a click on the menu item.
2016 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2017 sets the item's minimum size to
2021 Default is the item's natural size.
2025 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2027 sets the item's style.
2034 .Ar foo Ns Cm _invoke
2038 .Sx GtkFileChooserDialog
2042 If there isn't any dialog attached to the
2045 .Qq Ar id Ns Cm \&:active Ar label .
2048 .Bl -tag -width "commands "
2050 .Qq Ar id Ns Cm :set_current_page Ar n
2051 switches to zero-based page number
2054 .Qq Ar id Ns Cm :grab_focus
2055 puts the keyboard focus onto the notebook.
2057 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2058 makes the notebook grayed out
2063 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2066 the notebook, or makes it visible
2069 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2070 sets the notebook's tooltip.
2071 Default is disabling the tooltip.
2073 .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
2074 writes a snapshot of the notebook to an image file of the specified
2077 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2078 sets the notebooks's minimum size to
2082 Default is the widget's natural size.
2086 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2088 sets the notebook's style.
2095 .Bl -tag -width "commands "
2097 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2098 makes the overlay grayed out
2103 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2106 the overlay, or makes it visible
2109 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2110 sets the overlay's tooltip.
2111 Default is disabling the tooltip.
2113 .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
2114 writes a snapshot of the overlay to an image file of the specified
2117 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2118 sets the overlay's minimum size to
2122 Default is the overlay's natural size.
2126 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2135 .Bl -tag -width "commands "
2137 .Qq Ar id Ns Cm :grab_focus
2138 puts the keyboard focus onto the handle.
2140 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2141 makes the widget grayed out
2146 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2149 the widget, or makes it visible
2152 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2153 sets the widget's tooltip.
2154 Default is disabling the tooltip.
2156 .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
2157 writes a snapshot of the widget to an image file of the specified
2160 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2161 sets the widget's minimum size to
2165 Default is the widget's natural size.
2169 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2178 The main window can be turned into a
2180 and embedded into the XEmbed socket of another process; see
2184 .Ss GtkPrintUnixDialog
2185 .Bl -tag -width "commands "
2187 .Qq Ar id Ns Cm :print Ar file.ps
2188 opens the print dialog.
2193 to the printer the user selected in the dialog.
2195 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2196 makes the dialog grayed out
2201 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2204 the dialog, or makes it visible
2207 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2213 Initially, the dialog is unblocked.
2215 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2216 sets the dialog's tooltip.
2217 Default is disabling the tooltip.
2219 .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
2220 writes a snapshot of the dialog to an image file of the specified
2223 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2224 sets the dialog's minimum size to
2228 Default is the dialog's natural size.
2232 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2234 sets the widget style.
2238 .Qq Ar id Ns Cm \&:closed
2240 .Cm GtkPrintUnixDialog
2241 window was closed by the window manager.
2244 .Bl -tag -width "commands "
2246 .Qq Ar id Ns Cm :set_fraction Ar x
2247 moves the progress bar to
2249 .Pq between 0 and 1 .
2251 .Qq Ar id Ns Cm :set_text Bq Ar string
2252 replaces the text of the progress bar with
2254 Default is the progress percentage.
2256 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2259 the progress bar, or makes it visible
2262 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2263 sets the tooltip of the progressbar.
2264 Default is disabling the tooltip.
2266 .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
2267 writes a snapshot of the progress bar to an image file of the
2270 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2271 sets the minimum size of the progress bar to
2275 Default is the natural size.
2279 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2288 .Bl -tag -width "commands "
2290 .Qq Ar id Ns Cm :set_active 1
2291 switches the button on.
2292 All other buttons of the same group will go off automatically.
2294 .Qq Ar id Ns Cm :set_label Ar string
2295 replaces the button text with
2298 .Qq Ar id Ns Cm :grab_focus
2299 puts the keyboard focus onto the button.
2301 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2302 makes the button grayed out
2307 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2310 the button, or makes it visible
2313 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2319 Initially, the button is unblocked.
2321 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2322 sets the button's tooltip.
2323 Default is disabling the tooltip.
2325 .Qq Ar id Ns Cm :force
2326 simulates a click on the button.
2328 .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
2329 writes a snapshot of the button to an image file of the specified
2332 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2333 sets the button's minimum size to
2337 Default is the button's natural size.
2341 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2347 .Qq Ar id Ns Cm \&:1
2349 .Qq Ar id Ns Cm \&:0
2353 .Bl -tag -width "commands "
2355 .Qq Ar id Ns Cm :set_value Ar x
2356 moves the slider to value
2359 .Qq Ar id Ns Cm :set_fill_level Bq Ar x
2360 moves the fill level indicator to value
2362 Default is hiding the fill level indicator.
2364 .Qq Ar id Ns Cm :set_range Ar min max
2367 .Qq Ar id Ns Cm :set_increments Ar step page
2368 sets the steps the slider moves while pressing arrow keys and
2370 .Pf / Ql Page_Down ,
2373 .Qq Ar id Ns Cm :grab_focus
2374 puts the keyboard focus onto the scale.
2376 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2377 makes the scale grayed out
2382 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2385 the scale, or makes it visible
2388 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2394 Initially, the scale is unblocked.
2396 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2397 sets the scale's tooltip.
2398 Default is disabling the tooltip.
2400 .Qq Ar id Ns Cm :force
2401 simulates fresh selection of the current value.
2403 .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
2404 writes a snapshot of the scale to an image file of the specified
2407 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2408 sets the scale's minimum size to
2412 Default is the natural size.
2416 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2422 .Qq Ar id Ns Cm \&:value Ar number
2424 .Ss GtkScrolledWindow
2425 .Bl -tag -width "commands "
2427 .Qq Ar id Ns Cm :hscroll Ar position
2429 .Qq Ar id Ns Cm :vscroll Ar position
2432 to the left or top edge of the
2433 .Cm GtkScrolledWindow ,
2436 .Qq Ar id Ns Cm :hscroll_to_range Ar pos0 pos1
2438 .Qq Ar id Ns Cm :vscroll_to_range Ar pos0 pos1
2439 scroll, if necessary, the range between
2444 .Cm GtkScrolledWindow .
2445 If the range is greater than the window, the initial part of the range
2448 .Qq Ar id Ns Cm :grab_focus
2449 puts the keyboard focus onto the widget.
2451 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2452 makes the widget grayed out
2457 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2460 the widget, or makes it visible
2463 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2464 sets the widget's tooltip.
2465 Default is disabling the tooltip.
2467 .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
2468 writes a snapshot of the widget to an image file of the specified
2471 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2472 sets the minimum size to
2476 Default is the widget's natural size.
2480 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2489 .Bl -tag -width "commands "
2491 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2492 makes the separator insensitive
2497 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2498 sets the tooltip of the separator.
2499 Default is disabling the tooltip.
2501 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2504 the separator, or makes it visible
2507 .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
2508 writes a snapshot of the separator to an image file of the specified
2511 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2512 sets the minimum size to
2516 Default is the natural size of the separator.
2520 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2522 sets the widget style.
2528 .Ss GtkSeparatorMenuItem
2529 .Bl -tag -width "commands "
2531 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2532 makes the menu item insensitive
2537 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2540 the menu item, or makes it visible
2543 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2544 sets the tooltip of the menu item.
2545 Default is disabling the tooltip.
2547 .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
2548 writes a snapshot of the menu item to an image file of the specified
2551 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2552 sets the minimum size to
2556 Default is the natural size of the menu item.
2560 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2562 sets the widget style.
2569 .Bl -tag -width "commands "
2577 may be unsupported by Glade, but its definition can be inserted
2578 manually into the GtkBuilder
2581 .Bd -literal -offset indent
2583 <object class="GtkSocket" id="socket1">
2584 <property name="visible">True</property>
2585 <property name="can_focus">True</property>
2588 <property name="expand">True</property>
2589 <property name="fill">True</property>
2590 <property name="position">1</property>
2594 .Bl -tag -width "commands "
2597 requests a feedback message containing the socket
2600 .Qq Ar id Ns Cm :grab_focus
2601 puts the keyboard focus onto the socket.
2603 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2604 makes the socket grayed out
2609 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2612 the socket, or makes it visible
2615 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2616 sets the socket's tooltip.
2617 Default is disabling the tooltip.
2618 .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
2619 writes a snapshot of the socket to an image file of the specified
2622 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2623 sets the socket's minimum size to
2627 Default is the socket's natural size.
2631 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2637 .Qq Ar id Ns Cm :id Ar xid
2638 can be used by another process to XEmbed its widgets into the
2641 .Qq Ar id Ns Cm \&:plug-added ,
2643 .Ar id Ns Cm \&:plug-removed
2645 Notification that the other process has inserted its widgets into or
2646 removed them from the
2650 .Bl -tag -width "commands "
2652 .Qq Ar id Ns Cm :set_text Ar string
2653 sets the selected value to
2656 .Qq Ar id Ns Cm :set_range Ar min max
2659 .Qq Ar id Ns Cm :set_increments Ar step page
2660 sets the steps the value changes while pressing arrow keys/left mouse
2663 .Pf / Ql Page_Down Ns
2664 /middle mouse button,
2667 .Qq Ar id Ns Cm :grab_focus
2668 puts the keyboard focus onto the button.
2670 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2671 makes the button grayed out
2676 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2679 the button, or makes it visible
2682 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2688 Initially, the button is unblocked.
2690 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2691 sets the button's tooltip.
2692 Default is disabling the tooltip.
2694 .Qq Ar id Ns Cm :force
2695 simulates fresh selection of the current value
2697 .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
2698 writes a snapshot of the button to an image file of the specified
2701 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2702 sets the button's minimum size to
2706 Default is the widget's natural size.
2710 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2712 sets the button's style.
2716 .Qq Ar id Ns Cm \&:text Ar text
2719 .Bl -tag -width "commands "
2721 .Qq Ar id Ns Cm :start
2723 .Qq Ar id Ns Cm :stop
2724 start and stop the spinner.
2726 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2727 makes the spinner grayed out
2732 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2735 the spinner, or makes it visible
2738 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2739 sets the spinner's tooltip.
2740 Default is disabling the tooltip.
2742 .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
2743 writes a snapshot of the spinner to an image file of the specified
2746 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2747 sets the spinner's minimum size to
2751 Default is the natural size.
2755 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2764 The context parameter
2766 is an arbitrary non-whitespace string.
2767 .Bl -tag -width "commands "
2769 .Qq Ar id Ns Cm :push_id Ar c string ,
2770 .Qq Ar id Ns Cm :push Ar string
2773 with context parameter
2777 respectively, and display it in the statusbar.
2779 .Qq Ar id Ns Cm :pop_id Ar c ,
2780 .Qq Ar id Ns Cm :pop
2781 remove the latest entry associated with context parameter
2785 respectively, from the statusbar.
2787 .Qq Ar id Ns Cm :remove_all_id Ar c ,
2788 .Qq Ar id Ns Cm :remove_all
2789 remove the entries associated with context parameter
2793 respectively, from the statusbar.
2795 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2796 makes the statusbar grayed out
2801 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2804 the statusbar, or makes it visible
2807 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2808 sets the statusbar's tooltip.
2809 Default is disabling the tooltip.
2811 .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
2812 writes a snapshot of the statusbar to an image file of the specified
2815 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2816 sets the statusbar's minimum size to
2820 Default is the natural size.
2824 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2826 sets the statusbar's style.
2833 .Bl -tag -width "commands "
2835 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
2836 turns the switch off
2841 .Qq Ar id Ns Cm :grab_focus
2842 puts the keyboard focus onto the switch.
2844 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2845 makes the switch grayed out
2850 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2853 the switch, or makes it visible
2856 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2862 Initially, the switch is unblocked.
2864 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2865 sets the tooltip of the switch.
2866 Default is disabling the tooltip.
2868 .Qq Ar id Ns Cm :force
2869 simulates a click on the switch.
2871 .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
2872 writes a snapshot of the switch to an image file of the specified
2875 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2876 sets the switch's minimum size to
2880 Default is the natural size.
2884 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2890 .Qq Ar id Ns Cm \&:1
2892 .Qq Ar id Ns Cm \&:0
2896 There should be a dedicated
2898 for sending (parts of) the text.
2906 .Ar foo Ns Cm _send_text
2907 will send the content of the
2912 .Ar foo Ns Cm _send_selection
2913 will send the highlighted part the
2915 .Bl -tag -width "commands "
2917 .Qq Ar id Ns Cm :set_text Ar string
2918 replaces the user-editable text with (potentially empty)
2921 .Qq Ar id Ns Cm :delete
2924 .Qq Ar id Ns Cm :insert_at_cursor Ar string
2929 .Qq Ar id Ns Cm :place_cursor Brq Ar position | Cm end
2930 places the text cursor at
2932 or at the end of the text.
2934 .Qq Ar id Ns Cm :place_cursor_at_line Ar line
2935 places the text cursor at the beginning of
2938 .Qq Ar id Ns Cm :scroll_to_cursor
2939 scrolls to the cursor position if necessary.
2941 .Qq Ar id Ns Cm :save Ar file
2946 command containing the text.
2948 .Qq Ar id Ns Cm :grab_focus
2949 puts the keyboard focus into the textview.
2951 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2952 makes the text view grayed out
2957 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2960 the text view, or makes it visible
2963 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2964 sets the tooltip of the text view.
2965 Default is disabling the tooltip.
2967 .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
2968 writes a snapshot of the text view to an image file of the specified
2971 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2972 sets the minimum size to
2976 Default is the natural size.
2980 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2986 .Qq Ar button_id Ns Cm \&:text Ar text ,
2994 and backslashes are replaced by
2998 .Bl -tag -width "commands "
3000 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
3001 switches the button off
3006 .Qq Ar id Ns Cm :set_label Ar string
3007 replaces the button text with
3010 .Qq Ar id Ns Cm :grab_focus
3011 puts the keyboard focus onto the button.
3013 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3014 makes the button grayed out
3019 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3022 the button, or makes it visible
3025 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3031 Initially, the button is unblocked.
3033 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3034 sets the button's tooltip.
3035 Default is disabling the tooltip.
3037 .Qq Ar id Ns Cm :force
3038 simulates a click on the button.
3040 .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
3041 writes a snapshot of the button to an image file of the specified
3044 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3045 sets the button's minimum size to
3049 Default is the button's natural size.
3053 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3055 sets the button's style.
3059 .Qq Ar id Ns Cm \&:1
3061 .Qq Ar id Ns Cm \&:0
3066 can deal with columns of type
3067 .Cm gboolean , gint , guint , glong , gulong , gint64 , guint64 , gfloat , gdouble ,
3074 refer to the underlying model
3077 .Cm GtkTreeStore ) .
3079 is a sequence of one or more colon-separated integers, e.g.
3083 .Bl -tag -width "commands "
3085 .Qq Ar id Ns Cm :set Ar row column data
3086 replaces the content at
3090 (which should be compatible with the type of
3092 If necessary, new tree nodes are created to obtain the minimal tree
3093 structure needed to support
3096 .Qq Ar id Ns Cm :insert_row Brq Ar row Bo Cm as_child Bc | Cm end
3097 inserts a new, empty row; either as a sibling of
3103 or at the end of the list, respectively.
3105 .Qq Ar id Ns Cm :move_row Ar origin Brq Ar destination | Cm end
3108 within its current level to
3112 .Qq Ar id Ns Cm :remove_row Ar row
3113 removes the row at position
3116 .Qq Ar id Ns Cm :clear
3119 .Qq Ar id Ns Cm :expand Ar row
3120 expands one level of the subtree below
3123 .Qq Ar id Ns Cm :expand_all Bq Ar row
3124 expands the subtree below
3128 .Qq Ar id Ns Cm :collapse Bq Ar row
3129 collapses the subtree below
3133 .Qq Ar id Ns Cm :set_cursor Bq Ar row
3138 .Qq Ar id Ns Cm :scroll Ar row column
3143 .Qq Ar id Ns Cm :save Ar file
3144 stores the content of the underlying model as a sequence of
3149 .Qq Ar id Ns Cm :grab_focus
3150 puts the keyboard focus onto the tree view.
3152 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3153 makes the tree view grayed out
3158 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3161 the tree view, or makes it visible
3164 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3170 Initially, the widget is unblocked.
3172 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3173 sets the tooltip of the tree view.
3174 Default is disabling the tooltip.
3176 .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
3177 writes a snapshot of the tree view to an image file of the specified
3180 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3181 sets the minimum size of the tree view to
3185 Default is the widget's natural size.
3189 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3195 .Qq Ar id Ns Cm \&:clicked
3197 .Qq Ar id Ns Cm \&: Ns Ar column_type row column value ,
3198 one message per cell in the underlying model for each selected row; or
3200 .Qq Ar id Ns Cm \&: Ns Ar column_type row column new_value ,
3205 .Ss GtkTreeViewColumn
3206 .Bl -tag -width "commands "
3208 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3214 Initially, the widget is unblocked.
3216 .Qq Ar id Ns Cm \&:clicked
3219 .Bl -tag -width "commands "
3221 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3222 makes the viewport insensitive
3227 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3230 the viewport, or makes it visible
3233 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3234 sets the tooltip of the viewport.
3235 Default is disabling the tooltip.
3237 .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
3238 writes a snapshot of the viewport to an image file of the specified
3241 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3242 sets the minimum size to
3246 Default is the natural size of the viewport.
3250 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3252 sets the widget style.
3259 .Bl -tag -width "commands "
3261 .Qq Ar id Ns Cm :set_title Ar string
3262 replaces the text in the title bar with
3265 .Qq Ar id Ns Cm :resize Bq Ar width height
3266 changes the window size to
3270 pixels if specified, or to the default size.
3272 .Qq Ar id Ns Cm :move Ar x y
3273 moves the window to position
3276 .Qq Ar id Ns Cm :fullscreen
3278 .Qq Ar id Ns Cm :unfullscreen
3279 switch fullscreen mode on and off.
3281 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3282 makes the widget grayed out
3287 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3290 the widget, or makes it visible
3293 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3299 Initially, the widget is unblocked.
3301 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3302 sets the window's tooltip.
3303 Default is disabling the tooltip.
3304 .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
3305 writes a snapshot of the window to an image file of the specified
3308 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3309 sets the window's minimum size to
3313 Default is the widget's natural size.
3317 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3323 .Qq Ar id Ns Cm \&:closed
3326 was closed by the window manager.
3332 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3336 of the widget style to
3338 Properties not explicitly specified are reset to their default values.
3340 .Bl -dash -offset indent -compact
3342 .Ql label1:style font:Bold 11; background-color:green
3344 .Ql label1:style font-style:italic; font-weight:bold; color:blue
3346 .Ql button1:style background-image:url("q.png")
3348 .Ql treeview1:style background-image:linear-gradient(45deg, yellow, blue);
3350 .Ql frame1:style border-color:red yellow; border-width:5px
3352 .Ql frame1:style border-radius:10px; transition:10s
3354 For color notations see
3361 .Bl -dash -offset indent -compact
3363 standard X11 colors names like
3365 .Ql Dark Sea Green ,
3371 hexadecimal values in the form
3372 .Cm # Ns Ar rgb , Cm # Ns Ar rrggbb , Cm # Ns Ar rrrgggbbb ,
3374 .Cm # Ns Ar rrrrggggbbbb ;
3376 RGB colors in the form
3377 .Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&)
3379 RGBA colors in the form
3380 .Cm rgba( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns
3381 .Ar blue Ns Cm \&, Ns Ar alpha Ns Cm \&) ;
3382 .Ar red , green , blue
3383 between 0 and 255 and
3387 color expressions like
3390 .Ql lighter(currentColor) .
3395 .Ss Discovering Pipeglade Interactively
3396 Suppose the interface in
3399 .Sx GtkLabel Ql label1
3401 .Sx GtkButton Ql button1 .
3407 .Sx GtkButton , Ql button1:clicked
3408 will be reported on the terminal.
3411 .Dl label1:set_text The Button
3413 will change the text shown on the label into
3415 .Ss One-Shot File Dialog
3416 Suppose the interface in
3417 .Pa ./simple_open.ui
3419 .Sx GtkFileChooserDialog
3427 .Dl pipeglade -u simple_open.ui
3429 will open the dialog; pressing
3431 will close it after sending the selected filename to
3433 .Ss One-Shot User Notification
3435 .Pa ./simple_dialog.ui
3437 .Sx GtkLabel Ql label1 ,
3439 .Bd -literal -offset indent
3440 pipeglade -u simple_dialog.ui <<< \e
3441 "label1:set_text NOW READ THIS!"
3443 will set the label text accordingly and wait for user input.
3444 .Ss Continuous Input
3445 The following shell command displays a running clock:
3446 .Bd -literal -offset indent
3448 echo "label1:set_text `date`";
3450 done | pipeglade -u simple_dialog.ui
3452 .Ss Continuous Input and Output
3453 The following shell script fragment sets up
3455 for continuous communication with another program,
3457 .Bd -literal -offset indent
3458 pipeglade -i in.fifo -o out.fifo -b
3459 main_prog <out.fifo >in.fifo
3472 .An Bert Burgemeister
3473 .Aq Mt trebbu@googlemail.com .
3475 Due to what appears to be a bug in cairo v1.14.0,
3477 used with this library version occasionally crashes on