pipeglade.1

   1 .\" Copyright (c) 2014-2017 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 October 11, 2017
  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.
 107 .Pp
 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.
 112 See
 113 .Sx WIDGETS
 114 for possible feedback messages.
 115 .Pp
 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.
 122 .Pp
 123 Default feedback-message output is
 124 .Va stdout .
 125 .It Fl b
 126 Runs
 127 .Nm
 128 in the background after printing its process ID to
 129 .Va stdout .
 130 .Pp
 131 It is an error if option
 132 .Fl b
 133 is used and not both
 134 .Fl i Ar in-fifo
 135 and
 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 .
 148 .Pp
 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
 158 to
 159 .Ar log-file ,
 160 .Ar time
 161 being the number of microseconds elapsed during
 162 .Ar activity .
 163 .Ar time
 164 and
 165 .Ar activity
 166 are separated by a tab character.
 167 Permissions of
 168 .Ar log-file
 169 are set to
 170 .Li 0600 .
 171 A
 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
 197 .Nm
 198 version and exits.
 199 .El
 200 .Sh WIDGETS
 201 The widget classes able to communicate through
 202 .Nm
 203 are
 204 .\" BEGIN_TOC
 205 .Sx GtkAspectFrame ,
 206 .Sx GtkBox ,
 207 .Sx GtkButton ,
 208 .Sx GtkButtonBox ,
 209 .Sx GtkCalendar ,
 210 .Sx GtkCheckButton ,
 211 .Sx GtkColorButton ,
 212 .Sx GtkComboBoxText ,
 213 .Sx GtkDialog ,
 214 .Sx GtkDrawingArea ,
 215 .Sx GtkEntry ,
 216 .Sx GtkEventBox ,
 217 .Sx GtkExpander ,
 218 .Sx GtkFileChooserButton ,
 219 .Sx GtkFileChooserDialog ,
 220 .Sx GtkFontButton ,
 221 .Sx GtkFrame ,
 222 .Sx GtkGrid ,
 223 .Sx GtkImage ,
 224 .Sx GtkImageMenuItem ,
 225 .Sx GtkInfoBar ,
 226 .Sx GtkLabel ,
 227 .Sx GtkLinkButton ,
 228 .Sx GtkMenu ,
 229 .Sx GtkMenuBar ,
 230 .Sx GtkMenuButton ,
 231 .Sx GtkMenuItem ,
 232 .Sx GtkNotebook ,
 233 .Sx GtkOverlay ,
 234 .Sx GtkPaned ,
 235 .Sx GtkPlug ,
 236 .Sx GtkPrintUnixDialog ,
 237 .Sx GtkProgressBar ,
 238 .Sx GtkRadioButton ,
 239 .Sx GtkScale ,
 240 .Sx GtkScrolledWindow ,
 241 .Sx GtkSeparator ,
 242 .Sx GtkSeparatorMenuItem ,
 243 .Sx GtkSizeGroup ,
 244 .Sx GtkSocket ,
 245 .Sx GtkSpinButton ,
 246 .Sx GtkSpinner ,
 247 .Sx GtkStatusbar ,
 248 .Sx GtkSwitch ,
 249 .Sx GtkTextView ,
 250 .Sx GtkToggleButton ,
 251 .Sx GtkTreeView ,
 252 .Sx GtkTreeViewColumn ,
 253 .Sx GtkViewport ,
 254 and
 255 .Sx GtkWindow .
 256 .\" END_TOC
 257 .Pp
 258 .Nm
 259 references a widget by the
 260 .Ar id
 261 attribute it is given in Glade.
 262 In the
 263 .Pa .ui
 264 file, a
 265 .Cm GtkWindow
 266 named
 267 .Li foo
 268 would appear as
 269 .Dl <object class="GtkWindow" id="foo"> .
 270 .\"
 271 .\" Commands most widgets understand:
 272 .\"
 273 .\"  set_visible
 274 .\"  set_sensitive
 275 .\"  grab_focus
 276 .\"  set_tooltip_text
 277 .\"  block
 278 .\"  set_size_request
 279 .\"  style
 280 .\"  force
 281 .\"  snapshot
 282 .\"  ping
 283 .\"
 284 .Ss Unspecific Widget
 285 .Bl -tag -width indent
 286 .It Commands
 287 .Bl -item
 288 .It
 289 .Qq Ar id Ns Cm :load Ar file
 290 reads arbitrary
 291 .Nm
 292 commands from
 293 .Ar file .
 294 A non-empty
 295 .Ar id
 296 is required but ignored.
 297 .Cm :load
 298 commands may be nested but on attempts to read from the same file, the
 299 inner
 300 .Cm :load
 301 is ignored.
 302 There is also a
 303 .Cm :save
 304 command; see
 305 .Sx GtkTextView
 306 and
 307 .Sx GtkTreeView .
 308 .Pp
 309 .Qq Ar id Ns Cm :main_quit
 310 kills the user interface.
 311 A non-empty
 312 .Ar id
 313 is required but ignored.
 314 .El
 315 .El
 316 .Ss GtkAspectFrame
 317 .Bl -tag -width indent
 318 .It Commands
 319 .Bl -item
 320 .It
 321 .Qq Ar id Ns Cm :set_label Ar text
 322 replaces the frame label text with
 323 .Ar string .
 324 .It
 325 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
 326 makes the frame and its content grayed out
 327 .Pq Cm 0
 328 or responsive
 329 .Pq Cm 1 .
 330 .It
 331 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
 332 hides
 333 .Pq Cm 0
 334 the frame, or makes it visible
 335 .Pq Cm 1 .
 336 .It
 337 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
 338 sets the frame's tooltip.
 339 Default is disabling the tooltip.
 340 .It
 341 .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
 342 writes a snapshot of the frame to an image file of the specified
 343 type.
 344 .It
 345 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
 346 sets the widget's minimum size to
 347 .Ar width
 348 x
 349 .Ar height .
 350 Default is the frame's natural size.
 351 .It
 352 .Qo
 353 .Ar id Ns Cm :style
 354 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
 355 .Qc
 356 sets the style.
 357 See
 358 .Sx Style .
 359 .Pp
 360 .Qq Ar id Ns Cm :ping Bq Ar text
 361 triggers a feedback message.
 362 .El
 363 .It Feedback
 364 .Bl -item
 365 .It
 366 .Qq Ar id Ns Cm :ping Ar text
 367 if triggered by the
 368 .Cm :ping
 369 command.
 370 .El
 371 .El
 372 .Ss GtkBox
 373 .Bl -tag -width indent
 374 .It Commands
 375 .Bl -item
 376 .It
 377 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
 378 makes the box grayed out
 379 .Pq Cm 0
 380 or responsive
 381 .Pq Cm 1 .
 382 .It
 383 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
 384 hides
 385 .Pq Cm 0
 386 the box, or makes it visible
 387 .Pq Cm 1 .
 388 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
 389 sets the box's tooltip.
 390 Default is disabling the tooltip.
 391 .It
 392 .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
 393 writes a snapshot of the box to an image file of the specified
 394 type.
 395 .It
 396 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
 397 sets the box's minimum size to
 398 .Ar width
 399 x
 400 .Ar height .
 401 Default is the box's natural size.
 402 .It
 403 .Qo
 404 .Ar id Ns Cm :style
 405 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
 406 .Qc
 407 sets the style.
 408 See
 409 .Sx Style .
 410 .Pp
 411 .Qq Ar id Ns Cm :ping Bq Ar text
 412 triggers a feedback message.
 413 .El
 414 .It Feedback
 415 .Bl -item
 416 .It
 417 .Qq Ar id Ns Cm :ping Ar text
 418 if triggered by the
 419 .Cm :ping
 420 command.
 421 .El
 422 .El
 423 .Ss GtkButton
 424 .Bl -tag -width indent
 425 .It Commands
 426 .Bl -item
 427 .It
 428 .Qq Ar id Ns Cm :set_label Ar string
 429 replaces the button text with
 430 .Ar string .
 431 .It
 432 .Qq Ar id Ns Cm :grab_focus
 433 puts the keyboard focus onto the button.
 434 .It
 435 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
 436 makes the button grayed out
 437 .Pq Cm 0
 438 or responsive
 439 .Pq Cm 1 .
 440 .It
 441 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
 442 hides
 443 .Pq Cm 0
 444 the button, or makes it visible
 445 .Pq Cm 1 .
 446 .It
 447 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
 448 blocks
 449 .Pq Cm 1
 450 or unblocks
 451 .Pq Cm 0
 452 feedback messages.
 453 Initially, the button is unblocked.
 454 .It
 455 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
 456 sets the button's tooltip.
 457 Default is disabling the tooltip.
 458 .It
 459 .Qq Ar id Ns Cm :force
 460 simulates a click on the button.
 461 .It
 462 .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
 463 writes a snapshot of the button to an image file of the specified
 464 type.
 465 .It
 466 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
 467 sets the button's minimum size to
 468 .Ar width
 469 x
 470 .Ar height .
 471 Default is the button's natural size.
 472 .It
 473 .Qo
 474 .Ar id Ns Cm :style
 475 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
 476 .Qc
 477 sets the style.
 478 See
 479 .Sx Style .
 480 .Pp
 481 .Qq Ar id Ns Cm :ping Bq Ar text
 482 triggers a feedback message.
 483 .El
 484 .It Feedback
 485 .Bl -item
 486 .It
 487 .Qq Ar id Ns Cm :ping Ar text
 488 if triggered by the
 489 .Cm :ping
 490 command.
 491 .Pp
 492 .Qq Ar id Ns Cm \&:clicked
 493 .Pp
 494 .Cm GtkButton Ns
 495 s with ids ending in
 496 .Cm _ok , _apply , _cancel , _send_text ,
 497 and
 498 .Cm _send_selection
 499 may work differently; see
 500 .Sx GtkDialog , GtkFileChooserDialog ,
 501 and
 502 .Sx GtkTextView
 503 for details.
 504 .El
 505 .El
 506 .Ss GtkButtonBox
 507 .Bl -tag -width indent
 508 .It Commands
 509 .Bl -item
 510 .It
 511 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
 512 makes the box grayed out
 513 .Pq Cm 0
 514 or responsive
 515 .Pq Cm 1 .
 516 .It
 517 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
 518 hides
 519 .Pq Cm 0
 520 the box, or makes it visible
 521 .Pq Cm 1 .
 522 .It
 523 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
 524 sets the box's tooltip.
 525 Default is disabling the tooltip.
 526 .It
 527 .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
 528 writes a snapshot of the box to an image file of the specified
 529 type.
 530 .It
 531 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
 532 sets the box's minimum size to
 533 .Ar width
 534 x
 535 .Ar height .
 536 Default is the box's natural size.
 537 .It
 538 .Qo
 539 .Ar id Ns Cm :style
 540 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
 541 .Qc
 542 sets the style.
 543 See
 544 .Sx Style .
 545 .Pp
 546 .Qq Ar id Ns Cm :ping Bq Ar text
 547 triggers a feedback message.
 548 .El
 549 .It Feedback
 550 .Bl -item
 551 .It
 552 .Qq Ar id Ns Cm :ping Ar text
 553 if triggered by the
 554 .Cm :ping
 555 command.
 556 .El
 557 .El
 558 .Ss GtkCalendar
 559 .Bl -tag -width indent
 560 .It Commands
 561 .Bl -item
 562 .It
 563 .Qq Ar id Ns Cm :select_date Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
 564 selects the date on the calendar.
 565 .It
 566 .Qq Ar id Ns Cm :mark_day Ar day
 567 marks
 568 .Ar day Pq 1-31
 569 on the calendar.
 570 .It
 571 .Qq Ar id Ns Cm :clear_marks
 572 unmarks all days on the calendar.
 573 .It
 574 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
 575 makes the calendar grayed out
 576 .Pq Cm 0
 577 or responsive
 578 .Pq Cm 1 .
 579 .It
 580 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
 581 hides
 582 .Pq Cm 0
 583 the calendar, or makes it visible
 584 .Pq Cm 1 .
 585 .It
 586 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
 587 blocks
 588 .Pq Cm 1
 589 or unblocks
 590 .Pq Cm 0
 591 feedback messages.
 592 Initially, the calendar is unblocked.
 593 .It
 594 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
 595 sets the calendar's tooltip.
 596 Default is disabling the tooltip.
 597 .It
 598 .Qq Ar id Ns Cm :force
 599 simulates a click on the currently selected date.
 600 .It
 601 .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
 602 writes a snapshot of the calendar to an image file of the specified
 603 type.
 604 .It
 605 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
 606 sets the calendar's minimum size to
 607 .Ar width
 608 x
 609 .Ar height .
 610 Default is the widget's natural size.
 611 .It
 612 .Qo
 613 .Ar id Ns Cm :style
 614 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
 615 .Qc
 616 sets the calendar's style.
 617 See
 618 .Sx Style .
 619 .Pp
 620 .Qq Ar id Ns Cm :ping Bq Ar text
 621 triggers a feedback message.
 622 .El
 623 .It Feedback
 624 .Bl -item
 625 .It
 626 .Qq Ar id Ns Cm \&:clicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
 627 .It
 628 .Qq Ar id Ns Cm \&:doubleclicked Ar yyyy Ns Cm - Ns Ar mm Ns Cm - Ns Ar dd
 629 .Pp
 630 .Qq Ar id Ns Cm :ping Ar text
 631 if triggered by the
 632 .Cm :ping
 633 command.
 634 .El
 635 .El
 636 .Ss GtkCheckButton
 637 .Bl -tag -width indent
 638 .It Commands
 639 .Bl -item
 640 .It
 641 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
 642 switches the check mark off
 643 .Pq Cm 0
 644 or on
 645 .Pq Cm 1 .
 646 .It
 647 .Qq Ar id Ns Cm :set_label Ar string
 648 replaces the button text with
 649 .Ar string .
 650 .It
 651 .Qq Ar id Ns Cm :grab_focus
 652 puts the keyboard focus onto the button.
 653 .It
 654 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
 655 makes the button grayed out
 656 .Pq Cm 0
 657 or responsive
 658 .Pq Cm 1 .
 659 .It
 660 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
 661 hides
 662 .Pq Cm 0
 663 the button, or makes it visible
 664 .Pq Cm 1 .
 665 .It
 666 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
 667 blocks
 668 .Pq Cm 1
 669 or unblocks
 670 .Pq Cm 0
 671 feedback messages.
 672 Initially, the button is unblocked.
 673 .It
 674 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
 675 sets the button's tooltip.
 676 Default is disabling the tooltip.
 677 .It
 678 .Qq Ar id Ns Cm :force
 679 simulates a click on the button.
 680 .It
 681 .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
 682 writes a snapshot of the button to an image file of the specified
 683 type.
 684 .It
 685 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
 686 sets the button's minimum size to
 687 .Ar width
 688 x
 689 .Ar height .
 690 Default is the widget's natural size.
 691 .It
 692 .Qo
 693 .Ar id Ns Cm :style
 694 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
 695 .Qc
 696 sets the button's style.
 697 See
 698 .Sx Style .
 699 .Pp
 700 .Qq Ar id Ns Cm :ping Bq Ar text
 701 triggers a feedback message.
 702 .El
 703 .It Feedback
 704 .Bl -item
 705 .It
 706 .Qq Ar id Ns Cm \&:1
 707 if switched on, or
 708 .Qq Ar id Ns Cm \&:0
 709 otherwise.
 710 .Pp
 711 .Qq Ar id Ns Cm :ping Ar text
 712 if triggered by the
 713 .Cm :ping
 714 command.
 715 .El
 716 .El
 717 .Ss GtkColorButton
 718 .Bl -tag -width indent
 719 .It Commands
 720 .Bl -item
 721 .It
 722 .Qq Ar id Ns Cm :set_color Ar color
 723 preselects the color; see
 724 .Sx Color .
 725 .It
 726 .Qq Ar id Ns Cm :grab_focus
 727 puts the keyboard focus onto the button.
 728 .It
 729 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
 730 makes the button grayed out
 731 .Pq Cm 0
 732 or responsive
 733 .Pq Cm 1 .
 734 .It
 735 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
 736 hides
 737 .Pq Cm 0
 738 the button, or makes it visible
 739 .Pq Cm 1 .
 740 .It
 741 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
 742 blocks
 743 .Pq Cm 1
 744 or unblocks
 745 .Pq Cm 0
 746 feedback messages.
 747 Initially, the button is unblocked.
 748 .It
 749 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
 750 sets the button's tooltip.
 751 Default is disabling the tooltip.
 752 .It
 753 .Qq Ar id Ns Cm :force
 754 opens the dialog window.
 755 .It
 756 .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
 757 writes a snapshot of the button to an image file of the specified
 758 type.
 759 .It
 760 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
 761 sets the button's minimum size to
 762 .Ar width
 763 x
 764 .Ar height .
 765 Default is the widget's natural size.
 766 .It
 767 .Qo
 768 .Ar id Ns Cm :style
 769 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
 770 .Qc
 771 sets the button's style.
 772 See
 773 .Sx Style .
 774 .Pp
 775 .Qq Ar id Ns Cm :ping Bq Ar text
 776 triggers a feedback message.
 777 .El
 778 .It Feedback
 779 .Bl -item
 780 .It
 781 .Qq Ar id Ns Cm \&:color Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&)
 782 or
 783 .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 \&) .
 784 .Ar red , green ,
 785 and
 786 .Ar blue
 787 lie between 0 and 255, and
 788 .Ar alpha
 789 between 0 and 1.
 790 .Pp
 791 .Qq Ar id Ns Cm :ping Ar text
 792 if triggered by the
 793 .Cm :ping
 794 command.
 795 .El
 796 .El
 797 .Ss GtkComboBoxText
 798 The
 799 .Cm GtkComboBoxText
 800 should contain a
 801 .Cm GtkEntry .
 802 .Bl -tag -width indent
 803 .It Commands
 804 .Bl -item
 805 .It
 806 .Qq Ar id Ns Cm :prepend_text Ar string
 807 and
 808 .Qq Ar id Ns Cm :append_text Ar string
 809 prepend/append a new selectable item marked
 810 .Ar string .
 811 .It
 812 .Qq Ar id Ns Cm :insert_text Ar position string
 813 inserts item
 814 .Ar string
 815 at
 816 .Ar position .
 817 .It
 818 .Qq Ar id Ns Cm :remove Ar position
 819 removes the item at
 820 .Ar position .
 821 .It
 822 .Qq Ar id Ns Cm :grab_focus
 823 puts the keyboard focus onto the combo box.
 824 .It
 825 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
 826 makes the combo box grayed out
 827 .Pq Cm 0
 828 or responsive
 829 .Pq Cm 1 .
 830 .It
 831 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
 832 hides
 833 .Pq Cm 0
 834 the combo box, or makes it visible
 835 .Pq Cm 1 .
 836 .It
 837 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
 838 blocks
 839 .Pq Cm 1
 840 or unblocks
 841 .Pq Cm 0
 842 feedback messages.
 843 Initially, the combo box is unblocked.
 844 .It
 845 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
 846 sets the tooltip.
 847 Default is disabling the tooltip.
 848 .It
 849 .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
 850 writes a snapshot of the combo box to an image file of the specified
 851 type.
 852 .It
 853 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
 854 sets the combo box's minimum size to
 855 .Ar width
 856 x
 857 .Ar height .
 858 Default is the natural size.
 859 .It
 860 .Qo
 861 .Ar id Ns Cm :style
 862 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
 863 .Qc
 864 sets the style.
 865 See
 866 .Sx Style .
 867 .Pp
 868 .Qq Ar id Ns Cm :ping Bq Ar text
 869 triggers a feedback message.
 870 .El
 871 .It Feedback
 872 .Bl -item
 873 .It
 874 .Qq Ar entry_id Ns Cm \&:text Ar text ,
 875 .Ar entry_id
 876 being the id of the child
 877 .Cm GtkEntry .
 878 .Pp
 879 .Qq Ar id Ns Cm :ping Ar text
 880 if triggered by the
 881 .Cm :ping
 882 command.
 883 .El
 884 .El
 885 .Ss GtkDialog
 886 A
 887 .Cm GtkDialog
 888 with id
 889 .Ar foo
 890 will be invoked by a
 891 .Sx GtkMenuItem
 892 or a
 893 .Sx GtkImageMenuItem
 894 with id
 895 .Ar foo Ns Cm _invoke .
 896 .Pp
 897 The
 898 .Cm GtkDialog
 899 should have a
 900 .Sq Cancel
 901 .Sx GtkButton
 902 with id
 903 .Ar foo Ns Cm _cancel
 904 .Po Cm main_cancel
 905 if the dialog is the sole window of the GUI and therefore named
 906 .Cm main
 907 .Pc .
 908 .Pp
 909 If the
 910 .Cm GtkDialog
 911 has an
 912 .Sq Ok
 913 .Sx GtkButton
 914 with id
 915 .Ar foo Ns Cm _ok ,
 916 it will take care of hiding the dialog window.
 917 .Bl -tag -width indent
 918 .It Commands
 919 .Bl -item
 920 .It
 921 .Qq Ar id Ns Cm :set_title Ar string
 922 replaces the text in the title bar with
 923 .Ar string .
 924 .It
 925 .Qq Ar id Ns Cm :resize Bq Ar width height
 926 changes the size of the dialog window to
 927 .Ar width
 928 x
 929 .Ar height
 930 pixels if specified, or to the default size.
 931 .It
 932 .Qq Ar id Ns Cm :move Ar x y
 933 moves the dialog window to position
 934 .Pq Ar x , y .
 935 .It
 936 .Qq Ar id Ns Cm :fullscreen
 937 and
 938 .Qq Ar id Ns Cm :unfullscreen
 939 switch fullscreen mode on and off.
 940 .It
 941 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
 942 makes the dialog grayed out
 943 .Pq Cm 0
 944 or responsive
 945 .Pq Cm 1 .
 946 .It
 947 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
 948 hides
 949 .Pq Cm 0
 950 the dialog, or makes it visible
 951 .Pq Cm 1 .
 952 .It
 953 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
 954 blocks
 955 .Pq Cm 1
 956 or unblocks
 957 .Pq Cm 0
 958 feedback messages from the dialog window.
 959 Initially, the window is unblocked.
 960 .It
 961 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
 962 sets the dialog window's tooltip.
 963 Default is disabling the tooltip.
 964 .It
 965 .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
 966 writes a snapshot of the dialog window to an image file of the
 967 specified type.
 968 .It
 969 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
 970 sets the dialog window's minimum size to
 971 .Ar width
 972 x
 973 .Ar height .
 974 Default is its natural size.
 975 .It
 976 .Qo
 977 .Ar id Ns Cm :style
 978 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
 979 .Qc
 980 sets the dialog window's style.
 981 See
 982 .Sx Style .
 983 .Pp
 984 .Qq Ar id Ns Cm :ping Bq Ar text
 985 triggers a feedback message.
 986 .El
 987 .It Feedback
 988 .Bl -item
 989 .It
 990 .Qq Ar id Ns Cm \&:closed
 991 if the
 992 .Cm GtkDialog
 993 window was closed by the window manager.
 994 .Pp
 995 .Qq Ar id Ns Cm :ping Ar text
 996 if triggered by the
 997 .Cm :ping
 998 command.
 999 .El
