doc/gtk.widgets.texi

   1 @menu
   2 * about-dialog::
   3 * accel-label::
   4 * alignment::
   5 * arrow::
   6 * aspect-frame::
   7 * assistant::
   8 * bin::
   9 * box::
  10 * button::
  11 * button-box::
  12 * calendar::
  13 * cell-view::
  14 * check-button::
  15 * check-menu-item::
  16 * color-button::
  17 * color-selection::
  18 * color-selection-dialog::
  19 * combo-box::
  20 * combo-box-entry::
  21 * container::
  22 * curve::
  23 * dialog::
  24 * drawing-area::
  25 * entry::
  26 * event-box::
  27 * expander::
  28 * file-chooser-button::
  29 * file-chooser-dialog::
  30 * file-chooser-widget::
  31 * fixed::
  32 * font-button::
  33 * font-selection::
  34 * font-selection-dialog::
  35 * frame::
  36 * gamma-curve::
  37 * gtk-window::
  38 * h-box::
  39 * h-button-box::
  40 * h-paned::
  41 * h-ruler::
  42 * h-s-v::
  43 * h-scale::
  44 * h-scrollbar::
  45 * h-separator::
  46 * handle-box::
  47 * icon-view::
  48 * image::
  49 * image-menu-item::
  50 * input-dialog::
  51 * invisible::
  52 * item::
  53 * label::
  54 * layout::
  55 * link-button::
  56 * menu::
  57 * menu-bar::
  58 * menu-item::
  59 * menu-shell::
  60 * menu-tool-button::
  61 * message-dialog::
  62 * misc::
  63 * notebook::
  64 * page-setup-unix-dialog::
  65 * paned::
  66 * plug::
  67 * print-unix-dialog::
  68 * progress::
  69 * progress-bar::
  70 * radio-button::
  71 * radio-menu-item::
  72 * radio-tool-button::
  73 * range::
  74 * recent-chooser-dialog::
  75 * recent-chooser-menu::
  76 * recent-chooser-widget::
  77 * ruler::
  78 * scale::
  79 * scale-button::
  80 * scrollbar::
  81 * scrolled-window::
  82 * separator::
  83 * separator-menu-item::
  84 * separator-tool-item::
  85 * socket::
  86 * spin-button::
  87 * statusbar::
  88 * table::
  89 * tearoff-menu-item::
  90 * text-view::
  91 * toggle-button::
  92 * toggle-tool-button::
  93 * tool-button::
  94 * tool-item::
  95 * toolbar::
  96 * tree-view::
  97 * v-box::
  98 * v-button-box::
  99 * v-paned::
 100 * v-ruler::
 101 * v-scale::
 102 * v-scrollbar::
 103 * v-separator::
 104 * viewport::
 105 * volume-button::
 106 * widget::
 107 @end menu
 108
 109 @node about-dialog
 110 @section about-dialog
 111 @Class about-dialog
 112 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
 113
 114 The @ref{about-dialog} offers a simple way to display information about a program like its logo, name, copyright, website and license. It is also possible to give credits to the authors, documenters, translators and artists who have worked on the program. An about dialog is typically opened when the user selects the About option from the Help menu. All parts of the dialog are optional.
 115
 116 About dialog often contain links and email addresses. @ref{about-dialog} supports this by offering global hooks (TODO: not implemented in cl-gtk2), which are called when the user clicks on a link or email address, see gtk_about_dialog_set_email_hook() and gtk_about_dialog_set_url_hook(). Email addresses in the authors, documenters and artists properties are recognized by looking for @code{<user@@host>}, URLs are recognized by looking for @code{http://url}, with url extending to the next space, tab or line break.
 117
 118 When setting the website and email hooks for the @ref{about-dialog} widget, you should remember that the order is important: you should set the hook functions before setting the website and email URL properties. Otherwise the @ref{about-dialog} widget will not display the website and the email addresses as clickable.
 119
 120 Note that GTK+ sets a default title of @code{_("About %s")} on the dialog window (where @code{%s} is replaced by the name of the application, but in order to ensure proper translation of the title, applications should set the title property explicitly when constructing a @ref{about-dialog}, as shown in the following example:
 121
 122 @lisp
 123 (make-instance 'gtk:about-dialog :program-name "ExampleCode" :title "About ExampleCode")
 124 @end lisp
 125
 126
 127 Slots:
 128 @itemize
 129 @item @anchor{slot.about-dialog.artists}artists. Type: list of @code{string}. Accessor: @anchor{fn.about-dialog-artists}@code{about-dialog-artists}.
 130
 131 The people who contributed artwork to the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the description for more details.
 132 @item @anchor{slot.about-dialog.authors}authors. Type: list of @code{string}. Accessor: @anchor{fn.about-dialog-authors}@code{about-dialog-authors}.
 133
 134 The authors of the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.
 135 @item @anchor{slot.about-dialog.comments}comments. Type: @code{string}. Accessor: @anchor{fn.about-dialog-comments}@code{about-dialog-comments}.
 136
 137 Comments about the program. This string is displayed in a label in the main dialog, thus it should be a short explanation of the main purpose of the program, not a detailed list of features.
 138
 139 Default value: NIL
 140 @item @anchor{slot.about-dialog.copyright}copyright. Type: @code{string}. Accessor: @anchor{fn.about-dialog-copyright}@code{about-dialog-copyright}.
 141
 142 Copyright information for the program.
 143
 144 Default value: NIL
 145 @item @anchor{slot.about-dialog.documenters}documenters. Type: list of @code{string}. Accessor: @anchor{fn.about-dialog-documenters}@code{about-dialog-documenters}.
 146
 147 The people documenting the program, as a list of strings. Each string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.
 148 @item @anchor{slot.about-dialog.license}license. Type: @code{string}. Accessor: @anchor{fn.about-dialog-license}@code{about-dialog-license}.
 149
 150 The license of the program. This string is displayed in a text view in a secondary dialog, therefore it is fine to use a long multi-paragraph text. Note that the text is only wrapped in the text view if the @SlotRef{about-dialog,wrap-license} property is set to True; otherwise the text itself must contain the intended linebreaks.
 151
 152 Default value: NIL
 153 @item @anchor{slot.about-dialog.logo}logo. Type: @ref{pixbuf}. Accessor: @anchor{fn.about-dialog-logo}@code{about-dialog-logo}.
 154
 155 A logo for the about box. If this is not set, it defaults to gtk_window_get_default_icon_list().
 156 @item @anchor{slot.about-dialog.logo-icon-name}logo-icon-name. Type: @code{string}. Accessor: @anchor{fn.about-dialog-logo-icon-name}@code{about-dialog-logo-icon-name}.
 157
 158 A named icon to use as the logo for the about box. This property overrides the @SlotRef{about-dialog,logo} property.
 159
 160 Default value: NIL
 161 @item @anchor{slot.about-dialog.program-name}program-name. Type: @code{string}. Accessor: @anchor{fn.about-dialog-program-name}@code{about-dialog-program-name}.
 162
 163 The name of the program. If this is not set, it defaults to g_get_application_name().
 164
 165 Default value: NIL
 166 @item @anchor{slot.about-dialog.translator-credits}translator-credits. Type: @code{string}. Accessor: @anchor{fn.about-dialog-translator-credits}@code{about-dialog-translator-credits}.
 167
 168 Credits to the translators. This string should be marked as translatable. The string may contain email addresses and URLs, which will be displayed as links, see the introduction for more details.
 169
 170 Default value: NIL
 171 @item @anchor{slot.about-dialog.version}version. Type: @code{string}. Accessor: @anchor{fn.about-dialog-version}@code{about-dialog-version}.
 172
 173 The version of the program.
 174
 175 Default value: NIL
 176 @item @anchor{slot.about-dialog.website}website. Type: @code{string}. Accessor: @anchor{fn.about-dialog-website}@code{about-dialog-website}.
 177
 178 The URL for the link to the website of the program. This should be a string starting with "http://.
 179
 180 Default value: NIL
 181 @item @anchor{slot.about-dialog.website-label}website-label. Type: @code{string}. Accessor: @anchor{fn.about-dialog-website-label}@code{about-dialog-website-label}.
 182
 183 The label for the link to the website of the program. If this is not set, it defaults to the URL specified in the website property.
 184
 185 Default value: NIL
 186 @item @anchor{slot.about-dialog.wrap-license}wrap-license. Type: @code{boolean}. Accessor: @anchor{fn.about-dialog-wrap-license}@code{about-dialog-wrap-license}.
 187
 188 Whether to wrap the text in the license dialog.
 189
 190 Default value: False
 191 @end itemize
 192
 193 Signals:
 194 @itemize
 195 @end itemize
 196
 197
 198
 199
 200 @node accel-label
 201 @section accel-label
 202 @Class accel-label
 203 Superclass: @ref{label} @ref{atk-implementor-iface} @ref{buildable}
 204
 205 The @ref{accel-label} widget is a subclass of @ref{label} that also displays an accelerator key on the right of the label text, e.g. 'Ctl+S'. It is commonly used in menus to show the keyboard short-cuts for commands.
 206
 207 The accelerator key to display is not set explicitly. Instead, the @ref{accel-label} displays the accelerators which have been added to a particular widget. This widget is set by @SlotRef{accel-label,accel-widget}.
 208
 209 For example, a @ref{menu-item} widget may have an accelerator added to emit the @SignalRef{menu-item,activate} signal when the 'Ctl+S' key combination is pressed. A @ref{accel-label} is created and added to the @ref{accel-label}, and @SlotRef{accel-label,accel-widget} is set to the @ref{menu-item} as the second argument. The @ref{accel-label} will now display 'Ctl+S' after its label.
 210
 211 @c Note that creating a @ref{menu-item} with gtk_menu_item_new_with_label() (or one of the similar functions for GtkCheckMenuItem and GtkRadioMenuItem) automatically adds a GtkAccelLabel to the GtkMenuItem and calls gtk_accel_label_set_accel_widget() to set it up for you.
 212
 213 A @ref{accel-label} will only display accelerators which have @FlagsVRef{accel-flags,visible} set. A@ref{accel-label} can display multiple accelerators and even signal names, though it is almost always used to display just one accelerator key.
 214
 215 Slots:
 216 @itemize
 217 @item @anchor{slot.accel-label.accel-closure}accel-closure. Type: @code{GClosure}. Accessor: @anchor{fn.accel-label-accel-closure}@code{accel-label-accel-closure}.
 218
 219 The closure to be monitored for accelerator changes.
 220
 221 TODO: GClosure type mapping is not supported
 222 @item @anchor{slot.accel-label.accel-widget}accel-widget. Type: @ref{widget}. Accessor: @anchor{fn.accel-label-accel-widget}@code{accel-label-accel-widget}.
 223
 224 The widget to be monitored for accelerator changes.
 225 @end itemize
 226
 227
 228 Signals:
 229 @itemize
 230 @end itemize
 231
 232
 233
 234
 235 @node alignment
 236 @section alignment
 237 @Class alignment
 238 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
 239
 240 Slots:
 241 @itemize
 242 @item @anchor{slot.alignment.bottom-padding}bottom-padding. Type: @code{integer}. Accessor: @anchor{fn.alignment-bottom-padding}@code{alignment-bottom-padding}.
 243 @item @anchor{slot.alignment.left-padding}left-padding. Type: @code{integer}. Accessor: @anchor{fn.alignment-left-padding}@code{alignment-left-padding}.
 244 @item @anchor{slot.alignment.right-padding}right-padding. Type: @code{integer}. Accessor: @anchor{fn.alignment-right-padding}@code{alignment-right-padding}.
 245 @item @anchor{slot.alignment.top-padding}top-padding. Type: @code{integer}. Accessor: @anchor{fn.alignment-top-padding}@code{alignment-top-padding}.
 246 @item @anchor{slot.alignment.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.alignment-xalign}@code{alignment-xalign}.
 247 @item @anchor{slot.alignment.xscale}xscale. Type: @code{single-float}. Accessor: @anchor{fn.alignment-xscale}@code{alignment-xscale}.
 248 @item @anchor{slot.alignment.yalign}yalign. Type: @code{single-float}. Accessor: @anchor{fn.alignment-yalign}@code{alignment-yalign}.
 249 @item @anchor{slot.alignment.yscale}yscale. Type: @code{single-float}. Accessor: @anchor{fn.alignment-yscale}@code{alignment-yscale}.
 250 @end itemize
 251
 252
 253 Signals:
 254 @itemize
 255 @end itemize
 256
 257
 258
 259
 260 @node arrow
 261 @section arrow
 262 @Class arrow
 263 Superclass: @ref{misc} @ref{atk-implementor-iface} @ref{buildable}
 264
 265 Slots:
 266 @itemize
 267 @item @anchor{slot.arrow.arrow-type}arrow-type. Type: @ref{arrow-type}. Accessor: @anchor{fn.arrow-arrow-type}@code{arrow-arrow-type}.
 268 @item @anchor{slot.arrow.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.arrow-shadow-type}@code{arrow-shadow-type}.
 269 @end itemize
 270
 271
 272 Signals:
 273 @itemize
 274 @end itemize
 275
 276
 277
 278
 279 @node aspect-frame
 280 @section aspect-frame
 281 @Class aspect-frame
 282 Superclass: @ref{frame} @ref{atk-implementor-iface} @ref{buildable}
 283
 284 Slots:
 285 @itemize
 286 @item @anchor{slot.aspect-frame.obey-child}obey-child. Type: @code{boolean}. Accessor: @anchor{fn.aspect-frame-obey-child}@code{aspect-frame-obey-child}.
 287 @item @anchor{slot.aspect-frame.ratio}ratio. Type: @code{single-float}. Accessor: @anchor{fn.aspect-frame-ratio}@code{aspect-frame-ratio}.
 288 @item @anchor{slot.aspect-frame.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.aspect-frame-xalign}@code{aspect-frame-xalign}.
 289 @item @anchor{slot.aspect-frame.yalign}yalign. Type: @code{single-float}. Accessor: @anchor{fn.aspect-frame-yalign}@code{aspect-frame-yalign}.
 290 @end itemize
 291
 292
 293 Signals:
 294 @itemize
 295 @end itemize
 296
 297
 298
 299
 300 @node assistant
 301 @section assistant
 302 @Class assistant
 303 Superclass: @ref{gtk-window} @ref{atk-implementor-iface} @ref{buildable}
 304
 305 A @ref{assistant} is a widget used to represent a generally complex operation splitted in several steps, guiding the user through its pages and controlling the page flow to collect the necessary data.
 306
 307 Slots:
 308 @itemize
 309 @item @anchor{slot.assistant.current-page}current-page. Type: @code{integer}. Accessor: @anchor{fn.assistant-current-page}@code{assistant-current-page}.
 310
 311 The index (starting from 0) of the current page in the assistant, or -1 if the assistant has no pages.
 312 @item @anchor{slot.assistant.forward-page-function}forward-page-function. function. Accessor: @anchor{fn.assistant-forward-page-function}@code{assistant-forward-page-function}. Write-only.
 313
 314 Page forwarding function is used to determine what will be the next page when the user presses the forward button. Setting this to NIL will make the assistant to use the default forward function, which just goes to the next visible page.
 315 The function called both for computing the next page when the user presses the "forward" button and for handling the behavior of the "last" button. The function accepts a single integer - the current page number and returns the page number for the next page.
 316 @item @anchor{slot.assistant.n-pages}n-pages. Type: @code{integer}. Accessor: @anchor{fn.assistant-n-pages}@code{assistant-n-pages}. Read-only.
 317
 318 The number of pages in the assistant
 319 @end itemize
 320
 321
 322 Signals:
 323 @itemize
 324 @item @anchor{signal.assistant.apply}"apply". Signature: (instance @ref{assistant}) @result{} void. Options: run-last.
 325
 326 This signal is emitted when the apply button is clicked. The default behavior of the @ref{assistant} is to switch to the page after the current page, unless the current page is the last one.
 327
 328 A handler for the @SignalRef{assistant,apply} signal should carry out the actions for which the wizard has collected data. If the action takes a long time to complete, you might consider to put a page of type @EnumVRef{assistant-page-type,progress} after the confirmation page and handle this operation within the @SignalRef{assistant,prepare} signal of the progress page.
 329 @item @anchor{signal.assistant.cancel}"cancel". Signature: (instance @ref{assistant}) @result{} void. Options: run-last.
 330
 331 This signal is emitted when then the cancel button is clicked.
 332 @item @anchor{signal.assistant.close}"close". Signature: (instance @ref{assistant}) @result{} void. Options: run-last.
 333
 334 This signal is emitted either when the close button of a summary page is clicked, or when the apply button in the last page in the flow (of type @EnumVRef{assistant-page-type,confirm}) is clicked.
 335 @item @anchor{signal.assistant.prepare}"prepare". Signature: (instance @ref{assistant}), (page @ref{widget}) @result{} void. Options: run-last.
 336
 337 This signal is emitted when a new page is set as the assistant's current page, before making the new page visible. A handler for this signal can do any preparation which are necessary before showing page.
 338 @end itemize
 339
 340 @RMethod assistant-nth-page
 341 @lisp
 342 (assistant-nth-page assistant page-number) @result{} page-widget
 343 @end lisp
 344
 345 Returns the child widget (a @ref{widget}) contained in page number @var{page-number} (an integer).
 346
 347 @RMethod assistant-append-page
 348 @lisp
 349 (assistant-append-page assistant page)
 350 @end lisp
 351
 352 Appends a @var{page} (a @ref{widget}) to the @var{assistant} (a @ref{assistant}).
 353
 354 @RMethod assistant-prepend-page
 355 @lisp
 356 (assistant-prepend-page assistant page)
 357 @end lisp
 358
 359 Prepends a @var{page} (a @ref{widget}) to the @var{assistant} (a @ref{assistant}).
 360
 361 @RMethod assistant-insert-page
 362 @lisp
 363 (assistant-insert-page assistant page position) @result{} page-number
 364 @end lisp
 365
 366 Inserts a @var{page} (a @ref{widget}) in the @var{assistant} (a @ref{assistant}) at a given @var{position}. @var{position} is the index (starting at 0) at which to insert the page, or -1 to append the page. Returns the index of inserted @var{page}.
 367
 368 @RMethod assistant-add-action-widget
 369 @lisp
 370 (assistant-add-action-widget assistant widget)
 371 @end lisp
 372
 373 Adds the @var{widget} (a @ref{widget}) to the action area of a @var{assistant} (a @ref{assistant}).
 374
 375 @RMethod assistant-remove-action-widget
 376 @lisp
 377 (assistant-remove-action-widget assistant widget)
 378 @end lisp
 379
 380 Removes the @var{widget} (a @ref{widget}) from the action area of a @var{assistant} (a @ref{assistant}).
 381
 382 @RMethod assistant-update-buttons-state
 383 @lisp
 384 (assistant-update-buttons-state assistant)
 385 @end lisp
 386
 387 Forces @var{assistant} (a @ref{assistant}) to recompute the buttons state.
 388
 389 GTK+ automatically takes care of this in most situations, e.g. when the user goes to a different page, or when the visibility or completeness of a page changes.
 390
 391 One situation where it can be necessary to call this function is when changing a value on the current page affects the future page flow of the assistant.
 392
 393 @node bin
 394 @section bin
 395 @Class bin
 396 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
 397
 398 Subclasses: @ref{viewport} @ref{scrolled-window} @ref{tool-item} @ref{handle-box} @ref{expander} @ref{event-box} @ref{combo-box} @ref{frame} @ref{alignment} @ref{button} @ref{item} @ref{gtk-window}
 399
 400 Slots:
 401 @itemize
 402 @end itemize
 403
 404
 405 Signals:
 406 @itemize
 407 @end itemize
 408
 409
 410
 411
 412 @node box
 413 @section box
 414 @Class box
 415 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
 416
 417 Subclasses: @ref{h-box} @ref{v-box} @ref{button-box}
 418
 419 Slots:
 420 @itemize
 421 @item @anchor{slot.box.homogeneous}homogeneous. Type: @code{boolean}. Accessor: @anchor{fn.box-homogeneous}@code{box-homogeneous}.
 422 @item @anchor{slot.box.spacing}spacing. Type: @code{integer}. Accessor: @anchor{fn.box-spacing}@code{box-spacing}.
 423 @end itemize
 424
 425
 426 Signals:
 427 @itemize
 428 @end itemize
 429
 430
 431
 432
 433 @node button
 434 @section button
 435 @Class button
 436 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
 437
 438 Subclasses: @ref{scale-button} @ref{link-button} @ref{font-button} @ref{color-button} @ref{toggle-button}
 439
 440 The @ref{button} widget is generally used to attach a function to that is called when the button is pressed. The various signals and how to use them are outlined below.
 441
 442 The @ref{button} widget can hold any valid child widget. That is it can hold most any other standard @ref{widget}. The most commonly used child is the @ref{label}.
 443
 444 Slots:
 445 @itemize
 446 @item @anchor{slot.button.focus-on-click}focus-on-click. Type: @code{boolean}. Accessor: @anchor{fn.button-focus-on-click}@code{button-focus-on-click}.
 447
 448 Whether the button grabs focus when it is clicked with the mouse.
 449
 450 Default value: True
 451 @item @anchor{slot.button.image}image. Type: @ref{widget}. Accessor: @anchor{fn.button-image}@code{button-image}.
 452
 453 Child widget to appear next to the button text.
 454 @item @anchor{slot.button.image-position}image-position. Type: @ref{position-type}. Accessor: @anchor{fn.button-image-position}@code{button-image-position}.
 455
 456 The position of the image relative to the text inside the button.
 457
 458 Default value: @EnumVRef{position-type,left}
 459 @item @anchor{slot.button.label}label. Type: @code{string}. Accessor: @anchor{fn.button-label}@code{button-label}.
 460
 461 Text of the label widget inside the button, if the button contains a label widget.
 462
 463 Default value: NIL
 464 @item @anchor{slot.button.relief}relief. Type: @ref{relief-style}. Accessor: @anchor{fn.button-relief}@code{button-relief}.
 465
 466 The border relief style.
 467
 468 Default value: @EnumVRef{relief-style,normal}
 469 @item @anchor{slot.button.use-stock}use-stock. Type: @code{boolean}. Accessor: @anchor{fn.button-use-stock}@code{button-use-stock}.
 470
 471 If set, the label is used to pick a stock item instead of being displayed.
 472
 473 Default value: False
 474 @item @anchor{slot.button.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.button-use-underline}@code{button-use-underline}.
 475
 476 If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
 477
 478 Default value: False
 479 @item @anchor{slot.button.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.button-xalign}@code{button-xalign}.
 480
 481 If the child of the button is a @ref{misc} or @ref{alignment}, this property can be used to control it's horizontal alignment. 0.0 is left aligned, 1.0 is right aligned.
 482
 483 Allowed values: [0,1]
 484
 485 Default value: 0.5
 486 @item @anchor{slot.button.yalign}yalign. Type: @code{single-float}. Accessor: @anchor{fn.button-yalign}@code{button-yalign}.
 487
 488 If the child of the button is a @ref{misc} or @ref{alignment}, this property can be used to control it's vertical alignment. 0.0 is left aligned, 1.0 is right aligned.
 489
 490 Allowed values: [0,1]
 491
 492 Default value: 0.5
 493 @end itemize
 494
 495
 496 Signals:
 497 @itemize
 498 @item @anchor{signal.button.activate}"activate". Signature: (instance @ref{button}) @result{} void. Options: run-first, action.
 499
 500 This signal is an action signal and emitting it causes the button to animate press then release. Applications should never connect to this signal, but use the @SignalRef{button,clicked} signal.
 501 @item @anchor{signal.button.clicked}"clicked". Signature: (instance @ref{button}) @result{} void. Options: run-first, action.
 502
 503 Emitted when the button has been activated (pressed and released).
 504 @item @anchor{signal.button.enter}"enter". Signature: (instance @ref{button}) @result{} void. Options: run-first.
 505
 506 Emitted when the pointer enters the button.
 507 @item @anchor{signal.button.leave}"leave". Signature: (instance @ref{button}) @result{} void. Options: run-first.
 508
 509 Emitted when the pointer leaves the button.
 510 @item @anchor{signal.button.pressed}"pressed". Signature: (instance @ref{button}) @result{} void. Options: run-first.
 511
 512 Emitted when the button is pressed.
 513 @item @anchor{signal.button.released}"released". Signature: (instance @ref{button}) @result{} void. Options: run-first.
 514
 515 Emitted when the button is released.
 516 @end itemize
 517
 518
 519
 520
 521 @node button-box
 522 @section button-box
 523 @Class button-box
 524 Superclass: @ref{box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
 525
 526 Subclasses: @ref{v-button-box} @ref{h-button-box}
 527
 528 Slots:
 529 @itemize
 530 @item @anchor{slot.button-box.layout-style}layout-style. Type: @ref{button-box-style}. Accessor: @anchor{fn.button-box-layout-style}@code{button-box-layout-style}.
 531 @end itemize
 532
 533
 534 Signals:
 535 @itemize
 536 @end itemize
 537
 538
 539
 540
 541 @node calendar
 542 @section calendar
 543 @Class calendar
 544 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
 545
 546 Slots:
 547 @itemize
 548 @item @anchor{slot.calendar.day}day. Type: @code{integer}. Accessor: @anchor{fn.calendar-day}@code{calendar-day}.
 549 @item @anchor{slot.calendar.detail-function}detail-function. Type: ????. Accessor: @anchor{fn.calendar-detail-function}@code{calendar-detail-function}. Write-only.
 550 @item @anchor{slot.calendar.detail-height-rows}detail-height-rows. Type: @code{integer}. Accessor: @anchor{fn.calendar-detail-height-rows}@code{calendar-detail-height-rows}.
 551 @item @anchor{slot.calendar.detail-width-chars}detail-width-chars. Type: @code{integer}. Accessor: @anchor{fn.calendar-detail-width-chars}@code{calendar-detail-width-chars}.
 552 @item @anchor{slot.calendar.month}month. Type: @code{integer}. Accessor: @anchor{fn.calendar-month}@code{calendar-month}.
 553 @item @anchor{slot.calendar.no-month-change}no-month-change. Type: @code{boolean}. Accessor: @anchor{fn.calendar-no-month-change}@code{calendar-no-month-change}.
 554 @item @anchor{slot.calendar.show-day-names}show-day-names. Type: @code{boolean}. Accessor: @anchor{fn.calendar-show-day-names}@code{calendar-show-day-names}.
 555 @item @anchor{slot.calendar.show-details}show-details. Type: @code{boolean}. Accessor: @anchor{fn.calendar-show-details}@code{calendar-show-details}.
 556 @item @anchor{slot.calendar.show-heading}show-heading. Type: @code{boolean}. Accessor: @anchor{fn.calendar-show-heading}@code{calendar-show-heading}.
 557 @item @anchor{slot.calendar.show-week-numbers}show-week-numbers. Type: @code{boolean}. Accessor: @anchor{fn.calendar-show-week-numbers}@code{calendar-show-week-numbers}.
 558 @item @anchor{slot.calendar.year}year. Type: @code{integer}. Accessor: @anchor{fn.calendar-year}@code{calendar-year}.
 559 @end itemize
 560
 561
 562 Signals:
 563 @itemize
 564 @item @anchor{signal.calendar.day-selected}"day-selected". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
 565 @item @anchor{signal.calendar.day-selected-double-click}"day-selected-double-click". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
 566 @item @anchor{signal.calendar.month-changed}"month-changed". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
 567 @item @anchor{signal.calendar.next-month}"next-month". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
 568 @item @anchor{signal.calendar.next-year}"next-year". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
 569 @item @anchor{signal.calendar.prev-month}"prev-month". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
 570 @item @anchor{signal.calendar.prev-year}"prev-year". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
 571 @end itemize
 572
 573
 574
 575
 576 @node cell-view
 577 @section cell-view
 578 @Class cell-view
 579 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-layout}
 580
 581 Slots:
 582 @itemize
 583 @item @anchor{slot.cell-view.background}background. Type: @code{string}. Accessor: @anchor{fn.cell-view-background}@code{cell-view-background}. Write-only.
 584 @item @anchor{slot.cell-view.background-gdk}background-gdk. Type: @ref{color}. Accessor: @anchor{fn.cell-view-background-gdk}@code{cell-view-background-gdk}.
 585 @item @anchor{slot.cell-view.background-set}background-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-view-background-set}@code{cell-view-background-set}.
 586 @item @anchor{slot.cell-view.displayed-row}displayed-row. Type: @ref{tree-path}. Accessor: @anchor{fn.cell-view-displayed-row}@code{cell-view-displayed-row}.
 587 @item @anchor{slot.cell-view.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.cell-view-model}@code{cell-view-model}.
 588 @end itemize
 589
 590
 591 Signals:
 592 @itemize
 593 @end itemize
 594
 595
 596
 597
 598 @node check-button
 599 @section check-button
 600 @Class check-button
 601 Superclass: @ref{toggle-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
 602
 603 Subclasses: @ref{radio-button}
 604
 605
 606 A @ref{check-button} places a discrete @ref{toggle-button} next to a widget, (usually a @ref{label}). See the @ref{toggle-button} for more information about toggle/check buttons.
 607
 608 The important signal @SignalRef{toggle-button,toggled} is also inherited from @ref{toggle-button}.
 609
 610 Slots:
 611 @itemize
 612 @end itemize
 613
 614
 615 Signals:
 616 @itemize
 617 @end itemize
 618
 619
 620
 621
 622 @node check-menu-item
 623 @section check-menu-item
 624 @Class check-menu-item
 625 Superclass: @ref{menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
 626
 627 Subclasses: @ref{radio-menu-item}
 628
 629 Slots:
 630 @itemize
 631 @item @anchor{slot.check-menu-item.active}active. Type: @code{boolean}. Accessor: @anchor{fn.check-menu-item-active}@code{check-menu-item-active}.
 632 @item @anchor{slot.check-menu-item.draw-as-radio}draw-as-radio. Type: @code{boolean}. Accessor: @anchor{fn.check-menu-item-draw-as-radio}@code{check-menu-item-draw-as-radio}.
 633 @item @anchor{slot.check-menu-item.inconsistent}inconsistent. Type: @code{boolean}. Accessor: @anchor{fn.check-menu-item-inconsistent}@code{check-menu-item-inconsistent}.
 634 @end itemize
 635
 636
 637 Signals:
 638 @itemize
 639 @item @anchor{signal.check-menu-item.toggled}"toggled". Signature: (instance @ref{check-menu-item}) @result{} void. Options: run-first.
 640 @end itemize
 641
 642
 643
 644
 645 @node color-button
 646 @section color-button
 647 @Class color-button
 648 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
 649
 650 Slots:
 651 @itemize
 652 @item @anchor{slot.color-button.alpha}alpha. Type: @code{integer}. Accessor: @anchor{fn.color-button-alpha}@code{color-button-alpha}.
 653 @item @anchor{slot.color-button.color}color. Type: @ref{color}. Accessor: @anchor{fn.color-button-color}@code{color-button-color}.
 654 @item @anchor{slot.color-button.title}title. Type: @code{string}. Accessor: @anchor{fn.color-button-title}@code{color-button-title}.
 655 @item @anchor{slot.color-button.use-alpha}use-alpha. Type: @code{boolean}. Accessor: @anchor{fn.color-button-use-alpha}@code{color-button-use-alpha}.
 656 @end itemize
 657
 658
 659 Signals:
 660 @itemize
 661 @item @anchor{signal.color-button.color-set}"color-set". Signature: (instance @ref{color-button}) @result{} void. Options: run-first.
 662 @end itemize
 663
 664
 665
 666
 667 @node color-selection
 668 @section color-selection
 669 @Class color-selection
 670 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
 671
 672 Slots:
 673 @itemize
 674 @item @anchor{slot.color-selection.current-alpha}current-alpha. Type: @code{integer}. Accessor: @anchor{fn.color-selection-current-alpha}@code{color-selection-current-alpha}.
 675 @item @anchor{slot.color-selection.current-color}current-color. Type: @ref{color}. Accessor: @anchor{fn.color-selection-current-color}@code{color-selection-current-color}.
 676 @item @anchor{slot.color-selection.has-opacity-control}has-opacity-control. Type: @code{boolean}. Accessor: @anchor{fn.color-selection-has-opacity-control}@code{color-selection-has-opacity-control}.
 677 @item @anchor{slot.color-selection.has-palette}has-palette. Type: @code{boolean}. Accessor: @anchor{fn.color-selection-has-palette}@code{color-selection-has-palette}.
 678 @end itemize
 679
 680
 681 Signals:
 682 @itemize
 683 @item @anchor{signal.color-selection.color-changed}"color-changed". Signature: (instance @ref{color-selection}) @result{} void. Options: run-first.
 684 @end itemize
 685
 686
 687
 688
 689 @node color-selection-dialog
 690 @section color-selection-dialog
 691 @Class color-selection-dialog
 692 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
 693
 694 Slots:
 695 @itemize
 696 @item @anchor{slot.color-selection-dialog.cancel-button}cancel-button. Type: @ref{widget}. Accessor: @anchor{fn.color-selection-dialog-cancel-button}@code{color-selection-dialog-cancel-button}. Read-only.
 697 @item @anchor{slot.color-selection-dialog.color-selection}color-selection. Type: @ref{widget}. Accessor: @anchor{fn.color-selection-dialog-color-selection}@code{color-selection-dialog-color-selection}. Read-only.
 698 @item @anchor{slot.color-selection-dialog.help-button}help-button. Type: @ref{widget}. Accessor: @anchor{fn.color-selection-dialog-help-button}@code{color-selection-dialog-help-button}. Read-only.
 699 @item @anchor{slot.color-selection-dialog.ok-button}ok-button. Type: @ref{widget}. Accessor: @anchor{fn.color-selection-dialog-ok-button}@code{color-selection-dialog-ok-button}. Read-only.
 700 @end itemize
 701
 702
 703 Signals:
 704 @itemize
 705 @end itemize
 706
 707
 708
 709
 710 @node combo-box
 711 @section combo-box
 712 @Class combo-box
 713 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-editable} @ref{cell-layout}
 714
 715 Subclasses: @ref{combo-box-entry}
 716
 717 Slots:
 718 @itemize
 719 @item @anchor{slot.combo-box.active}active. Type: @code{integer}. Accessor: @anchor{fn.combo-box-active}@code{combo-box-active}.
 720 @item @anchor{slot.combo-box.active-iter}active-iter. Type: @ref{tree-iter}. Accessor: @anchor{fn.combo-box-active-iter}@code{combo-box-active-iter}.
 721 @item @anchor{slot.combo-box.add-tearoffs}add-tearoffs. Type: @code{boolean}. Accessor: @anchor{fn.combo-box-add-tearoffs}@code{combo-box-add-tearoffs}.
 722 @item @anchor{slot.combo-box.button-sensitivity}button-sensitivity. Type: @ref{sensitivity-type}. Accessor: @anchor{fn.combo-box-button-sensitivity}@code{combo-box-button-sensitivity}.
 723 @item @anchor{slot.combo-box.column-span-column}column-span-column. Type: @code{integer}. Accessor: @anchor{fn.combo-box-column-span-column}@code{combo-box-column-span-column}.
 724 @item @anchor{slot.combo-box.focus-on-click}focus-on-click. Type: @code{boolean}. Accessor: @anchor{fn.combo-box-focus-on-click}@code{combo-box-focus-on-click}.
 725 @item @anchor{slot.combo-box.has-frame}has-frame. Type: @code{boolean}. Accessor: @anchor{fn.combo-box-has-frame}@code{combo-box-has-frame}.
 726 @item @anchor{slot.combo-box.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.combo-box-model}@code{combo-box-model}.
 727 @item @anchor{slot.combo-box.popup-shown}popup-shown. Type: @code{boolean}. Accessor: @anchor{fn.combo-box-popup-shown}@code{combo-box-popup-shown}. Read-only.
 728 @item @anchor{slot.combo-box.row-separator-func}row-separator-func. Type: ????. Accessor: @anchor{fn.combo-box-row-separator-func}@code{combo-box-row-separator-func}. Write-only.
 729 @item @anchor{slot.combo-box.row-span-column}row-span-column. Type: @code{integer}. Accessor: @anchor{fn.combo-box-row-span-column}@code{combo-box-row-span-column}.
 730 @item @anchor{slot.combo-box.tearoff-title}tearoff-title. Type: @code{string}. Accessor: @anchor{fn.combo-box-tearoff-title}@code{combo-box-tearoff-title}.
 731 @item @anchor{slot.combo-box.wrap-width}wrap-width. Type: @code{integer}. Accessor: @anchor{fn.combo-box-wrap-width}@code{combo-box-wrap-width}.
 732 @end itemize
 733
 734
 735 Signals:
 736 @itemize
 737 @item @anchor{signal.combo-box.changed}"changed". Signature: (instance @ref{combo-box}) @result{} void. Options: run-last.
 738 @item @anchor{signal.combo-box.move-active}"move-active". Signature: (instance @ref{combo-box}), (arg-1 @ref{scroll-type}) @result{} void. Options: run-last, action.
 739 @item @anchor{signal.combo-box.popdown}"popdown". Signature: (instance @ref{combo-box}) @result{} @code{boolean}. Options: run-last, action.
 740 @item @anchor{signal.combo-box.popup}"popup". Signature: (instance @ref{combo-box}) @result{} void. Options: run-last, action.
 741 @end itemize
 742
 743
 744
 745
 746 @node combo-box-entry
 747 @section combo-box-entry
 748 @Class combo-box-entry
 749 Superclass: @ref{combo-box} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-editable} @ref{cell-layout}
 750
 751 Slots:
 752 @itemize
 753 @item @anchor{slot.combo-box-entry.text-column}text-column. Type: @code{integer}. Accessor: @anchor{fn.combo-box-entry-text-column}@code{combo-box-entry-text-column}.
 754 @end itemize
 755
 756
 757 Signals:
 758 @itemize
 759 @end itemize
 760
 761
 762
 763
 764 @node container
 765 @section container
 766 @Class container
 767 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
 768
 769 Subclasses: @ref{toolbar} @ref{text-view} @ref{table} @ref{socket} @ref{layout} @ref{paned} @ref{fixed} @ref{box} @ref{icon-view} @ref{tree-view} @ref{notebook} @ref{menu-shell} @ref{bin}
 770
 771 Slots:
 772 @itemize
 773 @item @anchor{slot.container.border-width}border-width. Type: @code{integer}. Accessor: @anchor{fn.container-border-width}@code{container-border-width}.
 774 @item @anchor{slot.container.child}child. Type: @ref{widget}. Accessor: @anchor{fn.container-child}@code{container-child}. Write-only.
 775 @item @anchor{slot.container.focus-child}focus-child. Type: @ref{g-object}. Accessor: @anchor{fn.container-focus-child}@code{container-focus-child}.
 776 @item @anchor{slot.container.focus-hadjustment}focus-hadjustment. Type: @ref{g-object}. Accessor: @anchor{fn.container-focus-hadjustment}@code{container-focus-hadjustment}.
 777 @item @anchor{slot.container.focus-vadjustment}focus-vadjustment. Type: @ref{g-object}. Accessor: @anchor{fn.container-focus-vadjustment}@code{container-focus-vadjustment}.
 778 @item @anchor{slot.container.resize-mode}resize-mode. Type: @ref{resize-mode}. Accessor: @anchor{fn.container-resize-mode}@code{container-resize-mode}.
 779 @end itemize
 780
 781
 782 Signals:
 783 @itemize
 784 @item @anchor{signal.container.add}"add". Signature: (instance @ref{container}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
 785 @item @anchor{signal.container.check-resize}"check-resize". Signature: (instance @ref{container}) @result{} void. Options: run-last.
 786 @item @anchor{signal.container.remove}"remove". Signature: (instance @ref{container}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
 787 @item @anchor{signal.container.set-focus-child}"set-focus-child". Signature: (instance @ref{container}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
 788 @end itemize
 789
 790
 791
 792
 793 @node curve
 794 @section curve
 795 @Class curve
 796 Superclass: @ref{drawing-area} @ref{atk-implementor-iface} @ref{buildable}
 797
 798 Slots:
 799 @itemize
 800 @item @anchor{slot.curve.curve-type}curve-type. Type: @ref{curve-type}. Accessor: @anchor{fn.curve-curve-type}@code{curve-curve-type}.
 801 @item @anchor{slot.curve.max-x}max-x. Type: @code{single-float}. Accessor: @anchor{fn.curve-max-x}@code{curve-max-x}.
 802 @item @anchor{slot.curve.max-y}max-y. Type: @code{single-float}. Accessor: @anchor{fn.curve-max-y}@code{curve-max-y}.
 803 @item @anchor{slot.curve.min-x}min-x. Type: @code{single-float}. Accessor: @anchor{fn.curve-min-x}@code{curve-min-x}.
 804 @item @anchor{slot.curve.min-y}min-y. Type: @code{single-float}. Accessor: @anchor{fn.curve-min-y}@code{curve-min-y}.
 805 @end itemize
 806
 807
 808 Signals:
 809 @itemize
 810 @item @anchor{signal.curve.curve-type-changed}"curve-type-changed". Signature: (instance @ref{curve}) @result{} void. Options: run-first.
 811 @end itemize
 812
 813
 814
 815
 816 @node dialog
 817 @section dialog
 818 @Class dialog
 819 Superclass: @ref{gtk-window} @ref{atk-implementor-iface} @ref{buildable}
 820
 821 Subclasses: @ref{recent-chooser-dialog} @ref{message-dialog} @ref{input-dialog} @ref{font-selection-dialog} @ref{file-chooser-dialog} @ref{color-selection-dialog} @ref{about-dialog}
 822
 823 Dialog boxes are a convenient way to prompt the user for a small amount of input, e.g. to display a message, ask a question, or anything else that does not require extensive effort on the user's part.
 824
 825 GTK+ treats a dialog as a window split vertically. The top section is a @ref{v-box}, and is where widgets such as a @ref{label} or a @ref{entry} should be packed. The bottom area is known as the @SlotRef{dialog,action-area}. This is generally used for packing buttons into the dialog which may perform functions such as cancel, ok, or apply. The two areas are separated by a @ref{h-separator}.
 826
 827 If 'dialog' is a newly created dialog, the two primary areas of the window can be accessed through @SlotRef{dialog,content-area} and @SlotRef{dialog,action-area}.
 828
 829 A 'modal' dialog (that is, one which freezes the rest of the application from user input), can be created by setting @SlotRef{gtk-window,modal} (e.g., by specifying @code{:modal t} initarg).
 830
 831 If you add buttons to @ref{dialog} using @ref{dialog-add-button}, or @ref{dialog-add-action-widget}, clicking the button will emit a @SignalRef{dialog,response} signal with a response ID that was specified. GTK+ will never assign a meaning to positive response IDs; these are entirely user-defined. But for convenience, you can use the response IDs in the @ref{response-type} enumeration (these all have values less than zero). If a dialog receives a delete event, the @SignalRef{dialog,response} signal will be emitted with a response ID of @EnumVRef{response-type,delete-event}.
 832
 833 TODO: cl-gtk2 does not yet support specifying custom response IDs.
 834
 835 If you want to block waiting for a dialog to return before returning control flow to your code, you can call @ref{dialog-run}. This function enters a recursive main loop and waits for the user to respond to the dialog, returning the response ID corresponding to the button the user clicked.
 836
 837 For the simple dialog in the following example, in reality you'd probably use @ref{message-dialog} to save yourself some effort. But you'd need to create the dialog contents manually if you had more than a simple message in the dialog.
 838
 839 @lisp
 840 (defun quick-message (message)
 841   "Function to open a dialog box display the MESSAGE"
 842   (let ((dialog (make-instance 'gtk:dialog :title "Message")))
 843     (gtk:dialog-add-button dialog "gtk-ok" :none)
 844     (gtk:container-add (gtk:dialog-content-area dialog)
 845                        (make-instance 'gtk:label :label message))
 846     (gobject:connect-signal dialog "response"
 847                             (lambda (dialog1 response-id)
 848                               (declare (ignore dialog1 response-id))
 849                               (gtk:object-destroy dialog)))
 850     (gtk:widget-show dialog)))
 851 @end lisp
 852
 853 Slots:
 854 @itemize
 855 @item @anchor{slot.dialog.action-area}action-area. Type: @ref{v-box}. Accessor: @anchor{fn.dialog-action-area}@code{dialog-action-area}. Read-only.
 856
 857 The action area of dialog.
 858 @item @anchor{slot.dialog.alternative-button-order}alternative-button-order. Type: @code{list of @ref{response-type}}. Accessor: @anchor{fn.dialog-alternative-button-order}@code{dialog-alternative-button-order}. Write-only.
 859
 860 Sets an alternative button order. If the "gtk-alternative-button-order" setting is set to True, the dialog buttons are reordered according to the order of the response ids passed to this function.
 861
 862 By default, GTK+ dialogs use the button order advocated by the Gnome Human Interface Guidelines with the affirmative button at the far right, and the cancel button left of it. But the builtin GTK+ dialogs and @ref{message-dialog}s do provide an alternative button order, which is more suitable on some platforms, e.g. Windows.
 863
 864 Set this after adding all the buttons to your dialog, as the following example shows:
 865
 866 @lisp
 867 (setf (dialog-alternative-button-order dialog) '(:ok :cancel :help))
 868 @end lisp
 869
 870 @item @anchor{slot.dialog.content-area}content-area. Type: @ref{widget}. Accessor: @anchor{fn.dialog-content-area}@code{dialog-content-area}. Read-only.
 871
 872 The content area of dialog.
 873
 874 @item @anchor{slot.dialog.default-response}default-response. Type: @ref{response-type}. Accessor: @anchor{fn.dialog-default-response}@code{dialog-default-response}. Write-only.
 875
 876 The widget in the dialog's action area with the given this response is the default widget for the dialog. Pressing "Enter" normally activates the default widget.
 877 @item @anchor{slot.dialog.has-separator}has-separator. Type: @code{boolean}. Accessor: @anchor{fn.dialog-has-separator}@code{dialog-has-separator}.
 878
 879
 880 When True, the dialog has a separator bar above its buttons.
 881
 882 Default value: True
 883 @end itemize
 884
 885
 886 Signals:
 887 @itemize
 888 @item @anchor{signal.dialog.close}"close". Signature: (instance @ref{dialog}) @result{} void. Options: run-last, action.
 889
 890 The close signal is a keybinding signal which gets emitted when the user uses a keybinding to close the dialog.
 891
 892 The default binding for this signal is the Escape key.
 893 @item @anchor{signal.dialog.response}"response". Signature: (instance @ref{dialog}), (response-id @code{integer}) @result{} void. Options: run-last.
 894
 895 Emitted when an action widget is clicked, the dialog receives a delete event, or the application programmer calls @ref{dialog-response}. On a delete event, the response ID is @EnumVRef{response-type,delete-event}. Otherwise, it depends on which action widget was clicked.
 896
 897 Note: because of some limitations, @var{response-id} is an integer. Use @code{(cffi:foreign-enum-keyword 'gtk:response-type response-id)} to get the value of type @ref{response-type}.
 898 @end itemize
 899
 900 @RMethod dialog-run
 901 @lisp
 902 (dialog-run dialog) @result{} response
 903 @end lisp
 904
 905 Blocks in a recursive main loop until the dialog either emits the @SignalRef{dialog,response} signal, or is destroyed. If the dialog is destroyed during the call to @ref{dialog-run}, it returns @EnumVRef{response-type,none}. Otherwise, it returns the response ID from the @SignalRef{dialog,response} signal emission.
 906
 907 Before entering the recursive main loop, @ref{dialog-run} calls @code{widget-show} on the dialog for you. Note that you still need to show any children of the dialog yourself.
 908
 909 During @ref{dialog-run}, the default behavior of @SignalRef{widget,delete-event} is disabled; if the dialog receives @SignalRef{widget,delete-event}, it will not be destroyed as windows usually are, and @ref{dialog-run} will return @EnumVRef{response-type,delete-event}. Also, during @ref{dialog-run} the dialog will be modal. You can force @ref{dialog-run} to return at any time by calling @ref{dialog-response} to emit the @SignalRef{dialog,response} signal. Destroying the dialog during @ref{dialog-run} is a very bad idea, because your post-run code won't know whether the dialog was destroyed or not.
 910
 911 After @ref{dialog-run} returns, you are responsible for hiding or destroying the dialog if you wish to do so.
 912
 913 Note that even though the recursive main loop gives the effect of a modal dialog (it prevents the user from interacting with other windows in the same window group while the dialog is run), callbacks such as timeouts, IO channel watches, DND drops, etc, will be triggered during a @ref{dialog-run} call.
 914
 915 @RMethod dialog-response
 916 @lisp
 917 (dialog-response dialog response)
 918 @end lisp
 919
 920 Emits the @SignalRef{dialog,response} signal with the given @var{response} (of type @ref{response-type}). Used to indicate that the user has responded to the @var{dialog} in some way; typically either you or @ref{dialog-run} will be monitoring the @SignalRef{dialog,response} signal and take appropriate action.
 921
 922 @RMethod dialog-add-button
 923 @lisp
 924 (dialog-add-button dialog text response) @result{} button
 925 @end lisp
 926
 927 Adds a button with the given @var{text} (or a stock button, if @var{text} is a stock ID) and sets things up so that clicking the button will emit the @SignalRef{dialog,response} signal with the given @var{response}. The button is appended to the end of the dialog's action area. The @ref{button} widget is returned, but usually you don't need it.
 928
 929 @RMethod dialog-add-action-widget
 930 @lisp
 931 (dialog-add-action-widget dialog widget response)
 932 @end lisp
 933
 934 Adds an activatable @var{widget} to the action area of a @var{dialog}, connecting a signal handler that will emit the @SignalRef{dialog,response} signal on the dialog when the @var{widget} is activated. The @var{widget} is appended to the end of the dialog's action area. If you want to add a non-activatable widget, simply pack it into the @SlotRef{dialog,action-area} field of the @ref{dialog}.
 935
 936 @RMethod dialog-set-response-sensitive
 937 @lisp
 938 (dialog-set-response-sensitive dialog response setting)
 939 @end lisp
 940
 941 Sets the @SlotRef{widget,sensitive} for each widget in the dialog's action area with the given @var{response}. A convenient way to sensitize/desensitize dialog buttons.
 942
 943 @RMethod dialog-response-for-widget
 944 @lisp
 945 (dialog-response-for-widget dialog widget) @result{} response
 946 @end lisp
 947
 948 Gets the @var{response} (of type @ref{response-type}) of a @var{widget} in the action area of a @var{dialog}.
 949
 950 @RMethod dialog-alternative-button-order-on-screen
 951 @lisp
 952 (dialog-alternative-button-order-on-screen screen) @result{} boolean
 953 @end lisp
 954
 955 Returns True if dialogs are expected to use an alternative button order on the @ref{screen} @var{screen}. See @SlotRef{dialog,alternative-button-order} for more details about alternative button order.
 956
 957 If you need to use this method, you should probably connect to the ::notify:gtk-alternative-button-order signal on the GtkSettings object associated to screen, in order to be notified if the button order setting changes.
 958
 959 @var{screen}: a @ref{screen} or a NIL if to use a default screen.
 960
 961 @node drawing-area
 962 @section drawing-area
 963 @Class drawing-area
 964 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
 965
 966 Subclasses: @ref{curve}
 967
 968 Slots:
 969 @itemize
 970 @end itemize
 971
 972
 973 Signals:
 974 @itemize
 975 @end itemize
 976
 977
 978
 979
 980 @node entry
 981 @section entry
 982 @Class entry
 983 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-editable} @ref{editable}
 984
 985 Subclasses: @ref{spin-button}
 986
 987 The @ref{entry} widget is a single line text entry widget. A fairly large set of key bindings are supported by default. If the entered text is longer than the allocation of the widget, the widget will scroll so that the cursor position is visible.
 988
 989 When using an entry for passwords and other sensitive information, it can be put into "password mode" using @SlotRef{entry,visibility}. In this mode, entered text is displayed using a 'invisible' character. By default, GTK+ picks the best invisible character that is available in the current font, but it can be changed with @SlotRef{entry,invisible-char}. Since 2.16, GTK+ displays a warning when Caps Lock or input methods might interfere with entering text in a password entry. The warning can be turned off with the @SlotRef{entry,caps-lock-warning} property.
 990
 991 Since 2.16, @ref{entry} has the ability to display progress or activity information behind the text. To make an entry display such information, use @SlotRef{entry,progress-fraction} or @SlotRef{entry,progress-pulse-step},
 992
 993 Additionally, @ref{entry} can show icons at either side of the entry. These icons can be activatable by clicking, can be set up as drag source and can have tooltips. To add an icon, use @SlotRef{entry,primary-icon-gicon} or one of the various other properties that set an icon from a stock id, an icon name or a pixbuf. To trigger an action when the user clicks an icon, connect to the @SignalRef{entry,icon-press} signal. To allow DND operations from an icon, use gtk_entry_set_icon_drag_source(). To set a tooltip on an icon, use @SlotRef{entry,primary-icon-tooltip-text} or @SlotRef{entry,primary-icon-tooltip-markup}. Secondary icon works the same way.
 994
 995 Note that functionality or information that is only available by clicking on an icon in an entry may not be accessible at all to users which are not able to use a mouse or other pointing device. It is therefore recommended that any such functionality should also be available by other means, e.g. via the context menu of the entry.
 996
 997
 998 Slots:
 999 @itemize
1000 @item @anchor{slot.entry.activates-default}activates-default. Type: @code{boolean}. Accessor: @anchor{fn.entry-activates-default}@code{entry-activates-default}.
1001
1002 Whether to activate the default widget (such as the default button in a dialog) when Enter is pressed.
1003
1004 Default value: False
1005 @item @anchor{slot.entry.caps-lock-warning}caps-lock-warning. Type: @code{boolean}. Accessor: @anchor{fn.entry-caps-lock-warning}@code{entry-caps-lock-warning}.
1006
1007 Whether password entries will show a warning when Caps Lock is on.
1008
1009 Note that the warning is shown using a secondary icon, and thus does not work if you are using the secondary icon position for some other purpose.
1010
1011 Default value: True
1012 @item @anchor{slot.entry.completion}completion. Type: @ref{entry-completion}. Accessor: @anchor{fn.entry-completion}@code{entry-completion}.
1013
1014 The current position of the insertion cursor in chars.
1015
1016 Allowed values: [0,65535]
1017
1018 Default value: 0
1019 @item @anchor{slot.entry.cursor-hadjustment}cursor-hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.entry-cursor-hadjustment}@code{entry-cursor-hadjustment}.
1020
1021 The adjustment that is bound to the cursor position.
1022
1023 The adjustment has to be in pixel units and in the same coordinate system as the entry.
1024 @item @anchor{slot.entry.cursor-position}cursor-position. Type: @code{integer}. Accessor: @anchor{fn.entry-cursor-position}@code{entry-cursor-position}. Read-only.
1025
1026 Whether the entry contents can be edited.
1027
1028 Default value: True
1029 @item @anchor{slot.entry.editable}editable. Type: @code{boolean}. Accessor: @anchor{fn.entry-editable}@code{entry-editable}.
1030
1031 False removes outside bevel from entry.
1032
1033 Default value: True
1034 @item @anchor{slot.entry.has-frame}has-frame. Type: @code{boolean}. Accessor: @anchor{fn.entry-has-frame}@code{entry-has-frame}.
1035
1036 False removes outside bevel from entry.
1037
1038 Default value: True
1039 @item @anchor{slot.entry.im-module}im-module. Type: @code{string}. Accessor: @anchor{fn.entry-im-module}@code{entry-im-module}.
1040
1041 Which IM (input method) module should be used for this entry. See @ref{i-m-context}.
1042
1043 Setting this to a non-NIL value overrides the system-wide IM module setting. See the @SlotRef{settings,gtk-im-module} property.
1044
1045 Default value: NIL
1046 @item @anchor{slot.entry.inner-border}inner-border. Type: @ref{border}. Accessor: @anchor{fn.entry-inner-border}@code{entry-inner-border}.
1047
1048 Sets the text area's border between the text and the frame.
1049
1050 Since 2.10
1051 @item @anchor{slot.entry.invisible-char}invisible-char. Type: @code{integer}. Accessor: @anchor{fn.entry-invisible-char}@code{entry-invisible-char}.
1052
1053 The character to use when masking entry contents (in "password mode").
1054
1055 Default value: '*'
1056 @item @anchor{slot.entry.invisible-char-set}invisible-char-set. Type: @code{boolean}. Accessor: @anchor{fn.entry-invisible-char-set}@code{entry-invisible-char-set}.
1057
1058 Whether the invisible char has been set for the GtkEntry.
1059
1060 Default value: False
1061 @item @anchor{slot.entry.layout}layout. Type: @code{PangoLayout}. Accessor: @anchor{fn.entry-layout}@code{entry-layout}. Read-only.
1062
1063 The PangoLayout used to display the entry. The layout is useful to e.g. convert text positions to pixel positions, in combination with @SlotRef{entry,layout-offset}.
1064
1065 Keep in mind that the layout text may contain a preedit string, so @ref{entry-layout-index-to-text-index} and @ref{entry-text-index-to-layout-index} are needed to convert byte indices in the layout to byte indices in the entry contents.
1066 @item @anchor{slot.entry.layout-offset}layout-offset. Type: list of @code{integer}. Accessor: @anchor{fn.entry-layout-offset}@code{entry-layout-offset}. Read-only.
1067
1068 Obtains the position of the PangoLayout used to render text in the entry, in widget coordinates as the list of two integers - the x and y offsets. Useful if you want to line up the text in an entry with some other text, e.g. when using the entry to implement editable cells in a sheet widget.
1069
1070 Also useful to convert mouse events into coordinates inside the PangoLayout, e.g. to take some action if some part of the entry text is clicked.
1071
1072 Note that as the user scrolls around in the entry the offsets will change; you'll need to connect to the "notify::scroll-offset" signal to track this. Remember when using the PangoLayout functions you need to convert to and from pixels using PANGO_PIXELS() or PANGO_SCALE.
1073
1074 Keep in mind that the layout text may contain a preedit string, so @ref{entry-layout-index-to-text-index} and @ref{entry-text-index-to-layout-index} are needed to convert byte indices in the layout to byte indices in the entry contents.
1075 @item @anchor{slot.entry.max-length}max-length. Type: @code{integer}. Accessor: @anchor{fn.entry-max-length}@code{entry-max-length}.
1076
1077 Maximum number of characters for this entry. Zero if no maximum.
1078
1079 Allowed values: [0,65535]
1080
1081 Default value: 0
1082 @item @anchor{slot.entry.overwrite-mode}overwrite-mode. Type: @code{boolean}. Accessor: @anchor{fn.entry-overwrite-mode}@code{entry-overwrite-mode}.
1083
1084 If text is overwritten when typing in the GtkEntry.
1085
1086 Default value: False
1087 @item @anchor{slot.entry.primary-icon-activatable}primary-icon-activatable. Type: @code{boolean}. Accessor: @anchor{fn.entry-primary-icon-activatable}@code{entry-primary-icon-activatable}.
1088
1089 Whether the primary icon is activatable.
1090
1091 GTK+ emits the @SignalRef{entry,icon-press} and @SignalRef{entry,icon-release} signals only on sensitive, activatable icons.
1092
1093 Sensitive, but non-activatable icons can be used for purely informational purposes.
1094
1095 Default value: False
1096 @item @anchor{slot.entry.primary-icon-gicon}primary-icon-gicon. Type: @code{GIcon}. Accessor: @anchor{fn.entry-primary-icon-gicon}@code{entry-primary-icon-gicon}.
1097
1098 The GIcon to use for the primary icon for the entry. TODO: GIcon is not yet supported
1099 @item @anchor{slot.entry.primary-icon-name}primary-icon-name. Type: @code{string}. Accessor: @anchor{fn.entry-primary-icon-name}@code{entry-primary-icon-name}.
1100
1101 The icon name to use for the primary icon for the entry.
1102
1103 Default value: NIL
1104 @item @anchor{slot.entry.primary-icon-pixbuf}primary-icon-pixbuf. Type: @ref{pixbuf}. Accessor: @anchor{fn.entry-primary-icon-pixbuf}@code{entry-primary-icon-pixbuf}.
1105
1106 A pixbuf to use as the primary icon for the entry.
1107 @item @anchor{slot.entry.primary-icon-sensitive}primary-icon-sensitive. Type: @code{boolean}. Accessor: @anchor{fn.entry-primary-icon-sensitive}@code{entry-primary-icon-sensitive}.
1108
1109 Whether the primary icon is sensitive.
1110
1111 An insensitive icon appears grayed out. GTK+ does not emit the @SignalRef{entry,icon-press} and @SignalRef{entry,icon-release} signals and does not allow DND from insensitive icons.
1112
1113 An icon should be set insensitive if the action that would trigger when clicked is currently not available.
1114
1115 Default value: True
1116 @item @anchor{slot.entry.primary-icon-stock}primary-icon-stock. Type: @code{string}. Accessor: @anchor{fn.entry-primary-icon-stock}@code{entry-primary-icon-stock}.
1117
1118 The stock id to use for the primary icon for the entry.
1119
1120 Default value: NIL
1121 @item @anchor{slot.entry.primary-icon-storage-type}primary-icon-storage-type. Type: @ref{image-type}. Accessor: @anchor{fn.entry-primary-icon-storage-type}@code{entry-primary-icon-storage-type}. Read-only.
1122
1123 The representation which is used for the primary icon of the entry.
1124
1125 Default value: @EnumVRef{image-type,empty}
1126 @item @anchor{slot.entry.primary-icon-tooltip-markup}primary-icon-tooltip-markup. Type: @code{string}. Accessor: @anchor{fn.entry-primary-icon-tooltip-markup}@code{entry-primary-icon-tooltip-markup}.
1127
1128 The contents of the tooltip on the primary icon, which is marked up with the Pango text markup language.
1129
1130 Default value: NIL
1131 @item @anchor{slot.entry.primary-icon-tooltip-text}primary-icon-tooltip-text. Type: @code{string}. Accessor: @anchor{fn.entry-primary-icon-tooltip-text}@code{entry-primary-icon-tooltip-text}.
1132
1133 The contents of the tooltip on the primary icon.
1134
1135 Default value: NIL
1136 @item @anchor{slot.entry.progress-fraction}progress-fraction. Type: @code{double-float}. Accessor: @anchor{fn.entry-progress-fraction}@code{entry-progress-fraction}.
1137
1138 The current fraction of the task that's been completed.
1139
1140 Allowed values: [0,1]
1141
1142 Default value: 0
1143 @item @anchor{slot.entry.progress-pulse-step}progress-pulse-step. Type: @code{double-float}. Accessor: @anchor{fn.entry-progress-pulse-step}@code{entry-progress-pulse-step}.
1144
1145 The fraction of total entry width to move the progress bouncing block for each call to gtk_entry_progress_pulse().
1146
1147 Allowed values: [0,1]
1148
1149 Default value: 0.1
1150 @item @anchor{slot.entry.scroll-offset}scroll-offset. Type: @code{integer}. Accessor: @anchor{fn.entry-scroll-offset}@code{entry-scroll-offset}. Read-only.
1151
1152 Number of pixels of the entry scrolled off the screen to the left.
1153
1154 Allowed values: >= 0
1155
1156 Default value: 0
1157 @item @anchor{slot.entry.secondary-icon-activatable}secondary-icon-activatable. Type: @code{boolean}. Accessor: @anchor{fn.entry-secondary-icon-activatable}@code{entry-secondary-icon-activatable}.
1158
1159 Whether the secondary icon is activatable.
1160
1161 GTK+ emits the @SignalRef{entry,icon-press} and @SignalRef{entry,icon-release} signals only on sensitive, activatable icons.
1162
1163 Sensitive, but non-activatable icons can be used for purely informational purposes.
1164
1165 Default value: False
1166 @item @anchor{slot.entry.secondary-icon-gicon}secondary-icon-gicon. Type: @code{GIcon}. Accessor: @anchor{fn.entry-secondary-icon-gicon}@code{entry-secondary-icon-gicon}.
1167
1168 The GIcon to use for the secondary icon for the entry. TODO: GIcon is not yet supported
1169 @item @anchor{slot.entry.secondary-icon-name}secondary-icon-name. Type: @code{string}. Accessor: @anchor{fn.entry-secondary-icon-name}@code{entry-secondary-icon-name}.
1170
1171 The icon name to use for the secondary icon for the entry.
1172
1173 Default value: NIL
1174 @item @anchor{slot.entry.secondary-icon-pixbuf}secondary-icon-pixbuf. Type: @ref{pixbuf}. Accessor: @anchor{fn.entry-secondary-icon-pixbuf}@code{entry-secondary-icon-pixbuf}.
1175
1176 An pixbuf to use as the secondary icon for the entry.
1177 @item @anchor{slot.entry.secondary-icon-sensitive}secondary-icon-sensitive. Type: @code{boolean}. Accessor: @anchor{fn.entry-secondary-icon-sensitive}@code{entry-secondary-icon-sensitive}.
1178
1179 Whether the secondary icon is sensitive.
1180
1181 An insensitive icon appears grayed out. GTK+ does not emit the @SignalRef{entry,icon-press} and @SignalRef{entry,icon-release} signals and does not allow DND from insensitive icons.
1182
1183 An icon should be set insensitive if the action that would trigger when clicked is currently not available.
1184
1185 Default value: True
1186 @item @anchor{slot.entry.secondary-icon-stock}secondary-icon-stock. Type: @code{string}. Accessor: @anchor{fn.entry-secondary-icon-stock}@code{entry-secondary-icon-stock}.
1187
1188 The stock id to use for the secondary icon for the entry.
1189
1190 Default value: NIL
1191 @item @anchor{slot.entry.secondary-icon-storage-type}secondary-icon-storage-type. Type: @ref{image-type}. Accessor: @anchor{fn.entry-secondary-icon-storage-type}@code{entry-secondary-icon-storage-type}. Read-only.
1192
1193 The representation which is used for the secondary icon of the entry.
1194
1195 Default value: @EnumVRef{image-type,empty}
1196 @item @anchor{slot.entry.secondary-icon-tooltip-markup}secondary-icon-tooltip-markup. Type: @code{string}. Accessor: @anchor{fn.entry-secondary-icon-tooltip-markup}@code{entry-secondary-icon-tooltip-markup}.
1197
1198 The contents of the tooltip on the secondary icon, which is marked up with the Pango text markup language.
1199
1200 Default value: NIL
1201 @item @anchor{slot.entry.secondary-icon-tooltip-text}secondary-icon-tooltip-text. Type: @code{string}. Accessor: @anchor{fn.entry-secondary-icon-tooltip-text}@code{entry-secondary-icon-tooltip-text}.
1202
1203 The contents of the tooltip on the secondary icon.
1204
1205 Default value: NIL
1206 @item @anchor{slot.entry.selection-bound}selection-bound. Type: @code{integer}. Accessor: @anchor{fn.entry-selection-bound}@code{entry-selection-bound}. Read-only.
1207
1208 The position of the opposite end of the selection from the cursor in chars.
1209
1210 Allowed values: [0,65535]
1211
1212 Default value: 0
1213 @item @anchor{slot.entry.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.entry-shadow-type}@code{entry-shadow-type}.
1214
1215 Which kind of shadow to draw around the entry when "has-frame" is set to True.
1216
1217 Default value: @EnumVRef{shadow-type,in}
1218 @item @anchor{slot.entry.text}text. Type: @code{string}. Accessor: @anchor{fn.entry-text}@code{entry-text}.
1219
1220 The contents of the entry.
1221
1222 Default value: ""
1223 @item @anchor{slot.entry.text-length}text-length. Type: @code{integer}. Accessor: @anchor{fn.entry-text-length}@code{entry-text-length}. Read-only.
1224
1225 The length of the text in the GtkEntry.
1226
1227 Allowed values: <= 65535
1228
1229 Default value: 0
1230 @item @anchor{slot.entry.truncate-multiline}truncate-multiline. Type: @code{boolean}. Accessor: @anchor{fn.entry-truncate-multiline}@code{entry-truncate-multiline}.
1231
1232 When True, pasted multi-line text is truncated to the first line.
1233
1234 Default value: False
1235 @item @anchor{slot.entry.visibility}visibility. Type: @code{boolean}. Accessor: @anchor{fn.entry-visibility}@code{entry-visibility}.
1236
1237 False displays the "invisible char" instead of the actual text (password mode).
1238
1239 Default value: True
1240 @item @anchor{slot.entry.width-chars}width-chars. Type: @code{integer}. Accessor: @anchor{fn.entry-width-chars}@code{entry-width-chars}.
1241
1242 Number of characters to leave space for in the entry.
1243
1244 Default value: -1
1245 @item @anchor{slot.entry.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.entry-xalign}@code{entry-xalign}.
1246
1247 The horizontal alignment, from 0 (left) to 1 (right). Reversed for RTL layouts.
1248
1249 Allowed values: [0,1]
1250
1251 Default value: 0
1252 @end itemize
1253
1254 Signals:
1255 @itemize
1256 @item @anchor{signal.entry.activate}"activate". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1257
1258 A keybinding signal which gets emitted when the user activates the entry.
1259
1260 Applications should not connect to it, but may emit it with @ref{emit-signal} if they need to control activation programmatically.
1261
1262 The default bindings for this signal are all forms of the Enter key.
1263 @item @anchor{signal.entry.backspace}"backspace". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1264
1265 This signal is a keybinding signal which gets emitted when the user asks for it.
1266
1267 The default bindings for this signal are Backspace and Shift-Backspace.
1268 @item @anchor{signal.entry.copy-clipboard}"copy-clipboard". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1269
1270 This signal is a keybinding signal which gets emitted to copy the selection to the clipboard.
1271
1272 The default bindings for this signal are Ctrl-c and Ctrl-Insert.
1273 @item @anchor{signal.entry.cut-clipboard}"cut-clipboard". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1274
1275 This signal is a keybinding signal which gets emitted to cut the selection to the clipboard.
1276
1277 The default bindings for this signal are Ctrl-x and Shift-Delete.
1278 @item @anchor{signal.entry.delete-from-cursor}"delete-from-cursor". Signature: (instance @ref{entry}), (type @ref{delete-type}), (count @code{integer}) @result{} void. Options: run-last, action.
1279
1280 This signal is a keybinding signal which gets emitted when the user initiates a text deletion.
1281
1282 If the @var{type} is @EnumVRef{delete-type,chars}, GTK+ deletes the selection if there is one, otherwise it deletes the requested number of characters.
1283
1284 The default bindings for this signal are Delete for deleting a character and Ctrl-Delete for deleting a word.
1285
1286 @var{count} is the number of type units to delete
1287 @item @anchor{signal.entry.icon-press}"icon-press". Signature: (instance @ref{entry}), (icon @ref{entry-icon-position}), (event @ref{event}) @result{} void. Options: run-last.
1288
1289 This signal is emitted when an activatable icon is clicked.
1290 @item @anchor{signal.entry.icon-release}"icon-release". Signature: (instance @ref{entry}), (icon @code{entry-icon-position}), (event @ref{event}) @result{} void. Options: run-last.
1291
1292 This signal is emitted on the button release from a mouse click over an activatable icon.
1293 @item @anchor{signal.entry.insert-at-cursor}"insert-at-cursor". Signature: (instance @ref{entry}), (string @code{string}) @result{} void. Options: run-last, action.
1294
1295 This signal is a keybinding signal which gets emitted when the user initiates the insertion of a fixed string at the cursor.
1296
1297 This signal has no default bindings.
1298 @item @anchor{signal.entry.move-cursor}"move-cursor". Signature: (instance @ref{entry}), (step @ref{movement-step}), (count @code{integer}), (extend-selection @code{boolean}) @result{} void. Options: run-last, action.
1299
1300 This signal is a keybinding signal which gets emitted when the user initiates a cursor movement. If the cursor is not visible in entry, this signal causes the viewport to be moved instead.
1301
1302 Applications should not connect to it, but may emit it with @ref{emit-signal} if they need to control the cursor programmatically.
1303
1304 The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifer does not. There are too many key combinations to list them all here.
1305
1306 @itemize
1307 @item Arrow keys move by individual characters/lines
1308 @item Ctrl-arrow key combinations move by words/paragraphs
1309 @item Home/End keys move to the ends of the buffer
1310 @end itemize
1311
1312 @var{count} is the number of @var{step} units to move
1313
1314 @var{extend-selection} is True if the move should extend the selection
1315 @item @anchor{signal.entry.paste-clipboard}"paste-clipboard". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1316
1317 This signal is a keybinding signal which gets emitted to paste the contents of the clipboard into the text view.
1318
1319 The default bindings for this signal are Ctrl-v and Shift-Insert.
1320 @item @anchor{signal.entry.populate-popup}"populate-popup". Signature: (instance @ref{entry}), (menu @ref{menu}) @result{} void. Options: run-last.
1321
1322 This signal gets emitted before showing the context menu of the entry.
1323
1324 If you need to add items to the context menu, connect to this signal and append your menuitems to the menu.
1325 @item @anchor{signal.entry.toggle-overwrite}"toggle-overwrite". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1326
1327 This signal is a keybinding signal which gets emitted to toggle the overwrite mode of the entry.
1328
1329 The default bindings for this signal is Insert.
1330 @end itemize
1331
1332 @RMethod entry-layout-index-to-text-index
1333 @lisp
1334 (entry-layout-index-to-text-index entry layout-index) @result{} text-index
1335 @end lisp
1336
1337 Converts from a position in the entry contents to a position in the entry's PangoLayout.
1338
1339 @var{layout-index} - byte index into the entry layout text
1340
1341 @var{text-index} - byte index into the entry contents
1342
1343 @RMethod entry-text-index-to-layout-index
1344 @lisp
1345 (entry-text-index-to-layout-index entry text-index) @result{} layout-index
1346 @end lisp
1347
1348 Converts from a position in the entry's PangoLayout contents to a position in the entry.
1349
1350 @var{layout-index} - byte index into the entry layout text
1351
1352 @var{text-index} - byte index into the entry contents
1353
1354 @node event-box
1355 @section event-box
1356 @Class event-box
1357 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
1358
1359 Slots:
1360 @itemize
1361 @item @anchor{slot.event-box.above-child}above-child. Type: @code{boolean}. Accessor: @anchor{fn.event-box-above-child}@code{event-box-above-child}.
1362 @item @anchor{slot.event-box.visible-window}visible-window. Type: @code{boolean}. Accessor: @anchor{fn.event-box-visible-window}@code{event-box-visible-window}.
1363 @end itemize
1364
1365
1366 Signals:
1367 @itemize
1368 @end itemize
1369
1370
1371
1372
1373 @node expander
1374 @section expander
1375 @Class expander
1376 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
1377
1378 Slots:
1379 @itemize
1380 @item @anchor{slot.expander.expanded}expanded. Type: @code{boolean}. Accessor: @anchor{fn.expander-expanded}@code{expander-expanded}.
1381 @item @anchor{slot.expander.label}label. Type: @code{string}. Accessor: @anchor{fn.expander-label}@code{expander-label}.
1382 @item @anchor{slot.expander.label-widget}label-widget. Type: @ref{widget}. Accessor: @anchor{fn.expander-label-widget}@code{expander-label-widget}.
1383 @item @anchor{slot.expander.spacing}spacing. Type: @code{integer}. Accessor: @anchor{fn.expander-spacing}@code{expander-spacing}.
1384 @item @anchor{slot.expander.use-markup}use-markup. Type: @code{boolean}. Accessor: @anchor{fn.expander-use-markup}@code{expander-use-markup}.
1385 @item @anchor{slot.expander.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.expander-use-underline}@code{expander-use-underline}.
1386 @end itemize
1387
1388
1389 Signals:
1390 @itemize
1391 @item @anchor{signal.expander.activate}"activate". Signature: (instance @ref{expander}) @result{} void. Options: run-last, action.
1392 @end itemize
1393
1394
1395
1396
1397 @node file-chooser-button
1398 @section file-chooser-button
1399 @Class file-chooser-button
1400 Superclass: @ref{h-box} @ref{atk-implementor-iface} @ref{buildable} @ref{file-chooser} @ref{orientable}
1401
1402 Slots:
1403 @itemize
1404 @item @anchor{slot.file-chooser-button.dialog}dialog. Type: @ref{file-chooser}. Accessor: @anchor{fn.file-chooser-button-dialog}@code{file-chooser-button-dialog}. Write-only.
1405 @item @anchor{slot.file-chooser-button.focus-on-click}focus-on-click. Type: @code{boolean}. Accessor: @anchor{fn.file-chooser-button-focus-on-click}@code{file-chooser-button-focus-on-click}.
1406 @item @anchor{slot.file-chooser-button.title}title. Type: @code{string}. Accessor: @anchor{fn.file-chooser-button-title}@code{file-chooser-button-title}.
1407 @item @anchor{slot.file-chooser-button.width-chars}width-chars. Type: @code{integer}. Accessor: @anchor{fn.file-chooser-button-width-chars}@code{file-chooser-button-width-chars}.
1408 @end itemize
1409
1410
1411 Signals:
1412 @itemize
1413 @item @anchor{signal.file-chooser-button.file-set}"file-set". Signature: (instance @ref{file-chooser-button}) @result{} void. Options: run-first.
1414 @end itemize
1415
1416
1417
1418
1419 @node file-chooser-dialog
1420 @section file-chooser-dialog
1421 @Class file-chooser-dialog
1422 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable} @ref{file-chooser}
1423
1424 Slots:
1425 @itemize
1426 @end itemize
1427
1428
1429 Signals:
1430 @itemize
1431 @end itemize
1432
1433
1434
1435
1436 @node file-chooser-widget
1437 @section file-chooser-widget
1438 @Class file-chooser-widget
1439 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{file-chooser} @ref{file-chooser-embed} @ref{orientable}
1440
1441 Slots:
1442 @itemize
1443 @end itemize
1444
1445
1446 Signals:
1447 @itemize
1448 @end itemize
1449
1450
1451
1452
1453 @node fixed
1454 @section fixed
1455 @Class fixed
1456 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
1457
1458 Slots:
1459 @itemize
1460 @item @anchor{slot.fixed.has-window}has-window. Type: @code{boolean}. Accessor: @anchor{fn.fixed-has-window}@code{fixed-has-window}.
1461 @end itemize
1462
1463
1464 Signals:
1465 @itemize
1466 @end itemize
1467
1468
1469
1470
1471 @node font-button
1472 @section font-button
1473 @Class font-button
1474 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
1475
1476 Slots:
1477 @itemize
1478 @item @anchor{slot.font-button.font-name}font-name. Type: @code{string}. Accessor: @anchor{fn.font-button-font-name}@code{font-button-font-name}.
1479 @item @anchor{slot.font-button.show-size}show-size. Type: @code{boolean}. Accessor: @anchor{fn.font-button-show-size}@code{font-button-show-size}.
1480 @item @anchor{slot.font-button.show-style}show-style. Type: @code{boolean}. Accessor: @anchor{fn.font-button-show-style}@code{font-button-show-style}.
1481 @item @anchor{slot.font-button.title}title. Type: @code{string}. Accessor: @anchor{fn.font-button-title}@code{font-button-title}.
1482 @item @anchor{slot.font-button.use-font}use-font. Type: @code{boolean}. Accessor: @anchor{fn.font-button-use-font}@code{font-button-use-font}.
1483 @item @anchor{slot.font-button.use-size}use-size. Type: @code{boolean}. Accessor: @anchor{fn.font-button-use-size}@code{font-button-use-size}.
1484 @end itemize
1485
1486
1487 Signals:
1488 @itemize
1489 @item @anchor{signal.font-button.font-set}"font-set". Signature: (instance @ref{font-button}) @result{} void. Options: run-first.
1490 @end itemize
1491
1492
1493
1494
1495 @node font-selection
1496 @section font-selection
1497 @Class font-selection
1498 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1499
1500 Slots:
1501 @itemize
1502 @item @anchor{slot.font-selection.font}font. Type: @ref{font}. Accessor: @anchor{fn.font-selection-font}@code{font-selection-font}. Read-only.
1503 @item @anchor{slot.font-selection.font-name}font-name. Type: @code{string}. Accessor: @anchor{fn.font-selection-font-name}@code{font-selection-font-name}.
1504 @item @anchor{slot.font-selection.preview-text}preview-text. Type: @code{string}. Accessor: @anchor{fn.font-selection-preview-text}@code{font-selection-preview-text}.
1505 @end itemize
1506
1507
1508 Signals:
1509 @itemize
1510 @end itemize
1511
1512
1513
1514
1515 @node font-selection-dialog
1516 @section font-selection-dialog
1517 @Class font-selection-dialog
1518 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
1519
1520 Slots:
1521 @itemize
1522 @item @anchor{slot.font-selection-dialog.apply-button}apply-button. Type: @ref{g-object}. Accessor: @anchor{fn.font-selection-dialog-apply-button}@code{font-selection-dialog-apply-button}. Read-only.
1523 @item @anchor{slot.font-selection-dialog.cancel-button}cancel-button. Type: @ref{g-object}. Accessor: @anchor{fn.font-selection-dialog-cancel-button}@code{font-selection-dialog-cancel-button}. Read-only.
1524 @item @anchor{slot.font-selection-dialog.font-name}font-name. Type: @code{string}. Accessor: @anchor{fn.font-selection-dialog-font-name}@code{font-selection-dialog-font-name}.
1525 @item @anchor{slot.font-selection-dialog.ok-button}ok-button. Type: @ref{g-object}. Accessor: @anchor{fn.font-selection-dialog-ok-button}@code{font-selection-dialog-ok-button}. Read-only.
1526 @item @anchor{slot.font-selection-dialog.preview-text}preview-text. Type: @code{string}. Accessor: @anchor{fn.font-selection-dialog-preview-text}@code{font-selection-dialog-preview-text}.
1527 @end itemize
1528
1529
1530 Signals:
1531 @itemize
1532 @end itemize
1533
1534
1535
1536
1537 @node frame
1538 @section frame
1539 @Class frame
1540 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
1541
1542 Subclasses: @ref{aspect-frame}
1543
1544 Slots:
1545 @itemize
1546 @item @anchor{slot.frame.label}label. Type: @code{string}. Accessor: @anchor{fn.frame-label}@code{frame-label}.
1547 @item @anchor{slot.frame.label-widget}label-widget. Type: @ref{widget}. Accessor: @anchor{fn.frame-label-widget}@code{frame-label-widget}.
1548 @item @anchor{slot.frame.label-xalign}label-xalign. Type: @code{single-float}. Accessor: @anchor{fn.frame-label-xalign}@code{frame-label-xalign}.
1549 @item @anchor{slot.frame.label-yalign}label-yalign. Type: @code{single-float}. Accessor: @anchor{fn.frame-label-yalign}@code{frame-label-yalign}.
1550 @item @anchor{slot.frame.shadow}shadow. Type: @ref{shadow-type}. Accessor: @anchor{fn.frame-shadow}@code{frame-shadow}.
1551 @item @anchor{slot.frame.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.frame-shadow-type}@code{frame-shadow-type}.
1552 @end itemize
1553
1554
1555 Signals:
1556 @itemize
1557 @end itemize
1558
1559
1560
1561
1562 @node gamma-curve
1563 @section gamma-curve
1564 @Class gamma-curve
1565 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1566
1567 Slots:
1568 @itemize
1569 @end itemize
1570
1571
1572 Signals:
1573 @itemize
1574 @end itemize
1575
1576
1577
1578
1579 @node gtk-window
1580 @section gtk-window
1581 @Class gtk-window
1582 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
1583
1584 Subclasses: @ref{plug} @ref{assistant} @ref{dialog}
1585
1586 @ref{gtk-window} is a toplevel window that can contain other widgets. Nearly always, the type of the window should be @EnumVRef{window-type,toplevel}. If you're implementing something like a popup menu from scratch (which is a bad idea, just use @ref{menu}), you might use @EnumVRef{window-type,popup}. @EnumVRef{window-type,popup} is not for dialogs, though in some other toolkits dialogs are called "popups". In GTK+, @EnumVRef{window-type,popup} means a pop-up menu or pop-up tooltip. On X11, popup windows are not controlled by the window manager.
1587
1588 If you simply want an undecorated window (no window borders), use @SlotRef{gtk-window,decorated}, don't use @EnumVRef{window-type,popup}.
1589
1590 Slots:
1591 @itemize
1592 @item @anchor{slot.gtk-window.accept-focus}accept-focus. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-accept-focus}@code{gtk-window-accept-focus}.
1593
1594 Windows may set a hint asking the desktop environment not to receive the input focus. True if the window should receive the input focus.
1595
1596 Default value: True
1597 @item @anchor{slot.gtk-window.allow-grow}allow-grow. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-allow-grow}@code{gtk-window-allow-grow}.
1598
1599 If True, users can expand the window beyond its minimum size.
1600
1601 Default value: True
1602 @item @anchor{slot.gtk-window.allow-shrink}allow-shrink. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-allow-shrink}@code{gtk-window-allow-shrink}.
1603
1604 If True, the window has no mimimum size. Setting this to True is 99% of the time a bad idea.
1605
1606 Default value: False
1607 @item @anchor{slot.gtk-window.decorated}decorated. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-decorated}@code{gtk-window-decorated}.
1608
1609 Whether the window should be decorated by the window manager.
1610
1611 By default, windows are decorated with a title bar, resize controls, etc. Some window managers allow GTK+ to disable these decorations, creating a borderless window. If you set the decorated property to False using this function, GTK+ will do its best to convince the window manager not to decorate the window. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling @ref{widget-show}.
1612
1613 On Windows, this always works, since there's no window manager policy involved.
1614
1615 Default value: True
1616
1617 @item @anchor{slot.gtk-window.default-height}default-height. Type: @code{integer}. Accessor: @anchor{fn.gtk-window-default-height}@code{gtk-window-default-height}.
1618
1619 The default height of the window, used when initially showing the window.
1620
1621 If the window's "natural" size (its size request) is larger than the default, the default will be ignored. More generally, if the default size does not obey the geometry hints for the window (@ref{window-set-geometry-hints} can be used to set these explicitly), the default size will be clamped to the nearest permitted size.
1622
1623 Unlike @SlotRef{widget,width-request} and @SlotRef{widget,height-request}, that set a size request for a widget and thus would keep users from shrinking the window, this function only sets the initial size, just as if the user had resized the window themselves. Users can still shrink the window again as they normally would. Setting a default size of -1 means to use the "natural" default size (the size request of the window).
1624
1625 For more control over a window's initial size and how resizing works, see @ref{window-set-geometry-hints}.
1626
1627 For some uses, @ref{window-resize} is a more appropriate function. @ref{window-resize} changes the current size of the window, rather than the size to be used on initial display. @ref{window-resize} always affects the window itself, not the geometry widget.
1628
1629 The default size of a window only affects the first time a window is shown; if a window is hidden and re-shown, it will remember the size it had prior to hiding, rather than using the default size.
1630
1631 Windows can't actually be 0x0 in size, they must be at least 1x1, but passing 0 for width and height is OK, resulting in a 1x1 default size.
1632
1633 Default value: -1
1634 @item @anchor{slot.gtk-window.default-widget}default-widget. Type: @ref{widget}. Accessor: @anchor{fn.gtk-window-default-widget}@code{gtk-window-default-widget}.
1635
1636 The default widget is the widget that's activated when the user presses Enter in a dialog (for example). When setting (rather than unsetting) the default widget it's generally easier to call gtk_widget_grab_focus() on the widget. Before making a widget the default widget, you must set the @SlotRef{widget,can-default} on the widget you'd like to make the default.
1637 @item @anchor{slot.gtk-window.default-width}default-width. Type: @code{integer}. Accessor: @anchor{fn.gtk-window-default-width}@code{gtk-window-default-width}.
1638
1639 The default width of the window, used when initially showing the window.
1640
1641 See @SlotRef{gtk-window,default-height} for explanation.
1642
1643 Default value: -1
1644 @item @anchor{slot.gtk-window.deletable}deletable. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-deletable}@code{gtk-window-deletable}.
1645
1646 Whether the window frame should have a close button.
1647
1648 By default, windows have a close button in the window frame. Some window managers allow GTK+ to disable this button. If you set the deletable property to False using this function, GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible, so you should call it before calling @ref{widget-show}.
1649
1650 On Windows, this always works, since there's no window manager policy involved.
1651
1652 Default value: True
1653 @item @anchor{slot.gtk-window.destroy-with-parent}destroy-with-parent. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-destroy-with-parent}@code{gtk-window-destroy-with-parent}.
1654
1655 If this window should be destroyed when the parent is destroyed.
1656
1657 Default value: False
1658 @item @anchor{slot.gtk-window.focus}focus. Type: @ref{widget}. Accessor: @anchor{fn.gtk-window-focus}@code{gtk-window-focus}.
1659
1660 The current focused widget within the window. Note that this is the widget that would have the focus if the toplevel window focused; if the toplevel window is not focused then @SlotRef{gtk-window,focus} will not be True for the widget.
1661
1662 Settings this works the following way. If focus is not the current focus widget, and is focusable, sets it as the focus widget for the window. If focus is NIL, unsets the focus widget for this window. To set the focus to a particular widget in the toplevel, it is usually more convenient to use @ref{widget-grab-focus} instead of this function.
1663
1664 @item @anchor{slot.gtk-window.focus-on-map}focus-on-map. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-focus-on-map}@code{gtk-window-focus-on-map}.
1665
1666 Windows may set a hint asking the desktop environment not to receive the input focus when the window is mapped.  True if the window should receive the input focus when mapped.
1667
1668 Default value: True
1669 @item @anchor{slot.gtk-window.group}group. Type: @ref{window-group}. Accessor: @anchor{fn.gtk-window-group}@code{gtk-window-group}. Read-only.
1670
1671 Returns the group for window or the default group, if window does not have an explicit window group.
1672 @item @anchor{slot.gtk-window.gravity}gravity. Type: @ref{gravity}. Accessor: @anchor{fn.gtk-window-gravity}@code{gtk-window-gravity}.
1673
1674 The window gravity of the window. See @ref{window-move} and @ref{gravity} for more details about window gravity.
1675
1676 Default value: @EnumVRef{anchor-type,north-west}
1677
1678 @item @anchor{slot.gtk-window.has-frame}has-frame. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-has-frame}@code{gtk-window-has-frame}.
1679
1680 (Note: this is a special-purpose property for the framebuffer port that causes GTK+ to draw its own window border. For most applications you want @SlotRef{gtk-window,decorated} instead, which tells the window manager whether to draw the window border.)
1681
1682 If this property is set to True on a window, then before it is realized or showed, it will have a "frame" window around @SlotRef{widget,window}. Using the signal @SignalRef{gtk-window,frame-event} you can receive all events targeted at the frame.
1683
1684 This function is used by the linux-fb port to implement managed windows, but it could conceivably be used by X-programs that want to do their own window decorations.
1685 @item @anchor{slot.gtk-window.has-toplevel-focus}has-toplevel-focus. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-has-toplevel-focus}@code{gtk-window-has-toplevel-focus}. Read-only.
1686
1687 Whether the input focus is within this GtkWindow.
1688
1689 Default value: False
1690 @item @anchor{slot.gtk-window.icon}icon. Type: @ref{pixbuf}. Accessor: @anchor{fn.gtk-window-icon}@code{gtk-window-icon}.
1691
1692 This icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts.
1693
1694 The icon should be provided in whatever size it was naturally drawn; that is, don't scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.
1695
1696 Icon for this window.
1697 @item @anchor{slot.gtk-window.icon-list}icon-list. Type: list of @ref{pixbuf}. Accessor: @anchor{fn.gtk-window-icon-list}@code{gtk-window-icon-list}.
1698
1699 The icon representing a @ref{gtk-window}. The icon is used when the window is minimized (also known as iconified). Some window managers or desktop environments may also place it in the window frame, or display it in other contexts.
1700
1701 This property allows you to pass in the same icon in several hand-drawn sizes. The list should contain the natural sizes your icon is available in; that is, don't scale the image before passing it to GTK+. Scaling is postponed until the last minute, when the desired final size is known, to allow best quality.
1702
1703 By passing several sizes, you may improve the final image quality of the icon, by reducing or eliminating automatic image scaling.
1704
1705 Recommended sizes to provide: 16x16, 32x32, 48x48 at minimum, and larger images (64x64, 128x128) if you have them.
1706
1707 See also @ref{window-default-icon-list} to set the icon for all windows in your application in one go.
1708
1709 Note that transient windows (those who have been set transient for another window using @SlotRef{gtk-window,transient-for}) will inherit their icon from their transient parent. So there's no need to explicitly set the icon on transient windows.
1710
1711 @item @anchor{slot.gtk-window.icon-name}icon-name. Type: @code{string}. Accessor: @anchor{fn.gtk-window-icon-name}@code{gtk-window-icon-name}.
1712
1713 The icon-name property specifies the name of the themed icon to use as the window icon. See @ref{icon-theme} for more details.
1714
1715 Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM.
1716
1717 Default value: NIL
1718 @item @anchor{slot.gtk-window.is-active}is-active. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-is-active}@code{gtk-window-is-active}. Read-only.
1719
1720 Whether the toplevel is the current active window.
1721
1722 Default value: False
1723 @item @anchor{slot.gtk-window.mnemonic-modifier}mnemonic-modifier. Type: @ref{modifier-type}. Accessor: @anchor{fn.gtk-window-mnemonic-modifier}@code{gtk-window-mnemonic-modifier}.
1724
1725 The modifier mask used to activate mnemonics on this window.
1726 @item @anchor{slot.gtk-window.modal}modal. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-modal}@code{gtk-window-modal}.
1727
1728 If True, the window is modal (other windows are not usable while this one is up).
1729
1730 Default value: False
1731 @item @anchor{slot.gtk-window.opacity}opacity. Type: @code{double-float}. Accessor: @anchor{fn.gtk-window-opacity}@code{gtk-window-opacity}.
1732
1733 The requested opacity of the window.
1734
1735 Setting opacity requests the windowing system to make window partially transparent, with opacity 0 being fully transparent and 1 fully opaque. (Values of the opacity parameter are clamped to the [0,1] range.) On X11 this has any effect only on X screens with a compositing manager running. See @SlotRef{screen,composited-p}. On Windows it should work always.
1736
1737 Note that setting a window's opacity after the window has been shown causes it to flicker once on Windows.
1738
1739 Allowed values: [0,1]
1740
1741 Default value: 1
1742 @item @anchor{slot.gtk-window.resizable}resizable. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-resizable}@code{gtk-window-resizable}.
1743
1744 If True, users can resize the window.
1745
1746 Default value: True
1747 @item @anchor{slot.gtk-window.role}role. Type: @code{string}. Accessor: @anchor{fn.gtk-window-role}@code{gtk-window-role}.
1748
1749 Unique identifier for the window to be used when restoring a session.
1750
1751 This is only useful on X11, not with other GTK+ targets.
1752
1753 In combination with the window title, the window role allows a window manager to identify "the same" window when an application is restarted. So for example you might set the "toolbox" role on your app's toolbox window, so that when the user restarts their session, the window manager can put the toolbox back in the same place.
1754
1755 If a window already has a unique title, you don't need to set the role, since the WM can use the title to identify the window when restoring the session.
1756
1757 Default value: NIL
1758 @item @anchor{slot.gtk-window.screen}screen. Type: @ref{screen}. Accessor: @anchor{fn.gtk-window-screen}@code{gtk-window-screen}.
1759
1760 The screen where this window will be displayed.
1761 @item @anchor{slot.gtk-window.skip-pager-hint}skip-pager-hint. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-skip-pager-hint}@code{gtk-window-skip-pager-hint}.
1762
1763 Windows may set a hint asking the desktop environment not to display the window in the pager. (A "pager" is any desktop navigation tool such as a workspace switcher that displays a thumbnail representation of the windows on the screen.) True if the window should not be in the pager.
1764
1765 Default value: False
1766 @item @anchor{slot.gtk-window.skip-taskbar-hint}skip-taskbar-hint. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-skip-taskbar-hint}@code{gtk-window-skip-taskbar-hint}.
1767
1768 Windows may set a hint asking the desktop environment not to display the window in the task bar. True if the window should not be in the task bar.
1769
1770 Default value: False
1771 @item @anchor{slot.gtk-window.startup-id}startup-id. Type: @code{string}. Accessor: @anchor{fn.gtk-window-startup-id}@code{gtk-window-startup-id}. Write-only.
1772
1773 The startup-id is a write-only property for setting window's startup notification identifier.
1774
1775 Startup notification identifiers are used by desktop environment to track application startup, to provide user feedback and other features. This function changes the corresponding property on the underlying @ref{gdk-window}. Normally, startup identifier is managed automatically and you should only use this function in special cases like transferring focus from other processes. You should set this before calling @ref{window-present} or any equivalent function generating a window map event.
1776
1777 This is only useful on X11, not with other GTK+ targets.
1778
1779 Default value: NIL
1780 @item @anchor{slot.gtk-window.title}title. Type: @code{string}. Accessor: @anchor{fn.gtk-window-title}@code{gtk-window-title}.
1781
1782 The title of the window.
1783
1784 Default value: NIL
1785 @item @anchor{slot.gtk-window.transient-for}transient-for. Type: @ref{gtk-window}. Accessor: @anchor{fn.gtk-window-transient-for}@code{gtk-window-transient-for}.
1786
1787 The transient parent of the window.
1788
1789 Dialog windows should be set transient for the main application window they were spawned from. This allows window managers to e.g. keep the dialog on top of the main window, or center the dialog over the main window.
1790
1791 On Windows, this puts the child window on top of the parent, much as the window manager would have done on X.
1792 @item @anchor{slot.gtk-window.type}type. Type: @ref{window-type}. Accessor: @anchor{fn.gtk-window-type}@code{gtk-window-type}.
1793
1794 The type of the window.
1795
1796 Default value: @EnumVRef{window-type,toplevel}
1797 @item @anchor{slot.gtk-window.type-hint}type-hint. Type: @ref{gdk-window-type-hint}. Accessor: @anchor{fn.gtk-window-type-hint}@code{gtk-window-type-hint}.
1798
1799 Hint to help the desktop environment understand what kind of window this is and how to treat it.
1800
1801 This should be set before the window becomes visible.
1802
1803 Default value: @EnumVRef{gdk-window-type-hint,normal}
1804 @item @anchor{slot.gtk-window.urgency-hint}urgency-hint. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-urgency-hint}@code{gtk-window-urgency-hint}.
1805
1806 Windows may set a hint asking the desktop environment to draw the users attention to the window. True if the window should be brought to the user's attention.
1807
1808 Default value: False
1809 @item @anchor{slot.gtk-window.window-position}window-position. Type: @ref{window-position}. Accessor: @anchor{fn.gtk-window-window-position}@code{gtk-window-window-position}.
1810
1811 The initial position of the window.
1812
1813 Default value: @EnumVRef{window-position,none}
1814 @end itemize
1815
1816
1817 Signals:
1818 @itemize
1819 @item @anchor{signal.gtk-window.activate-default}"activate-default". Signature: (instance @ref{gtk-window}) @result{} void. Options: run-last, action.
1820
1821 The activate-default signal is a keybinding signal which gets emitted when the user activates the default widget of window.
1822 @item @anchor{signal.gtk-window.activate-focus}"activate-focus". Signature: (instance @ref{gtk-window}) @result{} void. Options: run-last, action.
1823
1824 The activate-default signal is a keybinding signal which gets emitted when the user activates the currently focused widget of window.
1825 @item @anchor{signal.gtk-window.frame-event}"frame-event". Signature: (instance @ref{gtk-window}), (event @ref{event}) @result{} @code{boolean}. Options: run-last.
1826
1827
1828 @item @anchor{signal.gtk-window.keys-changed}"keys-changed". Signature: (instance @ref{gtk-window}) @result{} void. Options: run-first.
1829
1830 The keys-changed signal gets emitted when the set of accelerators or mnemonics that are associated with window changes.
1831 @item @anchor{signal.gtk-window.set-focus}"set-focus". Signature: (instance @ref{gtk-window}), (widget @ref{widget}) @result{} void. Options: run-last.
1832 @end itemize
1833
1834 @RMethod window-add-accel-group
1835 @lisp
1836 (window-add-accel-group window accel-group)
1837 @end lisp
1838
1839 Associate @var{accel-group} (an @ref{accel-group}) with @var{window} (an @ref{gtk-window}).
1840
1841 @RMethod window-remove-accel-group
1842 @lisp
1843 (window-remove-accel-group window accel-group)
1844 @end lisp
1845
1846 Reverses the effect of @ref{window-add-accel-group}.
1847
1848 @RMethod window-activate-focus
1849 @lisp
1850 (window-activate-focus window)
1851 @end lisp
1852
1853 Activates the current focused widget within the @var{window} (an @ref{gtk-window}).
1854
1855 @RMethod window-activate-default
1856 @lisp
1857 (window-activate-default window) @result{} activated-p
1858 @end lisp
1859
1860 Activates the default widget for the @var{window} (an @ref{gtk-window}), unless the current focused widget has been configured to receive the default action (see @SlotRef{widget,receives-default}), in which case the focused widget is activated.
1861
1862 Returns True if a widget got activated.
1863
1864 @RMethod window-set-geometry-hints
1865 @lisp
1866 (window-set-geometry-hints window geometry-widget geometry geometry-mask)
1867 @end lisp
1868
1869 This function sets up hints about how a @var{window} (an @ref{gtk-window}) can be resized by the user. You can set a minimum and maximum size; allowed resize increments (e.g. for xterm, you can only resize by the size of a character); aspect ratios; and more. See the @ref{geometry} struct.
1870
1871 @var{geometry-widget}: a @ref{widget} - widget the geometry hints will be applied to
1872
1873 @var{geometry}: a @ref{geometry} - struct containing geometry information
1874
1875 @var{geometry-mask}: a @ref{window-hints} - mask indicating which struct fields should be paid attention to
1876
1877 @RFunction window-list-toplevels
1878 @lisp
1879 (window-list-toplevels) @result{} windows
1880 @end lisp
1881
1882 Returns a list of all existing toplevel windows. The widgets in the list are not individually referenced.
1883
1884 @var{windows}: fresh list of @ref{gtk-window}
1885
1886 @RMethod window-add-mnemonic
1887 @lisp
1888 (window-add-mnemonic window keyval target)
1889 @end lisp
1890
1891 Adds a mnemonic to this @var{window} (a @ref{gtk-window}).
1892
1893 @var{keyval}: mnemonic keyval
1894
1895 @var{target}: the @ref{widget} that gets activated by the mnemonic
1896
1897 @RMethod window-remove-mnemonic
1898 @lisp
1899 (window-remove-mnemonic window keyval target)
1900 @end lisp
1901
1902 Removes a mnemonic from this @var{window} (a @ref{gtk-window}).
1903
1904 @var{keyval}: mnemonic keyval
1905
1906 @var{target}: the @ref{widget} that gets activated by the mnemonic
1907
1908 @RMethod window-mnemonic-activate
1909 @lisp
1910 (window-mnemonic-activate window keyval modifier)
1911 @end lisp
1912
1913 Activates the targets associated with the mnemonic.
1914
1915 @var{keyval}: mnemonic keyval
1916
1917 @var{modifier}: a @ref{modifier-type} - modifiers
1918
1919 @RMethod window-activate-key
1920 @lisp
1921 (window-activate-key window event) @result{} activated-p
1922 @end lisp
1923
1924 Activates mnemonics and accelerators for this @ref{gtk-window}. This is normally called by the default @SignalRef{widget,key-press-event} handler for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.
1925
1926 Returns True if a mnemonic or accelerator was found and activated.
1927
1928 @var{event}: a @ref{event-key}
1929
1930 @RMethod window-propagate-key-event
1931 @lisp
1932 (window-propagate-key-event window event) @result{} handled-p
1933 @end lisp
1934
1935 Propagate a key press or release event to the focus widget and up the focus container chain until a widget handles @var{event}. This is normally called by the default @SignalRef{widget,key-press-event} and @SignalRef{widget,key-release-event} handlers for toplevel windows, however in some cases it may be useful to call this directly when overriding the standard key handling for a toplevel window.
1936
1937 Returns True if a widget in the focus chain handled the event.
1938
1939 @var{event}: a @ref{event-key}
1940
1941 @RMethod window-present
1942 @lisp
1943 (window-present window)
1944 @end lisp
1945
1946 Presents a @var{window} (a @ref{gtk-window}) to the user. This may mean raising the window in the stacking order, deiconifying it, moving it to the current desktop, and/or giving it the keyboard focus, possibly dependent on the user's platform, window manager, and preferences.
1947
1948 If window is hidden, this function calls @ref{widget-show} as well.
1949
1950 This function should be used when the user tries to open a window that's already open. Say for example the preferences dialog is currently open, and the user chooses Preferences from the menu a second time; use @ref{window-present} to move the already-open dialog where the user can see it.
1951
1952 If you are calling this function in response to a user interaction, it is preferable to use @ref{window-present-with-time}.
1953
1954 @RMethod window-present-with-time
1955 @lisp
1956 (window-present-with-time window timestamp)
1957 @end lisp
1958
1959 Presents a @var{window} (a @ref{gtk-window}) to the user in response to a user interaction. If you need to present a window without a timestamp, use @ref{window-present}. See @ref{window-present} for details.
1960
1961 @var{timestamp}: the timestamp of the user interaction (typically a button or key press event) which triggered this call
1962
1963 @RMethod window-iconify
1964 @lisp
1965 (window-iconify window)
1966 @end lisp
1967
1968 Asks to iconify (i.e. minimize) the specified @var{window} (a @ref{gtk-window}). Note that you shouldn't assume the window is definitely iconified afterward, because other entities (e.g. the user or window manager) could deiconify it again, or there may not be a window manager in which case iconification isn't possible, etc. But normally the window will end up iconified. Just don't write code that crashes if not.
1969
1970 It's permitted to call this function before showing a window, in which case the window will be iconified before it ever appears onscreen.
1971
1972 You can track iconification via the @SignalRef{widget,window-state-event} signal on GtkWidget.
1973
1974 @RMethod window-deiconify
1975 @lisp
1976 (window-deiconify window)
1977 @end lisp
1978
1979 Asks to deiconify (i.e. unminimize) the specified window. Note that you shouldn't assume the window is definitely deiconified afterward, because other entities (e.g. the user or window manager) could iconify it again before your code which assumes deiconification gets to run.
1980
1981 You can track iconification via the @SignalRef{widget,window-state-event}.
1982
1983 @RMethod window-stick
1984 @lisp
1985 (window-stick window)
1986 @end lisp
1987 Asks to stick @var{window} (a @ref{gtk-window}), which means that it will appear on all user desktops. Note that you shouldn't assume the window is definitely stuck afterward, because other entities (e.g. the user or window manager) could unstick it again, and some window managers do not support sticking windows. But normally the window will end up stuck. Just don't write code that crashes if not.
1988
1989 It's permitted to call this function before showing a window.
1990
1991 You can track stickiness via the @SignalRef{widget,window-state-event} signal.
1992
1993 @RMethod window-unstick
1994 @lisp
1995 (window-unstick window)
1996 @end lisp
1997 Asks to unstick @var{window} (a @ref{gtk-window}), which means that it will appear on only one of the user's desktops. Note that you shouldn't assume the window is definitely unstuck afterward, because other entities (e.g. the user or window manager) could stick it again. But normally the window will end up stuck. Just don't write code that crashes if not.
1998
1999 You can track stickiness via the @SignalRef{widget,window-state-event} signal.
2000
2001 @RMethod window-maximize
2002 @lisp
2003 (window-maximize window)
2004 @end lisp
2005
2006 Asks to maximize @var{window} (a @ref{gtk-window}), so that it becomes full-screen. Note that you shouldn't assume the window is definitely maximized afterward, because other entities (e.g. the user or window manager) could unmaximize it again, and not all window managers support maximization. But normally the window will end up maximized. Just don't write code that crashes if not.
2007
2008 It's permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially.
2009
2010 You can track maximization via the @SignalRef{widget,window-state-event} signal.
2011
2012 @RMethod window-unmaximize
2013 @lisp
2014 (window-unmaximize window)
2015 @end lisp
2016
2017 Asks to unmaximize @var{window} (a @ref{gtk-window}). Note that you shouldn't assume the window is definitely unmaximized afterward, because other entities (e.g. the user or window manager) could maximize it again, and not all window managers honor requests to unmaximize. But normally the window will end up unmaximized. Just don't write code that crashes if not.
2018
2019 You can track maximization via the @SignalRef{widget,window-state-event} signal on GtkWidget.
2020
2021 @RMethod window-fullscreen
2022 @lisp
2023 (window-fullscreen window)
2024 @end lisp
2025
2026 Asks to place @var{window} (a @ref{gtk-window}) in the fullscreen state. Note that you shouldn't assume the window is definitely full screen afterward, because other entities (e.g. the user or window manager) could unfullscreen it again, and not all window managers honor requests to fullscreen windows. But normally the window will end up fullscreen. Just don't write code that crashes if not.
2027
2028 You can track the fullscreen state via the @SignalRef{widget,window-state-event} signal.
2029
2030 @RMethod window-unfullscreen
2031 @lisp
2032 (window-unfullscreen window)
2033 @end lisp
2034
2035 Asks to toggle off the fullscreen state for @var{window} (a @ref{gtk-window}). Note that you shouldn't assume the window is definitely not full screen afterward, because other entities (e.g. the user or window manager) could fullscreen it again, and not all window managers honor requests to unfullscreen windows. But normally the window will end up restored to its normal state. Just don't write code that crashes if not.
2036
2037 You can track the fullscreen state via the @SignalRef{widget,window-state-event} signal.
2038
2039 @RMethod window-set-keep-above
2040 @lisp
2041 (window-set-keep-above window setting)
2042 @end lisp
2043
2044 Asks to keep @var{window} (a @ref{gtk-window}) above, so that it stays on top. Note that you shouldn't assume the window is definitely above afterward, because other entities (e.g. the user or window manager) could not keep it above, and not all window managers support keeping windows above. But normally the window will end kept above. Just don't write code that crashes if not.
2045
2046 It's permitted to call this function before showing a window, in which case the window will be kept above when it appears onscreen initially.
2047
2048 You can track the above state via the @SignalRef{widget,window-state-event} signal.
2049
2050 Note that, according to the Extended Window Manager Hints specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.
2051
2052 @var{setting}: a boolean; whether to keep @var{window} above other windows
2053
2054 @RMethod window-set-keep-below
2055 @lisp
2056 (window-set-keep-below window setting)
2057 @end lisp
2058 Asks to keep window below, so that it stays in bottom. Note that you shouldn't assume the window is definitely below afterward, because other entities (e.g. the user or window manager) could not keep it below, and not all window managers support putting windows below. But normally the window will be kept below. Just don't write code that crashes if not.
2059
2060 It's permitted to call this function before showing a window, in which case the window will be kept below when it appears onscreen initially.
2061
2062 You can track the below state via the "window-state-event" signal on GtkWidget.
2063
2064 Note that, according to the Extended Window Manager Hints specification, the above state is mainly meant for user preferences and should not be used by applications e.g. for drawing attention to their dialogs.
2065
2066 @var{setting}: a boolean; whether to keep window below other windows
2067
2068 @RMethod window-begin-resize-drag
2069 @lisp
2070 (window-begin-resize-drag window edge button root-x root-y timestamp)
2071 @end lisp
2072
2073 Starts resizing a @var{window} (a @ref{gtk-window}). This function is used if an application has window resizing controls. When GDK can support it, the resize will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window resizing, potentially not all that well, depending on the windowing system.
2074
2075 @var{edge}: a @ref{window-edge}; position of the resize control
2076
2077 @var{button}: an integer; mouse button that initiated the drag
2078
2079 @var{root-x}: an integer; X position where the user clicked to initiate the drag, in root window coordinates
2080
2081 @var{root-y}: an integer; Y position where the user clicked to initiate the drag
2082
2083 @var{timestamp}: timestamp from the click event that initiated the drag
2084
2085 @RMethod window-begin-move-drag
2086 @lisp
2087 (window-begin-move-drag window button root-x root-y timestamp)
2088 @end lisp
2089
2090 Starts moving a window. This function is used if an application has window movement grips. When GDK can support it, the window movement will be done using the standard mechanism for the window manager or windowing system. Otherwise, GDK will try to emulate window movement, potentially not all that well, depending on the windowing system.
2091
2092 @var{edge}: a @ref{window-edge}; position of the resize control
2093
2094 @var{button}: an integer; mouse button that initiated the drag
2095
2096 @var{root-x}: an integer; X position where the user clicked to initiate the drag, in root window coordinates
2097
2098 @var{root-y}: an integer; Y position where the user clicked to initiate the drag
2099
2100 @var{timestamp}: timestamp from the click event that initiated the drag
2101
2102 @RMethod window-set-frame-dimensions
2103 @lisp
2104 (window-set-frame-dimensions window left top right bottom)
2105 @end lisp
2106
2107 (Note: this is a special-purpose function intended for the framebuffer port; see @SlotRef{gtk-window,has-frame}. It will have no effect on the window border drawn by the window manager, which is the normal case when using the X Window system.)
2108
2109 For windows with frames this function can be used to change the size of the frame border.
2110
2111 @var{window}: a @ref{gtk-window}
2112
2113 @var{left}, @var{top}, @var{right}, @var{bottom} - integers; sizes of left, top, right, bottom borders
2114
2115 @RFunction window-default-icon-list
2116 @lisp
2117 (window-default-icon-list) @result icons
2118 (setf (window-default-icon-list) icons)
2119 @end lisp
2120
2121 An icon list to be used as fallback for windows that haven't had @SlotRef{gtk-window,icon-list} set on them to set up a window-specific icon list. This function allows you to set up the icon for all windows in your app at once.
2122
2123 @var{icons}: a list of @ref{pixbuf}s.
2124
2125 @RFunction window-default-icon
2126 @lisp
2127 (setf (window-default-icon) icon)
2128 @end lisp
2129
2130 Sets an @var{icon} (a @ref{pixbuf}) to be used as fallback for windows that haven't had @SlotRef{gtk-window,icon} set on them from a pixbuf.
2131
2132 @RFunction window-default-icon-name
2133 @lisp
2134 (setf (window-default-icon-name) name)
2135 @end lisp
2136
2137 Sets an icon (a @code{string} - the name of the themed icon) to be used as fallback for windows.
2138
2139 @RMethod window-move
2140 @lisp
2141 (window-move window x y)
2142 @end lisp
2143
2144 Asks the window manager to move @var{window} (a @ref{gtk-window}) to the given position (defined by integers @var{x}, @var{y}). Window managers are free to ignore this; most window managers ignore requests for initial window positions (instead using a user-defined placement algorithm) and honor requests after the window has already been shown.
2145
2146 Note: the position is the position of the gravity-determined reference point for the window. The gravity determines two things: first, the location of the reference point in root window coordinates; and second, which point on the window is positioned at the reference point.
2147
2148 By default the gravity is @EnumVRef{gravity,north-west}, so the reference point is simply the x, y supplied. The top-left corner of the window decorations (aka window frame or border) will be placed at x, y. Therefore, to position a window at the top left of the screen, you want to use the default gravity (which is @EnumVRef{gravity,north-west}) and move the window to 0,0.
2149
2150 To position a window at the bottom right corner of the screen, you would set @EnumVRef{gravity,south-east}, which means that the reference point is at x + the window width and y + the window height, and the bottom-right corner of the window border will be placed at that reference point. So, to place a window in the bottom right corner you would first set gravity to south east, then write: gtk_window_move (window, gdk_screen_width() - window_width, gdk_screen_height() - window_height) (note that this example does not take multi-head scenarios into account).
2151
2152 The Extended Window Manager Hints specification at http://www.freedesktop.org/Standards/wm-spec has a nice table of gravities in the "implementation notes" section.
2153
2154 @RMethod window-resize
2155 @lisp
2156 (window-resize window width height)
2157 @end lisp
2158
2159 Resizes the @var{window} (a @ref{gtk-window}) to @var{width} pixels by @var{height} pixels as if the user had done so, obeying geometry constraints. The default geometry constraint is that windows may not be smaller than their size request (see @SlotRef{widget,width-request}, @SlotRef{widget,height-request}).
2160
2161 If @ref{window-resize} is called before showing a window for the first time, it overrides any default size set with @SlotRef{gtk-window,default-width}, @SlotRef{gtk-window,default-height}.
2162
2163 Windows may not be resized smaller than 1 by 1 pixels.
2164
2165 @node h-box
2166 @section h-box
2167 @Class h-box
2168 Superclass: @ref{box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
2169
2170 Subclasses: @ref{statusbar} @ref{file-chooser-button}
2171
2172 Slots:
2173 @itemize
2174 @end itemize
2175
2176
2177 Signals:
2178 @itemize
2179 @end itemize
2180
2181
2182
2183
2184 @node h-button-box
2185 @section h-button-box
2186 @Class h-button-box
2187 Superclass: @ref{button-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
2188
2189 Slots:
2190 @itemize
2191 @end itemize
2192
2193
2194 Signals:
2195 @itemize
2196 @end itemize
2197
2198
2199
2200
2201 @node h-paned
2202 @section h-paned
2203 @Class h-paned
2204 Superclass: @ref{paned} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
2205
2206 Slots:
2207 @itemize
2208 @end itemize
2209
2210
2211 Signals:
2212 @itemize
2213 @end itemize
2214
2215
2216
2217
2218 @node h-ruler
2219 @section h-ruler
2220 @Class h-ruler
2221 Superclass: @ref{ruler} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
2222
2223 Slots:
2224 @itemize
2225 @end itemize
2226
2227
2228 Signals:
2229 @itemize
2230 @end itemize
2231
2232
2233
2234
2235 @node h-s-v
2236 @section h-s-v
2237 @Class h-s-v
2238 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
2239
2240 Slots:
2241 @itemize
2242 @end itemize
2243
2244
2245 Signals:
2246 @itemize
2247 @item @anchor{signal.h-s-v.changed}"changed". Signature: (instance @ref{h-s-v}) @result{} void. Options: run-first.
2248 @item @anchor{signal.h-s-v.move}"move". Signature: (instance @ref{h-s-v}), (arg-1 @ref{direction-type}) @result{} void. Options: run-last, action.
2249 @end itemize
2250
2251
2252
2253
2254 @node h-scale
2255 @section h-scale
2256 @Class h-scale
2257 Superclass: @ref{scale} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
2258
2259 The @ref{h-scale} widget is used to allow the user to select a value using a horizontal slider.
2260
2261 The position to show the current value, and the number of decimal places shown can be set using the parent @ref{scale} class's functions.
2262
2263 Slots:
2264 @itemize
2265 @end itemize
2266
2267
2268 Signals:
2269 @itemize
2270 @end itemize
2271
2272
2273
2274
2275 @node h-scrollbar
2276 @section h-scrollbar
2277 @Class h-scrollbar
2278 Superclass: @ref{scrollbar} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
2279
2280 Slots:
2281 @itemize
2282 @end itemize
2283
2284
2285 Signals:
2286 @itemize
2287 @end itemize
2288
2289
2290
2291
2292 @node h-separator
2293 @section h-separator
2294 @Class h-separator
2295 Superclass: @ref{separator} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
2296
2297 Slots:
2298 @itemize
2299 @end itemize
2300
2301
2302 Signals:
2303 @itemize
2304 @end itemize
2305
2306
2307
2308
2309 @node handle-box
2310 @section handle-box
2311 @Class handle-box
2312 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
2313
2314 Slots:
2315 @itemize
2316 @item @anchor{slot.handle-box.child-detached}child-detached. Type: @code{boolean}. Accessor: @anchor{fn.handle-box-child-detached}@code{handle-box-child-detached}. Read-only.
2317 @item @anchor{slot.handle-box.handle-position}handle-position. Type: @ref{position-type}. Accessor: @anchor{fn.handle-box-handle-position}@code{handle-box-handle-position}.
2318 @item @anchor{slot.handle-box.shadow}shadow. Type: @ref{shadow-type}. Accessor: @anchor{fn.handle-box-shadow}@code{handle-box-shadow}.
2319 @item @anchor{slot.handle-box.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.handle-box-shadow-type}@code{handle-box-shadow-type}.
2320 @item @anchor{slot.handle-box.snap-edge}snap-edge. Type: @ref{position-type}. Accessor: @anchor{fn.handle-box-snap-edge}@code{handle-box-snap-edge}.
2321 @item @anchor{slot.handle-box.snap-edge-set}snap-edge-set. Type: @code{boolean}. Accessor: @anchor{fn.handle-box-snap-edge-set}@code{handle-box-snap-edge-set}.
2322 @end itemize
2323
2324
2325 Signals:
2326 @itemize
2327 @item @anchor{signal.handle-box.child-attached}"child-attached". Signature: (instance @ref{handle-box}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
2328 @item @anchor{signal.handle-box.child-detached}"child-detached". Signature: (instance @ref{handle-box}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
2329 @end itemize
2330
2331
2332
2333
2334 @node icon-view
2335 @section icon-view
2336 @Class icon-view
2337 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-layout}
2338
2339 Slots:
2340 @itemize
2341 @item @anchor{slot.icon-view.column-spacing}column-spacing. Type: @code{integer}. Accessor: @anchor{fn.icon-view-column-spacing}@code{icon-view-column-spacing}.
2342 @item @anchor{slot.icon-view.columns}columns. Type: @code{integer}. Accessor: @anchor{fn.icon-view-columns}@code{icon-view-columns}.
2343 @item @anchor{slot.icon-view.item-width}item-width. Type: @code{integer}. Accessor: @anchor{fn.icon-view-item-width}@code{icon-view-item-width}.
2344 @item @anchor{slot.icon-view.margin}margin. Type: @code{integer}. Accessor: @anchor{fn.icon-view-margin}@code{icon-view-margin}.
2345 @item @anchor{slot.icon-view.markup-column}markup-column. Type: @code{integer}. Accessor: @anchor{fn.icon-view-markup-column}@code{icon-view-markup-column}.
2346 @item @anchor{slot.icon-view.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.icon-view-model}@code{icon-view-model}.
2347 @item @anchor{slot.icon-view.orientation}orientation. Type: @ref{orientation}. Accessor: @anchor{fn.icon-view-orientation}@code{icon-view-orientation}.
2348 @item @anchor{slot.icon-view.pixbuf-column}pixbuf-column. Type: @code{integer}. Accessor: @anchor{fn.icon-view-pixbuf-column}@code{icon-view-pixbuf-column}.
2349 @item @anchor{slot.icon-view.reorderable}reorderable. Type: @code{boolean}. Accessor: @anchor{fn.icon-view-reorderable}@code{icon-view-reorderable}.
2350 @item @anchor{slot.icon-view.row-spacing}row-spacing. Type: @code{integer}. Accessor: @anchor{fn.icon-view-row-spacing}@code{icon-view-row-spacing}.
2351 @item @anchor{slot.icon-view.selection-mode}selection-mode. Type: @ref{selection-mode}. Accessor: @anchor{fn.icon-view-selection-mode}@code{icon-view-selection-mode}.
2352 @item @anchor{slot.icon-view.spacing}spacing. Type: @code{integer}. Accessor: @anchor{fn.icon-view-spacing}@code{icon-view-spacing}.
2353 @item @anchor{slot.icon-view.text-column}text-column. Type: @code{integer}. Accessor: @anchor{fn.icon-view-text-column}@code{icon-view-text-column}.
2354 @item @anchor{slot.icon-view.tooltip-column}tooltip-column. Type: @code{integer}. Accessor: @anchor{fn.icon-view-tooltip-column}@code{icon-view-tooltip-column}.
2355 @end itemize
2356
2357
2358 Signals:
2359 @itemize
2360 @item @anchor{signal.icon-view.activate-cursor-item}"activate-cursor-item". Signature: (instance @ref{icon-view}) @result{} @code{boolean}. Options: run-last, action.
2361 @item @anchor{signal.icon-view.item-activated}"item-activated". Signature: (instance @ref{icon-view}), (arg-1 @ref{tree-path}) @result{} void. Options: run-last.
2362 @item @anchor{signal.icon-view.move-cursor}"move-cursor". Signature: (instance @ref{icon-view}), (arg-1 @ref{movement-step}), (arg-2 @code{integer}) @result{} @code{boolean}. Options: run-last, action.
2363 @item @anchor{signal.icon-view.select-all}"select-all". Signature: (instance @ref{icon-view}) @result{} void. Options: run-last, action.
2364 @item @anchor{signal.icon-view.select-cursor-item}"select-cursor-item". Signature: (instance @ref{icon-view}) @result{} void. Options: run-last, action.
2365 @item @anchor{signal.icon-view.selection-changed}"selection-changed". Signature: (instance @ref{icon-view}) @result{} void. Options: run-first.
2366 @item @anchor{signal.icon-view.set-scroll-adjustments}"set-scroll-adjustments". Signature: (instance @ref{icon-view}), (arg-1 @ref{adjustment}), (arg-2 @ref{adjustment}) @result{} void. Options: run-last.
2367 @item @anchor{signal.icon-view.toggle-cursor-item}"toggle-cursor-item". Signature: (instance @ref{icon-view}) @result{} void. Options: run-last, action.
2368 @item @anchor{signal.icon-view.unselect-all}"unselect-all". Signature: (instance @ref{icon-view}) @result{} void. Options: run-last, action.
2369 @end itemize
2370
2371
2372
2373
2374 @node image
2375 @section image
2376 @Class image
2377 Superclass: @ref{misc} @ref{atk-implementor-iface} @ref{buildable}
2378
2379 The @ref{image} widget displays an image. Various kinds of object can be displayed as an image; most typically, you would load a @ref{pixbuf} ("pixel buffer") from a file, and then display that. There's an @SlotRef{image,file} slot (with @code{:file} initarg) that is used to load @ref{pixbuf} from file:
2380 @lisp
2381 (make-instance 'image :file "myfile.png")
2382 @end lisp
2383
2384 If the file isn't loaded successfully, the image will contain a "broken image" icon similar to that used in many web browsers. If you want to handle errors in loading the file yourself, for example by displaying an error message, then load the image and set the @SlotRef{image,pixbuf}.
2385
2386 The image file may contain an animation, if so the @ref{image} will display an animation (@ref{pixbuf-animation}) instead of a static image.
2387
2388 @ref{image} is a subclass of @ref{misc}, which implies that you can align it (center, left, right) and add padding to it, using @ref{misc} slot.
2389
2390 @ref{image} is a "no window" widget (has no @ref{gdk-window} of its own), so by default does not receive events. If you want to receive events on the image, such as button clicks, place the image inside a @ref{event-box}, then connect to the event signals on the event box.
2391
2392 When handling events on the event box, keep in mind that coordinates in the image may be different from event box coordinates due to the alignment and padding settings on the image (see @ref{misc}). The simplest way to solve this is to set the alignment to 0.0 (left/top), and set the padding to zero. Then the origin of the image will be the same as the origin of the event box.
2393
2394 @c Sometimes an application will want to avoid depending on external data files, such as image files. GTK+ comes with a program to avoid this, called gdk-pixbuf-csource. This program allows you to convert an image into a C variable declaration, which can then be loaded into a GdkPixbuf using gdk_pixbuf_new_from_inline().
2395
2396 Slots:
2397 @itemize
2398 @item @anchor{slot.image.file}file. Type: @code{string}. Accessor: @anchor{fn.image-file}@code{image-file}.
2399
2400 Filename to load and display.
2401
2402 Default value: NIL
2403 @item @anchor{slot.image.gicon}gicon. Type: @code{GIcon}. Accessor: @anchor{fn.image-gicon}@code{image-gicon}.
2404
2405 The GIcon displayed in the GtkImage. For themed icons, If the icon theme is changed, the image will be updated automatically.
2406
2407 TODO: GIcon is part of GIO library that is not yet supported by cl-gtk2
2408 @item @anchor{slot.image.icon-name}icon-name. Type: @code{string}. Accessor: @anchor{fn.image-icon-name}@code{image-icon-name}.
2409
2410 The name of the icon in the icon theme. If the icon theme is changed, the image will be updated automatically.
2411
2412 Default value: NIL
2413 @item @anchor{slot.image.icon-set}icon-set. Type: @code{GtkIconSet}. Accessor: @anchor{fn.image-icon-set}@code{image-icon-set}.
2414
2415 Icon set to display.
2416 @item @anchor{slot.image.icon-size}icon-size. Type: @code{integer}. Accessor: @anchor{fn.image-icon-size}@code{image-icon-size}.
2417
2418 Symbolic size to use for stock icon, icon set or named icon.
2419
2420 Allowed values: >= 0
2421
2422 Default value: 4
2423 @item @anchor{slot.image.image}image. Type: @ref{gdk-image}. Accessor: @anchor{fn.image-image}@code{image-image}.
2424
2425 A GdkImage to display.
2426 @item @anchor{slot.image.mask}mask. Type: @ref{pixmap}. Accessor: @anchor{fn.image-mask}@code{image-mask}.
2427
2428 Mask bitmap to use with @ref{gdk-image} or @ref{pixmap}.
2429 @item @anchor{slot.image.pixbuf}pixbuf. Type: @ref{pixbuf}. Accessor: @anchor{fn.image-pixbuf}@code{image-pixbuf}.
2430
2431 A @ref{pixbuf} to display.
2432 @item @anchor{slot.image.pixbuf-animation}pixbuf-animation. Type: @ref{pixbuf-animation}. Accessor: @anchor{fn.image-pixbuf-animation}@code{image-pixbuf-animation}.
2433
2434 @ref{pixbuf-animation} to display.
2435 @item @anchor{slot.image.pixel-size}pixel-size. Type: @code{integer}. Accessor: @anchor{fn.image-pixel-size}@code{image-pixel-size}.
2436
2437 This property can be used to specify a fixed size overriding the @SlotRef{image,icon-size} property for images of type @EnumVRef{image-type,icon-name}.
2438
2439 Default value: -1
2440 @item @anchor{slot.image.pixmap}pixmap. Type: @ref{pixmap}. Accessor: @anchor{fn.image-pixmap}@code{image-pixmap}.
2441
2442 A @ref{pixmap} to display.
2443 @item @anchor{slot.image.stock}stock. Type: @code{string}. Accessor: @anchor{fn.image-stock}@code{image-stock}.
2444
2445 Stock ID for a stock image to display.
2446
2447 Default value: NIL
2448 @item @anchor{slot.image.storage-type}storage-type. Type: @ref{image-type}. Accessor: @anchor{fn.image-storage-type}@code{image-storage-type}. Read-only.
2449
2450 The representation being used for image data.
2451
2452 Default value: @EnumVRef{image-type,empty}
2453 @end itemize
2454
2455
2456 Signals:
2457 @itemize
2458 @end itemize
2459
2460
2461
2462
2463 @node image-menu-item
2464 @section image-menu-item
2465 @Class image-menu-item
2466 Superclass: @ref{menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2467
2468 Slots:
2469 @itemize
2470 @item @anchor{slot.image-menu-item.accel-group}accel-group. Type: @ref{accel-group}. Accessor: @anchor{fn.image-menu-item-accel-group}@code{image-menu-item-accel-group}. Write-only.
2471 @item @anchor{slot.image-menu-item.always-show-image}always-show-image. Type: @code{boolean}. Accessor: @anchor{fn.image-menu-item-always-show-image}@code{image-menu-item-always-show-image}.
2472 @item @anchor{slot.image-menu-item.image}image. Type: @ref{widget}. Accessor: @anchor{fn.image-menu-item-image}@code{image-menu-item-image}.
2473 @item @anchor{slot.image-menu-item.use-stock}use-stock. Type: @code{boolean}. Accessor: @anchor{fn.image-menu-item-use-stock}@code{image-menu-item-use-stock}.
2474 @end itemize
2475
2476
2477 Signals:
2478 @itemize
2479 @end itemize
2480
2481
2482
2483
2484 @node input-dialog
2485 @section input-dialog
2486 @Class input-dialog
2487 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
2488
2489 Slots:
2490 @itemize
2491 @end itemize
2492
2493
2494 Signals:
2495 @itemize
2496 @item @anchor{signal.input-dialog.disable-device}"disable-device". Signature: (instance @ref{input-dialog}), (arg-1 @code{GdkDevice}) @result{} void. Options: run-last.
2497 @item @anchor{signal.input-dialog.enable-device}"enable-device". Signature: (instance @ref{input-dialog}), (arg-1 @code{GdkDevice}) @result{} void. Options: run-last.
2498 @end itemize
2499
2500
2501
2502
2503 @node invisible
2504 @section invisible
2505 @Class invisible
2506 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
2507
2508 The @ref{invisible} widget is used internally in GTK+, and is probably not very useful for application developers.
2509
2510 It is used for reliable pointer grabs and selection handling in the code for drag-and-drop.
2511
2512 Slots:
2513 @itemize
2514 @item @anchor{slot.invisible.screen}screen. Type: @ref{screen}. Accessor: @anchor{fn.invisible-screen}@code{invisible-screen}.
2515
2516 The @ref{screen} where this window will be displayed.
2517 @end itemize
2518
2519
2520 Signals:
2521 @itemize
2522 @end itemize
2523
2524
2525
2526
2527 @node item
2528 @section item
2529 @Class item
2530 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
2531
2532 Subclasses: @ref{menu-item}
2533
2534 Slots:
2535 @itemize
2536 @end itemize
2537
2538
2539 Signals:
2540 @itemize
2541 @item @anchor{signal.item.deselect}"deselect". Signature: (instance @ref{item}) @result{} void. Options: run-first.
2542 @item @anchor{signal.item.select}"select". Signature: (instance @ref{item}) @result{} void. Options: run-first.
2543 @item @anchor{signal.item.toggle}"toggle". Signature: (instance @ref{item}) @result{} void. Options: run-first.
2544 @end itemize
2545
2546
2547
2548
2549 @node label
2550 @section label
2551 @Class label
2552 Superclass: @ref{misc} @ref{atk-implementor-iface} @ref{buildable}
2553
2554 Subclasses: @ref{accel-label}
2555
2556 The @ref{label} widget displays a small amount of text. As the name implies, most labels are used to label another widget such as a @ref{button}, or a @ref{menu-item}.
2557
2558 @chapheading Mnemonics
2559
2560 Labels may contain mnemonics. Mnemonics are underlined characters in the label, used for keyboard navigation. Mnemonics are created by providing a string with an underscore before the mnemonic character, such as "_File", to @SlotRef{label,label} and setting @SlotRef{label,use-underline} to True.
2561
2562 Mnemonics automatically activate any activatable widget the label is inside, such as a @ref{button}; if the label is not inside the mnemonic's target widget, you have to tell the label about the target by settings @SlotRef{label,mnemonic-widget}. Here's a simple example where the label is inside a button:
2563
2564 @chapheading Markup (styled text)
2565
2566 To make it easy to format text in a label (changing colors, fonts, etc.), label text can be provided in a simple markup format. Set @SlotRef{label,use-markup} to True if @SlotRef{label,label} contains markup. Here's how to create a label with a small font:
2567 @lisp
2568 (make-instance 'label :label "<small>Small text</small>" :use-markup t)
2569 @end lisp
2570 (See @uref{http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html,,complete documentation} of available tags in the Pango manual.)
2571
2572 The markup passed to @SlotRef{label,label} must be valid; for example, literal @code{</>/&} characters must be escaped as @code{&lt;}, @code{&gt;}, and @code{&amp;}. If you pass text obtained from the user, file, or a network, you'll want to escape it with g_markup_escape_text() or g_markup_printf_escaped(). (TODO: these functions are not supported yet in cl-gtk2)
2573
2574 Markup strings are just a convenient way to set the PangoAttrList on a label; @SlotRef{label,attributes} may be a simpler way to set attributes in some cases. Be careful though; PangoAttrList tends to cause internationalization problems, unless you're applying attributes to the entire string (i.e. unless you set the range of each attribute to [0, G_MAXINT)). The reason is that specifying the start_index and end_index for a PangoAttribute requires knowledge of the exact string being displayed, so translations will cause problems.
2575
2576 @chapheading Selectable labels
2577
2578 Labels can be made selectable with @SlotRef{label,selectable}. Selectable labels allow the user to copy the label contents to the clipboard. Only labels that contain useful-to-copy information - such as error messages - should be made selectable.
2579
2580 @chapheading Text layout
2581
2582 A label can contain any number of paragraphs, but will have performance problems if it contains more than a small number. Paragraphs are separated by newlines or other paragraph separators understood by Pango.
2583
2584 Labels can automatically wrap text if you call @SlotRef{label,line-wrap}.
2585
2586 @SlotRef{label,justify} sets how the lines in a label align with one another. If you want to set how the label as a whole aligns in its available space, see @SlotRef{misc,xalign} and @SlotRef{misc,yalign}.
2587
2588 Slots:
2589 @itemize
2590 @item @anchor{slot.label.angle}angle. Type: @code{double-float}. Accessor: @anchor{fn.label-angle}@code{label-angle}.
2591
2592 The angle that the baseline of the label makes with the horizontal, in degrees, measured counterclockwise. An angle of 90 reads from from bottom to top, an angle of 270, from top to bottom. Ignored if the label is selectable, wrapped, or ellipsized.
2593
2594 Allowed values: [0,360]
2595
2596 Default value: 0
2597 @item @anchor{slot.label.attributes}attributes. Type: @code{PangoAttrList}. Accessor: @anchor{fn.label-attributes}@code{label-attributes}.
2598
2599 A list of style attributes to apply to the text of the label
2600 @item @anchor{slot.label.cursor-position}cursor-position. Type: @code{integer}. Accessor: @anchor{fn.label-cursor-position}@code{label-cursor-position}. Read-only.
2601
2602 The current position of the insertion cursor in chars.
2603
2604 Allowed values: >= 0
2605
2606 Default value: 0
2607 @item @anchor{slot.label.ellipsize}ellipsize. Type: @ref{pango-ellipsize-mode}. Accessor: @anchor{fn.label-ellipsize}@code{label-ellipsize}.
2608
2609 The preferred place to ellipsize the string, if the label does not have enough room to display the entire string.
2610
2611 Note that setting this property to a value other than @EnumVRef{pango-ellipsize-mode,none} has the side-effect that the label requests only enough space to display the ellipsis "...". In particular, this means that ellipsizing labels do not work well in notebook tabs, unless the tab's "tab-expand" property is set to True. Other ways to set a label's width are @SlotRef{widget,width-request} and @SlotRef{label,width-chars}.
2612
2613 Default value: @EnumVRef{pango-ellipsize-mode,none}
2614 @item @anchor{slot.label.justify}justify. Type: @ref{justification}. Accessor: @anchor{fn.label-justify}@code{label-justify}.
2615
2616 The alignment of the lines in the text of the label relative to each other. This does NOT affect the alignment of the label within its allocation. See @SlotRef{misc,xalign} for that.
2617
2618 Default value: @EnumVRef{justification,left}
2619 @item @anchor{slot.label.label}label. Type: @code{string}. Accessor: @anchor{fn.label-label}@code{label-label}.
2620
2621 The text of the label.
2622
2623 Default value: ""
2624 @item @anchor{slot.label.layout}layout. Type: @ref{g-object}. Accessor: @anchor{fn.label-layout}@code{label-layout}. Read-only.
2625
2626 Gets the PangoLayout used to display the label. The layout is useful to e.g. convert text positions to pixel positions, in combination with @SlotRef{label,layout-offsets}.
2627 @item @anchor{slot.label.layout-offsets}layout-offsets. Type: list of @code{integer}. Accessor: @anchor{fn.label-layout-offsets}@code{label-layout-offsets}. Read-only.
2628
2629 The coordinates where the label will draw the @code{PangoLayout} representing the text in the label; useful to convert mouse events into coordinates inside the @code{PangoLayout}, e.g. to take some action if some part of the label is clicked. Of course you will need to create a @ref{event-box} to receive the events, and pack the label inside it, since labels are a no-window widgets. Remember when using the @code{PangoLayout} functions you need to convert to and from pixels using PANGO_PIXELS or PANGO_SCALE.
2630 @item @anchor{slot.label.line-wrap}line-wrap. Type: @code{boolean}. Accessor: @anchor{fn.label-line-wrap}@code{label-line-wrap}.
2631
2632 Whether lines in the label are automatically wrapped. True makes label break lines if text exceeds the widget's size. False lets the text get cut off by the edge of the widget if it exceeds the widget size.
2633
2634 Note that setting line wrapping to True does not make the label wrap at its parent container's width, because GTK+ widgets conceptually can't make their requisition depend on the parent container's size. For a label that wraps at a specific position, set the label's width using @SlotRef{widget,width-request}.
2635 @item @anchor{slot.label.line-wrap-mode}line-wrap-mode. Type: @ref{pango-wrap-mode}. Accessor: @anchor{fn.label-line-wrap-mode}@code{label-line-wrap-mode}.
2636
2637 If line wrapping is on (see @SlotRef{label,line-wrap}) this controls how the line wrapping is done. The default is @EnumVRef{pango-wrap-mode,word} which means wrap on word boundaries.
2638 @item @anchor{slot.label.max-width-chars}max-width-chars. Type: @code{integer}. Accessor: @anchor{fn.label-max-width-chars}@code{label-max-width-chars}.
2639
2640 The desired maximum width of the label, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the label will request space for no more than the requested number of characters. If the @SlotRef{label,width-chars} property is set to a positive value, then the @SlotRef{label,max-width-chars} property is ignored.
2641
2642 Default value: -1
2643 @item @anchor{slot.label.mnemonic-keyval}mnemonic-keyval. Type: @code{integer}. Accessor: @anchor{fn.label-mnemonic-keyval}@code{label-mnemonic-keyval}. Read-only.
2644
2645 The mnemonic accelerator key for this label.
2646
2647 Default value: 16777215
2648 @item @anchor{slot.label.mnemonic-widget}mnemonic-widget. Type: @ref{widget}. Accessor: @anchor{fn.label-mnemonic-widget}@code{label-mnemonic-widget}.
2649
2650 The widget to be activated when the label's mnemonic key is pressed.
2651 @item @anchor{slot.label.pattern}pattern. Type: @code{string}. Accessor: @anchor{fn.label-pattern}@code{label-pattern}. Write-only.
2652
2653 A string with _ characters in positions correspond to characters in the text to underline.
2654
2655 Default value: NIL
2656 @item @anchor{slot.label.selectable}selectable. Type: @code{boolean}. Accessor: @anchor{fn.label-selectable}@code{label-selectable}.
2657
2658 Whether the label text can be selected with the mouse.
2659
2660 Default value: False
2661 @item @anchor{slot.label.selection-bound}selection-bound. Type: @code{integer}. Accessor: @anchor{fn.label-selection-bound}@code{label-selection-bound}. Read-only.
2662
2663 The position of the opposite end of the selection from the cursor in chars.
2664
2665 Allowed values: >= 0
2666
2667 Default value: 0
2668 @item @anchor{slot.label.selection-bounds}selection-bounds. Type: @code{(list integer integer)}. Accessor: @anchor{fn.label-selection-bounds}@code{label-selection-bounds}. Read-only.
2669
2670 Gets the selected range of characters in the label. Returns either NIL if there is no selection or list of two integers specifying character offsets of start and end of a selection
2671 @item @anchor{slot.label.single-line-mode}single-line-mode. Type: @code{boolean}. Accessor: @anchor{fn.label-single-line-mode}@code{label-single-line-mode}.
2672
2673 Whether the label is in single line mode. In single line mode, the height of the label does not depend on the actual text, it is always set to ascent + descent of the font. This can be an advantage in situations where resizing the label because of text changes would be distracting, e.g. in a statusbar.
2674
2675 Default value: False
2676 @item @anchor{slot.label.use-markup}use-markup. Type: @code{boolean}. Accessor: @anchor{fn.label-use-markup}@code{label-use-markup}.
2677
2678 The text of the label includes XML markup.
2679
2680 Default value: False
2681 @item @anchor{slot.label.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.label-use-underline}@code{label-use-underline}.
2682
2683 If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
2684
2685 Default value: False
2686 @item @anchor{slot.label.width-chars}width-chars. Type: @code{integer}. Accessor: @anchor{fn.label-width-chars}@code{label-width-chars}.
2687
2688 he desired width of the label, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the label will request either 3 characters or the property value, whichever is greater. If the @SlotRef{label,width-chars} property is set to a positive value, then the @SlotRef{label,max-width-chars} property is ignored.
2689
2690 Default value: -1
2691 @item @anchor{slot.label.wrap}wrap. Type: @code{boolean}. Accessor: @anchor{fn.label-wrap}@code{label-wrap}.
2692
2693 If set, wrap lines if the text becomes too wide.
2694
2695 Default value: False
2696 @item @anchor{slot.label.wrap-mode}wrap-mode. Type: @ref{pango-wrap-mode}. Accessor: @anchor{fn.label-wrap-mode}@code{label-wrap-mode}.
2697
2698 If line wrapping is on (see the @SlotRef{label,wrap} property) this controls how the line wrapping is done. The default is @EnumVRef{pango-wrap-mode,word}, which means wrap on word boundaries.
2699 @end itemize
2700
2701
2702 Signals:
2703 @itemize
2704 @item @anchor{signal.label.copy-clipboard}"copy-clipboard". Signature: (instance @ref{label}) @result{} void. Options: run-last, action.
2705
2706 This signal is a keybinding signal which gets emitted to copy the selection to the clipboard.
2707
2708 The default binding for this signal is Ctrl-c.
2709 @item @anchor{signal.label.move-cursor}"move-cursor". Signature: (instance @ref{label}), (step @ref{movement-step}), (count @code{integer}), (extend-selection @code{boolean}) @result{} void. Options: run-last, action.
2710
2711 This signal is a keybinding signal which gets emitted when the user initiates a cursor movement. If the cursor is not visible in entry, this signal causes the viewport to be moved instead.
2712
2713 Applications should not connect to it, but may emit it with @ref{emit-signal} if they need to control the cursor programmatically.
2714
2715 The default bindings for this signal come in two variants, the variant with the Shift modifier extends the selection, the variant without the Shift modifer does not. There are too many key combinations to list them all here.
2716
2717 @itemize
2718 @item Arrow keys move by individual characters/lines
2719 @item Ctrl-arrow key combinations move by words/paragraphs
2720 @item Home/End keys move to the ends of the buffer
2721 @end itemize
2722
2723
2724 @var{step}: the granularity of the move, as a GtkMovementStep
2725
2726 @var{count}: the number of step units to move
2727
2728 @var{extend-selection}: True if the move should extend the selection
2729 @item @anchor{signal.label.populate-popup}"populate-popup". Signature: (instance @ref{label}), (menu @ref{menu}) @result{} void. Options: run-last.
2730
2731 This signal gets emitted before showing the context menu of the label. Note that only selectable labels have context menus.
2732
2733 If you need to add items to the context menu, connect to this signal and append your menuitems to the menu.
2734 @end itemize
2735
2736
2737
2738
2739 @node layout
2740 @section layout
2741 @Class layout
2742 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
2743
2744 Slots:
2745 @itemize
2746 @item @anchor{slot.layout.bin-window}bin-window. Type: @ref{g-object}. Accessor: @anchor{fn.layout-bin-window}@code{layout-bin-window}. Read-only.
2747 @item @anchor{slot.layout.hadjustment}hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.layout-hadjustment}@code{layout-hadjustment}.
2748 @item @anchor{slot.layout.height}height. Type: @code{integer}. Accessor: @anchor{fn.layout-height}@code{layout-height}.
2749 @item @anchor{slot.layout.vadjustment}vadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.layout-vadjustment}@code{layout-vadjustment}.
2750 @item @anchor{slot.layout.width}width. Type: @code{integer}. Accessor: @anchor{fn.layout-width}@code{layout-width}.
2751 @end itemize
2752
2753
2754 Signals:
2755 @itemize
2756 @item @anchor{signal.layout.set-scroll-adjustments}"set-scroll-adjustments". Signature: (instance @ref{layout}), (arg-1 @ref{adjustment}), (arg-2 @ref{adjustment}) @result{} void. Options: run-last, action.
2757 @end itemize
2758
2759
2760
2761
2762 @node link-button
2763 @section link-button
2764 @Class link-button
2765 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2766
2767 A @ref{link-button} is a @ref{button} with a hyperlink, similar to the one used by web browsers, which triggers an action when clicked. It is useful to show quick links to resources.
2768
2769 @ref{link-button} offers a global hook, which is called when the used clicks on it: see @ref{link-button-global-uri-hook}.
2770
2771 Slots:
2772 @itemize
2773 @item @anchor{slot.link-button.uri}uri. Type: @code{string}. Accessor: @anchor{fn.link-button-uri}@code{link-button-uri}.
2774
2775 The URI bound to this button.
2776
2777 Default value: NIL
2778 @item @anchor{slot.link-button.visited}visited. Type: @code{boolean}. Accessor: @anchor{fn.link-button-visited}@code{link-button-visited}.
2779
2780 The 'visited' state of this button. A visited link is drawn in a different color.
2781
2782 Default value: False
2783 @end itemize
2784
2785
2786 Signals:
2787 @itemize
2788 @end itemize
2789
2790 @RFunction link-button-global-uri-hook
2791 @lisp
2792 (setf (link-button-gloval-uri-hook) function)
2793 @end lisp
2794
2795 Sets function as the function that should be invoked every time a user clicks a @ref{link-button}. This function is called before every callback registered for the @SignalRef{button,clicked} signal.
2796
2797 If @var{function} is NIL, GTK+ defaults to calling gtk_show_uri() (default function that opens the default application for a URI).
2798
2799 @var{function} is a function of two arguments: a @ref{link-button} and a @code{string}. First argument is the button that was clicked and the second is the URI of the button.
2800
2801 @node menu
2802 @section menu
2803 @Class menu
2804 Superclass: @ref{menu-shell} @ref{atk-implementor-iface} @ref{buildable}
2805
2806 Subclasses: @ref{recent-chooser-menu}
2807
2808 Slots:
2809 @itemize
2810 @item @anchor{slot.menu.accel-group}accel-group. Type: @ref{accel-group}. Accessor: @anchor{fn.menu-accel-group}@code{menu-accel-group}.
2811 @item @anchor{slot.menu.accel-path}accel-path. Type: @code{string}. Accessor: @anchor{fn.menu-accel-path}@code{menu-accel-path}.
2812 @item @anchor{slot.menu.active}active. Type: @code{integer}. Accessor: @anchor{fn.menu-active}@code{menu-active}.
2813 @item @anchor{slot.menu.attach-widget}attach-widget. Type: @ref{widget}. Accessor: @anchor{fn.menu-attach-widget}@code{menu-attach-widget}.
2814 @item @anchor{slot.menu.monitor}monitor. Type: @code{integer}. Accessor: @anchor{fn.menu-monitor}@code{menu-monitor}.
2815 @item @anchor{slot.menu.screen}screen. Type: @ref{g-object}. Accessor: @anchor{fn.menu-screen}@code{menu-screen}. Write-only.
2816 @item @anchor{slot.menu.tearoff-state}tearoff-state. Type: @code{boolean}. Accessor: @anchor{fn.menu-tearoff-state}@code{menu-tearoff-state}.
2817 @item @anchor{slot.menu.tearoff-title}tearoff-title. Type: @code{string}. Accessor: @anchor{fn.menu-tearoff-title}@code{menu-tearoff-title}.
2818 @end itemize
2819
2820
2821 Signals:
2822 @itemize
2823 @item @anchor{signal.menu.move-scroll}"move-scroll". Signature: (instance @ref{menu}), (arg-1 @ref{scroll-type}) @result{} void. Options: run-last, action.
2824 @end itemize
2825
2826
2827
2828
2829 @node menu-bar
2830 @section menu-bar
2831 @Class menu-bar
2832 Superclass: @ref{menu-shell} @ref{atk-implementor-iface} @ref{buildable}
2833
2834 Slots:
2835 @itemize
2836 @item @anchor{slot.menu-bar.child-pack-direction}child-pack-direction. Type: @ref{pack-direction}. Accessor: @anchor{fn.menu-bar-child-pack-direction}@code{menu-bar-child-pack-direction}.
2837 @item @anchor{slot.menu-bar.pack-direction}pack-direction. Type: @ref{pack-direction}. Accessor: @anchor{fn.menu-bar-pack-direction}@code{menu-bar-pack-direction}.
2838 @end itemize
2839
2840
2841 Signals:
2842 @itemize
2843 @end itemize
2844
2845
2846
2847
2848 @node menu-item
2849 @section menu-item
2850 @Class menu-item
2851 Superclass: @ref{item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2852
2853 Subclasses: @ref{tearoff-menu-item} @ref{separator-menu-item} @ref{image-menu-item} @ref{check-menu-item}
2854
2855 Slots:
2856 @itemize
2857 @item @anchor{slot.menu-item.accel-path}accel-path. Type: @code{string}. Accessor: @anchor{fn.menu-item-accel-path}@code{menu-item-accel-path}.
2858 @item @anchor{slot.menu-item.label}label. Type: @code{string}. Accessor: @anchor{fn.menu-item-label}@code{menu-item-label}.
2859 @item @anchor{slot.menu-item.right-justified}right-justified. Type: @code{boolean}. Accessor: @anchor{fn.menu-item-right-justified}@code{menu-item-right-justified}.
2860 @item @anchor{slot.menu-item.submenu}submenu. Type: @ref{menu}. Accessor: @anchor{fn.menu-item-submenu}@code{menu-item-submenu}.
2861 @item @anchor{slot.menu-item.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.menu-item-use-underline}@code{menu-item-use-underline}.
2862 @end itemize
2863
2864
2865 Signals:
2866 @itemize
2867 @item @anchor{signal.menu-item.activate}"activate". Signature: (instance @ref{menu-item}) @result{} void. Options: run-first, action.
2868 @item @anchor{signal.menu-item.activate-item}"activate-item". Signature: (instance @ref{menu-item}) @result{} void. Options: run-first.
2869 @item @anchor{signal.menu-item.toggle-size-allocate}"toggle-size-allocate". Signature: (instance @ref{menu-item}), (arg-1 @code{integer}) @result{} void. Options: run-first.
2870 @item @anchor{signal.menu-item.toggle-size-request}"toggle-size-request". Signature: (instance @ref{menu-item}), (arg-1 gpointer) @result{} void. Options: run-first.
2871 @end itemize
2872
2873
2874
2875
2876 @node menu-shell
2877 @section menu-shell
2878 @Class menu-shell
2879 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
2880
2881 Subclasses: @ref{menu-bar} @ref{menu}
2882
2883 Slots:
2884 @itemize
2885 @item @anchor{slot.menu-shell.take-focus}take-focus. Type: @code{boolean}. Accessor: @anchor{fn.menu-shell-take-focus}@code{menu-shell-take-focus}.
2886 @end itemize
2887
2888
2889 Signals:
2890 @itemize
2891 @item @anchor{signal.menu-shell.activate-current}"activate-current". Signature: (instance @ref{menu-shell}), (arg-1 @code{boolean}) @result{} void. Options: run-last, action.
2892 @item @anchor{signal.menu-shell.cancel}"cancel". Signature: (instance @ref{menu-shell}) @result{} void. Options: run-last, action.
2893 @item @anchor{signal.menu-shell.cycle-focus}"cycle-focus". Signature: (instance @ref{menu-shell}), (arg-1 @ref{direction-type}) @result{} void. Options: run-last, action.
2894 @item @anchor{signal.menu-shell.deactivate}"deactivate". Signature: (instance @ref{menu-shell}) @result{} void. Options: run-first.
2895 @item @anchor{signal.menu-shell.move-current}"move-current". Signature: (instance @ref{menu-shell}), (arg-1 @ref{menu-direction-type}) @result{} void. Options: run-last, action.
2896 @item @anchor{signal.menu-shell.move-selected}"move-selected". Signature: (instance @ref{menu-shell}), (arg-1 @code{integer}) @result{} @code{boolean}. Options: run-last.
2897 @item @anchor{signal.menu-shell.selection-done}"selection-done". Signature: (instance @ref{menu-shell}) @result{} void. Options: run-first.
2898 @end itemize
2899
2900
2901
2902
2903 @node menu-tool-button
2904 @section menu-tool-button
2905 @Class menu-tool-button
2906 Superclass: @ref{tool-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2907
2908 Slots:
2909 @itemize
2910 @item @anchor{slot.menu-tool-button.arrow-tooltip-markup}arrow-tooltip-markup. Type: @code{string}. Accessor: @anchor{fn.menu-tool-button-arrow-tooltip-markup}@code{menu-tool-button-arrow-tooltip-markup}. Write-only.
2911 @item @anchor{slot.menu-tool-button.arrow-tooltip-text}arrow-tooltip-text. Type: @code{string}. Accessor: @anchor{fn.menu-tool-button-arrow-tooltip-text}@code{menu-tool-button-arrow-tooltip-text}. Write-only.
2912 @item @anchor{slot.menu-tool-button.menu}menu. Type: @ref{menu}. Accessor: @anchor{fn.menu-tool-button-menu}@code{menu-tool-button-menu}.
2913 @end itemize
2914
2915
2916 Signals:
2917 @itemize
2918 @item @anchor{signal.menu-tool-button.show-menu}"show-menu". Signature: (instance @ref{menu-tool-button}) @result{} void. Options: run-first.
2919 @end itemize
2920
2921
2922
2923
2924 @node message-dialog
2925 @section message-dialog
2926 @Class message-dialog
2927 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
2928
2929 @ref{message-dialog} presents a dialog with an image representing the
2930 type of message (Error, Question, etc.) alongside some message
2931 text. It's simply a convenience widget; you could construct the
2932 equivalent of @ref{message-dialog} from @ref{dialog} without too much
2933 effort, but @ref{message-dialog} saves typing.
2934
2935 The easiest way to do a modal message dialog is to use gtk_dialog_run(),
2936 though you can also pass in the @FlagsVRef{dialog-flags,modal} flag,
2937 @ref{dialog-run} automatically makes the dialog modal and waits for the
2938 user to respond to it. @ref{dialog-run} returns when any dialog button
2939 is clicked.
2940
2941 Slots:
2942 @itemize
2943 @item @anchor{slot.message-dialog.buttons}buttons. Type: @ref{buttons-type}. Accessor: @anchor{fn.message-dialog-buttons}@code{message-dialog-buttons}. Write-only.
2944
2945 The buttons shown in the message dialog.
2946
2947 Default value: @EnumVRef{buttons-type,none}
2948 @item @anchor{slot.message-dialog.image}image. Type: @ref{widget}. Accessor: @anchor{fn.message-dialog-image}@code{message-dialog-image}.
2949
2950 The image for this dialog
2951 @item @anchor{slot.message-dialog.message-type}message-type. Type: @ref{message-type}. Accessor: @anchor{fn.message-dialog-message-type}@code{message-dialog-message-type}.
2952
2953 The type of the message. The type is used to determine the image that is shown in the dialog, unless the image is explicitly set by the @SlotRef{message-dialog,image} property.
2954
2955 Default value: @EnumVRef{message-type,info}
2956 @item @anchor{slot.message-dialog.secondary-text}secondary-text. Type: @code{string}. Accessor: @anchor{fn.message-dialog-secondary-text}@code{message-dialog-secondary-text}.
2957
2958 The secondary text of the message dialog.
2959
2960 Default value: NIL
2961 @item @anchor{slot.message-dialog.secondary-use-markup}secondary-use-markup. Type: @code{boolean}. Accessor: @anchor{fn.message-dialog-secondary-use-markup}@code{message-dialog-secondary-use-markup}.
2962
2963 True if the secondary text of the dialog includes Pango markup. See pango_parse_markup().
2964
2965 Default value: False
2966 @item @anchor{slot.message-dialog.text}text. Type: @code{string}. Accessor: @anchor{fn.message-dialog-text}@code{message-dialog-text}.
2967
2968 The primary text of the message dialog. If the dialog has a secondary text, this will appear as the title.
2969
2970 Default value: ""
2971 @item @anchor{slot.message-dialog.use-markup}use-markup. Type: @code{boolean}. Accessor: @anchor{fn.message-dialog-use-markup}@code{message-dialog-use-markup}.
2972
2973 True if the primary text of the dialog includes Pango markup. See pango_parse_markup().
2974
2975 Default value: False
2976 @end itemize
2977
2978
2979 Signals:
2980 @itemize
2981 @end itemize
2982
2983
2984 @node misc
2985 @section misc
2986 @Class misc
2987 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
2988
2989 Subclasses: @ref{image} @ref{arrow} @ref{label}
2990
2991 Slots:
2992 @itemize
2993 @item @anchor{slot.misc.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.misc-xalign}@code{misc-xalign}.
2994 @item @anchor{slot.misc.xpad}xpad. Type: @code{integer}. Accessor: @anchor{fn.misc-xpad}@code{misc-xpad}.
2995 @item @anchor{slot.misc.yalign}yalign. Type: @code{single-float}. Accessor: @anchor{fn.misc-yalign}@code{misc-yalign}.
2996 @item @anchor{slot.misc.ypad}ypad. Type: @code{integer}. Accessor: @anchor{fn.misc-ypad}@code{misc-ypad}.
2997 @end itemize
2998
2999
3000 Signals:
3001 @itemize
3002 @end itemize
3003
3004
3005
3006
3007 @node notebook
3008 @section notebook
3009 @Class notebook
3010 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3011
3012 Slots:
3013 @itemize
3014 @item @anchor{slot.notebook.enable-popup}enable-popup. Type: @code{boolean}. Accessor: @anchor{fn.notebook-enable-popup}@code{notebook-enable-popup}.
3015 @item @anchor{slot.notebook.group}group. Type: gpointer. Accessor: @anchor{fn.notebook-group}@code{notebook-group}.
3016 @item @anchor{slot.notebook.group-id}group-id. Type: @code{integer}. Accessor: @anchor{fn.notebook-group-id}@code{notebook-group-id}.
3017 @item @anchor{slot.notebook.homogeneous}homogeneous. Type: @code{boolean}. Accessor: @anchor{fn.notebook-homogeneous}@code{notebook-homogeneous}.
3018 @item @anchor{slot.notebook.page}page. Type: @code{integer}. Accessor: @anchor{fn.notebook-page}@code{notebook-page}.
3019 @item @anchor{slot.notebook.scrollable}scrollable. Type: @code{boolean}. Accessor: @anchor{fn.notebook-scrollable}@code{notebook-scrollable}.
3020 @item @anchor{slot.notebook.show-border}show-border. Type: @code{boolean}. Accessor: @anchor{fn.notebook-show-border}@code{notebook-show-border}.
3021 @item @anchor{slot.notebook.show-tabs}show-tabs. Type: @code{boolean}. Accessor: @anchor{fn.notebook-show-tabs}@code{notebook-show-tabs}.
3022 @item @anchor{slot.notebook.tab-border}tab-border. Type: @code{integer}. Accessor: @anchor{fn.notebook-tab-border}@code{notebook-tab-border}. Write-only.
3023 @item @anchor{slot.notebook.tab-hborder}tab-hborder. Type: @code{integer}. Accessor: @anchor{fn.notebook-tab-hborder}@code{notebook-tab-hborder}.
3024 @item @anchor{slot.notebook.tab-pos}tab-pos. Type: @ref{position-type}. Accessor: @anchor{fn.notebook-tab-pos}@code{notebook-tab-pos}.
3025 @item @anchor{slot.notebook.tab-vborder}tab-vborder. Type: @code{integer}. Accessor: @anchor{fn.notebook-tab-vborder}@code{notebook-tab-vborder}.
3026 @end itemize
3027
3028
3029 Signals:
3030 @itemize
3031 @item @anchor{signal.notebook.change-current-page}"change-current-page". Signature: (instance @ref{notebook}), (arg-1 @code{integer}) @result{} @code{boolean}. Options: run-last, action.
3032 @item @anchor{signal.notebook.create-window}"create-window". Signature: (instance @ref{notebook}), (arg-1 @ref{widget}), (arg-2 @code{integer}), (arg-3 @code{integer}) @result{} @ref{notebook}. Options: run-last.
3033 @item @anchor{signal.notebook.focus-tab}"focus-tab". Signature: (instance @ref{notebook}), (arg-1 @ref{notebook-tab}) @result{} @code{boolean}. Options: run-last, action.
3034 @item @anchor{signal.notebook.move-focus-out}"move-focus-out". Signature: (instance @ref{notebook}), (arg-1 @ref{direction-type}) @result{} void. Options: run-last, action.
3035 @item @anchor{signal.notebook.page-added}"page-added". Signature: (instance @ref{notebook}), (arg-1 @ref{widget}), (arg-2 @code{integer}) @result{} void. Options: run-last.
3036 @item @anchor{signal.notebook.page-removed}"page-removed". Signature: (instance @ref{notebook}), (arg-1 @ref{widget}), (arg-2 @code{integer}) @result{} void. Options: run-last.
3037 @item @anchor{signal.notebook.page-reordered}"page-reordered". Signature: (instance @ref{notebook}), (arg-1 @ref{widget}), (arg-2 @code{integer}) @result{} void. Options: run-last.
3038 @item @anchor{signal.notebook.reorder-tab}"reorder-tab". Signature: (instance @ref{notebook}), (arg-1 @ref{direction-type}), (arg-2 @code{boolean}) @result{} @code{boolean}. Options: run-last, action.
3039 @item @anchor{signal.notebook.select-page}"select-page". Signature: (instance @ref{notebook}), (arg-1 @code{boolean}) @result{} @code{boolean}. Options: run-last, action.
3040 @item @anchor{signal.notebook.switch-page}"switch-page". Signature: (instance @ref{notebook}), (arg-1 gpointer), (arg-2 @code{integer}) @result{} void. Options: run-last.
3041 @end itemize
3042
3043
3044
3045
3046 @node page-setup-unix-dialog
3047 @section page-setup-unix-dialog
3048 @Class page-setup-unix-dialog
3049 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
3050
3051 Slots:
3052 @itemize
3053 @item @anchor{slot.page-setup-unix-dialog.page-setup}page-setup. Type: @ref{page-setup}. Accessor: @anchor{fn.page-setup-unix-dialog-page-setup}@code{page-setup-unix-dialog-page-setup}.
3054 @item @anchor{slot.page-setup-unix-dialog.print-settings}print-settings. Type: @ref{print-settings}. Accessor: @anchor{fn.page-setup-unix-dialog-print-settings}@code{page-setup-unix-dialog-print-settings}.
3055 @end itemize
3056
3057
3058 Signals:
3059 @itemize
3060 @end itemize
3061
3062
3063 @node paned
3064 @section paned
3065 @Class paned
3066 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3067
3068 Subclasses: @ref{v-paned} @ref{h-paned}
3069
3070 Slots:
3071 @itemize
3072 @item @anchor{slot.paned.max-position}max-position. Type: @code{integer}. Accessor: @anchor{fn.paned-max-position}@code{paned-max-position}. Read-only.
3073 @item @anchor{slot.paned.min-position}min-position. Type: @code{integer}. Accessor: @anchor{fn.paned-min-position}@code{paned-min-position}. Read-only.
3074 @item @anchor{slot.paned.position}position. Type: @code{integer}. Accessor: @anchor{fn.paned-position}@code{paned-position}.
3075 @item @anchor{slot.paned.position-set}position-set. Type: @code{boolean}. Accessor: @anchor{fn.paned-position-set}@code{paned-position-set}.
3076 @end itemize
3077
3078
3079 Signals:
3080 @itemize
3081 @item @anchor{signal.paned.accept-position}"accept-position". Signature: (instance @ref{paned}) @result{} @code{boolean}. Options: run-last, action.
3082 @item @anchor{signal.paned.cancel-position}"cancel-position". Signature: (instance @ref{paned}) @result{} @code{boolean}. Options: run-last, action.
3083 @item @anchor{signal.paned.cycle-child-focus}"cycle-child-focus". Signature: (instance @ref{paned}), (arg-1 @code{boolean}) @result{} @code{boolean}. Options: run-last, action.
3084 @item @anchor{signal.paned.cycle-handle-focus}"cycle-handle-focus". Signature: (instance @ref{paned}), (arg-1 @code{boolean}) @result{} @code{boolean}. Options: run-last, action.
3085 @item @anchor{signal.paned.move-handle}"move-handle". Signature: (instance @ref{paned}), (arg-1 @ref{scroll-type}) @result{} @code{boolean}. Options: run-last, action.
3086 @item @anchor{signal.paned.toggle-handle-focus}"toggle-handle-focus". Signature: (instance @ref{paned}) @result{} @code{boolean}. Options: run-last, action.
3087 @end itemize
3088
3089
3090
3091
3092 @node plug
3093 @section plug
3094 @Class plug
3095 Superclass: @ref{gtk-window} @ref{atk-implementor-iface} @ref{buildable}
3096
3097 Slots:
3098 @itemize
3099 @item @anchor{slot.plug.embedded}embedded. Type: @code{boolean}. Accessor: @anchor{fn.plug-embedded}@code{plug-embedded}. Read-only.
3100 @item @anchor{slot.plug.socket-window}socket-window. Type: @ref{gdk-window}. Accessor: @anchor{fn.plug-socket-window}@code{plug-socket-window}. Read-only.
3101 @end itemize
3102
3103
3104 Signals:
3105 @itemize
3106 @item @anchor{signal.plug.embedded}"embedded". Signature: (instance @ref{plug}) @result{} void. Options: run-last.
3107 @end itemize
3108
3109
3110
3111
3112 @node print-unix-dialog
3113 @section print-unix-dialog
3114 @Class print-unix-dialog
3115 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
3116
3117 Slots:
3118 @itemize
3119 @item @anchor{slot.print-unix-dialog.current-page}current-page. Type: @code{integer}. Accessor: @anchor{fn.print-unix-dialog-current-page}@code{print-unix-dialog-current-page}.
3120 @item @anchor{slot.print-unix-dialog.page-setup}page-setup. Type: @ref{page-setup}. Accessor: @anchor{fn.print-unix-dialog-page-setup}@code{print-unix-dialog-page-setup}.
3121 @item @anchor{slot.print-unix-dialog.print-settings}print-settings. Type: @ref{print-settings}. Accessor: @anchor{fn.print-unix-dialog-print-settings}@code{print-unix-dialog-print-settings}.
3122 @item @anchor{slot.print-unix-dialog.selected-printer}selected-printer. Type: @code{GtkPrinter}. Accessor: @anchor{fn.print-unix-dialog-selected-printer}@code{print-unix-dialog-selected-printer}. Read-only.
3123 @end itemize
3124
3125
3126 Signals:
3127 @itemize
3128 @end itemize
3129
3130
3131 @node progress
3132 @section progress
3133 @Class progress
3134 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
3135
3136 Subclasses: @ref{progress-bar}
3137
3138 Slots:
3139 @itemize
3140 @item @anchor{slot.progress.activity-mode}activity-mode. Type: @code{boolean}. Accessor: @anchor{fn.progress-activity-mode}@code{progress-activity-mode}.
3141 @item @anchor{slot.progress.show-text}show-text. Type: @code{boolean}. Accessor: @anchor{fn.progress-show-text}@code{progress-show-text}.
3142 @item @anchor{slot.progress.text-xalign}text-xalign. Type: @code{single-float}. Accessor: @anchor{fn.progress-text-xalign}@code{progress-text-xalign}.
3143 @item @anchor{slot.progress.text-yalign}text-yalign. Type: @code{single-float}. Accessor: @anchor{fn.progress-text-yalign}@code{progress-text-yalign}.
3144 @end itemize
3145
3146
3147 Signals:
3148 @itemize
3149 @end itemize
3150
3151
3152
3153
3154 @node progress-bar
3155 @section progress-bar
3156 @Class progress-bar
3157 Superclass: @ref{progress} @ref{atk-implementor-iface} @ref{buildable}
3158
3159 The @ref{progress-bar} is typically used to display the progress of a long running operation. It provides a visual clue that processing is underway. The @ref{progress-bar} can be used in two different modes: percentage mode and activity  mode.
3160
3161 When an application can determine how much work needs to take place (e.g. read a fixed number of bytes from a file) and can monitor its progress, it can use the @ref{progress-bar} in percentage mode and the user sees a growing bar indicating the percentage of the work that has been completed. In this mode, the application is required to set @SlotRef{progress-bar,fraction} periodically to update the progress bar.
3162
3163 When an application has no accurate way of knowing the amount of work to do, it can use the @ref{progress-bar} in activity mode, which shows activity by a block moving back and forth within the progress area. In this mode, the application is required to call @ref{progress-bar-pulse} perodically to update the progress bar.
3164
3165 There is quite a bit of flexibility provided to control the appearance of the @ref{progress-bar}. Functions are provided to control the orientation of the bar, optional text can be displayed along with the bar, and the step size used in activity mode can be set.
3166
3167 Slots:
3168 @itemize
3169 @item @anchor{slot.progress-bar.activity-blocks}activity-blocks. Type: @code{integer}. Accessor: @anchor{fn.progress-bar-activity-blocks}@code{progress-bar-activity-blocks}.
3170
3171 The number of blocks which can fit in the progress bar area in activity mode (Deprecated).
3172
3173 Allowed values: >= 2
3174
3175 Default value: 5
3176 @item @anchor{slot.progress-bar.activity-step}activity-step. Type: @code{integer}. Accessor: @anchor{fn.progress-bar-activity-step}@code{progress-bar-activity-step}.
3177
3178 The increment used for each iteration in activity mode (Deprecated).
3179
3180 Default value: 3
3181 @item @anchor{slot.progress-bar.adjustment}adjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.progress-bar-adjustment}@code{progress-bar-adjustment}.
3182
3183 The @ref{adjustment} connected to the progress bar (Deprecated
3184 @item @anchor{slot.progress-bar.bar-style}bar-style. Type: @ref{progress-bar-style}. Accessor: @anchor{fn.progress-bar-bar-style}@code{progress-bar-bar-style}.
3185
3186 Specifies the visual style of the bar in percentage mode (Deprecated).
3187
3188 Default value: @EnumVRef{progress-bar-style,continuous}
3189 @item @anchor{slot.progress-bar.discrete-blocks}discrete-blocks. Type: @code{integer}. Accessor: @anchor{fn.progress-bar-discrete-blocks}@code{progress-bar-discrete-blocks}.
3190
3191 The number of discrete blocks in a progress bar (when shown in the discrete style).
3192
3193 Allowed values: >= 2
3194
3195 Default value: 10
3196 @item @anchor{slot.progress-bar.ellipsize}ellipsize. Type: @ref{pango-ellipsize-mode}. Accessor: @anchor{fn.progress-bar-ellipsize}@code{progress-bar-ellipsize}.
3197
3198 The preferred place to ellipsize the string, if the progressbar does not have enough room to display the entire string.
3199
3200 Note that setting this property to a value other than @EnumVRef{pango-ellipsize-mode,none} has the side-effect that the progressbar requests only enough space to display the ellipsis "...". Another means to set a progressbar's width is @SlotRef{widget,width-request}.
3201
3202 Default value: @EnumVRef{pango-ellipsize-mode,none}
3203 @item @anchor{slot.progress-bar.fraction}fraction. Type: @code{double-float}. Accessor: @anchor{fn.progress-bar-fraction}@code{progress-bar-fraction}.
3204
3205 The fraction of total work that has been completed.
3206
3207 Allowed values: [0,1]
3208
3209 Default value: 0
3210 @item @anchor{slot.progress-bar.orientation}orientation. Type: @ref{progress-bar-orientation}. Accessor: @anchor{fn.progress-bar-orientation}@code{progress-bar-orientation}.
3211
3212 Orientation and growth direction of the progress bar.
3213
3214 Default value: @EnumVRef{progress-bar-orientation,left-to-right}
3215 @item @anchor{slot.progress-bar.pulse-step}pulse-step. Type: @code{double-float}. Accessor: @anchor{fn.progress-bar-pulse-step}@code{progress-bar-pulse-step}.
3216
3217 The fraction of total progress to move the bouncing block when pulsed.
3218
3219 Allowed values: [0,1]
3220
3221 Default value: 0.1
3222 @item @anchor{slot.progress-bar.text}text. Type: @code{string}. Accessor: @anchor{fn.progress-bar-text}@code{progress-bar-text}.
3223
3224 Text to be displayed in the progress bar.
3225
3226 Default value: NIL
3227 @end itemize
3228
3229
3230 Signals:
3231 @itemize
3232 @end itemize
3233
3234 @RMethod progress-bar-pulse
3235 @lisp
3236 (progress-bar-pulse progress-bar)
3237 @end lisp
3238
3239 Indicates that some progress is made, but you don't know how much. Causes the progress bar to enter "activity mode," where a block bounces back and forth. Each call to @ref{progress-bar-pulse} causes the block to move by a little bit (the amount of movement per pulse is determined by @SlotRef{progress-bar,pulse-step}).
3240
3241 @node radio-button
3242 @section radio-button
3243 @Class radio-button
3244 Superclass: @ref{check-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3245
3246 A single radio button performs the same basic function as a @ref{check-button}, as its position in the object hierarchy reflects. It is only when multiple radio buttons are grouped together that they become a different user interface component in their own right.
3247
3248 Every radio button is a member of some group of radio buttons. When one is selected, all other radio buttons in the same group are deselected. A @ref{radio-button} is one way of giving the user a choice from many options.
3249
3250 To group radio buttons into one group, set @SlotRef{radio-button,group} to one of the radio buttons of the group.
3251
3252 Slots:
3253 @itemize
3254 @item @anchor{slot.radio-button.group}group. Type: @ref{radio-button}. Accessor: @anchor{fn.radio-button-group}@code{radio-button-group}. Write-only.
3255
3256 A button of the radio button group that this radio button belongs to
3257 @end itemize
3258
3259
3260 Signals:
3261 @itemize
3262 @item @anchor{signal.radio-button.group-changed}"group-changed". Signature: (instance @ref{radio-button}) @result{} void. Options: run-first.
3263
3264 Emitted when the group of radio buttons that a radio button belongs to changes. This is emitted when a radio button switches from being alone to being part of a group of 2 or more buttons, or vice-versa, and when a button is moved from one group of 2 or more buttons to a different one, but not when the composition of the group that a button belongs to changes.
3265 @end itemize
3266
3267
3268
3269
3270 @node radio-menu-item
3271 @section radio-menu-item
3272 @Class radio-menu-item
3273 Superclass: @ref{check-menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3274
3275 Slots:
3276 @itemize
3277 @item @anchor{slot.radio-menu-item.group}group. Type: @ref{radio-menu-item}. Accessor: @anchor{fn.radio-menu-item-group}@code{radio-menu-item-group}. Write-only.
3278 @end itemize
3279
3280
3281 Signals:
3282 @itemize
3283 @item @anchor{signal.radio-menu-item.group-changed}"group-changed". Signature: (instance @ref{radio-menu-item}) @result{} void. Options: run-first.
3284 @end itemize
3285
3286
3287
3288
3289 @node radio-tool-button
3290 @section radio-tool-button
3291 @Class radio-tool-button
3292 Superclass: @ref{toggle-tool-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3293
3294 Slots:
3295 @itemize
3296 @item @anchor{slot.radio-tool-button.group}group. Type: @ref{radio-tool-button}. Accessor: @anchor{fn.radio-tool-button-group}@code{radio-tool-button-group}. Write-only.
3297 @end itemize
3298
3299
3300 Signals:
3301 @itemize
3302 @end itemize
3303
3304
3305
3306
3307 @node range
3308 @section range
3309 @Class range
3310 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3311
3312 Subclasses: @ref{scrollbar} @ref{scale}
3313
3314 Slots:
3315 @itemize
3316 @item @anchor{slot.range.adjustment}adjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.range-adjustment}@code{range-adjustment}.
3317 @item @anchor{slot.range.fill-level}fill-level. Type: @code{double-float}. Accessor: @anchor{fn.range-fill-level}@code{range-fill-level}.
3318 @item @anchor{slot.range.inverted}inverted. Type: @code{boolean}. Accessor: @anchor{fn.range-inverted}@code{range-inverted}.
3319 @item @anchor{slot.range.lower-stepper-sensitivity}lower-stepper-sensitivity. Type: @ref{sensitivity-type}. Accessor: @anchor{fn.range-lower-stepper-sensitivity}@code{range-lower-stepper-sensitivity}.
3320 @item @anchor{slot.range.restrict-to-fill-level}restrict-to-fill-level. Type: @code{boolean}. Accessor: @anchor{fn.range-restrict-to-fill-level}@code{range-restrict-to-fill-level}.
3321 @item @anchor{slot.range.show-fill-level}show-fill-level. Type: @code{boolean}. Accessor: @anchor{fn.range-show-fill-level}@code{range-show-fill-level}.
3322 @item @anchor{slot.range.update-policy}update-policy. Type: @ref{update-type}. Accessor: @anchor{fn.range-update-policy}@code{range-update-policy}.
3323 @item @anchor{slot.range.upper-stepper-sensitivity}upper-stepper-sensitivity. Type: @ref{sensitivity-type}. Accessor: @anchor{fn.range-upper-stepper-sensitivity}@code{range-upper-stepper-sensitivity}.
3324 @end itemize
3325
3326
3327 Signals:
3328 @itemize
3329 @item @anchor{signal.range.adjust-bounds}"adjust-bounds". Signature: (instance @ref{range}), (arg-1 @code{double-float}) @result{} void. Options: run-last.
3330 @item @anchor{signal.range.change-value}"change-value". Signature: (instance @ref{range}), (arg-1 @ref{scroll-type}), (arg-2 @code{double-float}) @result{} @code{boolean}. Options: run-last.
3331 @item @anchor{signal.range.move-slider}"move-slider". Signature: (instance @ref{range}), (arg-1 @ref{scroll-type}) @result{} void. Options: run-last, action.
3332 @item @anchor{signal.range.value-changed}"value-changed". Signature: (instance @ref{range}) @result{} void. Options: run-last.
3333 @end itemize
3334
3335
3336
3337
3338 @node recent-chooser-dialog
3339 @section recent-chooser-dialog
3340 @Class recent-chooser-dialog
3341 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable} @ref{recent-chooser}
3342
3343 Slots:
3344 @itemize
3345 @end itemize
3346
3347
3348 Signals:
3349 @itemize
3350 @end itemize
3351
3352
3353
3354
3355 @node recent-chooser-menu
3356 @section recent-chooser-menu
3357 @Class recent-chooser-menu
3358 Superclass: @ref{menu} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable} @ref{recent-chooser}
3359
3360 Slots:
3361 @itemize
3362 @item @anchor{slot.recent-chooser-menu.show-numbers}show-numbers. Type: @code{boolean}. Accessor: @anchor{fn.recent-chooser-menu-show-numbers}@code{recent-chooser-menu-show-numbers}.
3363 @end itemize
3364
3365
3366 Signals:
3367 @itemize
3368 @end itemize
3369
3370
3371
3372
3373 @node recent-chooser-widget
3374 @section recent-chooser-widget
3375 @Class recent-chooser-widget
3376 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable} @ref{recent-chooser}
3377
3378 Slots:
3379 @itemize
3380 @end itemize
3381
3382
3383 Signals:
3384 @itemize
3385 @end itemize
3386
3387
3388
3389
3390 @node ruler
3391 @section ruler
3392 @Class ruler
3393 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3394
3395 Subclasses: @ref{v-ruler} @ref{h-ruler}
3396
3397 Slots:
3398 @itemize
3399 @item @anchor{slot.ruler.lower}lower. Type: @code{double-float}. Accessor: @anchor{fn.ruler-lower}@code{ruler-lower}.
3400 @item @anchor{slot.ruler.max-size}max-size. Type: @code{double-float}. Accessor: @anchor{fn.ruler-max-size}@code{ruler-max-size}.
3401 @item @anchor{slot.ruler.metric}metric. Type: @ref{metric-type}. Accessor: @anchor{fn.ruler-metric}@code{ruler-metric}.
3402 @item @anchor{slot.ruler.position}position. Type: @code{double-float}. Accessor: @anchor{fn.ruler-position}@code{ruler-position}.
3403 @item @anchor{slot.ruler.upper}upper. Type: @code{double-float}. Accessor: @anchor{fn.ruler-upper}@code{ruler-upper}.
3404 @end itemize
3405
3406
3407 Signals:
3408 @itemize
3409 @end itemize
3410
3411
3412
3413
3414 @node scale
3415 @section scale
3416 @Class scale
3417 Superclass: @ref{range} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3418
3419 Subclasses: @ref{v-scale} @ref{h-scale}
3420
3421 Slots:
3422 @itemize
3423 @item @anchor{slot.scale.digits}digits. Type: @code{integer}. Accessor: @anchor{fn.scale-digits}@code{scale-digits}.
3424 @item @anchor{slot.scale.draw-value}draw-value. Type: @code{boolean}. Accessor: @anchor{fn.scale-draw-value}@code{scale-draw-value}.
3425 @item @anchor{slot.scale.value-pos}value-pos. Type: @ref{position-type}. Accessor: @anchor{fn.scale-value-pos}@code{scale-value-pos}.
3426 @end itemize
3427
3428
3429 Signals:
3430 @itemize
3431 @item @anchor{signal.scale.format-value}"format-value". Signature: (instance @ref{scale}), (arg-1 @code{double-float}) @result{} @code{string}. Options: run-last.
3432 @end itemize
3433
3434
3435
3436
3437 @node scale-button
3438 @section scale-button
3439 @Class scale-button
3440 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable} @ref{orientable}
3441
3442 Subclasses: @ref{volume-button}
3443
3444 @ref{scale-button} provides a button which pops up a scale widget. This kind of widget is commonly used for volume controls in multimedia applications, and GTK+ provides a @ref{volume-button} subclass that is tailored for this use case.
3445
3446 Slots:
3447 @itemize
3448 @item @anchor{slot.scale-button.adjustment}adjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.scale-button-adjustment}@code{scale-button-adjustment}.
3449
3450 The @ref{adjustment} that contains the current value of this scale button object.
3451 @item @anchor{slot.scale-button.icons}icons. Type: list of @code{string}. Accessor: @anchor{fn.scale-button-icons}@code{scale-button-icons}.
3452
3453 The names of the icons to be used by the scale button. The first item in the list will be used in the button when the current value is the lowest value, the second item for the highest value. All the subsequent icons will be used for all the other values, spread evenly over the range of values.
3454
3455 If there's only one icon name in the icons array, it will be used for all the values. If only two icon names are in the icons array, the first one will be used for the bottom 50% of the scale, and the second one for the top 50%.
3456
3457 It is recommended to use at least 3 icons so that the @ref{scale-button} reflects the current value of the scale better for the users.
3458 @item @anchor{slot.scale-button.size}size. Type: @ref{icon-size}. Accessor: @anchor{fn.scale-button-size}@code{scale-button-size}.
3459
3460 The icon size.
3461
3462 Default value: @EnumVRef{icon-size,small-toolbar}
3463 @item @anchor{slot.scale-button.value}value. Type: @code{double-float}. Accessor: @anchor{fn.scale-button-value}@code{scale-button-value}.
3464
3465 The value of the scale.
3466
3467 Default value: 0
3468 @end itemize
3469
3470
3471 Signals:
3472 @itemize
3473 @item @anchor{signal.scale-button.popdown}"popdown". Signature: (instance @ref{scale-button}) @result{} void. Options: run-last, action.
3474
3475 This signal is a keybinding signal which gets emitted to popdown the scale widget.
3476
3477 The default binding for this signal is Escape.
3478 @item @anchor{signal.scale-button.popup}"popup". Signature: (instance @ref{scale-button}) @result{} void. Options: run-last, action.
3479
3480 This signal is a keybinding signal which gets emitted to popup the scale widget.
3481
3482 The default bindings for this signal are Space, Enter and Return.
3483 @item @anchor{signal.scale-button.value-changed}"value-changed". Signature: (instance @ref{scale-button}), (arg-1 @code{double-float}) @result{} void. Options: run-last.
3484
3485 This signal is emitted when the value field has changed.
3486 @end itemize
3487
3488
3489
3490
3491 @node scrollbar
3492 @section scrollbar
3493 @Class scrollbar
3494 Superclass: @ref{range} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3495
3496 Subclasses: @ref{v-scrollbar} @ref{h-scrollbar}
3497
3498 Slots:
3499 @itemize
3500 @end itemize
3501
3502
3503 Signals:
3504 @itemize
3505 @end itemize
3506
3507
3508
3509
3510 @node scrolled-window
3511 @section scrolled-window
3512 @Class scrolled-window
3513 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
3514
3515 Slots:
3516 @itemize
3517 @item @anchor{slot.scrolled-window.hadjustment}hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.scrolled-window-hadjustment}@code{scrolled-window-hadjustment}.
3518 @item @anchor{slot.scrolled-window.hscrollbar-policy}hscrollbar-policy. Type: @ref{policy-type}. Accessor: @anchor{fn.scrolled-window-hscrollbar-policy}@code{scrolled-window-hscrollbar-policy}.
3519 @item @anchor{slot.scrolled-window.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.scrolled-window-shadow-type}@code{scrolled-window-shadow-type}.
3520 @item @anchor{slot.scrolled-window.vadjustment}vadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.scrolled-window-vadjustment}@code{scrolled-window-vadjustment}.
3521 @item @anchor{slot.scrolled-window.vscrollbar-policy}vscrollbar-policy. Type: @ref{policy-type}. Accessor: @anchor{fn.scrolled-window-vscrollbar-policy}@code{scrolled-window-vscrollbar-policy}.
3522 @item @anchor{slot.scrolled-window.window-placement}window-placement. Type: @ref{corner-type}. Accessor: @anchor{fn.scrolled-window-window-placement}@code{scrolled-window-window-placement}.
3523 @item @anchor{slot.scrolled-window.window-placement-set}window-placement-set. Type: @code{boolean}. Accessor: @anchor{fn.scrolled-window-window-placement-set}@code{scrolled-window-window-placement-set}.
3524 @end itemize
3525
3526
3527 Signals:
3528 @itemize
3529 @item @anchor{signal.scrolled-window.move-focus-out}"move-focus-out". Signature: (instance @ref{scrolled-window}), (arg-1 @ref{direction-type}) @result{} void. Options: run-last, action.
3530 @item @anchor{signal.scrolled-window.scroll-child}"scroll-child". Signature: (instance @ref{scrolled-window}), (arg-1 @ref{scroll-type}), (arg-2 @code{boolean}) @result{} @code{boolean}. Options: run-last, action.
3531 @end itemize
3532
3533
3534
3535
3536 @node separator
3537 @section separator
3538 @Class separator
3539 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3540
3541 Subclasses: @ref{v-separator} @ref{h-separator}
3542
3543 Slots:
3544 @itemize
3545 @end itemize
3546
3547
3548 Signals:
3549 @itemize
3550 @end itemize
3551
3552
3553
3554
3555 @node separator-menu-item
3556 @section separator-menu-item
3557 @Class separator-menu-item
3558 Superclass: @ref{menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3559
3560 Slots:
3561 @itemize
3562 @end itemize
3563
3564
3565 Signals:
3566 @itemize
3567 @end itemize
3568
3569
3570
3571
3572 @node separator-tool-item
3573 @section separator-tool-item
3574 @Class separator-tool-item
3575 Superclass: @ref{tool-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3576
3577 Slots:
3578 @itemize
3579 @item @anchor{slot.separator-tool-item.draw}draw. Type: @code{boolean}. Accessor: @anchor{fn.separator-tool-item-draw}@code{separator-tool-item-draw}.
3580 @end itemize
3581
3582
3583 Signals:
3584 @itemize
3585 @end itemize
3586
3587
3588
3589
3590 @node socket
3591 @section socket
3592 @Class socket
3593 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3594
3595 Slots:
3596 @itemize
3597 @end itemize
3598
3599
3600 Signals:
3601 @itemize
3602 @item @anchor{signal.socket.plug-added}"plug-added". Signature: (instance @ref{socket}) @result{} void. Options: run-last.
3603 @item @anchor{signal.socket.plug-removed}"plug-removed". Signature: (instance @ref{socket}) @result{} @code{boolean}. Options: run-last.
3604 @end itemize
3605
3606
3607
3608
3609 @node spin-button
3610 @section spin-button
3611 @Class spin-button
3612 Superclass: @ref{entry} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-editable} @ref{editable}
3613
3614 Slots:
3615 @itemize
3616 @item @anchor{slot.spin-button.adjustment}adjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.spin-button-adjustment}@code{spin-button-adjustment}.
3617 @item @anchor{slot.spin-button.climb-rate}climb-rate. Type: @code{double-float}. Accessor: @anchor{fn.spin-button-climb-rate}@code{spin-button-climb-rate}.
3618 @item @anchor{slot.spin-button.digits}digits. Type: @code{integer}. Accessor: @anchor{fn.spin-button-digits}@code{spin-button-digits}.
3619 @item @anchor{slot.spin-button.numeric}numeric. Type: @code{boolean}. Accessor: @anchor{fn.spin-button-numeric}@code{spin-button-numeric}.
3620 @item @anchor{slot.spin-button.snap-to-ticks}snap-to-ticks. Type: @code{boolean}. Accessor: @anchor{fn.spin-button-snap-to-ticks}@code{spin-button-snap-to-ticks}.
3621 @item @anchor{slot.spin-button.update-policy}update-policy. Type: @ref{spin-button-update-policy}. Accessor: @anchor{fn.spin-button-update-policy}@code{spin-button-update-policy}.
3622 @item @anchor{slot.spin-button.value}value. Type: @code{double-float}. Accessor: @anchor{fn.spin-button-value}@code{spin-button-value}.
3623 @item @anchor{slot.spin-button.wrap}wrap. Type: @code{boolean}. Accessor: @anchor{fn.spin-button-wrap}@code{spin-button-wrap}.
3624 @end itemize
3625
3626
3627 Signals:
3628 @itemize
3629 @item @anchor{signal.spin-button.change-value}"change-value". Signature: (instance @ref{spin-button}), (arg-1 @ref{scroll-type}) @result{} void. Options: run-last, action.
3630 @item @anchor{signal.spin-button.input}"input". Signature: (instance @ref{spin-button}), (arg-1 gpointer) @result{} @code{integer}. Options: run-last.
3631 @item @anchor{signal.spin-button.output}"output". Signature: (instance @ref{spin-button}) @result{} @code{boolean}. Options: run-last.
3632 @item @anchor{signal.spin-button.value-changed}"value-changed". Signature: (instance @ref{spin-button}) @result{} void. Options: run-last.
3633 @item @anchor{signal.spin-button.wrapped}"wrapped". Signature: (instance @ref{spin-button}) @result{} void. Options: run-last.
3634 @end itemize
3635
3636
3637
3638
3639 @node statusbar
3640 @section statusbar
3641 @Class statusbar
3642 Superclass: @ref{h-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3643
3644 A @ref{statusbar} is usually placed along the bottom of an application's main @ref{gtk-window}. It may provide a regular commentary of the application's status (as is usually the case in a web browser, for example), or may be used to simply output a message when the status changes, (when an upload is complete in an FTP client, for example). It may also have a resize grip (a triangular area in the lower right corner) which can be clicked on to resize the window containing the statusbar.
3645
3646 Status bars in GTK+ maintain a stack of messages. The message at the top of the each bar's stack is the one that will currently be displayed.
3647
3648 Any messages added to a statusbar's stack must specify a context id that is used to uniquely identify the source of a message. Context ids may be specified by context descriptions (as string) or by numeric identifiers obtained by @ref{statusbar-context-id}. Note that messages are stored in a stack, and when choosing which message to display, the stack structure is adhered to, regardless of the context description of a message.
3649
3650 One could say that a statusbar maintains one stack of messages for display purposes, but allows multiple message producers to maintain sub-stacks of the messages they produced (via context descriptions).
3651
3652 Messages are added to the bar's stack with @ref{statusbar-push}.
3653
3654 The message at the top of the stack can be removed using @ref{statusbar-pop}. A message can be removed from anywhere in the stack if its @var{message-id} was recorded at the time it was added. This is done using @ref{statusbar-remove}.
3655
3656 Slots:
3657 @itemize
3658 @item @anchor{slot.statusbar.has-resize-grip}has-resize-grip. Type: @code{boolean}. Accessor: @anchor{fn.statusbar-has-resize-grip}@code{statusbar-has-resize-grip}.
3659
3660 Whether the statusbar has a grip for resizing the toplevel window.
3661
3662 Default value: True
3663 @end itemize
3664
3665
3666 Signals:
3667 @itemize
3668 @item @anchor{signal.statusbar.text-popped}"text-popped". Signature: (instance @ref{statusbar}), (context-id @code{integer}), (text @code{string}) @result{} void. Options: run-last.
3669
3670 Is emitted whenever a new message is popped off a statusbar's stack.
3671
3672 @var{context-id} is a numeric identifier of a context.
3673 @item @anchor{signal.statusbar.text-pushed}"text-pushed". Signature: (instance @ref{statusbar}), (context-id @code{integer}), (text @code{string}) @result{} void. Options: run-last.
3674
3675 Is emitted whenever a new message gets pushed onto a statusbar's stack.
3676
3677 @var{context-id} is a numeric identifier of a context.
3678 @end itemize
3679
3680 @RMethod statusbar-context-id
3681 @lisp
3682 (statusbar-context-id statusbar context-description) @result{} context-id
3683 @end lisp
3684
3685 Returns a context identifier, given a description of the actual context. Note that the description is not shown in the UI.
3686
3687 @var{context-description} is a string - textual description of what context the new message is being used in
3688
3689 @RMethod statusbar-push
3690 @lisp
3691 (statusbar-push statusbar context text) @result{} message-id
3692 @end lisp
3693
3694 Pushes a new message onto a statusbar's stack.
3695
3696 @var{context}: a string (context description) or a number obtained by @ref{statusbar-context-id}
3697
3698 @var{text}: the message to add to the statusbar
3699
3700 @var{message-id}: a message id that can be used with @ref{statusbar-remove}.
3701
3702 @RMethod statusbar-pop
3703 @lisp
3704 (statusbar-pop statusbar context)
3705 @end lisp
3706
3707 Removes the first message in the @ref{statusbar}'s stack with the given context.
3708
3709 Note that this may not change the displayed message, if the message at the top of the stack has a different context.
3710
3711 @var{context}: a string (context description) or a number obtained by @ref{statusbar-context-id}
3712
3713 @RMethod statusbar-remove
3714 @lisp
3715 (statusbar-remove statusbar context message-id)
3716 @end lisp
3717
3718 Forces the removal of a message from a statusbar's stack. The exact @var{context} and @var{message-id} must be specified.
3719
3720 @var{context}: a string (context description) or a number obtained by @ref{statusbar-context-id}
3721
3722 @var{message-id}: a message identifier returned by @ref{statusbar-push}
3723
3724 @node table
3725 @section table
3726 @Class table
3727 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3728
3729 Slots:
3730 @itemize
3731 @item @anchor{slot.table.column-spacing}column-spacing. Type: @code{integer}. Accessor: @anchor{fn.table-column-spacing}@code{table-column-spacing}.
3732 @item @anchor{slot.table.homogeneous}homogeneous. Type: @code{boolean}. Accessor: @anchor{fn.table-homogeneous}@code{table-homogeneous}.
3733 @item @anchor{slot.table.n-columns}n-columns. Type: @code{integer}. Accessor: @anchor{fn.table-n-columns}@code{table-n-columns}.
3734 @item @anchor{slot.table.n-rows}n-rows. Type: @code{integer}. Accessor: @anchor{fn.table-n-rows}@code{table-n-rows}.
3735 @item @anchor{slot.table.row-spacing}row-spacing. Type: @code{integer}. Accessor: @anchor{fn.table-row-spacing}@code{table-row-spacing}.
3736 @end itemize
3737
3738
3739 Signals:
3740 @itemize
3741 @end itemize
3742
3743
3744
3745
3746 @node tearoff-menu-item
3747 @section tearoff-menu-item
3748 @Class tearoff-menu-item
3749 Superclass: @ref{menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3750
3751 Slots:
3752 @itemize
3753 @end itemize
3754
3755
3756 Signals:
3757 @itemize
3758 @end itemize
3759
3760
3761
3762
3763 @node text-view
3764 @section text-view
3765 @Class text-view
3766 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3767
3768 Slots:
3769 @itemize
3770 @item @anchor{slot.text-view.accepts-tab}accepts-tab. Type: @code{boolean}. Accessor: @anchor{fn.text-view-accepts-tab}@code{text-view-accepts-tab}.
3771 @item @anchor{slot.text-view.buffer}buffer. Type: @ref{text-buffer}. Accessor: @anchor{fn.text-view-buffer}@code{text-view-buffer}.
3772 @item @anchor{slot.text-view.cursor-visible}cursor-visible. Type: @code{boolean}. Accessor: @anchor{fn.text-view-cursor-visible}@code{text-view-cursor-visible}.
3773 @item @anchor{slot.text-view.editable}editable. Type: @code{boolean}. Accessor: @anchor{fn.text-view-editable}@code{text-view-editable}.
3774 @item @anchor{slot.text-view.im-module}im-module. Type: @code{string}. Accessor: @anchor{fn.text-view-im-module}@code{text-view-im-module}.
3775 @item @anchor{slot.text-view.indent}indent. Type: @code{integer}. Accessor: @anchor{fn.text-view-indent}@code{text-view-indent}.
3776 @item @anchor{slot.text-view.justification}justification. Type: @ref{justification}. Accessor: @anchor{fn.text-view-justification}@code{text-view-justification}.
3777 @item @anchor{slot.text-view.left-margin}left-margin. Type: @code{integer}. Accessor: @anchor{fn.text-view-left-margin}@code{text-view-left-margin}.
3778 @item @anchor{slot.text-view.overwrite}overwrite. Type: @code{boolean}. Accessor: @anchor{fn.text-view-overwrite}@code{text-view-overwrite}.
3779 @item @anchor{slot.text-view.pixels-above-lines}pixels-above-lines. Type: @code{integer}. Accessor: @anchor{fn.text-view-pixels-above-lines}@code{text-view-pixels-above-lines}.
3780 @item @anchor{slot.text-view.pixels-below-lines}pixels-below-lines. Type: @code{integer}. Accessor: @anchor{fn.text-view-pixels-below-lines}@code{text-view-pixels-below-lines}.
3781 @item @anchor{slot.text-view.pixels-inside-wrap}pixels-inside-wrap. Type: @code{integer}. Accessor: @anchor{fn.text-view-pixels-inside-wrap}@code{text-view-pixels-inside-wrap}.
3782 @item @anchor{slot.text-view.right-margin}right-margin. Type: @code{integer}. Accessor: @anchor{fn.text-view-right-margin}@code{text-view-right-margin}.
3783 @item @anchor{slot.text-view.tabs}tabs. Type: @code{PangoTabArray}. Accessor: @anchor{fn.text-view-tabs}@code{text-view-tabs}.
3784 @item @anchor{slot.text-view.wrap-mode}wrap-mode. Type: @ref{wrap-mode}. Accessor: @anchor{fn.text-view-wrap-mode}@code{text-view-wrap-mode}.
3785 @end itemize
3786
3787
3788 Signals:
3789 @itemize
3790 @item @anchor{signal.text-view.backspace}"backspace". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3791 @item @anchor{signal.text-view.copy-clipboard}"copy-clipboard". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3792 @item @anchor{signal.text-view.cut-clipboard}"cut-clipboard". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3793 @item @anchor{signal.text-view.delete-from-cursor}"delete-from-cursor". Signature: (instance @ref{text-view}), (arg-1 @ref{delete-type}), (arg-2 @code{integer}) @result{} void. Options: run-last, action.
3794 @item @anchor{signal.text-view.insert-at-cursor}"insert-at-cursor". Signature: (instance @ref{text-view}), (arg-1 @code{string}) @result{} void. Options: run-last, action.
3795 @item @anchor{signal.text-view.move-cursor}"move-cursor". Signature: (instance @ref{text-view}), (arg-1 @ref{movement-step}), (arg-2 @code{integer}), (arg-3 @code{boolean}) @result{} void. Options: run-last, action.
3796 @item @anchor{signal.text-view.move-viewport}"move-viewport". Signature: (instance @ref{text-view}), (arg-1 @ref{scroll-step}), (arg-2 @code{integer}) @result{} void. Options: run-last, action.
3797 @item @anchor{signal.text-view.page-horizontally}"page-horizontally". Signature: (instance @ref{text-view}), (arg-1 @code{integer}), (arg-2 @code{boolean}) @result{} void. Options: run-last, action.
3798 @item @anchor{signal.text-view.paste-clipboard}"paste-clipboard". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3799 @item @anchor{signal.text-view.populate-popup}"populate-popup". Signature: (instance @ref{text-view}), (arg-1 @ref{menu}) @result{} void. Options: run-last.
3800 @item @anchor{signal.text-view.select-all}"select-all". Signature: (instance @ref{text-view}), (arg-1 @code{boolean}) @result{} void. Options: run-last, action.
3801 @item @anchor{signal.text-view.set-anchor}"set-anchor". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3802 @item @anchor{signal.text-view.set-scroll-adjustments}"set-scroll-adjustments". Signature: (instance @ref{text-view}), (arg-1 @ref{adjustment}), (arg-2 @ref{adjustment}) @result{} void. Options: run-last, action.
3803 @item @anchor{signal.text-view.toggle-cursor-visible}"toggle-cursor-visible". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3804 @item @anchor{signal.text-view.toggle-overwrite}"toggle-overwrite". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3805 @end itemize
3806
3807
3808
3809
3810 @node toggle-button
3811 @section toggle-button
3812 @Class toggle-button
3813 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3814
3815 Subclasses: @ref{check-button}
3816
3817 A @ref{toggle-button} is a @ref{button} which will remain 'pressed-in' when clicked. Clicking again will cause the toggle button to return to its normal state.
3818
3819 The state of a @ref{toggle-button} is stored in @SlotRef{toggle-button,active} and @SlotRef{toggle-button,inconsistent}.
3820
3821 Slots:
3822 @itemize
3823 @item @anchor{slot.toggle-button.active}active. Type: @code{boolean}. Accessor: @anchor{fn.toggle-button-active}@code{toggle-button-active}.
3824
3825 If the toggle button should be pressed in or not.
3826
3827 Default value: False
3828 @item @anchor{slot.toggle-button.draw-indicator}draw-indicator. Type: @code{boolean}. Accessor: @anchor{fn.toggle-button-draw-indicator}@code{toggle-button-draw-indicator}.
3829
3830 If the toggle part of the button is displayed.
3831
3832 Default value: False
3833 @item @anchor{slot.toggle-button.inconsistent}inconsistent. Type: @code{boolean}. Accessor: @anchor{fn.toggle-button-inconsistent}@code{toggle-button-inconsistent}.
3834
3835 If the toggle button is in an "in between" state.
3836
3837 Default value: False
3838 @end itemize
3839
3840
3841 Signals:
3842 @itemize
3843 @item @anchor{signal.toggle-button.toggled}"toggled". Signature: (instance @ref{toggle-button}) @result{} void. Options: run-first.
3844
3845 Should be connected if you wish to perform an action whenever the @ref{toggle-button}'s state is changed.
3846 @end itemize
3847
3848
3849
3850
3851 @node toggle-tool-button
3852 @section toggle-tool-button
3853 @Class toggle-tool-button
3854 Superclass: @ref{tool-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3855
3856 Subclasses: @ref{radio-tool-button}
3857
3858 Slots:
3859 @itemize
3860 @item @anchor{slot.toggle-tool-button.active}active. Type: @code{boolean}. Accessor: @anchor{fn.toggle-tool-button-active}@code{toggle-tool-button-active}.
3861 @end itemize
3862
3863
3864 Signals:
3865 @itemize
3866 @item @anchor{signal.toggle-tool-button.toggled}"toggled". Signature: (instance @ref{toggle-tool-button}) @result{} void. Options: run-first.
3867 @end itemize
3868
3869
3870
3871
3872 @node tool-button
3873 @section tool-button
3874 @Class tool-button
3875 Superclass: @ref{tool-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3876
3877 Subclasses: @ref{toggle-tool-button} @ref{menu-tool-button}
3878
3879 Slots:
3880 @itemize
3881 @item @anchor{slot.tool-button.icon-name}icon-name. Type: @code{string}. Accessor: @anchor{fn.tool-button-icon-name}@code{tool-button-icon-name}.
3882 @item @anchor{slot.tool-button.icon-widget}icon-widget. Type: @ref{widget}. Accessor: @anchor{fn.tool-button-icon-widget}@code{tool-button-icon-widget}.
3883 @item @anchor{slot.tool-button.label}label. Type: @code{string}. Accessor: @anchor{fn.tool-button-label}@code{tool-button-label}.
3884 @item @anchor{slot.tool-button.label-widget}label-widget. Type: @ref{widget}. Accessor: @anchor{fn.tool-button-label-widget}@code{tool-button-label-widget}.
3885 @item @anchor{slot.tool-button.stock-id}stock-id. Type: @code{string}. Accessor: @anchor{fn.tool-button-stock-id}@code{tool-button-stock-id}.
3886 @item @anchor{slot.tool-button.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.tool-button-use-underline}@code{tool-button-use-underline}.
3887 @end itemize
3888
3889
3890 Signals:
3891 @itemize
3892 @item @anchor{signal.tool-button.clicked}"clicked". Signature: (instance @ref{tool-button}) @result{} void. Options: run-first, action.
3893 @end itemize
3894
3895
3896
3897
3898 @node tool-item
3899 @section tool-item
3900 @Class tool-item
3901 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3902
3903 Subclasses: @ref{separator-tool-item} @ref{tool-button}
3904
3905 Slots:
3906 @itemize
3907 @item @anchor{slot.tool-item.expand}expand. Type: @code{boolean}. Accessor: @anchor{fn.tool-item-expand}@code{tool-item-expand}.
3908 @item @anchor{slot.tool-item.icon-size}icon-size. Type: @ref{icon-size}. Accessor: @anchor{fn.tool-item-icon-size}@code{tool-item-icon-size}. Read-only.
3909 @item @anchor{slot.tool-item.is-important}is-important. Type: @code{boolean}. Accessor: @anchor{fn.tool-item-is-important}@code{tool-item-is-important}.
3910 @item @anchor{slot.tool-item.orientation}orientation. Type: @ref{orientation}. Accessor: @anchor{fn.tool-item-orientation}@code{tool-item-orientation}. Read-only.
3911 @item @anchor{slot.tool-item.relief-style}relief-style. Type: @ref{relief-style}. Accessor: @anchor{fn.tool-item-relief-style}@code{tool-item-relief-style}. Read-only.
3912 @item @anchor{slot.tool-item.toolbar-style}toolbar-style. Type: @ref{toolbar-style}. Accessor: @anchor{fn.tool-item-toolbar-style}@code{tool-item-toolbar-style}. Read-only.
3913 @item @anchor{slot.tool-item.use-drag-window}use-drag-window. Type: @code{boolean}. Accessor: @anchor{fn.tool-item-use-drag-window}@code{tool-item-use-drag-window}.
3914 @item @anchor{slot.tool-item.visible-horizontal}visible-horizontal. Type: @code{boolean}. Accessor: @anchor{fn.tool-item-visible-horizontal}@code{tool-item-visible-horizontal}.
3915 @item @anchor{slot.tool-item.visible-vertical}visible-vertical. Type: @code{boolean}. Accessor: @anchor{fn.tool-item-visible-vertical}@code{tool-item-visible-vertical}.
3916 @end itemize
3917
3918
3919 Signals:
3920 @itemize
3921 @item @anchor{signal.tool-item.create-menu-proxy}"create-menu-proxy". Signature: (instance @ref{tool-item}) @result{} @code{boolean}. Options: run-last.
3922 @item @anchor{signal.tool-item.set-tooltip}"set-tooltip". Signature: (instance @ref{tool-item}), (arg-1 @ref{tooltips}), (arg-2 @code{string}), (arg-3 @code{string}) @result{} @code{boolean}. Options: run-last.
3923 @item @anchor{signal.tool-item.toolbar-reconfigured}"toolbar-reconfigured". Signature: (instance @ref{tool-item}) @result{} void. Options: run-last.
3924 @end itemize
3925
3926
3927
3928
3929 @node toolbar
3930 @section toolbar
3931 @Class toolbar
3932 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable} @ref{tool-shell}
3933
3934 Slots:
3935 @itemize
3936 @item @anchor{slot.toolbar.icon-size}icon-size. Type: @code{integer}. Accessor: @anchor{fn.toolbar-icon-size}@code{toolbar-icon-size}.
3937 @item @anchor{slot.toolbar.icon-size-set}icon-size-set. Type: @code{boolean}. Accessor: @anchor{fn.toolbar-icon-size-set}@code{toolbar-icon-size-set}.
3938 @item @anchor{slot.toolbar.show-arrow}show-arrow. Type: @code{boolean}. Accessor: @anchor{fn.toolbar-show-arrow}@code{toolbar-show-arrow}.
3939 @item @anchor{slot.toolbar.toolbar-style}toolbar-style. Type: @ref{toolbar-style}. Accessor: @anchor{fn.toolbar-toolbar-style}@code{toolbar-toolbar-style}.
3940 @item @anchor{slot.toolbar.tooltips}tooltips. Type: @code{boolean}. Accessor: @anchor{fn.toolbar-tooltips}@code{toolbar-tooltips}.
3941 @end itemize
3942
3943
3944 Signals:
3945 @itemize
3946 @item @anchor{signal.toolbar.focus-home-or-end}"focus-home-or-end". Signature: (instance @ref{toolbar}), (arg-1 @code{boolean}) @result{} @code{boolean}. Options: run-last, action.
3947 @item @anchor{signal.toolbar.orientation-changed}"orientation-changed". Signature: (instance @ref{toolbar}), (arg-1 @ref{orientation}) @result{} void. Options: run-first.
3948 @item @anchor{signal.toolbar.popup-context-menu}"popup-context-menu". Signature: (instance @ref{toolbar}), (arg-1 @code{integer}), (arg-2 @code{integer}), (arg-3 @code{integer}) @result{} @code{boolean}. Options: run-last.
3949 @item @anchor{signal.toolbar.style-changed}"style-changed". Signature: (instance @ref{toolbar}), (arg-1 @ref{toolbar-style}) @result{} void. Options: run-first.
3950 @end itemize
3951
3952
3953
3954
3955 @node tree-view
3956 @section tree-view
3957 @Class tree-view
3958 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3959
3960 Slots:
3961 @itemize
3962 @item @anchor{slot.tree-view.bin-window}bin-window. Type: @ref{g-object}. Accessor: @anchor{fn.tree-view-bin-window}@code{tree-view-bin-window}. Read-only.
3963 @item @anchor{slot.tree-view.column-drag-function}column-drag-function. Type: ????. Accessor: @anchor{fn.tree-view-column-drag-function}@code{tree-view-column-drag-function}. Write-only.
3964 @item @anchor{slot.tree-view.enable-grid-lines}enable-grid-lines. Type: @ref{tree-view-grid-lines}. Accessor: @anchor{fn.tree-view-enable-grid-lines}@code{tree-view-enable-grid-lines}.
3965 @item @anchor{slot.tree-view.enable-search}enable-search. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-enable-search}@code{tree-view-enable-search}.
3966 @item @anchor{slot.tree-view.enable-tree-lines}enable-tree-lines. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-enable-tree-lines}@code{tree-view-enable-tree-lines}.
3967 @item @anchor{slot.tree-view.expander-column}expander-column. Type: @ref{tree-view-column}. Accessor: @anchor{fn.tree-view-expander-column}@code{tree-view-expander-column}.
3968 @item @anchor{slot.tree-view.fixed-height-mode}fixed-height-mode. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-fixed-height-mode}@code{tree-view-fixed-height-mode}.
3969 @item @anchor{slot.tree-view.hadjustment}hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.tree-view-hadjustment}@code{tree-view-hadjustment}.
3970 @item @anchor{slot.tree-view.headers-clickable}headers-clickable. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-headers-clickable}@code{tree-view-headers-clickable}.
3971 @item @anchor{slot.tree-view.headers-visible}headers-visible. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-headers-visible}@code{tree-view-headers-visible}.
3972 @item @anchor{slot.tree-view.hover-expand}hover-expand. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-hover-expand}@code{tree-view-hover-expand}.
3973 @item @anchor{slot.tree-view.hover-selection}hover-selection. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-hover-selection}@code{tree-view-hover-selection}.
3974 @item @anchor{slot.tree-view.level-indentation}level-indentation. Type: @code{integer}. Accessor: @anchor{fn.tree-view-level-indentation}@code{tree-view-level-indentation}.
3975 @item @anchor{slot.tree-view.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.tree-view-model}@code{tree-view-model}.
3976 @item @anchor{slot.tree-view.reorderable}reorderable. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-reorderable}@code{tree-view-reorderable}.
3977 @item @anchor{slot.tree-view.row-separator-func}row-separator-func. Type: ????. Accessor: @anchor{fn.tree-view-row-separator-func}@code{tree-view-row-separator-func}. Write-only.
3978 @item @anchor{slot.tree-view.rubber-banding}rubber-banding. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-rubber-banding}@code{tree-view-rubber-banding}.
3979 @item @anchor{slot.tree-view.rules-hint}rules-hint. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-rules-hint}@code{tree-view-rules-hint}.
3980 @item @anchor{slot.tree-view.search-column}search-column. Type: @code{integer}. Accessor: @anchor{fn.tree-view-search-column}@code{tree-view-search-column}.
3981 @item @anchor{slot.tree-view.search-entry}search-entry. Type: @ref{g-object}. Accessor: @anchor{fn.tree-view-search-entry}@code{tree-view-search-entry}.
3982 @item @anchor{slot.tree-view.search-equal-func}search-equal-func. Type: ????. Accessor: @anchor{fn.tree-view-search-equal-func}@code{tree-view-search-equal-func}. Write-only.
3983 @item @anchor{slot.tree-view.search-position-func}search-position-func. Type: ????. Accessor: @anchor{fn.tree-view-search-position-func}@code{tree-view-search-position-func}. Write-only.
3984 @item @anchor{slot.tree-view.selection}selection. Type: @ref{g-object}. Accessor: @anchor{fn.tree-view-selection}@code{tree-view-selection}. Read-only.
3985 @item @anchor{slot.tree-view.show-expanders}show-expanders. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-show-expanders}@code{tree-view-show-expanders}.
3986 @item @anchor{slot.tree-view.tooltip-column}tooltip-column. Type: @code{integer}. Accessor: @anchor{fn.tree-view-tooltip-column}@code{tree-view-tooltip-column}.
3987 @item @anchor{slot.tree-view.vadjustment}vadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.tree-view-vadjustment}@code{tree-view-vadjustment}.
3988 @end itemize
3989
3990
3991 Signals:
3992 @itemize
3993 @item @anchor{signal.tree-view.columns-changed}"columns-changed". Signature: (instance @ref{tree-view}) @result{} void. Options: run-last.
3994 @item @anchor{signal.tree-view.cursor-changed}"cursor-changed". Signature: (instance @ref{tree-view}) @result{} void. Options: run-last.
3995 @item @anchor{signal.tree-view.expand-collapse-cursor-row}"expand-collapse-cursor-row". Signature: (instance @ref{tree-view}), (arg-1 @code{boolean}), (arg-2 @code{boolean}), (arg-3 @code{boolean}) @result{} @code{boolean}. Options: run-last, action.
3996 @item @anchor{signal.tree-view.move-cursor}"move-cursor". Signature: (instance @ref{tree-view}), (arg-1 @ref{movement-step}), (arg-2 @code{integer}) @result{} @code{boolean}. Options: run-last, action.
3997 @item @anchor{signal.tree-view.row-activated}"row-activated". Signature: (instance @ref{tree-view}), (arg-1 @ref{tree-path}), (arg-2 @ref{tree-view-column}) @result{} void. Options: run-last, action.
3998 @item @anchor{signal.tree-view.row-collapsed}"row-collapsed". Signature: (instance @ref{tree-view}), (arg-1 @ref{tree-iter}), (arg-2 @ref{tree-path}) @result{} void. Options: run-last.
3999 @item @anchor{signal.tree-view.row-expanded}"row-expanded". Signature: (instance @ref{tree-view}), (arg-1 @ref{tree-iter}), (arg-2 @ref{tree-path}) @result{} void. Options: run-last.
4000 @item @anchor{signal.tree-view.select-all}"select-all". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
4001 @item @anchor{signal.tree-view.select-cursor-parent}"select-cursor-parent". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
4002 @item @anchor{signal.tree-view.select-cursor-row}"select-cursor-row". Signature: (instance @ref{tree-view}), (arg-1 @code{boolean}) @result{} @code{boolean}. Options: run-last, action.
4003 @item @anchor{signal.tree-view.set-scroll-adjustments}"set-scroll-adjustments". Signature: (instance @ref{tree-view}), (arg-1 @ref{adjustment}), (arg-2 @ref{adjustment}) @result{} void. Options: run-last, action.
4004 @item @anchor{signal.tree-view.start-interactive-search}"start-interactive-search". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
4005 @item @anchor{signal.tree-view.test-collapse-row}"test-collapse-row". Signature: (instance @ref{tree-view}), (arg-1 @ref{tree-iter}), (arg-2 @ref{tree-path}) @result{} @code{boolean}. Options: run-last.
4006 @item @anchor{signal.tree-view.test-expand-row}"test-expand-row". Signature: (instance @ref{tree-view}), (arg-1 @ref{tree-iter}), (arg-2 @ref{tree-path}) @result{} @code{boolean}. Options: run-last.
4007 @item @anchor{signal.tree-view.toggle-cursor-row}"toggle-cursor-row". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
4008 @item @anchor{signal.tree-view.unselect-all}"unselect-all". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
4009 @end itemize
4010
4011
4012
4013
4014 @node v-box
4015 @section v-box
4016 @Class v-box
4017 Superclass: @ref{box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
4018
4019 Subclasses: @ref{recent-chooser-widget} @ref{gamma-curve} @ref{font-selection} @ref{file-chooser-widget} @ref{color-selection}
4020
4021 Slots:
4022 @itemize
4023 @end itemize
4024
4025
4026 Signals:
4027 @itemize
4028 @end itemize
4029
4030
4031
4032
4033 @node v-button-box
4034 @section v-button-box
4035 @Class v-button-box
4036 Superclass: @ref{button-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
4037
4038 Slots:
4039 @itemize
4040 @end itemize
4041
4042
4043 Signals:
4044 @itemize
4045 @end itemize
4046
4047
4048
4049
4050 @node v-paned
4051 @section v-paned
4052 @Class v-paned
4053 Superclass: @ref{paned} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
4054
4055 Slots:
4056 @itemize
4057 @end itemize
4058
4059
4060 Signals:
4061 @itemize
4062 @end itemize
4063
4064
4065
4066
4067 @node v-ruler
4068 @section v-ruler
4069 @Class v-ruler
4070 Superclass: @ref{ruler} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
4071
4072 Slots:
4073 @itemize
4074 @end itemize
4075
4076
4077 Signals:
4078 @itemize
4079 @end itemize
4080
4081
4082
4083
4084 @node v-scale
4085 @section v-scale
4086 @Class v-scale
4087 Superclass: @ref{scale} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
4088
4089 The @ref{v-scale} widget is used to allow the user to select a value using a vertical slider.
4090
4091 The position to show the current value, and the number of decimal places shown can be set using the parent @ref{scale} class's functions.
4092
4093 Slots:
4094 @itemize
4095 @end itemize
4096
4097
4098 Signals:
4099 @itemize
4100 @end itemize
4101
4102
4103
4104
4105 @node v-scrollbar
4106 @section v-scrollbar
4107 @Class v-scrollbar
4108 Superclass: @ref{scrollbar} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
4109
4110 Slots:
4111 @itemize
4112 @end itemize
4113
4114
4115 Signals:
4116 @itemize
4117 @end itemize
4118
4119
4120
4121
4122 @node v-separator
4123 @section v-separator
4124 @Class v-separator
4125 Superclass: @ref{separator} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
4126
4127 Slots:
4128 @itemize
4129 @end itemize
4130
4131
4132 Signals:
4133 @itemize
4134 @end itemize
4135
4136
4137
4138
4139 @node viewport
4140 @section viewport
4141 @Class viewport
4142 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
4143
4144 Slots:
4145 @itemize
4146 @item @anchor{slot.viewport.hadjustment}hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.viewport-hadjustment}@code{viewport-hadjustment}.
4147 @item @anchor{slot.viewport.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.viewport-shadow-type}@code{viewport-shadow-type}.
4148 @item @anchor{slot.viewport.vadjustment}vadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.viewport-vadjustment}@code{viewport-vadjustment}.
4149 @end itemize
4150
4151
4152 Signals:
4153 @itemize
4154 @item @anchor{signal.viewport.set-scroll-adjustments}"set-scroll-adjustments". Signature: (instance @ref{viewport}), (arg-1 @ref{adjustment}), (arg-2 @ref{adjustment}) @result{} void. Options: run-last, action.
4155 @end itemize
4156
4157
4158
4159
4160 @node volume-button
4161 @section volume-button
4162 @Class volume-button
4163 Superclass: @ref{scale-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable} @ref{orientable}
4164
4165 @ref{volume-button} is a subclass of @ref{scale-button} that has been tailored for use as a volume control widget with suitable icons, tooltips and accessible labels.
4166
4167 Slots:
4168 @itemize
4169 @end itemize
4170
4171
4172 Signals:
4173 @itemize
4174 @end itemize
4175
4176
4177
4178
4179 @node widget
4180 @section widget
4181 @Class widget
4182 Superclass: @ref{gtk-object} @ref{atk-implementor-iface} @ref{buildable}
4183
4184 Subclasses: @ref{separator} @ref{ruler} @ref{range} @ref{progress} @ref{misc} @ref{invisible} @ref{h-s-v} @ref{entry} @ref{drawing-area} @ref{container} @ref{cell-view} @ref{calendar}
4185
4186 Slots:
4187 @itemize
4188 @item @anchor{slot.widget.accessible}accessible. Type: @ref{g-object}. Accessor: @anchor{fn.widget-accessible}@code{widget-accessible}. Read-only.
4189 @item @anchor{slot.widget.app-paintable}app-paintable. Type: @code{boolean}. Accessor: @anchor{fn.widget-app-paintable}@code{widget-app-paintable}.
4190 @item @anchor{slot.widget.can-default}can-default. Type: @code{boolean}. Accessor: @anchor{fn.widget-can-default}@code{widget-can-default}.
4191 @item @anchor{slot.widget.can-focus}can-focus. Type: @code{boolean}. Accessor: @anchor{fn.widget-can-focus}@code{widget-can-focus}.
4192 @item @anchor{slot.widget.child-visible}child-visible. Type: @code{boolean}. Accessor: @anchor{fn.widget-child-visible}@code{widget-child-visible}.
4193 @item @anchor{slot.widget.colormap}colormap. Type: @ref{gdk-colormap}. Accessor: @anchor{fn.widget-colormap}@code{widget-colormap}.
4194 @item @anchor{slot.widget.composite-child}composite-child. Type: @code{boolean}. Accessor: @anchor{fn.widget-composite-child}@code{widget-composite-child}. Read-only.
4195 @item @anchor{slot.widget.composite-name}composite-name. Type: @code{string}. Accessor: @anchor{fn.widget-composite-name}@code{widget-composite-name}.
4196 @item @anchor{slot.widget.direction}direction. Type: @ref{text-direction}. Accessor: @anchor{fn.widget-direction}@code{widget-direction}.
4197 @item @anchor{slot.widget.events}events. Type: @ref{event-mask}. Accessor: @anchor{fn.widget-events}@code{widget-events}.
4198 @item @anchor{slot.widget.extension-events}extension-events. Type: @ref{gdk-extension-mode}. Accessor: @anchor{fn.widget-extension-events}@code{widget-extension-events}.
4199 @item @anchor{slot.widget.has-default}has-default. Type: @code{boolean}. Accessor: @anchor{fn.widget-has-default}@code{widget-has-default}.
4200 @item @anchor{slot.widget.has-focus}has-focus. Type: @code{boolean}. Accessor: @anchor{fn.widget-has-focus}@code{widget-has-focus}.
4201 @item @anchor{slot.widget.has-tooltip}has-tooltip. Type: @code{boolean}. Accessor: @anchor{fn.widget-has-tooltip}@code{widget-has-tooltip}.
4202 @item @anchor{slot.widget.height-request}height-request. Type: @code{integer}. Accessor: @anchor{fn.widget-height-request}@code{widget-height-request}.
4203 @item @anchor{slot.widget.is-focus}is-focus. Type: @code{boolean}. Accessor: @anchor{fn.widget-is-focus}@code{widget-is-focus}.
4204 @item @anchor{slot.widget.modifier-style}modifier-style. Type: @ref{rc-style}. Accessor: @anchor{fn.widget-modifier-style}@code{widget-modifier-style}.
4205 @item @anchor{slot.widget.name}name. Type: @code{string}. Accessor: @anchor{fn.widget-name}@code{widget-name}.
4206 @item @anchor{slot.widget.no-show-all}no-show-all. Type: @code{boolean}. Accessor: @anchor{fn.widget-no-show-all}@code{widget-no-show-all}.
4207 @item @anchor{slot.widget.pango-context}pango-context. Type: @ref{g-object}. Accessor: @anchor{fn.widget-pango-context}@code{widget-pango-context}. Read-only.
4208 @item @anchor{slot.widget.parent}parent. Type: @ref{container}. Accessor: @anchor{fn.widget-parent}@code{widget-parent}.
4209 @item @anchor{slot.widget.parent-window}parent-window. Type: @ref{gdk-window}. Accessor: @anchor{fn.widget-parent-window}@code{widget-parent-window}.
4210 @item @anchor{slot.widget.receives-default}receives-default. Type: @code{boolean}. Accessor: @anchor{fn.widget-receives-default}@code{widget-receives-default}.
4211 @item @anchor{slot.widget.redraw-on-allocate}redraw-on-allocate. Type: @code{boolean}. Accessor: @anchor{fn.widget-redraw-on-allocate}@code{widget-redraw-on-allocate}. Write-only.
4212 @item @anchor{slot.widget.sensitive}sensitive. Type: @code{boolean}. Accessor: @anchor{fn.widget-sensitive}@code{widget-sensitive}.
4213 @item @anchor{slot.widget.style}style. Type: @ref{style}. Accessor: @anchor{fn.widget-style}@code{widget-style}.
4214 @item @anchor{slot.widget.tooltip-markup}tooltip-markup. Type: @code{string}. Accessor: @anchor{fn.widget-tooltip-markup}@code{widget-tooltip-markup}.
4215 @item @anchor{slot.widget.tooltip-text}tooltip-text. Type: @code{string}. Accessor: @anchor{fn.widget-tooltip-text}@code{widget-tooltip-text}.
4216 @item @anchor{slot.widget.tooltip-window}tooltip-window. Type: @ref{g-object}. Accessor: @anchor{fn.widget-tooltip-window}@code{widget-tooltip-window}.
4217 @item @anchor{slot.widget.toplevel}toplevel. Type: @ref{widget}. Accessor: @anchor{fn.widget-toplevel}@code{widget-toplevel}. Read-only.
4218 @item @anchor{slot.widget.visible}visible. Type: @code{boolean}. Accessor: @anchor{fn.widget-visible}@code{widget-visible}.
4219 @item @anchor{slot.widget.visual}visual. Type: @ref{visual}. Accessor: @anchor{fn.widget-visual}@code{widget-visual}. Read-only.
4220 @item @anchor{slot.widget.width-request}width-request. Type: @code{integer}. Accessor: @anchor{fn.widget-width-request}@code{widget-width-request}.
4221 @item @anchor{slot.widget.window}window. Type: @ref{gdk-window}. Accessor: @anchor{fn.widget-window}@code{widget-window}. Read-only.
4222 @end itemize
4223
4224
4225 Signals:
4226 @itemize
4227 @item @anchor{signal.widget.accel-closures-changed}\"accel-closures-changed\". Signature: (instance @ref{widget}) @result{} void. Options: .
4228 @item @anchor{signal.widget.button-press-event}\"button-press-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4229 @item @anchor{signal.widget.button-release-event}\"button-release-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4230 @item @anchor{signal.widget.can-activate-accel}\"can-activate-accel\". Signature: (instance @ref{widget}), (arg-1 @code{integer}) @result{} @code{boolean}. Options: run-last.
4231 @item @anchor{signal.widget.child-notify}\"child-notify\". Signature: (instance @ref{widget}), (arg-1 GParam) @result{} void. Options: run-first, no-recurse, detailed, no-hooks.
4232 @item @anchor{signal.widget.client-event}\"client-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4233 @item @anchor{signal.widget.composited-changed}\"composited-changed\". Signature: (instance @ref{widget}) @result{} void. Options: run-last, action.
4234 @item @anchor{signal.widget.configure-event}\"configure-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4235 @item @anchor{signal.widget.damage-event}\"damage-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4236 @item @anchor{signal.widget.delete-event}\"delete-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4237 @item @anchor{signal.widget.destroy-event}\"destroy-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4238 @item @anchor{signal.widget.direction-changed}\"direction-changed\". Signature: (instance @ref{widget}), (arg-1 @ref{text-direction}) @result{} void. Options: run-first.
4239 @item @anchor{signal.widget.drag-begin}\"drag-begin\". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}) @result{} void. Options: run-last.
4240 @item @anchor{signal.widget.drag-data-delete}\"drag-data-delete\". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}) @result{} void. Options: run-last.
4241 @item @anchor{signal.widget.drag-data-get}\"drag-data-get\". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}), (arg-2 @code{GtkSelectionData}), (arg-3 @code{integer}), (arg-4 @code{integer}) @result{} void. Options: run-last.
4242 @item @anchor{signal.widget.drag-data-received}\"drag-data-received\". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}), (arg-2 @code{integer}), (arg-3 @code{integer}), (arg-4 @code{GtkSelectionData}), (arg-5 @code{integer}), (arg-6 @code{integer}) @result{} void. Options: run-last.
4243 @item @anchor{signal.widget.drag-drop}\"drag-drop\". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}), (arg-2 @code{integer}), (arg-3 @code{integer}), (arg-4 @code{integer}) @result{} @code{boolean}. Options: run-last.
4244 @item @anchor{signal.widget.drag-end}\"drag-end\". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}) @result{} void. Options: run-last.
4245 @item @anchor{signal.widget.drag-failed}\"drag-failed\". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}), (arg-2 @ref{drag-result}) @result{} @code{boolean}. Options: run-last.
4246 @item @anchor{signal.widget.drag-leave}\"drag-leave\". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}), (arg-2 @code{integer}) @result{} void. Options: run-last.
4247 @item @anchor{signal.widget.drag-motion}\"drag-motion\". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}), (arg-2 @code{integer}), (arg-3 @code{integer}), (arg-4 @code{integer}) @result{} @code{boolean}. Options: run-last.
4248 @item @anchor{signal.widget.enter-notify-event}\"enter-notify-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4249 @item @anchor{signal.widget.event}\"event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4250 @item @anchor{signal.widget.event-after}\"event-after\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} void. Options: .
4251 @item @anchor{signal.widget.expose-event}\"expose-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4252 @item @anchor{signal.widget.focus}\"focus\". Signature: (instance @ref{widget}), (arg-1 @ref{direction-type}) @result{} @code{boolean}. Options: run-last.
4253 @item @anchor{signal.widget.focus-in-event}\"focus-in-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4254 @item @anchor{signal.widget.focus-out-event}\"focus-out-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4255 @item @anchor{signal.widget.grab-broken-event}\"grab-broken-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4256 @item @anchor{signal.widget.grab-focus}\"grab-focus\". Signature: (instance @ref{widget}) @result{} void. Options: run-last, action.
4257 @item @anchor{signal.widget.grab-notify}\"grab-notify\". Signature: (instance @ref{widget}), (arg-1 @code{boolean}) @result{} void. Options: run-first.
4258 @item @anchor{signal.widget.hide}\"hide\". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
4259 @item @anchor{signal.widget.hierarchy-changed}\"hierarchy-changed\". Signature: (instance @ref{widget}), (arg-1 @ref{widget}) @result{} void. Options: run-last.
4260 @item @anchor{signal.widget.key-press-event}\"key-press-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4261 @item @anchor{signal.widget.key-release-event}\"key-release-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4262 @item @anchor{signal.widget.keynav-failed}\"keynav-failed\". Signature: (instance @ref{widget}), (arg-1 @ref{direction-type}) @result{} @code{boolean}. Options: run-last.
4263 @item @anchor{signal.widget.leave-notify-event}\"leave-notify-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4264 @item @anchor{signal.widget.map}\"map\". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
4265 @item @anchor{signal.widget.map-event}\"map-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4266 @item @anchor{signal.widget.mnemonic-activate}\"mnemonic-activate\". Signature: (instance @ref{widget}), (arg-1 @code{boolean}) @result{} @code{boolean}. Options: run-last.
4267 @item @anchor{signal.widget.motion-notify-event}\"motion-notify-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4268 @item @anchor{signal.widget.move-focus}\"move-focus\". Signature: (instance @ref{widget}), (arg-1 @ref{direction-type}) @result{} void. Options: run-last, action.
4269 @item @anchor{signal.widget.no-expose-event}\"no-expose-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4270 @item @anchor{signal.widget.parent-set}\"parent-set\". Signature: (instance @ref{widget}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
4271 @item @anchor{signal.widget.popup-menu}\"popup-menu\". Signature: (instance @ref{widget}) @result{} @code{boolean}. Options: run-last, action.
4272 @item @anchor{signal.widget.property-notify-event}\"property-notify-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4273 @item @anchor{signal.widget.proximity-in-event}\"proximity-in-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4274 @item @anchor{signal.widget.proximity-out-event}\"proximity-out-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4275 @item @anchor{signal.widget.query-tooltip}\"query-tooltip\". Signature: (instance @ref{widget}), (arg-1 @code{integer}), (arg-2 @code{integer}), (arg-3 @code{boolean}), (arg-4 @ref{tooltip}) @result{} @code{boolean}. Options: run-last.
4276 @item @anchor{signal.widget.realize}\"realize\". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
4277 @item @anchor{signal.widget.screen-changed}\"screen-changed\". Signature: (instance @ref{widget}), (arg-1 @ref{screen}) @result{} void. Options: run-last.
4278 @item @anchor{signal.widget.scroll-event}\"scroll-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4279 @item @anchor{signal.widget.selection-clear-event}\"selection-clear-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4280 @item @anchor{signal.widget.selection-get}\"selection-get\". Signature: (instance @ref{widget}), (arg-1 @code{GtkSelectionData}), (arg-2 @code{integer}), (arg-3 @code{integer}) @result{} void. Options: run-last.
4281 @item @anchor{signal.widget.selection-notify-event}\"selection-notify-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4282 @item @anchor{signal.widget.selection-received}\"selection-received\". Signature: (instance @ref{widget}), (arg-1 @code{GtkSelectionData}), (arg-2 @code{integer}) @result{} void. Options: run-last.
4283 @item @anchor{signal.widget.selection-request-event}\"selection-request-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4284 @item @anchor{signal.widget.show}\"show\". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
4285 @item @anchor{signal.widget.show-help}\"show-help\". Signature: (instance @ref{widget}), (arg-1 @ref{widget-help-type}) @result{} @code{boolean}. Options: run-last, action.
4286 @item @anchor{signal.widget.size-allocate}\"size-allocate\". Signature: (instance @ref{widget}), (arg-1 @ref{rectangle}) @result{} void. Options: run-first.
4287 @item @anchor{signal.widget.size-request}\"size-request\". Signature: (instance @ref{widget}), (arg-1 @code{GtkRequisition}) @result{} void. Options: run-first.
4288 @item @anchor{signal.widget.state-changed}\"state-changed\". Signature: (instance @ref{widget}), (arg-1 @ref{state-type}) @result{} void. Options: run-first.
4289 @item @anchor{signal.widget.style-set}\"style-set\". Signature: (instance @ref{widget}), (arg-1 @ref{style}) @result{} void. Options: run-first.
4290 @item @anchor{signal.widget.unmap}\"unmap\". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
4291 @item @anchor{signal.widget.unmap-event}\"unmap-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4292 @item @anchor{signal.widget.unrealize}\"unrealize\". Signature: (instance @ref{widget}) @result{} void. Options: run-last.
4293 @item @anchor{signal.widget.visibility-notify-event}\"visibility-notify-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4294 @item @anchor{signal.widget.window-state-event}\"window-state-event\". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
4295 @end itemize
4296
4297
4298
4299 @RMethod widget-show
4300
4301 Undocumented yet
4302
4303 @RMethod widget-grab-focus
4304
4305 Undocumented yet
4306