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