Add GtkButton documentation
[cl-gtk2.git] / 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 * old-editable::
65 * paned::
66 * plug::
67 * progress::
68 * progress-bar::
69 * radio-button::
70 * radio-menu-item::
71 * radio-tool-button::
72 * range::
73 * recent-chooser-dialog::
74 * recent-chooser-menu::
75 * recent-chooser-widget::
76 * ruler::
77 * scale::
78 * scale-button::
79 * scrollbar::
80 * scrolled-window::
81 * separator::
82 * separator-menu-item::
83 * separator-tool-item::
84 * socket::
85 * spin-button::
86 * statusbar::
87 * table::
88 * tearoff-menu-item::
89 * text::
90 * text-view::
91 * toggle-button::
92 * toggle-tool-button::
93 * tool-button::
94 * tool-item::
95 * toolbar::
96 * tree::
97 * tree-item::
98 * tree-view::
99 * v-box::
100 * v-button-box::
101 * v-paned::
102 * v-ruler::
103 * v-scale::
104 * v-scrollbar::
105 * v-separator::
106 * viewport::
107 * volume-button::
108 * widget::
109 @end menu
110
111 @node about-dialog
112 @section about-dialog
113 @Class about-dialog
114 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
115
116 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.
117
118 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.
119
120 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.
121
122 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:
123
124 @lisp
125 (make-instance 'gtk:about-dialog :program-name "ExampleCode" :title "About ExampleCode")
126 @end lisp
127
128
129 Slots:
130 @itemize
131 @item @anchor{slot.about-dialog.artists}artists. Type: list of @code{string}. Accessor: @anchor{fn.about-dialog-artists}@code{about-dialog-artists}.
132
133 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.
134 @item @anchor{slot.about-dialog.authors}authors. Type: list of @code{string}. Accessor: @anchor{fn.about-dialog-authors}@code{about-dialog-authors}.
135
136 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.
137 @item @anchor{slot.about-dialog.comments}comments. Type: @code{string}. Accessor: @anchor{fn.about-dialog-comments}@code{about-dialog-comments}.
138
139 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.
140
141 Default value: NIL
142 @item @anchor{slot.about-dialog.copyright}copyright. Type: @code{string}. Accessor: @anchor{fn.about-dialog-copyright}@code{about-dialog-copyright}.
143
144 Copyright information for the program.
145
146 Default value: NIL
147 @item @anchor{slot.about-dialog.documenters}documenters. Type: list of @code{string}. Accessor: @anchor{fn.about-dialog-documenters}@code{about-dialog-documenters}.
148
149 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.
150 @item @anchor{slot.about-dialog.license}license. Type: @code{string}. Accessor: @anchor{fn.about-dialog-license}@code{about-dialog-license}.
151
152 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.
153
154 Default value: NIL
155 @item @anchor{slot.about-dialog.logo}logo. Type: @ref{pixbuf}. Accessor: @anchor{fn.about-dialog-logo}@code{about-dialog-logo}.
156
157 A logo for the about box. If this is not set, it defaults to gtk_window_get_default_icon_list().
158 @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}.
159
160 A named icon to use as the logo for the about box. This property overrides the @SlotRef{about-dialog,logo} property.
161
162 Default value: NIL
163 @item @anchor{slot.about-dialog.program-name}program-name. Type: @code{string}. Accessor: @anchor{fn.about-dialog-program-name}@code{about-dialog-program-name}.
164
165 The name of the program. If this is not set, it defaults to g_get_application_name().
166
167 Default value: NIL
168 @item @anchor{slot.about-dialog.translator-credits}translator-credits. Type: @code{string}. Accessor: @anchor{fn.about-dialog-translator-credits}@code{about-dialog-translator-credits}.
169
170 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.
171
172 Default value: NIL
173 @item @anchor{slot.about-dialog.version}version. Type: @code{string}. Accessor: @anchor{fn.about-dialog-version}@code{about-dialog-version}.
174
175 The version of the program.
176
177 Default value: NIL
178 @item @anchor{slot.about-dialog.website}website. Type: @code{string}. Accessor: @anchor{fn.about-dialog-website}@code{about-dialog-website}.
179
180 The URL for the link to the website of the program. This should be a string starting with "http://.
181
182 Default value: NIL
183 @item @anchor{slot.about-dialog.website-label}website-label. Type: @code{string}. Accessor: @anchor{fn.about-dialog-website-label}@code{about-dialog-website-label}.
184
185 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.
186
187 Default value: NIL
188 @item @anchor{slot.about-dialog.wrap-license}wrap-license. Type: @code{boolean}. Accessor: @anchor{fn.about-dialog-wrap-license}@code{about-dialog-wrap-license}.
189
190 Whether to wrap the text in the license dialog.
191
192 Default value: False
193 @end itemize
194
195 Signals:
196 @itemize
197 @end itemize
198
199
200
201
202 @node accel-label
203 @section accel-label
204 @Class accel-label
205 Superclass: @ref{label} @ref{atk-implementor-iface} @ref{buildable}
206
207 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.
208
209 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}.
210
211 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.
212
213 @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.
214
215 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.
216
217 Slots:
218 @itemize
219 @item @anchor{slot.accel-label.accel-closure}accel-closure. Type: @code{GClosure}. Accessor: @anchor{fn.accel-label-accel-closure}@code{accel-label-accel-closure}.
220
221 The closure to be monitored for accelerator changes.
222
223 TODO: GClosure type mapping is not supported
224 @item @anchor{slot.accel-label.accel-widget}accel-widget. Type: @ref{widget}. Accessor: @anchor{fn.accel-label-accel-widget}@code{accel-label-accel-widget}.
225
226 The widget to be monitored for accelerator changes.
227 @end itemize
228
229
230 Signals:
231 @itemize
232 @end itemize
233
234
235
236
237 @node alignment
238 @section alignment
239 @Class alignment
240 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
241
242 Slots:
243 @itemize
244 @item @anchor{slot.alignment.bottom-padding}bottom-padding. Type: @code{integer}. Accessor: @anchor{fn.alignment-bottom-padding}@code{alignment-bottom-padding}.
245 @item @anchor{slot.alignment.left-padding}left-padding. Type: @code{integer}. Accessor: @anchor{fn.alignment-left-padding}@code{alignment-left-padding}.
246 @item @anchor{slot.alignment.right-padding}right-padding. Type: @code{integer}. Accessor: @anchor{fn.alignment-right-padding}@code{alignment-right-padding}.
247 @item @anchor{slot.alignment.top-padding}top-padding. Type: @code{integer}. Accessor: @anchor{fn.alignment-top-padding}@code{alignment-top-padding}.
248 @item @anchor{slot.alignment.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.alignment-xalign}@code{alignment-xalign}.
249 @item @anchor{slot.alignment.xscale}xscale. Type: @code{single-float}. Accessor: @anchor{fn.alignment-xscale}@code{alignment-xscale}.
250 @item @anchor{slot.alignment.yalign}yalign. Type: @code{single-float}. Accessor: @anchor{fn.alignment-yalign}@code{alignment-yalign}.
251 @item @anchor{slot.alignment.yscale}yscale. Type: @code{single-float}. Accessor: @anchor{fn.alignment-yscale}@code{alignment-yscale}.
252 @end itemize
253
254
255 Signals:
256 @itemize
257 @end itemize
258
259
260
261
262 @node arrow
263 @section arrow
264 @Class arrow
265 Superclass: @ref{misc} @ref{atk-implementor-iface} @ref{buildable}
266
267 Slots:
268 @itemize
269 @item @anchor{slot.arrow.arrow-type}arrow-type. Type: @ref{arrow-type}. Accessor: @anchor{fn.arrow-arrow-type}@code{arrow-arrow-type}.
270 @item @anchor{slot.arrow.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.arrow-shadow-type}@code{arrow-shadow-type}.
271 @end itemize
272
273
274 Signals:
275 @itemize
276 @end itemize
277
278
279
280
281 @node aspect-frame
282 @section aspect-frame
283 @Class aspect-frame
284 Superclass: @ref{frame} @ref{atk-implementor-iface} @ref{buildable}
285
286 Slots:
287 @itemize
288 @item @anchor{slot.aspect-frame.obey-child}obey-child. Type: @code{boolean}. Accessor: @anchor{fn.aspect-frame-obey-child}@code{aspect-frame-obey-child}.
289 @item @anchor{slot.aspect-frame.ratio}ratio. Type: @code{single-float}. Accessor: @anchor{fn.aspect-frame-ratio}@code{aspect-frame-ratio}.
290 @item @anchor{slot.aspect-frame.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.aspect-frame-xalign}@code{aspect-frame-xalign}.
291 @item @anchor{slot.aspect-frame.yalign}yalign. Type: @code{single-float}. Accessor: @anchor{fn.aspect-frame-yalign}@code{aspect-frame-yalign}.
292 @end itemize
293
294
295 Signals:
296 @itemize
297 @end itemize
298
299
300
301
302 @node assistant
303 @section assistant
304 @Class assistant
305 Superclass: @ref{gtk-window} @ref{atk-implementor-iface} @ref{buildable}
306
307 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.
308
309 Slots:
310 @itemize
311 @item @anchor{slot.assistant.current-page}current-page. Type: @code{integer}. Accessor: @anchor{fn.assistant-current-page}@code{assistant-current-page}.
312
313 The index (starting from 0) of the current page in the assistant, or -1 if the assistant has no pages.
314 @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.
315
316 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.
317 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.
318 @item @anchor{slot.assistant.n-pages}n-pages. Type: @code{integer}. Accessor: @anchor{fn.assistant-n-pages}@code{assistant-n-pages}. Read-only.
319
320 The number of pages in the assistant
321 @end itemize
322
323
324 Signals:
325 @itemize
326 @item @anchor{signal.assistant.apply}"apply". Signature: (instance @ref{assistant}) @result{} void. Options: run-last.
327
328 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.
329
330 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.
331 @item @anchor{signal.assistant.cancel}"cancel". Signature: (instance @ref{assistant}) @result{} void. Options: run-last.
332
333 This signal is emitted when then the cancel button is clicked.
334 @item @anchor{signal.assistant.close}"close". Signature: (instance @ref{assistant}) @result{} void. Options: run-last.
335
336 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.
337 @item @anchor{signal.assistant.prepare}"prepare". Signature: (instance @ref{assistant}), (page @ref{widget}) @result{} void. Options: run-last.
338
339 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.
340 @end itemize
341
342 @RMethod assistant-nth-page
343 @lisp
344 (assistant-nth-page assistant page-number) @result{} page-widget
345 @end lisp
346
347 Returns the child widget (a @ref{widget}) contained in page number @var{page-number} (an integer).
348
349 @RMethod assistant-append-page
350 @lisp
351 (assistant-append-page assistant page)
352 @end lisp
353
354 Appends a @var{page} (a @ref{widget}) to the @var{assistant} (a @ref{assistant}).
355
356 @RMethod assistant-prepend-page
357 @lisp
358 (assistant-prepend-page assistant page)
359 @end lisp
360
361 Prepends a @var{page} (a @ref{widget}) to the @var{assistant} (a @ref{assistant}).
362
363 @RMethod assistant-insert-page
364 @lisp
365 (assistant-insert-page assistant page position) @result{} page-number
366 @end lisp
367
368 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}.
369
370 @RMethod assistant-add-action-widget
371 @lisp
372 (assistant-add-action-widget assistant widget)
373 @end lisp
374
375 Adds the @var{widget} (a @ref{widget}) to the action area of a @var{assistant} (a @ref{assistant}).
376
377 @RMethod assistant-remove-action-widget
378 @lisp
379 (assistant-remove-action-widget assistant widget)
380 @end lisp
381
382 Removes the @var{widget} (a @ref{widget}) from the action area of a @var{assistant} (a @ref{assistant}).
383
384 @RMethod assistant-update-buttons-state
385 @lisp
386 (assistant-update-buttons-state assistant)
387 @end lisp
388
389 Forces @var{assistant} (a @ref{assistant}) to recompute the buttons state.
390
391 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.
392
393 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.
394
395 @node bin
396 @section bin
397 @Class bin
398 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
399
400 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}
401
402 Slots:
403 @itemize
404 @end itemize
405
406
407 Signals:
408 @itemize
409 @end itemize
410
411
412
413
414 @node box
415 @section box
416 @Class box
417 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
418
419 Subclasses: @ref{h-box} @ref{v-box} @ref{button-box}
420
421 Slots:
422 @itemize
423 @item @anchor{slot.box.homogeneous}homogeneous. Type: @code{boolean}. Accessor: @anchor{fn.box-homogeneous}@code{box-homogeneous}.
424 @item @anchor{slot.box.spacing}spacing. Type: @code{integer}. Accessor: @anchor{fn.box-spacing}@code{box-spacing}.
425 @end itemize
426
427
428 Signals:
429 @itemize
430 @end itemize
431
432
433
434
435 @node button
436 @section button
437 @Class button
438 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
439
440 Subclasses: @ref{scale-button} @ref{link-button} @ref{font-button} @ref{color-button} @ref{toggle-button}
441
442 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.
443
444 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}.
445
446 Slots:
447 @itemize
448 @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}.
449
450 Whether the button grabs focus when it is clicked with the mouse.
451
452 Default value: True
453 @item @anchor{slot.button.image}image. Type: @ref{widget}. Accessor: @anchor{fn.button-image}@code{button-image}.
454
455 Child widget to appear next to the button text.
456 @item @anchor{slot.button.image-position}image-position. Type: @ref{position-type}. Accessor: @anchor{fn.button-image-position}@code{button-image-position}.
457
458 The position of the image relative to the text inside the button.
459
460 Default value: @EnumVRef{position-type,left}
461 @item @anchor{slot.button.label}label. Type: @code{string}. Accessor: @anchor{fn.button-label}@code{button-label}.
462
463 Text of the label widget inside the button, if the button contains a label widget.
464
465 Default value: NIL
466 @item @anchor{slot.button.relief}relief. Type: @ref{relief-style}. Accessor: @anchor{fn.button-relief}@code{button-relief}.
467
468 The border relief style.
469
470 Default value: @EnumVRef{relief-style,normal}
471 @item @anchor{slot.button.use-stock}use-stock. Type: @code{boolean}. Accessor: @anchor{fn.button-use-stock}@code{button-use-stock}.
472
473 If set, the label is used to pick a stock item instead of being displayed.
474
475 Default value: False
476 @item @anchor{slot.button.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.button-use-underline}@code{button-use-underline}.
477
478 If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
479
480 Default value: False
481 @item @anchor{slot.button.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.button-xalign}@code{button-xalign}.
482
483 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.
484
485 Allowed values: [0,1]
486
487 Default value: 0.5
488 @item @anchor{slot.button.yalign}yalign. Type: @code{single-float}. Accessor: @anchor{fn.button-yalign}@code{button-yalign}.
489
490 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.
491
492 Allowed values: [0,1]
493
494 Default value: 0.5
495 @end itemize
496
497
498 Signals:
499 @itemize
500 @item @anchor{signal.button.activate}"activate". Signature: (instance @ref{button}) @result{} void. Options: run-first, action.
501
502 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.
503 @item @anchor{signal.button.clicked}"clicked". Signature: (instance @ref{button}) @result{} void. Options: run-first, action.
504
505 Emitted when the button has been activated (pressed and released).
506 @item @anchor{signal.button.enter}"enter". Signature: (instance @ref{button}) @result{} void. Options: run-first.
507
508 Emitted when the pointer enters the button.
509 @item @anchor{signal.button.leave}"leave". Signature: (instance @ref{button}) @result{} void. Options: run-first.
510
511 Emitted when the pointer leaves the button.
512 @item @anchor{signal.button.pressed}"pressed". Signature: (instance @ref{button}) @result{} void. Options: run-first.
513
514 Emitted when the button is pressed.
515 @item @anchor{signal.button.released}"released". Signature: (instance @ref{button}) @result{} void. Options: run-first.
516
517 Emitted when the button is released.
518 @end itemize
519
520
521
522
523 @node button-box
524 @section button-box
525 @Class button-box
526 Superclass: @ref{box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
527
528 Subclasses: @ref{v-button-box} @ref{h-button-box}
529
530 Slots:
531 @itemize
532 @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}.
533 @end itemize
534
535
536 Signals:
537 @itemize
538 @end itemize
539
540
541
542
543 @node calendar
544 @section calendar
545 @Class calendar
546 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
547
548 Slots:
549 @itemize
550 @item @anchor{slot.calendar.day}day. Type: @code{integer}. Accessor: @anchor{fn.calendar-day}@code{calendar-day}.
551 @item @anchor{slot.calendar.detail-function}detail-function. Type: ????. Accessor: @anchor{fn.calendar-detail-function}@code{calendar-detail-function}. Write-only.
552 @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}.
553 @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}.
554 @item @anchor{slot.calendar.month}month. Type: @code{integer}. Accessor: @anchor{fn.calendar-month}@code{calendar-month}.
555 @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}.
556 @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}.
557 @item @anchor{slot.calendar.show-details}show-details. Type: @code{boolean}. Accessor: @anchor{fn.calendar-show-details}@code{calendar-show-details}.
558 @item @anchor{slot.calendar.show-heading}show-heading. Type: @code{boolean}. Accessor: @anchor{fn.calendar-show-heading}@code{calendar-show-heading}.
559 @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}.
560 @item @anchor{slot.calendar.year}year. Type: @code{integer}. Accessor: @anchor{fn.calendar-year}@code{calendar-year}.
561 @end itemize
562
563
564 Signals:
565 @itemize
566 @item @anchor{signal.calendar.day-selected}"day-selected". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
567 @item @anchor{signal.calendar.day-selected-double-click}"day-selected-double-click". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
568 @item @anchor{signal.calendar.month-changed}"month-changed". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
569 @item @anchor{signal.calendar.next-month}"next-month". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
570 @item @anchor{signal.calendar.next-year}"next-year". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
571 @item @anchor{signal.calendar.prev-month}"prev-month". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
572 @item @anchor{signal.calendar.prev-year}"prev-year". Signature: (instance @ref{calendar}) @result{} void. Options: run-first.
573 @end itemize
574
575
576
577
578 @node cell-view
579 @section cell-view
580 @Class cell-view
581 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-layout}
582
583 Slots:
584 @itemize
585 @item @anchor{slot.cell-view.background}background. Type: @code{string}. Accessor: @anchor{fn.cell-view-background}@code{cell-view-background}. Write-only.
586 @item @anchor{slot.cell-view.background-gdk}background-gdk. Type: @ref{color}. Accessor: @anchor{fn.cell-view-background-gdk}@code{cell-view-background-gdk}.
587 @item @anchor{slot.cell-view.background-set}background-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-view-background-set}@code{cell-view-background-set}.
588 @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}.
589 @item @anchor{slot.cell-view.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.cell-view-model}@code{cell-view-model}.
590 @end itemize
591
592
593 Signals:
594 @itemize
595 @end itemize
596
597
598
599
600 @node check-button
601 @section check-button
602 @Class check-button
603 Superclass: @ref{toggle-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
604
605 Subclasses: @ref{radio-button}
606
607 Slots:
608 @itemize
609 @end itemize
610
611
612 Signals:
613 @itemize
614 @end itemize
615
616
617
618
619 @node check-menu-item
620 @section check-menu-item
621 @Class check-menu-item
622 Superclass: @ref{menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
623
624 Subclasses: @ref{radio-menu-item}
625
626 Slots:
627 @itemize
628 @item @anchor{slot.check-menu-item.active}active. Type: @code{boolean}. Accessor: @anchor{fn.check-menu-item-active}@code{check-menu-item-active}.
629 @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}.
630 @item @anchor{slot.check-menu-item.inconsistent}inconsistent. Type: @code{boolean}. Accessor: @anchor{fn.check-menu-item-inconsistent}@code{check-menu-item-inconsistent}.
631 @end itemize
632
633
634 Signals:
635 @itemize
636 @item @anchor{signal.check-menu-item.toggled}"toggled". Signature: (instance @ref{check-menu-item}) @result{} void. Options: run-first.
637 @end itemize
638
639
640
641
642 @node color-button
643 @section color-button
644 @Class color-button
645 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
646
647 Slots:
648 @itemize
649 @item @anchor{slot.color-button.alpha}alpha. Type: @code{integer}. Accessor: @anchor{fn.color-button-alpha}@code{color-button-alpha}.
650 @item @anchor{slot.color-button.color}color. Type: @ref{color}. Accessor: @anchor{fn.color-button-color}@code{color-button-color}.
651 @item @anchor{slot.color-button.title}title. Type: @code{string}. Accessor: @anchor{fn.color-button-title}@code{color-button-title}.
652 @item @anchor{slot.color-button.use-alpha}use-alpha. Type: @code{boolean}. Accessor: @anchor{fn.color-button-use-alpha}@code{color-button-use-alpha}.
653 @end itemize
654
655
656 Signals:
657 @itemize
658 @item @anchor{signal.color-button.color-set}"color-set". Signature: (instance @ref{color-button}) @result{} void. Options: run-first.
659 @end itemize
660
661
662
663
664 @node color-selection
665 @section color-selection
666 @Class color-selection
667 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
668
669 Slots:
670 @itemize
671 @item @anchor{slot.color-selection.current-alpha}current-alpha. Type: @code{integer}. Accessor: @anchor{fn.color-selection-current-alpha}@code{color-selection-current-alpha}.
672 @item @anchor{slot.color-selection.current-color}current-color. Type: @ref{color}. Accessor: @anchor{fn.color-selection-current-color}@code{color-selection-current-color}.
673 @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}.
674 @item @anchor{slot.color-selection.has-palette}has-palette. Type: @code{boolean}. Accessor: @anchor{fn.color-selection-has-palette}@code{color-selection-has-palette}.
675 @end itemize
676
677
678 Signals:
679 @itemize
680 @item @anchor{signal.color-selection.color-changed}"color-changed". Signature: (instance @ref{color-selection}) @result{} void. Options: run-first.
681 @end itemize
682
683
684
685
686 @node color-selection-dialog
687 @section color-selection-dialog
688 @Class color-selection-dialog
689 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
690
691 Slots:
692 @itemize
693 @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.
694 @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.
695 @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.
696 @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.
697 @end itemize
698
699
700 Signals:
701 @itemize
702 @end itemize
703
704
705
706
707 @node combo-box
708 @section combo-box
709 @Class combo-box
710 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-editable} @ref{cell-layout}
711
712 Subclasses: @ref{combo-box-entry}
713
714 Slots:
715 @itemize
716 @item @anchor{slot.combo-box.active}active. Type: @code{integer}. Accessor: @anchor{fn.combo-box-active}@code{combo-box-active}.
717 @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}.
718 @item @anchor{slot.combo-box.add-tearoffs}add-tearoffs. Type: @code{boolean}. Accessor: @anchor{fn.combo-box-add-tearoffs}@code{combo-box-add-tearoffs}.
719 @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}.
720 @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}.
721 @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}.
722 @item @anchor{slot.combo-box.has-frame}has-frame. Type: @code{boolean}. Accessor: @anchor{fn.combo-box-has-frame}@code{combo-box-has-frame}.
723 @item @anchor{slot.combo-box.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.combo-box-model}@code{combo-box-model}.
724 @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.
725 @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.
726 @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}.
727 @item @anchor{slot.combo-box.tearoff-title}tearoff-title. Type: @code{string}. Accessor: @anchor{fn.combo-box-tearoff-title}@code{combo-box-tearoff-title}.
728 @item @anchor{slot.combo-box.wrap-width}wrap-width. Type: @code{integer}. Accessor: @anchor{fn.combo-box-wrap-width}@code{combo-box-wrap-width}.
729 @end itemize
730
731
732 Signals:
733 @itemize
734 @item @anchor{signal.combo-box.changed}"changed". Signature: (instance @ref{combo-box}) @result{} void. Options: run-last.
735 @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.
736 @item @anchor{signal.combo-box.popdown}"popdown". Signature: (instance @ref{combo-box}) @result{} @code{boolean}. Options: run-last, action.
737 @item @anchor{signal.combo-box.popup}"popup". Signature: (instance @ref{combo-box}) @result{} void. Options: run-last, action.
738 @end itemize
739
740
741
742
743 @node combo-box-entry
744 @section combo-box-entry
745 @Class combo-box-entry
746 Superclass: @ref{combo-box} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-editable} @ref{cell-layout}
747
748 Slots:
749 @itemize
750 @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}.
751 @end itemize
752
753
754 Signals:
755 @itemize
756 @end itemize
757
758
759
760
761 @node container
762 @section container
763 @Class container
764 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
765
766 Subclasses: @ref{tree} @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}
767
768 Slots:
769 @itemize
770 @item @anchor{slot.container.border-width}border-width. Type: @code{integer}. Accessor: @anchor{fn.container-border-width}@code{container-border-width}.
771 @item @anchor{slot.container.child}child. Type: @ref{widget}. Accessor: @anchor{fn.container-child}@code{container-child}. Write-only.
772 @item @anchor{slot.container.focus-child}focus-child. Type: @ref{g-object}. Accessor: @anchor{fn.container-focus-child}@code{container-focus-child}.
773 @item @anchor{slot.container.focus-hadjustment}focus-hadjustment. Type: @ref{g-object}. Accessor: @anchor{fn.container-focus-hadjustment}@code{container-focus-hadjustment}.
774 @item @anchor{slot.container.focus-vadjustment}focus-vadjustment. Type: @ref{g-object}. Accessor: @anchor{fn.container-focus-vadjustment}@code{container-focus-vadjustment}.
775 @item @anchor{slot.container.resize-mode}resize-mode. Type: @ref{resize-mode}. Accessor: @anchor{fn.container-resize-mode}@code{container-resize-mode}.
776 @end itemize
777
778
779 Signals:
780 @itemize
781 @item @anchor{signal.container.add}"add". Signature: (instance @ref{container}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
782 @item @anchor{signal.container.check-resize}"check-resize". Signature: (instance @ref{container}) @result{} void. Options: run-last.
783 @item @anchor{signal.container.remove}"remove". Signature: (instance @ref{container}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
784 @item @anchor{signal.container.set-focus-child}"set-focus-child". Signature: (instance @ref{container}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
785 @end itemize
786
787
788
789
790 @node curve
791 @section curve
792 @Class curve
793 Superclass: @ref{drawing-area} @ref{atk-implementor-iface} @ref{buildable}
794
795 Slots:
796 @itemize
797 @item @anchor{slot.curve.curve-type}curve-type. Type: @ref{curve-type}. Accessor: @anchor{fn.curve-curve-type}@code{curve-curve-type}.
798 @item @anchor{slot.curve.max-x}max-x. Type: @code{single-float}. Accessor: @anchor{fn.curve-max-x}@code{curve-max-x}.
799 @item @anchor{slot.curve.max-y}max-y. Type: @code{single-float}. Accessor: @anchor{fn.curve-max-y}@code{curve-max-y}.
800 @item @anchor{slot.curve.min-x}min-x. Type: @code{single-float}. Accessor: @anchor{fn.curve-min-x}@code{curve-min-x}.
801 @item @anchor{slot.curve.min-y}min-y. Type: @code{single-float}. Accessor: @anchor{fn.curve-min-y}@code{curve-min-y}.
802 @end itemize
803
804
805 Signals:
806 @itemize
807 @item @anchor{signal.curve.curve-type-changed}"curve-type-changed". Signature: (instance @ref{curve}) @result{} void. Options: run-first.
808 @end itemize
809
810
811
812
813 @node dialog
814 @section dialog
815 @Class dialog
816 Superclass: @ref{gtk-window} @ref{atk-implementor-iface} @ref{buildable}
817
818 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}
819
820 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.
821
822 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}.
823
824 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}.
825
826 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).
827
828 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}.
829
830 TODO: cl-gtk2 does not yet support specifying custom response IDs.
831
832 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.
833
834 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.
835
836 @lisp
837 (defun quick-message (message)
838   "Function to open a dialog box display the MESSAGE"
839   (let ((dialog (make-instance 'gtk:dialog :title "Message")))
840     (gtk:dialog-add-button dialog "gtk-ok" :none)
841     (gtk:container-add (gtk:dialog-content-area dialog)
842                        (make-instance 'gtk:label :label message))
843     (gobject:connect-signal dialog "response"
844                             (lambda (dialog1 response-id)
845                               (declare (ignore dialog1 response-id))
846                               (gtk:object-destroy dialog)))
847     (gtk:widget-show dialog)))
848 @end lisp
849
850 Slots:
851 @itemize
852 @item @anchor{slot.dialog.action-area}action-area. Type: @ref{v-box}. Accessor: @anchor{fn.dialog-action-area}@code{dialog-action-area}. Read-only.
853
854 The action area of dialog.
855 @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.
856
857 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.
858
859 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.
860
861 Set this after adding all the buttons to your dialog, as the following example shows:
862
863 @lisp
864 (setf (dialog-alternative-button-order dialog) '(:ok :cancel :help))
865 @end lisp
866
867 @item @anchor{slot.dialog.content-area}content-area. Type: @ref{widget}. Accessor: @anchor{fn.dialog-content-area}@code{dialog-content-area}. Read-only.
868
869 The content area of dialog.
870
871 @item @anchor{slot.dialog.default-response}default-response. Type: @ref{response-type}. Accessor: @anchor{fn.dialog-default-response}@code{dialog-default-response}. Write-only.
872
873 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.
874 @item @anchor{slot.dialog.has-separator}has-separator. Type: @code{boolean}. Accessor: @anchor{fn.dialog-has-separator}@code{dialog-has-separator}.
875
876
877 When True, the dialog has a separator bar above its buttons.
878
879 Default value: True
880 @end itemize
881
882
883 Signals:
884 @itemize
885 @item @anchor{signal.dialog.close}"close". Signature: (instance @ref{dialog}) @result{} void. Options: run-last, action.
886
887 The close signal is a keybinding signal which gets emitted when the user uses a keybinding to close the dialog.
888
889 The default binding for this signal is the Escape key.
890 @item @anchor{signal.dialog.response}"response". Signature: (instance @ref{dialog}), (response-id @code{integer}) @result{} void. Options: run-last.
891
892 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.
893
894 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}.
895 @end itemize
896
897 @RMethod dialog-run
898 @lisp
899 (dialog-run dialog) @result{} response
900 @end lisp
901
902 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.
903
904 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.
905
906 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.
907
908 After @ref{dialog-run} returns, you are responsible for hiding or destroying the dialog if you wish to do so.
909
910 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.
911
912 @RMethod dialog-response
913 @lisp
914 (dialog-response dialog response)
915 @end lisp
916
917 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.
918
919 @RMethod dialog-add-button
920 @lisp
921 (dialog-add-button dialog text response) @result{} button
922 @end lisp
923
924 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.
925
926 @RMethod dialog-add-action-widget
927 @lisp
928 (dialog-add-action-widget dialog widget response)
929 @end lisp
930
931 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}.
932
933 @RMethod dialog-set-response-sensitive
934 @lisp
935 (dialog-set-response-sensitive dialog response setting)
936 @end lisp
937
938 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.
939
940 @RMethod dialog-response-for-widget
941 @lisp
942 (dialog-response-for-widget dialog widget) @result{} response
943 @end lisp
944
945 Gets the @var{response} (of type @ref{response-type}) of a @var{widget} in the action area of a @var{dialog}.
946
947 @RMethod dialog-alternative-button-order-on-screen
948 @lisp
949 (dialog-alternative-button-order-on-screen screen) @result{} boolean
950 @end lisp
951
952 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.
953
954 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.
955
956 @var{screen}: a @ref{screen} or a NIL if to use a default screen.
957
958 @node drawing-area
959 @section drawing-area
960 @Class drawing-area
961 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
962
963 Subclasses: @ref{curve}
964
965 Slots:
966 @itemize
967 @end itemize
968
969
970 Signals:
971 @itemize
972 @end itemize
973
974
975
976
977 @node entry
978 @section entry
979 @Class entry
980 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-editable} @ref{editable}
981
982 Subclasses: @ref{spin-button}
983
984 Slots:
985 @itemize
986 @item @anchor{slot.entry.activates-default}activates-default. Type: @code{boolean}. Accessor: @anchor{fn.entry-activates-default}@code{entry-activates-default}.
987 @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}.
988 @item @anchor{slot.entry.cursor-position}cursor-position. Type: @code{integer}. Accessor: @anchor{fn.entry-cursor-position}@code{entry-cursor-position}. Read-only.
989 @item @anchor{slot.entry.editable}editable. Type: @code{boolean}. Accessor: @anchor{fn.entry-editable}@code{entry-editable}.
990 @item @anchor{slot.entry.has-frame}has-frame. Type: @code{boolean}. Accessor: @anchor{fn.entry-has-frame}@code{entry-has-frame}.
991 @item @anchor{slot.entry.im-module}im-module. Type: @code{string}. Accessor: @anchor{fn.entry-im-module}@code{entry-im-module}.
992 @item @anchor{slot.entry.inner-border}inner-border. Type: @ref{border}. Accessor: @anchor{fn.entry-inner-border}@code{entry-inner-border}.
993 @item @anchor{slot.entry.invisible-char}invisible-char. Type: @code{integer}. Accessor: @anchor{fn.entry-invisible-char}@code{entry-invisible-char}.
994 @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}.
995 @item @anchor{slot.entry.max-length}max-length. Type: @code{integer}. Accessor: @anchor{fn.entry-max-length}@code{entry-max-length}.
996 @item @anchor{slot.entry.overwrite-mode}overwrite-mode. Type: @code{boolean}. Accessor: @anchor{fn.entry-overwrite-mode}@code{entry-overwrite-mode}.
997 @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}.
998 @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}.
999 @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}.
1000 @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}.
1001 @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}.
1002 @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}.
1003 @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.
1004 @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}.
1005 @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}.
1006 @item @anchor{slot.entry.progress-fraction}progress-fraction. Type: @code{double-float}. Accessor: @anchor{fn.entry-progress-fraction}@code{entry-progress-fraction}.
1007 @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}.
1008 @item @anchor{slot.entry.scroll-offset}scroll-offset. Type: @code{integer}. Accessor: @anchor{fn.entry-scroll-offset}@code{entry-scroll-offset}. Read-only.
1009 @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}.
1010 @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}.
1011 @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}.
1012 @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}.
1013 @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}.
1014 @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}.
1015 @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.
1016 @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}.
1017 @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}.
1018 @item @anchor{slot.entry.selection-bound}selection-bound. Type: @code{integer}. Accessor: @anchor{fn.entry-selection-bound}@code{entry-selection-bound}. Read-only.
1019 @item @anchor{slot.entry.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.entry-shadow-type}@code{entry-shadow-type}.
1020 @item @anchor{slot.entry.text}text. Type: @code{string}. Accessor: @anchor{fn.entry-text}@code{entry-text}.
1021 @item @anchor{slot.entry.text-length}text-length. Type: @code{integer}. Accessor: @anchor{fn.entry-text-length}@code{entry-text-length}. Read-only.
1022 @item @anchor{slot.entry.truncate-multiline}truncate-multiline. Type: @code{boolean}. Accessor: @anchor{fn.entry-truncate-multiline}@code{entry-truncate-multiline}.
1023 @item @anchor{slot.entry.visibility}visibility. Type: @code{boolean}. Accessor: @anchor{fn.entry-visibility}@code{entry-visibility}.
1024 @item @anchor{slot.entry.width-chars}width-chars. Type: @code{integer}. Accessor: @anchor{fn.entry-width-chars}@code{entry-width-chars}.
1025 @item @anchor{slot.entry.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.entry-xalign}@code{entry-xalign}.
1026 @end itemize
1027
1028
1029 Signals:
1030 @itemize
1031 @item @anchor{signal.entry.activate}"activate". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1032 @item @anchor{signal.entry.backspace}"backspace". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1033 @item @anchor{signal.entry.copy-clipboard}"copy-clipboard". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1034 @item @anchor{signal.entry.cut-clipboard}"cut-clipboard". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1035 @item @anchor{signal.entry.delete-from-cursor}"delete-from-cursor". Signature: (instance @ref{entry}), (arg-1 @ref{delete-type}), (arg-2 @code{integer}) @result{} void. Options: run-last, action.
1036 @item @anchor{signal.entry.icon-press}"icon-press". Signature: (instance @ref{entry}), (arg-1 @code{GtkEntryIconPosition}), (arg-2 @ref{event}) @result{} void. Options: run-last.
1037 @item @anchor{signal.entry.icon-release}"icon-release". Signature: (instance @ref{entry}), (arg-1 @code{GtkEntryIconPosition}), (arg-2 @ref{event}) @result{} void. Options: run-last.
1038 @item @anchor{signal.entry.insert-at-cursor}"insert-at-cursor". Signature: (instance @ref{entry}), (arg-1 @code{string}) @result{} void. Options: run-last, action.
1039 @item @anchor{signal.entry.move-cursor}"move-cursor". Signature: (instance @ref{entry}), (arg-1 @ref{movement-step}), (arg-2 @code{integer}), (arg-3 @code{boolean}) @result{} void. Options: run-last, action.
1040 @item @anchor{signal.entry.paste-clipboard}"paste-clipboard". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1041 @item @anchor{signal.entry.populate-popup}"populate-popup". Signature: (instance @ref{entry}), (arg-1 @ref{menu}) @result{} void. Options: run-last.
1042 @item @anchor{signal.entry.toggle-overwrite}"toggle-overwrite". Signature: (instance @ref{entry}) @result{} void. Options: run-last, action.
1043 @end itemize
1044
1045
1046
1047
1048 @node event-box
1049 @section event-box
1050 @Class event-box
1051 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
1052
1053 Slots:
1054 @itemize
1055 @item @anchor{slot.event-box.above-child}above-child. Type: @code{boolean}. Accessor: @anchor{fn.event-box-above-child}@code{event-box-above-child}.
1056 @item @anchor{slot.event-box.visible-window}visible-window. Type: @code{boolean}. Accessor: @anchor{fn.event-box-visible-window}@code{event-box-visible-window}.
1057 @end itemize
1058
1059
1060 Signals:
1061 @itemize
1062 @end itemize
1063
1064
1065
1066
1067 @node expander
1068 @section expander
1069 @Class expander
1070 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
1071
1072 Slots:
1073 @itemize
1074 @item @anchor{slot.expander.expanded}expanded. Type: @code{boolean}. Accessor: @anchor{fn.expander-expanded}@code{expander-expanded}.
1075 @item @anchor{slot.expander.label}label. Type: @code{string}. Accessor: @anchor{fn.expander-label}@code{expander-label}.
1076 @item @anchor{slot.expander.label-widget}label-widget. Type: @ref{widget}. Accessor: @anchor{fn.expander-label-widget}@code{expander-label-widget}.
1077 @item @anchor{slot.expander.spacing}spacing. Type: @code{integer}. Accessor: @anchor{fn.expander-spacing}@code{expander-spacing}.
1078 @item @anchor{slot.expander.use-markup}use-markup. Type: @code{boolean}. Accessor: @anchor{fn.expander-use-markup}@code{expander-use-markup}.
1079 @item @anchor{slot.expander.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.expander-use-underline}@code{expander-use-underline}.
1080 @end itemize
1081
1082
1083 Signals:
1084 @itemize
1085 @item @anchor{signal.expander.activate}"activate". Signature: (instance @ref{expander}) @result{} void. Options: run-last, action.
1086 @end itemize
1087
1088
1089
1090
1091 @node file-chooser-button
1092 @section file-chooser-button
1093 @Class file-chooser-button
1094 Superclass: @ref{h-box} @ref{atk-implementor-iface} @ref{buildable} @ref{file-chooser} @ref{orientable}
1095
1096 Slots:
1097 @itemize
1098 @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.
1099 @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}.
1100 @item @anchor{slot.file-chooser-button.title}title. Type: @code{string}. Accessor: @anchor{fn.file-chooser-button-title}@code{file-chooser-button-title}.
1101 @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}.
1102 @end itemize
1103
1104
1105 Signals:
1106 @itemize
1107 @item @anchor{signal.file-chooser-button.file-set}"file-set". Signature: (instance @ref{file-chooser-button}) @result{} void. Options: run-first.
1108 @end itemize
1109
1110
1111
1112
1113 @node file-chooser-dialog
1114 @section file-chooser-dialog
1115 @Class file-chooser-dialog
1116 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable} @ref{file-chooser}
1117
1118 Slots:
1119 @itemize
1120 @end itemize
1121
1122
1123 Signals:
1124 @itemize
1125 @end itemize
1126
1127
1128
1129
1130 @node file-chooser-widget
1131 @section file-chooser-widget
1132 @Class file-chooser-widget
1133 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{file-chooser} @ref{file-chooser-embed} @ref{orientable}
1134
1135 Slots:
1136 @itemize
1137 @end itemize
1138
1139
1140 Signals:
1141 @itemize
1142 @end itemize
1143
1144
1145
1146
1147 @node fixed
1148 @section fixed
1149 @Class fixed
1150 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
1151
1152 Slots:
1153 @itemize
1154 @item @anchor{slot.fixed.has-window}has-window. Type: @code{boolean}. Accessor: @anchor{fn.fixed-has-window}@code{fixed-has-window}.
1155 @end itemize
1156
1157
1158 Signals:
1159 @itemize
1160 @end itemize
1161
1162
1163
1164
1165 @node font-button
1166 @section font-button
1167 @Class font-button
1168 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
1169
1170 Slots:
1171 @itemize
1172 @item @anchor{slot.font-button.font-name}font-name. Type: @code{string}. Accessor: @anchor{fn.font-button-font-name}@code{font-button-font-name}.
1173 @item @anchor{slot.font-button.show-size}show-size. Type: @code{boolean}. Accessor: @anchor{fn.font-button-show-size}@code{font-button-show-size}.
1174 @item @anchor{slot.font-button.show-style}show-style. Type: @code{boolean}. Accessor: @anchor{fn.font-button-show-style}@code{font-button-show-style}.
1175 @item @anchor{slot.font-button.title}title. Type: @code{string}. Accessor: @anchor{fn.font-button-title}@code{font-button-title}.
1176 @item @anchor{slot.font-button.use-font}use-font. Type: @code{boolean}. Accessor: @anchor{fn.font-button-use-font}@code{font-button-use-font}.
1177 @item @anchor{slot.font-button.use-size}use-size. Type: @code{boolean}. Accessor: @anchor{fn.font-button-use-size}@code{font-button-use-size}.
1178 @end itemize
1179
1180
1181 Signals:
1182 @itemize
1183 @item @anchor{signal.font-button.font-set}"font-set". Signature: (instance @ref{font-button}) @result{} void. Options: run-first.
1184 @end itemize
1185
1186
1187
1188
1189 @node font-selection
1190 @section font-selection
1191 @Class font-selection
1192 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1193
1194 Slots:
1195 @itemize
1196 @item @anchor{slot.font-selection.font}font. Type: @ref{font}. Accessor: @anchor{fn.font-selection-font}@code{font-selection-font}. Read-only.
1197 @item @anchor{slot.font-selection.font-name}font-name. Type: @code{string}. Accessor: @anchor{fn.font-selection-font-name}@code{font-selection-font-name}.
1198 @item @anchor{slot.font-selection.preview-text}preview-text. Type: @code{string}. Accessor: @anchor{fn.font-selection-preview-text}@code{font-selection-preview-text}.
1199 @end itemize
1200
1201
1202 Signals:
1203 @itemize
1204 @end itemize
1205
1206
1207
1208
1209 @node font-selection-dialog
1210 @section font-selection-dialog
1211 @Class font-selection-dialog
1212 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
1213
1214 Slots:
1215 @itemize
1216 @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.
1217 @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.
1218 @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}.
1219 @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.
1220 @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}.
1221 @end itemize
1222
1223
1224 Signals:
1225 @itemize
1226 @end itemize
1227
1228
1229
1230
1231 @node frame
1232 @section frame
1233 @Class frame
1234 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
1235
1236 Subclasses: @ref{aspect-frame}
1237
1238 Slots:
1239 @itemize
1240 @item @anchor{slot.frame.label}label. Type: @code{string}. Accessor: @anchor{fn.frame-label}@code{frame-label}.
1241 @item @anchor{slot.frame.label-widget}label-widget. Type: @ref{widget}. Accessor: @anchor{fn.frame-label-widget}@code{frame-label-widget}.
1242 @item @anchor{slot.frame.label-xalign}label-xalign. Type: @code{single-float}. Accessor: @anchor{fn.frame-label-xalign}@code{frame-label-xalign}.
1243 @item @anchor{slot.frame.label-yalign}label-yalign. Type: @code{single-float}. Accessor: @anchor{fn.frame-label-yalign}@code{frame-label-yalign}.
1244 @item @anchor{slot.frame.shadow}shadow. Type: @ref{shadow-type}. Accessor: @anchor{fn.frame-shadow}@code{frame-shadow}.
1245 @item @anchor{slot.frame.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.frame-shadow-type}@code{frame-shadow-type}.
1246 @end itemize
1247
1248
1249 Signals:
1250 @itemize
1251 @end itemize
1252
1253
1254
1255
1256 @node gamma-curve
1257 @section gamma-curve
1258 @Class gamma-curve
1259 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1260
1261 Slots:
1262 @itemize
1263 @end itemize
1264
1265
1266 Signals:
1267 @itemize
1268 @end itemize
1269
1270
1271
1272
1273 @node gtk-window
1274 @section gtk-window
1275 @Class gtk-window
1276 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
1277
1278 Subclasses: @ref{plug} @ref{assistant} @ref{dialog}
1279
1280 @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.
1281
1282 If you simply want an undecorated window (no window borders), use @SlotRef{gtk-window,decorated}, don't use @EnumVRef{window-type,popup}.
1283
1284 Slots:
1285 @itemize
1286 @item @anchor{slot.gtk-window.accept-focus}accept-focus. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-accept-focus}@code{gtk-window-accept-focus}.
1287
1288 Windows may set a hint asking the desktop environment not to receive the input focus. True if the window should receive the input focus.
1289
1290 Default value: True
1291 @item @anchor{slot.gtk-window.allow-grow}allow-grow. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-allow-grow}@code{gtk-window-allow-grow}.
1292
1293 If True, users can expand the window beyond its minimum size.
1294
1295 Default value: True
1296 @item @anchor{slot.gtk-window.allow-shrink}allow-shrink. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-allow-shrink}@code{gtk-window-allow-shrink}.
1297
1298 If True, the window has no mimimum size. Setting this to True is 99% of the time a bad idea.
1299
1300 Default value: False
1301 @item @anchor{slot.gtk-window.decorated}decorated. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-decorated}@code{gtk-window-decorated}.
1302
1303 Whether the window should be decorated by the window manager.
1304
1305 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}.
1306
1307 On Windows, this always works, since there's no window manager policy involved.
1308
1309 Default value: True
1310
1311 @item @anchor{slot.gtk-window.default-height}default-height. Type: @code{integer}. Accessor: @anchor{fn.gtk-window-default-height}@code{gtk-window-default-height}.
1312
1313 The default height of the window, used when initially showing the window.
1314
1315 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.
1316
1317 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).
1318
1319 For more control over a window's initial size and how resizing works, see @ref{window-set-geometry-hints}.
1320
1321 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.
1322
1323 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.
1324
1325 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.
1326
1327 Default value: -1
1328 @item @anchor{slot.gtk-window.default-widget}default-widget. Type: @ref{widget}. Accessor: @anchor{fn.gtk-window-default-widget}@code{gtk-window-default-widget}.
1329
1330 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.
1331 @item @anchor{slot.gtk-window.default-width}default-width. Type: @code{integer}. Accessor: @anchor{fn.gtk-window-default-width}@code{gtk-window-default-width}.
1332
1333 The default width of the window, used when initially showing the window.
1334
1335 See @SlotRef{gtk-window,default-height} for explanation.
1336
1337 Default value: -1
1338 @item @anchor{slot.gtk-window.deletable}deletable. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-deletable}@code{gtk-window-deletable}.
1339
1340 Whether the window frame should have a close button.
1341
1342 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}.
1343
1344 On Windows, this always works, since there's no window manager policy involved.
1345
1346 Default value: True
1347 @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}.
1348
1349 If this window should be destroyed when the parent is destroyed.
1350
1351 Default value: False
1352 @item @anchor{slot.gtk-window.focus}focus. Type: @ref{widget}. Accessor: @anchor{fn.gtk-window-focus}@code{gtk-window-focus}.
1353
1354 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.
1355
1356 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.
1357
1358 @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}.
1359
1360 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.
1361
1362 Default value: True
1363 @item @anchor{slot.gtk-window.gravity}gravity. Type: @ref{gravity}. Accessor: @anchor{fn.gtk-window-gravity}@code{gtk-window-gravity}.
1364
1365 The window gravity of the window. See @ref{window-move} and @ref{gravity} for more details about window gravity.
1366
1367 Default value: @EnumVRef{anchor-type,north-west}
1368 @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.
1369
1370 Whether the input focus is within this GtkWindow.
1371
1372 Default value: False
1373 @item @anchor{slot.gtk-window.icon}icon. Type: @ref{pixbuf}. Accessor: @anchor{fn.gtk-window-icon}@code{gtk-window-icon}.
1374
1375 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.
1376
1377 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.
1378
1379 Icon for this window.
1380 @item @anchor{slot.gtk-window.icon-name}icon-name. Type: @code{string}. Accessor: @anchor{fn.gtk-window-icon-name}@code{gtk-window-icon-name}.
1381
1382 The icon-name property specifies the name of the themed icon to use as the window icon. See @ref{icon-theme} for more details.
1383
1384 Note that this has nothing to do with the WM_ICON_NAME property which is mentioned in the ICCCM.
1385
1386 Default value: NIL
1387 @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.
1388
1389 Whether the toplevel is the current active window.
1390
1391 Default value: False
1392 @item @anchor{slot.gtk-window.modal}modal. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-modal}@code{gtk-window-modal}.
1393
1394 If True, the window is modal (other windows are not usable while this one is up).
1395
1396 Default value: False
1397 @item @anchor{slot.gtk-window.opacity}opacity. Type: @code{double-float}. Accessor: @anchor{fn.gtk-window-opacity}@code{gtk-window-opacity}.
1398
1399 The requested opacity of the window.
1400
1401 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.
1402
1403 Note that setting a window's opacity after the window has been shown causes it to flicker once on Windows.
1404
1405 Allowed values: [0,1]
1406
1407 Default value: 1
1408 @item @anchor{slot.gtk-window.resizable}resizable. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-resizable}@code{gtk-window-resizable}.
1409
1410 If True, users can resize the window.
1411
1412 Default value: True
1413 @item @anchor{slot.gtk-window.role}role. Type: @code{string}. Accessor: @anchor{fn.gtk-window-role}@code{gtk-window-role}.
1414
1415 Unique identifier for the window to be used when restoring a session.
1416
1417 This is only useful on X11, not with other GTK+ targets.
1418
1419 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.
1420
1421 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.
1422
1423 Default value: NIL
1424 @item @anchor{slot.gtk-window.screen}screen. Type: @ref{screen}. Accessor: @anchor{fn.gtk-window-screen}@code{gtk-window-screen}.
1425
1426 The screen where this window will be displayed.
1427 @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}.
1428
1429 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.
1430
1431 Default value: False
1432 @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}.
1433
1434 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.
1435
1436 Default value: False
1437 @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.
1438
1439 The startup-id is a write-only property for setting window's startup notification identifier.
1440
1441 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.
1442
1443 This is only useful on X11, not with other GTK+ targets.
1444
1445 Default value: NIL
1446 @item @anchor{slot.gtk-window.title}title. Type: @code{string}. Accessor: @anchor{fn.gtk-window-title}@code{gtk-window-title}.
1447
1448 The title of the window.
1449
1450 Default value: NIL
1451 @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}.
1452
1453 The transient parent of the window.
1454
1455 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.
1456
1457 On Windows, this puts the child window on top of the parent, much as the window manager would have done on X.
1458 @item @anchor{slot.gtk-window.type}type. Type: @ref{window-type}. Accessor: @anchor{fn.gtk-window-type}@code{gtk-window-type}.
1459
1460 The type of the window.
1461
1462 Default value: @EnumVRef{window-type,toplevel}
1463 @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}.
1464
1465 Hint to help the desktop environment understand what kind of window this is and how to treat it.
1466
1467 This should be set before the window becomes visible.
1468
1469 Default value: @EnumVRef{gdk-window-type-hint,normal}
1470 @item @anchor{slot.gtk-window.urgency-hint}urgency-hint. Type: @code{boolean}. Accessor: @anchor{fn.gtk-window-urgency-hint}@code{gtk-window-urgency-hint}.
1471
1472 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.
1473
1474 Default value: False
1475 @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}.
1476
1477 The initial position of the window.
1478
1479 Default value: @EnumVRef{window-position,none}
1480 @end itemize
1481
1482
1483 Signals:
1484 @itemize
1485 @item @anchor{signal.gtk-window.activate-default}"activate-default". Signature: (instance @ref{gtk-window}) @result{} void. Options: run-last, action.
1486
1487 The activate-default signal is a keybinding signal which gets emitted when the user activates the default widget of window.
1488 @item @anchor{signal.gtk-window.activate-focus}"activate-focus". Signature: (instance @ref{gtk-window}) @result{} void. Options: run-last, action.
1489
1490 The activate-default signal is a keybinding signal which gets emitted when the user activates the currently focused widget of window.
1491 @item @anchor{signal.gtk-window.frame-event}"frame-event". Signature: (instance @ref{gtk-window}), (event @ref{event}) @result{} @code{boolean}. Options: run-last.
1492
1493
1494 @item @anchor{signal.gtk-window.keys-changed}"keys-changed". Signature: (instance @ref{gtk-window}) @result{} void. Options: run-first.
1495
1496 The keys-changed signal gets emitted when the set of accelerators or mnemonics that are associated with window changes.
1497 @item @anchor{signal.gtk-window.set-focus}"set-focus". Signature: (instance @ref{gtk-window}), (widget @ref{widget}) @result{} void. Options: run-last.
1498 @end itemize
1499
1500 @RMethod window-add-accel-group
1501 @lisp
1502 (window-add-accel-group window accel-group)
1503 @end lisp
1504
1505 Associate @var{accel-group} (an @ref{accel-group}) with @var{window} (an @ref{gtk-window}).
1506
1507 @RMethod window-remove-accel-group
1508 @lisp
1509 (window-remove-accel-group window accel-group)
1510 @end lisp
1511
1512 Reverses the effect of @ref{window-add-accel-group}.
1513
1514 @RMethod window-activate-focus
1515 @lisp
1516 (window-activate-focus window)
1517 @end lisp
1518
1519 Activates the current focused widget within the @var{window} (an @ref{gtk-window}).
1520
1521 @RMethod window-activate-default
1522 @lisp
1523 (window-activate-default window) @result{} activated-p
1524 @end lisp
1525
1526 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.
1527
1528 Returns True if a widget got activated.
1529
1530 @RMethod window-set-geometry-hints
1531 @lisp
1532 (window-set-geometry-hints window geometry-widget geometry geometry-mask)
1533 @end lisp
1534
1535 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.
1536
1537 @var{geometry-widget}: a @ref{widget} - widget the geometry hints will be applied to
1538
1539 @var{geometry}: a @ref{geometry} - struct containing geometry information
1540
1541 @var{geometry-mask}: a @ref{window-hints} - mask indicating which struct fields should be paid attention to
1542
1543 @Function window-list-toplevels
1544 @lisp
1545 (window-list-toplevels) @result{} windows
1546 @end lisp
1547
1548 Returns a list of all existing toplevel windows. The widgets in the list are not individually referenced.
1549
1550 @var{windows}: fresh list of @ref{gtk-window}
1551
1552 @RMethod window-add-mnemonic
1553 @lisp
1554 (window-add-mnemonic window keyval target)
1555 @end lisp
1556
1557 Adds a mnemonic to this @var{window} (a @ref{gtk-window}).
1558
1559 @var{keyval}: mnemonic keyval
1560
1561 @var{target}: the @ref{widget} that gets activated by the mnemonic
1562
1563 @RMethod window-remove-mnemonic
1564 @lisp
1565 (window-remove-mnemonic window keyval target)
1566 @end lisp
1567
1568 Removes a mnemonic from this @var{window} (a @ref{gtk-window}).
1569
1570 @var{keyval}: mnemonic keyval
1571
1572 @var{target}: the @ref{widget} that gets activated by the mnemonic
1573
1574 @RMethod window-mnemonic-activate
1575 @lisp
1576 (window-mnemonic-activate window keyval modifier)
1577 @end lisp
1578
1579 Activates the targets associated with the mnemonic.
1580
1581 @var{keyval}: mnemonic keyval
1582
1583 @var{modifier}: a @ref{modifier-type} - modifiers
1584
1585 @RMethod window-activate-key
1586 @lisp
1587 (window-activate-key window event) @result{} activated-p
1588 @end lisp
1589
1590 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.
1591
1592 Returns True if a mnemonic or accelerator was found and activated.
1593
1594 @var{event}: a @ref{event-key}
1595
1596 @RMethod window-propagate-key-event
1597 @lisp
1598 (window-propagate-key-event window event) @result{} handled-p
1599 @end lisp
1600
1601 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.
1602
1603 Returns True if a widget in the focus chain handled the event.
1604
1605 @var{event}: a @ref{event-key}
1606
1607 @RMethod window-present
1608 @lisp
1609 (window-present window)
1610 @end lisp
1611
1612 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.
1613
1614 If window is hidden, this function calls @ref{widget-show} as well.
1615
1616 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.
1617
1618 If you are calling this function in response to a user interaction, it is preferable to use @ref{window-present-with-time}.
1619
1620 @RMethod window-present-with-time
1621 @lisp
1622 (window-present-with-time window timestamp)
1623 @end lisp
1624
1625 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.
1626
1627 @var{timestamp}: the timestamp of the user interaction (typically a button or key press event) which triggered this call
1628
1629 @RMethod window-iconify
1630 @lisp
1631 (window-iconify window)
1632 @end lisp
1633
1634 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.
1635
1636 It's permitted to call this function before showing a window, in which case the window will be iconified before it ever appears onscreen.
1637
1638 You can track iconification via the @SignalRef{widget,window-state-event} signal on GtkWidget.
1639
1640 @RMethod window-deiconify
1641 @lisp
1642 (window-deiconify window)
1643 @end lisp
1644
1645 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.
1646
1647 You can track iconification via the @SignalRef{widget,window-state-event}.
1648
1649 @RMethod window-stick
1650 @lisp
1651 (window-stick window)
1652 @end lisp
1653 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.
1654
1655 It's permitted to call this function before showing a window.
1656
1657 You can track stickiness via the @SignalRef{widget,window-state-event} signal.
1658
1659 @RMethod window-unstick
1660 @lisp
1661 (window-unstick window)
1662 @end lisp
1663 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.
1664
1665 You can track stickiness via the @SignalRef{widget,window-state-event} signal.
1666
1667 @RMethod window-maximize
1668 @lisp
1669 (window-maximize window)
1670 @end lisp
1671
1672 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.
1673
1674 It's permitted to call this function before showing a window, in which case the window will be maximized when it appears onscreen initially.
1675
1676 You can track maximization via the @SignalRef{widget,window-state-event} signal.
1677
1678 @RMethod window-unmaximize
1679 @lisp
1680 (window-unmaximize window)
1681 @end lisp
1682
1683 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.
1684
1685 You can track maximization via the @SignalRef{widget,window-state-event} signal on GtkWidget.
1686
1687 @RMethod window-fullscreen
1688 @lisp
1689 (window-fullscreen window)
1690 @end lisp
1691
1692 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.
1693
1694 You can track the fullscreen state via the @SignalRef{widget,window-state-event} signal.
1695
1696 @RMethod window-unfullscreen
1697 @lisp
1698 (window-unfullscreen window)
1699 @end lisp
1700
1701 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.
1702
1703 You can track the fullscreen state via the @SignalRef{widget,window-state-event} signal.
1704
1705 @RMethod window-set-keep-above
1706 @lisp
1707 (window-set-keep-above window setting)
1708 @end lisp
1709
1710 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.
1711
1712 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.
1713
1714 You can track the above state via the @SignalRef{widget,window-state-event} signal.
1715
1716 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.
1717
1718 @var{setting}: a boolean; whether to keep @var{window} above other windows
1719
1720 @RMethod window-set-keep-below
1721 @lisp
1722 (window-set-keep-below window setting)
1723 @end lisp
1724 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.
1725
1726 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.
1727
1728 You can track the below state via the "window-state-event" signal on GtkWidget.
1729
1730 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.
1731
1732 @var{setting}: a boolean; whether to keep window below other windows
1733
1734 @RMethod window-begin-resize-drag
1735 @lisp
1736 (window-begin-resize-drag window edge button root-x root-y timestamp)
1737 @end lisp
1738
1739 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.
1740
1741 @var{edge}: a @ref{window-edge}; position of the resize control
1742
1743 @var{button}: an integer; mouse button that initiated the drag
1744
1745 @var{root-x}: an integer; X position where the user clicked to initiate the drag, in root window coordinates
1746
1747 @var{root-y}: an integer; Y position where the user clicked to initiate the drag
1748
1749 @var{timestamp}: timestamp from the click event that initiated the drag
1750
1751 @RMethod window-begin-move-drag
1752 @lisp
1753 (window-begin-move-drag window button root-x root-y timestamp)
1754 @end lisp
1755
1756 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.
1757
1758 @var{edge}: a @ref{window-edge}; position of the resize control
1759
1760 @var{button}: an integer; mouse button that initiated the drag
1761
1762 @var{root-x}: an integer; X position where the user clicked to initiate the drag, in root window coordinates
1763
1764 @var{root-y}: an integer; Y position where the user clicked to initiate the drag
1765
1766 @var{timestamp}: timestamp from the click event that initiated the drag
1767
1768 @RMethod window-set-frame-dimensions
1769 @lisp
1770 (window-set-frame-dimensions window left top right bottom)
1771 @end lisp
1772
1773 (Note: this is a special-purpose function intended for the framebuffer port; see @ref{window-set-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.)
1774
1775 For windows with frames this function can be used to change the size of the frame border.
1776
1777 @var{window}: a @ref{gtk-window}
1778
1779 @var{left}, @var{top}, @var{right}, @var{bottom} - integers; sizes of left, top, right, bottom borders
1780
1781 @RMethod window-set-has-frame
1782 @lisp
1783 (window-set-has-frame window setting)
1784 @end lisp
1785
1786 (Note: this is a special-purpose function 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.)
1787
1788 If this function is called on a @var{window} (a @ref{gtk-window}) with setting of True, before it is realized or showed, it will have a "frame" window around window->window, accessible in window->frame. Using the signal @SignalRef{gtk-window,frame-event} you can receive all events targeted at the frame.
1789
1790 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.
1791
1792 @var{setting}: a boolean
1793
1794 @RMethod window-set-mnemonic-modifier
1795 @lisp
1796 (window-set-mnemonic-modifier window modifier)
1797 @end lisp
1798
1799 Sets the mnemonic @var{modifier} (a @ref{modifier-type}) for this @var{window} (a @ref{gtk-window}).
1800
1801 @Function window-default-icon-list
1802 @lisp
1803 (setf (window-default-icon-list) icons)
1804 @end lisp
1805
1806 Sets an icon list to be used as fallback for windows that haven't had @code{gtk_window_set_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.
1807
1808 @var{icons}: a list of @ref{pixbuf}s.
1809
1810 @Function window-default-icon
1811 @lisp
1812 (setf (window-default-icon) icon)
1813 @end lisp
1814
1815 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.
1816
1817 @Function window-default-icon-name
1818 @lisp
1819 (setf (window-default-icon-name) name)
1820 @end lisp
1821
1822 Sets an icon (a @code{string} - the name of the themed icon) to be used as fallback for windows.
1823
1824 @RMethod window-move
1825 @lisp
1826 (window-move window x y)
1827 @end lisp
1828
1829 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.
1830
1831 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.
1832
1833 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.
1834
1835 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).
1836
1837 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.
1838
1839 @RMethod window-resize
1840 @lisp
1841 (window-resize window width height)
1842 @end lisp
1843
1844 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}).
1845
1846 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}.
1847
1848 Windows may not be resized smaller than 1 by 1 pixels.
1849
1850 @node h-box
1851 @section h-box
1852 @Class h-box
1853 Superclass: @ref{box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1854
1855 Subclasses: @ref{statusbar} @ref{file-chooser-button}
1856
1857 Slots:
1858 @itemize
1859 @end itemize
1860
1861
1862 Signals:
1863 @itemize
1864 @end itemize
1865
1866
1867
1868
1869 @node h-button-box
1870 @section h-button-box
1871 @Class h-button-box
1872 Superclass: @ref{button-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1873
1874 Slots:
1875 @itemize
1876 @end itemize
1877
1878
1879 Signals:
1880 @itemize
1881 @end itemize
1882
1883
1884
1885
1886 @node h-paned
1887 @section h-paned
1888 @Class h-paned
1889 Superclass: @ref{paned} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1890
1891 Slots:
1892 @itemize
1893 @end itemize
1894
1895
1896 Signals:
1897 @itemize
1898 @end itemize
1899
1900
1901
1902
1903 @node h-ruler
1904 @section h-ruler
1905 @Class h-ruler
1906 Superclass: @ref{ruler} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1907
1908 Slots:
1909 @itemize
1910 @end itemize
1911
1912
1913 Signals:
1914 @itemize
1915 @end itemize
1916
1917
1918
1919
1920 @node h-s-v
1921 @section h-s-v
1922 @Class h-s-v
1923 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
1924
1925 Slots:
1926 @itemize
1927 @end itemize
1928
1929
1930 Signals:
1931 @itemize
1932 @item @anchor{signal.h-s-v.changed}"changed". Signature: (instance @ref{h-s-v}) @result{} void. Options: run-first.
1933 @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.
1934 @end itemize
1935
1936
1937
1938
1939 @node h-scale
1940 @section h-scale
1941 @Class h-scale
1942 Superclass: @ref{scale} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1943
1944 Slots:
1945 @itemize
1946 @end itemize
1947
1948
1949 Signals:
1950 @itemize
1951 @end itemize
1952
1953
1954
1955
1956 @node h-scrollbar
1957 @section h-scrollbar
1958 @Class h-scrollbar
1959 Superclass: @ref{scrollbar} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1960
1961 Slots:
1962 @itemize
1963 @end itemize
1964
1965
1966 Signals:
1967 @itemize
1968 @end itemize
1969
1970
1971
1972
1973 @node h-separator
1974 @section h-separator
1975 @Class h-separator
1976 Superclass: @ref{separator} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
1977
1978 Slots:
1979 @itemize
1980 @end itemize
1981
1982
1983 Signals:
1984 @itemize
1985 @end itemize
1986
1987
1988
1989
1990 @node handle-box
1991 @section handle-box
1992 @Class handle-box
1993 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
1994
1995 Slots:
1996 @itemize
1997 @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.
1998 @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}.
1999 @item @anchor{slot.handle-box.shadow}shadow. Type: @ref{shadow-type}. Accessor: @anchor{fn.handle-box-shadow}@code{handle-box-shadow}.
2000 @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}.
2001 @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}.
2002 @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}.
2003 @end itemize
2004
2005
2006 Signals:
2007 @itemize
2008 @item @anchor{signal.handle-box.child-attached}"child-attached". Signature: (instance @ref{handle-box}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
2009 @item @anchor{signal.handle-box.child-detached}"child-detached". Signature: (instance @ref{handle-box}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
2010 @end itemize
2011
2012
2013
2014
2015 @node icon-view
2016 @section icon-view
2017 @Class icon-view
2018 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-layout}
2019
2020 Slots:
2021 @itemize
2022 @item @anchor{slot.icon-view.column-spacing}column-spacing. Type: @code{integer}. Accessor: @anchor{fn.icon-view-column-spacing}@code{icon-view-column-spacing}.
2023 @item @anchor{slot.icon-view.columns}columns. Type: @code{integer}. Accessor: @anchor{fn.icon-view-columns}@code{icon-view-columns}.
2024 @item @anchor{slot.icon-view.item-width}item-width. Type: @code{integer}. Accessor: @anchor{fn.icon-view-item-width}@code{icon-view-item-width}.
2025 @item @anchor{slot.icon-view.margin}margin. Type: @code{integer}. Accessor: @anchor{fn.icon-view-margin}@code{icon-view-margin}.
2026 @item @anchor{slot.icon-view.markup-column}markup-column. Type: @code{integer}. Accessor: @anchor{fn.icon-view-markup-column}@code{icon-view-markup-column}.
2027 @item @anchor{slot.icon-view.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.icon-view-model}@code{icon-view-model}.
2028 @item @anchor{slot.icon-view.orientation}orientation. Type: @ref{orientation}. Accessor: @anchor{fn.icon-view-orientation}@code{icon-view-orientation}.
2029 @item @anchor{slot.icon-view.pixbuf-column}pixbuf-column. Type: @code{integer}. Accessor: @anchor{fn.icon-view-pixbuf-column}@code{icon-view-pixbuf-column}.
2030 @item @anchor{slot.icon-view.reorderable}reorderable. Type: @code{boolean}. Accessor: @anchor{fn.icon-view-reorderable}@code{icon-view-reorderable}.
2031 @item @anchor{slot.icon-view.row-spacing}row-spacing. Type: @code{integer}. Accessor: @anchor{fn.icon-view-row-spacing}@code{icon-view-row-spacing}.
2032 @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}.
2033 @item @anchor{slot.icon-view.spacing}spacing. Type: @code{integer}. Accessor: @anchor{fn.icon-view-spacing}@code{icon-view-spacing}.
2034 @item @anchor{slot.icon-view.text-column}text-column. Type: @code{integer}. Accessor: @anchor{fn.icon-view-text-column}@code{icon-view-text-column}.
2035 @item @anchor{slot.icon-view.tooltip-column}tooltip-column. Type: @code{integer}. Accessor: @anchor{fn.icon-view-tooltip-column}@code{icon-view-tooltip-column}.
2036 @end itemize
2037
2038
2039 Signals:
2040 @itemize
2041 @item @anchor{signal.icon-view.activate-cursor-item}"activate-cursor-item". Signature: (instance @ref{icon-view}) @result{} @code{boolean}. Options: run-last, action.
2042 @item @anchor{signal.icon-view.item-activated}"item-activated". Signature: (instance @ref{icon-view}), (arg-1 @ref{tree-path}) @result{} void. Options: run-last.
2043 @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.
2044 @item @anchor{signal.icon-view.select-all}"select-all". Signature: (instance @ref{icon-view}) @result{} void. Options: run-last, action.
2045 @item @anchor{signal.icon-view.select-cursor-item}"select-cursor-item". Signature: (instance @ref{icon-view}) @result{} void. Options: run-last, action.
2046 @item @anchor{signal.icon-view.selection-changed}"selection-changed". Signature: (instance @ref{icon-view}) @result{} void. Options: run-first.
2047 @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.
2048 @item @anchor{signal.icon-view.toggle-cursor-item}"toggle-cursor-item". Signature: (instance @ref{icon-view}) @result{} void. Options: run-last, action.
2049 @item @anchor{signal.icon-view.unselect-all}"unselect-all". Signature: (instance @ref{icon-view}) @result{} void. Options: run-last, action.
2050 @end itemize
2051
2052
2053
2054
2055 @node image
2056 @section image
2057 @Class image
2058 Superclass: @ref{misc} @ref{atk-implementor-iface} @ref{buildable}
2059
2060 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:
2061 @lisp
2062 (make-instance 'image :file "myfile.png")
2063 @end lisp
2064
2065 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}.
2066
2067 The image file may contain an animation, if so the @ref{image} will display an animation (@ref{pixbuf-animation}) instead of a static image.
2068
2069 @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.
2070
2071 @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.
2072
2073 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.
2074
2075 @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().
2076
2077 Slots:
2078 @itemize
2079 @item @anchor{slot.image.file}file. Type: @code{string}. Accessor: @anchor{fn.image-file}@code{image-file}.
2080
2081 Filename to load and display.
2082
2083 Default value: NIL
2084 @item @anchor{slot.image.gicon}gicon. Type: @code{GIcon}. Accessor: @anchor{fn.image-gicon}@code{image-gicon}.
2085
2086 The GIcon displayed in the GtkImage. For themed icons, If the icon theme is changed, the image will be updated automatically.
2087
2088 TODO: GIcon is part of GIO library that is not yet supported by cl-gtk2
2089 @item @anchor{slot.image.icon-name}icon-name. Type: @code{string}. Accessor: @anchor{fn.image-icon-name}@code{image-icon-name}.
2090
2091 The name of the icon in the icon theme. If the icon theme is changed, the image will be updated automatically.
2092
2093 Default value: NIL
2094 @item @anchor{slot.image.icon-set}icon-set. Type: @code{GtkIconSet}. Accessor: @anchor{fn.image-icon-set}@code{image-icon-set}.
2095
2096 Icon set to display.
2097 @item @anchor{slot.image.icon-size}icon-size. Type: @code{integer}. Accessor: @anchor{fn.image-icon-size}@code{image-icon-size}.
2098
2099 Symbolic size to use for stock icon, icon set or named icon.
2100
2101 Allowed values: >= 0
2102
2103 Default value: 4
2104 @item @anchor{slot.image.image}image. Type: @ref{gdk-image}. Accessor: @anchor{fn.image-image}@code{image-image}.
2105
2106 A GdkImage to display.
2107 @item @anchor{slot.image.mask}mask. Type: @ref{pixmap}. Accessor: @anchor{fn.image-mask}@code{image-mask}.
2108
2109 Mask bitmap to use with @ref{gdk-image} or @ref{pixmap}.
2110 @item @anchor{slot.image.pixbuf}pixbuf. Type: @ref{pixbuf}. Accessor: @anchor{fn.image-pixbuf}@code{image-pixbuf}.
2111
2112 A @ref{pixbuf} to display.
2113 @item @anchor{slot.image.pixbuf-animation}pixbuf-animation. Type: @ref{pixbuf-animation}. Accessor: @anchor{fn.image-pixbuf-animation}@code{image-pixbuf-animation}.
2114
2115 @ref{pixbuf-animation} to display.
2116 @item @anchor{slot.image.pixel-size}pixel-size. Type: @code{integer}. Accessor: @anchor{fn.image-pixel-size}@code{image-pixel-size}.
2117
2118 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}.
2119
2120 Default value: -1
2121 @item @anchor{slot.image.pixmap}pixmap. Type: @ref{pixmap}. Accessor: @anchor{fn.image-pixmap}@code{image-pixmap}.
2122
2123 A @ref{pixmap} to display.
2124 @item @anchor{slot.image.stock}stock. Type: @code{string}. Accessor: @anchor{fn.image-stock}@code{image-stock}.
2125
2126 Stock ID for a stock image to display.
2127
2128 Default value: NIL
2129 @item @anchor{slot.image.storage-type}storage-type. Type: @ref{image-type}. Accessor: @anchor{fn.image-storage-type}@code{image-storage-type}. Read-only.
2130
2131 The representation being used for image data.
2132
2133 Default value: @EnumVRef{image-type,empty}
2134 @end itemize
2135
2136
2137 Signals:
2138 @itemize
2139 @end itemize
2140
2141
2142
2143
2144 @node image-menu-item
2145 @section image-menu-item
2146 @Class image-menu-item
2147 Superclass: @ref{menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2148
2149 Slots:
2150 @itemize
2151 @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.
2152 @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}.
2153 @item @anchor{slot.image-menu-item.image}image. Type: @ref{widget}. Accessor: @anchor{fn.image-menu-item-image}@code{image-menu-item-image}.
2154 @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}.
2155 @end itemize
2156
2157
2158 Signals:
2159 @itemize
2160 @end itemize
2161
2162
2163
2164
2165 @node input-dialog
2166 @section input-dialog
2167 @Class input-dialog
2168 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
2169
2170 Slots:
2171 @itemize
2172 @end itemize
2173
2174
2175 Signals:
2176 @itemize
2177 @item @anchor{signal.input-dialog.disable-device}"disable-device". Signature: (instance @ref{input-dialog}), (arg-1 @code{GdkDevice}) @result{} void. Options: run-last.
2178 @item @anchor{signal.input-dialog.enable-device}"enable-device". Signature: (instance @ref{input-dialog}), (arg-1 @code{GdkDevice}) @result{} void. Options: run-last.
2179 @end itemize
2180
2181
2182
2183
2184 @node invisible
2185 @section invisible
2186 @Class invisible
2187 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
2188
2189 The @ref{invisible} widget is used internally in GTK+, and is probably not very useful for application developers.
2190
2191 It is used for reliable pointer grabs and selection handling in the code for drag-and-drop.
2192
2193 Slots:
2194 @itemize
2195 @item @anchor{slot.invisible.screen}screen. Type: @ref{screen}. Accessor: @anchor{fn.invisible-screen}@code{invisible-screen}.
2196
2197 The @ref{screen} where this window will be displayed.
2198 @end itemize
2199
2200
2201 Signals:
2202 @itemize
2203 @end itemize
2204
2205
2206
2207
2208 @node item
2209 @section item
2210 @Class item
2211 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
2212
2213 Subclasses: @ref{tree-item} @ref{menu-item}
2214
2215 Slots:
2216 @itemize
2217 @end itemize
2218
2219
2220 Signals:
2221 @itemize
2222 @item @anchor{signal.item.deselect}"deselect". Signature: (instance @ref{item}) @result{} void. Options: run-first.
2223 @item @anchor{signal.item.select}"select". Signature: (instance @ref{item}) @result{} void. Options: run-first.
2224 @item @anchor{signal.item.toggle}"toggle". Signature: (instance @ref{item}) @result{} void. Options: run-first.
2225 @end itemize
2226
2227
2228
2229
2230 @node label
2231 @section label
2232 @Class label
2233 Superclass: @ref{misc} @ref{atk-implementor-iface} @ref{buildable}
2234
2235 Subclasses: @ref{accel-label}
2236
2237 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}.
2238
2239 @chapheading Mnemonics
2240
2241 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.
2242
2243 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:
2244
2245 @chapheading Markup (styled text)
2246
2247 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:
2248 @lisp
2249 (make-instance 'label :label "<small>Small text</small>" :use-markup t)
2250 @end lisp
2251 (See @uref{http://library.gnome.org/devel/pango/stable/PangoMarkupFormat.html,,complete documentation} of available tags in the Pango manual.)
2252
2253 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)
2254
2255 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.
2256
2257 @chapheading Selectable labels
2258
2259 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.
2260
2261 @chapheading Text layout
2262
2263 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.
2264
2265 Labels can automatically wrap text if you call @SlotRef{label,line-wrap}.
2266
2267 @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}.
2268
2269 Slots:
2270 @itemize
2271 @item @anchor{slot.label.angle}angle. Type: @code{double-float}. Accessor: @anchor{fn.label-angle}@code{label-angle}.
2272
2273 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.
2274
2275 Allowed values: [0,360]
2276
2277 Default value: 0
2278 @item @anchor{slot.label.attributes}attributes. Type: @code{PangoAttrList}. Accessor: @anchor{fn.label-attributes}@code{label-attributes}.
2279
2280 A list of style attributes to apply to the text of the label
2281 @item @anchor{slot.label.cursor-position}cursor-position. Type: @code{integer}. Accessor: @anchor{fn.label-cursor-position}@code{label-cursor-position}. Read-only.
2282
2283 The current position of the insertion cursor in chars.
2284
2285 Allowed values: >= 0
2286
2287 Default value: 0
2288 @item @anchor{slot.label.ellipsize}ellipsize. Type: @ref{pango-ellipsize-mode}. Accessor: @anchor{fn.label-ellipsize}@code{label-ellipsize}.
2289
2290 The preferred place to ellipsize the string, if the label does not have enough room to display the entire string.
2291
2292 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}.
2293
2294 Default value: @EnumVRef{pango-ellipsize-mode,none}
2295 @item @anchor{slot.label.justify}justify. Type: @ref{justification}. Accessor: @anchor{fn.label-justify}@code{label-justify}.
2296
2297 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.
2298
2299 Default value: @EnumVRef{justification,left}
2300 @item @anchor{slot.label.label}label. Type: @code{string}. Accessor: @anchor{fn.label-label}@code{label-label}.
2301
2302 The text of the label.
2303
2304 Default value: ""
2305 @item @anchor{slot.label.layout}layout. Type: @ref{g-object}. Accessor: @anchor{fn.label-layout}@code{label-layout}. Read-only.
2306
2307 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}.
2308 @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.
2309
2310 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.
2311 @item @anchor{slot.label.line-wrap}line-wrap. Type: @code{boolean}. Accessor: @anchor{fn.label-line-wrap}@code{label-line-wrap}.
2312
2313 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.
2314
2315 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}.
2316 @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}.
2317
2318 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.
2319 @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}.
2320
2321 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.
2322
2323 Default value: -1
2324 @item @anchor{slot.label.mnemonic-keyval}mnemonic-keyval. Type: @code{integer}. Accessor: @anchor{fn.label-mnemonic-keyval}@code{label-mnemonic-keyval}. Read-only.
2325
2326 The mnemonic accelerator key for this label.
2327
2328 Default value: 16777215
2329 @item @anchor{slot.label.mnemonic-widget}mnemonic-widget. Type: @ref{widget}. Accessor: @anchor{fn.label-mnemonic-widget}@code{label-mnemonic-widget}.
2330
2331 The widget to be activated when the label's mnemonic key is pressed.
2332 @item @anchor{slot.label.pattern}pattern. Type: @code{string}. Accessor: @anchor{fn.label-pattern}@code{label-pattern}. Write-only.
2333
2334 A string with _ characters in positions correspond to characters in the text to underline.
2335
2336 Default value: NIL
2337 @item @anchor{slot.label.selectable}selectable. Type: @code{boolean}. Accessor: @anchor{fn.label-selectable}@code{label-selectable}.
2338
2339 Whether the label text can be selected with the mouse.
2340
2341 Default value: False
2342 @item @anchor{slot.label.selection-bound}selection-bound. Type: @code{integer}. Accessor: @anchor{fn.label-selection-bound}@code{label-selection-bound}. Read-only.
2343
2344 The position of the opposite end of the selection from the cursor in chars.
2345
2346 Allowed values: >= 0
2347
2348 Default value: 0
2349 @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.
2350
2351 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
2352 @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}.
2353
2354 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.
2355
2356 Default value: False
2357 @item @anchor{slot.label.use-markup}use-markup. Type: @code{boolean}. Accessor: @anchor{fn.label-use-markup}@code{label-use-markup}.
2358
2359 The text of the label includes XML markup.
2360
2361 Default value: False
2362 @item @anchor{slot.label.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.label-use-underline}@code{label-use-underline}.
2363
2364 If set, an underline in the text indicates the next character should be used for the mnemonic accelerator key.
2365
2366 Default value: False
2367 @item @anchor{slot.label.width-chars}width-chars. Type: @code{integer}. Accessor: @anchor{fn.label-width-chars}@code{label-width-chars}.
2368
2369 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.
2370
2371 Default value: -1
2372 @item @anchor{slot.label.wrap}wrap. Type: @code{boolean}. Accessor: @anchor{fn.label-wrap}@code{label-wrap}.
2373
2374 If set, wrap lines if the text becomes too wide.
2375
2376 Default value: False
2377 @item @anchor{slot.label.wrap-mode}wrap-mode. Type: @ref{pango-wrap-mode}. Accessor: @anchor{fn.label-wrap-mode}@code{label-wrap-mode}.
2378
2379 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.
2380 @end itemize
2381
2382
2383 Signals:
2384 @itemize
2385 @item @anchor{signal.label.copy-clipboard}"copy-clipboard". Signature: (instance @ref{label}) @result{} void. Options: run-last, action.
2386
2387 This signal is a keybinding signal which gets emitted to copy the selection to the clipboard.
2388
2389 The default binding for this signal is Ctrl-c.
2390 @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.
2391
2392 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.
2393
2394 Applications should not connect to it, but may emit it with @ref{emit-signal} if they need to control the cursor programmatically.
2395
2396 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.
2397
2398 @itemize
2399 @item Arrow keys move by individual characters/lines
2400 @item Ctrl-arrow key combinations move by words/paragraphs
2401 @item Home/End keys move to the ends of the buffer
2402 @end itemize
2403
2404
2405 @var{step}: the granularity of the move, as a GtkMovementStep
2406
2407 @var{count}: the number of step units to move
2408
2409 @var{extend-selection}: True if the move should extend the selection
2410 @item @anchor{signal.label.populate-popup}"populate-popup". Signature: (instance @ref{label}), (menu @ref{menu}) @result{} void. Options: run-last.
2411
2412 This signal gets emitted before showing the context menu of the label. Note that only selectable labels have context menus.
2413
2414 If you need to add items to the context menu, connect to this signal and append your menuitems to the menu.
2415 @end itemize
2416
2417
2418
2419
2420 @node layout
2421 @section layout
2422 @Class layout
2423 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
2424
2425 Slots:
2426 @itemize
2427 @item @anchor{slot.layout.bin-window}bin-window. Type: @ref{g-object}. Accessor: @anchor{fn.layout-bin-window}@code{layout-bin-window}. Read-only.
2428 @item @anchor{slot.layout.hadjustment}hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.layout-hadjustment}@code{layout-hadjustment}.
2429 @item @anchor{slot.layout.height}height. Type: @code{integer}. Accessor: @anchor{fn.layout-height}@code{layout-height}.
2430 @item @anchor{slot.layout.vadjustment}vadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.layout-vadjustment}@code{layout-vadjustment}.
2431 @item @anchor{slot.layout.width}width. Type: @code{integer}. Accessor: @anchor{fn.layout-width}@code{layout-width}.
2432 @end itemize
2433
2434
2435 Signals:
2436 @itemize
2437 @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.
2438 @end itemize
2439
2440
2441
2442
2443 @node link-button
2444 @section link-button
2445 @Class link-button
2446 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2447
2448 Slots:
2449 @itemize
2450 @item @anchor{slot.link-button.uri}uri. Type: @code{string}. Accessor: @anchor{fn.link-button-uri}@code{link-button-uri}.
2451 @item @anchor{slot.link-button.visited}visited. Type: @code{boolean}. Accessor: @anchor{fn.link-button-visited}@code{link-button-visited}.
2452 @end itemize
2453
2454
2455 Signals:
2456 @itemize
2457 @end itemize
2458
2459
2460
2461
2462 @node menu
2463 @section menu
2464 @Class menu
2465 Superclass: @ref{menu-shell} @ref{atk-implementor-iface} @ref{buildable}
2466
2467 Subclasses: @ref{recent-chooser-menu}
2468
2469 Slots:
2470 @itemize
2471 @item @anchor{slot.menu.accel-group}accel-group. Type: @ref{accel-group}. Accessor: @anchor{fn.menu-accel-group}@code{menu-accel-group}.
2472 @item @anchor{slot.menu.accel-path}accel-path. Type: @code{string}. Accessor: @anchor{fn.menu-accel-path}@code{menu-accel-path}.
2473 @item @anchor{slot.menu.active}active. Type: @code{integer}. Accessor: @anchor{fn.menu-active}@code{menu-active}.
2474 @item @anchor{slot.menu.attach-widget}attach-widget. Type: @ref{widget}. Accessor: @anchor{fn.menu-attach-widget}@code{menu-attach-widget}.
2475 @item @anchor{slot.menu.monitor}monitor. Type: @code{integer}. Accessor: @anchor{fn.menu-monitor}@code{menu-monitor}.
2476 @item @anchor{slot.menu.screen}screen. Type: @ref{g-object}. Accessor: @anchor{fn.menu-screen}@code{menu-screen}. Write-only.
2477 @item @anchor{slot.menu.tearoff-state}tearoff-state. Type: @code{boolean}. Accessor: @anchor{fn.menu-tearoff-state}@code{menu-tearoff-state}.
2478 @item @anchor{slot.menu.tearoff-title}tearoff-title. Type: @code{string}. Accessor: @anchor{fn.menu-tearoff-title}@code{menu-tearoff-title}.
2479 @end itemize
2480
2481
2482 Signals:
2483 @itemize
2484 @item @anchor{signal.menu.move-scroll}"move-scroll". Signature: (instance @ref{menu}), (arg-1 @ref{scroll-type}) @result{} void. Options: run-last, action.
2485 @end itemize
2486
2487
2488
2489
2490 @node menu-bar
2491 @section menu-bar
2492 @Class menu-bar
2493 Superclass: @ref{menu-shell} @ref{atk-implementor-iface} @ref{buildable}
2494
2495 Slots:
2496 @itemize
2497 @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}.
2498 @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}.
2499 @end itemize
2500
2501
2502 Signals:
2503 @itemize
2504 @end itemize
2505
2506
2507
2508
2509 @node menu-item
2510 @section menu-item
2511 @Class menu-item
2512 Superclass: @ref{item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2513
2514 Subclasses: @ref{tearoff-menu-item} @ref{separator-menu-item} @ref{image-menu-item} @ref{check-menu-item}
2515
2516 Slots:
2517 @itemize
2518 @item @anchor{slot.menu-item.accel-path}accel-path. Type: @code{string}. Accessor: @anchor{fn.menu-item-accel-path}@code{menu-item-accel-path}.
2519 @item @anchor{slot.menu-item.label}label. Type: @code{string}. Accessor: @anchor{fn.menu-item-label}@code{menu-item-label}.
2520 @item @anchor{slot.menu-item.right-justified}right-justified. Type: @code{boolean}. Accessor: @anchor{fn.menu-item-right-justified}@code{menu-item-right-justified}.
2521 @item @anchor{slot.menu-item.submenu}submenu. Type: @ref{menu}. Accessor: @anchor{fn.menu-item-submenu}@code{menu-item-submenu}.
2522 @item @anchor{slot.menu-item.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.menu-item-use-underline}@code{menu-item-use-underline}.
2523 @end itemize
2524
2525
2526 Signals:
2527 @itemize
2528 @item @anchor{signal.menu-item.activate}"activate". Signature: (instance @ref{menu-item}) @result{} void. Options: run-first, action.
2529 @item @anchor{signal.menu-item.activate-item}"activate-item". Signature: (instance @ref{menu-item}) @result{} void. Options: run-first.
2530 @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.
2531 @item @anchor{signal.menu-item.toggle-size-request}"toggle-size-request". Signature: (instance @ref{menu-item}), (arg-1 gpointer) @result{} void. Options: run-first.
2532 @end itemize
2533
2534
2535
2536
2537 @node menu-shell
2538 @section menu-shell
2539 @Class menu-shell
2540 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
2541
2542 Subclasses: @ref{menu-bar} @ref{menu}
2543
2544 Slots:
2545 @itemize
2546 @item @anchor{slot.menu-shell.take-focus}take-focus. Type: @code{boolean}. Accessor: @anchor{fn.menu-shell-take-focus}@code{menu-shell-take-focus}.
2547 @end itemize
2548
2549
2550 Signals:
2551 @itemize
2552 @item @anchor{signal.menu-shell.activate-current}"activate-current". Signature: (instance @ref{menu-shell}), (arg-1 @code{boolean}) @result{} void. Options: run-last, action.
2553 @item @anchor{signal.menu-shell.cancel}"cancel". Signature: (instance @ref{menu-shell}) @result{} void. Options: run-last, action.
2554 @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.
2555 @item @anchor{signal.menu-shell.deactivate}"deactivate". Signature: (instance @ref{menu-shell}) @result{} void. Options: run-first.
2556 @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.
2557 @item @anchor{signal.menu-shell.move-selected}"move-selected". Signature: (instance @ref{menu-shell}), (arg-1 @code{integer}) @result{} @code{boolean}. Options: run-last.
2558 @item @anchor{signal.menu-shell.selection-done}"selection-done". Signature: (instance @ref{menu-shell}) @result{} void. Options: run-first.
2559 @end itemize
2560
2561
2562
2563
2564 @node menu-tool-button
2565 @section menu-tool-button
2566 @Class menu-tool-button
2567 Superclass: @ref{tool-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2568
2569 Slots:
2570 @itemize
2571 @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.
2572 @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.
2573 @item @anchor{slot.menu-tool-button.menu}menu. Type: @ref{menu}. Accessor: @anchor{fn.menu-tool-button-menu}@code{menu-tool-button-menu}.
2574 @end itemize
2575
2576
2577 Signals:
2578 @itemize
2579 @item @anchor{signal.menu-tool-button.show-menu}"show-menu". Signature: (instance @ref{menu-tool-button}) @result{} void. Options: run-first.
2580 @end itemize
2581
2582
2583
2584
2585 @node message-dialog
2586 @section message-dialog
2587 @Class message-dialog
2588 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable}
2589
2590 @ref{message-dialog} presents a dialog with an image representing the
2591 type of message (Error, Question, etc.) alongside some message
2592 text. It's simply a convenience widget; you could construct the
2593 equivalent of @ref{message-dialog} from @ref{dialog} without too much
2594 effort, but @ref{message-dialog} saves typing.
2595
2596 The easiest way to do a modal message dialog is to use gtk_dialog_run(),
2597 though you can also pass in the @FlagsVRef{dialog-flags,modal} flag,
2598 @ref{dialog-run} automatically makes the dialog modal and waits for the
2599 user to respond to it. @ref{dialog-run} returns when any dialog button
2600 is clicked.
2601
2602 Slots:
2603 @itemize
2604 @item @anchor{slot.message-dialog.buttons}buttons. Type: @ref{buttons-type}. Accessor: @anchor{fn.message-dialog-buttons}@code{message-dialog-buttons}. Write-only.
2605
2606 The buttons shown in the message dialog.
2607
2608 Default value: @EnumVRef{buttons-type,none}
2609 @item @anchor{slot.message-dialog.image}image. Type: @ref{widget}. Accessor: @anchor{fn.message-dialog-image}@code{message-dialog-image}.
2610
2611 The image for this dialog
2612 @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}.
2613
2614 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.
2615
2616 Default value: @EnumVRef{message-type,info}
2617 @item @anchor{slot.message-dialog.secondary-text}secondary-text. Type: @code{string}. Accessor: @anchor{fn.message-dialog-secondary-text}@code{message-dialog-secondary-text}.
2618
2619 The secondary text of the message dialog.
2620
2621 Default value: NIL
2622 @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}.
2623
2624 True if the secondary text of the dialog includes Pango markup. See pango_parse_markup().
2625
2626 Default value: False
2627 @item @anchor{slot.message-dialog.text}text. Type: @code{string}. Accessor: @anchor{fn.message-dialog-text}@code{message-dialog-text}.
2628
2629 The primary text of the message dialog. If the dialog has a secondary text, this will appear as the title.
2630
2631 Default value: ""
2632 @item @anchor{slot.message-dialog.use-markup}use-markup. Type: @code{boolean}. Accessor: @anchor{fn.message-dialog-use-markup}@code{message-dialog-use-markup}.
2633
2634 True if the primary text of the dialog includes Pango markup. See pango_parse_markup().
2635
2636 Default value: False
2637 @end itemize
2638
2639
2640 Signals:
2641 @itemize
2642 @end itemize
2643
2644
2645 @node misc
2646 @section misc
2647 @Class misc
2648 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
2649
2650 Subclasses: @ref{image} @ref{arrow} @ref{label}
2651
2652 Slots:
2653 @itemize
2654 @item @anchor{slot.misc.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.misc-xalign}@code{misc-xalign}.
2655 @item @anchor{slot.misc.xpad}xpad. Type: @code{integer}. Accessor: @anchor{fn.misc-xpad}@code{misc-xpad}.
2656 @item @anchor{slot.misc.yalign}yalign. Type: @code{single-float}. Accessor: @anchor{fn.misc-yalign}@code{misc-yalign}.
2657 @item @anchor{slot.misc.ypad}ypad. Type: @code{integer}. Accessor: @anchor{fn.misc-ypad}@code{misc-ypad}.
2658 @end itemize
2659
2660
2661 Signals:
2662 @itemize
2663 @end itemize
2664
2665
2666
2667
2668 @node notebook
2669 @section notebook
2670 @Class notebook
2671 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
2672
2673 Slots:
2674 @itemize
2675 @item @anchor{slot.notebook.enable-popup}enable-popup. Type: @code{boolean}. Accessor: @anchor{fn.notebook-enable-popup}@code{notebook-enable-popup}.
2676 @item @anchor{slot.notebook.group}group. Type: gpointer. Accessor: @anchor{fn.notebook-group}@code{notebook-group}.
2677 @item @anchor{slot.notebook.group-id}group-id. Type: @code{integer}. Accessor: @anchor{fn.notebook-group-id}@code{notebook-group-id}.
2678 @item @anchor{slot.notebook.homogeneous}homogeneous. Type: @code{boolean}. Accessor: @anchor{fn.notebook-homogeneous}@code{notebook-homogeneous}.
2679 @item @anchor{slot.notebook.page}page. Type: @code{integer}. Accessor: @anchor{fn.notebook-page}@code{notebook-page}.
2680 @item @anchor{slot.notebook.scrollable}scrollable. Type: @code{boolean}. Accessor: @anchor{fn.notebook-scrollable}@code{notebook-scrollable}.
2681 @item @anchor{slot.notebook.show-border}show-border. Type: @code{boolean}. Accessor: @anchor{fn.notebook-show-border}@code{notebook-show-border}.
2682 @item @anchor{slot.notebook.show-tabs}show-tabs. Type: @code{boolean}. Accessor: @anchor{fn.notebook-show-tabs}@code{notebook-show-tabs}.
2683 @item @anchor{slot.notebook.tab-border}tab-border. Type: @code{integer}. Accessor: @anchor{fn.notebook-tab-border}@code{notebook-tab-border}. Write-only.
2684 @item @anchor{slot.notebook.tab-hborder}tab-hborder. Type: @code{integer}. Accessor: @anchor{fn.notebook-tab-hborder}@code{notebook-tab-hborder}.
2685 @item @anchor{slot.notebook.tab-pos}tab-pos. Type: @ref{position-type}. Accessor: @anchor{fn.notebook-tab-pos}@code{notebook-tab-pos}.
2686 @item @anchor{slot.notebook.tab-vborder}tab-vborder. Type: @code{integer}. Accessor: @anchor{fn.notebook-tab-vborder}@code{notebook-tab-vborder}.
2687 @end itemize
2688
2689
2690 Signals:
2691 @itemize
2692 @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.
2693 @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.
2694 @item @anchor{signal.notebook.focus-tab}"focus-tab". Signature: (instance @ref{notebook}), (arg-1 @ref{notebook-tab}) @result{} @code{boolean}. Options: run-last, action.
2695 @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.
2696 @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.
2697 @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.
2698 @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.
2699 @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.
2700 @item @anchor{signal.notebook.select-page}"select-page". Signature: (instance @ref{notebook}), (arg-1 @code{boolean}) @result{} @code{boolean}. Options: run-last, action.
2701 @item @anchor{signal.notebook.switch-page}"switch-page". Signature: (instance @ref{notebook}), (arg-1 gpointer), (arg-2 @code{integer}) @result{} void. Options: run-last.
2702 @end itemize
2703
2704
2705
2706
2707 @node old-editable
2708 @section old-editable
2709 @Class old-editable
2710 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{editable}
2711
2712 Subclasses: @ref{text}
2713
2714 Slots:
2715 @itemize
2716 @item @anchor{slot.old-editable.editable}editable. Type: @code{boolean}. Accessor: @anchor{fn.old-editable-editable}@code{old-editable-editable}.
2717 @item @anchor{slot.old-editable.text-position}text-position. Type: @code{integer}. Accessor: @anchor{fn.old-editable-text-position}@code{old-editable-text-position}.
2718 @end itemize
2719
2720
2721 Signals:
2722 @itemize
2723 @item @anchor{signal.old-editable.activate}"activate". Signature: (instance @ref{old-editable}) @result{} void. Options: run-last, action.
2724 @item @anchor{signal.old-editable.copy-clipboard}"copy-clipboard". Signature: (instance @ref{old-editable}) @result{} void. Options: run-last, action.
2725 @item @anchor{signal.old-editable.cut-clipboard}"cut-clipboard". Signature: (instance @ref{old-editable}) @result{} void. Options: run-last, action.
2726 @item @anchor{signal.old-editable.kill-char}"kill-char". Signature: (instance @ref{old-editable}), (arg-1 @code{integer}) @result{} void. Options: run-last, action.
2727 @item @anchor{signal.old-editable.kill-line}"kill-line". Signature: (instance @ref{old-editable}), (arg-1 @code{integer}) @result{} void. Options: run-last, action.
2728 @item @anchor{signal.old-editable.kill-word}"kill-word". Signature: (instance @ref{old-editable}), (arg-1 @code{integer}) @result{} void. Options: run-last, action.
2729 @item @anchor{signal.old-editable.move-cursor}"move-cursor". Signature: (instance @ref{old-editable}), (arg-1 @code{integer}), (arg-2 @code{integer}) @result{} void. Options: run-last, action.
2730 @item @anchor{signal.old-editable.move-page}"move-page". Signature: (instance @ref{old-editable}), (arg-1 @code{integer}), (arg-2 @code{integer}) @result{} void. Options: run-last, action.
2731 @item @anchor{signal.old-editable.move-to-column}"move-to-column". Signature: (instance @ref{old-editable}), (arg-1 @code{integer}) @result{} void. Options: run-last, action.
2732 @item @anchor{signal.old-editable.move-to-row}"move-to-row". Signature: (instance @ref{old-editable}), (arg-1 @code{integer}) @result{} void. Options: run-last, action.
2733 @item @anchor{signal.old-editable.move-word}"move-word". Signature: (instance @ref{old-editable}), (arg-1 @code{integer}) @result{} void. Options: run-last, action.
2734 @item @anchor{signal.old-editable.paste-clipboard}"paste-clipboard". Signature: (instance @ref{old-editable}) @result{} void. Options: run-last, action.
2735 @item @anchor{signal.old-editable.set-editable}"set-editable". Signature: (instance @ref{old-editable}), (arg-1 @code{boolean}) @result{} void. Options: run-last, action.
2736 @end itemize
2737
2738
2739
2740
2741 @node paned
2742 @section paned
2743 @Class paned
2744 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
2745
2746 Subclasses: @ref{v-paned} @ref{h-paned}
2747
2748 Slots:
2749 @itemize
2750 @item @anchor{slot.paned.max-position}max-position. Type: @code{integer}. Accessor: @anchor{fn.paned-max-position}@code{paned-max-position}. Read-only.
2751 @item @anchor{slot.paned.min-position}min-position. Type: @code{integer}. Accessor: @anchor{fn.paned-min-position}@code{paned-min-position}. Read-only.
2752 @item @anchor{slot.paned.position}position. Type: @code{integer}. Accessor: @anchor{fn.paned-position}@code{paned-position}.
2753 @item @anchor{slot.paned.position-set}position-set. Type: @code{boolean}. Accessor: @anchor{fn.paned-position-set}@code{paned-position-set}.
2754 @end itemize
2755
2756
2757 Signals:
2758 @itemize
2759 @item @anchor{signal.paned.accept-position}"accept-position". Signature: (instance @ref{paned}) @result{} @code{boolean}. Options: run-last, action.
2760 @item @anchor{signal.paned.cancel-position}"cancel-position". Signature: (instance @ref{paned}) @result{} @code{boolean}. Options: run-last, action.
2761 @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.
2762 @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.
2763 @item @anchor{signal.paned.move-handle}"move-handle". Signature: (instance @ref{paned}), (arg-1 @ref{scroll-type}) @result{} @code{boolean}. Options: run-last, action.
2764 @item @anchor{signal.paned.toggle-handle-focus}"toggle-handle-focus". Signature: (instance @ref{paned}) @result{} @code{boolean}. Options: run-last, action.
2765 @end itemize
2766
2767
2768
2769
2770 @node plug
2771 @section plug
2772 @Class plug
2773 Superclass: @ref{gtk-window} @ref{atk-implementor-iface} @ref{buildable}
2774
2775 Slots:
2776 @itemize
2777 @item @anchor{slot.plug.embedded}embedded. Type: @code{boolean}. Accessor: @anchor{fn.plug-embedded}@code{plug-embedded}. Read-only.
2778 @item @anchor{slot.plug.socket-window}socket-window. Type: @ref{gdk-window}. Accessor: @anchor{fn.plug-socket-window}@code{plug-socket-window}. Read-only.
2779 @end itemize
2780
2781
2782 Signals:
2783 @itemize
2784 @item @anchor{signal.plug.embedded}"embedded". Signature: (instance @ref{plug}) @result{} void. Options: run-last.
2785 @end itemize
2786
2787
2788
2789
2790 @node progress
2791 @section progress
2792 @Class progress
2793 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable}
2794
2795 Subclasses: @ref{progress-bar}
2796
2797 Slots:
2798 @itemize
2799 @item @anchor{slot.progress.activity-mode}activity-mode. Type: @code{boolean}. Accessor: @anchor{fn.progress-activity-mode}@code{progress-activity-mode}.
2800 @item @anchor{slot.progress.show-text}show-text. Type: @code{boolean}. Accessor: @anchor{fn.progress-show-text}@code{progress-show-text}.
2801 @item @anchor{slot.progress.text-xalign}text-xalign. Type: @code{single-float}. Accessor: @anchor{fn.progress-text-xalign}@code{progress-text-xalign}.
2802 @item @anchor{slot.progress.text-yalign}text-yalign. Type: @code{single-float}. Accessor: @anchor{fn.progress-text-yalign}@code{progress-text-yalign}.
2803 @end itemize
2804
2805
2806 Signals:
2807 @itemize
2808 @end itemize
2809
2810
2811
2812
2813 @node progress-bar
2814 @section progress-bar
2815 @Class progress-bar
2816 Superclass: @ref{progress} @ref{atk-implementor-iface} @ref{buildable}
2817
2818 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.
2819
2820 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.
2821
2822 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.
2823
2824 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.
2825
2826 Slots:
2827 @itemize
2828 @item @anchor{slot.progress-bar.activity-blocks}activity-blocks. Type: @code{integer}. Accessor: @anchor{fn.progress-bar-activity-blocks}@code{progress-bar-activity-blocks}.
2829
2830 The number of blocks which can fit in the progress bar area in activity mode (Deprecated).
2831
2832 Allowed values: >= 2
2833
2834 Default value: 5
2835 @item @anchor{slot.progress-bar.activity-step}activity-step. Type: @code{integer}. Accessor: @anchor{fn.progress-bar-activity-step}@code{progress-bar-activity-step}.
2836
2837 The increment used for each iteration in activity mode (Deprecated).
2838
2839 Default value: 3
2840 @item @anchor{slot.progress-bar.adjustment}adjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.progress-bar-adjustment}@code{progress-bar-adjustment}.
2841
2842 The @ref{adjustment} connected to the progress bar (Deprecated
2843 @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}.
2844
2845 Specifies the visual style of the bar in percentage mode (Deprecated).
2846
2847 Default value: @EnumVRef{progress-bar-style,continuous}
2848 @item @anchor{slot.progress-bar.discrete-blocks}discrete-blocks. Type: @code{integer}. Accessor: @anchor{fn.progress-bar-discrete-blocks}@code{progress-bar-discrete-blocks}.
2849
2850 The number of discrete blocks in a progress bar (when shown in the discrete style).
2851
2852 Allowed values: >= 2
2853
2854 Default value: 10
2855 @item @anchor{slot.progress-bar.ellipsize}ellipsize. Type: @ref{pango-ellipsize-mode}. Accessor: @anchor{fn.progress-bar-ellipsize}@code{progress-bar-ellipsize}.
2856
2857 The preferred place to ellipsize the string, if the progressbar does not have enough room to display the entire string.
2858
2859 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}.
2860
2861 Default value: @EnumVRef{pango-ellipsize-mode,none}
2862 @item @anchor{slot.progress-bar.fraction}fraction. Type: @code{double-float}. Accessor: @anchor{fn.progress-bar-fraction}@code{progress-bar-fraction}.
2863
2864 The fraction of total work that has been completed.
2865
2866 Allowed values: [0,1]
2867
2868 Default value: 0
2869 @item @anchor{slot.progress-bar.orientation}orientation. Type: @ref{progress-bar-orientation}. Accessor: @anchor{fn.progress-bar-orientation}@code{progress-bar-orientation}.
2870
2871 Orientation and growth direction of the progress bar.
2872
2873 Default value: @EnumVRef{progress-bar-orientation,left-to-right}
2874 @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}.
2875
2876 The fraction of total progress to move the bouncing block when pulsed.
2877
2878 Allowed values: [0,1]
2879
2880 Default value: 0.1
2881 @item @anchor{slot.progress-bar.text}text. Type: @code{string}. Accessor: @anchor{fn.progress-bar-text}@code{progress-bar-text}.
2882
2883 Text to be displayed in the progress bar.
2884
2885 Default value: NIL
2886 @end itemize
2887
2888
2889 Signals:
2890 @itemize
2891 @end itemize
2892
2893 @RMethod progress-bar-pulse
2894 @lisp
2895 (progress-bar-pulse progress-bar)
2896 @end lisp
2897
2898 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}).
2899
2900 @node radio-button
2901 @section radio-button
2902 @Class radio-button
2903 Superclass: @ref{check-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2904
2905 Slots:
2906 @itemize
2907 @item @anchor{slot.radio-button.group}group. Type: @ref{radio-button}. Accessor: @anchor{fn.radio-button-group}@code{radio-button-group}. Write-only.
2908 @end itemize
2909
2910
2911 Signals:
2912 @itemize
2913 @item @anchor{signal.radio-button.group-changed}"group-changed". Signature: (instance @ref{radio-button}) @result{} void. Options: run-first.
2914 @end itemize
2915
2916
2917
2918
2919 @node radio-menu-item
2920 @section radio-menu-item
2921 @Class radio-menu-item
2922 Superclass: @ref{check-menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2923
2924 Slots:
2925 @itemize
2926 @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.
2927 @end itemize
2928
2929
2930 Signals:
2931 @itemize
2932 @item @anchor{signal.radio-menu-item.group-changed}"group-changed". Signature: (instance @ref{radio-menu-item}) @result{} void. Options: run-first.
2933 @end itemize
2934
2935
2936
2937
2938 @node radio-tool-button
2939 @section radio-tool-button
2940 @Class radio-tool-button
2941 Superclass: @ref{toggle-tool-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
2942
2943 Slots:
2944 @itemize
2945 @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.
2946 @end itemize
2947
2948
2949 Signals:
2950 @itemize
2951 @end itemize
2952
2953
2954
2955
2956 @node range
2957 @section range
2958 @Class range
2959 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
2960
2961 Subclasses: @ref{scrollbar} @ref{scale}
2962
2963 Slots:
2964 @itemize
2965 @item @anchor{slot.range.adjustment}adjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.range-adjustment}@code{range-adjustment}.
2966 @item @anchor{slot.range.fill-level}fill-level. Type: @code{double-float}. Accessor: @anchor{fn.range-fill-level}@code{range-fill-level}.
2967 @item @anchor{slot.range.inverted}inverted. Type: @code{boolean}. Accessor: @anchor{fn.range-inverted}@code{range-inverted}.
2968 @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}.
2969 @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}.
2970 @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}.
2971 @item @anchor{slot.range.update-policy}update-policy. Type: @ref{update-type}. Accessor: @anchor{fn.range-update-policy}@code{range-update-policy}.
2972 @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}.
2973 @end itemize
2974
2975
2976 Signals:
2977 @itemize
2978 @item @anchor{signal.range.adjust-bounds}"adjust-bounds". Signature: (instance @ref{range}), (arg-1 @code{double-float}) @result{} void. Options: run-last.
2979 @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.
2980 @item @anchor{signal.range.move-slider}"move-slider". Signature: (instance @ref{range}), (arg-1 @ref{scroll-type}) @result{} void. Options: run-last, action.
2981 @item @anchor{signal.range.value-changed}"value-changed". Signature: (instance @ref{range}) @result{} void. Options: run-last.
2982 @end itemize
2983
2984
2985
2986
2987 @node recent-chooser-dialog
2988 @section recent-chooser-dialog
2989 @Class recent-chooser-dialog
2990 Superclass: @ref{dialog} @ref{atk-implementor-iface} @ref{buildable} @ref{recent-chooser}
2991
2992 Slots:
2993 @itemize
2994 @end itemize
2995
2996
2997 Signals:
2998 @itemize
2999 @end itemize
3000
3001
3002
3003
3004 @node recent-chooser-menu
3005 @section recent-chooser-menu
3006 @Class recent-chooser-menu
3007 Superclass: @ref{menu} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable} @ref{recent-chooser}
3008
3009 Slots:
3010 @itemize
3011 @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}.
3012 @end itemize
3013
3014
3015 Signals:
3016 @itemize
3017 @end itemize
3018
3019
3020
3021
3022 @node recent-chooser-widget
3023 @section recent-chooser-widget
3024 @Class recent-chooser-widget
3025 Superclass: @ref{v-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable} @ref{recent-chooser}
3026
3027 Slots:
3028 @itemize
3029 @end itemize
3030
3031
3032 Signals:
3033 @itemize
3034 @end itemize
3035
3036
3037
3038
3039 @node ruler
3040 @section ruler
3041 @Class ruler
3042 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3043
3044 Subclasses: @ref{v-ruler} @ref{h-ruler}
3045
3046 Slots:
3047 @itemize
3048 @item @anchor{slot.ruler.lower}lower. Type: @code{double-float}. Accessor: @anchor{fn.ruler-lower}@code{ruler-lower}.
3049 @item @anchor{slot.ruler.max-size}max-size. Type: @code{double-float}. Accessor: @anchor{fn.ruler-max-size}@code{ruler-max-size}.
3050 @item @anchor{slot.ruler.metric}metric. Type: @ref{metric-type}. Accessor: @anchor{fn.ruler-metric}@code{ruler-metric}.
3051 @item @anchor{slot.ruler.position}position. Type: @code{double-float}. Accessor: @anchor{fn.ruler-position}@code{ruler-position}.
3052 @item @anchor{slot.ruler.upper}upper. Type: @code{double-float}. Accessor: @anchor{fn.ruler-upper}@code{ruler-upper}.
3053 @end itemize
3054
3055
3056 Signals:
3057 @itemize
3058 @end itemize
3059
3060
3061
3062
3063 @node scale
3064 @section scale
3065 @Class scale
3066 Superclass: @ref{range} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3067
3068 Subclasses: @ref{v-scale} @ref{h-scale}
3069
3070 Slots:
3071 @itemize
3072 @item @anchor{slot.scale.digits}digits. Type: @code{integer}. Accessor: @anchor{fn.scale-digits}@code{scale-digits}.
3073 @item @anchor{slot.scale.draw-value}draw-value. Type: @code{boolean}. Accessor: @anchor{fn.scale-draw-value}@code{scale-draw-value}.
3074 @item @anchor{slot.scale.value-pos}value-pos. Type: @ref{position-type}. Accessor: @anchor{fn.scale-value-pos}@code{scale-value-pos}.
3075 @end itemize
3076
3077
3078 Signals:
3079 @itemize
3080 @item @anchor{signal.scale.format-value}"format-value". Signature: (instance @ref{scale}), (arg-1 @code{double-float}) @result{} @code{string}. Options: run-last.
3081 @end itemize
3082
3083
3084
3085
3086 @node scale-button
3087 @section scale-button
3088 @Class scale-button
3089 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable} @ref{orientable}
3090
3091 Subclasses: @ref{volume-button}
3092
3093 Slots:
3094 @itemize
3095 @item @anchor{slot.scale-button.adjustment}adjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.scale-button-adjustment}@code{scale-button-adjustment}.
3096 @item @anchor{slot.scale-button.icons}icons. Type: @code{GStrv}. Accessor: @anchor{fn.scale-button-icons}@code{scale-button-icons}.
3097 @item @anchor{slot.scale-button.size}size. Type: @ref{icon-size}. Accessor: @anchor{fn.scale-button-size}@code{scale-button-size}.
3098 @item @anchor{slot.scale-button.value}value. Type: @code{double-float}. Accessor: @anchor{fn.scale-button-value}@code{scale-button-value}.
3099 @end itemize
3100
3101
3102 Signals:
3103 @itemize
3104 @item @anchor{signal.scale-button.popdown}"popdown". Signature: (instance @ref{scale-button}) @result{} void. Options: run-last, action.
3105 @item @anchor{signal.scale-button.popup}"popup". Signature: (instance @ref{scale-button}) @result{} void. Options: run-last, action.
3106 @item @anchor{signal.scale-button.value-changed}"value-changed". Signature: (instance @ref{scale-button}), (arg-1 @code{double-float}) @result{} void. Options: run-last.
3107 @end itemize
3108
3109
3110
3111
3112 @node scrollbar
3113 @section scrollbar
3114 @Class scrollbar
3115 Superclass: @ref{range} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3116
3117 Subclasses: @ref{v-scrollbar} @ref{h-scrollbar}
3118
3119 Slots:
3120 @itemize
3121 @end itemize
3122
3123
3124 Signals:
3125 @itemize
3126 @end itemize
3127
3128
3129
3130
3131 @node scrolled-window
3132 @section scrolled-window
3133 @Class scrolled-window
3134 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
3135
3136 Slots:
3137 @itemize
3138 @item @anchor{slot.scrolled-window.hadjustment}hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.scrolled-window-hadjustment}@code{scrolled-window-hadjustment}.
3139 @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}.
3140 @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}.
3141 @item @anchor{slot.scrolled-window.vadjustment}vadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.scrolled-window-vadjustment}@code{scrolled-window-vadjustment}.
3142 @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}.
3143 @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}.
3144 @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}.
3145 @end itemize
3146
3147
3148 Signals:
3149 @itemize
3150 @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.
3151 @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.
3152 @end itemize
3153
3154
3155
3156
3157 @node separator
3158 @section separator
3159 @Class separator
3160 Superclass: @ref{widget} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3161
3162 Subclasses: @ref{v-separator} @ref{h-separator}
3163
3164 Slots:
3165 @itemize
3166 @end itemize
3167
3168
3169 Signals:
3170 @itemize
3171 @end itemize
3172
3173
3174
3175
3176 @node separator-menu-item
3177 @section separator-menu-item
3178 @Class separator-menu-item
3179 Superclass: @ref{menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3180
3181 Slots:
3182 @itemize
3183 @end itemize
3184
3185
3186 Signals:
3187 @itemize
3188 @end itemize
3189
3190
3191
3192
3193 @node separator-tool-item
3194 @section separator-tool-item
3195 @Class separator-tool-item
3196 Superclass: @ref{tool-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3197
3198 Slots:
3199 @itemize
3200 @item @anchor{slot.separator-tool-item.draw}draw. Type: @code{boolean}. Accessor: @anchor{fn.separator-tool-item-draw}@code{separator-tool-item-draw}.
3201 @end itemize
3202
3203
3204 Signals:
3205 @itemize
3206 @end itemize
3207
3208
3209
3210
3211 @node socket
3212 @section socket
3213 @Class socket
3214 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3215
3216 Slots:
3217 @itemize
3218 @end itemize
3219
3220
3221 Signals:
3222 @itemize
3223 @item @anchor{signal.socket.plug-added}"plug-added". Signature: (instance @ref{socket}) @result{} void. Options: run-last.
3224 @item @anchor{signal.socket.plug-removed}"plug-removed". Signature: (instance @ref{socket}) @result{} @code{boolean}. Options: run-last.
3225 @end itemize
3226
3227
3228
3229
3230 @node spin-button
3231 @section spin-button
3232 @Class spin-button
3233 Superclass: @ref{entry} @ref{atk-implementor-iface} @ref{buildable} @ref{cell-editable} @ref{editable}
3234
3235 Slots:
3236 @itemize
3237 @item @anchor{slot.spin-button.adjustment}adjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.spin-button-adjustment}@code{spin-button-adjustment}.
3238 @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}.
3239 @item @anchor{slot.spin-button.digits}digits. Type: @code{integer}. Accessor: @anchor{fn.spin-button-digits}@code{spin-button-digits}.
3240 @item @anchor{slot.spin-button.numeric}numeric. Type: @code{boolean}. Accessor: @anchor{fn.spin-button-numeric}@code{spin-button-numeric}.
3241 @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}.
3242 @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}.
3243 @item @anchor{slot.spin-button.value}value. Type: @code{double-float}. Accessor: @anchor{fn.spin-button-value}@code{spin-button-value}.
3244 @item @anchor{slot.spin-button.wrap}wrap. Type: @code{boolean}. Accessor: @anchor{fn.spin-button-wrap}@code{spin-button-wrap}.
3245 @end itemize
3246
3247
3248 Signals:
3249 @itemize
3250 @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.
3251 @item @anchor{signal.spin-button.input}"input". Signature: (instance @ref{spin-button}), (arg-1 gpointer) @result{} @code{integer}. Options: run-last.
3252 @item @anchor{signal.spin-button.output}"output". Signature: (instance @ref{spin-button}) @result{} @code{boolean}. Options: run-last.
3253 @item @anchor{signal.spin-button.value-changed}"value-changed". Signature: (instance @ref{spin-button}) @result{} void. Options: run-last.
3254 @item @anchor{signal.spin-button.wrapped}"wrapped". Signature: (instance @ref{spin-button}) @result{} void. Options: run-last.
3255 @end itemize
3256
3257
3258
3259
3260 @node statusbar
3261 @section statusbar
3262 @Class statusbar
3263 Superclass: @ref{h-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3264
3265 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.
3266
3267 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.
3268
3269 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.
3270
3271 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).
3272
3273 Messages are added to the bar's stack with @ref{statusbar-push}.
3274
3275 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}.
3276
3277 Slots:
3278 @itemize
3279 @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}.
3280
3281 Whether the statusbar has a grip for resizing the toplevel window.
3282
3283 Default value: True
3284 @end itemize
3285
3286
3287 Signals:
3288 @itemize
3289 @item @anchor{signal.statusbar.text-popped}"text-popped". Signature: (instance @ref{statusbar}), (context-id @code{integer}), (text @code{string}) @result{} void. Options: run-last.
3290
3291 Is emitted whenever a new message is popped off a statusbar's stack.
3292
3293 @var{context-id} is a numeric identifier of a context.
3294 @item @anchor{signal.statusbar.text-pushed}"text-pushed". Signature: (instance @ref{statusbar}), (context-id @code{integer}), (text @code{string}) @result{} void. Options: run-last.
3295
3296 Is emitted whenever a new message gets pushed onto a statusbar's stack.
3297
3298 @var{context-id} is a numeric identifier of a context.
3299 @end itemize
3300
3301 @RMethod statusbar-context-id
3302 @lisp
3303 (statusbar-context-id statusbar context-description) @result{} context-id
3304 @end lisp
3305
3306 Returns a context identifier, given a description of the actual context. Note that the description is not shown in the UI.
3307
3308 @var{context-description} is a string - textual description of what context the new message is being used in
3309
3310 @RMethod statusbar-push
3311 @lisp
3312 (statusbar-push statusbar context text) @result{} message-id
3313 @end lisp
3314
3315 Pushes a new message onto a statusbar's stack.
3316
3317 @var{context}: a string (context description) or a number obtained by @ref{statusbar-context-id}
3318
3319 @var{text}: the message to add to the statusbar
3320
3321 @var{message-id}: a message id that can be used with @ref{statusbar-remove}.
3322
3323 @RMethod statusbar-pop
3324 @lisp
3325 (statusbar-pop statusbar context)
3326 @end lisp
3327
3328 Removes the first message in the @ref{statusbar}'s stack with the given context.
3329
3330 Note that this may not change the displayed message, if the message at the top of the stack has a different context.
3331
3332 @var{context}: a string (context description) or a number obtained by @ref{statusbar-context-id}
3333
3334 @RMethod statusbar-remove
3335 @lisp
3336 (statusbar-remove statusbar context message-id)
3337 @end lisp
3338
3339 Forces the removal of a message from a statusbar's stack. The exact @var{context} and @var{message-id} must be specified.
3340
3341 @var{context}: a string (context description) or a number obtained by @ref{statusbar-context-id}
3342
3343 @var{message-id}: a message identifier returned by @ref{statusbar-push}
3344
3345 @node table
3346 @section table
3347 @Class table
3348 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3349
3350 Slots:
3351 @itemize
3352 @item @anchor{slot.table.column-spacing}column-spacing. Type: @code{integer}. Accessor: @anchor{fn.table-column-spacing}@code{table-column-spacing}.
3353 @item @anchor{slot.table.homogeneous}homogeneous. Type: @code{boolean}. Accessor: @anchor{fn.table-homogeneous}@code{table-homogeneous}.
3354 @item @anchor{slot.table.n-columns}n-columns. Type: @code{integer}. Accessor: @anchor{fn.table-n-columns}@code{table-n-columns}.
3355 @item @anchor{slot.table.n-rows}n-rows. Type: @code{integer}. Accessor: @anchor{fn.table-n-rows}@code{table-n-rows}.
3356 @item @anchor{slot.table.row-spacing}row-spacing. Type: @code{integer}. Accessor: @anchor{fn.table-row-spacing}@code{table-row-spacing}.
3357 @end itemize
3358
3359
3360 Signals:
3361 @itemize
3362 @end itemize
3363
3364
3365
3366
3367 @node tearoff-menu-item
3368 @section tearoff-menu-item
3369 @Class tearoff-menu-item
3370 Superclass: @ref{menu-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3371
3372 Slots:
3373 @itemize
3374 @end itemize
3375
3376
3377 Signals:
3378 @itemize
3379 @end itemize
3380
3381
3382
3383
3384 @node text
3385 @section text
3386 @Class text
3387 Superclass: @ref{old-editable} @ref{atk-implementor-iface} @ref{buildable} @ref{editable}
3388
3389 Slots:
3390 @itemize
3391 @item @anchor{slot.text.hadjustment}hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.text-hadjustment}@code{text-hadjustment}.
3392 @item @anchor{slot.text.line-wrap}line-wrap. Type: @code{boolean}. Accessor: @anchor{fn.text-line-wrap}@code{text-line-wrap}.
3393 @item @anchor{slot.text.vadjustment}vadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.text-vadjustment}@code{text-vadjustment}.
3394 @item @anchor{slot.text.word-wrap}word-wrap. Type: @code{boolean}. Accessor: @anchor{fn.text-word-wrap}@code{text-word-wrap}.
3395 @end itemize
3396
3397
3398 Signals:
3399 @itemize
3400 @item @anchor{signal.text.set-scroll-adjustments}"set-scroll-adjustments". Signature: (instance @ref{text}), (arg-1 @ref{adjustment}), (arg-2 @ref{adjustment}) @result{} void. Options: run-last.
3401 @end itemize
3402
3403
3404
3405
3406 @node text-view
3407 @section text-view
3408 @Class text-view
3409 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3410
3411 Slots:
3412 @itemize
3413 @item @anchor{slot.text-view.accepts-tab}accepts-tab. Type: @code{boolean}. Accessor: @anchor{fn.text-view-accepts-tab}@code{text-view-accepts-tab}.
3414 @item @anchor{slot.text-view.buffer}buffer. Type: @ref{text-buffer}. Accessor: @anchor{fn.text-view-buffer}@code{text-view-buffer}.
3415 @item @anchor{slot.text-view.cursor-visible}cursor-visible. Type: @code{boolean}. Accessor: @anchor{fn.text-view-cursor-visible}@code{text-view-cursor-visible}.
3416 @item @anchor{slot.text-view.editable}editable. Type: @code{boolean}. Accessor: @anchor{fn.text-view-editable}@code{text-view-editable}.
3417 @item @anchor{slot.text-view.im-module}im-module. Type: @code{string}. Accessor: @anchor{fn.text-view-im-module}@code{text-view-im-module}.
3418 @item @anchor{slot.text-view.indent}indent. Type: @code{integer}. Accessor: @anchor{fn.text-view-indent}@code{text-view-indent}.
3419 @item @anchor{slot.text-view.justification}justification. Type: @ref{justification}. Accessor: @anchor{fn.text-view-justification}@code{text-view-justification}.
3420 @item @anchor{slot.text-view.left-margin}left-margin. Type: @code{integer}. Accessor: @anchor{fn.text-view-left-margin}@code{text-view-left-margin}.
3421 @item @anchor{slot.text-view.overwrite}overwrite. Type: @code{boolean}. Accessor: @anchor{fn.text-view-overwrite}@code{text-view-overwrite}.
3422 @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}.
3423 @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}.
3424 @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}.
3425 @item @anchor{slot.text-view.right-margin}right-margin. Type: @code{integer}. Accessor: @anchor{fn.text-view-right-margin}@code{text-view-right-margin}.
3426 @item @anchor{slot.text-view.tabs}tabs. Type: @code{PangoTabArray}. Accessor: @anchor{fn.text-view-tabs}@code{text-view-tabs}.
3427 @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}.
3428 @end itemize
3429
3430
3431 Signals:
3432 @itemize
3433 @item @anchor{signal.text-view.backspace}"backspace". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3434 @item @anchor{signal.text-view.copy-clipboard}"copy-clipboard". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3435 @item @anchor{signal.text-view.cut-clipboard}"cut-clipboard". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3436 @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.
3437 @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.
3438 @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.
3439 @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.
3440 @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.
3441 @item @anchor{signal.text-view.paste-clipboard}"paste-clipboard". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3442 @item @anchor{signal.text-view.populate-popup}"populate-popup". Signature: (instance @ref{text-view}), (arg-1 @ref{menu}) @result{} void. Options: run-last.
3443 @item @anchor{signal.text-view.select-all}"select-all". Signature: (instance @ref{text-view}), (arg-1 @code{boolean}) @result{} void. Options: run-last, action.
3444 @item @anchor{signal.text-view.set-anchor}"set-anchor". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3445 @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.
3446 @item @anchor{signal.text-view.toggle-cursor-visible}"toggle-cursor-visible". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3447 @item @anchor{signal.text-view.toggle-overwrite}"toggle-overwrite". Signature: (instance @ref{text-view}) @result{} void. Options: run-last, action.
3448 @end itemize
3449
3450
3451
3452
3453 @node toggle-button
3454 @section toggle-button
3455 @Class toggle-button
3456 Superclass: @ref{button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3457
3458 Subclasses: @ref{check-button}
3459
3460 Slots:
3461 @itemize
3462 @item @anchor{slot.toggle-button.active}active. Type: @code{boolean}. Accessor: @anchor{fn.toggle-button-active}@code{toggle-button-active}.
3463 @item @anchor{slot.toggle-button.draw-indicator}draw-indicator. Type: @code{boolean}. Accessor: @anchor{fn.toggle-button-draw-indicator}@code{toggle-button-draw-indicator}.
3464 @item @anchor{slot.toggle-button.inconsistent}inconsistent. Type: @code{boolean}. Accessor: @anchor{fn.toggle-button-inconsistent}@code{toggle-button-inconsistent}.
3465 @end itemize
3466
3467
3468 Signals:
3469 @itemize
3470 @item @anchor{signal.toggle-button.toggled}"toggled". Signature: (instance @ref{toggle-button}) @result{} void. Options: run-first.
3471 @end itemize
3472
3473
3474
3475
3476 @node toggle-tool-button
3477 @section toggle-tool-button
3478 @Class toggle-tool-button
3479 Superclass: @ref{tool-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3480
3481 Subclasses: @ref{radio-tool-button}
3482
3483 Slots:
3484 @itemize
3485 @item @anchor{slot.toggle-tool-button.active}active. Type: @code{boolean}. Accessor: @anchor{fn.toggle-tool-button-active}@code{toggle-tool-button-active}.
3486 @end itemize
3487
3488
3489 Signals:
3490 @itemize
3491 @item @anchor{signal.toggle-tool-button.toggled}"toggled". Signature: (instance @ref{toggle-tool-button}) @result{} void. Options: run-first.
3492 @end itemize
3493
3494
3495
3496
3497 @node tool-button
3498 @section tool-button
3499 @Class tool-button
3500 Superclass: @ref{tool-item} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3501
3502 Subclasses: @ref{toggle-tool-button} @ref{menu-tool-button}
3503
3504 Slots:
3505 @itemize
3506 @item @anchor{slot.tool-button.icon-name}icon-name. Type: @code{string}. Accessor: @anchor{fn.tool-button-icon-name}@code{tool-button-icon-name}.
3507 @item @anchor{slot.tool-button.icon-widget}icon-widget. Type: @ref{widget}. Accessor: @anchor{fn.tool-button-icon-widget}@code{tool-button-icon-widget}.
3508 @item @anchor{slot.tool-button.label}label. Type: @code{string}. Accessor: @anchor{fn.tool-button-label}@code{tool-button-label}.
3509 @item @anchor{slot.tool-button.label-widget}label-widget. Type: @ref{widget}. Accessor: @anchor{fn.tool-button-label-widget}@code{tool-button-label-widget}.
3510 @item @anchor{slot.tool-button.stock-id}stock-id. Type: @code{string}. Accessor: @anchor{fn.tool-button-stock-id}@code{tool-button-stock-id}.
3511 @item @anchor{slot.tool-button.use-underline}use-underline. Type: @code{boolean}. Accessor: @anchor{fn.tool-button-use-underline}@code{tool-button-use-underline}.
3512 @end itemize
3513
3514
3515 Signals:
3516 @itemize
3517 @item @anchor{signal.tool-button.clicked}"clicked". Signature: (instance @ref{tool-button}) @result{} void. Options: run-first, action.
3518 @end itemize
3519
3520
3521
3522
3523 @node tool-item
3524 @section tool-item
3525 @Class tool-item
3526 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable}
3527
3528 Subclasses: @ref{separator-tool-item} @ref{tool-button}
3529
3530 Slots:
3531 @itemize
3532 @item @anchor{slot.tool-item.expand}expand. Type: @code{boolean}. Accessor: @anchor{fn.tool-item-expand}@code{tool-item-expand}.
3533 @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.
3534 @item @anchor{slot.tool-item.is-important}is-important. Type: @code{boolean}. Accessor: @anchor{fn.tool-item-is-important}@code{tool-item-is-important}.
3535 @item @anchor{slot.tool-item.orientation}orientation. Type: @ref{orientation}. Accessor: @anchor{fn.tool-item-orientation}@code{tool-item-orientation}. Read-only.
3536 @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.
3537 @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.
3538 @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}.
3539 @item @anchor{slot.tool-item.visible-horizontal}visible-horizontal. Type: @code{boolean}. Accessor: @anchor{fn.tool-item-visible-horizontal}@code{tool-item-visible-horizontal}.
3540 @item @anchor{slot.tool-item.visible-vertical}visible-vertical. Type: @code{boolean}. Accessor: @anchor{fn.tool-item-visible-vertical}@code{tool-item-visible-vertical}.
3541 @end itemize
3542
3543
3544 Signals:
3545 @itemize
3546 @item @anchor{signal.tool-item.create-menu-proxy}"create-menu-proxy". Signature: (instance @ref{tool-item}) @result{} @code{boolean}. Options: run-last.
3547 @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.
3548 @item @anchor{signal.tool-item.toolbar-reconfigured}"toolbar-reconfigured". Signature: (instance @ref{tool-item}) @result{} void. Options: run-last.
3549 @end itemize
3550
3551
3552
3553
3554 @node toolbar
3555 @section toolbar
3556 @Class toolbar
3557 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable} @ref{tool-shell}
3558
3559 Slots:
3560 @itemize
3561 @item @anchor{slot.toolbar.icon-size}icon-size. Type: @code{integer}. Accessor: @anchor{fn.toolbar-icon-size}@code{toolbar-icon-size}.
3562 @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}.
3563 @item @anchor{slot.toolbar.show-arrow}show-arrow. Type: @code{boolean}. Accessor: @anchor{fn.toolbar-show-arrow}@code{toolbar-show-arrow}.
3564 @item @anchor{slot.toolbar.toolbar-style}toolbar-style. Type: @ref{toolbar-style}. Accessor: @anchor{fn.toolbar-toolbar-style}@code{toolbar-toolbar-style}.
3565 @item @anchor{slot.toolbar.tooltips}tooltips. Type: @code{boolean}. Accessor: @anchor{fn.toolbar-tooltips}@code{toolbar-tooltips}.
3566 @end itemize
3567
3568
3569 Signals:
3570 @itemize
3571 @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.
3572 @item @anchor{signal.toolbar.orientation-changed}"orientation-changed". Signature: (instance @ref{toolbar}), (arg-1 @ref{orientation}) @result{} void. Options: run-first.
3573 @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.
3574 @item @anchor{signal.toolbar.style-changed}"style-changed". Signature: (instance @ref{toolbar}), (arg-1 @ref{toolbar-style}) @result{} void. Options: run-first.
3575 @end itemize
3576
3577
3578
3579
3580 @node tree
3581 @section tree
3582 @Class tree
3583 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3584
3585 Slots:
3586 @itemize
3587 @end itemize
3588
3589
3590 Signals:
3591 @itemize
3592 @item @anchor{signal.tree.select-child}"select-child". Signature: (instance @ref{tree}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
3593 @item @anchor{signal.tree.selection-changed}"selection-changed". Signature: (instance @ref{tree}) @result{} void. Options: run-first.
3594 @item @anchor{signal.tree.unselect-child}"unselect-child". Signature: (instance @ref{tree}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
3595 @end itemize
3596
3597
3598
3599
3600 @node tree-item
3601 @section tree-item
3602 @Class tree-item
3603 Superclass: @ref{item} @ref{atk-implementor-iface} @ref{buildable}
3604
3605 Slots:
3606 @itemize
3607 @end itemize
3608
3609
3610 Signals:
3611 @itemize
3612 @item @anchor{signal.tree-item.collapse}"collapse". Signature: (instance @ref{tree-item}) @result{} void. Options: run-first.
3613 @item @anchor{signal.tree-item.expand}"expand". Signature: (instance @ref{tree-item}) @result{} void. Options: run-first.
3614 @end itemize
3615
3616
3617
3618
3619 @node tree-view
3620 @section tree-view
3621 @Class tree-view
3622 Superclass: @ref{container} @ref{atk-implementor-iface} @ref{buildable}
3623
3624 Slots:
3625 @itemize
3626 @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.
3627 @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.
3628 @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}.
3629 @item @anchor{slot.tree-view.enable-search}enable-search. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-enable-search}@code{tree-view-enable-search}.
3630 @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}.
3631 @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}.
3632 @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}.
3633 @item @anchor{slot.tree-view.hadjustment}hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.tree-view-hadjustment}@code{tree-view-hadjustment}.
3634 @item @anchor{slot.tree-view.headers-clickable}headers-clickable. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-headers-clickable}@code{tree-view-headers-clickable}.
3635 @item @anchor{slot.tree-view.headers-visible}headers-visible. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-headers-visible}@code{tree-view-headers-visible}.
3636 @item @anchor{slot.tree-view.hover-expand}hover-expand. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-hover-expand}@code{tree-view-hover-expand}.
3637 @item @anchor{slot.tree-view.hover-selection}hover-selection. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-hover-selection}@code{tree-view-hover-selection}.
3638 @item @anchor{slot.tree-view.level-indentation}level-indentation. Type: @code{integer}. Accessor: @anchor{fn.tree-view-level-indentation}@code{tree-view-level-indentation}.
3639 @item @anchor{slot.tree-view.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.tree-view-model}@code{tree-view-model}.
3640 @item @anchor{slot.tree-view.reorderable}reorderable. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-reorderable}@code{tree-view-reorderable}.
3641 @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.
3642 @item @anchor{slot.tree-view.rubber-banding}rubber-banding. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-rubber-banding}@code{tree-view-rubber-banding}.
3643 @item @anchor{slot.tree-view.rules-hint}rules-hint. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-rules-hint}@code{tree-view-rules-hint}.
3644 @item @anchor{slot.tree-view.search-column}search-column. Type: @code{integer}. Accessor: @anchor{fn.tree-view-search-column}@code{tree-view-search-column}.
3645 @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}.
3646 @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.
3647 @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.
3648 @item @anchor{slot.tree-view.selection}selection. Type: @ref{g-object}. Accessor: @anchor{fn.tree-view-selection}@code{tree-view-selection}. Read-only.
3649 @item @anchor{slot.tree-view.show-expanders}show-expanders. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-show-expanders}@code{tree-view-show-expanders}.
3650 @item @anchor{slot.tree-view.tooltip-column}tooltip-column. Type: @code{integer}. Accessor: @anchor{fn.tree-view-tooltip-column}@code{tree-view-tooltip-column}.
3651 @item @anchor{slot.tree-view.vadjustment}vadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.tree-view-vadjustment}@code{tree-view-vadjustment}.
3652 @end itemize
3653
3654
3655 Signals:
3656 @itemize
3657 @item @anchor{signal.tree-view.columns-changed}"columns-changed". Signature: (instance @ref{tree-view}) @result{} void. Options: run-last.
3658 @item @anchor{signal.tree-view.cursor-changed}"cursor-changed". Signature: (instance @ref{tree-view}) @result{} void. Options: run-last.
3659 @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.
3660 @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.
3661 @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.
3662 @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.
3663 @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.
3664 @item @anchor{signal.tree-view.select-all}"select-all". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
3665 @item @anchor{signal.tree-view.select-cursor-parent}"select-cursor-parent". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
3666 @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.
3667 @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.
3668 @item @anchor{signal.tree-view.start-interactive-search}"start-interactive-search". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
3669 @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.
3670 @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.
3671 @item @anchor{signal.tree-view.toggle-cursor-row}"toggle-cursor-row". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
3672 @item @anchor{signal.tree-view.unselect-all}"unselect-all". Signature: (instance @ref{tree-view}) @result{} @code{boolean}. Options: run-last, action.
3673 @end itemize
3674
3675
3676
3677
3678 @node v-box
3679 @section v-box
3680 @Class v-box
3681 Superclass: @ref{box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3682
3683 Subclasses: @ref{recent-chooser-widget} @ref{gamma-curve} @ref{font-selection} @ref{file-chooser-widget} @ref{color-selection}
3684
3685 Slots:
3686 @itemize
3687 @end itemize
3688
3689
3690 Signals:
3691 @itemize
3692 @end itemize
3693
3694
3695
3696
3697 @node v-button-box
3698 @section v-button-box
3699 @Class v-button-box
3700 Superclass: @ref{button-box} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3701
3702 Slots:
3703 @itemize
3704 @end itemize
3705
3706
3707 Signals:
3708 @itemize
3709 @end itemize
3710
3711
3712
3713
3714 @node v-paned
3715 @section v-paned
3716 @Class v-paned
3717 Superclass: @ref{paned} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3718
3719 Slots:
3720 @itemize
3721 @end itemize
3722
3723
3724 Signals:
3725 @itemize
3726 @end itemize
3727
3728
3729
3730
3731 @node v-ruler
3732 @section v-ruler
3733 @Class v-ruler
3734 Superclass: @ref{ruler} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3735
3736 Slots:
3737 @itemize
3738 @end itemize
3739
3740
3741 Signals:
3742 @itemize
3743 @end itemize
3744
3745
3746
3747
3748 @node v-scale
3749 @section v-scale
3750 @Class v-scale
3751 Superclass: @ref{scale} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3752
3753 Slots:
3754 @itemize
3755 @end itemize
3756
3757
3758 Signals:
3759 @itemize
3760 @end itemize
3761
3762
3763
3764
3765 @node v-scrollbar
3766 @section v-scrollbar
3767 @Class v-scrollbar
3768 Superclass: @ref{scrollbar} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3769
3770 Slots:
3771 @itemize
3772 @end itemize
3773
3774
3775 Signals:
3776 @itemize
3777 @end itemize
3778
3779
3780
3781
3782 @node v-separator
3783 @section v-separator
3784 @Class v-separator
3785 Superclass: @ref{separator} @ref{atk-implementor-iface} @ref{buildable} @ref{orientable}
3786
3787 Slots:
3788 @itemize
3789 @end itemize
3790
3791
3792 Signals:
3793 @itemize
3794 @end itemize
3795
3796
3797
3798
3799 @node viewport
3800 @section viewport
3801 @Class viewport
3802 Superclass: @ref{bin} @ref{atk-implementor-iface} @ref{buildable}
3803
3804 Slots:
3805 @itemize
3806 @item @anchor{slot.viewport.hadjustment}hadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.viewport-hadjustment}@code{viewport-hadjustment}.
3807 @item @anchor{slot.viewport.shadow-type}shadow-type. Type: @ref{shadow-type}. Accessor: @anchor{fn.viewport-shadow-type}@code{viewport-shadow-type}.
3808 @item @anchor{slot.viewport.vadjustment}vadjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.viewport-vadjustment}@code{viewport-vadjustment}.
3809 @end itemize
3810
3811
3812 Signals:
3813 @itemize
3814 @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.
3815 @end itemize
3816
3817
3818
3819
3820 @node volume-button
3821 @section volume-button
3822 @Class volume-button
3823 Superclass: @ref{scale-button} @ref{atk-implementor-iface} @ref{activatable} @ref{buildable} @ref{orientable}
3824
3825 Slots:
3826 @itemize
3827 @end itemize
3828
3829
3830 Signals:
3831 @itemize
3832 @end itemize
3833
3834
3835
3836
3837 @node widget
3838 @section widget
3839 @Class widget
3840 Superclass: @ref{gtk-object} @ref{atk-implementor-iface} @ref{buildable}
3841
3842 Subclasses: @ref{old-editable} @ref{progress} @ref{invisible} @ref{h-s-v} @ref{separator} @ref{range} @ref{ruler} @ref{entry} @ref{drawing-area} @ref{cell-view} @ref{calendar} @ref{misc} @ref{container}
3843
3844 Slots:
3845 @itemize
3846 @item @anchor{slot.widget.accessible}accessible. Type: @ref{g-object}. Accessor: @anchor{fn.widget-accessible}@code{widget-accessible}. Read-only.
3847 @item @anchor{slot.widget.app-paintable}app-paintable. Type: @code{boolean}. Accessor: @anchor{fn.widget-app-paintable}@code{widget-app-paintable}.
3848 @item @anchor{slot.widget.can-default}can-default. Type: @code{boolean}. Accessor: @anchor{fn.widget-can-default}@code{widget-can-default}.
3849 @item @anchor{slot.widget.can-focus}can-focus. Type: @code{boolean}. Accessor: @anchor{fn.widget-can-focus}@code{widget-can-focus}.
3850 @item @anchor{slot.widget.composite-child}composite-child. Type: @code{boolean}. Accessor: @anchor{fn.widget-composite-child}@code{widget-composite-child}. Read-only.
3851 @item @anchor{slot.widget.composite-name}composite-name. Type: @code{string}. Accessor: @anchor{fn.widget-composite-name}@code{widget-composite-name}.
3852 @item @anchor{slot.widget.direction}direction. Type: @ref{text-direction}. Accessor: @anchor{fn.widget-direction}@code{widget-direction}.
3853 @item @anchor{slot.widget.events}events. Type: @ref{event-mask}. Accessor: @anchor{fn.widget-events}@code{widget-events}.
3854 @item @anchor{slot.widget.extension-events}extension-events. Type: @ref{gdk-extension-mode}. Accessor: @anchor{fn.widget-extension-events}@code{widget-extension-events}.
3855 @item @anchor{slot.widget.has-default}has-default. Type: @code{boolean}. Accessor: @anchor{fn.widget-has-default}@code{widget-has-default}.
3856 @item @anchor{slot.widget.has-focus}has-focus. Type: @code{boolean}. Accessor: @anchor{fn.widget-has-focus}@code{widget-has-focus}.
3857 @item @anchor{slot.widget.has-tooltip}has-tooltip. Type: @code{boolean}. Accessor: @anchor{fn.widget-has-tooltip}@code{widget-has-tooltip}.
3858 @item @anchor{slot.widget.height-request}height-request. Type: @code{integer}. Accessor: @anchor{fn.widget-height-request}@code{widget-height-request}.
3859 @item @anchor{slot.widget.is-focus}is-focus. Type: @code{boolean}. Accessor: @anchor{fn.widget-is-focus}@code{widget-is-focus}.
3860 @item @anchor{slot.widget.name}name. Type: @code{string}. Accessor: @anchor{fn.widget-name}@code{widget-name}.
3861 @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}.
3862 @item @anchor{slot.widget.parent}parent. Type: @ref{container}. Accessor: @anchor{fn.widget-parent}@code{widget-parent}.
3863 @item @anchor{slot.widget.receives-default}receives-default. Type: @code{boolean}. Accessor: @anchor{fn.widget-receives-default}@code{widget-receives-default}.
3864 @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.
3865 @item @anchor{slot.widget.sensitive}sensitive. Type: @code{boolean}. Accessor: @anchor{fn.widget-sensitive}@code{widget-sensitive}.
3866 @item @anchor{slot.widget.style}style. Type: @ref{style}. Accessor: @anchor{fn.widget-style}@code{widget-style}.
3867 @item @anchor{slot.widget.tooltip-markup}tooltip-markup. Type: @code{string}. Accessor: @anchor{fn.widget-tooltip-markup}@code{widget-tooltip-markup}.
3868 @item @anchor{slot.widget.tooltip-text}tooltip-text. Type: @code{string}. Accessor: @anchor{fn.widget-tooltip-text}@code{widget-tooltip-text}.
3869 @item @anchor{slot.widget.tooltip-window}tooltip-window. Type: @ref{g-object}. Accessor: @anchor{fn.widget-tooltip-window}@code{widget-tooltip-window}.
3870 @item @anchor{slot.widget.visible}visible. Type: @code{boolean}. Accessor: @anchor{fn.widget-visible}@code{widget-visible}.
3871 @item @anchor{slot.widget.width-request}width-request. Type: @code{integer}. Accessor: @anchor{fn.widget-width-request}@code{widget-width-request}.
3872 @item @anchor{slot.widget.window}window. Type: @ref{gdk-window}. Accessor: @anchor{fn.widget-window}@code{widget-window}. Read-only.
3873 @end itemize
3874
3875
3876 Signals:
3877 @itemize
3878 @item @anchor{signal.widget.accel-closures-changed}"accel-closures-changed". Signature: (instance @ref{widget}) @result{} void. Options: .
3879 @item @anchor{signal.widget.button-press-event}"button-press-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3880 @item @anchor{signal.widget.button-release-event}"button-release-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3881 @item @anchor{signal.widget.can-activate-accel}"can-activate-accel". Signature: (instance @ref{widget}), (arg-1 @code{integer}) @result{} @code{boolean}. Options: run-last.
3882 @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.
3883 @item @anchor{signal.widget.client-event}"client-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3884 @item @anchor{signal.widget.composited-changed}"composited-changed". Signature: (instance @ref{widget}) @result{} void. Options: run-last, action.
3885 @item @anchor{signal.widget.configure-event}"configure-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3886 @item @anchor{signal.widget.damage-event}"damage-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3887 @item @anchor{signal.widget.delete-event}"delete-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3888 @item @anchor{signal.widget.destroy-event}"destroy-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3889 @item @anchor{signal.widget.direction-changed}"direction-changed". Signature: (instance @ref{widget}), (arg-1 @ref{text-direction}) @result{} void. Options: run-first.
3890 @item @anchor{signal.widget.drag-begin}"drag-begin". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}) @result{} void. Options: run-last.
3891 @item @anchor{signal.widget.drag-data-delete}"drag-data-delete". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}) @result{} void. Options: run-last.
3892 @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.
3893 @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.
3894 @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.
3895 @item @anchor{signal.widget.drag-end}"drag-end". Signature: (instance @ref{widget}), (arg-1 @ref{drag-context}) @result{} void. Options: run-last.
3896 @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.
3897 @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.
3898 @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.
3899 @item @anchor{signal.widget.enter-notify-event}"enter-notify-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3900 @item @anchor{signal.widget.event}"event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3901 @item @anchor{signal.widget.event-after}"event-after". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} void. Options: .
3902 @item @anchor{signal.widget.expose-event}"expose-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3903 @item @anchor{signal.widget.focus}"focus". Signature: (instance @ref{widget}), (arg-1 @ref{direction-type}) @result{} @code{boolean}. Options: run-last.
3904 @item @anchor{signal.widget.focus-in-event}"focus-in-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3905 @item @anchor{signal.widget.focus-out-event}"focus-out-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3906 @item @anchor{signal.widget.grab-broken-event}"grab-broken-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3907 @item @anchor{signal.widget.grab-focus}"grab-focus". Signature: (instance @ref{widget}) @result{} void. Options: run-last, action.
3908 @item @anchor{signal.widget.grab-notify}"grab-notify". Signature: (instance @ref{widget}), (arg-1 @code{boolean}) @result{} void. Options: run-first.
3909 @item @anchor{signal.widget.hide}"hide". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
3910 @item @anchor{signal.widget.hierarchy-changed}"hierarchy-changed". Signature: (instance @ref{widget}), (arg-1 @ref{widget}) @result{} void. Options: run-last.
3911 @item @anchor{signal.widget.key-press-event}"key-press-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3912 @item @anchor{signal.widget.key-release-event}"key-release-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3913 @item @anchor{signal.widget.keynav-failed}"keynav-failed". Signature: (instance @ref{widget}), (arg-1 @ref{direction-type}) @result{} @code{boolean}. Options: run-last.
3914 @item @anchor{signal.widget.leave-notify-event}"leave-notify-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3915 @item @anchor{signal.widget.map}"map". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
3916 @item @anchor{signal.widget.map-event}"map-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3917 @item @anchor{signal.widget.mnemonic-activate}"mnemonic-activate". Signature: (instance @ref{widget}), (arg-1 @code{boolean}) @result{} @code{boolean}. Options: run-last.
3918 @item @anchor{signal.widget.motion-notify-event}"motion-notify-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3919 @item @anchor{signal.widget.move-focus}"move-focus". Signature: (instance @ref{widget}), (arg-1 @ref{direction-type}) @result{} void. Options: run-last, action.
3920 @item @anchor{signal.widget.no-expose-event}"no-expose-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3921 @item @anchor{signal.widget.parent-set}"parent-set". Signature: (instance @ref{widget}), (arg-1 @ref{widget}) @result{} void. Options: run-first.
3922 @item @anchor{signal.widget.popup-menu}"popup-menu". Signature: (instance @ref{widget}) @result{} @code{boolean}. Options: run-last, action.
3923 @item @anchor{signal.widget.property-notify-event}"property-notify-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3924 @item @anchor{signal.widget.proximity-in-event}"proximity-in-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3925 @item @anchor{signal.widget.proximity-out-event}"proximity-out-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3926 @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.
3927 @item @anchor{signal.widget.realize}"realize". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
3928 @item @anchor{signal.widget.screen-changed}"screen-changed". Signature: (instance @ref{widget}), (arg-1 @ref{screen}) @result{} void. Options: run-last.
3929 @item @anchor{signal.widget.scroll-event}"scroll-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3930 @item @anchor{signal.widget.selection-clear-event}"selection-clear-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3931 @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.
3932 @item @anchor{signal.widget.selection-notify-event}"selection-notify-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3933 @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.
3934 @item @anchor{signal.widget.selection-request-event}"selection-request-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3935 @item @anchor{signal.widget.show}"show". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
3936 @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.
3937 @item @anchor{signal.widget.size-allocate}"size-allocate". Signature: (instance @ref{widget}), (arg-1 @ref{rectangle}) @result{} void. Options: run-first.
3938 @item @anchor{signal.widget.size-request}"size-request". Signature: (instance @ref{widget}), (arg-1 @code{GtkRequisition}) @result{} void. Options: run-first.
3939 @item @anchor{signal.widget.state-changed}"state-changed". Signature: (instance @ref{widget}), (arg-1 @ref{state-type}) @result{} void. Options: run-first.
3940 @item @anchor{signal.widget.style-set}"style-set". Signature: (instance @ref{widget}), (arg-1 @ref{style}) @result{} void. Options: run-first.
3941 @item @anchor{signal.widget.unmap}"unmap". Signature: (instance @ref{widget}) @result{} void. Options: run-first.
3942 @item @anchor{signal.widget.unmap-event}"unmap-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3943 @item @anchor{signal.widget.unrealize}"unrealize". Signature: (instance @ref{widget}) @result{} void. Options: run-last.
3944 @item @anchor{signal.widget.visibility-notify-event}"visibility-notify-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3945 @item @anchor{signal.widget.window-state-event}"window-state-event". Signature: (instance @ref{widget}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
3946 @end itemize
3947
3948 @RMethod widget-show
3949
3950 Undocumented yet
3951
3952 @RMethod widget-grab-focus
3953
3954 Undocumented yet
3955