Add new tests for documentation correctness
[pipeglade.git] / pipeglade.1
blob757f7d2fd14c698fbb3899cfd7884aebd054b79f
1 .\" Copyright (c) 2014-2016 Bert Burgemeister <trebbu@googlemail.com>
2 .\"
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:
10 .\"
11 .\" The above copyright notice and this permission notice shall be
12 .\" included in all copies or substantial portions of the Software.
13 .\"
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.
21 .\"
22 .Dd Jun 05, 2016
23 .Dt PIPEGLADE 1 PRM
24 .Os BSD
25 .Sh NAME
26 .Nm pipeglade
27 .Nd pipe-driven GTK+ interface
28 .Sh SYNOPSIS
29 .Nm
30 .Oo
31 .Op Fl i Ar in-fifo
32 .Op Fl o Ar out-fifo
33 .Op Fl b
34 .Op Fl u Ar builder-file
35 .Op Fl e Ar parent-xid
36 .Op Fl l Ar log-file
37 .Op Fl O Ar err-file
38 .Op Fl -display Ar X-server
39 .Oc |
40 .Op Fl h | G | V
41 .Sh DESCRIPTION
42 .Nm
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
47 .Xr glade 1
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
51 GTK+ 3.
52 Simple one-shot dialogs as well as more complex, long-running programs
53 can be built using
54 .Nm ;
55 see
56 .Sx EXAMPLES .
57 .Sh OPTIONS
58 .Bl -tag -width Ds
59 .It Fl i Ar in-fifo
60 Creates a named pipe
61 .Ar in-fifo
62 if necessary, sets its permissions to
63 .Li 0600 ,
64 and uses it for command input.
65 .Pp
66 A command is a line of text.
67 Its format is
68 .Qq Ar id Ns Cm \&: Ns Ar action Bq Ar data ,
69 .Ar id
70 being the name of the receiving widget;
71 .Ar data
72 is separated from the rest of the command by a single whitespace
73 character.
74 Commands whose first non-whitespace character is
75 .Cm #
76 are considered comments and ignored silently, as are empty input lines.
77 Any occurences of the two-character sequences
78 .Cm \en
79 and
80 .Cm \er
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
85 .Va stderr
86 and are otherwise ignored.
87 See
88 .Sx WIDGETS
89 for applicable commands.
90 .Pp
91 It is an error if
92 .Ar in-fifo
93 exists but is not a named pipe.
94 The named pipe
95 .Ar in-fifo
96 is deleted upon successful program termination.
97 .Pp
98 Default command input is
99 .Va stdin .
100 .It Fl o Ar out-fifo
101 Creates a named pipe
102 .Ar out-fifo
103 if necessary, sets its permissions to
104 .Li 0600 ,
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 ,
110 .Ar id
111 being the name of the sending widget.
113 .Sx WIDGETS
114 for possible feedback messages.
116 It is an error if
117 .Ar out-fifo
118 exists but is not a named pipe.
119 The named pipe
120 .Ar out-fifo
121 is deleted upon successful program termination.
123 Default feedback-message output is
124 .Va stdout .
125 .It Fl b
126 Runs
128 in the background after printing its process ID to
129 .Va stdout .
131 It is an error if option
132 .Fl b
133 is used and not both
134 .Fl i Ar in-fifo
136 .Fl o Ar out-fifo
137 are specified.
138 .It Fl u Ar builder-file
139 Displays the graphical user interface
140 .Ar builder-file
141 which should be created using the
142 .Xr glade 1
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
147 .Cm main .
149 Default is
150 .Pa ./pipeglade.ui .
151 .It Fl e Ar parent-xid
152 Embeds the main window into the XEmbed socket
153 .Ar parent-xid
154 of another process.
155 .It Fl l Ar log-file
156 Appends for each command a line of
157 .Qq Ar time activity
159 .Ar log-file ,
160 .Ar time
161 being the number of microseconds elapsed during
162 .Ar activity .
163 .Ar time
165 .Ar activity
166 are separated by a tab character.
167 Permissions of
168 .Ar log-file
169 are set to
170 .Li 0600 .
172 .Ar log-file
173 name of
174 .Ql -
175 means
176 .Va stderr .
177 .It Fl O Ar err-file
178 Redirects
179 .Va stderr ,
180 appending its output to
181 .Ar err-file .
182 Permissions of
183 .Ar err-file
184 are set to
185 .Li 0600 .
186 .It Fl -display Ar X-server
187 Uses the display on
188 .Ar X-server
189 for user interaction.
190 .It Fl h
191 Prints a help message and exits.
192 .It Fl G
193 Prints the versions of the underlying GTK+ and cairo libraries and
194 exits.
195 .It Fl V
196 Prints the
198 version and exits.
200 .Sh WIDGETS
201 The widget classes able to communicate through
204 .\" BEGIN_TOC
205 .Sx GtkBox ,
206 .Sx GtkButton ,
207 .Sx GtkButtonBox ,
208 .Sx GtkCalendar ,
209 .Sx GtkCheckButton ,
210 .Sx GtkColorButton ,
211 .Sx GtkComboBoxText ,
212 .Sx GtkDialog ,
213 .Sx GtkDrawingArea ,
214 .Sx GtkEntry ,
215 .Sx GtkEventBox ,
216 .Sx GtkExpander ,
217 .Sx GtkFileChooserButton ,
218 .Sx GtkFileChooserDialog ,
219 .Sx GtkFontButton ,
220 .Sx GtkFrame ,
221 .Sx GtkGrid ,
222 .Sx GtkImage ,
223 .Sx GtkImageMenuItem ,
224 .Sx GtkInfoBar ,
225 .Sx GtkLabel ,
226 .Sx GtkMenuItem ,
227 .Sx GtkNotebook ,
228 .Sx GtkOverlay ,
229 .Sx GtkPlug ,
230 .Sx GtkPrintUnixDialog ,
231 .Sx GtkProgressBar ,
232 .Sx GtkRadioButton ,
233 .Sx GtkScale ,
234 .Sx GtkScrolledWindow ,
235 .Sx GtkSeparator ,
236 .Sx GtkSeparatorMenuItem ,
237 .Sx GtkSocket ,
238 .Sx GtkSpinButton ,
239 .Sx GtkSpinner ,
240 .Sx GtkStatusbar ,
241 .Sx GtkSwitch ,
242 .Sx GtkTextView ,
243 .Sx GtkToggleButton ,
244 .Sx GtkTreeView ,
245 .Sx GtkTreeViewColumn ,
246 .Sx GtkViewport ,
248 .Sx GtkWindow .
249 .\" END_TOC
252 references a widget by the
253 .Ar id
254 attribute it is given in Glade.
255 In the
256 .Pa .ui
257 file, a
258 .Cm GtkWindow
259 named
260 .Li foo
261 would appear as
262 .Dl <object class="GtkWindow" id="foo"> .
263 .Ss Unspecific Widget
264 .Bl -tag -width "commands "
265 .It Commands
267 .Qq Ar id Ns Cm :load Ar file
268 reads arbitrary
270 commands from
271 .Ar file .
272 A non-empty
273 .Ar id
274 is required but ignored.
275 .Cm :load
276 commands may be nested but on attempts to read from the same file, the
277 inner
278 .Cm :load
279 is ignored.
280 There is also a
281 .Cm :save
282 command; see
283 .Sx GtkTextView
285 .Sx GtkTreeView .
287 .Qq Ar id Ns Cm :main_quit
288 kills the user interface.
289 A non-empty
290 .Ar id
291 is required but ignored.
293 .Ss GtkBox
294 .Bl -tag -width "commands "
295 .It Commands
296 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
297 makes the box grayed out
298 .Pq Cm 0
299 or responsive
300 .Pq Cm 1 .
302 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
303 hides
304 .Pq Cm 0
305 the box, or makes it visible
306 .Pq Cm 1 .
307 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
308 sets the box's tooltip.
309 Default is disabling the tooltip.
311 .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
312 writes a snapshot of the box to an image file of the specified
313 type.
315 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
316 sets the box's minimum size to
317 .Ar width
319 .Ar height .
320 Default is the box's natural size.
323 .Ar id Ns Cm :style
324 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
326 sets the style.
328 .Sx Style .
329 .It Feedback
330 none
332 .Ss GtkButton
333 .Bl -tag -width "commands "
334 .It Commands
335 .Qq Ar id Ns Cm :set_label Ar string
336 replaces the button text with
337 .Ar string .
339 .Qq Ar id Ns Cm :grab_focus
340 puts the keyboard focus onto the button.
342 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
343 makes the button grayed out
344 .Pq Cm 0
345 or responsive
346 .Pq Cm 1 .
348 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
349 hides
350 .Pq Cm 0
351 the widget, or makes it visible
352 .Pq Cm 1 .
354 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
355 blocks
356 .Pq Cm 1
357 or unblocks
358 .Pq Cm 0
359 feedback messages.
360 Initially, the button is unblocked.
362 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
363 sets the button's tooltip.
364 Default is disabling the tooltip.
366 .Qq Ar id Ns Cm :force
367 simulates a click on the button.
369 .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
370 writes a snapshot of the button to an image file of the specified
371 type.
373 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
374 sets the button's minimum size to
375 .Ar width
377 .Ar height .
378 Default is the button's natural size.
381 .Ar id Ns Cm :style
382 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
384 sets the style.
386 .Sx Style .
387 .It Feedback
388 .Qq Ar id Ns Cm \&:clicked
390 .Cm GtkButton Ns
391 s with ids ending in
392 .Cm _ok , _apply , _cancel , _send_text ,
394 .Cm _send_selection
395 may work differently; see
396 .Sx GtkDialog , GtkFileChooserDialog ,
398 .Sx GtkTextView
399 for details.
401 .Ss GtkButtonBox
402 .Bl -tag -width "commands "
403 .It Commands
404 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
405 makes the box grayed out
406 .Pq Cm 0
407 or responsive
408 .Pq Cm 1 .
410 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
411 hides
412 .Pq Cm 0
413 the box, or makes it visible
414 .Pq Cm 1 .
416 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
417 sets the box's tooltip.
418 Default is disabling the tooltip.
420 .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
421 writes a snapshot of the box to an image file of the specified
422 type.
424 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
425 sets the box's minimum size to
426 .Ar width
428 .Ar height .
429 Default is the box's natural size.
432 .Ar id Ns Cm :style
433 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
435 sets the style.
437 .Sx Style .
438 .It Feedback
439 none
441 .Ss GtkCalendar
442 .Bl -tag -width "commands "
443 .It Commands
444 .Qq Ar id Ns Cm :select_date Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
445 selects the date on the calendar.
447 .Qq Ar id Ns Cm :mark_day Ar day
448 marks
449 .Ar day Pq 1-31
450 on the calendar.
452 .Qq Ar id Ns Cm :clear_marks
453 unmarks all days on the calendar.
455 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
456 makes the calendar grayed out
457 .Pq Cm 0
458 or responsive
459 .Pq Cm 1 .
461 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
462 hides
463 .Pq Cm 0
464 the calendar, or makes it visible
465 .Pq Cm 1 .
467 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
468 blocks
469 .Pq Cm 1
470 or unblocks
471 .Pq Cm 0
472 feedback messages.
473 Initially, the calendar is unblocked.
475 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
476 sets the calendar's tooltip.
477 Default is disabling the tooltip.
479 .Qq Ar id Ns Cm :force
480 simulates a click on the currently selected date.
482 .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
483 writes a snapshot of the calendar to an image file of the specified
484 type.
486 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
487 sets the calendar's minimum size to
488 .Ar width
490 .Ar height .
491 Default is the widget's natural size.
494 .Ar id Ns Cm :style
495 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
497 sets the calendar's style.
499 .Sx Style .
500 .It Feedback
501 .Qq Ar id Ns Cm \&:clicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
503 .Qq Ar id Ns Cm \&:doubleclicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
505 .Ss GtkCheckButton
506 .Bl -tag -width "commands "
507 .It Commands
508 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
509 switches the check mark off
510 .Pq Cm 0
511 or on
512 .Pq Cm 1 .
514 .Qq Ar id Ns Cm :set_label Ar string
515 replaces the button text with
516 .Ar string .
518 .Qq Ar id Ns Cm :grab_focus
519 puts the keyboard focus onto the button.
521 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
522 makes the button grayed out
523 .Pq Cm 0
524 or responsive
525 .Pq Cm 1 .
527 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
528 hides
529 .Pq Cm 0
530 the button, or makes it visible
531 .Pq Cm 1 .
533 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
534 blocks
535 .Pq Cm 1
536 or unblocks
537 .Pq Cm 0
538 feedback messages.
539 Initially, the button is unblocked.
541 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
542 sets the button's tooltip.
543 Default is disabling the tooltip.
545 .Qq Ar id Ns Cm :force
546 simulates a click on the button.
548 .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
549 writes a snapshot of the button to an image file of the specified
550 type.
552 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
553 sets the button's minimum size to
554 .Ar width
556 .Ar height .
557 Default is the widget's natural size.
560 .Ar id Ns Cm :style
561 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
563 sets the button's style.
565 .Sx Style .
566 .It Feedback
567 .Qq Ar id Ns Cm \&:1
568 if switched on, or
569 .Qq Ar id Ns Cm \&:0
570 otherwise.
572 .Ss GtkColorButton
573 .Bl -tag -width "commands "
574 .It Commands
575 .Qq Ar id Ns Cm :set_color Ar color
576 preselects the color; see
577 .Sx Color .
579 .Qq Ar id Ns Cm :grab_focus
580 puts the keyboard focus onto the button.
582 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
583 makes the button grayed out
584 .Pq Cm 0
585 or responsive
586 .Pq Cm 1 .
588 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
589 hides
590 .Pq Cm 0
591 the button, or makes it visible
592 .Pq Cm 1 .
594 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
595 blocks
596 .Pq Cm 1
597 or unblocks
598 .Pq Cm 0
599 feedback messages.
600 Initially, the button is unblocked.
602 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
603 sets the button's tooltip.
604 Default is disabling the tooltip.
606 .Qq Ar id Ns Cm :force
607 opens the dialog window.
609 .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
610 writes a snapshot of the button to an image file of the specified
611 type.
613 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
614 sets the button's minimum size to
615 .Ar width
617 .Ar height .
618 Default is the widget's natural size.
621 .Ar id Ns Cm :style
622 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
624 sets the button's style.
626 .Sx Style .
627 .It Feedback
628 .Qq Ar id Ns Cm \&:color Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&)
630 .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 \&) .
631 .Ar red , green ,
633 .Ar blue
634 lie between 0 and 255, and
635 .Ar alpha
636 between 0 and 1.
638 .Ss GtkComboBoxText
640 .Cm GtkComboBoxText
641 should contain a
642 .Cm GtkEntry .
643 .Bl -tag -width "commands "
644 .It Commands
645 .Qq Ar id Ns Cm :prepend_text Ar string
647 .Qq Ar id Ns Cm :append_text Ar string
648 prepend/append a new selectable item marked
649 .Ar string .
651 .Qq Ar id Ns Cm :insert_text Ar position string
652 inserts item
653 .Ar string
655 .Ar position .
657 .Qq Ar id Ns Cm :remove Ar position
658 removes the item at
659 .Ar position .
661 .Qq Ar id Ns Cm :grab_focus
662 puts the keyboard focus onto the combo box.
664 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
665 makes the combo box grayed out
666 .Pq Cm 0
667 or responsive
668 .Pq Cm 1 .
670 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
671 hides
672 .Pq Cm 0
673 the combo box, or makes it visible
674 .Pq Cm 1 .
676 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
677 blocks
678 .Pq Cm 1
679 or unblocks
680 .Pq Cm 0
681 feedback messages.
682 Initially, the combo box is unblocked.
684 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
685 sets the tooltip.
686 Default is disabling the tooltip.
688 .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
689 writes a snapshot of the combo box to an image file of the specified
690 type.
692 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
693 sets the combo box's minimum size to
694 .Ar width
696 .Ar height .
697 Default is the natural size.
700 .Ar id Ns Cm :style
701 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
703 sets the style.
705 .Sx Style .
706 .It Feedback
707 .Qq Ar entry_id Ns Cm \&:text Ar text ,
708 .Ar entry_id
709 being the id of the child
710 .Cm GtkEntry .
712 .Ss GtkDialog
714 .Cm GtkDialog
715 with id
716 .Ar foo
717 will be invoked by a
718 .Sx GtkMenuItem
719 or a
720 .Sx GtkImageMenuItem
721 with id
722 .Ar foo Ns Cm _invoke .
725 .Cm GtkDialog
726 should have a
727 .Sq Cancel
728 .Sx GtkButton
729 with id
730 .Ar foo Ns Cm _cancel
731 .Po Cm main_cancel
732 if the dialog is the sole window of the GUI and therefore named
733 .Cm main
734 .Pc .
736 If the
737 .Cm GtkDialog
738 has an
739 .Sq Ok
740 .Sx GtkButton
741 with id
742 .Ar foo Ns Cm _ok ,
743 it will take care of hiding the dialog window.
744 .Bl -tag -width "commands "
745 .It Commands
746 .Qq Ar id Ns Cm :set_title Ar string
747 replaces the text in the title bar with
748 .Ar string .
750 .Qq Ar id Ns Cm :resize Bq Ar width height
751 changes the size of the dialog window to
752 .Ar width
754 .Ar height
755 pixels if specified, or to the default size.
757 .Qq Ar id Ns Cm :move Ar x y
758 moves the dialog window to position
759 .Pq Ar x , y .
761 .Qq Ar id Ns Cm :fullscreen
763 .Qq Ar id Ns Cm :unfullscreen
764 switch fullscreen mode on and off.
766 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
767 makes the dialog grayed out
768 .Pq Cm 0
769 or responsive
770 .Pq Cm 1 .
772 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
773 hides
774 .Pq Cm 0
775 the dialog, or makes it visible
776 .Pq Cm 1 .
778 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
779 blocks
780 .Pq Cm 1
781 or unblocks
782 .Pq Cm 0
783 feedback messages from the dialog window.
784 Initially, the window is unblocked.
786 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
787 sets the dialog window's tooltip.
788 Default is disabling the tooltip.
790 .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
791 writes a snapshot of the dialog window to an image file of the
792 specified type.
794 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
795 sets the dialog window's minimum size to
796 .Ar width
798 .Ar height .
799 Default is its natural size.
802 .Ar id Ns Cm :style
803 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
805 sets the dialog window's style.
807 .Sx Style .
808 .It Feedback
809 .Qq Ar id Ns Cm \&:closed
810 if the
811 .Cm GtkDialog
812 window was closed by the window manager.
814 .Ss GtkDrawingArea
815 Drawing commands
816 expect a context parameter of the form
817 .Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
818 where
819 .Ar n
820 is an arbitrary non-negative integer that can be used later to
821 reference the command.
822 The first form,
823 .Ar n ,
824 appends its command to the current list of drawing operations.
825 The second form,
826 .Cm = Ns Ar n ,
827 replaces the first drawing operation with context parameter
828 .Ar n
829 by the new command.
830 The third form,
831 .Ar n Ns Cm < Ns Ar m ,
832 inserts its command before the first drawing operation with context
833 parameter
834 .Ar m .
835 Both second and third form fall back to appending.
837 The default coordinate system is a left-handed system with its origin
838 in the upper-left corner.
839 Angles increase from the positive X axis towards the positve Y axis
840 .Pq clockwise in the default system .
841 .Bl -tag -width "commands "
842 .It Commands
843 .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
844 adds a circular arc to the current path.
845 The arc is centered at
846 .Pq Ar x , y
847 and proceeds from
848 .Ar angle1
850 .Ar angle2
851 .Pq in degrees .
853 .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
854 adds a circular arc to the current path.
855 The arc is centered at
856 .Pq Ar x , y
857 and proceeds in the direction of decreasing angles from
858 .Ar angle1
860 .Ar angle2
861 .Pq in degrees .
863 .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
864 adds a line segment from the current point to the point most recently
865 passed to
866 .Ar id Ns Cm :move_to
868 .Ar id Ns Cm :rel_move_to .
870 .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
871 adds a cubic Bezier spline from the current point to
872 .Pq Ar x3 , y3 ,
873 using
874 .Pq Ar x1 , y1
876 .Pq Ar x2 , y2
877 as control points.
878 If there is no current point, the curve will start at
879 .Pq Ar x1 , y1 .
881 .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
882 fills the current path and clears it.
884 .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
885 fills the current path without clearing it.
887 .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
888 adds a line from the current point to
889 .Pq Ar x , y ,
890 or creates a new current point at
891 .Pq Ar x , y .
893 .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
894 sets the current point to
895 .Pq Ar x , y .
897 .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
898 adds a rectangle to the current path.
899 The top left corner is at
900 .Pq Ar x , y .
902 .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
903 adds a cubic Bezier spline from the current point to
904 .Pq Ar dx3 , dy3 ,
905 using
906 .Pq Ar dx1 , dy1
908 .Pq Ar dx2 , dy2
909 as control points.
910 All coordinates are offsets relative to the current point.
912 .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
913 adds a line from the current point to a point offset from there by
914 .Pq Ar dx , dy .
916 .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
917 .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
918 .Ar text
920 moves the current point such that
921 .Qq Ar id Ns Cm :show_text Ar n text
922 will place the specified reference point of
923 .Ar text
924 on the original current point.
926 .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
927 moves the current point by
928 .Pq Ar dx , dy .
930 .Qq Ar id Ns Cm :remove Ar n
931 removes the elements with context parameter
932 .Ar n
933 from the
934 .Cm GtkDrawingArea Ar id .
936 .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
937 rotates the user space axes by
938 .Ar angle
939 .Pq in degrees .
941 .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
942 scales the user space axes by
943 .Pq Ar sx , sy .
945 .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
946 sets the dash pattern to
947 .Ar l
949 .Ar l
950 off.
952 .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 ...
953 resets the dash pattern to a line with arbitrary on/off portions.
955 .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
956 resets the dash pattern to a solid line.
958 .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
959 .Brq Cm normal | italic | oblique
960 .Brq Cm normal | bold
961 .Bq Cm family
963 sets the font face for subsequent calls of
964 .Ar id Ns Cm :show_text .
966 .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
967 sets the font size for subsequent calls of
968 .Ar id Ns Cm :show_text .
970 .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
971 sets the line cap style.
972 Default is
973 .Cm butt .
975 .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
976 sets the line junction style.
977 Default is
978 .Cm miter .
980 .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
981 sets the line width.
982 Default
983 .Ar width
984 is 2.
986 .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
987 sets the color.
988 .Ar color
989 is in the format used with
990 .Sx GtkColorButton .
992 .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
993 writes
994 .Ar text ,
995 beginning at the current point.
997 .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
998 strokes the current path and clears it.
1000 .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
1001 strokes the current path without clearing it.
1003 .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
1004 modifies the current transformation matrix such that
1006 .Dl Va x' Li = Ar xx Va x Li + Ar xy Va y Li + Ar x0 ,
1007 .Dl Va y' Li = Ar yx Va y Li + Ar yy Va y Li + Ar y0 .
1009 Default is resetting the current transformation matrix.
1011 .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
1012 translates the user space origin by
1013 .Pq Ar tx , ty .
1015 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1016 hides
1017 .Pq Cm 0
1018 the drawing area, or makes it visible
1019 .Pq Cm 1 .
1021 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1022 sets the drawing area's tooltip.
1023 Default is disabling the tooltip.
1025 .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
1026 writes a snapshot of the drawing area to an image file of the specified
1027 type.
1029 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1030 sets the drawing areas's minimum size to
1031 .Ar width
1033 .Ar height .
1034 Default is the natural size.
1035 .It Feedback
1036 none
1038 .Ss GtkEntry
1039 .Bl -tag -width "commands "
1040 .It Commands
1041 .Qq Ar id Ns Cm :set_text Ar string
1042 replaces the user-editable text with
1043 .Ar string .
1045 .Qq Ar id Ns Cm :set_placeholder_text Ar string
1046 sets the
1047 .Ar string
1048 that is displayed when the entry is empty and unfocused.
1050 .Qq Ar id Ns Cm :grab_focus
1051 puts the keyboard focus into the entry.
1053 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1054 makes the entry grayed out
1055 .Pq Cm 0
1056 or responsive
1057 .Pq Cm 1 .
1059 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1060 hides
1061 .Pq Cm 0
1062 the entry, or makes it visible
1063 .Pq Cm 1 .
1065 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1066 blocks
1067 .Pq Cm 1
1068 or unblocks
1069 .Pq Cm 0
1070 feedback messages.
1071 Initially, the entry is unblocked.
1073 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1074 sets the entry's tooltip.
1075 Default is disabling the tooltip.
1077 .Qq Ar id Ns Cm :force
1078 lets the entry report its current content.
1080 .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
1081 writes a snapshot of the entry to an image file of the specified
1082 type.
1084 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1085 sets the entry's minimum size to
1086 .Ar width
1088 .Ar height .
1089 Default is the entry's natural size.
1092 .Ar id Ns Cm :style
1093 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1095 sets the style.
1097 .Sx Style .
1098 .It Feedback
1099 .Qq Ar id Ns Cm \&:text Ar text ,
1100 once for each change of
1101 .Ar text .
1103 .Ss GtkEventBox
1104 .Ar x , y
1105 are mouse pointer coordinates relative to the
1106 .Cm GtkEventBox .
1107 .Bl -tag -width "commands "
1108 .It Commands
1109 .Qq Ar id Ns Cm :grab_focus
1110 puts the keyboard focus onto the event box.
1112 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1113 makes the event box insensitive
1114 .Pq Cm 0
1115 or responsive
1116 .Pq Cm 1 .
1118 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1119 blocks
1120 .Pq Cm 1
1121 or unblocks
1122 .Pq Cm 0
1123 feedback messages.
1124 Initially, the event box is unblocked.
1126 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1127 sets the tooltip of the event box.
1128 Default is disabling the tooltip.
1130 .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
1131 writes a snapshot of the event box to an image file of the specified
1132 type.
1134 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1135 sets the minimum size to
1136 .Ar width
1138 .Ar height .
1139 Default is the natural size of the event box.
1142 .Ar id Ns Cm :style
1143 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1145 sets the widget style.
1147 .Sx Style .
1148 .It Feedback
1149 .Qq Ar id Ns Cm \&:button_press Ar b x y ,
1150 .Qq Ar id Ns Cm \&:button_release Ar b x y
1151 where
1152 .Ar b
1153 is the mouse button (normally 1, 2, or 3 for the left, middle, and
1154 right button; others may exist).
1156 .Qq Ar id Ns Cm \&:motion Ar x y
1157 is reported repeatedly while the mouse is being moved with a button
1158 pressed.
1160 .Qq Ar id Ns Cm \&:key_press Ar key ,
1161 .Ar key
1162 being the key's name
1163 .Po e.g.
1164 .Ql Control_L ,
1165 .Ql Tab ,
1166 .Ql a
1167 .Pc .
1169 .Ss GtkExpander
1170 .Bl -tag -width "commands "
1171 .It Commands
1172 .Qq Ar id Ns Cm :set_label Ar string
1173 replaces the expander label text with
1174 .Ar string .
1176 .Qq Ar id Ns Cm :set_expanded Brq Cm 0 Ns | Ns  1
1177 hides
1178 .Pq Cm 0
1179 the child widget, or makes it visible
1180 .Pq Cm 1 .
1182 .Qq Ar id Ns Cm :grab_focus
1183 puts the keyboard focus onto the expander.
1185 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1186 makes the expander grayed out
1187 .Pq Cm 0
1188 or responsive
1189 .Pq Cm 1 .
1191 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1192 hides
1193 .Pq Cm 0
1194 the expander, or makes it visible
1195 .Pq Cm 1 .
1197 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1198 sets the expander's tooltip.
1199 Default is disabling the tooltip.
1201 .Qq Ar id Ns Cm :force
1202 toggles the expansion state.
1204 .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
1205 writes a snapshot of the expander to an image file of the specified
1206 type.
1208 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1209 sets the expander's minimum size to
1210 .Ar width
1212 .Ar height .
1213 Default is the natural size.
1216 .Ar id Ns Cm :style
1217 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1219 sets the style.
1221 .Sx Style .
1222 .It Feedback
1223 none
1225 .Ss GtkGrid
1226 .Bl -tag -width "commands "
1227 .It Commands
1228 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1229 hides
1230 .Pq Cm 0
1231 the grid, or makes it visible
1232 .Pq Cm 1 .
1233 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1234 sets the grid's tooltip.
1235 Default is disabling the tooltip.
1237 .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
1238 writes a snapshot of the grid to an image file of the specified
1239 type.
1241 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1242 sets the grid's minimum size to
1243 .Ar width
1245 .Ar height .
1246 Default is the grid's natural size.
1249 .Ar id Ns Cm :style
1250 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1252 sets the style.
1254 .Sx Style .
1255 .It Feedback
1256 none
1258 .Ss GtkFileChooserButton
1259 .Bl -tag -width "commands "
1260 .It Commands
1261 .Qq Ar id Ns Cm :set_filename Ar path
1262 preselects
1263 .Ar path
1264 to the extent it exists.
1266 .Qq Ar id Ns Cm :grab_focus
1267 puts the keyboard focus onto the button.
1269 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1270 makes the button grayed out
1271 .Pq Cm 0
1272 or responsive
1273 .Pq Cm 1 .
1275 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1276 hides
1277 .Pq Cm 0
1278 the button, or makes it visible
1279 .Pq Cm 1 .
1281 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1282 blocks
1283 .Pq Cm 1
1284 or unblocks
1285 .Pq Cm 0
1286 feedback messages.
1287 Initially, the button is unblocked.
1289 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1290 sets the button's tooltip.
1291 Default is disabling the tooltip.
1293 .Qq Ar id Ns Cm :force
1294 simulates fresh selection of the currently selected pathname.
1296 .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
1297 writes a snapshot of the button to an image file of the specified
1298 type.
1300 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1301 sets the button's minimum size to
1302 .Ar width
1304 .Ar height .
1305 Default is the widget's natural size.
1308 .Ar id Ns Cm :style
1309 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1311 sets the style.
1313 .Sx Style .
1314 .It Feedback
1315 .Qq Ar id Ns Cm \&:file Ar pathname
1316 if the selection has changed.
1318 .Ss GtkFileChooserDialog
1320 .Cm GtkFileChooserDialog
1321 with id
1322 .Ar foo
1323 will be invoked by a
1324 .Sx GtkMenuItem
1325 or a
1326 .Sx GtkImageMenuItem
1327 with id
1328 .Ar foo Ns Cm _invoke .
1331 .Cm GtkFileChooserDialog
1332 should have an
1333 .Sq OK
1334 .Sx GtkButton
1335 with id
1336 .Ar foo Ns Cm _ok
1337 .Po Cm main_ok
1338 if the dialog is the sole window of the GUI and therefore named
1339 .Cm main
1340 .Pc .
1343 .Cm GtkFileChooserDialog
1344 may have a
1345 .Sq Cancel
1346 .Sx GtkButton
1347 with id
1348 .Ar foo Ns Cm _cancel
1349 .Po Cm main_cancel
1350 if the dialog is the sole window of the GUI and therefore named
1351 .Cm main
1352 .Pc .
1355 .Cm GtkFileChooserDialog
1356 may have an
1357 .Sq Apply
1358 .Sx GtkButton
1359 with id
1360 .Ar foo Ns Cm _apply
1361 .Po Cm main_apply
1362 if the dialog is the sole window of the GUI and therefore named
1363 .Cm main
1364 .Pc .
1365 .Bl -tag -width "commands "
1366 .It Commands
1367 .Qq Ar id Ns Cm :set_filename Ar path
1368 preselects
1369 .Ar path
1370 to the extent it exists.
1372 .Qq Ar id Ns Cm :set_current_name Ar string
1373 makes
1374 .Ar string
1375 the suggested filename, which may not yet exist.
1376 .Ar string
1377 should either resemble an absolute path, or the
1378 .Ar directory
1379 must be set separately by
1380 .Ar id Ns Cm :set_filename Ar directory .
1382 .Qq Ar id Ns Cm :set_title Ar string
1383 replaces the text in the title bar with
1384 .Ar string .
1386 .Qq Ar id Ns Cm :resize Bq Ar width height
1387 changes the size of the dialog window to
1388 .Ar width
1390 .Ar height
1391 pixels if specified, or to the default size.
1393 .Qq Ar id Ns Cm :move Ar x y
1394 moves the dialog window to position
1395 .Pq Ar x , y .
1397 .Qq Ar id Ns Cm :fullscreen
1399 .Qq Ar id Ns Cm :unfullscreen
1400 switch fullscreen mode on and off.
1402 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1403 makes the dialog grayed out
1404 .Pq Cm 0
1405 or responsive
1406 .Pq Cm 1 .
1408 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1409 hides
1410 .Pq Cm 0
1411 the dialog, or makes it visible
1412 .Pq Cm 1 .
1414 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1415 blocks
1416 .Pq Cm 1
1417 or unblocks
1418 .Pq Cm 0
1419 feedback messages form the dialog window.
1420 Initially, the widget is unblocked.
1422 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1423 sets the dialog window's tooltip.
1424 Default is disabling the tooltip.
1426 .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
1427 writes a snapshot of the widget to an image file of the specified
1428 type.
1430 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1431 sets the widget's minimum size to
1432 .Ar width
1434 .Ar height .
1435 Default is the widget's natural size.
1438 .Ar id Ns Cm :style
1439 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1441 sets the widget style.
1443 .Sx Style .
1444 .It Feedback
1445 .Qq Ar id Ns Cm \&:file Ar pathname
1446 and/or
1447 .Qq Ar id Ns Cm \&:folder Ar pathname
1449 .Qq Ar id Ns Cm \&:closed
1450 if the
1451 .Cm GtkFileChooserDialog
1452 window was closed by the window manager.
1454 .Ss GtkFontButton
1455 .Bl -tag -width "commands "
1456 .It Commands
1457 .Qq Ar id Ns Cm :set_font_name Ar fontname
1458 preselects the font.
1460 .Qq Ar id Ns Cm :grab_focus
1461 puts the keyboard focus onto the button.
1463 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1464 makes the button grayed out
1465 .Pq Cm 0
1466 or responsive
1467 .Pq Cm 1 .
1469 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1470 hides
1471 .Pq Cm 0
1472 the button, or makes it visible
1473 .Pq Cm 1 .
1475 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1476 blocks
1477 .Pq Cm 1
1478 or unblocks
1479 .Pq Cm 0
1480 feedback messages.
1481 Initially, the button is unblocked.
1483 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1484 sets the button's tooltip.
1485 Default is disabling the tooltip.
1487 .Qq Ar id Ns Cm :force
1488 opens the dialog window.
1490 .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
1491 writes a snapshot of the button to an image file of the specified
1492 type.
1494 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1495 sets the button's minimum size to
1496 .Ar width
1498 .Ar height .
1499 Default is the button's natural size.
1502 .Ar id Ns Cm :style
1503 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1505 sets the style.
1507 .Sx Style .
1508 .It Feedback
1509 .Qq Ar id Ns Cm \&:font Ar fontname
1511 .Ss GtkFrame
1512 .Bl -tag -width "commands "
1513 .It Commands
1514 .Qq Ar id Ns Cm :set_label Ar text
1515 replaces the frame label text with
1516 .Ar string .
1518 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1519 makes the frame and its content grayed out
1520 .Pq Cm 0
1521 or responsive
1522 .Pq Cm 1 .
1524 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1525 hides
1526 .Pq Cm 0
1527 the frame, or makes it visible
1528 .Pq Cm 1 .
1530 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1531 sets the frame's tooltip.
1532 Default is disabling the tooltip.
1534 .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
1535 writes a snapshot of the frame to an image file of the specified
1536 type.
1538 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1539 sets the widget's minimum size to
1540 .Ar width
1542 .Ar height .
1543 Default is the frame's natural size.
1546 .Ar id Ns Cm :style
1547 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1549 sets the style.
1551 .Sx Style .
1552 .It Feedback
1553 none
1555 .Ss GtkImage
1556 .Bl -tag -width "commands "
1557 .It Commands
1558 .Qq Ar id Ns Cm :set_from_icon_name Ar icon-name
1559 replaces the image with one of the standard icons.
1561 .Qq Ar id Ns Cm :set_from_file Ar path
1562 replaces the image by the one found at
1563 .Ar path Ns .
1565 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1566 hides
1567 .Pq Cm 0
1568 the image, or makes it visible
1569 .Pq Cm 1 .
1571 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1572 sets the image's tooltip.
1573 Default is disabling the tooltip.
1575 .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
1576 writes a snapshot of the image to an image file of the specified
1577 type.
1579 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1580 sets the images's minimum size to
1581 .Ar width
1583 .Ar height .
1584 Default is the image's natural size.
1587 .Ar id Ns Cm :style
1588 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1590 sets the style.
1592 .Sx Style .
1593 .It Feedback
1594 none
1596 .Ss GtkImageMenuItem
1597 .Bl -tag -width "commands "
1598 .It Commands
1599 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1600 makes the item grayed out
1601 .Pq Cm 0
1602 or responsive
1603 .Pq Cm 1 .
1605 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1606 hides
1607 .Pq Cm 0
1608 the item, or makes it visible
1609 .Pq Cm 1 .
1611 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1612 blocks
1613 .Pq Cm 1
1614 or unblocks
1615 .Pq Cm 0
1616 feedback messages.
1617 Initially, the item is unblocked.
1619 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1620 sets the item's tooltip.
1621 Default is disabling the tooltip.
1623 .Qq Ar id Ns Cm :force
1624 simulates a click on the menu item.
1626 .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
1627 writes a snapshot of the menu item to an image file of the specified
1628 type.
1630 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1631 sets the item's minimum size to
1632 .Ar width
1634 .Ar height .
1635 Default is the item's natural size.
1638 .Ar id Ns Cm :style
1639 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1641 sets the item's style.
1643 .Sx Style .
1644 .It Feedback
1646 .Cm GtkMenuItem
1648 .Cm GtkImageMenuItem
1649 with id
1650 .Ar foo Ns Cm _invoke
1651 will invoke the
1652 .Sx GtkDialog
1654 .Sx GtkFileChooserDialog
1655 with id
1656 .Ar foo
1657 if it exists.
1658 If there isn't any dialog attached to the
1659 .Cm GtkMenuItem ,
1660 it reports
1661 .Qq Ar id Ns Cm \&:active Ar label .
1663 .Ss GtkInfoBar
1664 .Bl -tag -width "commands "
1665 .It Commands
1666 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1667 makes the info bar grayed out
1668 .Pq Cm 0
1669 or responsive
1670 .Pq Cm 1 .
1672 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1673 hides
1674 .Pq Cm 0
1675 the info bar, or makes it visible
1676 .Pq Cm 1 .
1678 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1679 sets the info bar's tooltip.
1680 Default is disabling the tooltip.
1682 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1683 sets the info bar's minimum size to
1684 .Ar width
1686 .Ar height .
1687 Default is the info bar's natural size.
1690 .Ar id Ns Cm :style
1691 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1693 sets the style.
1695 .Sx Style .
1696 .It Feedback
1697 none
1699 .Ss GtkLabel
1700 .Bl -tag -width "commands "
1701 .It Commands
1702 .Qq Ar id Ns Cm :set_text Ar string
1703 replaces the label text with
1704 .Ar string .
1706 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1707 makes the label grayed out
1708 .Pq Cm 0
1709 or clearly visible
1710 .Pq Cm 1 .
1712 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1713 hides
1714 .Pq Cm 0
1715 the label, or makes it visible
1716 .Pq Cm 1 .
1718 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1719 sets the label's tooltip.
1720 Default is disabling the tooltip.
1722 .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
1723 writes a snapshot of the label to an image file of the specified
1724 type.
1726 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1727 sets the label's minimum size to
1728 .Ar width
1730 .Ar height .
1731 Default is the natural size.
1734 .Ar id Ns Cm :style
1735 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1737 sets the label's style.
1739 .Sx Style .
1740 .It Feedback
1741 none
1743 .Ss GtkMenuItem
1744 .Bl -tag -width "commands "
1745 .It Commands
1746 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1747 makes the item grayed out
1748 .Pq Cm 0
1749 or responsive
1750 .Pq Cm 1 .
1752 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1753 hides
1754 .Pq Cm 0
1755 the item, or makes it visible
1756 .Pq Cm 1 .
1758 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1759 blocks
1760 .Pq Cm 1
1761 or unblocks
1762 .Pq Cm 0
1763 feedback messages.
1764 Initially, the item is unblocked.
1766 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1767 sets the item's tooltip.
1768 Default is disabling the tooltip.
1770 .Qq Ar id Ns Cm :force
1771 simulates a click on the menu item.
1773 .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
1774 writes a snapshot of the menu item to an image file of the specified
1775 type.
1777 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1778 sets the item's minimum size to
1779 .Ar width
1781 .Ar height .
1782 Default is the item's natural size.
1785 .Ar id Ns Cm :style
1786 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1788 sets the item's style.
1790 .Sx Style .
1791 .It Feedback
1793 .Cm GtkMenuItem
1795 .Cm GtkImageMenuItem
1796 with id
1797 .Ar foo Ns Cm _invoke
1798 will invoke the
1799 .Sx GtkDialog
1801 .Sx GtkFileChooserDialog
1802 with id
1803 .Ar foo
1804 if it exists.
1805 If there isn't any dialog attached to the
1806 .Cm GtkMenuItem ,
1807 it reports
1808 .Qq Ar id Ns Cm \&:active Ar label .
1810 .Ss GtkNotebook
1811 .Bl -tag -width "commands "
1812 .It Commands
1813 .Qq Ar id Ns Cm :set_current_page Ar n
1814 switches to zero-based page number
1815 .Ar n .
1817 .Qq Ar id Ns Cm :grab_focus
1818 puts the keyboard focus onto the notebook.
1820 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1821 makes the notebook grayed out
1822 .Pq Cm 0
1823 or responsive
1824 .Pq Cm 1 .
1826 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1827 hides
1828 .Pq Cm 0
1829 the notebook, or makes it visible
1830 .Pq Cm 1 .
1832 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1833 sets the notebook's tooltip.
1834 Default is disabling the tooltip.
1836 .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
1837 writes a snapshot of the notebook to an image file of the specified
1838 type.
1840 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1841 sets the notebooks's minimum size to
1842 .Ar width
1844 .Ar height .
1845 Default is the widget's natural size.
1848 .Ar id Ns Cm :style
1849 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1851 sets the notebook's style.
1853 .Sx Style .
1854 .It Feedback
1855 none
1857 .Ss GtkOverlay
1858 .Bl -tag -width "commands "
1859 .It Commands
1860 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1861 makes the overlay grayed out
1862 .Pq Cm 0
1863 or responsive
1864 .Pq Cm 1 .
1866 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1867 hides
1868 .Pq Cm 0
1869 the overlay, or makes it visible
1870 .Pq Cm 1 .
1872 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1873 sets the overlay's tooltip.
1874 Default is disabling the tooltip.
1876 .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
1877 writes a snapshot of the overlay to an image file of the specified
1878 type.
1880 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1881 sets the overlay's minimum size to
1882 .Ar width
1884 .Ar height .
1885 Default is the overlay's natural size.
1888 .Ar id Ns Cm :style
1889 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1891 sets the style.
1893 .Sx Style .
1894 .It Feedback
1895 none
1897 .Ss GtkPlug
1898 The main window can be turned into a
1899 .Cm GtkPlug
1900 and embedded into the XEmbed socket of another process; see
1901 .Sx OPTIONS ,
1902 option
1903 .Fl e .
1904 .Ss GtkPrintUnixDialog
1905 .Bl -tag -width "commands "
1906 .It Commands
1907 .Qq Ar id Ns Cm :print Ar file.ps
1908 opens the print dialog.
1909 Pressing the
1910 .Ql Print
1911 button sends
1912 .Ar file.ps
1913 to the printer the user selected in the dialog.
1915 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1916 makes the dialog grayed out
1917 .Pq Cm 0
1918 or responsive
1919 .Pq Cm 1 .
1921 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1922 hides
1923 .Pq Cm 0
1924 the dialog, or makes it visible
1925 .Pq Cm 1 .
1927 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1928 blocks
1929 .Pq Cm 1
1930 or unblocks
1931 .Pq Cm 0
1932 feedback messages.
1933 Initially, the dialog is unblocked.
1935 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1936 sets the dialog's tooltip.
1937 Default is disabling the tooltip.
1939 .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
1940 writes a snapshot of the dialog to an image file of the specified
1941 type.
1943 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1944 sets the dialog's minimum size to
1945 .Ar width
1947 .Ar height .
1948 Default is the dialog's natural size.
1951 .Ar id Ns Cm :style
1952 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1954 sets the widget style.
1956 .Sx Style .
1957 .It Feedback
1958 .Qq Ar id Ns Cm \&:closed
1959 if the
1960 .Cm GtkPrintUnixDialog
1961 window was closed by the window manager.
1963 .Ss GtkProgressBar
1964 .Bl -tag -width "commands "
1965 .It Commands
1966 .Qq Ar id Ns Cm :set_fraction Ar x
1967 moves the progress bar to
1968 .Ar x
1969 .Pq between 0 and 1 .
1971 .Qq Ar id Ns Cm :set_text Bq Ar string
1972 replaces the text of the progress bar with
1973 .Ar string .
1974 Default is the progress percentage.
1976 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1977 hides
1978 .Pq Cm 0
1979 the progress bar, or makes it visible
1980 .Pq Cm 1 .
1982 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1983 sets the tooltip of the progressbar.
1984 Default is disabling the tooltip.
1986 .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
1987 writes a snapshot of the progress bar to an image file of the
1988 specified type.
1990 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1991 sets the minimum size of the progress bar to
1992 .Ar width
1994 .Ar height .
1995 Default is the natural size.
1998 .Ar id Ns Cm :style
1999 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2001 sets the style.
2003 .Sx Style .
2004 .It Feedback
2005 none
2007 .Ss GtkRadioButton
2008 .Bl -tag -width "commands "
2009 .It Commands
2010 .Qq Ar id Ns Cm :set_active 1
2011 switches the button on.
2012 All other buttons of the same group will go off automatically.
2014 .Qq Ar id Ns Cm :set_label Ar string
2015 replaces the button text with
2016 .Ar string .
2018 .Qq Ar id Ns Cm :grab_focus
2019 puts the keyboard focus onto the button.
2021 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2022 makes the button grayed out
2023 .Pq Cm 0
2024 or responsive
2025 .Pq Cm 1 .
2027 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2028 hides
2029 .Pq Cm 0
2030 the button, or makes it visible
2031 .Pq Cm 1 .
2033 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2034 blocks
2035 .Pq Cm 1
2036 or unblocks
2037 .Pq Cm 0
2038 feedback messages.
2039 Initially, the button is unblocked.
2041 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2042 sets the button's tooltip.
2043 Default is disabling the tooltip.
2045 .Qq Ar id Ns Cm :force
2046 simulates a click on the button.
2048 .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
2049 writes a snapshot of the button to an image file of the specified
2050 type.
2052 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2053 sets the button's minimum size to
2054 .Ar width
2056 .Ar height .
2057 Default is the button's natural size.
2060 .Ar id Ns Cm :style
2061 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2063 sets the style.
2065 .Sx Style .
2066 .It Feedback
2067 .Qq Ar id Ns Cm \&:1
2068 if switched on, or
2069 .Qq Ar id Ns Cm \&:0
2070 otherwise.
2072 .Ss GtkScale
2073 .Bl -tag -width "commands "
2074 .It Commands
2075 .Qq Ar id Ns Cm :set_value Ar x
2076 moves the slider to value
2077 .Ar x .
2079 .Qq Ar id Ns Cm :set_fill_level Bq Ar x
2080 moves the fill level indicator to value
2081 .Ar x .
2082 Default is hiding the fill level indicator.
2084 .Qq Ar id Ns Cm :set_range Ar min max
2085 changes the range.
2087 .Qq Ar id Ns Cm :set_increments Ar step page
2088 sets the steps the slider moves while pressing arrow keys and
2089 .Ql Page_Up Ns
2090 .Pf / Ql Page_Down ,
2091 respectively.
2093 .Qq Ar id Ns Cm :grab_focus
2094 puts the keyboard focus onto the scale.
2096 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2097 makes the scale grayed out
2098 .Pq Cm 0
2099 or responsive
2100 .Pq Cm 1 .
2102 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2103 hides
2104 .Pq Cm 0
2105 the scale, or makes it visible
2106 .Pq Cm 1 .
2108 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2109 blocks
2110 .Pq Cm 1
2111 or unblocks
2112 .Pq Cm 0
2113 feedback messages.
2114 Initially, the scale is unblocked.
2116 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2117 sets the scale's tooltip.
2118 Default is disabling the tooltip.
2120 .Qq Ar id Ns Cm :force
2121 simulates fresh selection of the current value.
2123 .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
2124 writes a snapshot of the scale to an image file of the specified
2125 type.
2127 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2128 sets the scale's minimum size to
2129 .Ar width
2131 .Ar height .
2132 Default is the natural size.
2135 .Ar id Ns Cm :style
2136 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2138 sets the style.
2140 .Sx Style .
2141 .It Feedback
2142 .Qq Ar id Ns Cm \&:value Ar number
2144 .Ss GtkScrolledWindow
2145 .Bl -tag -width "commands "
2146 .It Commands
2147 .Qq Ar id Ns Cm :hscroll Ar position
2149 .Qq Ar id Ns Cm :vscroll Ar position
2150 scroll
2151 .Ar position
2152 to the left or top edge of the
2153 .Cm GtkScrolledWindow ,
2154 respectively.
2156 .Qq Ar id Ns Cm :hscroll_to_range Ar pos0 pos1
2158 .Qq Ar id Ns Cm :vscroll_to_range Ar pos0 pos1
2159 scroll, if necessary, the range between
2160 .Ar pos0
2162 .Ar pos1
2163 into the
2164 .Cm GtkScrolledWindow .
2165 If the range is greater than the window, the initial part of the range
2166 will be visible.
2168 .Qq Ar id Ns Cm :grab_focus
2169 puts the keyboard focus onto the widget.
2171 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2172 makes the widget grayed out
2173 .Pq Cm 0
2174 or responsive
2175 .Pq Cm 1 .
2177 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2178 hides
2179 .Pq Cm 0
2180 the widget, or makes it visible
2181 .Pq Cm 1 .
2183 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2184 sets the widget's tooltip.
2185 Default is disabling the tooltip.
2187 .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
2188 writes a snapshot of the widget to an image file of the specified
2189 type.
2191 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2192 sets the minimum size to
2193 .Ar width
2195 .Ar height .
2196 Default is the widget's natural size.
2199 .Ar id Ns Cm :style
2200 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2202 sets the style.
2204 .Sx Style .
2205 .It Feedback
2206 none
2208 .Ss GtkSeparator
2209 .Bl -tag -width "commands "
2210 .It Commands
2211 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2212 makes the separator insensitive
2213 .Pq Cm 0
2214 or responsive
2215 .Pq Cm 1 .
2217 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2218 sets the tooltip of the separator.
2219 Default is disabling the tooltip.
2221 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2222 hides
2223 .Pq Cm 0
2224 the separator, or makes it visible
2225 .Pq Cm 1 .
2227 .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
2228 writes a snapshot of the separator to an image file of the specified
2229 type.
2231 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2232 sets the minimum size to
2233 .Ar width
2235 .Ar height .
2236 Default is the natural size of the separator.
2239 .Ar id Ns Cm :style
2240 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2242 sets the widget style.
2244 .Sx Style .
2245 .It Feedback
2246 none
2248 .Ss GtkSeparatorMenuItem
2249 .Bl -tag -width "commands "
2250 .It Commands
2251 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2252 makes the menu item insensitive
2253 .Pq Cm 0
2254 or responsive
2255 .Pq Cm 1 .
2257 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2258 hides
2259 .Pq Cm 0
2260 the menu item, or makes it visible
2261 .Pq Cm 1 .
2263 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2264 sets the tooltip of the menu item.
2265 Default is disabling the tooltip.
2267 .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
2268 writes a snapshot of the menu item to an image file of the specified
2269 type.
2271 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2272 sets the minimum size to
2273 .Ar width
2275 .Ar height .
2276 Default is the natural size of the menu item.
2279 .Ar id Ns Cm :style
2280 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2282 sets the widget style.
2284 .Sx Style .
2285 .It Feedback
2286 none
2288 .Ss GtkSocket
2289 .Cm GtkSocket
2290 may be unsupported by Glade, but its definition can be inserted
2291 manually into the GtkBuilder
2292 .Pq Pa .ui
2293 file:
2294 .Bd -literal -offset indent
2295 <child>
2296   <object class="GtkSocket" id="socket1">
2297     <property name="visible">True</property>
2298     <property name="can_focus">True</property>
2299   </object>
2300   <packing>
2301     <property name="expand">True</property>
2302     <property name="fill">True</property>
2303     <property name="position">1</property>
2304   </packing>
2305 </child>
2307 .Bl -tag -width "commands "
2308 .It Commands
2309 .Qq Ar id Ns Cm :id
2310 requests a feedback message containing the socket
2311 .Ar xid .
2313 .Qq Ar id Ns Cm :grab_focus
2314 puts the keyboard focus onto the socket.
2316 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2317 makes the socket grayed out
2318 .Pq Cm 0
2319 or responsive
2320 .Pq Cm 1 .
2322 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2323 hides
2324 .Pq Cm 0
2325 the socket, or makes it visible
2326 .Pq Cm 1 .
2328 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2329 sets the socket's tooltip.
2330 Default is disabling the tooltip.
2331 .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
2332 writes a snapshot of the socket to an image file of the specified
2333 type.
2335 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2336 sets the socket's minimum size to
2337 .Ar width
2339 .Ar height .
2340 Default is the socket's natural size.
2343 .Ar id Ns Cm :style
2344 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2346 sets the style.
2348 .Sx Style .
2349 .It Feedback
2350 .Qq Ar id Ns Cm :id Ar xid
2351 can be used by another process to XEmbed its widgets into the
2352 .Cm GtkSocket .
2354 .Qq Ar id Ns Cm \&:plug-added ,
2356 .Ar id Ns Cm \&:plug-removed
2357 .Qc .
2358 Notification that the other process has inserted its widgets into or
2359 removed them from the
2360 .Cm GtkSocket .
2362 .Ss GtkSpinButton
2363 .Bl -tag -width "commands "
2364 .It Commands
2365 .Qq Ar id Ns Cm :set_text Ar string
2366 sets the selected value to
2367 .Ar string .
2369 .Qq Ar id Ns Cm :set_range Ar min max
2370 changes the range.
2372 .Qq Ar id Ns Cm :set_increments Ar step page
2373 sets the steps the value changes while pressing arrow keys/left mouse
2374 button, and
2375 .Ql Page_Up Ns
2376 .Pf / Ql Page_Down Ns
2377 /middle mouse button,
2378 respectively.
2380 .Qq Ar id Ns Cm :grab_focus
2381 puts the keyboard focus onto the button.
2383 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2384 makes the button grayed out
2385 .Pq Cm 0
2386 or responsive
2387 .Pq Cm 1 .
2389 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2390 hides
2391 .Pq Cm 0
2392 the button, or makes it visible
2393 .Pq Cm 1 .
2395 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2396 blocks
2397 .Pq Cm 1
2398 or unblocks
2399 .Pq Cm 0
2400 feedback messages.
2401 Initially, the button is unblocked.
2403 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2404 sets the button's tooltip.
2405 Default is disabling the tooltip.
2407 .Qq Ar id Ns Cm :force
2408 simulates fresh selection of the current value
2410 .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
2411 writes a snapshot of the button to an image file of the specified
2412 type.
2414 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2415 sets the button's minimum size to
2416 .Ar width
2418 .Ar height .
2419 Default is the widget's natural size.
2422 .Ar id Ns Cm :style
2423 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2425 sets the button's style.
2427 .Sx Style .
2428 .It Feedback
2429 .Qq Ar id Ns Cm \&:text Ar text
2431 .Ss GtkSpinner
2432 .Bl -tag -width "commands "
2433 .It Commands
2434 .Qq Ar id Ns Cm :start
2436 .Qq Ar id Ns Cm :stop
2437 start and stop the spinner.
2439 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2440 makes the spinner grayed out
2441 .Pq Cm 0
2442 or clearly visible
2443 .Pq Cm 1 .
2445 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2446 hides
2447 .Pq Cm 0
2448 the spinner, or makes it visible
2449 .Pq Cm 1 .
2451 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2452 sets the spinner's tooltip.
2453 Default is disabling the tooltip.
2455 .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
2456 writes a snapshot of the spinner to an image file of the specified
2457 type.
2459 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2460 sets the spinner's minimum size to
2461 .Ar width
2463 .Ar height .
2464 Default is the natural size.
2467 .Ar id Ns Cm :style
2468 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2470 sets the style.
2472 .Sx Style .
2473 .It Feedback
2474 none
2476 .Ss GtkStatusbar
2477 The context parameter
2478 .Ar c
2479 is an arbitrary non-whitespace string.
2480 .Bl -tag -width "commands "
2481 .It Commands
2482 .Qq Ar id Ns Cm :push_id Ar c string ,
2483 .Qq Ar id Ns Cm :push Ar string
2484 associate
2485 .Ar string
2486 with context parameter
2487 .Ar c
2489 .Ql 0 ,
2490 respectively, and display it in the statusbar.
2492 .Qq Ar id Ns Cm :pop_id Ar c ,
2493 .Qq Ar id Ns Cm :pop
2494 remove the latest entry associated with context parameter
2495 .Ar c
2497 .Ql 0 ,
2498 respectively, from the statusbar.
2500 .Qq Ar id Ns Cm :remove_all_id Ar c ,
2501 .Qq Ar id Ns Cm :remove_all
2502 remove the entries associated with context parameter
2503 .Ar c
2505 .Ql 0 ,
2506 respectively, from the statusbar.
2508 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2509 makes the statusbar grayed out
2510 .Pq Cm 0
2511 or clearly visible
2512 .Pq Cm 1 .
2514 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2515 hides
2516 .Pq Cm 0
2517 the statusbar, or makes it visible
2518 .Pq Cm 1 .
2520 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2521 sets the statusbar's tooltip.
2522 Default is disabling the tooltip.
2524 .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
2525 writes a snapshot of the statusbar to an image file of the specified
2526 type.
2528 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2529 sets the statusbar's minimum size to
2530 .Ar width
2532 .Ar height .
2533 Default is the natural size.
2536 .Ar id Ns Cm :style
2537 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2539 sets the statusbar's style.
2541 .Sx Style .
2542 .It Feedback
2543 none
2545 .Ss GtkSwitch
2546 .Bl -tag -width "commands "
2547 .It Commands
2548 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
2549 turns the switch off
2550 .Pq Cm 0
2551 or on
2552 .Pq Cm 1 .
2554 .Qq Ar id Ns Cm :grab_focus
2555 puts the keyboard focus onto the switch.
2557 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2558 makes the switch grayed out
2559 .Pq Cm 0
2560 or responsive
2561 .Pq Cm 1 .
2563 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2564 hides
2565 .Pq Cm 0
2566 the switch, or makes it visible
2567 .Pq Cm 1 .
2569 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2570 blocks
2571 .Pq Cm 1
2572 or unblocks
2573 .Pq Cm 0
2574 feedback messages.
2575 Initially, the switch is unblocked.
2577 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2578 sets the tooltip of the switch.
2579 Default is disabling the tooltip.
2581 .Qq Ar id Ns Cm :force
2582 simulates a click on the switch.
2584 .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
2585 writes a snapshot of the switch to an image file of the specified
2586 type.
2588 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2589 sets the switch's minimum size to
2590 .Ar width
2592 .Ar height .
2593 Default is the natural size.
2596 .Ar id Ns Cm :style
2597 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2599 sets the style.
2601 .Sx Style .
2602 .It Feedback
2603 .Qq Ar id Ns Cm \&:1
2604 if switched on, or
2605 .Qq Ar id Ns Cm \&:0
2606 otherwise.
2608 .Ss GtkTextView
2609 There should be a dedicated
2610 .Sx GtkButton
2611 for sending (parts of) the text.
2612 If the id of the
2613 .Cm GtkTextView
2615 .Ar foo ,
2617 .Sx GtkButton
2618 with id
2619 .Ar foo Ns Cm _send_text
2620 will send the content of the
2621 .Cm GtkTextView ;
2623 .Sx GtkButton
2624 with id
2625 .Ar foo Ns Cm _send_selection
2626 will send the highlighted part the
2627 .Cm GtkTextView .
2628 .Bl -tag -width "commands "
2629 .It Commands
2630 .Qq Ar id Ns Cm :set_text Ar string
2631 replaces the user-editable text with (potentially empty)
2632 .Ar string Ns .
2634 .Qq Ar id Ns Cm :delete
2635 deletes the text.
2637 .Qq Ar id Ns Cm :insert_at_cursor Ar string
2638 inserts
2639 .Ar string
2640 at cursor position.
2642 .Qq Ar id Ns Cm :place_cursor Brq Ar position | Cm end
2643 places the text cursor at
2644 .Ar position
2645 or at the end of the text.
2647 .Qq Ar id Ns Cm :place_cursor_at_line Ar line
2648 places the text cursor at the beginning of
2649 .Ar line .
2651 .Qq Ar id Ns Cm :scroll_to_cursor
2652 scrolls to the cursor position if necessary.
2654 .Qq Ar id Ns Cm :save Ar file
2655 stores in
2656 .Ar file
2659 command containing the text.
2661 .Qq Ar id Ns Cm :grab_focus
2662 puts the keyboard focus into the textview.
2664 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2665 makes the text view grayed out
2666 .Pq Cm 0
2667 or responsive
2668 .Pq Cm 1 .
2670 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2671 hides
2672 .Pq Cm 0
2673 the text view, or makes it visible
2674 .Pq Cm 1 .
2676 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2677 sets the tooltip of the text view.
2678 Default is disabling the tooltip.
2680 .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
2681 writes a snapshot of the text view to an image file of the specified
2682 type.
2684 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2685 sets the minimum size to
2686 .Ar width
2688 .Ar height .
2689 Default is the natural size.
2692 .Ar id Ns Cm :style
2693 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2695 sets the style.
2697 .Sx Style .
2698 .It Feedback
2699 .Qq Ar button_id Ns Cm \&:text Ar text ,
2700 .Ar button_id
2701 being the id of the
2702 .Sx GtkButton .
2703 Line endings in
2704 .Ar text
2705 are replaced by
2706 .Cm \en ,
2707 and backslashes are replaced by
2708 .Cm \e\e .
2710 .Ss GtkToggleButton
2711 .Bl -tag -width "commands "
2712 .It Commands
2713 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
2714 switches the button off
2715 .Pq Cm 0
2716 or on
2717 .Pq Cm 1 .
2719 .Qq Ar id Ns Cm :set_label Ar string
2720 replaces the button text with
2721 .Ar string .
2723 .Qq Ar id Ns Cm :grab_focus
2724 puts the keyboard focus onto the button.
2726 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2727 makes the button grayed out
2728 .Pq Cm 0
2729 or responsive
2730 .Pq Cm 1 .
2732 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2733 hides
2734 .Pq Cm 0
2735 the button, or makes it visible
2736 .Pq Cm 1 .
2738 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2739 blocks
2740 .Pq Cm 1
2741 or unblocks
2742 .Pq Cm 0
2743 feedback messages.
2744 Initially, the button is unblocked.
2746 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2747 sets the button's tooltip.
2748 Default is disabling the tooltip.
2750 .Qq Ar id Ns Cm :force
2751 simulates a click on the button.
2753 .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
2754 writes a snapshot of the button to an image file of the specified
2755 type.
2757 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2758 sets the button's minimum size to
2759 .Ar width
2761 .Ar height .
2762 Default is the button's natural size.
2765 .Ar id Ns Cm :style
2766 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2768 sets the button's style.
2770 .Sx Style .
2771 .It Feedback
2772 .Qq Ar id Ns Cm \&:1
2773 if switched on, or
2774 .Qq Ar id Ns Cm \&:0
2775 otherwise.
2777 .Ss GtkTreeView
2779 can deal with columns of type
2780 .Cm gboolean , gint , guint , glong , gulong , gint64 , guint64 , gfloat , gdouble ,
2782 .Cm gchararray .
2784 .Ar row
2786 .Ar column
2787 refer to the underlying model
2788 .Cm ( GtkListStore
2790 .Cm GtkTreeStore ) .
2791 .Ar row
2792 is a sequence of one or more colon-separated integers, e.g.
2793 .Ql 3
2795 .Ql 0:0:1 .
2796 .Bl -tag -width "commands "
2797 .It Commands
2798 .Qq Ar id Ns Cm :set Ar row column data
2799 replaces the content at
2800 .Pq Ar row , column
2801 with
2802 .Ar data
2803 (which should be compatible with the type of
2804 .Ar column ) .
2805 If necessary, new tree nodes are created to obtain the minimal tree
2806 structure needed to support
2807 .Ar row .
2809 .Qq Ar id Ns Cm :insert_row Brq Ar row Bo Cm as_child Bc | Cm end
2810 inserts a new, empty row; either as a sibling of
2811 .Ar row
2812 at position
2813 .Ar row ,
2814 or as a child of
2815 .Ar row ,
2816 or at the end of the list, respectively.
2818 .Qq Ar id Ns Cm :move_row Ar origin Brq Ar destination | Cm end
2819 moves the row at
2820 .Ar origin
2821 within its current level to
2822 .Ar destination
2823 or to the end.
2825 .Qq Ar id Ns Cm :remove_row Ar row
2826 removes the row at position
2827 .Ar row .
2829 .Qq Ar id Ns Cm :clear
2830 removes all rows.
2832 .Qq Ar id Ns Cm :expand Ar row
2833 expands one level of the subtree below
2834 .Ar row .
2836 .Qq Ar id Ns Cm :expand_all Bq Ar row
2837 expands the subtree below
2838 .Ar row ,
2839 or the whole tree.
2841 .Qq Ar id Ns Cm :collapse Bq Ar row
2842 collapses the subtree below
2843 .Ar row ,
2844 or the whole tree.
2846 .Qq Ar id Ns Cm :set_cursor Bq Ar row
2847 sets the cursor to
2848 .Ar row ,
2849 or unsets it.
2851 .Qq Ar id Ns Cm :scroll Ar row column
2852 scrolls the cell at
2853 .Pq Ar row , column
2854 into view.
2856 .Qq Ar id Ns Cm :save Ar file
2857 stores the content of the underlying model as a sequence of
2859 commands into
2860 .Ar file .
2862 .Qq Ar id Ns Cm :grab_focus
2863 puts the keyboard focus onto the tree view.
2865 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2866 makes the tree view grayed out
2867 .Pq Cm 0
2868 or responsive
2869 .Pq Cm 1 .
2871 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2872 hides
2873 .Pq Cm 0
2874 the tree view, or makes it visible
2875 .Pq Cm 1 .
2877 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2879 with
2880 .Ar id
2881 from the underlying
2882 .Cm GtkTreeSelection
2884 blocks
2885 .Pq Cm 1
2886 or unblocks
2887 .Pq Cm 0
2888 feedback messages.
2889 Initially, the widget is unblocked.
2891 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2892 sets the tooltip of the tree view.
2893 Default is disabling the tooltip.
2895 .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
2896 writes a snapshot of the tree view to an image file of the specified
2897 type.
2899 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2900 sets the minimum size of the tree view to
2901 .Ar width
2903 .Ar height .
2904 Default is the widget's natural size.
2907 .Ar id Ns Cm :style
2908 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2910 sets the style.
2912 .Sx Style .
2913 .It Feedback
2914 .Qq Ar id Ns Cm \&:clicked
2916 .Qq Ar id Ns Cm \&: Ns Ar column_type row column value ,
2917 one message per cell in the underlying model for each selected row; or
2919 .Qq Ar id Ns Cm \&: Ns Ar column_type row column new_value ,
2920 if the cell at
2921 .Pq Ar row , column
2922 has been edited.
2924 .Ss GtkTreeViewColumn
2925 .Bl -tag -width "commands "
2926 .It Commands
2927 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2928 blocks
2929 .Pq Cm 1
2930 or unblocks
2931 .Pq Cm 0
2932 feedback messages.
2933 Initially, the widget is unblocked.
2934 .It Feedback
2935 .Qq Ar id Ns Cm \&:clicked
2937 .Ss GtkViewport
2938 .Bl -tag -width "commands "
2939 .It Commands
2940 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2941 makes the viewport insensitive
2942 .Pq Cm 0
2943 or responsive
2944 .Pq Cm 1 .
2946 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2947 hides
2948 .Pq Cm 0
2949 the viewport, or makes it visible
2950 .Pq Cm 1 .
2952 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2953 sets the tooltip of the viewport.
2954 Default is disabling the tooltip.
2956 .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
2957 writes a snapshot of the viewport to an image file of the specified
2958 type.
2960 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2961 sets the minimum size to
2962 .Ar width
2964 .Ar height .
2965 Default is the natural size of the viewport.
2968 .Ar id Ns Cm :style
2969 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2971 sets the widget style.
2973 .Sx Style .
2974 .It Feedback
2975 none
2977 .Ss GtkWindow
2978 .Bl -tag -width "commands "
2979 .It Commands
2980 .Qq Ar id Ns Cm :set_title Ar string
2981 replaces the text in the title bar with
2982 .Ar string .
2984 .Qq Ar id Ns Cm :resize Bq Ar width height
2985 changes the window size to
2986 .Ar width
2988 .Ar height
2989 pixels if specified, or to the default size.
2991 .Qq Ar id Ns Cm :move Ar x y
2992 moves the window to position
2993 .Pq Ar x , y .
2995 .Qq Ar id Ns Cm :fullscreen
2997 .Qq Ar id Ns Cm :unfullscreen
2998 switch fullscreen mode on and off.
3000 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3001 makes the widget grayed out
3002 .Pq Cm 0
3003 or responsive
3004 .Pq Cm 1 .
3006 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3007 hides
3008 .Pq Cm 0
3009 the widget, or makes it visible
3010 .Pq Cm 1 .
3012 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3013 blocks
3014 .Pq Cm 1
3015 or unblocks
3016 .Pq Cm 0
3017 feedback messages.
3018 Initially, the widget is unblocked.
3020 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3021 sets the window's tooltip.
3022 Default is disabling the tooltip.
3023 .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
3024 writes a snapshot of the window to an image file of the specified
3025 type.
3027 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3028 sets the window's minimum size to
3029 .Ar width
3031 .Ar height .
3032 Default is the widget's natural size.
3035 .Ar id Ns Cm :style
3036 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3038 sets the style.
3040 .Sx Style .
3041 .It Feedback
3042 .Qq Ar id Ns Cm \&:closed
3043 if the
3044 .Cm GtkWindow
3045 was closed by the window manager.
3047 .Sh SPECIAL SYNTAX
3048 .Ss Style
3050 .Ar id Ns Cm :style
3051 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3053 sets properties
3054 .Ar prop
3055 of the widget style to
3056 .Ar val .
3057 Properties not explicitly specified are reset to their default values.
3058 Examples:
3059 .Bl -dash -offset indent -compact
3061 .Ql label1:style font:Bold 11; background-color:green
3063 .Ql label1:style font-style:italic; font-weight:bold; color:blue
3065 .Ql frame1:style border-color:red yellow; border-width:5px
3067 .Ql frame1:style border-radius:10px; transition:10s
3069 For a description of possible color notations see
3070 .Sx Color .
3071 .Ss Color
3072 .Ar color
3073 can be
3074 .Bl -dash -offset indent -compact
3076 a standard X11 color name, like
3077 .Ql Dark Sea Green ,
3079 a hexadecimal value in the form
3080 .Cm # Ns Ar rgb , Cm # Ns Ar rrggbb , Cm # Ns Ar rrrgggbbb ,
3082 .Cm # Ns Ar rrrrggggbbbb ,
3084 an RGB color in the form
3085 .Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&) ,
3088 an RGBA color in the form
3089 .Cm rgba( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns
3090 .Ar blue Ns Cm \&, Ns Ar alpha Ns Cm \&) .
3092 .Sh EXIT STATUS
3093 .Ex -std
3094 .Sh EXAMPLES
3095 .Ss Discovering Pipeglade Interactively
3096 Suppose the interface in
3097 .Pa ./pipeglade.ui
3098 has a
3099 .Sx GtkLabel Ql label1
3100 and a
3101 .Sx GtkButton Ql button1 .
3102 After invoking
3104 .Dl pipeglade
3106 and clicking the
3107 .Sx GtkButton , Ql button1:clicked
3108 will be reported on the terminal.
3109 Typing
3111 .Dl label1:set_text The Button
3113 will change the text shown on the label into
3114 .Ql The Button .
3115 .Ss One-Shot File Dialog
3116 Suppose the interface in
3117 .Pa ./simple_open.ui
3118 contains a
3119 .Sx GtkFileChooserDialog
3120 with an
3121 .Sq OK
3122 .Sx GtkButton
3123 whose id is
3124 .Ql main_ok .
3125 Invoking
3127 .Dl pipeglade -u simple_open.ui
3129 will open the dialog; pressing
3130 .Sq OK
3131 will close it after sending the selected filename to
3132 .Va stdout .
3133 .Ss One-Shot User Notification
3134 If the interface in
3135 .Pa ./simple_dialog.ui
3136 contains a
3137 .Sx GtkLabel Ql label1 ,
3138 then
3139 .Bd -literal -offset indent
3140 pipeglade -u simple_dialog.ui <<< \e
3141     "label1:set_text NOW READ THIS!"
3143 will set the label text accordingly and wait for user input.
3144 .Ss Continuous Input
3145 The following shell command displays a running clock:
3146 .Bd -literal -offset indent
3147 while true; do
3148     echo "label1:set_text `date`";
3149     sleep 1;
3150 done | pipeglade -u simple_dialog.ui
3152 .Ss Continuous Input and Output
3153 The following shell script fragment sets up
3155 for continuous communication with another program,
3156 .Pa main_prog :
3157 .Bd -literal -offset indent
3158 pipeglade -i in.fifo -o out.fifo -b
3159 main_prog <out.fifo >in.fifo
3161 .Sh SEE ALSO
3162 .Xr dialog 1 ,
3163 .Xr glade 1 ,
3164 .Xr gxmessage 1 ,
3165 .Xr kdialog 1 ,
3166 .Xr whiptail 1 ,
3167 .Xr xmessage 1 ,
3168 .Xr zenity 1
3169 .Sh AUTHOR
3171 was written by
3172 .An Bert Burgemeister
3173 .Aq Mt trebbu@googlemail.com .
3174 .Sh BUGS
3175 Due to what appears to be a bug in cairo v1.14.0,
3177 used with this library version occasionally crashes on
3178 .Cm GtkDrawingArea
3179 commands.