1000 .El
1001 .Ss GtkDrawingArea
1002 Drawing commands
1003 expect a context parameter of the form
1004 .Bro Ar n Ns | Ns Cm = Ns Ar n Ns | Ns Ar n Ns Cm < Ns Ar m Brc
1005 where
1006 .Ar n
1007 is an arbitrary non-negative integer that can be used later to
1008 reference the command.
1009 The first form,
1010 .Ar n ,
1011 appends its command to the current list of drawing operations.
1012 The second form,
1013 .Cm = Ns Ar n ,
1014 replaces the first drawing operation with context parameter
1015 .Ar n
1016 by the new command.
1017 The third form,
1018 .Ar n Ns Cm < Ns Ar m ,
1019 inserts its command before the first drawing operation with context
1020 parameter
1021 .Ar m .
1022 Both second and third form fall back to appending.
1023 .Pp
1024 The default coordinate system is a left-handed system with its origin
1025 in the upper-left corner.
1026 Angles increase from the positive X axis towards the positve Y axis
1027 .Pq clockwise in the default system .
1028 .Bl -tag -width indent
1029 .It Commands
1030 .Bl -item
1031 .It
1032 .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
1033 adds a circular arc to the current path.
1034 The arc is centered at
1035 .Pq Ar x , y
1036 and proceeds from
1037 .Ar angle1
1038 to
1039 .Ar angle2
1040 .Pq in degrees .
1041 .It
1042 .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
1043 adds a circular arc to the current path.
1044 The arc is centered at
1045 .Pq Ar x , y
1046 and proceeds in the direction of decreasing angles from
1047 .Ar angle1
1048 to
1049 .Ar angle2
1050 .Pq in degrees .
1051 .It
1052 .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
1053 adds a line segment from the current point to the point most recently
1054 passed to
1055 .Ar id Ns Cm :move_to
1056 or
1057 .Ar id Ns Cm :rel_move_to .
1058 .It
1059 .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
1060 adds a cubic Bezier spline from the current point to
1061 .Pq Ar x3 , y3 ,
1062 using
1063 .Pq Ar x1 , y1
1064 and
1065 .Pq Ar x2 , y2
1066 as control points.
1067 If there is no current point, the curve will start at
1068 .Pq Ar x1 , y1 .
1069 .It
1070 .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
1071 fills the current path and clears it.
1072 .It
1073 .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
1074 fills the current path without clearing it.
1075 .It
1076 .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
1077 adds a line from the current point to
1078 .Pq Ar x , y ,
1079 or creates a new current point at
1080 .Pq Ar x , y .
1081 .It
1082 .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
1083 sets the current point to
1084 .Pq Ar x , y .
1085 .It
1086 .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
1087 adds a rectangle to the current path.
1088 The top left corner is at
1089 .Pq Ar x , y .
1090 .It
1091 .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
1092 adds a cubic Bezier spline from the current point to
1093 .Pq Ar dx3 , dy3 ,
1094 using
1095 .Pq Ar dx1 , dy1
1096 and
1097 .Pq Ar dx2 , dy2
1098 as control points.
1099 All coordinates are offsets relative to the current point.
1100 .It
1101 .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
1102 adds a line from the current point to a point offset from there by
1103 .Pq Ar dx , dy .
1104 .It
1105 .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
1106 .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
1107 .Ar text
1108 .Qc
1109 moves the current point such that
1110 .Qq Ar id Ns Cm :show_text Ar n text
1111 will place the specified reference point of
1112 .Ar text
1113 on the original current point.
1114 .It
1115 .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
1116 moves the current point by
1117 .Pq Ar dx , dy .
1118 .It
1119 .Qq Ar id Ns Cm :remove Ar n
1120 removes the elements with context parameter
1121 .Ar n
1122 from the
1123 .Cm GtkDrawingArea Ar id .
1124 .It
1125 .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
1126 rotates the user space axes by
1127 .Ar angle
1128 .Pq in degrees .
1129 .It
1130 .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
1131 scales the user space axes by
1132 .Pq Ar sx , sy .
1133 .It
1134 .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
1135 sets the dash pattern to
1136 .Ar l
1137 on,
1138 .Ar l
1139 off.
1140 .It
1141 .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 ...
1142 resets the dash pattern to a line with arbitrary on/off portions.
1143 .It
1144 .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
1145 resets the dash pattern to a solid line.
1146 .It
1147 .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
1148 .Brq Cm normal | italic | oblique
1149 .Brq Cm normal | bold
1150 .Bq Ar family
1151 .Qc
1152 sets the font face for subsequent calls of
1153 .Ar id Ns Cm :show_text .
1154 .It
1155 .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
1156 sets the font size for subsequent calls of
1157 .Ar id Ns Cm :show_text .
1158 .It
1159 .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
1160 sets the line cap style.
1161 Default is
1162 .Cm butt .
1163 .It
1164 .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
1165 sets the line junction style.
1166 Default is
1167 .Cm miter .
1168 .It
1169 .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
1170 sets the line width.
1171 Default
1172 .Ar width
1173 is 2.
1174 .It
1175 .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
1176 sets the color; see
1177 .Sx Color .
1178 .It
1179 .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
1180 writes
1181 .Ar text ,
1182 beginning at the current point.
1183 .It
1184 .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
1185 strokes the current path and clears it.
1186 .It
1187 .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
1188 strokes the current path without clearing it.
1189 .It
1190 .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
1191 modifies the current transformation matrix such that
1192 .It
1193 .Dl Va x' Li = Ar xx Va x Li + Ar xy Va y Li + Ar x0 ,
1194 .Dl Va y' Li = Ar yx Va y Li + Ar yy Va y Li + Ar y0 .
1195 .Pp
1196 Default is resetting the current transformation matrix.
1197 .It
1198 .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
1199 translates the user space origin by
1200 .Pq Ar tx , ty .
1201 .It
1202 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1203 hides
1204 .Pq Cm 0
1205 the drawing area, or makes it visible
1206 .Pq Cm 1 .
1207 .It
1208 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1209 sets the drawing area's tooltip.
1210 Default is disabling the tooltip.
1211 .It
1212 .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
1213 writes a snapshot of the drawing area to an image file of the specified
1214 type.
1215 .It
1216 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1217 sets the drawing areas's minimum size to
1218 .Ar width
1219 x
1220 .Ar height .
1221 Default is the natural size.
1222 .Pp
1223 .Qq Ar id Ns Cm :ping Bq Ar text
1224 triggers a feedback message.
1225 .El
1226 .It Feedback
1227 .Bl -item
1228 .It
1229 .Qq Ar id Ns Cm :ping Ar text
1230 if triggered by the
1231 .Cm :ping
1232 command.
1233 .El
1234 .El
1235 .Ss GtkEntry
1236 .Bl -tag -width indent
1237 .It Commands
1238 .Bl -item
1239 .It
1240 .Qq Ar id Ns Cm :set_text Ar string
1241 replaces the user-editable text with
1242 .Ar string .
1243 .It
1244 .Qq Ar id Ns Cm :set_placeholder_text Ar string
1245 sets the
1246 .Ar string
1247 that is displayed when the entry is empty and unfocused.
1248 .It
1249 .Qq Ar id Ns Cm :grab_focus
1250 puts the keyboard focus into the entry.
1251 .It
1252 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1253 makes the entry grayed out
1254 .Pq Cm 0
1255 or responsive
1256 .Pq Cm 1 .
1257 .It
1258 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1259 hides
1260 .Pq Cm 0
1261 the entry, or makes it visible
1262 .Pq Cm 1 .
1263 .It
1264 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1265 blocks
1266 .Pq Cm 1
1267 or unblocks
1268 .Pq Cm 0
1269 feedback messages.
1270 Initially, the entry is unblocked.
1271 .It
1272 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1273 sets the entry's tooltip.
1274 Default is disabling the tooltip.
1275 .It
1276 .Qq Ar id Ns Cm :force
1277 lets the entry report its current content.
1278 .It
1279 .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
1280 writes a snapshot of the entry to an image file of the specified
1281 type.
1282 .It
1283 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1284 sets the entry's minimum size to
1285 .Ar width
1286 x
1287 .Ar height .
1288 Default is the entry's natural size.
1289 .It
1290 .Qo
1291 .Ar id Ns Cm :style
1292 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1293 .Qc
1294 sets the style.
1295 See
1296 .Sx Style .
1297 .Pp
1298 .Qq Ar id Ns Cm :ping Bq Ar text
1299 triggers a feedback message.
1300 .El
1301 .It Feedback
1302 .Bl -item
1303 .It
1304 .Qq Ar id Ns Cm \&:text Ar text ,
1305 once for each change of
1306 .Ar text .
1307 .Pp
1308 .Qq Ar id Ns Cm :ping Ar text
1309 if triggered by the
1310 .Cm :ping
1311 command.
1312 .El
1313 .El
1314 .Ss GtkEventBox
1315 .Ar x , y
1316 are mouse pointer coordinates relative to the
1317 .Cm GtkEventBox .
1318 .Bl -tag -width indent
1319 .It Commands
1320 .Bl -item
1321 .It
1322 .Qq Ar id Ns Cm :grab_focus
1323 puts the keyboard focus onto the event box.
1324 .It
1325 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1326 makes the event box insensitive
1327 .Pq Cm 0
1328 or responsive
1329 .Pq Cm 1 .
1330 .It
1331 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1332 blocks
1333 .Pq Cm 1
1334 or unblocks
1335 .Pq Cm 0
1336 feedback messages.
1337 Initially, the event box is unblocked.
1338 .It
1339 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1340 sets the tooltip of the event box.
1341 Default is disabling the tooltip.
1342 .It
1343 .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
1344 writes a snapshot of the event box to an image file of the specified
1345 type.
1346 .It
1347 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1348 sets the minimum size to
1349 .Ar width
1350 x
1351 .Ar height .
1352 Default is the natural size of the event box.
1353 .It
1354 .Qo
1355 .Ar id Ns Cm :style
1356 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1357 .Qc
1358 sets the widget style.
1359 See
1360 .Sx Style .
1361 .Pp
1362 .Qq Ar id Ns Cm :ping Bq Ar text
1363 triggers a feedback message.
1364 .El
1365 .It Feedback
1366 .Bl -item
1367 .It
1368 .Qq Ar id Ns Cm \&:button_press Ar b x y ,
1369 .Qq Ar id Ns Cm \&:button_release Ar b x y
1370 where
1371 .Ar b
1372 is the mouse button (normally 1, 2, or 3 for the left, middle, and
1373 right button; others may exist).
1374 .It
1375 .Qq Ar id Ns Cm \&:motion Ar x y
1376 is reported repeatedly while the mouse is being moved with a button
1377 pressed.
1378 .It
1379 .Qq Ar id Ns Cm \&:key_press Ar key ,
1380 .Ar key
1381 being the key's name
1382 .Po e.g.
1383 .Ql Control_L ,
1384 .Ql Tab ,
1385 .Ql a
1386 .Pc .
1387 .Pp
1388 .Qq Ar id Ns Cm :ping Ar text
1389 if triggered by the
1390 .Cm :ping
1391 command.
1392 .El
1393 .El
1394 .Ss GtkExpander
1395 .Bl -tag -width indent
1396 .It Commands
1397 .Bl -item
1398 .It
1399 .Qq Ar id Ns Cm :set_label Ar string
1400 replaces the expander label text with
1401 .Ar string .
1402 .It
1403 .Qq Ar id Ns Cm :set_expanded Brq Cm 0 Ns | Ns  1
1404 hides
1405 .Pq Cm 0
1406 the child widget, or makes it visible
1407 .Pq Cm 1 .
1408 .It
1409 .Qq Ar id Ns Cm :grab_focus
1410 puts the keyboard focus onto the expander.
1411 .It
1412 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1413 makes the expander grayed out
1414 .Pq Cm 0
1415 or responsive
1416 .Pq Cm 1 .
1417 .It
1418 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1419 hides
1420 .Pq Cm 0
1421 the expander, or makes it visible
1422 .Pq Cm 1 .
1423 .It
1424 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1425 sets the expander's tooltip.
1426 Default is disabling the tooltip.
1427 .It
1428 .Qq Ar id Ns Cm :force
1429 toggles the expansion state.
1430 .It
1431 .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
1432 writes a snapshot of the expander to an image file of the specified
1433 type.
1434 .It
1435 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1436 sets the expander's minimum size to
1437 .Ar width
1438 x
1439 .Ar height .
1440 Default is the natural size.
1441 .It
1442 .Qo
1443 .Ar id Ns Cm :style
1444 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1445 .Qc
1446 sets the style.
1447 See
1448 .Sx Style .
1449 .Pp
1450 .Qq Ar id Ns Cm :ping Bq Ar text
1451 triggers a feedback message.
1452 .El
1453 .It Feedback
1454 .Bl -item
1455 .It
1456 .Qq Ar id Ns Cm :ping Ar text
1457 if triggered by the
1458 .Cm :ping
1459 command.
1460 .El
1461 .El
1462 .Ss GtkGrid
1463 .Bl -tag -width indent
1464 .It Commands
1465 .Bl -item
1466 .It
1467 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1468 hides
1469 .Pq Cm 0
1470 the grid, or makes it visible
1471 .Pq Cm 1 .
1472 .It
1473 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1474 sets the grid's tooltip.
1475 Default is disabling the tooltip.
1476 .It
1477 .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
1478 writes a snapshot of the grid to an image file of the specified
1479 type.
1480 .It
1481 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1482 sets the grid's minimum size to
1483 .Ar width
1484 x
1485 .Ar height .
1486 Default is the grid's natural size.
1487 .It
1488 .Qo
1489 .Ar id Ns Cm :style
1490 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1491 .Qc
1492 sets the style.
1493 See
1494 .Sx Style .
1495 .Pp
1496 .Qq Ar id Ns Cm :ping Bq Ar text
1497 triggers a feedback message.
1498 .El
1499 .It Feedback
1500 .Bl -item
1501 .It
1502 .Qq Ar id Ns Cm :ping Ar text
1503 if triggered by the
1504 .Cm :ping
1505 command.
1506 .El
1507 .El
1508 .Ss GtkFileChooserButton
1509 .Bl -tag -width indent
1510 .It Commands
1511 .Bl -item
1512 .It
1513 .Qq Ar id Ns Cm :set_filename Ar path
1514 preselects
1515 .Ar path
1516 to the extent it exists.
1517 .It
1518 .Qq Ar id Ns Cm :grab_focus
1519 puts the keyboard focus onto the button.
1520 .It
1521 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1522 makes the button grayed out
1523 .Pq Cm 0
1524 or responsive
1525 .Pq Cm 1 .
1526 .It
1527 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1528 hides
1529 .Pq Cm 0
1530 the button, or makes it visible
1531 .Pq Cm 1 .
1532 .It
1533 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1534 blocks
1535 .Pq Cm 1
1536 or unblocks
1537 .Pq Cm 0
1538 feedback messages.
1539 Initially, the button is unblocked.
1540 .It
1541 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1542 sets the button's tooltip.
1543 Default is disabling the tooltip.
1544 .It
1545 .Qq Ar id Ns Cm :force
1546 simulates fresh selection of the currently selected pathname.
1547 .It
1548 .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
1549 writes a snapshot of the button to an image file of the specified
1550 type.
1551 .It
1552 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1553 sets the button's minimum size to
1554 .Ar width
1555 x
1556 .Ar height .
1557 Default is the widget's natural size.
1558 .It
1559 .Qo
1560 .Ar id Ns Cm :style
1561 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1562 .Qc
1563 sets the style.
1564 See
1565 .Sx Style .
1566 .Pp
1567 .Qq Ar id Ns Cm :ping Bq Ar text
1568 triggers a feedback message.
1569 .El
1570 .It Feedback
1571 .Bl -item
1572 .It
1573 .Qq Ar id Ns Cm \&:file Ar pathname
1574 if the selection has changed.
1575 .Pp
1576 .Qq Ar id Ns Cm :ping Ar text
1577 if triggered by the
1578 .Cm :ping
1579 command.
1580 .El
1581 .El
1582 .Ss GtkFileChooserDialog
1583 A
1584 .Cm GtkFileChooserDialog
1585 with id
1586 .Ar foo
1587 will be invoked by a
1588 .Sx GtkMenuItem
1589 or a
1590 .Sx GtkImageMenuItem
1591 with id
1592 .Ar foo Ns Cm _invoke .
1593 .Pp
1594 The
1595 .Cm GtkFileChooserDialog
1596 should have an
1597 .Sq OK
1598 .Sx GtkButton
1599 with id
1600 .Ar foo Ns Cm _ok
1601 .Po Cm main_ok
1602 if the dialog is the sole window of the GUI and therefore named
1603 .Cm main
1604 .Pc .
1605 .Pp
1606 The
1607 .Cm GtkFileChooserDialog
1608 may have a
1609 .Sq Cancel
1610 .Sx GtkButton
1611 with id
1612 .Ar foo Ns Cm _cancel
1613 .Po Cm main_cancel
1614 if the dialog is the sole window of the GUI and therefore named
1615 .Cm main
1616 .Pc .
1617 .Pp
1618 The
1619 .Cm GtkFileChooserDialog
1620 may have an
1621 .Sq Apply
1622 .Sx GtkButton
1623 with id
1624 .Ar foo Ns Cm _apply
1625 .Po Cm main_apply
1626 if the dialog is the sole window of the GUI and therefore named
1627 .Cm main
1628 .Pc .
1629 .Bl -tag -width indent
1630 .It Commands
1631 .Bl -item
1632 .It
1633 .Qq Ar id Ns Cm :set_filename Ar path
1634 preselects
1635 .Ar path
1636 to the extent it exists.
1637 .It
1638 .Qq Ar id Ns Cm :set_current_name Ar string
1639 makes
1640 .Ar string
1641 the suggested filename, which may not yet exist.
1642 .Ar string
1643 should either resemble an absolute path, or the
1644 .Ar directory
1645 must be set separately by
1646 .Ar id Ns Cm :set_filename Ar directory .
1647 .It
1648 .Qq Ar id Ns Cm :set_title Ar string
1649 replaces the text in the title bar with
1650 .Ar string .
1651 .It
1652 .Qq Ar id Ns Cm :resize Bq Ar width height
1653 changes the size of the dialog window to
1654 .Ar width
1655 x
1656 .Ar height
1657 pixels if specified, or to the default size.
1658 .It
1659 .Qq Ar id Ns Cm :move Ar x y
1660 moves the dialog window to position
1661 .Pq Ar x , y .
1662 .It
1663 .Qq Ar id Ns Cm :fullscreen
1664 and
1665 .Qq Ar id Ns Cm :unfullscreen
1666 switch fullscreen mode on and off.
1667 .It
1668 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1669 makes the dialog grayed out
1670 .Pq Cm 0
1671 or responsive
1672 .Pq Cm 1 .
1673 .It
1674 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1675 hides
1676 .Pq Cm 0
1677 the dialog, or makes it visible
1678 .Pq Cm 1 .
1679 .It
1680 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1681 blocks
1682 .Pq Cm 1
1683 or unblocks
1684 .Pq Cm 0
1685 feedback messages form the dialog window.
1686 Initially, the widget is unblocked.
1687 .It
1688 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1689 sets the dialog window's tooltip.
1690 Default is disabling the tooltip.
1691 .It
1692 .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
1693 writes a snapshot of the widget to an image file of the specified
1694 type.
1695 .It
1696 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1697 sets the widget's minimum size to
1698 .Ar width
1699 x
1700 .Ar height .
1701 Default is the widget's natural size.
1702 .It
1703 .Qo
1704 .Ar id Ns Cm :style
1705 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1706 .Qc
1707 sets the widget style.
1708 See
1709 .Sx Style .
1710 .Pp
1711 .Qq Ar id Ns Cm :ping Bq Ar text
1712 triggers a feedback message.
1713 .El
1714 .It Feedback
1715 .Bl -item
1716 .It
1717 .Qq Ar id Ns Cm \&:file Ar pathname
1718 and/or
1719 .Qq Ar id Ns Cm \&:folder Ar pathname
1720 .It
1721 .Qq Ar id Ns Cm \&:closed
1722 if the
1723 .Cm GtkFileChooserDialog
1724 window was closed by the window manager.
1725 .Pp
1726 .Qq Ar id Ns Cm :ping Ar text
1727 if triggered by the
1728 .Cm :ping
1729 command.
1730 .El
1731 .El
1732 .Ss GtkFontButton
1733 .Bl -tag -width indent
1734 .It Commands
1735 .Bl -item
1736 .It
1737 .Qq Ar id Ns Cm :set_font_name Ar fontname
1738 preselects the font.
1739 .It
1740 .Qq Ar id Ns Cm :grab_focus
1741 puts the keyboard focus onto the button.
1742 .It
1743 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1744 makes the button grayed out
1745 .Pq Cm 0
1746 or responsive
1747 .Pq Cm 1 .
1748 .It
1749 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1750 hides
1751 .Pq Cm 0
1752 the button, or makes it visible
1753 .Pq Cm 1 .
1754 .It
1755 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
1756 blocks
1757 .Pq Cm 1
1758 or unblocks
1759 .Pq Cm 0
1760 feedback messages.
1761 Initially, the button is unblocked.
1762 .It
1763 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1764 sets the button's tooltip.
1765 Default is disabling the tooltip.
1766 .It
1767 .Qq Ar id Ns Cm :force
1768 opens the dialog window.
1769 .It
1770 .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
1771 writes a snapshot of the button to an image file of the specified
1772 type.
1773 .It
1774 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1775 sets the button's minimum size to
1776 .Ar width
1777 x
1778 .Ar height .
1779 Default is the button's natural size.
1780 .It
1781 .Qo
1782 .Ar id Ns Cm :style
1783 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1784 .Qc
1785 sets the style.
1786 See
1787 .Sx Style .
1788 .Pp
1789 .Qq Ar id Ns Cm :ping Bq Ar text
1790 triggers a feedback message.
1791 .El
1792 .It Feedback
1793 .Bl -item
1794 .It
1795 .Qq Ar id Ns Cm \&:font Ar fontname
1796 .Pp
1797 .Qq Ar id Ns Cm :ping Ar text
1798 if triggered by the
1799 .Cm :ping
1800 command.
1801 .El
1802 .El
1803 .Ss GtkFrame
1804 .Bl -tag -width indent
1805 .It Commands
1806 .Bl -item
1807 .It
1808 .Qq Ar id Ns Cm :set_label Ar text
1809 replaces the frame label text with
1810 .Ar string .
1811 .It
1812 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1813 makes the frame and its content grayed out
1814 .Pq Cm 0
1815 or responsive
1816 .Pq Cm 1 .
1817 .It
1818 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1819 hides
1820 .Pq Cm 0
1821 the frame, or makes it visible
1822 .Pq Cm 1 .
1823 .It
1824 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1825 sets the frame's tooltip.
1826 Default is disabling the tooltip.
1827 .It
1828 .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
1829 writes a snapshot of the frame to an image file of the specified
1830 type.
1831 .It
1832 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1833 sets the widget's minimum size to
1834 .Ar width
1835 x
1836 .Ar height .
1837 Default is the frame's natural size.
1838 .It
1839 .Qo
1840 .Ar id Ns Cm :style
1841 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1842 .Qc
1843 sets the style.
1844 See
1845 .Sx Style .
1846 .Pp
1847 .Qq Ar id Ns Cm :ping Bq Ar text
1848 triggers a feedback message.
1849 .El
1850 .It Feedback
1851 .Bl -item
1852 .It
1853 .Qq Ar id Ns Cm :ping Ar text
1854 if triggered by the
1855 .Cm :ping
1856 command.
1857 .El
1858 .El
1859 .Ss GtkImage
1860 .Bl -tag -width indent
1861 .It Commands
1862 .Bl -item
1863 .It
1864 .Qq Ar id Ns Cm :set_from_icon_name Ar icon-name
1865 replaces the image with one of the standard icons.
1866 .It
1867 .Qq Ar id Ns Cm :set_from_file Ar path
1868 replaces the image by the one found at
1869 .Ar path Ns .
1870 .It
1871 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1872 hides
1873 .Pq Cm 0
1874 the image, or makes it visible
1875 .Pq Cm 1 .
1876 .It
1877 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1878 sets the image's tooltip.
1879 Default is disabling the tooltip.
1880 .It
1881 .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
1882 writes a snapshot of the image to an image file of the specified
1883 type.
1884 .It
1885 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1886 sets the images's minimum size to
1887 .Ar width
1888 x
1889 .Ar height .
1890 Default is the image's natural size.
1891 .It
1892 .Qo
1893 .Ar id Ns Cm :style
1894 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1895 .Qc
1896 sets the style.
1897 See
1898 .Sx Style .
1899 .El
1900 .Pp
1901 .Qq Ar id Ns Cm :ping Bq Ar text
1902 triggers a feedback message.
1903 .It Feedback
1904 .Bl -item
1905 .It
1906 .Qq Ar id Ns Cm :ping Ar text
1907 if triggered by the
1908 .Cm :ping
1909 command.
1910 .El
1911 .El
1912 .Ss GtkMenu
1913 .Bl -tag -width indent
1914 .It Commands
1915 .Bl -item
1916 .It
1917 .Qq Ar id Ns Cm :popup ,
1918 .Qq Ar id Ns Cm :popdown
1919 displays the menu at mouse position or closes it, respectively.
1920 .It
1921 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1922 makes the menu grayed out
1923 .Pq Cm 0
1924 or responsive
1925 .Pq Cm 1 .
1926 .It
1927 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1928 sets the menu's tooltip.
1929 Default is disabling the tooltip.
1930 .It
1931 .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
1932 writes a snapshot of the (popped-up) menu to an image file of the
1933 specified type.
1934 .It
1935 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1936 sets the menu's minimum size to
1937 .Ar width
1938 x
1939 .Ar height .
1940 Default is the menu's natural size.
1941 .It
1942 .Qo
1943 .Ar id Ns Cm :style
1944 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
1945 .Qc
1946 sets the menu's style.
1947 See
1948 .Sx Style .
1949 .Pp
1950 .Qq Ar id Ns Cm :ping Bq Ar text
1951 triggers a feedback message.
1952 .El
1953 .It Feedback
1954 .Bl -item
1955 .It
1956 .Qq Ar id Ns Cm :ping Ar text
1957 if triggered by the
1958 .Cm :ping
1959 command.
1960 .El
1961 .El
1962 .Ss GtkMenuButton
1963 .Bl -tag -width indent
1964 .It Commands
1965 .Bl -item
1966 .It
1967 .Qq Ar id Ns Cm :grab_focus
1968 puts the keyboard focus onto the button.
1969 .It
1970 .Qq Ar id Ns Cm :force
1971 simulates a click onto the button.
1972 .It
1973 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
1974 makes the button grayed out
1975 .Pq Cm 0
1976 or responsive
1977 .Pq Cm 1 .
1978 .It
1979 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
1980 hides
1981 .Pq Cm 0
1982 the button, or makes it visible
1983 .Pq Cm 1 .
1984 .It
1985 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
1986 sets the button's tooltip.
1987 Default is disabling the tooltip.
1988 .It
1989 .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
1990 writes a snapshot of the button to an image file of the specified
1991 type.
1992 .It
1993 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
1994 sets the button's minimum size to
1995 .Ar width
1996 x
1997 .Ar height .
1998 Default is the button's natural size.
1999 .It
2000 .Qo
2001 .Ar id Ns Cm :style
2002 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2003 .Qc
2004 sets the button's style.
2005 See
2006 .Sx Style .
2007 .Pp
2008 .Qq Ar id Ns Cm :ping Bq Ar text
2009 triggers a feedback message.
2010 .El
2011 .It Feedback
2012 .Bl -item
2013 .It
2014 .Qq Ar id Ns Cm :ping Ar text
2015 if triggered by the
2016 .Cm :ping
2017 command.
2018 .El
2019 .El
2020 .Ss GtkImageMenuItem
2021 .Cm GtkImageMenuItem
2022 is deprecated.
2023 .Bl -tag -width indent
2024 .It Commands
2025 .Bl -item
2026 .It
2027 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2028 makes the item grayed out
2029 .Pq Cm 0
2030 or responsive
2031 .Pq Cm 1 .
2032 .It
2033 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2034 hides
2035 .Pq Cm 0
2036 the item, or makes it visible
2037 .Pq Cm 1 .
2038 .It
2039 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2040 blocks
2041 .Pq Cm 1
2042 or unblocks
2043 .Pq Cm 0
2044 feedback messages.
2045 Initially, the item is unblocked.
2046 .It
2047 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2048 sets the item's tooltip.
2049 Default is disabling the tooltip.
2050 .It
2051 .Qq Ar id Ns Cm :force
2052 simulates a click on the menu item.
2053 .It
2054 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2055 sets the item's minimum size to
2056 .Ar width
2057 x
2058 .Ar height .
2059 Default is the item's natural size.
2060 .It
2061 .Qo
2062 .Ar id Ns Cm :style
2063 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2064 .Qc
2065 sets the item's style.
2066 See
2067 .Sx Style .
2068 .Pp
2069 .Qq Ar id Ns Cm :ping Bq Ar text
2070 triggers a feedback message.
2071 .El
2072 .It Feedback
2073 .Bl -item
2074 .It
2075 A
2076 .Cm GtkImageMenuItem
2077 with id
2078 .Ar foo Ns Cm _invoke
2079 will invoke the
2080 .Sx GtkDialog
2081 or
2082 .Sx GtkFileChooserDialog
2083 with id
2084 .Ar foo
2085 if it exists.
2086 If there isn't any dialog attached to the
2087 .Cm GtkImageMenuItem ,
2088 it reports
2089 .Qq Ar id Ns Cm \&:active Ar label .
2090 .Pp
2091 .Qq Ar id Ns Cm :ping Ar text
2092 if triggered by the
2093 .Cm :ping
2094 command.
2095 .El
2096 .El
2097 .Ss GtkInfoBar
2098 .Bl -tag -width indent
2099 .It Commands
2100 .Bl -item
2101 .It
2102 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2103 makes the info bar grayed out
2104 .Pq Cm 0
2105 or responsive
2106 .Pq Cm 1 .
2107 .It
2108 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2109 hides
2110 .Pq Cm 0
2111 the info bar, or makes it visible
2112 .Pq Cm 1 .
2113 .It
2114 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2115 sets the info bar's tooltip.
2116 Default is disabling the tooltip.
2117 .It
2118 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2119 sets the info bar's minimum size to
2120 .Ar width
2121 x
2122 .Ar height .
2123 Default is the info bar's natural size.
2124 .It
2125 .Qo
2126 .Ar id Ns Cm :style
2127 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2128 .Qc
2129 sets the style.
2130 See
2131 .Sx Style .
2132 .Pp
2133 .Qq Ar id Ns Cm :ping Bq Ar text
2134 triggers a feedback message.
2135 .El
2136 .It Feedback
2137 .Bl -item
2138 .It
2139 .Qq Ar id Ns Cm :ping Ar text
2140 if triggered by the
2141 .Cm :ping
2142 command.
2143 .El
2144 .El
2145 .Ss GtkLabel
2146 .Bl -tag -width indent
2147 .It Commands
2148 .Bl -item
2149 .It
2150 .Qq Ar id Ns Cm :set_text Ar string
2151 replaces the label text with
2152 .Ar string .
2153 .It
2154 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2155 makes the label grayed out
2156 .Pq Cm 0
2157 or clearly visible
2158 .Pq Cm 1 .
2159 .It
2160 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2161 hides
2162 .Pq Cm 0
2163 the label, or makes it visible
2164 .Pq Cm 1 .
2165 .It
2166 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2167 sets the label's tooltip.
2168 Default is disabling the tooltip.
2169 .It
2170 .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
2171 writes a snapshot of the label to an image file of the specified
2172 type.
2173 .It
2174 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2175 sets the label's minimum size to
2176 .Ar width
2177 x
2178 .Ar height .
2179 Default is the natural size.
2180 .It
2181 .Qo
2182 .Ar id Ns Cm :style
2183 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2184 .Qc
2185 sets the label's style.
2186 See
2187 .Sx Style .
2188 .Pp
2189 .Qq Ar id Ns Cm :ping Bq Ar text
2190 triggers a feedback message.
2191 .El
2192 .It Feedback
2193 .Bl -item
2194 .It
2195 .Qq Ar id Ns Cm :ping Ar text
2196 if triggered by the
2197 .Cm :ping
2198 command.
2199 .El
2200 .El
2201 .Ss GtkLinkButton
2202 .Bl -tag -width indent
2203 .It Commands
2204 .Bl -item
2205 .It
2206 .Qq Ar id Ns Cm :set_visited Brq Cm 0 Ns | Ns Cm 1
2207 gives the button text the appearance of an unvisited
2208 .Pq Cm 0 , No default
2209 or visited
2210 .Pq Cm 1
2211 link.
2212 .It
2213 .Qq Ar id Ns Cm :set_label Ar string
2214 replaces the button text with
2215 .Ar string .
2216 .It
2217 .Qq Ar id Ns Cm :grab_focus
2218 puts the keyboard focus onto the button.
2219 .It
2220 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2221 makes the button grayed out
2222 .Pq Cm 0
2223 or responsive
2224 .Pq Cm 1 .
2225 .It
2226 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2227 hides
2228 .Pq Cm 0
2229 the button, or makes it visible
2230 .Pq Cm 1 .
2231 .It
2232 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2233 blocks
2234 .Pq Cm 1
2235 or unblocks
2236 .Pq Cm 0
2237 feedback messages.
2238 Initially, the button is unblocked.
2239 .It
2240 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2241 sets the button's tooltip.
2242 Default is disabling the tooltip.
2243 .It
2244 .Qq Ar id Ns Cm :force
2245 simulates a click on the button.
2246 .It
2247 .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
2248 writes a snapshot of the button to an image file of the specified
2249 type.
2250 .It
2251 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2252 sets the button's minimum size to
2253 .Ar width
2254 x
2255 .Ar height .
2256 Default is the button's natural size.
2257 .It
2258 .Qo
2259 .Ar id Ns Cm :style
2260 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2261 .Qc
2262 sets the style.
2263 See
2264 .Sx Style .
2265 .Pp
2266 .Qq Ar id Ns Cm :ping Bq Ar text
2267 triggers a feedback message.
2268 .El
2269 .It Feedback
2270 .Bl -item
2271 .It
2272 .Qq Ar id Ns Cm \&:clicked
2273 .Pp
2274 .Qq Ar id Ns Cm :ping Ar text
2275 if triggered by the
2276 .Cm :ping
2277 command.
2278 .El
2279 .El
2280 .Ss GtkMenuBar
2281 .Bl -tag -width indent
2282 .It Commands
2283 .Bl -item
2284 .It
2285 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2286 makes the menu bar grayed out
2287 .Pq Cm 0
2288 or responsive
2289 .Pq Cm 1 .
2290 .It
2291 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2292 hides
2293 .Pq Cm 0
2294 the menu bar, or makes it visible
2295 .Pq Cm 1 .
2296 .It
2297 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2298 sets the menu bar's tooltip.
2299 Default is disabling the tooltip.
2300 .It
2301 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2302 sets the menu bar's minimum size to
2303 .Ar width
2304 x
2305 .Ar height .
2306 Default is its natural size.
2307 .It
2308 .Qo
2309 .Ar id Ns Cm :style
2310 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2311 .Qc
2312 sets the menu bar's style.
2313 See
2314 .Sx Style .
2315 .Pp
2316 .Qq Ar id Ns Cm :ping Bq Ar text
2317 triggers a feedback message.
2318 .El
2319 .It Feedback
2320 .Bl -item
2321 .It
2322 .Qq Ar id Ns Cm :ping Ar text
2323 if triggered by the
2324 .Cm :ping
2325 command.
2326 .El
2327 .El
2328 .Ss GtkMenuItem
2329 .Bl -tag -width indent
2330 .It Commands
2331 .Bl -item
2332 .It
2333 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2334 makes the item grayed out
2335 .Pq Cm 0
2336 or responsive
2337 .Pq Cm 1 .
2338 .It
2339 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2340 hides
2341 .Pq Cm 0
2342 the item, or makes it visible
2343 .Pq Cm 1 .
2344 .It
2345 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2346 blocks
2347 .Pq Cm 1
2348 or unblocks
2349 .Pq Cm 0
2350 feedback messages.
2351 Initially, the item is unblocked.
2352 .It
2353 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2354 sets the item's tooltip.
2355 Default is disabling the tooltip.
2356 .It
2357 .Qq Ar id Ns Cm :force
2358 simulates a click on the menu item.
2359 .It
2360 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2361 sets the item's minimum size to
2362 .Ar width
2363 x
2364 .Ar height .
2365 Default is the item's natural size.
2366 .It
2367 .Qo
2368 .Ar id Ns Cm :style
2369 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2370 .Qc
2371 sets the item's style.
2372 See
2373 .Sx Style .
2374 .Pp
2375 .Qq Ar id Ns Cm :ping Bq Ar text
2376 triggers a feedback message.
2377 .El
2378 .It Feedback
2379 .Bl -item
2380 .It
2381 A
2382 .Cm GtkMenuItem
2383 with id
2384 .Ar foo Ns Cm _invoke
2385 will invoke the
2386 .Sx GtkDialog
2387 or
2388 .Sx GtkFileChooserDialog
2389 with id
2390 .Ar foo
2391 if it exists.
2392 If there isn't any dialog attached to the
2393 .Cm GtkMenuItem ,
2394 it reports
2395 .Qq Ar id Ns Cm \&:active Ar label .
2396 .Pp
2397 .Qq Ar id Ns Cm :ping Ar text
2398 if triggered by the
2399 .Cm :ping
2400 command.
2401 .El
2402 .El
2403 .Ss GtkNotebook
2404 .Bl -tag -width indent
2405 .It Commands
2406 .Bl -item
2407 .It
2408 .Qq Ar id Ns Cm :set_current_page Ar n
2409 switches to zero-based page number
2410 .Ar n .
2411 .It
2412 .Qq Ar id Ns Cm :grab_focus
2413 puts the keyboard focus onto the notebook.
2414 .It
2415 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2416 makes the notebook grayed out
2417 .Pq Cm 0
2418 or responsive
2419 .Pq Cm 1 .
2420 .It
2421 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2422 hides
2423 .Pq Cm 0
2424 the notebook, or makes it visible
2425 .Pq Cm 1 .
2426 .It
2427 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2428 sets the notebook's tooltip.
2429 Default is disabling the tooltip.
2430 .It
2431 .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
2432 writes a snapshot of the notebook to an image file of the specified
2433 type.
2434 .It
2435 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2436 sets the notebooks's minimum size to
2437 .Ar width
2438 x
2439 .Ar height .
2440 Default is the widget's natural size.
2441 .It
2442 .Qo
2443 .Ar id Ns Cm :style
2444 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2445 .Qc
2446 sets the notebook's style.
2447 See
2448 .Sx Style .
2449 .Pp
2450 .Qq Ar id Ns Cm :ping Bq Ar text
2451 triggers a feedback message.
2452 .El
2453 .It Feedback
2454 .Bl -item
2455 .It
2456 .Qq Ar id Ns Cm :ping Ar text
2457 if triggered by the
2458 .Cm :ping
2459 command.
2460 .El
2461 .El
2462 .Ss GtkOverlay
2463 .Bl -tag -width indent
2464 .It Commands
2465 .Bl -item
2466 .It
2467 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2468 makes the overlay grayed out
2469 .Pq Cm 0
2470 or responsive
2471 .Pq Cm 1 .
2472 .It
2473 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2474 hides
2475 .Pq Cm 0
2476 the overlay, or makes it visible
2477 .Pq Cm 1 .
2478 .It
2479 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2480 sets the overlay's tooltip.
2481 Default is disabling the tooltip.
2482 .It
2483 .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
2484 writes a snapshot of the overlay to an image file of the specified
2485 type.
2486 .It
2487 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2488 sets the overlay's minimum size to
2489 .Ar width
2490 x
2491 .Ar height .
2492 Default is the overlay's natural size.
2493 .It
2494 .Qo
2495 .Ar id Ns Cm :style
2496 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2497 .Qc
2498 sets the style.
2499 See
2500 .Sx Style .
2501 .Pp
2502 .Qq Ar id Ns Cm :ping Bq Ar text
2503 triggers a feedback message.
2504 .El
2505 .It Feedback
2506 .Bl -item
2507 .It
2508 .Qq Ar id Ns Cm :ping Ar text
2509 if triggered by the
2510 .Cm :ping
2511 command.
2512 .El
2513 .El
2514 .Ss GtkPaned
2515 .Bl -tag -width indent
2516 .It Commands
2517 .Bl -item
2518 .It
2519 .Qq Ar id Ns Cm :grab_focus
2520 puts the keyboard focus onto the handle.
2521 .It
2522 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2523 makes the widget grayed out
2524 .Pq Cm 0
2525 or responsive
2526 .Pq Cm 1 .
2527 .It
2528 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2529 hides
2530 .Pq Cm 0
2531 the widget, or makes it visible
2532 .Pq Cm 1 .
2533 .It
2534 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2535 sets the widget's tooltip.
2536 Default is disabling the tooltip.
2537 .It
2538 .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
2539 writes a snapshot of the widget to an image file of the specified
2540 type.
2541 .It
2542 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2543 sets the widget's minimum size to
2544 .Ar width
2545 x
2546 .Ar height .
2547 Default is the widget's natural size.
2548 .It
2549 .Qo
2550 .Ar id Ns Cm :style
2551 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2552 .Qc
2553 sets the style.
2554 See
2555 .Sx Style .
2556 .Pp
2557 .Qq Ar id Ns Cm :ping Bq Ar text
2558 triggers a feedback message.
2559 .El
2560 .It Feedback
2561 .Bl -item
2562 .It
2563 .Qq Ar id Ns Cm :ping Ar text
2564 if triggered by the
2565 .Cm :ping
2566 command.
2567 .El
2568 .El
2569 .Ss GtkPlug
2570 The main window can be turned into a
2571 .Cm GtkPlug
2572 and embedded into the XEmbed socket of another process; see
2573 .Sx OPTIONS ,
2574 option
2575 .Fl e .
2576 .Ss GtkPrintUnixDialog
2577 .Bl -tag -width indent
2578 .It Commands
2579 .Bl -item
2580 .It
2581 .Qq Ar id Ns Cm :print Ar file.ps
2582 opens the print dialog.
2583 Pressing the
2584 .Ql Print
2585 button sends
2586 .Ar file.ps
2587 to the printer the user selected in the dialog.
2588 .It
2589 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2590 makes the dialog grayed out
2591 .Pq Cm 0
2592 or responsive
2593 .Pq Cm 1 .
2594 .It
2595 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2596 hides
2597 .Pq Cm 0
2598 the dialog, or makes it visible
2599 .Pq Cm 1 .
2600 .It
2601 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2602 blocks
2603 .Pq Cm 1
2604 or unblocks
2605 .Pq Cm 0
2606 feedback messages.
2607 Initially, the dialog is unblocked.
2608 .It
2609 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2610 sets the dialog's tooltip.
2611 Default is disabling the tooltip.
2612 .It
2613 .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
2614 writes a snapshot of the dialog to an image file of the specified
2615 type.
2616 .It
2617 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2618 sets the dialog's minimum size to
2619 .Ar width
2620 x
2621 .Ar height .
2622 Default is the dialog's natural size.
2623 .It
2624 .Qo
2625 .Ar id Ns Cm :style
2626 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2627 .Qc
2628 sets the widget style.
2629 See
2630 .Sx Style .
2631 .Pp
2632 .Qq Ar id Ns Cm :ping Bq Ar text
2633 triggers a feedback message.
2634 .El
2635 .It Feedback
2636 .Bl -item
2637 .It
2638 .Qq Ar id Ns Cm \&:closed
2639 if the
2640 .Cm GtkPrintUnixDialog
2641 window was closed by the window manager.
2642 .Pp
2643 .Qq Ar id Ns Cm :ping Ar text
2644 if triggered by the
2645 .Cm :ping
2646 command.
2647 .El
2648 .El
2649 .Ss GtkProgressBar
2650 .Bl -tag -width indent
2651 .It Commands
2652 .Bl -item
2653 .It
2654 .Qq Ar id Ns Cm :set_fraction Ar x
2655 moves the progress bar to
2656 .Ar x
2657 .Pq between 0 and 1 .
2658 .It
2659 .Qq Ar id Ns Cm :set_text Bq Ar string
2660 replaces the text of the progress bar with
2661 .Ar string .
2662 Default is the progress percentage.
2663 .It
2664 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2665 hides
2666 .Pq Cm 0
2667 the progress bar, or makes it visible
2668 .Pq Cm 1 .
2669 .It
2670 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2671 sets the tooltip of the progressbar.
2672 Default is disabling the tooltip.
2673 .It
2674 .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
2675 writes a snapshot of the progress bar to an image file of the
2676 specified type.
2677 .It
2678 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2679 sets the minimum size of the progress bar to
2680 .Ar width
2681 x
2682 .Ar height .
2683 Default is the natural size.
2684 .It
2685 .Qo
2686 .Ar id Ns Cm :style
2687 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2688 .Qc
2689 sets the style.
2690 See
2691 .Sx Style .
2692 .Pp
2693 .Qq Ar id Ns Cm :ping Bq Ar text
2694 triggers a feedback message.
2695 .El
2696 .It Feedback
2697 .Bl -item
2698 .It
2699 .Qq Ar id Ns Cm :ping Ar text
2700 if triggered by the
2701 .Cm :ping
2702 command.
2703 .El
2704 .El
2705 .Ss GtkRadioButton
2706 .Bl -tag -width indent
2707 .It Commands
2708 .Bl -item
2709 .It
2710 .Qq Ar id Ns Cm :set_active 1
2711 switches the button on.
2712 All other buttons of the same group will go off automatically.
2713 .It
2714 .Qq Ar id Ns Cm :set_label Ar string
2715 replaces the button text with
2716 .Ar string .
2717 .It
2718 .Qq Ar id Ns Cm :grab_focus
2719 puts the keyboard focus onto the button.
2720 .It
2721 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2722 makes the button grayed out
2723 .Pq Cm 0
2724 or responsive
2725 .Pq Cm 1 .
2726 .It
2727 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2728 hides
2729 .Pq Cm 0
2730 the button, or makes it visible
2731 .Pq Cm 1 .
2732 .It
2733 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2734 blocks
2735 .Pq Cm 1
2736 or unblocks
2737 .Pq Cm 0
2738 feedback messages.
2739 Initially, the button is unblocked.
2740 .It
2741 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2742 sets the button's tooltip.
2743 Default is disabling the tooltip.
2744 .It
2745 .Qq Ar id Ns Cm :force
2746 simulates a click on the button.
2747 .It
2748 .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
2749 writes a snapshot of the button to an image file of the specified
2750 type.
2751 .It
2752 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2753 sets the button's minimum size to
2754 .Ar width
2755 x
2756 .Ar height .
2757 Default is the button's natural size.
2758 .It
2759 .Qo
2760 .Ar id Ns Cm :style
2761 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2762 .Qc
2763 sets the style.
2764 See
2765 .Sx Style .
2766 .Pp
2767 .Qq Ar id Ns Cm :ping Bq Ar text
2768 triggers a feedback message.
2769 .El
2770 .It Feedback
2771 .Bl -item
2772 .It
2773 .Qq Ar id Ns Cm \&:1
2774 if switched on, or
2775 .Qq Ar id Ns Cm \&:0
2776 otherwise.
2777 .Pp
2778 .Qq Ar id Ns Cm :ping Ar text
2779 if triggered by the
2780 .Cm :ping
2781 command.
2782 .El
2783 .El
2784 .Ss GtkScale
2785 .Bl -tag -width indent
2786 .It Commands
2787 .Bl -item
2788 .It
2789 .Qq Ar id Ns Cm :set_value Ar x
2790 moves the slider to value
2791 .Ar x .
2792 .It
2793 .Qq Ar id Ns Cm :set_fill_level Bq Ar x
2794 moves the fill level indicator to value
2795 .Ar x .
2796 Default is hiding the fill level indicator.
2797 .It
2798 .Qq Ar id Ns Cm :set_range Ar min max
2799 changes the range.
2800 .It
2801 .Qq Ar id Ns Cm :set_increments Ar step page
2802 sets the steps the slider moves while pressing arrow keys and
2803 .Ql Page_Up Ns
2804 .Pf / Ql Page_Down ,
2805 respectively.
2806 .It
2807 .Qq Ar id Ns Cm :grab_focus
2808 puts the keyboard focus onto the scale.
2809 .It
2810 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2811 makes the scale grayed out
2812 .Pq Cm 0
2813 or responsive
2814 .Pq Cm 1 .
2815 .It
2816 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2817 hides
2818 .Pq Cm 0
2819 the scale, or makes it visible
2820 .Pq Cm 1 .
2821 .It
2822 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
2823 blocks
2824 .Pq Cm 1
2825 or unblocks
2826 .Pq Cm 0
2827 feedback messages.
2828 Initially, the scale is unblocked.
2829 .It
2830 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2831 sets the scale's tooltip.
2832 Default is disabling the tooltip.
2833 .It
2834 .Qq Ar id Ns Cm :force
2835 simulates fresh selection of the current value.
2836 .It
2837 .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
2838 writes a snapshot of the scale to an image file of the specified
2839 type.
2840 .It
2841 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2842 sets the scale's minimum size to
2843 .Ar width
2844 x
2845 .Ar height .
2846 Default is the natural size.
2847 .It
2848 .Qo
2849 .Ar id Ns Cm :style
2850 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2851 .Qc
2852 sets the style.
2853 See
2854 .Sx Style .
2855 .Pp
2856 .Qq Ar id Ns Cm :ping Bq Ar text
2857 triggers a feedback message.
2858 .El
2859 .It Feedback
2860 .Bl -item
2861 .It
2862 .Qq Ar id Ns Cm \&:value Ar number
2863 .Pp
2864 .Qq Ar id Ns Cm :ping Ar text
2865 if triggered by the
2866 .Cm :ping
2867 command.
2868 .El
2869 .El
2870 .Ss GtkScrolledWindow
2871 .Bl -tag -width indent
2872 .It Commands
2873 .Bl -item
2874 .It
2875 .Qq Ar id Ns Cm :hscroll Ar position
2876 and
2877 .Qq Ar id Ns Cm :vscroll Ar position
2878 scroll
2879 .Ar position
2880 to the left or top edge of the
2881 .Cm GtkScrolledWindow ,
2882 respectively.
2883 .It
2884 .Qq Ar id Ns Cm :hscroll_to_range Ar pos0 pos1
2885 and
2886 .Qq Ar id Ns Cm :vscroll_to_range Ar pos0 pos1
2887 scroll, if necessary, the range between
2888 .Ar pos0
2889 and
2890 .Ar pos1
2891 into the
2892 .Cm GtkScrolledWindow .
2893 If the range is greater than the window, the initial part of the range
2894 will be visible.
2895 .It
2896 .Qq Ar id Ns Cm :grab_focus
2897 puts the keyboard focus onto the widget.
2898 .It
2899 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2900 makes the widget grayed out
2901 .Pq Cm 0
2902 or responsive
2903 .Pq Cm 1 .
2904 .It
2905 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2906 hides
2907 .Pq Cm 0
2908 the widget, or makes it visible
2909 .Pq Cm 1 .
2910 .It
2911 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2912 sets the widget's tooltip.
2913 Default is disabling the tooltip.
2914 .It
2915 .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
2916 writes a snapshot of the widget to an image file of the specified
2917 type.
2918 .It
2919 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2920 sets the minimum size to
2921 .Ar width
2922 x
2923 .Ar height .
2924 Default is the widget's natural size.
2925 .It
2926 .Qo
2927 .Ar id Ns Cm :style
2928 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2929 .Qc
2930 sets the style.
2931 See
2932 .Sx Style .
2933 .Pp
2934 .Qq Ar id Ns Cm :ping Bq Ar text
2935 triggers a feedback message.
2936 .El
2937 .It Feedback
2938 .Bl -item
2939 .It
2940 .Qq Ar id Ns Cm :ping Ar text
2941 if triggered by the
2942 .Cm :ping
2943 command.
2944 .El
2945 .El
2946 .Ss GtkSeparator
2947 .Bl -tag -width indent
2948 .It Commands
2949 .Bl -item
2950 .It
2951 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
2952 makes the separator insensitive
2953 .Pq Cm 0
2954 or responsive
2955 .Pq Cm 1 .
2956 .It
2957 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
2958 sets the tooltip of the separator.
2959 Default is disabling the tooltip.
2960 .It
2961 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
2962 hides
2963 .Pq Cm 0
2964 the separator, or makes it visible
2965 .Pq Cm 1 .
2966 .It
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 separator to an image file of the specified
2969 type.
2970 .It
2971 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
2972 sets the minimum size to
2973 .Ar width
2974 x
2975 .Ar height .
2976 Default is the natural size of the separator.
2977 .It
2978 .Qo
2979 .Ar id Ns Cm :style
2980 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
2981 .Qc
2982 sets the widget style.
2983 See
2984 .Sx Style .
2985 .Pp
2986 .Qq Ar id Ns Cm :ping Bq Ar text
2987 triggers a feedback message.
2988 .El
2989 .It Feedback
2990 .Bl -item
2991 .It
2992 .Qq Ar id Ns Cm :ping Ar text
2993 if triggered by the
2994 .Cm :ping
2995 command.
2996 .El
2997 .El
2998 .Ss GtkSeparatorMenuItem
2999 .Bl -tag -width indent
3000 .It Commands
3001 .Bl -item
3002 .It
3003 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3004 makes the menu item insensitive
3005 .Pq Cm 0
3006 or responsive
3007 .Pq Cm 1 .
3008 .It
3009 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3010 hides
3011 .Pq Cm 0
3012 the menu item, or makes it visible
3013 .Pq Cm 1 .
3014 .It
3015 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3016 sets the tooltip of the menu item.
3017 Default is disabling the tooltip.
3018 .It
3019 .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
3020 writes a snapshot of the menu item to an image file of the specified
3021 type.
3022 .It
3023 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3024 sets the minimum size to
3025 .Ar width
3026 x
3027 .Ar height .
3028 Default is the natural size of the menu item.
3029 .It
3030 .Qo
3031 .Ar id Ns Cm :style
3032 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3033 .Qc
3034 sets the widget style.
3035 See
3036 .Sx Style .
3037 .Pp
3038 .Qq Ar id Ns Cm :ping Bq Ar text
3039 triggers a feedback message.
3040 .El
3041 .It Feedback
3042 .Bl -item
3043 .It
3044 .Qq Ar id Ns Cm :ping Ar text
3045 if triggered by the
3046 .Cm :ping
3047 command.
3048 .El
3049 .El
3050 .Ss GtkSizeGroup
3051 .Bl -tag -width indent
3052 .It Commands
3053 .Bl -item
3054 .It
3055 .Qq Ar id Ns Cm :ping Bq Ar text
3056 triggers a feedback message.
3057 .El
3058 .It Feedback
3059 .Bl -item
3060 .It
3061 .Qq Ar id Ns Cm :ping Ar text
3062 if triggered by the
3063 .Cm :ping
3064 command.
3065 .El
3066 .El
3067 .Ss GtkSocket
3068 .Cm GtkSocket
3069 may be unsupported by Glade, but its definition can be inserted
3070 manually into the GtkBuilder
3071 .Pq Pa .ui
3072 file:
3073 .Bd -literal -offset indent
3074 <child>
3075   <object class="GtkSocket" id="socket1">
3076     <property name="visible">True</property>
3077     <property name="can_focus">True</property>
3078   </object>
3079   <packing>
3080     <property name="expand">True</property>
3081     <property name="fill">True</property>
3082     <property name="position">1</property>
3083   </packing>
3084 </child>
3085 .Ed
3086 .Bl -tag -width indent
3087 .It Commands
3088 .Bl -item
3089 .It
3090 .Qq Ar id Ns Cm :id
3091 requests a feedback message containing the socket
3092 .Ar xid .
3093 .It
3094 .Qq Ar id Ns Cm :grab_focus
3095 puts the keyboard focus onto the socket.
3096 .It
3097 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3098 makes the socket grayed out
3099 .Pq Cm 0
3100 or responsive
3101 .Pq Cm 1 .
3102 .It
3103 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3104 hides
3105 .Pq Cm 0
3106 the socket, or makes it visible
3107 .Pq Cm 1 .
3108 .It
3109 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3110 sets the socket's tooltip.
3111 Default is disabling the tooltip.
3112 .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
3113 writes a snapshot of the socket to an image file of the specified
3114 type.
3115 .It
3116 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3117 sets the socket's minimum size to
3118 .Ar width
3119 x
3120 .Ar height .
3121 Default is the socket's natural size.
3122 .It
3123 .Qo
3124 .Ar id Ns Cm :style
3125 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3126 .Qc
3127 sets the style.
3128 See
3129 .Sx Style .
3130 .Pp
3131 .Qq Ar id Ns Cm :ping Bq Ar text
3132 triggers a feedback message.
3133 .El
3134 .It Feedback
3135 .Bl -item
3136 .It
3137 .Qq Ar id Ns Cm :id Ar xid
3138 can be used by another process to XEmbed its widgets into the
3139 .Cm GtkSocket .
3140 .It
3141 .Qq Ar id Ns Cm \&:plug-added ,
3142 .Qo
3143 .Ar id Ns Cm \&:plug-removed
3144 .Qc .
3145 Notification that the other process has inserted its widgets into or
3146 removed them from the
3147 .Cm GtkSocket .
3148 .Pp
3149 .Qq Ar id Ns Cm :ping Ar text
3150 if triggered by the
3151 .Cm :ping
3152 command.
3153 .El
3154 .El
3155 .Ss GtkSpinButton
3156 .Bl -tag -width indent
3157 .It Commands
3158 .Bl -item
3159 .It
3160 .Qq Ar id Ns Cm :set_text Ar string
3161 sets the selected value to
3162 .Ar string .
3163 .It
3164 .Qq Ar id Ns Cm :set_range Ar min max
3165 changes the range.
3166 .It
3167 .Qq Ar id Ns Cm :set_increments Ar step page
3168 sets the steps the value changes while pressing arrow keys/left mouse
3169 button, and
3170 .Ql Page_Up Ns
3171 .Pf / Ql Page_Down Ns
3172 /middle mouse button,
3173 respectively.
3174 .It
3175 .Qq Ar id Ns Cm :grab_focus
3176 puts the keyboard focus onto the button.
3177 .It
3178 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3179 makes the button grayed out
3180 .Pq Cm 0
3181 or responsive
3182 .Pq Cm 1 .
3183 .It
3184 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3185 hides
3186 .Pq Cm 0
3187 the button, or makes it visible
3188 .Pq Cm 1 .
3189 .It
3190 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3191 blocks
3192 .Pq Cm 1
3193 or unblocks
3194 .Pq Cm 0
3195 feedback messages.
3196 Initially, the button is unblocked.
3197 .It
3198 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3199 sets the button's tooltip.
3200 Default is disabling the tooltip.
3201 .It
3202 .Qq Ar id Ns Cm :force
3203 simulates fresh selection of the current value
3204 .It
3205 .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
3206 writes a snapshot of the button to an image file of the specified
3207 type.
3208 .It
3209 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3210 sets the button's minimum size to
3211 .Ar width
3212 x
3213 .Ar height .
3214 Default is the widget's natural size.
3215 .It
3216 .Qo
3217 .Ar id Ns Cm :style
3218 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3219 .Qc
3220 sets the button's style.
3221 See
3222 .Sx Style .
3223 .Pp
3224 .Qq Ar id Ns Cm :ping Bq Ar text
3225 triggers a feedback message.
3226 .El
3227 .It Feedback
3228 .Bl -item
3229 .It
3230 .Qq Ar id Ns Cm \&:text Ar text
3231 .Pp
3232 .Qq Ar id Ns Cm :ping Ar text
3233 if triggered by the
3234 .Cm :ping
3235 command.
3236 .El
3237 .El
3238 .Ss GtkSpinner
3239 .Bl -tag -width indent
3240 .It Commands
3241 .Bl -item
3242 .It
3243 .Qq Ar id Ns Cm :start
3244 and
3245 .Qq Ar id Ns Cm :stop
3246 start and stop the spinner.
3247 .It
3248 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3249 makes the spinner grayed out
3250 .Pq Cm 0
3251 or clearly visible
3252 .Pq Cm 1 .
3253 .It
3254 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3255 hides
3256 .Pq Cm 0
3257 the spinner, or makes it visible
3258 .Pq Cm 1 .
3259 .It
3260 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3261 sets the spinner's tooltip.
3262 Default is disabling the tooltip.
3263 .It
3264 .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
3265 writes a snapshot of the spinner to an image file of the specified
3266 type.
3267 .It
3268 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3269 sets the spinner's minimum size to
3270 .Ar width
3271 x
3272 .Ar height .
3273 Default is the natural size.
3274 .It
3275 .Qo
3276 .Ar id Ns Cm :style
3277 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3278 .Qc
3279 sets the style.
3280 See
3281 .Sx Style .
3282 .Pp
3283 .Qq Ar id Ns Cm :ping Bq Ar text
3284 triggers a feedback message.
3285 .El
3286 .It Feedback
3287 .Bl -item
3288 .It
3289 .Qq Ar id Ns Cm :ping Ar text
3290 if triggered by the
3291 .Cm :ping
3292 command.
3293 .El
3294 .El
3295 .Ss GtkStatusbar
3296 The context parameter
3297 .Ar c
3298 is an arbitrary non-whitespace string.
3299 .Bl -tag -width indent
3300 .It Commands
3301 .Bl -item
3302 .It
3303 .Qq Ar id Ns Cm :push_id Ar c string ,
3304 .Qq Ar id Ns Cm :push Ar string
3305 associate
3306 .Ar string
3307 with context parameter
3308 .Ar c
3309 or
3310 .Ql 0 ,
3311 respectively, and display it in the statusbar.
3312 .It
3313 .Qq Ar id Ns Cm :pop_id Ar c ,
3314 .Qq Ar id Ns Cm :pop
3315 remove the latest entry associated with context parameter
3316 .Ar c
3317 or
3318 .Ql 0 ,
3319 respectively, from the statusbar.
3320 .It
3321 .Qq Ar id Ns Cm :remove_all_id Ar c ,
3322 .Qq Ar id Ns Cm :remove_all
3323 remove the entries associated with context parameter
3324 .Ar c
3325 or
3326 .Ql 0 ,
3327 respectively, from the statusbar.
3328 .It
3329 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3330 makes the statusbar grayed out
3331 .Pq Cm 0
3332 or clearly visible
3333 .Pq Cm 1 .
3334 .It
3335 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3336 hides
3337 .Pq Cm 0
3338 the statusbar, or makes it visible
3339 .Pq Cm 1 .
3340 .It
3341 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3342 sets the statusbar's tooltip.
3343 Default is disabling the tooltip.
3344 .It
3345 .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
3346 writes a snapshot of the statusbar to an image file of the specified
3347 type.
3348 .It
3349 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3350 sets the statusbar's minimum size to
3351 .Ar width
3352 x
3353 .Ar height .
3354 Default is the natural size.
3355 .It
3356 .Qo
3357 .Ar id Ns Cm :style
3358 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3359 .Qc
3360 sets the statusbar's style.
3361 See
3362 .Sx Style .
3363 .Pp
3364 .Qq Ar id Ns Cm :ping Bq Ar text
3365 triggers a feedback message.
3366 .El
3367 .It Feedback
3368 .Bl -item
3369 .It
3370 .Qq Ar id Ns Cm :ping Ar text
3371 if triggered by the
3372 .Cm :ping
3373 command.
3374 .El
3375 .El
3376 .Ss GtkSwitch
3377 .Bl -tag -width indent
3378 .It Commands
3379 .Bl -item
3380 .It
3381 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
3382 turns the switch off
3383 .Pq Cm 0
3384 or on
3385 .Pq Cm 1 .
3386 .It
3387 .Qq Ar id Ns Cm :grab_focus
3388 puts the keyboard focus onto the switch.
3389 .It
3390 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3391 makes the switch grayed out
3392 .Pq Cm 0
3393 or responsive
3394 .Pq Cm 1 .
3395 .It
3396 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3397 hides
3398 .Pq Cm 0
3399 the switch, or makes it visible
3400 .Pq Cm 1 .
3401 .It
3402 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3403 blocks
3404 .Pq Cm 1
3405 or unblocks
3406 .Pq Cm 0
3407 feedback messages.
3408 Initially, the switch is unblocked.
3409 .It
3410 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3411 sets the tooltip of the switch.
3412 Default is disabling the tooltip.
3413 .It
3414 .Qq Ar id Ns Cm :force
3415 simulates a click on the switch.
3416 .It
3417 .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
3418 writes a snapshot of the switch to an image file of the specified
3419 type.
3420 .It
3421 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3422 sets the switch's minimum size to
3423 .Ar width
3424 x
3425 .Ar height .
3426 Default is the natural size.
3427 .It
3428 .Qo
3429 .Ar id Ns Cm :style
3430 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3431 .Qc
3432 sets the style.
3433 See
3434 .Sx Style .
3435 .Pp
3436 .Qq Ar id Ns Cm :ping Bq Ar text
3437 triggers a feedback message.
3438 .El
3439 .It Feedback
3440 .Bl -item
3441 .It
3442 .Qq Ar id Ns Cm \&:1
3443 if switched on, or
3444 .Qq Ar id Ns Cm \&:0
3445 otherwise.
3446 .Pp
3447 .Qq Ar id Ns Cm :ping Ar text
3448 if triggered by the
3449 .Cm :ping
3450 command.
3451 .El
3452 .El
3453 .Ss GtkTextView
3454 There should be a dedicated
3455 .Sx GtkButton
3456 for sending (parts of) the text.
3457 If the id of the
3458 .Cm GtkTextView
3459 is
3460 .Ar foo ,
3461 a
3462 .Sx GtkButton
3463 with id
3464 .Ar foo Ns Cm _send_text
3465 will send the content of the
3466 .Cm GtkTextView ;
3467 a
3468 .Sx GtkButton
3469 with id
3470 .Ar foo Ns Cm _send_selection
3471 will send the highlighted part the
3472 .Cm GtkTextView .
3473 .Bl -tag -width indent
3474 .It Commands
3475 .Bl -item
3476 .It
3477 .Qq Ar id Ns Cm :set_text Ar string
3478 replaces the user-editable text with (potentially empty)
3479 .Ar string Ns .
3480 .It
3481 .Qq Ar id Ns Cm :delete
3482 deletes the text.
3483 .It
3484 .Qq Ar id Ns Cm :insert_at_cursor Ar string
3485 inserts
3486 .Ar string
3487 at cursor position.
3488 .It
3489 .Qq Ar id Ns Cm :place_cursor Brq Ar position | Cm end
3490 places the text cursor at
3491 .Ar position
3492 or at the end of the text.
3493 .It
3494 .Qq Ar id Ns Cm :place_cursor_at_line Ar line
3495 places the text cursor at the beginning of
3496 .Ar line .
3497 .It
3498 .Qq Ar id Ns Cm :scroll_to_cursor
3499 scrolls to the cursor position if necessary.
3500 .It
3501 .Qq Ar id Ns Cm :save Ar file
3502 stores in
3503 .Ar file
3504 a
3505 .Nm
3506 command containing the text.
3507 .It
3508 .Qq Ar id Ns Cm :grab_focus
3509 puts the keyboard focus into the textview.
3510 .It
3511 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3512 makes the text view grayed out
3513 .Pq Cm 0
3514 or responsive
3515 .Pq Cm 1 .
3516 .It
3517 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3518 hides
3519 .Pq Cm 0
3520 the text view, or makes it visible
3521 .Pq Cm 1 .
3522 .It
3523 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3524 sets the tooltip of the text view.
3525 Default is disabling the tooltip.
3526 .It
3527 .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
3528 writes a snapshot of the text view to an image file of the specified
3529 type.
3530 .It
3531 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3532 sets the minimum size to
3533 .Ar width
3534 x
3535 .Ar height .
3536 Default is the natural size.
3537 .It
3538 .Qo
3539 .Ar id Ns Cm :style
3540 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3541 .Qc
3542 sets the style.
3543 See
3544 .Sx Style .
3545 .Pp
3546 .Qq Ar id Ns Cm :ping Bq Ar text
3547 triggers a feedback message.
3548 .El
3549 .It Feedback
3550 .Bl -item
3551 .It
3552 .Qq Ar button_id Ns Cm \&:text Ar text ,
3553 .Ar button_id
3554 being the id of the
3555 .Sx GtkButton .
3556 Line endings in
3557 .Ar text
3558 are replaced by
3559 .Cm \en ,
3560 and backslashes are replaced by
3561 .Cm \e\e .
3562 .Pp
3563 .Qq Ar id Ns Cm :ping Ar text
3564 if triggered by the
3565 .Cm :ping
3566 command.
3567 .El
3568 .El
3569 .Ss GtkToggleButton
3570 .Bl -tag -width indent
3571 .It Commands
3572 .Bl -item
3573 .It
3574 .Qq Ar id Ns Cm :set_active Brq Cm 0 Ns | Ns Cm 1
3575 switches the button off
3576 .Pq Cm 0
3577 or on
3578 .Pq Cm 1 .
3579 .It
3580 .Qq Ar id Ns Cm :set_label Ar string
3581 replaces the button text with
3582 .Ar string .
3583 .It
3584 .Qq Ar id Ns Cm :grab_focus
3585 puts the keyboard focus onto the button.
3586 .It
3587 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3588 makes the button grayed out
3589 .Pq Cm 0
3590 or responsive
3591 .Pq Cm 1 .
3592 .It
3593 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3594 hides
3595 .Pq Cm 0
3596 the button, or makes it visible
3597 .Pq Cm 1 .
3598 .It
3599 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3600 blocks
3601 .Pq Cm 1
3602 or unblocks
3603 .Pq Cm 0
3604 feedback messages.
3605 Initially, the button is unblocked.
3606 .It
3607 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3608 sets the button's tooltip.
3609 Default is disabling the tooltip.
3610 .It
3611 .Qq Ar id Ns Cm :force
3612 simulates a click on the button.
3613 .It
3614 .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
3615 writes a snapshot of the button to an image file of the specified
3616 type.
3617 .It
3618 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3619 sets the button's minimum size to
3620 .Ar width
3621 x
3622 .Ar height .
3623 Default is the button's natural size.
3624 .It
3625 .Qo
3626 .Ar id Ns Cm :style
3627 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3628 .Qc
3629 sets the button's style.
3630 See
3631 .Sx Style .
3632 .Pp
3633 .Qq Ar id Ns Cm :ping Bq Ar text
3634 triggers a feedback message.
3635 .El
3636 .It Feedback
3637 .Bl -item
3638 .It
3639 .Qq Ar id Ns Cm \&:1
3640 if switched on, or
3641 .Qq Ar id Ns Cm \&:0
3642 otherwise.
3643 .Pp
3644 .Qq Ar id Ns Cm :ping Ar text
3645 if triggered by the
3646 .Cm :ping
3647 command.
3648 .El
3649 .El
3650 .Ss GtkTreeView
3651 .Nm
3652 can deal with columns of type
3653 .Cm gboolean , gint , guint , glong , gulong , gint64 , guint64 , gfloat , gdouble ,
3654 and
3655 .Cm gchararray .
3656 .Pp
3657 .Ar row
3658 and
3659 .Ar column
3660 refer to the underlying model
3661 .Cm ( GtkListStore
3662 or
3663 .Cm GtkTreeStore ) .
3664 .Ar row
3665 is a sequence of one or more colon-separated integers, e.g.
3666 .Ql 3
3667 or
3668 .Ql 0:0:1 .
3669 .Bl -tag -width indent
3670 .It Commands
3671 .Bl -item
3672 .It
3673 .Qq Ar id Ns Cm :set Ar row column data
3674 replaces the content at
3675 .Pq Ar row , column
3676 with
3677 .Ar data
3678 (which should be compatible with the type of
3679 .Ar column ) .
3680 If necessary, new tree nodes are created to obtain the minimal tree
3681 structure needed to support
3682 .Ar row .
3683 .It
3684 .Qq Ar id Ns Cm :insert_row Brq Ar row Bo Cm as_child Bc | Cm end
3685 inserts a new, empty row; either as a sibling of
3686 .Ar row
3687 at position
3688 .Ar row ,
3689 or as a child of
3690 .Ar row ,
3691 or at the end of the list, respectively.
3692 .It
3693 .Qq Ar id Ns Cm :move_row Ar origin Brq Ar destination | Cm end
3694 moves the row at
3695 .Ar origin
3696 within its current level to
3697 .Ar destination
3698 or to the end.
3699 .It
3700 .Qq Ar id Ns Cm :remove_row Ar row
3701 removes the row at position
3702 .Ar row .
3703 .It
3704 .Qq Ar id Ns Cm :clear
3705 removes all rows.
3706 .It
3707 .Qq Ar id Ns Cm :expand Ar row
3708 expands one level of the subtree below
3709 .Ar row .
3710 .It
3711 .Qq Ar id Ns Cm :expand_all Bq Ar row
3712 expands the subtree below
3713 .Ar row ,
3714 or the whole tree.
3715 .It
3716 .Qq Ar id Ns Cm :collapse Bq Ar row
3717 collapses the subtree below
3718 .Ar row ,
3719 or the whole tree.
3720 .It
3721 .Qq Ar id Ns Cm :set_cursor Bq Ar row
3722 sets the cursor to
3723 .Ar row ,
3724 or unsets it.
3725 .It
3726 .Qq Ar id Ns Cm :scroll Ar row column
3727 scrolls the cell at
3728 .Pq Ar row , column
3729 into view.
3730 .It
3731 .Qq Ar id Ns Cm :save Ar file
3732 stores the content of the underlying model as a sequence of
3733 .Nm
3734 commands into
3735 .Ar file .
3736 .It
3737 .Qq Ar id Ns Cm :grab_focus
3738 puts the keyboard focus onto the tree view.
3739 .It
3740 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3741 makes the tree view grayed out
3742 .Pq Cm 0
3743 or responsive
3744 .Pq Cm 1 .
3745 .It
3746 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3747 hides
3748 .Pq Cm 0
3749 the tree view, or makes it visible
3750 .Pq Cm 1 .
3751 .It
3752 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3753 blocks
3754 .Pq Cm 1
3755 or unblocks
3756 .Pq Cm 0
3757 feedback messages.
3758 Initially, the widget is unblocked.
3759 .It
3760 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3761 sets the tooltip of the tree view.
3762 Default is disabling the tooltip.
3763 .It
3764 .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
3765 writes a snapshot of the tree view to an image file of the specified
3766 type.
3767 .It
3768 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3769 sets the minimum size of the tree view to
3770 .Ar width
3771 x
3772 .Ar height .
3773 Default is the widget's natural size.
3774 .It
3775 .Qo
3776 .Ar id Ns Cm :style
3777 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3778 .Qc
3779 sets the style.
3780 See
3781 .Sx Style .
3782 .Pp
3783 .Qq Ar id Ns Cm :ping Bq Ar text
3784 triggers a feedback message.
3785 .El
3786 .It Feedback
3787 .Bl -item
3788 .It
3789 .Qq Ar id Ns Cm \&:clicked
3790 .It
3791 .Qq Ar id Ns Cm \&: Ns Ar column_type row column value ,
3792 one message per cell in the underlying model for each selected row; or
3793 .It
3794 .Qq Ar id Ns Cm \&: Ns Ar column_type row column new_value ,
3795 if the cell at
3796 .Pq Ar row , column
3797 has been edited.
3798 .Pp
3799 .Qq Ar id Ns Cm :ping Ar text
3800 if triggered by the
3801 .Cm :ping
3802 command.
3803 .El
3804 .El
3805 .Ss GtkTreeViewColumn
3806 .Bl -tag -width indent
3807 .It Commands
3808 .Bl -item
3809 .It
3810 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3811 blocks
3812 .Pq Cm 1
3813 or unblocks
3814 .Pq Cm 0
3815 feedback messages.
3816 Initially, the widget is unblocked.
3817 .Pp
3818 .Qq Ar id Ns Cm :ping Bq Ar text
3819 triggers a feedback message.
3820 .El
3821 .It Feedback
3822 .Bl -item
3823 .It
3824 .Qq Ar id Ns Cm \&:clicked
3825 .Pp
3826 .Qq Ar id Ns Cm :ping Ar text
3827 if triggered by the
3828 .Cm :ping
3829 command.
3830 .El
3831 .El
3832 .Ss GtkViewport
3833 .Bl -tag -width indent
3834 .It Commands
3835 .Bl -item
3836 .It
3837 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3838 makes the viewport insensitive
3839 .Pq Cm 0
3840 or responsive
3841 .Pq Cm 1 .
3842 .It
3843 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3844 hides
3845 .Pq Cm 0
3846 the viewport, or makes it visible
3847 .Pq Cm 1 .
3848 .It
3849 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3850 sets the tooltip of the viewport.
3851 Default is disabling the tooltip.
3852 .It
3853 .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
3854 writes a snapshot of the viewport to an image file of the specified
3855 type.
3856 .It
3857 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3858 sets the minimum size to
3859 .Ar width
3860 x
3861 .Ar height .
3862 Default is the natural size of the viewport.
3863 .It
3864 .Qo
3865 .Ar id Ns Cm :style
3866 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3867 .Qc
3868 sets the widget style.
3869 See
3870 .Sx Style .
3871 .Pp
3872 .Qq Ar id Ns Cm :ping Bq Ar text
3873 triggers a feedback message.
3874 .El
3875 .It Feedback
3876 .Bl -item
3877 .It
3878 .Qq Ar id Ns Cm :ping Ar text
3879 if triggered by the
3880 .Cm :ping
3881 command.
3882 .El
3883 .El
3884 .Ss GtkWindow
3885 .Bl -tag -width indent
3886 .It Commands
3887 .Bl -item
3888 .It
3889 .Qq Ar id Ns Cm :set_title Ar string
3890 replaces the text in the title bar with
3891 .Ar string .
3892 .It
3893 .Qq Ar id Ns Cm :resize Bq Ar width height
3894 changes the window size to
3895 .Ar width
3896 x
3897 .Ar height
3898 pixels if specified, or to the default size.
3899 .It
3900 .Qq Ar id Ns Cm :move Ar x y
3901 moves the window to position
3902 .Pq Ar x , y .
3903 .It
3904 .Qq Ar id Ns Cm :fullscreen
3905 and
3906 .Qq Ar id Ns Cm :unfullscreen
3907 switch fullscreen mode on and off.
3908 .It
3909 .Qq Ar id Ns Cm :set_sensitive Brq Cm 0 Ns | Ns Cm 1
3910 makes the widget grayed out
3911 .Pq Cm 0
3912 or responsive
3913 .Pq Cm 1 .
3914 .It
3915 .Qq Ar id Ns Cm :set_visible Brq Cm 0 Ns | Ns Cm 1
3916 hides
3917 .Pq Cm 0
3918 the widget, or makes it visible
3919 .Pq Cm 1 .
3920 .It
3921 .Qq Ar id Ns Cm :block Brq Cm 0 Ns | Ns Cm 1
3922 blocks
3923 .Pq Cm 1
3924 or unblocks
3925 .Pq Cm 0
3926 feedback messages.
3927 Initially, the widget is unblocked.
3928 .It
3929 .Qq Ar id Ns Cm :set_tooltip_text Bq Ar text
3930 sets the window's tooltip.
3931 Default is disabling the tooltip.
3932 .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
3933 writes a snapshot of the window to an image file of the specified
3934 type.
3935 .It
3936 .Qq Ar id Ns Cm :set_size_request Bq Ar width height
3937 sets the window's minimum size to
3938 .Ar width
3939 x
3940 .Ar height .
3941 Default is the widget's natural size.
3942 .It
3943 .Qo
3944 .Ar id Ns Cm :style
3945 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3946 .Qc
3947 sets the style.
3948 See
3949 .Sx Style .
3950 .Pp
3951 .Qq Ar id Ns Cm :ping Bq Ar text
3952 triggers a feedback message.
3953 .El
3954 .It Feedback
3955 .Bl -item
3956 .It
3957 .Qq Ar id Ns Cm \&:closed
3958 if the
3959 .Cm GtkWindow
3960 was closed by the window manager.
3961 .Pp
3962 .Qq Ar id Ns Cm :ping Ar text
3963 if triggered by the
3964 .Cm :ping
3965 command.
3966 .El
3967 .El
3968 .Sh SPECIAL SYNTAX
3969 .Ss Style
3970 .Qo
3971 .Ar id Ns Cm :style
3972 .Bo Ar prop Ns Cm \&: Ns Ar val Ns Bo Cm \&; Ar prop Ns Cm \&: Ns Ar val ... Bc Bc
3973 .Qc
3974 sets properties
3975 .Ar prop
3976 of the widget style to
3977 .Ar val .
3978 Properties not explicitly specified are reset to their default values.
3979 Examples:
3980 .Bl -dash -offset indent -compact
3981 .It
3982 .Ql label1:style font:Bold 11; background-color:green
3983 .It
3984 .Ql label1:style font-style:italic; font-weight:bold; color:blue
3985 .It
3986 .Ql button1:style background-image:url("q.png")
3987 .It
3988 .Ql treeview1:style background-image:linear-gradient(45deg, yellow, blue);
3989 .It
3990 .Ql frame1:style border-color:red yellow; border-width:5px
3991 .It
3992 .Ql frame1:style border-radius:10px; transition:10s
3993 .El
3994 For color notations see
3995 .Sx Color ,
3996 below.
3997 .Ss Color
3998 Possible
3999 .Ar color
4000 notations:
4001 .Bl -dash -offset indent -compact
4002 .It
4003 standard X11 colors names like
4004 .Ql blue ,
4005 .Ql Dark Sea Green ,
4006 or
4007 .Ql Red ;
4008 .It
4009 .Ql transparent ;
4010 .It
4011 hexadecimal values in the form
4012 .Cm # Ns Ar rgb , Cm # Ns Ar rrggbb , Cm # Ns Ar rrrgggbbb ,
4013 or
4014 .Cm # Ns Ar rrrrggggbbbb ;
4015 .It
4016 RGB colors in the form
4017 .Cm rgb( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns Ar blue Ns Cm \&)
4018 or
4019 RGBA colors in the form
4020 .Cm rgba( Ns Ar red Ns Cm \&, Ns Ar green Ns Cm \&, Ns
4021 .Ar blue Ns Cm \&, Ns Ar alpha Ns Cm \&) ;
4022 .Ar red , green , blue
4023 between 0 and 255 and
4024 .Ar alpha
4025 between 0 and 1;
4026 .It
4027 color expressions like
4028 .Ql darker(blue)
4029 or
4030 .Ql lighter(currentColor) .
4031 .El
4032 .Sh EXIT STATUS
4033 .Ex -std
4034 .Sh EXAMPLES
4035 .Ss Discovering Pipeglade Interactively
4036 Suppose the interface in
4037 .Pa ./pipeglade.ui
4038 has a
4039 .Sx GtkLabel Ql label1
4040 and a
4041 .Sx GtkButton Ql button1 .
4042 After invoking
4043 .Pp
4044 .Dl pipeglade
4045 .Pp
4046 and clicking the
4047 .Sx GtkButton , Ql button1:clicked
4048 will be reported on the terminal.
4049 Typing
4050 .Pp
4051 .Dl label1:set_text The Button
4052 .Pp
4053 will change the text shown on the label into
4054 .Ql The Button .
4055 .Ss One-Shot File Dialog
4056 Suppose the interface in
4057 .Pa ./simple_open.ui
4058 contains a
4059 .Sx GtkFileChooserDialog
4060 with an
4061 .Sq OK
4062 .Sx GtkButton
4063 whose id is
4064 .Ql main_ok .
4065 Invoking
4066 .Pp
4067 .Dl pipeglade -u simple_open.ui
4068 .Pp
4069 will open the dialog; pressing
4070 .Sq OK
4071 will close it after sending the selected filename to
4072 .Va stdout .
4073 .Ss One-Shot User Notification
4074 If the interface in
4075 .Pa ./simple_dialog.ui
4076 contains a
4077 .Sx GtkLabel Ql label1 ,
4078 then
4079 .Bd -literal -offset indent
4080 pipeglade -u simple_dialog.ui <<< \e
4081     "label1:set_text NOW READ THIS!"
4082 .Ed
4083 will set the label text accordingly and wait for user input.
4084 .Ss Continuous Input
4085 The following shell command displays a running clock:
4086 .Bd -literal -offset indent
4087 while true; do
4088     echo "label1:set_text `date`";
4089     sleep 1;
4090 done | pipeglade -u simple_dialog.ui
4091 .Ed
4092 .Ss Continuous Input and Output
4093 The following shell script fragment sets up
4094 .Nm
4095 for continuous communication with another program,
4096 .Pa main_prog :
4097 .Bd -literal -offset indent
4098 pipeglade -i in.fifo -o out.fifo -b
4099 main_prog <out.fifo >in.fifo
4100 .Ed
4101 .Sh SEE ALSO
4102 .Xr dialog 1 ,
4103 .Xr glade 1 ,
4104 .Xr gxmessage 1 ,
4105 .Xr kdialog 1 ,
4106 .Xr whiptail 1 ,
4107 .Xr xmessage 1 ,
4108 .Xr zenity 1
4109 .Sh AUTHOR
4110 .Nm
4111 was written by
4112 .An Bert Burgemeister
4113 .Aq Mt trebbu@googlemail.com .
4114 .Sh BUGS
4115 Due to what appears to be a bug in cairo v1.14.0,
4116 .Nm
4117 used with this library version occasionally crashes on
4118 .Cm GtkDrawingArea
4119 commands.