Added texinfo macros EnumVRes, Method and RMethod
[cl-gtk2.git] / doc / gtk.objects.texi
1 @menu
2 * accel-group::
3 * accel-map::
4 * action::
5 * action-group::
6 * adjustment::
7 * array-list-store::
8 * builder::
9 * cell-renderer::
10 * cell-renderer-accel::
11 * cell-renderer-combo::
12 * cell-renderer-pixbuf::
13 * cell-renderer-progress::
14 * cell-renderer-spin::
15 * cell-renderer-text::
16 * cell-renderer-toggle::
17 * clipboard::
18 * entry-completion::
19 * file-filter::
20 * gtk-object::
21 * i-m-context::
22 * icon-factory::
23 * icon-theme::
24 * item-factory::
25 * list-store::
26 * page-setup::
27 * print-context::
28 * print-operation::
29 * print-settings::
30 * radio-action::
31 * rc-style::
32 * recent-action::
33 * recent-filter::
34 * recent-manager::
35 * settings::
36 * size-group::
37 * status-icon::
38 * style::
39 * text-buffer::
40 * text-child-anchor::
41 * text-iter::
42 * text-mark::
43 * text-tag::
44 * text-tag-table::
45 * toggle-action::
46 * tooltip::
47 * tooltips::
48 * tree-lisp-store::
49 * tree-model-filter::
50 * tree-model-sort::
51 * tree-path::
52 * tree-selection::
53 * tree-store::
54 * tree-view-column::
55 * ui-manager::
56 * window-group::
57 @end menu
58
59 @node accel-group
60 @section accel-group
61 @Class accel-group
62 Superclass: @ref{g-object}
63
64 An @ref{accel-group} represents a group of keyboard accelerators, typically attached to a toplevel @ref{gtk-window} (with gtk_window_add_accel_group()). Usually you won't need to create an @ref{accel-group} directly; instead, when using @ref{item-factory}, GTK+ automatically sets up the accelerators for your menus in the item factory's @ref{accel-group}s.
65
66 Note that accelerators are different from mnemonics. Accelerators are shortcuts for activating a menu item; they appear alongside the menu item they're a shortcut for. For example "Ctrl+Q" might appear alongside the "Quit" menu item. Mnemonics are shortcuts for GUI elements such as text entries or buttons; they appear as underlined characters. See @ref{slot.label.mnemonic-widget,label-mnemonic-widget}. Menu items can have both accelerators and mnemonics, of course.
67
68 Slots:
69 @itemize
70 @item @anchor{slot.accel-group.is-locked}is-locked. Type: @code{boolean}. Accessor: @anchor{fn.accel-group-is-locked}@code{accel-group-is-locked}. Read-only.
71
72 Is the accel group locked.
73
74 @item @anchor{slot.accel-group.modifier-mask}modifier-mask. Type: @ref{gdk-modifier-type}. Accessor: @anchor{fn.accel-group-modifier-mask}@code{accel-group-modifier-mask}. Read-only.
75
76 Modifier Mask.
77
78 Default value: @code{'(:shift-mask control-mask :mod1-mask :super-mask :hyper-mask :meta-mask)}
79
80 @end itemize
81
82
83 Signals:
84 @itemize
85 @item @anchor{signal.accel-group.accel-activate}"accel-activate". Signature: (instance @ref{accel-group}), (acceleratable @ref{g-object}), (keyval @code{integer}), (modifier @ref{gdk-modifier-type}) @result{} @code{boolean}. Options: detailed.
86
87 The @code{accel-activate} signal is an implementation detail of @ref{accel-group} and not meant to be used by applications.
88
89 @table @var
90 @item @var{acceleratable}
91
92 the object on which the accelerator was activated
93 @item @var{keyval}
94
95 the accelerator keyval
96 @item @var{modifier}
97
98 the modifier combination of the accelerator
99 @item Return value
100
101 True if the accelerator was activated
102 @end table
103
104 @item @anchor{signal.accel-group.accel-changed}"accel-changed". Signature: (instance @ref{accel-group}), (keyval @code{integer}), (modifier @ref{gdk-modifier-type}), (closure @code{GClosure}) @result{} void. Options: run-first, detailed.
105
106 The @code{accel-changed} signal is emitted when a @code{GtkAccelGroupEntry} is added to or removed from the accel group.
107
108 Widgets like @ref{accel-label} which display an associated accelerator should connect to this signal, and rebuild their visual representation if the @var{accel_closure} is theirs.
109
110 @table @var
111 @item @var{keyval}
112 the accelerator keyval
113 @item @var{modifier}
114 the modifier combination of the accelerator
115 @item @var{accel_closure}
116 the GClosure of the accelerator
117 @end table
118 @end itemize
119
120
121
122
123 @node accel-map
124 @section accel-map
125 @Class accel-map
126 Superclass: @ref{g-object}
127
128
129
130 Slots:
131 @itemize
132 @end itemize
133
134
135 Signals:
136 @itemize
137 @item @anchor{signal.accel-map.changed}"changed". Signature: (instance @ref{accel-map}), (arg-1 @code{string}), (arg-2 @code{integer}), (arg-3 @ref{gdk-modifier-type}) @result{} void. Options: run-last, detailed.
138 @end itemize
139
140
141
142
143 @node action
144 @section action
145 @Class action
146 Superclass: @ref{g-object}
147
148 Subclasses: @ref{recent-action} @ref{toggle-action}
149
150 Actions represent operations that the user can be perform, along with some information how it should be presented in the interface. Each action provides methods to create icons, menu items and toolbar items representing itself.
151
152 As well as the callback that is called when the action gets activated, the following also gets associated with the action:
153 @itemize
154 @item a name (not translated, for path lookup)
155 @item a label (translated, for display)
156 @item an accelerator
157 @item whether label indicates a stock id
158 @item a tooltip (optional, translated)
159 @item a toolbar label (optional, shorter than label)
160 @end itemize
161 The action will also have some state information:
162 @itemize
163 @item visible (shown/hidden)
164 @item sensitive (enabled/disabled)
165 @end itemize
166 Apart from regular actions, there are @ref{toggle-action}s, which can be toggled between two states and @ref{radio-action}s, of which only one in a group can be in the "active" state. Other actions can be implemented as @ref{action} subclasses.
167
168 Each action can have one or more proxy menu item, toolbar button or other proxy widgets. Proxies mirror the state of the action (text label, tooltip, icon, visible, sensitive, etc), and should change when the action's state changes. When the proxy is activated, it should activate its action.
169
170 Slots:
171 @itemize
172 @item @anchor{slot.action.accel-group}accel-group. Type: @ref{g-object}. Accessor: @anchor{fn.action-accel-group}@code{action-accel-group}. Write-only.
173 @item @anchor{slot.action.accel-path}accel-path. Type: @code{string}. Accessor: @anchor{fn.action-accel-path}@code{action-accel-path}.
174 @item @anchor{slot.action.action-group}action-group. Type: @ref{action-group}. Accessor: @anchor{fn.action-action-group}@code{action-action-group}.
175
176 The @ref{action-group} this @ref{action} is associated with, or @code{NIL} (for internal use).
177 @item @anchor{slot.action.gicon}gicon. Type: @code{GIcon}. Accessor: @anchor{fn.action-gicon}@code{action-gicon}.
178
179 The @code{GIcon} displayed in the @ref{action}.
180
181 Note that the stock icon is preferred, if the @ref{slot.action.stock-id,action-stock-id} property holds the id of an existing stock icon.
182
183 This is an appearance property and thus only applies if @ref{slot.activatable.use-action-appearance,activatable-use-action-appearance} is true.
184 @item @anchor{slot.action.hide-if-empty}hide-if-empty. Type: @code{boolean}. Accessor: @anchor{fn.action-hide-if-empty}@code{action-hide-if-empty}.
185
186 When TRUE, empty menu proxies for this action are hidden.
187
188 Default value: TRUE
189 @item @anchor{slot.action.icon-name}icon-name. Type: @code{string}. Accessor: @anchor{fn.action-icon-name}@code{action-icon-name}.
190
191 The name of the icon from the icon theme.
192
193 Note that the stock icon is preferred, if the @ref{slot.action.stock-id,action-stock-id} property holds the id of an existing stock icon, and the @code{GIcon} is preferred if the @ref{slot.action.gicon,action-gicon} property is set.
194
195 This is an appearance property and thus only applies if @ref{slot.activatable.use-action-appearance,activatable-use-action-appearance} is TRUE.
196
197 Default value: @code{NIL}
198 @item @anchor{slot.action.is-important}is-important. Type: @code{boolean}. Accessor: @anchor{fn.action-is-important}@code{action-is-important}.
199
200 Whether the action is considered important. When TRUE, toolitem proxies for this action show text in @ref{enum.toolbar-style.both-horiz,@code{:both-horiz}} mode.
201
202 Default value: FALSE
203 @item @anchor{slot.action.label}label. Type: @code{string}. Accessor: @anchor{fn.action-label}@code{action-label}.
204
205 The label used for menu items and buttons that activate this action. If the label is NULL, GTK+ uses the stock label specified via the stock-id property.
206
207 This is an appearance property and thus only applies if @ref{slot.activatable.use-action-appearance,activatable-use-action-appearance} is TRUE.
208
209 Default value: NIL
210 @item @anchor{slot.action.name}name. Type: @code{string}. Accessor: @anchor{fn.action-name}@code{action-name}.
211
212 A unique name for the action.
213
214 Default value: NIL
215 @item @anchor{slot.action.sensitive}sensitive. Type: @code{boolean}. Accessor: @anchor{fn.action-sensitive}@code{action-sensitive}.
216
217 Whether the action is enabled.
218
219 Default value: TRUE
220 @item @anchor{slot.action.short-label}short-label. Type: @code{string}. Accessor: @anchor{fn.action-short-label}@code{action-short-label}.
221
222 A shorter label that may be used on toolbar buttons.
223
224 This is an appearance property and thus only applies if @SlotRef{activatable,use-action-appearance} is TRUE.
225
226 Default value: NIL
227 @item @anchor{slot.action.stock-id}stock-id. Type: @code{string}. Accessor: @anchor{fn.action-stock-id}@code{action-stock-id}.
228
229 The stock icon displayed in widgets representing this action.
230
231 This is an appearance property and thus only applies if @SlotRef{activatable,use-action-appearance} is TRUE.
232
233 Default value: NIL
234 @item @anchor{slot.action.tooltip}tooltip. Type: @code{string}. Accessor: @anchor{fn.action-tooltip}@code{action-tooltip}.
235
236 A tooltip for this action.
237
238 Default value: NIL
239 @item @anchor{slot.action.visible}visible. Type: @code{boolean}. Accessor: @anchor{fn.action-visible}@code{action-visible}.
240
241 Whether the action is visible.
242
243 Default value: TRUE
244 @item @anchor{slot.action.visible-horizontal}visible-horizontal. Type: @code{boolean}. Accessor: @anchor{fn.action-visible-horizontal}@code{action-visible-horizontal}.
245
246 Whether the toolbar item is visible when the toolbar is in a horizontal orientation.
247
248 Default value: TRUE
249 @item @anchor{slot.action.visible-overflown}visible-overflown. Type: @code{boolean}. Accessor: @anchor{fn.action-visible-overflown}@code{action-visible-overflown}.
250
251 When TRUE, toolitem proxies for this action are represented in the toolbar overflow menu.
252
253 Default value: TRUE
254 @item @anchor{slot.action.visible-vertical}visible-vertical. Type: @code{boolean}. Accessor: @anchor{fn.action-visible-vertical}@code{action-visible-vertical}.
255
256 Whether the toolbar item is visible when the toolbar is in a vertical orientation.
257
258 Default value: TRUE
259 @end itemize
260
261
262 Signals:
263 @itemize
264 @item @anchor{signal.action.activate}"activate". Signature: (instance @ref{action}) @result{} void. Options: run-first, no-recurse.
265
266 The @code{activate} signal is emitted when the action is activated.
267 @end itemize
268
269
270
271
272 @node action-group
273 @section action-group
274 @Class action-group
275 Superclass: @ref{g-object}
276
277 Actions are organised into groups. An action group is essentially a map from names to @ref{action} objects.
278
279 All actions that would make sense to use in a particular context should be in a single group. Multiple action groups may be used for a particular user interface. In fact, it is expected that most nontrivial applications will make use of multiple groups. For example, in an application that can edit multiple documents, one group holding global actions (e.g. quit, about, new), and one group per document holding actions that act on that document (eg. save, cut/copy/paste, etc). Each window's menus would be constructed from a combination of two action groups.
280
281 Accelerators are handled by the GTK+ accelerator map. All actions are assigned an accelerator path (which normally has the form @code{<Actions>/group-name/action-name}) and a shortcut is associated with this accelerator path. All menuitems and toolitems take on this accelerator path. The GTK+ accelerator map code makes sure that the correct shortcut is displayed next to the menu item.
282
283 Slots:
284 @itemize
285 @item @anchor{slot.action-group.name}name. Type: @code{string}. Accessor: @anchor{fn.action-group-name}@code{action-group-name}.
286
287 A name for the action group.
288
289 Default value: NIL
290 @item @anchor{slot.action-group.sensitive}sensitive. Type: @code{boolean}. Accessor: @anchor{fn.action-group-sensitive}@code{action-group-sensitive}.
291
292 Whether the action group is enabled.
293
294 Default value: TRUE
295 @item @anchor{slot.action-group.translate-function}translate-function. Type: @code{(function (string) string)}. Accessor: @anchor{fn.action-group-translate-function}@code{action-group-translate-function}. Write-only.
296
297 Sets a function to be used for translating the @emph{label} and @emph{tooltip} of GtkActionGroupEntrys added by gtk_action_group_add_actions().
298
299 If you're using gettext, it is enough to set the @SlotRef{action-group,translation-domain}.
300 @item @anchor{slot.action-group.translation-domain}translation-domain. Type: @code{string}. Accessor: @anchor{fn.action-group-translation-domain}@code{action-group-translation-domain}. Write-only.
301
302 Sets the translation domain and uses g_dgettext() for translating the @emph{label} and @emph{tooltip} of GtkActionEntrys added by gtk_action_group_add_actions().
303 @item @anchor{slot.action-group.visible}visible. Type: @code{boolean}. Accessor: @anchor{fn.action-group-visible}@code{action-group-visible}.
304
305 Whether the action group is visible.
306
307 Default value: TRUE
308 @end itemize
309
310
311 Signals:
312 @itemize
313 @item @anchor{signal.action-group.connect-proxy}"connect-proxy". Signature: (instance @ref{action-group}), (action @ref{action}), (proxy @ref{widget}) @result{} void. Options: None.
314
315 The @code{connect-proxy} signal is emitted after connecting a proxy to an action in the group. Note that the proxy may have been connected to a different action before.
316
317 This is intended for simple customizations for which a custom action class would be too clumsy, e.g. showing tooltips for menuitems in the statusbar.
318
319 @ref{ui-manager} proxies the signal and provides global notification just before any action is connected to a proxy, which is probably more convenient to use.
320
321 @item @anchor{signal.action-group.disconnect-proxy}"disconnect-proxy". Signature: (instance @ref{action-group}), (action @ref{action}), (proxy @ref{widget}) @result{} void. Options: None.
322
323 The @code{disconnect-proxy} signal is emitted after disconnecting a proxy from an action in the group.
324
325 @ref{ui-manager} proxies the signal and provides global notification just before any action is connected to a proxy, which is probably more convenient to use.
326 @item @anchor{signal.action-group.post-activate}"post-activate". Signature: (instance @ref{action-group}), (action @ref{action}) @result{} void. Options: None.
327
328 The @code{post-activate} signal is emitted just after the action in the action_group is activated
329
330 This is intended for @ref{ui-manager} to proxy the signal and provide global notification just after any action is activated.
331 @item @anchor{signal.action-group.pre-activate}"pre-activate". Signature: (instance @ref{action-group}), (action @ref{action}) @result{} void. Options: None.
332
333 The @code{pre-activate} signal is emitted just before the action in the action_group is activated
334
335 This is intended for @ref{ui-manager} to proxy the signal and provide global notification just before any action is activated.
336 @end itemize
337
338
339
340
341 @node adjustment
342 @section adjustment
343 @Class adjustment
344 Superclass: @ref{gtk-object}
345
346 The @ref{adjustment} object represents a value which has an associated lower and upper bound, together with step and page increments, and a page size. It is used within several GTK+ widgets, including @ref{spin-button}, @ref{viewport}, and @ref{range} (which is a base class for @ref{h-scrollbar}, @ref{v-scrollbar}, @ref{h-scale}, @ref{v-scale}).
347
348 The @ref{adjustment} object does not update the value itself. Instead it is left up to the owner of the GtkAdjustment to control the value.
349
350 Slots:
351 @itemize
352 @item @anchor{slot.adjustment.lower}lower. Type: @code{double-float}. Accessor: @anchor{fn.adjustment-lower}@code{adjustment-lower}.
353
354 The minimum value of the adjustment.
355
356 Default value: 0
357 @item @anchor{slot.adjustment.page-increment}page-increment. Type: @code{double-float}. Accessor: @anchor{fn.adjustment-page-increment}@code{adjustment-page-increment}.
358
359 The page increment of the adjustment.
360
361 Default value: 0
362 @item @anchor{slot.adjustment.page-size}page-size. Type: @code{double-float}. Accessor: @anchor{fn.adjustment-page-size}@code{adjustment-page-size}.
363
364 The page size of the adjustment. Note that the page-size is irrelevant and should be set to zero if the adjustment is used for a simple scalar value, e.g. in a @ref{spin-button}.
365
366 Default value: 0
367 @item @anchor{slot.adjustment.step-increment}step-increment. Type: @code{double-float}. Accessor: @anchor{fn.adjustment-step-increment}@code{adjustment-step-increment}.
368
369 The step increment of the adjustment.
370
371 Default value: 0
372 @item @anchor{slot.adjustment.upper}upper. Type: @code{double-float}. Accessor: @anchor{fn.adjustment-upper}@code{adjustment-upper}.
373
374 The maximum value of the adjustment. Note that values will be restricted by @code{(- upper page-size)} if the page-size property is nonzero.
375
376 Default value: 0
377 @item @anchor{slot.adjustment.value}value. Type: @code{double-float}. Accessor: @anchor{fn.adjustment-value}@code{adjustment-value}.
378
379 The value of the adjustment.
380
381 Default value: 0
382 @end itemize
383
384
385 Signals:
386 @itemize
387 @item @anchor{signal.adjustment.changed}"changed". Signature: (instance @ref{adjustment}) @result{} void. Options: run-first, no-recurse.
388
389 Emitted when one or more of the @ref{adjustment} fields have been changed, other than the @SlotRef{adjustment,value} field.
390 @item @anchor{signal.adjustment.value-changed}"value-changed". Signature: (instance @ref{adjustment}) @result{} void. Options: run-first, no-recurse.
391
392 Emitted when the @SlotRef{adjustment,value} field has been changed.
393 @end itemize
394
395
396
397
398 @node array-list-store
399 @section array-list-store
400 @Class array-list-store
401 Superclass: @ref{g-object} @ref{tree-model}
402
403 A Lisp implementation of @ref{tree-model} interface suitable for using in @ref{tree-view} widgets. @ref{array-list-store} contains a list of objects and a list of columns. Each column has a number (starting from zero) and is specified by its GType and reader function.
404
405 @RFunction store-add-column
406 @lisp
407 (store-add-column list-store name reader)
408 @end lisp
409 Adds the column named @var{name} (a string) into @var{list-store} and associate @var{reader} as a reader function for this column.
410
411 @RFunction store-add-item
412 @lisp
413 (store-add-item list-store item)
414 @end lisp
415 Adds the @var{item} to @var{list-store}.
416
417 @RFunction store-items-count
418 @lisp
419 (store-items-count list-store) @result{} count
420 @end lisp
421 Returns the count of items in a @var{list-store}
422
423 @RFunction store-remove-item
424 @lisp
425 (store-remove-item list-store item &key (test 'eq))
426 @end lisp
427 Removes the first @var{item} from @var{list-store} (using @var{test} as a comparison function).
428
429 @node builder
430 @section builder
431 @Class builder
432 Superclass: @ref{g-object}
433
434 A @ref{builder} is an auxiliary object that reads textual descriptions of a user interface and instantiates the described objects. To pass a description to a @ref{builder}, call @ref{builder-add-from-file} or @ref{builder-add-from-string} or use @code{:from-file} or @code{:from-string} initialization arguments. These functions can be called multiple times; both initargs may be specified; the builder merges the content of all descriptions.
435
436 A @ref{builder} holds a reference to all objects that it has constructed and drops these references when it is finalized. This finalization can cause the destruction of non-widget objects or widgets which are not contained in a toplevel window. For toplevel windows constructed by a builder, it is the responsibility of the user to call @code{gtk_widget_destroy} to get rid of them and all the widgets they contain.
437
438 The function @ref{builder-get-object} can be used to access the widgets in the interface by the names assigned to them inside the UI description. Toplevel windows returned by these functions will stay around until the user explicitly destroys them with @code{gtk_widget_destroy}. Other widgets will either be part of a larger hierarchy constructed by the builder, or without a parent, in which case they have to be added to some container to make use of them.
439
440 The functions @ref{builder-connect-signals-simple} and @ref{builder-connect-signals-full} can be used to connect handlers to the named signals in the description.
441
442 Slots:
443 @itemize
444 @item @anchor{slot.builder.translation-domain}translation-domain. Type: @code{string}. Accessor: @anchor{fn.builder-translation-domain}@code{builder-translation-domain}.
445
446 The translation domain used when translating property values that have been marked as translatable in interface descriptions. If the translation domain is NIL, GtkBuilder uses gettext(), otherwise g_dgettext().
447
448 Default value: NIL
449 @end itemize
450
451
452 Signals:
453 @itemize
454 @end itemize
455 @RFunction builder-add-from-file
456 @lisp
457 (builder-add-from-file builder file-name)
458 @end lisp
459 Parses a file containing a GtkBuilder UI definition and merges it with the current contents of builder
460 @RFunction builder-add-from-string
461 @lisp
462 (builder-add-from-string builder string)
463 @end lisp
464 Parses a string containing a GtkBuilder UI definition and merges it with the current contents of builder.
465 @RFunction builder-get-object
466 @lisp
467 (builder-get-object builder name)
468 @end lisp
469 Gets the object named @var{name}.
470 @RFunction builder-connect-signals-simple
471 @lisp
472 (builder-connect-signals-simple builder handlers-list)
473 @end lisp
474 Connects the signal handlers to objects. @var{handler-list} is a plist mapping from signal handler names to signal handler functions.
475
476 Example:
477 @lisp
478 (builder-connect-signals-simple builder `(("new" ,#'new) ("open" ,#'cb-open)))
479 @end lisp
480 @RFunction builder-connect-signals-full
481 @lisp
482 (builder-connect-signals-full builder func)
483 @end lisp
484 Connects the signals handlers to objects. @var{func} is a function that maps signal handler name to signal handler function. Its signature is @code{(function (builder object signal-name handler-name connect-object flags))}. The @var{func} function should connect the signal handler named @var{handler-name} for @var{signal-name} of @var{object}. @var{connect-object} should be ignored. @var{flags} specifies the behavior of signal connection (@code{:after} if the handler should be called before or after the default handler of the signal; @code{:swapped} if the instance and data should be swapped when calling the handler).
485
486 @node cell-renderer
487 @section cell-renderer
488 @Class cell-renderer
489 Superclass: @ref{gtk-object}
490
491 Subclasses: @ref{cell-renderer-toggle} @ref{cell-renderer-progress} @ref{cell-renderer-pixbuf} @ref{cell-renderer-text}
492
493 The @ref{cell-renderer} is a base class of a set of objects used for rendering a cell to a @ref{drawable}. These objects are used primarily by the @ref{tree-view} widget, though they aren't tied to them in any specific way. It is worth noting that @ref{cell-renderer} is not a @ref{widget} and cannot be treated as such.
494
495 The primary use of a @ref{cell-renderer} is for drawing a certain graphical elements on a @ref{drawable}. Typically, one cell renderer is used to draw many cells on the screen. To this extent, it isn't expected that a @ref{cell-renderer} keep any permanent state around. Instead, any state is set just prior to use. Then, the cell is measured using gtk_cell_renderer_get_size(). Finally, the cell is rendered in the correct location using gtk_cell_renderer_render().
496
497 There are a number of rules that must be followed when writing a new @ref{cell-renderer}. First and formost, it's important that a certain set of properties will always yield a cell renderer of the same size, barring a @ref{style} change. The @ref{cell-renderer} also has a number of generic properties that are expected to be honored by all children.
498
499 Beyond merely rendering a cell, cell renderers can optionally provide active user interface elements. A cell renderer can be activatable like @ref{cell-renderer-toggle}, which toggles when it gets activated by a mouse click, or it can be editable like @ref{cell-renderer-text}, which allows the user to edit the text using a @ref{entry}. To make a cell renderer activatable or editable, you have to implement the @code{activate} or @code{start_editing} virtual functions, respectively.
500
501 Slots:
502 @itemize
503 @item @anchor{slot.cell-renderer.cell-background}cell-background. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-cell-background}@code{cell-renderer-cell-background}. Write-only.
504
505 Cell background color as a string.
506
507 Default value: NIL
508 @item @anchor{slot.cell-renderer.cell-background-gdk}cell-background-gdk. Type: @ref{color}. Accessor: @anchor{fn.cell-renderer-cell-background-gdk}@code{cell-renderer-cell-background-gdk}.
509
510 Cell background color as a @ref{color} structure.
511 @item @anchor{slot.cell-renderer.cell-background-set}cell-background-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-cell-background-set}@code{cell-renderer-cell-background-set}.
512
513 Whether this tag affects the cell background color.
514
515 Default value: FALSE
516 @item @anchor{slot.cell-renderer.editing}editing. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-editing}@code{cell-renderer-editing}. Read-only.
517
518 Whether the cell renderer is currently in editing mode.
519
520 Default value: FALSE
521 @item @anchor{slot.cell-renderer.height}height. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-height}@code{cell-renderer-height}.
522
523 The fixed height.
524
525 Default value: -1
526 @item @anchor{slot.cell-renderer.is-expanded}is-expanded. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-is-expanded}@code{cell-renderer-is-expanded}.
527
528 Row is an expander row, and is expanded.
529
530 Default value: FALSE
531 @item @anchor{slot.cell-renderer.is-expander}is-expander. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-is-expander}@code{cell-renderer-is-expander}.
532
533 Row has children.
534
535 Default value: FALSE
536 @item @anchor{slot.cell-renderer.mode}mode. Type: @ref{cell-renderer-mode}. Accessor: @anchor{fn.cell-renderer-mode}@code{cell-renderer-mode}.
537
538 Editable mode of the @ref{cell-renderer}.
539
540 Default value: @code{:inert}
541 @item @anchor{slot.cell-renderer.sensitive}sensitive. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-sensitive}@code{cell-renderer-sensitive}.
542
543 Display the cell sensitive.
544
545 Default value: TRUE
546 @item @anchor{slot.cell-renderer.visible}visible. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-visible}@code{cell-renderer-visible}.
547
548 Display the cell.
549
550 Default value: TRUE
551 @item @anchor{slot.cell-renderer.width}width. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-width}@code{cell-renderer-width}.
552
553 The fixed width.
554
555 Default value: -1
556 @item @anchor{slot.cell-renderer.xalign}xalign. Type: @code{single-float}. Accessor: @anchor{fn.cell-renderer-xalign}@code{cell-renderer-xalign}.
557
558 The x-align.
559
560 Allowed values: [0,1]
561
562 Default value: 0.5
563 @item @anchor{slot.cell-renderer.xpad}xpad. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-xpad}@code{cell-renderer-xpad}.
564
565 The xpad.
566
567 Default value: 0
568 @item @anchor{slot.cell-renderer.yalign}yalign. Type: @code{single-float}. Accessor: @anchor{fn.cell-renderer-yalign}@code{cell-renderer-yalign}.
569
570 The y-align.
571
572 Allowed values: [0,1]
573
574 Default value: 0.5
575 @item @anchor{slot.cell-renderer.ypad}ypad. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-ypad}@code{cell-renderer-ypad}.
576
577 The ypad.
578
579 Default value: 0
580 @end itemize
581
582
583 Signals:
584 @itemize
585 @item @anchor{signal.cell-renderer.editing-canceled}"editing-canceled". Signature: (instance @ref{cell-renderer}) @result{} void. Options: run-first.
586
587 This signal gets emitted when the user cancels the process of editing a cell. For example, an editable cell renderer could be written to cancel editing when the user presses Escape.
588
589 See also: gtk_cell_renderer_stop_editing().
590 @item @anchor{signal.cell-renderer.editing-started}"editing-started". Signature: (instance @ref{cell-renderer}), (editable @ref{cell-editable}), (path @code{string}) @result{} void. Options: run-first.
591
592 This signal gets emitted when a cell starts to be edited. The indended use of this signal is to do special setup on editable, e.g. adding a @ref{entry-completion} or setting up additional columns in a @ref{combo-box}.
593
594 Note that GTK+ doesn't guarantee that cell renderers will continue to use the same kind of widget for editing in future releases, therefore you should check the type of editable before doing any specific setup.
595
596 @table @var
597 @item @var{path}
598 the path identifying the edited cell
599 @end table
600 @end itemize
601
602
603
604
605 @node cell-renderer-accel
606 @section cell-renderer-accel
607 @Class cell-renderer-accel
608 Superclass: @ref{cell-renderer-text}
609
610 @ref{cell-renderer-accel} displays a keyboard accelerator (i.e. a key combination like @code{<Control>-a}). If the cell renderer is editable, the accelerator can be changed by simply typing the new combination.
611
612 Slots:
613 @itemize
614 @item @anchor{slot.cell-renderer-accel.accel-key}accel-key. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-accel-accel-key}@code{cell-renderer-accel-accel-key}.
615
616 The keyval of the accelerator.
617
618 Default value: 0
619 @item @anchor{slot.cell-renderer-accel.accel-mode}accel-mode. Type: @ref{cell-renderer-accel-mode}. Accessor: @anchor{fn.cell-renderer-accel-accel-mode}@code{cell-renderer-accel-accel-mode}.
620
621 Determines if the edited accelerators are GTK+ accelerators. If they are, consumed modifiers are suppressed, only accelerators accepted by GTK+ are allowed, and the accelerators are rendered in the same way as they are in menus.
622
623 Default value: @code{:gtk}
624 @item @anchor{slot.cell-renderer-accel.accel-mods}accel-mods. Type: @ref{gdk-modifier-type}. Accessor: @anchor{fn.cell-renderer-accel-accel-mods}@code{cell-renderer-accel-accel-mods}.
625
626 The modifier mask of the accelerator.
627 @item @anchor{slot.cell-renderer-accel.keycode}keycode. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-accel-keycode}@code{cell-renderer-accel-keycode}.
628
629 The hardware keycode of the accelerator. Note that the hardware keycode is only relevant if the key does not have a keyval. Normally, the keyboard configuration should assign keyvals to all keys.
630
631 Default value: 0
632 @end itemize
633
634
635 Signals:
636 @itemize
637 @item @anchor{signal.cell-renderer-accel.accel-cleared}"accel-cleared". Signature: (instance @ref{cell-renderer-accel}), (path @code{string}) @result{} void. Options: run-last.
638
639 Gets emitted when the user has removed the accelerator.
640
641 @var{path} is the path identifying the row of the edited cell
642 @item @anchor{signal.cell-renderer-accel.accel-edited}"accel-edited". Signature: (instance @ref{cell-renderer-accel}), (path @code{string}), (accel-key @code{integer}), (accel-mods @ref{gdk-modifier-type}), (hardware-keycode @code{integer}) @result{} void. Options: run-last.
643
644 Gets emitted when the user has selected a new accelerator.
645 @table @var
646 @item @var{path}
647 the path identifying the row of the edited cell
648 @item @var{accel-key}
649 the new accelerator keyval
650 @item @var{accel-mods}
651 the new acclerator modifier mask
652 @item @var{hardware-keycode}
653 the keycode of the new accelerator
654 @end table
655 @end itemize
656
657
658
659
660 @node cell-renderer-combo
661 @section cell-renderer-combo
662 @Class cell-renderer-combo
663 Superclass: @ref{cell-renderer-text}
664
665 @ref{cell-renderer-combo} renders text in a cell like @ref{cell-renderer-text} from which it is derived. But while @ref{cell-renderer-text} offers a simple entry to edit the text, @ref{cell-renderer-combo} offers a @ref{combo-box} or @ref{combo-box-entry} widget to edit the text. The values to display in the combo box are taken from the tree model specified in the model property.
666
667 The combo cell renderer takes care of adding a text cell renderer to the combo box and sets it to display the column specified by its text-column property. Further properties of the comnbo box can be set in a handler for the editing-started signal.
668
669 Slots:
670 @itemize
671 @item @anchor{slot.cell-renderer-combo.has-entry}has-entry. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-combo-has-entry}@code{cell-renderer-combo-has-entry}.
672
673 If TRUE, the cell renderer will include an entry and allow to enter values other than the ones in the popup list.
674
675 Default value: TRUE
676 @item @anchor{slot.cell-renderer-combo.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.cell-renderer-combo-model}@code{cell-renderer-combo-model}.
677
678 Holds a tree model containing the possible values for the combo box. Use the @SlotRef{cell-renderer-combo,text-column} to specify the column holding the values.
679 @item @anchor{slot.cell-renderer-combo.text-column}text-column. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-combo-text-column}@code{cell-renderer-combo-text-column}.
680
681 Specifies the model column which holds the possible values for the combo box.
682
683 Note that this refers to the model specified in the model property, not the model backing the tree view to which this cell renderer is attached.
684
685 @ref{cell-renderer-combo} automatically adds a text cell renderer for this column to its combo box.
686
687 Default value: -1
688 @end itemize
689
690
691 Signals:
692 @itemize
693 @item @anchor{signal.cell-renderer-combo.changed}"changed". Signature: (instance @ref{cell-renderer-combo}), (path @code{string}), (iter @ref{tree-iter}) @result{} void. Options: run-last.
694
695 This signal is emitted each time after the user selected an item in the combo box, either by using the mouse or the arrow keys. Contrary to @ref{combo-box}, @code{changed} is not emitted for changes made to a selected item in the entry. The argument @var{iter} corresponds to the newly selected item in the combo box and it is relative to the @ref{tree-model} set via the model property on @ref{cell-renderer-combo}.
696
697 Note that as soon as you change the model displayed in the tree view, the tree view will immediately cease the editing operating. This means that you most probably want to refrain from changing the model until the combo cell renderer emits the @SignalRef{cell-renderer-text,edited} or @SignalRef{cell-renderer,editing-canceled} signal.
698 @end itemize
699
700
701
702
703 @node cell-renderer-pixbuf
704 @section cell-renderer-pixbuf
705 @Class cell-renderer-pixbuf
706 Superclass: @ref{cell-renderer}
707
708 A @ref{cell-renderer-pixbuf} can be used to render an image in a cell. It allows to render either a given @ref{pixbuf} (set via the @SlotRef{cell-renderer-pixbuf,pixbuf} property) or a stock icon (set via the @SlotRef{cell-renderer-pixbuf,stock-id} property).
709
710 To support the tree view, @ref{cell-renderer-pixbuf} also supports rendering two alternative pixbufs, when the @SlotRef{cell-renderer,is-expander} property is TRUE. If the @SlotRef{cell-renderer,is-expanded} property is TRUE and the @SlotRef{cell-renderer-pixbuf,pixbuf-expander-open} property is set to a @ref{pixbuf}, it renders that @ref{pixbuf}, if the @SlotRef{cell-renderer,is-expanded} property is FALSE and the @SlotRef{cell-renderer-pixbuf,pixbuf-expander-closed} property is set to a @ref{pixbuf}, it renders that one.
711
712 Slots:
713 @itemize
714 @item @anchor{slot.cell-renderer-pixbuf.follow-state}follow-state. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-pixbuf-follow-state}@code{cell-renderer-pixbuf-follow-state}.
715
716 Specifies whether the rendered pixbuf should be colorized according to the @ref{cell-renderer-state}.
717
718 Default value: FALSE
719 @item @anchor{slot.cell-renderer-pixbuf.gicon}gicon. Type: @code{GIcon}. Accessor: @anchor{fn.cell-renderer-pixbuf-gicon}@code{cell-renderer-pixbuf-gicon}.
720
721 The GIcon representing the icon to display. If the icon theme is changed, the image will be updated automatically.
722 @item @anchor{slot.cell-renderer-pixbuf.icon-name}icon-name. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-pixbuf-icon-name}@code{cell-renderer-pixbuf-icon-name}.
723
724 The name of the themed icon to display. This property only has an effect if not overridden by @SlotRef{cell-renderer-pixbuf,stock-id} or @SlotRef{cell-renderer-pixbuf,pixbuf} properties.
725
726 Default value: NIL
727 @item @anchor{slot.cell-renderer-pixbuf.pixbuf}pixbuf. Type: @ref{pixbuf}. Accessor: @anchor{fn.cell-renderer-pixbuf-pixbuf}@code{cell-renderer-pixbuf-pixbuf}.
728
729 The pixbuf to render.
730 @item @anchor{slot.cell-renderer-pixbuf.pixbuf-expander-closed}pixbuf-expander-closed. Type: @ref{pixbuf}. Accessor: @anchor{fn.cell-renderer-pixbuf-pixbuf-expander-closed}@code{cell-renderer-pixbuf-pixbuf-expander-closed}.
731
732 Pixbuf for closed expander.
733 @item @anchor{slot.cell-renderer-pixbuf.pixbuf-expander-open}pixbuf-expander-open. Type: @ref{pixbuf}. Accessor: @anchor{fn.cell-renderer-pixbuf-pixbuf-expander-open}@code{cell-renderer-pixbuf-pixbuf-expander-open}.
734
735 Pixbuf for open expander.
736 @item @anchor{slot.cell-renderer-pixbuf.stock-detail}stock-detail. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-pixbuf-stock-detail}@code{cell-renderer-pixbuf-stock-detail}.
737
738 Render detail to pass to the theme engine.
739
740 Default value: NIL
741 @item @anchor{slot.cell-renderer-pixbuf.stock-id}stock-id. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-pixbuf-stock-id}@code{cell-renderer-pixbuf-stock-id}.
742
743 The stock ID of the stock icon to render.
744
745 Default value: NIL
746 @item @anchor{slot.cell-renderer-pixbuf.stock-size}stock-size. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-pixbuf-stock-size}@code{cell-renderer-pixbuf-stock-size}.
747
748 The @ref{icon-size} value that specifies the size of the rendered icon.
749
750 Default value: 1
751 @end itemize
752
753
754 Signals:
755 @itemize
756 @end itemize
757
758
759
760
761 @node cell-renderer-progress
762 @section cell-renderer-progress
763 @Class cell-renderer-progress
764 Superclass: @ref{cell-renderer}
765
766 @ref{cell-renderer-progress} renders a numeric value as a progress par in a cell. Additionally, it can display a text on top of the progress bar.
767
768 Slots:
769 @itemize
770 @item @anchor{slot.cell-renderer-progress.orientation}orientation. Type: @ref{progress-bar-orientation}. Accessor: @anchor{fn.cell-renderer-progress-orientation}@code{cell-renderer-progress-orientation}.
771
772 The "orientation" property controls the direction and growth direction of the progress bar
773
774 Default value: @code{:left-to-right}
775 @item @anchor{slot.cell-renderer-progress.pulse}pulse. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-progress-pulse}@code{cell-renderer-progress-pulse}.
776
777 Setting this to a non-negative value causes the cell renderer to enter "activity mode", where a block bounces back and forth to indicate that some progress is made, without specifying exactly how much.
778
779 Each increment of the property causes the block to move by a little bit.
780
781 To indicate that the activity has not started yet, set the property to zero. To indicate completion, set the property to @code{(expt 2 (1- (* 8 (cffi:foreign-type-size :int))))}.
782
783 Default value: -1
784 @item @anchor{slot.cell-renderer-progress.text}text. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-progress-text}@code{cell-renderer-progress-text}.
785
786 Determines the label which will be drawn over the progress bar. Setting this property to NIL causes the default label to be displayed. Setting this property to an empty string causes no label to be displayed.
787
788 Default value: NIL
789 @item @anchor{slot.cell-renderer-progress.text-xalign}text-xalign. Type: @code{single-float}. Accessor: @anchor{fn.cell-renderer-progress-text-xalign}@code{cell-renderer-progress-text-xalign}.
790
791 Controls the horizontal alignment of the text in the progress bar. Valid values range from 0 (left) to 1 (right). Reserved for RTL layouts.
792
793 Allowed values: [0,1]
794
795 Default value: 0.5
796 @item @anchor{slot.cell-renderer-progress.text-yalign}text-yalign. Type: @code{single-float}. Accessor: @anchor{fn.cell-renderer-progress-text-yalign}@code{cell-renderer-progress-text-yalign}.
797
798 Controls the vertical alignment of the text in the progress bar. Valid values range from 0 (top) to 1 (bottom).
799
800 Allowed values: [0,1]
801
802 Default value: 0.5
803 @item @anchor{slot.cell-renderer-progress.value}value. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-progress-value}@code{cell-renderer-progress-value}.
804
805 The "value" property determines the percentage to which the progress bar will be "filled in".
806
807 Allowed values: [0,100]
808
809 Default value: 0
810 @end itemize
811
812
813 Signals:
814 @itemize
815 @end itemize
816
817
818
819
820 @node cell-renderer-spin
821 @section cell-renderer-spin
822 @Class cell-renderer-spin
823 Superclass: @ref{cell-renderer-text}
824
825 @ref{cell-renderer-spin} renders text in a cell like @ref{cell-renderer-text} from which it is derived. But while @ref{cell-renderer-text} offers a simple entry to edit the text, @ref{cell-renderer-spin} offers a @ref{spin-button} widget. Of course, that means that the text has to be parseable as a floating point number.
826
827 The range of the @ref{spin-button} is taken from the @SlotRef{cell-renderer-spin,adjustment} property of the cell renderer, which can be set explicitly or mapped to a column in the tree model, like all properties of cell renders. @ref{cell-renderer-spin} also has properties for the climb rate and the number of digits to display. Other @ref{spin-button} properties can be set in a handler for the @SignalRef{cell-renderer,editing-started} signal.
828
829 Slots:
830 @itemize
831 @item @anchor{slot.cell-renderer-spin.adjustment}adjustment. Type: @ref{adjustment}. Accessor: @anchor{fn.cell-renderer-spin-adjustment}@code{cell-renderer-spin-adjustment}.
832
833 The adjustment that holds the value of the spinbutton. This must be non-NIL for the cell renderer to be editable.
834 @item @anchor{slot.cell-renderer-spin.climb-rate}climb-rate. Type: @code{double-float}. Accessor: @anchor{fn.cell-renderer-spin-climb-rate}@code{cell-renderer-spin-climb-rate}.
835
836 The acceleration rate when you hold down a button.
837
838 Allowed values: >= 0
839
840 Default value: 0
841 @item @anchor{slot.cell-renderer-spin.digits}digits. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-spin-digits}@code{cell-renderer-spin-digits}.
842
843 The number of decimal places to display.
844
845 Allowed values: <= 20
846
847 Default value: 0
848 @end itemize
849
850
851 Signals:
852 @itemize
853 @end itemize
854
855
856
857
858 @node cell-renderer-text
859 @section cell-renderer-text
860 @Class cell-renderer-text
861 Superclass: @ref{cell-renderer}
862
863 Subclasses: @ref{cell-renderer-spin} @ref{cell-renderer-combo} @ref{cell-renderer-accel}
864
865 A @ref{cell-renderer-text} renders a given text in its cell, using the font, color and style information provided by its properties. The text will be ellipsized if it is too long and the @SlotRef{cell-renderer-text,ellipsize} property allows it.
866
867 Slots:
868 @itemize
869 @item @anchor{slot.cell-renderer-text.align-set}align-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-align-set}@code{cell-renderer-text-align-set}.
870
871 Whether this tag affects the alignment mode.
872
873 Default value: FALSE
874 @item @anchor{slot.cell-renderer-text.alignment}alignment. Type: @code{PangoAlignment}. Accessor: @anchor{fn.cell-renderer-text-alignment}@code{cell-renderer-text-alignment}.
875
876 Specifies how to align the lines of text with respect to each other.
877
878 Note that this property describes how to align the lines of text in case there are several of them. The "xalign" property of @ref{cell-renderer}, on the other hand, sets the horizontal alignment of the whole text.
879
880 Default value: PANGO_ALIGN_LEFT
881 @item @anchor{slot.cell-renderer-text.attributes}attributes. Type: @code{PangoAttrList}. Accessor: @anchor{fn.cell-renderer-text-attributes}@code{cell-renderer-text-attributes}.
882
883 A list of style attributes to apply to the text of the renderer.
884 @item @anchor{slot.cell-renderer-text.background}background. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-text-background}@code{cell-renderer-text-background}. Write-only.
885
886 Background color as a string.
887
888 Default value: NIL
889 @item @anchor{slot.cell-renderer-text.background-gdk}background-gdk. Type: @ref{color}. Accessor: @anchor{fn.cell-renderer-text-background-gdk}@code{cell-renderer-text-background-gdk}.
890
891 Background color as a @ref{color}
892 @item @anchor{slot.cell-renderer-text.background-set}background-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-background-set}@code{cell-renderer-text-background-set}.
893
894 Whether this tag affects the background color.
895
896 Default value: FALSE
897 @item @anchor{slot.cell-renderer-text.editable}editable. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-editable}@code{cell-renderer-text-editable}.
898
899 Whether the text can be modified by the user.
900
901 Default value: FALSE
902 @item @anchor{slot.cell-renderer-text.editable-set}editable-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-editable-set}@code{cell-renderer-text-editable-set}.
903
904 Whether this tag affects text editability.
905
906 Default value: FALSE
907 @item @anchor{slot.cell-renderer-text.ellipsize}ellipsize. Type: @code{PangoEllipsizeMode}. Accessor: @anchor{fn.cell-renderer-text-ellipsize}@code{cell-renderer-text-ellipsize}.
908
909 Specifies the preferred place to ellipsize the string, if the cell renderer does not have enough room to display the entire string. Setting it to PANGO_ELLIPSIZE_NONE turns off ellipsizing. See the wrap-width property for another way of making the text fit into a given width.
910
911 Default value: PANGO_ELLIPSIZE_NONE
912 @item @anchor{slot.cell-renderer-text.ellipsize-set}ellipsize-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-ellipsize-set}@code{cell-renderer-text-ellipsize-set}.
913
914 Whether this tag affects the ellipsize mode.
915
916 Default value: FALSE
917 @item @anchor{slot.cell-renderer-text.family}family. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-text-family}@code{cell-renderer-text-family}.
918
919 Name of the font family, e.g. Sans, Helvetica, Times, Monospace.
920
921 Default value: NIL
922 @item @anchor{slot.cell-renderer-text.family-set}family-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-family-set}@code{cell-renderer-text-family-set}.
923
924 Whether this tag affects the font family.
925
926 Default value: FALSE
927 @item @anchor{slot.cell-renderer-text.font}font. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-text-font}@code{cell-renderer-text-font}.
928
929 Font description as a string, e.g. "Sans Italic 12".
930
931 Default value: NULL
932 @item @anchor{slot.cell-renderer-text.font-desc}font-desc. Type: @code{PangoFontDescription}. Accessor: @anchor{fn.cell-renderer-text-font-desc}@code{cell-renderer-text-font-desc}.
933
934 Font description as a PangoFontDescription struct.
935 @item @anchor{slot.cell-renderer-text.foreground}foreground. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-text-foreground}@code{cell-renderer-text-foreground}. Write-only.
936
937 Foreground color as a string.
938
939 Default value: NULL
940 @item @anchor{slot.cell-renderer-text.foreground-gdk}foreground-gdk. Type: @ref{color}. Accessor: @anchor{fn.cell-renderer-text-foreground-gdk}@code{cell-renderer-text-foreground-gdk}.
941
942 Foreground color as a @ref{color}.
943 @item @anchor{slot.cell-renderer-text.foreground-set}foreground-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-foreground-set}@code{cell-renderer-text-foreground-set}.
944
945 Whether this tag affects the foreground color.
946
947 Default value: FALSE
948 @item @anchor{slot.cell-renderer-text.language}language. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-text-language}@code{cell-renderer-text-language}.
949
950 The language this text is in, as an ISO code. Pango can use this as a hint when rendering the text. If you don't understand this parameter, you probably don't need it.
951
952 Default value: NULL
953 @item @anchor{slot.cell-renderer-text.language-set}language-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-language-set}@code{cell-renderer-text-language-set}.
954
955 Whether this tag affects the language the text is rendered as.
956
957 Default value: FALSE
958 @item @anchor{slot.cell-renderer-text.markup}markup. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-text-markup}@code{cell-renderer-text-markup}. Write-only.
959
960 Marked up text to render.
961
962 Default value: NULL
963 @item @anchor{slot.cell-renderer-text.rise}rise. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-text-rise}@code{cell-renderer-text-rise}.
964
965 Offset of text above the baseline (below the baseline if rise is negative).
966
967 Allowed values: >= -2147483647
968
969 Default value: 0
970 @item @anchor{slot.cell-renderer-text.rise-set}rise-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-rise-set}@code{cell-renderer-text-rise-set}.
971
972 Whether this tag affects the rise.
973
974 Default value: FALSE
975 @item @anchor{slot.cell-renderer-text.scale}scale. Type: @code{double-float}. Accessor: @anchor{fn.cell-renderer-text-scale}@code{cell-renderer-text-scale}.
976
977 Font scaling factor.
978
979 Allowed values: >= 0
980
981 Default value: 1
982 @item @anchor{slot.cell-renderer-text.scale-set}scale-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-scale-set}@code{cell-renderer-text-scale-set}.
983
984 Whether this tag scales the font size by a factor.
985
986 Default value: FALSE
987 @item @anchor{slot.cell-renderer-text.single-paragraph-mode}single-paragraph-mode. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-single-paragraph-mode}@code{cell-renderer-text-single-paragraph-mode}.
988
989 Whether or not to keep all text in a single paragraph.
990
991 Default value: FALSE
992 @item @anchor{slot.cell-renderer-text.size}size. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-text-size}@code{cell-renderer-text-size}.
993
994 Font size.
995
996 Allowed values: >= 0
997
998 Default value: 0
999 @item @anchor{slot.cell-renderer-text.size-points}size-points. Type: @code{double-float}. Accessor: @anchor{fn.cell-renderer-text-size-points}@code{cell-renderer-text-size-points}.
1000
1001 Font size in points.
1002
1003 Allowed values: >= 0
1004
1005 Default value: 0
1006 @item @anchor{slot.cell-renderer-text.size-set}size-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-size-set}@code{cell-renderer-text-size-set}.
1007
1008 Whether this tag affects the font size.
1009
1010 Default value: FALSE
1011 @item @anchor{slot.cell-renderer-text.stretch}stretch. Type: @code{PangoStretch}. Accessor: @anchor{fn.cell-renderer-text-stretch}@code{cell-renderer-text-stretch}.
1012
1013 Font stretch.
1014
1015 Default value: PANGO_STRETCH_NORMAL
1016 @item @anchor{slot.cell-renderer-text.stretch-set}stretch-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-stretch-set}@code{cell-renderer-text-stretch-set}.
1017
1018 Whether this tag affects the font stretch.
1019
1020 Default value: FALSE
1021 @item @anchor{slot.cell-renderer-text.strikethrough}strikethrough. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-strikethrough}@code{cell-renderer-text-strikethrough}.
1022
1023 Whether to strike through the text.
1024
1025 Default value: FALSE
1026 @item @anchor{slot.cell-renderer-text.strikethrough-set}strikethrough-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-strikethrough-set}@code{cell-renderer-text-strikethrough-set}.
1027
1028 Whether this tag affects strikethrough.
1029
1030 Default value: FALSE
1031 @item @anchor{slot.cell-renderer-text.style}style. Type: @code{PangoStyle}. Accessor: @anchor{fn.cell-renderer-text-style}@code{cell-renderer-text-style}.
1032
1033 Font style.
1034
1035 Default value: PANGO_STYLE_NORMAL
1036 @item @anchor{slot.cell-renderer-text.style-set}style-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-style-set}@code{cell-renderer-text-style-set}.
1037
1038 Whether this tag affects the font style.
1039
1040 Default value: FALSE
1041
1042
1043 @item @anchor{slot.cell-renderer-text.text}text. Type: @code{string}. Accessor: @anchor{fn.cell-renderer-text-text}@code{cell-renderer-text-text}.
1044
1045 Text to render.
1046
1047 Default value: NIL
1048 @item @anchor{slot.cell-renderer-text.underline}underline. Type: @code{PangoUnderline}. Accessor: @anchor{fn.cell-renderer-text-underline}@code{cell-renderer-text-underline}.
1049
1050 Style of underline for this text.
1051
1052 Default value: PANGO_UNDERLINE_NONE
1053 @item @anchor{slot.cell-renderer-text.underline-set}underline-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-underline-set}@code{cell-renderer-text-underline-set}.
1054
1055 Whether this tag affects underlining.
1056
1057 Default value: FALSE
1058 @item @anchor{slot.cell-renderer-text.variant}variant. Type: @code{PangoVariant}. Accessor: @anchor{fn.cell-renderer-text-variant}@code{cell-renderer-text-variant}.
1059
1060 Font variant.
1061
1062 Default value: PANGO_VARIANT_NORMAL
1063 @item @anchor{slot.cell-renderer-text.variant-set}variant-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-variant-set}@code{cell-renderer-text-variant-set}.
1064
1065 Whether this tag affects the font variant.
1066
1067 Default value: FALSE
1068 @item @anchor{slot.cell-renderer-text.weight}weight. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-text-weight}@code{cell-renderer-text-weight}.
1069
1070 Font weight.
1071
1072 Allowed values: >= 0
1073
1074 Default value: 400
1075 @item @anchor{slot.cell-renderer-text.weight-set}weight-set. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-text-weight-set}@code{cell-renderer-text-weight-set}.
1076
1077 Whether this tag affects the font weight.
1078
1079 Default value: FALSE
1080 @item @anchor{slot.cell-renderer-text.width-chars}width-chars. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-text-width-chars}@code{cell-renderer-text-width-chars}.
1081
1082 The desired width of the cell, in characters. If this property is set to -1, the width will be calculated automatically, otherwise the cell will request either 3 characters or the property value, whichever is greater.
1083
1084 Default value: -1
1085 @item @anchor{slot.cell-renderer-text.wrap-mode}wrap-mode. Type: @code{PangoWrapMode}. Accessor: @anchor{fn.cell-renderer-text-wrap-mode}@code{cell-renderer-text-wrap-mode}.
1086
1087 Specifies how to break the string into multiple lines, if the cell renderer does not have enough room to display the entire string. This property has no effect unless the wrap-width property is set.
1088
1089 Default value: PANGO_WRAP_CHAR
1090 @item @anchor{slot.cell-renderer-text.wrap-width}wrap-width. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-text-wrap-width}@code{cell-renderer-text-wrap-width}.
1091
1092 Specifies the width at which the text is wrapped. The wrap-mode property can be used to influence at what character positions the line breaks can be placed. Setting wrap-width to -1 turns wrapping off.
1093
1094 Default value: -1
1095 @end itemize
1096
1097
1098 Signals:
1099 @itemize
1100 @item @anchor{signal.cell-renderer-text.edited}"edited". Signature: (instance @ref{cell-renderer-text}), (path @code{string}), (new-text @code{string}) @result{} void. Options: run-last.
1101
1102 This signal is emitted after renderer has been edited.
1103
1104 It is the responsibility of the application to update the model and store @var{new-text} at the position indicated by @var{path}.
1105 @end itemize
1106
1107
1108
1109
1110 @node cell-renderer-toggle
1111 @section cell-renderer-toggle
1112 @Class cell-renderer-toggle
1113 Superclass: @ref{cell-renderer}
1114
1115 @ref{cell-renderer-toggle} renders a toggle button in a cell. The button is drawn as a radio- or checkbutton, depending on the @SlotRef{cell-renderer-toggle,radio} property. When activated, it emits the @SignalRef{cell-renderer-toggle,toggled} signal.
1116
1117 Slots:
1118 @itemize
1119 @item @anchor{slot.cell-renderer-toggle.activatable}activatable. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-toggle-activatable}@code{cell-renderer-toggle-activatable}.
1120
1121 The toggle button can be activated.
1122
1123 Default value: TRUE
1124 @item @anchor{slot.cell-renderer-toggle.active}active. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-toggle-active}@code{cell-renderer-toggle-active}.
1125
1126 The toggle state of the button.
1127
1128 Default value: FALSE
1129 @item @anchor{slot.cell-renderer-toggle.inconsistent}inconsistent. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-toggle-inconsistent}@code{cell-renderer-toggle-inconsistent}.
1130
1131 The inconsistent state of the button.
1132
1133 Default value: FALSE
1134 @item @anchor{slot.cell-renderer-toggle.indicator-size}indicator-size. Type: @code{integer}. Accessor: @anchor{fn.cell-renderer-toggle-indicator-size}@code{cell-renderer-toggle-indicator-size}.
1135
1136 Size of check or radio indicator.
1137
1138 Allowed values: >= 0
1139
1140 Default value: 13
1141 @item @anchor{slot.cell-renderer-toggle.radio}radio. Type: @code{boolean}. Accessor: @anchor{fn.cell-renderer-toggle-radio}@code{cell-renderer-toggle-radio}.
1142
1143 Draw the toggle button as a radio button.
1144
1145 Default value: FALSE
1146 @end itemize
1147
1148
1149 Signals:
1150 @itemize
1151 @item @anchor{signal.cell-renderer-toggle.toggled}"toggled". Signature: (instance @ref{cell-renderer-toggle}), (path @code{string}) @result{} void. Options: run-last.
1152
1153 The signal is emitted when the cell of the row identified by @var{path} is toggled.
1154 @end itemize
1155
1156
1157
1158
1159 @node clipboard
1160 @section clipboard
1161 @Class clipboard
1162 Superclass: @ref{g-object}
1163
1164 The @ref{clipboard} object represents a clipboard of data shared between different processes or between different widgets in the same process. Each clipboard is identified by a name encoded as a GdkAtom. (Conversion to and from strings can be done with gdk_atom_intern() and gdk_atom_name().) The default clipboard corresponds to the "CLIPBOARD" atom; another commonly used clipboard is the "PRIMARY" clipboard, which, in X, traditionally contains the currently selected text.
1165
1166 To support having a number of different formats on the clipboard at the same time, the clipboard mechanism allows providing callbacks instead of the actual data. When you set the contents of the clipboard, you can either supply the data directly (via functions like gtk_clipboard_set_text()), or you can supply a callback to be called at a later time when the data is needed (via gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().) Providing a callback also avoids having to make copies of the data when it is not needed.
1167
1168 gtk_clipboard_set_with_data() and gtk_clipboard_set_with_owner() are quite similar; the choice between the two depends mostly on which is more convenient in a particular situation. The former is most useful when you want to have a blob of data with callbacks to convert it into the various data types that you advertise. When the clear_func you provided is called, you simply free the data blob. The latter is more useful when the contents of clipboard reflect the internal state of a GObject (As an example, for the PRIMARY clipboard, when an entry widget provides the clipboard's contents the contents are simply the text within the selected region.) If the contents change, the entry widget can call gtk_clipboard_set_with_owner() to update the timestamp for clipboard ownership, without having to worry about clear_func being called.
1169
1170 Requesting the data from the clipboard is essentially asynchronous. If the contents of the clipboard are provided within the same process, then a direct function call will be made to retrieve the data, but if they are provided by another process, then the data needs to be retrieved from the other process, which may take some time. To avoid blocking the user interface, the call to request the selection, gtk_clipboard_request_contents() takes a callback that will be called when the contents are received (or when the request fails.) If you don't want to deal with providing a separate callback, you can also use gtk_clipboard_wait_for_contents(). What this does is run the GLib main loop recursively waiting for the contents. This can simplify the code flow, but you still have to be aware that other callbacks in your program can be called while this recursive mainloop is running.
1171
1172 Along with the functions to get the clipboard contents as an arbitrary data chunk, there are also functions to retrieve it as text, gtk_clipboard_request_text() and gtk_clipboard_wait_for_text(). These functions take care of determining which formats are advertised by the clipboard provider, asking for the clipboard in the best available format and converting the results into the UTF-8 encoding. (The standard form for representing strings in GTK+.)
1173
1174 Slots:
1175 @itemize
1176 @end itemize
1177
1178
1179 Signals:
1180 @itemize
1181 @item @anchor{signal.clipboard.owner-change}"owner-change". Signature: (instance @ref{clipboard}), (event @ref{event-owner-change}) @result{} void. Options: run-first.
1182
1183 This signal is emitted when GTK+ receives an event that indicates that the ownership of the selection associated with clipboard has changed.
1184 @end itemize
1185
1186
1187
1188
1189 @node entry-completion
1190 @section entry-completion
1191 @Class entry-completion
1192 Superclass: @ref{g-object} @ref{buildable} @ref{cell-layout}
1193
1194 @ref{entry-completion} is an auxiliary object to be used in conjunction with @ref{entry} to provide the completion functionality. It implements the @ref{cell-layout} interface, to allow the user to add extra cells to the @ref{tree-view} with completion matches.
1195
1196 "Completion functionality" means that when the user modifies the text in the entry, @ref{entry-completion} checks which rows in the model match the current content of the entry, and displays a list of matches. By default, the matching is done by comparing the entry text case-insensitively against the text column of the model (see @SlotRef{entry-completion,text-column}), but this can be overridden with a custom match function (see gtk_entry_completion_set_match_func()).
1197
1198 When the user selects a completion, the content of the entry is updated. By default, the content of the entry is replaced by the text column of the model, but this can be overridden by connecting to the @SignalRef{entry-completion,match-selected} signal and updating the entry in the signal handler. Note that you should return TRUE from the signal handler to suppress the default behaviour.
1199
1200 To add completion functionality to an entry, use gtk_entry_set_completion().
1201
1202 In addition to regular completion matches, which will be inserted into the entry when they are selected, GtkEntryCompletion also allows to display "actions" in the popup window. Their appearance is similar to menuitems, to differentiate them clearly from completion strings. When an action is selected, the @SignalRef{entry-completion,action-activated} signal is emitted.
1203
1204 Slots:
1205 @itemize
1206 @item @anchor{slot.entry-completion.inline-completion}inline-completion. Type: @code{boolean}. Accessor: @anchor{fn.entry-completion-inline-completion}@code{entry-completion-inline-completion}.
1207
1208 Determines whether the common prefix of the possible completions should be inserted automatically in the entry. Note that this requires text-column to be set, even if you are using a custom match function.
1209
1210 Default value: FALSE
1211 @item @anchor{slot.entry-completion.inline-selection}inline-selection. Type: @code{boolean}. Accessor: @anchor{fn.entry-completion-inline-selection}@code{entry-completion-inline-selection}.
1212
1213 Determines whether the possible completions on the popup will appear in the entry as you navigate through them.
1214
1215 Default value: FALSE
1216 @item @anchor{slot.entry-completion.minimum-key-length}minimum-key-length. Type: @code{integer}. Accessor: @anchor{fn.entry-completion-minimum-key-length}@code{entry-completion-minimum-key-length}.
1217
1218 Minimum length of the search key in order to look up matches.
1219
1220 Allowed values: >= 0
1221
1222 Default value: 1
1223 @item @anchor{slot.entry-completion.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.entry-completion-model}@code{entry-completion-model}.
1224
1225 The model to find matches in.
1226 @item @anchor{slot.entry-completion.popup-completion}popup-completion. Type: @code{boolean}. Accessor: @anchor{fn.entry-completion-popup-completion}@code{entry-completion-popup-completion}.
1227
1228 Determines whether the possible completions should be shown in a popup window.
1229
1230 Default value: TRUE
1231 @item @anchor{slot.entry-completion.popup-set-width}popup-set-width. Type: @code{boolean}. Accessor: @anchor{fn.entry-completion-popup-set-width}@code{entry-completion-popup-set-width}.
1232
1233 Determines whether the completions popup window will be resized to the width of the entry.
1234
1235 Default value: TRUE
1236 @item @anchor{slot.entry-completion.popup-single-match}popup-single-match. Type: @code{boolean}. Accessor: @anchor{fn.entry-completion-popup-single-match}@code{entry-completion-popup-single-match}.
1237
1238 Determines whether the completions popup window will shown for a single possible completion. You probably want to set this to FALSE if you are using inline completion.
1239
1240 Default value: TRUE
1241 @item @anchor{slot.entry-completion.text-column}text-column. Type: @code{integer}. Accessor: @anchor{fn.entry-completion-text-column}@code{entry-completion-text-column}.
1242
1243 The column of the model containing the strings.
1244
1245 Default value: -1
1246 @end itemize
1247
1248
1249 Signals:
1250 @itemize
1251 @item @anchor{signal.entry-completion.action-activated}"action-activated". Signature: (instance @ref{entry-completion}), (index @code{integer}) @result{} void. Options: run-last.
1252
1253 Gets emitted when an action is activated. @var{index} is the index of activated action.
1254 @item @anchor{signal.entry-completion.cursor-on-match}"cursor-on-match". Signature: (instance @ref{entry-completion}), (model @ref{tree-model}), (iter @ref{tree-iter}) @result{} @code{boolean}. Options: run-last.
1255
1256 Gets emitted when a match from the cursor is on a match of the list.The default behaviour is to replace the contents of the entry with the contents of the text column in the row pointed to by iter.
1257 @item @anchor{signal.entry-completion.insert-prefix}"insert-prefix". Signature: (instance @ref{entry-completion}), (prefix @code{string}) @result{} @code{boolean}. Options: run-last.
1258
1259 Gets emitted when the inline autocompletion is triggered. The default behaviour is to make the entry display the whole prefix and select the newly inserted part.
1260
1261 Applications may connect to this signal in order to insert only a smaller part of the prefix into the entry - e.g. the entry used in the @ref{file-chooser} inserts only the part of the prefix up to the next '/'.
1262 @item @anchor{signal.entry-completion.match-selected}"match-selected". Signature: (instance @ref{entry-completion}), (model @ref{tree-model}), (iter @ref{tree-iter}) @result{} @code{boolean}. Options: run-last.
1263
1264 Gets emitted when a match from the list is selected. The default behaviour is to replace the contents of the entry with the contents of the text column in the row pointed to by iter.
1265 @end itemize
1266
1267
1268
1269
1270 @node file-filter
1271 @section file-filter
1272 @Class file-filter
1273 Superclass: @ref{gtk-object}
1274
1275 A @ref{file-filter} can be used to restrict the files being shown in a @ref{file-chooser}. Files can be filtered based on their name (with gtk_file_filter_add_pattern()), on their mime type (with gtk_file_filter_add_mime_type()), or by a custom filter function (with gtk_file_filter_add_custom()).
1276
1277 Filtering by mime types handles aliasing and subclassing of mime types; e.g. a filter for text/plain also matches a file with mime type application/rtf, since application/rtf is a subclass of text/plain. Note that GtkFileFilter allows wildcards for the subtype of a mime type, so you can e.g. filter for image/*.
1278
1279 Normally, filters are used by adding them to a GtkFileChooser, see gtk_file_chooser_add_filter(), but it is also possible to manually use a filter on a file with gtk_file_filter_filter().
1280 Slots:
1281 @itemize
1282 @item @anchor{slot.file-filter.name}name. Type: @code{string}. Accessor: @anchor{fn.file-filter-name}@code{file-filter-name}.
1283 @end itemize
1284
1285
1286 Signals:
1287 @itemize
1288 @end itemize
1289
1290
1291
1292
1293 @node gtk-object
1294 @section gtk-object
1295 @Class gtk-object
1296 Superclass: @ref{g-initially-unowned}
1297
1298 Subclasses: @ref{item-factory} @ref{tooltips} @ref{recent-filter} @ref{file-filter} @ref{cell-renderer} @ref{tree-view-column} @ref{adjustment} @ref{widget}
1299
1300 @ref{gtk-object} is the base class for all widgets, and for a few non-widget objects such as @ref{adjustment}. @ref{gtk-object} predates @ref{g-object}; non-widgets that derive from @ref{gtk-object} rather than @ref{g-object} do so for backward compatibility reasons.
1301
1302 The @SignalRef{gtk-object,destroy} signal asks all code owning a reference to an object to release said reference. So, for example, if you call gtk_object_destroy() on a @ref{gtk-window}, GTK+ will release the reference count that it owns; if you call gtk_object_destroy() on a @ref{button}, then the button will be removed from its parent container and the parent container will release its reference to the button. Because these references are released, calling gtk_object_destroy() should result in freeing all memory associated with an object, unless some buggy code fails to release its references in response to the "destroy" signal.
1303
1304 Slots:
1305 @itemize
1306 @item @anchor{slot.gtk-object.user-data}user-data. Type: gpointer. Accessor: @anchor{fn.gtk-object-user-data}@code{gtk-object-user-data}.
1307
1308 Anonymous User Data Pointer.
1309 @end itemize
1310
1311
1312 Signals:
1313 @itemize
1314 @item @anchor{signal.gtk-object.destroy}"destroy". Signature: (instance @ref{gtk-object}) @result{} void. Options: run-cleanup, no-recurse, no-hooks.
1315
1316 Signals that all holders of a reference to the @ref{gtk-object} should release the reference that they hold. May result in finalization of the object if all references are released.
1317 @end itemize
1318
1319
1320
1321
1322 @node i-m-context
1323 @section i-m-context
1324 @Class i-m-context
1325 Superclass: @ref{g-object}
1326
1327
1328 @ref{i-m-context} defines the interface for GTK+ input methods. An input method is used by GTK+ text input widgets like @ref{entry} to map from key events to Unicode character strings.
1329
1330 The user may change the current input method via a context menu, unless the @SlotRef{settings,gtk-show-input-method-menu} property is set to FALSE. The default input method can be set programmatically via the @SlotRef{settings,gtk-im-module} property. Alternatively, you may set the GTK_IM_MODULE environment variable as documented in gtk-running.
1331
1332 The @SlotRef{entry,im-module} and @SlotRef{text-view,im-module} properties may also be used to set input methods for specific widget instances. For instance, a certain entry widget might be expected to contain certain characters which would be easier to input with a certain input method.
1333
1334 An input method may consume multiple key events in sequence and finally output the composed result. This is called preediting, and an input method may provide feedback about this process by displaying the intermediate composition states as preedit text. For instance, the default GTK+ input method implements the input of arbitrary Unicode code points by holding down the Control and Shift keys and then typing "U" followed by the hexadecimal digits of the code point. When releasing the Control and Shift keys, preediting ends and the character is inserted as text. Ctrl+Shift+u20AC for example results in the â‚¬ sign.
1335
1336 Slots:
1337 @itemize
1338 @end itemize
1339
1340
1341 Signals:
1342 @itemize
1343 @item @anchor{signal.i-m-context.commit}"commit". Signature: (instance @ref{i-m-context}), (str @code{string}) @result{} void. Options: run-last.
1344
1345 The signal is emitted when a complete input sequence has been entered by the user. This can be a single character immediately after a key press or the final result of preediting.
1346 @item @anchor{signal.i-m-context.delete-surrounding}"delete-surrounding". Signature: (instance @ref{i-m-context}), (offset @code{integer}), (n-chars @code{integer}) @result{} @code{boolean}. Options: run-last.
1347
1348 The signal is emitted when the input method needs to delete all or part of the context surrounding the cursor.
1349 @table @var
1350 @item @var{offset}
1351 the character offset from the cursor position of the text to be deleted. A negative value indicates a position before the cursor.
1352 @item @var{n-chars}
1353 the number of characters to be deleted
1354 @end table
1355 @item @anchor{signal.i-m-context.preedit-changed}"preedit-changed". Signature: (instance @ref{i-m-context}) @result{} void. Options: run-last.
1356
1357 The signal is emitted whenever the preedit sequence currently being entered has changed. It is also emitted at the end of a preedit sequence, in which case gtk_im_context_get_preedit_string() returns the empty string.
1358 @item @anchor{signal.i-m-context.preedit-end}"preedit-end". Signature: (instance @ref{i-m-context}) @result{} void. Options: run-last.
1359
1360 The signal is emitted when a preediting sequence has been completed or canceled.
1361 @item @anchor{signal.i-m-context.preedit-start}"preedit-start". Signature: (instance @ref{i-m-context}) @result{} void. Options: run-last.
1362
1363 The signal is emitted when a new preediting sequence starts.
1364 @item @anchor{signal.i-m-context.retrieve-surrounding}"retrieve-surrounding". Signature: (instance @ref{i-m-context}) @result{} @code{boolean}. Options: run-last.
1365
1366 The signal is emitted when the input method requires the context surrounding the cursor. The callback should set the input method surrounding context by calling the gtk_im_context_set_surrounding() method.
1367 @end itemize
1368
1369
1370
1371
1372 @node icon-factory
1373 @section icon-factory
1374 @Class icon-factory
1375 Superclass: @ref{g-object}
1376
1377 An icon factory manages a collection of GtkIconSet; a GtkIconSet manages a set of variants of a particular icon (i.e. a GtkIconSet contains variants for different sizes and widget states). Icons in an icon factory are named by a stock ID, which is a simple string identifying the icon. Each @ref{style} has a list of @ref{icon-factory} derived from the current theme; those icon factories are consulted first when searching for an icon. If the theme doesn't set a particular icon, GTK+ looks for the icon in a list of default icon factories, maintained by gtk_icon_factory_add_default() and gtk_icon_factory_remove_default(). Applications with icons should add a default icon factory with their icons, which will allow themes to override the icons for the application.
1378
1379 To display an icon, always use gtk_style_lookup_icon_set() on the widget that will display the icon, or the convenience function gtk_widget_render_icon(). These functions take the theme into account when looking up the icon to use for a given stock ID.
1380
1381 Slots:
1382 @itemize
1383 @end itemize
1384
1385
1386 Signals:
1387 @itemize
1388 @end itemize
1389
1390
1391
1392
1393 @node icon-theme
1394 @section icon-theme
1395 @Class icon-theme
1396 Superclass: @ref{g-object}
1397
1398
1399
1400 @ref{icon-theme} provides a facility for looking up icons by name and size. The main reason for using a name rather than simply providing a filename is to allow different icons to be used depending on what icon theme is selecetd by the user. The operation of icon themes on Linux and Unix follows the Icon Theme Specification. There is a default icon theme, named hicolor where applications should install their icons, but more additional application themes can be installed as operating system vendors and users choose.
1401
1402 Named icons are similar to the Themeable Stock Images(3) facility, and the distinction between the two may be a bit confusing. A few things to keep in mind:
1403
1404 Stock images usually are used in conjunction with Stock Items(3)., such as GTK_STOCK_OK or GTK_STOCK_OPEN. Named icons are easier to set up and therefore are more useful for new icons that an application wants to add, such as application icons or window icons.
1405
1406 Stock images can only be loaded at the symbolic sizes defined by the GtkIconSize enumeration, or by custom sizes defined by gtk_icon_size_register(), while named icons are more flexible and any pixel size can be specified.
1407
1408 Because stock images are closely tied to stock items, and thus to actions in the user interface, stock images may come in multiple variants for different widget states or writing directions.
1409
1410 A good rule of thumb is that if there is a stock image for what you want to use, use it, otherwise use a named icon. It turns out that internally stock images are generally defined in terms of one or more named icons. (An example of the more than one case is icons that depend on writing direction; GTK_STOCK_GO_FORWARD uses the two themed icons "gtk-stock-go-forward-ltr" and "gtk-stock-go-forward-rtl".)
1411
1412 In many cases, named themes are used indirectly, via GtkImage or stock items, rather than directly, but looking up icons directly is also simple. The GtkIconTheme object acts as a database of all the icons in the current theme. You can create new GtkIconTheme objects, but its much more efficient to use the standard icon theme for the GdkScreen so that the icon information is shared with other people looking up icons.
1413
1414 Slots:
1415 @itemize
1416 @end itemize
1417
1418
1419 Signals:
1420 @itemize
1421 @item @anchor{signal.icon-theme.changed}"changed". Signature: (instance @ref{icon-theme}) @result{} void. Options: run-last.
1422 @end itemize
1423
1424
1425
1426
1427 @node item-factory
1428 @section item-factory
1429 @Class item-factory
1430 Superclass: @ref{gtk-object}
1431
1432 @ref{item-factory} has been deprecated in favour of @ref{ui-manager}.
1433
1434
1435 Slots:
1436 @itemize
1437 @end itemize
1438
1439
1440 Signals:
1441 @itemize
1442 @end itemize
1443
1444
1445
1446
1447 @node list-store
1448 @section list-store
1449 @Class list-store
1450 Superclass: @ref{g-object}
1451
1452 Note: see also @ref{array-list-store}
1453
1454 The @ref{list-store} object is a list model for use with a @ref{tree-view} widget. It implements the @ref{tree-model} interface, and consequentialy, can use all of the methods available there. It also implements the @ref{tree-sortable} interface so it can be sorted by the view. Finally, it also implements the tree drag and drop interfaces.
1455
1456 The @ref{list-store} can accept most GObject types as a column type, though it can't accept all custom types. Internally, it will keep a copy of data passed in (such as a string or a boxed pointer). Columns that accept GObjects are handled a little differently. The @ref{list-store} will keep a reference to the object instead of copying the value. As a result, if the object is modified, it is up to the application writer to call gtk_tree_model_row_changed to emit the "row_changed" signal. This most commonly affects lists with @ref{pixbuf}s stored.
1457
1458 Slots:
1459 @itemize
1460 @end itemize
1461
1462
1463 Signals:
1464 @itemize
1465 @end itemize
1466
1467
1468
1469
1470 @node page-setup
1471 @section page-setup
1472 @Class page-setup
1473 Superclass: @ref{g-object}
1474
1475
1476
1477 Slots:
1478 @itemize
1479 @end itemize
1480
1481
1482 Signals:
1483 @itemize
1484 @end itemize
1485
1486
1487
1488
1489 @node print-context
1490 @section print-context
1491 @Class print-context
1492 Superclass: @ref{g-object}
1493
1494 Slots:
1495 @itemize
1496 @end itemize
1497
1498
1499 Signals:
1500 @itemize
1501 @end itemize
1502
1503
1504
1505
1506 @node print-operation
1507 @section print-operation
1508 @Class print-operation
1509 Superclass: @ref{g-object}
1510
1511 Slots:
1512 @itemize
1513 @item @anchor{slot.print-operation.allow-async}allow-async. Type: @code{boolean}. Accessor: @anchor{fn.print-operation-allow-async}@code{print-operation-allow-async}.
1514 @item @anchor{slot.print-operation.current-page}current-page. Type: @code{integer}. Accessor: @anchor{fn.print-operation-current-page}@code{print-operation-current-page}.
1515 @item @anchor{slot.print-operation.custom-tab-label}custom-tab-label. Type: @code{string}. Accessor: @anchor{fn.print-operation-custom-tab-label}@code{print-operation-custom-tab-label}.
1516 @item @anchor{slot.print-operation.default-page-setup}default-page-setup. Type: @ref{page-setup}. Accessor: @anchor{fn.print-operation-default-page-setup}@code{print-operation-default-page-setup}.
1517 @item @anchor{slot.print-operation.export-filename}export-filename. Type: @code{string}. Accessor: @anchor{fn.print-operation-export-filename}@code{print-operation-export-filename}.
1518 @item @anchor{slot.print-operation.job-name}job-name. Type: @code{string}. Accessor: @anchor{fn.print-operation-job-name}@code{print-operation-job-name}.
1519 @item @anchor{slot.print-operation.n-pages}n-pages. Type: @code{integer}. Accessor: @anchor{fn.print-operation-n-pages}@code{print-operation-n-pages}.
1520 @item @anchor{slot.print-operation.print-settings}print-settings. Type: @ref{print-settings}. Accessor: @anchor{fn.print-operation-print-settings}@code{print-operation-print-settings}.
1521 @item @anchor{slot.print-operation.show-progress}show-progress. Type: @code{boolean}. Accessor: @anchor{fn.print-operation-show-progress}@code{print-operation-show-progress}.
1522 @item @anchor{slot.print-operation.status}status. Type: @ref{print-status}. Accessor: @anchor{fn.print-operation-status}@code{print-operation-status}. Read-only.
1523 @item @anchor{slot.print-operation.status-string}status-string. Type: @code{string}. Accessor: @anchor{fn.print-operation-status-string}@code{print-operation-status-string}. Read-only.
1524 @item @anchor{slot.print-operation.track-print-status}track-print-status. Type: @code{boolean}. Accessor: @anchor{fn.print-operation-track-print-status}@code{print-operation-track-print-status}.
1525 @item @anchor{slot.print-operation.unit}unit. Type: @ref{unit}. Accessor: @anchor{fn.print-operation-unit}@code{print-operation-unit}.
1526 @item @anchor{slot.print-operation.use-full-page}use-full-page. Type: @code{boolean}. Accessor: @anchor{fn.print-operation-use-full-page}@code{print-operation-use-full-page}.
1527 @end itemize
1528
1529
1530 Signals:
1531 @itemize
1532 @item @anchor{signal.print-operation.begin-print}"begin-print". Signature: (instance @ref{print-operation}), (arg-1 @ref{print-context}) @result{} void. Options: run-last.
1533 @item @anchor{signal.print-operation.create-custom-widget}"create-custom-widget". Signature: (instance @ref{print-operation}) @result{} @ref{g-object}. Options: run-last.
1534 @item @anchor{signal.print-operation.custom-widget-apply}"custom-widget-apply". Signature: (instance @ref{print-operation}), (arg-1 @ref{widget}) @result{} void. Options: run-last.
1535 @item @anchor{signal.print-operation.done}"done". Signature: (instance @ref{print-operation}), (arg-1 @ref{print-operation-result}) @result{} void. Options: run-last.
1536 @item @anchor{signal.print-operation.draw-page}"draw-page". Signature: (instance @ref{print-operation}), (arg-1 @ref{print-context}), (arg-2 @code{integer}) @result{} void. Options: run-last.
1537 @item @anchor{signal.print-operation.end-print}"end-print". Signature: (instance @ref{print-operation}), (arg-1 @ref{print-context}) @result{} void. Options: run-last.
1538 @item @anchor{signal.print-operation.paginate}"paginate". Signature: (instance @ref{print-operation}), (arg-1 @ref{print-context}) @result{} @code{boolean}. Options: run-last.
1539 @item @anchor{signal.print-operation.preview}"preview". Signature: (instance @ref{print-operation}), (arg-1 @ref{print-operation-preview}), (arg-2 @ref{print-context}), (arg-3 @ref{gtk-window}) @result{} @code{boolean}. Options: run-last.
1540 @item @anchor{signal.print-operation.request-page-setup}"request-page-setup". Signature: (instance @ref{print-operation}), (arg-1 @ref{print-context}), (arg-2 @code{integer}), (arg-3 @ref{page-setup}) @result{} void. Options: run-last.
1541 @item @anchor{signal.print-operation.status-changed}"status-changed". Signature: (instance @ref{print-operation}) @result{} void. Options: run-last.
1542 @end itemize
1543
1544
1545
1546
1547 @node print-settings
1548 @section print-settings
1549 @Class print-settings
1550 Superclass: @ref{g-object}
1551
1552 Slots:
1553 @itemize
1554 @end itemize
1555
1556
1557 Signals:
1558 @itemize
1559 @end itemize
1560
1561
1562
1563
1564 @node radio-action
1565 @section radio-action
1566 @Class radio-action
1567 Superclass: @ref{toggle-action}
1568
1569 Slots:
1570 @itemize
1571 @item @anchor{slot.radio-action.current-value}current-value. Type: @code{integer}. Accessor: @anchor{fn.radio-action-current-value}@code{radio-action-current-value}.
1572 @item @anchor{slot.radio-action.group}group. Type: @ref{radio-action}. Accessor: @anchor{fn.radio-action-group}@code{radio-action-group}. Write-only.
1573 @item @anchor{slot.radio-action.value}value. Type: @code{integer}. Accessor: @anchor{fn.radio-action-value}@code{radio-action-value}.
1574 @end itemize
1575
1576
1577 Signals:
1578 @itemize
1579 @item @anchor{signal.radio-action.changed}"changed". Signature: (instance @ref{radio-action}), (arg-1 @ref{radio-action}) @result{} void. Options: run-first, no-recurse.
1580 @end itemize
1581
1582
1583
1584
1585 @node rc-style
1586 @section rc-style
1587 @Class rc-style
1588 Superclass: @ref{g-object}
1589
1590 Slots:
1591 @itemize
1592 @end itemize
1593
1594
1595 Signals:
1596 @itemize
1597 @end itemize
1598
1599
1600
1601
1602 @node recent-action
1603 @section recent-action
1604 @Class recent-action
1605 Superclass: @ref{action}
1606
1607 Slots:
1608 @itemize
1609 @item @anchor{slot.recent-action.show-numbers}show-numbers. Type: @code{boolean}. Accessor: @anchor{fn.recent-action-show-numbers}@code{recent-action-show-numbers}.
1610 @end itemize
1611
1612
1613 Signals:
1614 @itemize
1615 @end itemize
1616
1617
1618
1619
1620 @node recent-filter
1621 @section recent-filter
1622 @Class recent-filter
1623 Superclass: @ref{gtk-object}
1624
1625 Slots:
1626 @itemize
1627 @end itemize
1628
1629
1630 Signals:
1631 @itemize
1632 @end itemize
1633
1634
1635
1636
1637 @node recent-manager
1638 @section recent-manager
1639 @Class recent-manager
1640 Superclass: @ref{g-object}
1641
1642 Slots:
1643 @itemize
1644 @item @anchor{slot.recent-manager.filename}filename. Type: @code{string}. Accessor: @anchor{fn.recent-manager-filename}@code{recent-manager-filename}.
1645 @item @anchor{slot.recent-manager.limit}limit. Type: @code{integer}. Accessor: @anchor{fn.recent-manager-limit}@code{recent-manager-limit}.
1646 @item @anchor{slot.recent-manager.size}size. Type: @code{integer}. Accessor: @anchor{fn.recent-manager-size}@code{recent-manager-size}. Read-only.
1647 @end itemize
1648
1649
1650 Signals:
1651 @itemize
1652 @item @anchor{signal.recent-manager.changed}"changed". Signature: (instance @ref{recent-manager}) @result{} void. Options: run-first.
1653 @end itemize
1654
1655
1656
1657
1658 @node settings
1659 @section settings
1660 @Class settings
1661 Superclass: @ref{g-object}
1662
1663 Slots:
1664 @itemize
1665 @item @anchor{slot.settings.color-hash}color-hash. Type: @code{GHashTable}. Accessor: @anchor{fn.settings-color-hash}@code{settings-color-hash}. Read-only.
1666 @item @anchor{slot.settings.gtk-alternative-button-order}gtk-alternative-button-order. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-alternative-button-order}@code{settings-gtk-alternative-button-order}.
1667 @item @anchor{slot.settings.gtk-alternative-sort-arrows}gtk-alternative-sort-arrows. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-alternative-sort-arrows}@code{settings-gtk-alternative-sort-arrows}.
1668 @item @anchor{slot.settings.gtk-button-images}gtk-button-images. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-button-images}@code{settings-gtk-button-images}.
1669 @item @anchor{slot.settings.gtk-can-change-accels}gtk-can-change-accels. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-can-change-accels}@code{settings-gtk-can-change-accels}.
1670 @item @anchor{slot.settings.gtk-color-palette}gtk-color-palette. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-color-palette}@code{settings-gtk-color-palette}.
1671 @item @anchor{slot.settings.gtk-color-scheme}gtk-color-scheme. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-color-scheme}@code{settings-gtk-color-scheme}.
1672 @item @anchor{slot.settings.gtk-cursor-blink}gtk-cursor-blink. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-cursor-blink}@code{settings-gtk-cursor-blink}.
1673 @item @anchor{slot.settings.gtk-cursor-blink-time}gtk-cursor-blink-time. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-cursor-blink-time}@code{settings-gtk-cursor-blink-time}.
1674 @item @anchor{slot.settings.gtk-cursor-blink-timeout}gtk-cursor-blink-timeout. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-cursor-blink-timeout}@code{settings-gtk-cursor-blink-timeout}.
1675 @item @anchor{slot.settings.gtk-cursor-theme-name}gtk-cursor-theme-name. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-cursor-theme-name}@code{settings-gtk-cursor-theme-name}.
1676 @item @anchor{slot.settings.gtk-cursor-theme-size}gtk-cursor-theme-size. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-cursor-theme-size}@code{settings-gtk-cursor-theme-size}.
1677 @item @anchor{slot.settings.gtk-dnd-drag-threshold}gtk-dnd-drag-threshold. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-dnd-drag-threshold}@code{settings-gtk-dnd-drag-threshold}.
1678 @item @anchor{slot.settings.gtk-double-click-distance}gtk-double-click-distance. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-double-click-distance}@code{settings-gtk-double-click-distance}.
1679 @item @anchor{slot.settings.gtk-double-click-time}gtk-double-click-time. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-double-click-time}@code{settings-gtk-double-click-time}.
1680 @item @anchor{slot.settings.gtk-enable-accels}gtk-enable-accels. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-enable-accels}@code{settings-gtk-enable-accels}.
1681 @item @anchor{slot.settings.gtk-enable-animations}gtk-enable-animations. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-enable-animations}@code{settings-gtk-enable-animations}.
1682 @item @anchor{slot.settings.gtk-enable-event-sounds}gtk-enable-event-sounds. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-enable-event-sounds}@code{settings-gtk-enable-event-sounds}.
1683 @item @anchor{slot.settings.gtk-enable-input-feedback-sounds}gtk-enable-input-feedback-sounds. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-enable-input-feedback-sounds}@code{settings-gtk-enable-input-feedback-sounds}.
1684 @item @anchor{slot.settings.gtk-enable-mnemonics}gtk-enable-mnemonics. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-enable-mnemonics}@code{settings-gtk-enable-mnemonics}.
1685 @item @anchor{slot.settings.gtk-enable-tooltips}gtk-enable-tooltips. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-enable-tooltips}@code{settings-gtk-enable-tooltips}.
1686 @item @anchor{slot.settings.gtk-entry-password-hint-timeout}gtk-entry-password-hint-timeout. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-entry-password-hint-timeout}@code{settings-gtk-entry-password-hint-timeout}.
1687 @item @anchor{slot.settings.gtk-entry-select-on-focus}gtk-entry-select-on-focus. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-entry-select-on-focus}@code{settings-gtk-entry-select-on-focus}.
1688 @item @anchor{slot.settings.gtk-error-bell}gtk-error-bell. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-error-bell}@code{settings-gtk-error-bell}.
1689 @item @anchor{slot.settings.gtk-fallback-icon-theme}gtk-fallback-icon-theme. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-fallback-icon-theme}@code{settings-gtk-fallback-icon-theme}.
1690 @item @anchor{slot.settings.gtk-file-chooser-backend}gtk-file-chooser-backend. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-file-chooser-backend}@code{settings-gtk-file-chooser-backend}.
1691 @item @anchor{slot.settings.gtk-font-name}gtk-font-name. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-font-name}@code{settings-gtk-font-name}.
1692 @item @anchor{slot.settings.gtk-fontconfig-timestamp}gtk-fontconfig-timestamp. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-fontconfig-timestamp}@code{settings-gtk-fontconfig-timestamp}.
1693 @item @anchor{slot.settings.gtk-icon-sizes}gtk-icon-sizes. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-icon-sizes}@code{settings-gtk-icon-sizes}.
1694 @item @anchor{slot.settings.gtk-icon-theme-name}gtk-icon-theme-name. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-icon-theme-name}@code{settings-gtk-icon-theme-name}.
1695 @item @anchor{slot.settings.gtk-im-module}gtk-im-module. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-im-module}@code{settings-gtk-im-module}.
1696 @item @anchor{slot.settings.gtk-key-theme-name}gtk-key-theme-name. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-key-theme-name}@code{settings-gtk-key-theme-name}.
1697 @item @anchor{slot.settings.gtk-keynav-cursor-only}gtk-keynav-cursor-only. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-keynav-cursor-only}@code{settings-gtk-keynav-cursor-only}.
1698 @item @anchor{slot.settings.gtk-keynav-wrap-around}gtk-keynav-wrap-around. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-keynav-wrap-around}@code{settings-gtk-keynav-wrap-around}.
1699 @item @anchor{slot.settings.gtk-label-select-on-focus}gtk-label-select-on-focus. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-label-select-on-focus}@code{settings-gtk-label-select-on-focus}.
1700 @item @anchor{slot.settings.gtk-menu-bar-accel}gtk-menu-bar-accel. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-menu-bar-accel}@code{settings-gtk-menu-bar-accel}.
1701 @item @anchor{slot.settings.gtk-menu-bar-popup-delay}gtk-menu-bar-popup-delay. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-menu-bar-popup-delay}@code{settings-gtk-menu-bar-popup-delay}.
1702 @item @anchor{slot.settings.gtk-menu-images}gtk-menu-images. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-menu-images}@code{settings-gtk-menu-images}.
1703 @item @anchor{slot.settings.gtk-menu-popdown-delay}gtk-menu-popdown-delay. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-menu-popdown-delay}@code{settings-gtk-menu-popdown-delay}.
1704 @item @anchor{slot.settings.gtk-menu-popup-delay}gtk-menu-popup-delay. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-menu-popup-delay}@code{settings-gtk-menu-popup-delay}.
1705 @item @anchor{slot.settings.gtk-modules}gtk-modules. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-modules}@code{settings-gtk-modules}.
1706 @item @anchor{slot.settings.gtk-print-backends}gtk-print-backends. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-print-backends}@code{settings-gtk-print-backends}.
1707 @item @anchor{slot.settings.gtk-print-preview-command}gtk-print-preview-command. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-print-preview-command}@code{settings-gtk-print-preview-command}.
1708 @item @anchor{slot.settings.gtk-recent-files-limit}gtk-recent-files-limit. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-recent-files-limit}@code{settings-gtk-recent-files-limit}.
1709 @item @anchor{slot.settings.gtk-recent-files-max-age}gtk-recent-files-max-age. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-recent-files-max-age}@code{settings-gtk-recent-files-max-age}.
1710 @item @anchor{slot.settings.gtk-scrolled-window-placement}gtk-scrolled-window-placement. Type: @ref{corner-type}. Accessor: @anchor{fn.settings-gtk-scrolled-window-placement}@code{settings-gtk-scrolled-window-placement}.
1711 @item @anchor{slot.settings.gtk-show-input-method-menu}gtk-show-input-method-menu. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-show-input-method-menu}@code{settings-gtk-show-input-method-menu}.
1712 @item @anchor{slot.settings.gtk-show-unicode-menu}gtk-show-unicode-menu. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-show-unicode-menu}@code{settings-gtk-show-unicode-menu}.
1713 @item @anchor{slot.settings.gtk-sound-theme-name}gtk-sound-theme-name. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-sound-theme-name}@code{settings-gtk-sound-theme-name}.
1714 @item @anchor{slot.settings.gtk-split-cursor}gtk-split-cursor. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-split-cursor}@code{settings-gtk-split-cursor}.
1715 @item @anchor{slot.settings.gtk-theme-name}gtk-theme-name. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-theme-name}@code{settings-gtk-theme-name}.
1716 @item @anchor{slot.settings.gtk-timeout-expand}gtk-timeout-expand. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-timeout-expand}@code{settings-gtk-timeout-expand}.
1717 @item @anchor{slot.settings.gtk-timeout-initial}gtk-timeout-initial. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-timeout-initial}@code{settings-gtk-timeout-initial}.
1718 @item @anchor{slot.settings.gtk-timeout-repeat}gtk-timeout-repeat. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-timeout-repeat}@code{settings-gtk-timeout-repeat}.
1719 @item @anchor{slot.settings.gtk-toolbar-icon-size}gtk-toolbar-icon-size. Type: @ref{icon-size}. Accessor: @anchor{fn.settings-gtk-toolbar-icon-size}@code{settings-gtk-toolbar-icon-size}.
1720 @item @anchor{slot.settings.gtk-toolbar-style}gtk-toolbar-style. Type: @ref{toolbar-style}. Accessor: @anchor{fn.settings-gtk-toolbar-style}@code{settings-gtk-toolbar-style}.
1721 @item @anchor{slot.settings.gtk-tooltip-browse-mode-timeout}gtk-tooltip-browse-mode-timeout. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-tooltip-browse-mode-timeout}@code{settings-gtk-tooltip-browse-mode-timeout}.
1722 @item @anchor{slot.settings.gtk-tooltip-browse-timeout}gtk-tooltip-browse-timeout. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-tooltip-browse-timeout}@code{settings-gtk-tooltip-browse-timeout}.
1723 @item @anchor{slot.settings.gtk-tooltip-timeout}gtk-tooltip-timeout. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-tooltip-timeout}@code{settings-gtk-tooltip-timeout}.
1724 @item @anchor{slot.settings.gtk-touchscreen-mode}gtk-touchscreen-mode. Type: @code{boolean}. Accessor: @anchor{fn.settings-gtk-touchscreen-mode}@code{settings-gtk-touchscreen-mode}.
1725 @item @anchor{slot.settings.gtk-xft-antialias}gtk-xft-antialias. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-xft-antialias}@code{settings-gtk-xft-antialias}.
1726 @item @anchor{slot.settings.gtk-xft-dpi}gtk-xft-dpi. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-xft-dpi}@code{settings-gtk-xft-dpi}.
1727 @item @anchor{slot.settings.gtk-xft-hinting}gtk-xft-hinting. Type: @code{integer}. Accessor: @anchor{fn.settings-gtk-xft-hinting}@code{settings-gtk-xft-hinting}.
1728 @item @anchor{slot.settings.gtk-xft-hintstyle}gtk-xft-hintstyle. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-xft-hintstyle}@code{settings-gtk-xft-hintstyle}.
1729 @item @anchor{slot.settings.gtk-xft-rgba}gtk-xft-rgba. Type: @code{string}. Accessor: @anchor{fn.settings-gtk-xft-rgba}@code{settings-gtk-xft-rgba}.
1730 @end itemize
1731
1732
1733 Signals:
1734 @itemize
1735 @end itemize
1736
1737
1738
1739
1740 @node size-group
1741 @section size-group
1742 @Class size-group
1743 Superclass: @ref{g-object}
1744
1745 Slots:
1746 @itemize
1747 @item @anchor{slot.size-group.ignore-hidden}ignore-hidden. Type: @code{boolean}. Accessor: @anchor{fn.size-group-ignore-hidden}@code{size-group-ignore-hidden}.
1748 @item @anchor{slot.size-group.mode}mode. Type: @ref{size-group-mode}. Accessor: @anchor{fn.size-group-mode}@code{size-group-mode}.
1749 @end itemize
1750
1751
1752 Signals:
1753 @itemize
1754 @end itemize
1755
1756
1757
1758
1759 @node status-icon
1760 @section status-icon
1761 @Class status-icon
1762 Superclass: @ref{g-object}
1763
1764 Slots:
1765 @itemize
1766 @item @anchor{slot.status-icon.blinking}blinking. Type: @code{boolean}. Accessor: @anchor{fn.status-icon-blinking}@code{status-icon-blinking}.
1767 @item @anchor{slot.status-icon.embedded}embedded. Type: @code{boolean}. Accessor: @anchor{fn.status-icon-embedded}@code{status-icon-embedded}. Read-only.
1768 @item @anchor{slot.status-icon.file}file. Type: @code{string}. Accessor: @anchor{fn.status-icon-file}@code{status-icon-file}. Write-only.
1769 @item @anchor{slot.status-icon.gicon}gicon. Type: @code{GIcon}. Accessor: @anchor{fn.status-icon-gicon}@code{status-icon-gicon}.
1770 @item @anchor{slot.status-icon.has-tooltip}has-tooltip. Type: @code{boolean}. Accessor: @anchor{fn.status-icon-has-tooltip}@code{status-icon-has-tooltip}.
1771 @item @anchor{slot.status-icon.icon-name}icon-name. Type: @code{string}. Accessor: @anchor{fn.status-icon-icon-name}@code{status-icon-icon-name}.
1772 @item @anchor{slot.status-icon.orientation}orientation. Type: @ref{orientation}. Accessor: @anchor{fn.status-icon-orientation}@code{status-icon-orientation}. Read-only.
1773 @item @anchor{slot.status-icon.pixbuf}pixbuf. Type: @ref{pixbuf}. Accessor: @anchor{fn.status-icon-pixbuf}@code{status-icon-pixbuf}.
1774 @item @anchor{slot.status-icon.screen}screen. Type: @ref{screen}. Accessor: @anchor{fn.status-icon-screen}@code{status-icon-screen}.
1775 @item @anchor{slot.status-icon.size}size. Type: @code{integer}. Accessor: @anchor{fn.status-icon-size}@code{status-icon-size}. Read-only.
1776 @item @anchor{slot.status-icon.stock}stock. Type: @code{string}. Accessor: @anchor{fn.status-icon-stock}@code{status-icon-stock}.
1777 @item @anchor{slot.status-icon.storage-type}storage-type. Type: @ref{image-type}. Accessor: @anchor{fn.status-icon-storage-type}@code{status-icon-storage-type}. Read-only.
1778 @item @anchor{slot.status-icon.tooltip-markup}tooltip-markup. Type: @code{string}. Accessor: @anchor{fn.status-icon-tooltip-markup}@code{status-icon-tooltip-markup}.
1779 @item @anchor{slot.status-icon.tooltip-text}tooltip-text. Type: @code{string}. Accessor: @anchor{fn.status-icon-tooltip-text}@code{status-icon-tooltip-text}.
1780 @item @anchor{slot.status-icon.visible}visible. Type: @code{boolean}. Accessor: @anchor{fn.status-icon-visible}@code{status-icon-visible}.
1781 @end itemize
1782
1783
1784 Signals:
1785 @itemize
1786 @item @anchor{signal.status-icon.activate}"activate". Signature: (instance @ref{status-icon}) @result{} void. Options: run-first, action.
1787 @item @anchor{signal.status-icon.button-press-event}"button-press-event". Signature: (instance @ref{status-icon}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
1788 @item @anchor{signal.status-icon.button-release-event}"button-release-event". Signature: (instance @ref{status-icon}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
1789 @item @anchor{signal.status-icon.popup-menu}"popup-menu". Signature: (instance @ref{status-icon}), (arg-1 @code{integer}), (arg-2 @code{integer}) @result{} void. Options: run-first, action.
1790 @item @anchor{signal.status-icon.query-tooltip}"query-tooltip". Signature: (instance @ref{status-icon}), (arg-1 @code{integer}), (arg-2 @code{integer}), (arg-3 @code{boolean}), (arg-4 @ref{tooltip}) @result{} @code{boolean}. Options: run-last.
1791 @item @anchor{signal.status-icon.scroll-event}"scroll-event". Signature: (instance @ref{status-icon}), (arg-1 @ref{event}) @result{} @code{boolean}. Options: run-last.
1792 @item @anchor{signal.status-icon.size-changed}"size-changed". Signature: (instance @ref{status-icon}), (arg-1 @code{integer}) @result{} @code{boolean}. Options: run-last.
1793 @end itemize
1794
1795
1796
1797
1798 @node style
1799 @section style
1800 @Class style
1801 Superclass: @ref{g-object}
1802
1803 Slots:
1804 @itemize
1805 @end itemize
1806
1807
1808 Signals:
1809 @itemize
1810 @item @anchor{signal.style.realize}"realize". Signature: (instance @ref{style}) @result{} void. Options: run-first.
1811 @item @anchor{signal.style.unrealize}"unrealize". Signature: (instance @ref{style}) @result{} void. Options: run-first.
1812 @end itemize
1813
1814
1815
1816
1817 @node text-buffer
1818 @section text-buffer
1819 @Class text-buffer
1820 Superclass: @ref{g-object}
1821
1822 Slots:
1823 @itemize
1824 @item @anchor{slot.text-buffer.copy-target-list}copy-target-list. Type: @code{GtkTargetList}. Accessor: @anchor{fn.text-buffer-copy-target-list}@code{text-buffer-copy-target-list}. Read-only.
1825 @item @anchor{slot.text-buffer.cursor-position}cursor-position. Type: @code{integer}. Accessor: @anchor{fn.text-buffer-cursor-position}@code{text-buffer-cursor-position}. Read-only.
1826 @item @anchor{slot.text-buffer.has-selection}has-selection. Type: @code{boolean}. Accessor: @anchor{fn.text-buffer-has-selection}@code{text-buffer-has-selection}. Read-only.
1827 @item @anchor{slot.text-buffer.paste-target-list}paste-target-list. Type: @code{GtkTargetList}. Accessor: @anchor{fn.text-buffer-paste-target-list}@code{text-buffer-paste-target-list}. Read-only.
1828 @item @anchor{slot.text-buffer.tag-table}tag-table. Type: @ref{text-tag-table}. Accessor: @anchor{fn.text-buffer-tag-table}@code{text-buffer-tag-table}.
1829 @item @anchor{slot.text-buffer.text}text. Type: @code{string}. Accessor: @anchor{fn.text-buffer-text}@code{text-buffer-text}.
1830 @end itemize
1831
1832
1833 Signals:
1834 @itemize
1835 @item @anchor{signal.text-buffer.apply-tag}"apply-tag". Signature: (instance @ref{text-buffer}), (arg-1 @ref{text-tag}), (arg-2 @ref{text-iter}), (arg-3 @ref{text-iter}) @result{} void. Options: run-last.
1836 @item @anchor{signal.text-buffer.begin-user-action}"begin-user-action". Signature: (instance @ref{text-buffer}) @result{} void. Options: run-last.
1837 @item @anchor{signal.text-buffer.changed}"changed". Signature: (instance @ref{text-buffer}) @result{} void. Options: run-last.
1838 @item @anchor{signal.text-buffer.delete-range}"delete-range". Signature: (instance @ref{text-buffer}), (arg-1 @ref{text-iter}), (arg-2 @ref{text-iter}) @result{} void. Options: run-last.
1839 @item @anchor{signal.text-buffer.end-user-action}"end-user-action". Signature: (instance @ref{text-buffer}) @result{} void. Options: run-last.
1840 @item @anchor{signal.text-buffer.insert-child-anchor}"insert-child-anchor". Signature: (instance @ref{text-buffer}), (arg-1 @ref{text-iter}), (arg-2 @ref{text-child-anchor}) @result{} void. Options: run-last.
1841 @item @anchor{signal.text-buffer.insert-pixbuf}"insert-pixbuf". Signature: (instance @ref{text-buffer}), (arg-1 @ref{text-iter}), (arg-2 @ref{pixbuf}) @result{} void. Options: run-last.
1842 @item @anchor{signal.text-buffer.insert-text}"insert-text". Signature: (instance @ref{text-buffer}), (arg-1 @ref{text-iter}), (arg-2 @code{string}), (arg-3 @code{integer}) @result{} void. Options: run-last.
1843 @item @anchor{signal.text-buffer.mark-deleted}"mark-deleted". Signature: (instance @ref{text-buffer}), (arg-1 @ref{text-mark}) @result{} void. Options: run-last.
1844 @item @anchor{signal.text-buffer.mark-set}"mark-set". Signature: (instance @ref{text-buffer}), (arg-1 @ref{text-iter}), (arg-2 @ref{text-mark}) @result{} void. Options: run-last.
1845 @item @anchor{signal.text-buffer.modified-changed}"modified-changed". Signature: (instance @ref{text-buffer}) @result{} void. Options: run-last.
1846 @item @anchor{signal.text-buffer.paste-done}"paste-done". Signature: (instance @ref{text-buffer}), (arg-1 @ref{clipboard}) @result{} void. Options: run-last.
1847 @item @anchor{signal.text-buffer.remove-tag}"remove-tag". Signature: (instance @ref{text-buffer}), (arg-1 @ref{text-tag}), (arg-2 @ref{text-iter}), (arg-3 @ref{text-iter}) @result{} void. Options: run-last.
1848 @end itemize
1849
1850
1851
1852
1853 @node text-child-anchor
1854 @section text-child-anchor
1855 @Class text-child-anchor
1856 Superclass: @ref{g-object}
1857
1858 Slots:
1859 @itemize
1860 @end itemize
1861
1862
1863 Signals:
1864 @itemize
1865 @end itemize
1866
1867
1868
1869
1870 @node text-iter
1871 @section text-iter
1872 @Class text-iter
1873 Superclass: @ref{g-boxed-opaque}
1874
1875 Slots:
1876 @itemize
1877 @end itemize
1878
1879
1880
1881
1882
1883
1884 @node text-mark
1885 @section text-mark
1886 @Class text-mark
1887 Superclass: @ref{g-object}
1888
1889 Slots:
1890 @itemize
1891 @item @anchor{slot.text-mark.left-gravity}left-gravity. Type: @code{boolean}. Accessor: @anchor{fn.text-mark-left-gravity}@code{text-mark-left-gravity}.
1892 @item @anchor{slot.text-mark.name}name. Type: @code{string}. Accessor: @anchor{fn.text-mark-name}@code{text-mark-name}.
1893 @end itemize
1894
1895
1896 Signals:
1897 @itemize
1898 @end itemize
1899
1900
1901
1902
1903 @node text-tag
1904 @section text-tag
1905 @Class text-tag
1906 Superclass: @ref{g-object}
1907
1908 Slots:
1909 @itemize
1910 @item @anchor{slot.text-tag.accumulative-margin}accumulative-margin. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-accumulative-margin}@code{text-tag-accumulative-margin}.
1911 @item @anchor{slot.text-tag.background}background. Type: @code{string}. Accessor: @anchor{fn.text-tag-background}@code{text-tag-background}. Write-only.
1912 @item @anchor{slot.text-tag.background-full-height}background-full-height. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-background-full-height}@code{text-tag-background-full-height}.
1913 @item @anchor{slot.text-tag.background-full-height-set}background-full-height-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-background-full-height-set}@code{text-tag-background-full-height-set}.
1914 @item @anchor{slot.text-tag.background-gdk}background-gdk. Type: @ref{color}. Accessor: @anchor{fn.text-tag-background-gdk}@code{text-tag-background-gdk}.
1915 @item @anchor{slot.text-tag.background-set}background-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-background-set}@code{text-tag-background-set}.
1916 @item @anchor{slot.text-tag.background-stipple}background-stipple. Type: @ref{pixmap}. Accessor: @anchor{fn.text-tag-background-stipple}@code{text-tag-background-stipple}.
1917 @item @anchor{slot.text-tag.background-stipple-set}background-stipple-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-background-stipple-set}@code{text-tag-background-stipple-set}.
1918 @item @anchor{slot.text-tag.direction}direction. Type: @ref{text-direction}. Accessor: @anchor{fn.text-tag-direction}@code{text-tag-direction}.
1919 @item @anchor{slot.text-tag.editable}editable. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-editable}@code{text-tag-editable}.
1920 @item @anchor{slot.text-tag.editable-set}editable-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-editable-set}@code{text-tag-editable-set}.
1921 @item @anchor{slot.text-tag.family}family. Type: @code{string}. Accessor: @anchor{fn.text-tag-family}@code{text-tag-family}.
1922 @item @anchor{slot.text-tag.family-set}family-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-family-set}@code{text-tag-family-set}.
1923 @item @anchor{slot.text-tag.font}font. Type: @code{string}. Accessor: @anchor{fn.text-tag-font}@code{text-tag-font}.
1924 @item @anchor{slot.text-tag.font-desc}font-desc. Type: @code{PangoFontDescription}. Accessor: @anchor{fn.text-tag-font-desc}@code{text-tag-font-desc}.
1925 @item @anchor{slot.text-tag.foreground}foreground. Type: @code{string}. Accessor: @anchor{fn.text-tag-foreground}@code{text-tag-foreground}. Write-only.
1926 @item @anchor{slot.text-tag.foreground-gdk}foreground-gdk. Type: @ref{color}. Accessor: @anchor{fn.text-tag-foreground-gdk}@code{text-tag-foreground-gdk}.
1927 @item @anchor{slot.text-tag.foreground-set}foreground-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-foreground-set}@code{text-tag-foreground-set}.
1928 @item @anchor{slot.text-tag.foreground-stipple}foreground-stipple. Type: @ref{pixmap}. Accessor: @anchor{fn.text-tag-foreground-stipple}@code{text-tag-foreground-stipple}.
1929 @item @anchor{slot.text-tag.foreground-stipple-set}foreground-stipple-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-foreground-stipple-set}@code{text-tag-foreground-stipple-set}.
1930 @item @anchor{slot.text-tag.indent}indent. Type: @code{integer}. Accessor: @anchor{fn.text-tag-indent}@code{text-tag-indent}.
1931 @item @anchor{slot.text-tag.indent-set}indent-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-indent-set}@code{text-tag-indent-set}.
1932 @item @anchor{slot.text-tag.invisible}invisible. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-invisible}@code{text-tag-invisible}.
1933 @item @anchor{slot.text-tag.invisible-set}invisible-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-invisible-set}@code{text-tag-invisible-set}.
1934 @item @anchor{slot.text-tag.justification}justification. Type: @ref{justification}. Accessor: @anchor{fn.text-tag-justification}@code{text-tag-justification}.
1935 @item @anchor{slot.text-tag.justification-set}justification-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-justification-set}@code{text-tag-justification-set}.
1936 @item @anchor{slot.text-tag.language}language. Type: @code{string}. Accessor: @anchor{fn.text-tag-language}@code{text-tag-language}.
1937 @item @anchor{slot.text-tag.language-set}language-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-language-set}@code{text-tag-language-set}.
1938 @item @anchor{slot.text-tag.left-margin}left-margin. Type: @code{integer}. Accessor: @anchor{fn.text-tag-left-margin}@code{text-tag-left-margin}.
1939 @item @anchor{slot.text-tag.left-margin-set}left-margin-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-left-margin-set}@code{text-tag-left-margin-set}.
1940 @item @anchor{slot.text-tag.name}name. Type: @code{string}. Accessor: @anchor{fn.text-tag-name}@code{text-tag-name}.
1941 @item @anchor{slot.text-tag.paragraph-background}paragraph-background. Type: @code{string}. Accessor: @anchor{fn.text-tag-paragraph-background}@code{text-tag-paragraph-background}. Write-only.
1942 @item @anchor{slot.text-tag.paragraph-background-gdk}paragraph-background-gdk. Type: @ref{color}. Accessor: @anchor{fn.text-tag-paragraph-background-gdk}@code{text-tag-paragraph-background-gdk}.
1943 @item @anchor{slot.text-tag.paragraph-background-set}paragraph-background-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-paragraph-background-set}@code{text-tag-paragraph-background-set}.
1944 @item @anchor{slot.text-tag.pixels-above-lines}pixels-above-lines. Type: @code{integer}. Accessor: @anchor{fn.text-tag-pixels-above-lines}@code{text-tag-pixels-above-lines}.
1945 @item @anchor{slot.text-tag.pixels-above-lines-set}pixels-above-lines-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-pixels-above-lines-set}@code{text-tag-pixels-above-lines-set}.
1946 @item @anchor{slot.text-tag.pixels-below-lines}pixels-below-lines. Type: @code{integer}. Accessor: @anchor{fn.text-tag-pixels-below-lines}@code{text-tag-pixels-below-lines}.
1947 @item @anchor{slot.text-tag.pixels-below-lines-set}pixels-below-lines-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-pixels-below-lines-set}@code{text-tag-pixels-below-lines-set}.
1948 @item @anchor{slot.text-tag.pixels-inside-wrap}pixels-inside-wrap. Type: @code{integer}. Accessor: @anchor{fn.text-tag-pixels-inside-wrap}@code{text-tag-pixels-inside-wrap}.
1949 @item @anchor{slot.text-tag.pixels-inside-wrap-set}pixels-inside-wrap-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-pixels-inside-wrap-set}@code{text-tag-pixels-inside-wrap-set}.
1950 @item @anchor{slot.text-tag.priority}priority. Type: @code{integer}. Accessor: @anchor{fn.text-tag-priority}@code{text-tag-priority}.
1951 @item @anchor{slot.text-tag.right-margin}right-margin. Type: @code{integer}. Accessor: @anchor{fn.text-tag-right-margin}@code{text-tag-right-margin}.
1952 @item @anchor{slot.text-tag.right-margin-set}right-margin-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-right-margin-set}@code{text-tag-right-margin-set}.
1953 @item @anchor{slot.text-tag.rise}rise. Type: @code{integer}. Accessor: @anchor{fn.text-tag-rise}@code{text-tag-rise}.
1954 @item @anchor{slot.text-tag.rise-set}rise-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-rise-set}@code{text-tag-rise-set}.
1955 @item @anchor{slot.text-tag.scale}scale. Type: @code{double-float}. Accessor: @anchor{fn.text-tag-scale}@code{text-tag-scale}.
1956 @item @anchor{slot.text-tag.scale-set}scale-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-scale-set}@code{text-tag-scale-set}.
1957 @item @anchor{slot.text-tag.size}size. Type: @code{integer}. Accessor: @anchor{fn.text-tag-size}@code{text-tag-size}.
1958 @item @anchor{slot.text-tag.size-points}size-points. Type: @code{double-float}. Accessor: @anchor{fn.text-tag-size-points}@code{text-tag-size-points}.
1959 @item @anchor{slot.text-tag.size-set}size-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-size-set}@code{text-tag-size-set}.
1960 @item @anchor{slot.text-tag.stretch}stretch. Type: @code{PangoStretch}. Accessor: @anchor{fn.text-tag-stretch}@code{text-tag-stretch}.
1961 @item @anchor{slot.text-tag.stretch-set}stretch-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-stretch-set}@code{text-tag-stretch-set}.
1962 @item @anchor{slot.text-tag.strikethrough}strikethrough. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-strikethrough}@code{text-tag-strikethrough}.
1963 @item @anchor{slot.text-tag.strikethrough-set}strikethrough-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-strikethrough-set}@code{text-tag-strikethrough-set}.
1964 @item @anchor{slot.text-tag.style}style. Type: @code{PangoStyle}. Accessor: @anchor{fn.text-tag-style}@code{text-tag-style}.
1965 @item @anchor{slot.text-tag.style-set}style-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-style-set}@code{text-tag-style-set}.
1966 @item @anchor{slot.text-tag.tabs}tabs. Type: @code{PangoTabArray}. Accessor: @anchor{fn.text-tag-tabs}@code{text-tag-tabs}.
1967 @item @anchor{slot.text-tag.tabs-set}tabs-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-tabs-set}@code{text-tag-tabs-set}.
1968 @item @anchor{slot.text-tag.underline}underline. Type: @code{PangoUnderline}. Accessor: @anchor{fn.text-tag-underline}@code{text-tag-underline}.
1969 @item @anchor{slot.text-tag.underline-set}underline-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-underline-set}@code{text-tag-underline-set}.
1970 @item @anchor{slot.text-tag.variant}variant. Type: @code{PangoVariant}. Accessor: @anchor{fn.text-tag-variant}@code{text-tag-variant}.
1971 @item @anchor{slot.text-tag.variant-set}variant-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-variant-set}@code{text-tag-variant-set}.
1972 @item @anchor{slot.text-tag.weight}weight. Type: @code{integer}. Accessor: @anchor{fn.text-tag-weight}@code{text-tag-weight}.
1973 @item @anchor{slot.text-tag.weight-set}weight-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-weight-set}@code{text-tag-weight-set}.
1974 @item @anchor{slot.text-tag.wrap-mode}wrap-mode. Type: @ref{wrap-mode}. Accessor: @anchor{fn.text-tag-wrap-mode}@code{text-tag-wrap-mode}.
1975 @item @anchor{slot.text-tag.wrap-mode-set}wrap-mode-set. Type: @code{boolean}. Accessor: @anchor{fn.text-tag-wrap-mode-set}@code{text-tag-wrap-mode-set}.
1976 @end itemize
1977
1978
1979 Signals:
1980 @itemize
1981 @item @anchor{signal.text-tag.event}"event". Signature: (instance @ref{text-tag}), (arg-1 @ref{g-object}), (arg-2 @ref{event}), (arg-3 @ref{text-iter}) @result{} @code{boolean}. Options: run-last.
1982 @end itemize
1983
1984
1985
1986
1987 @node text-tag-table
1988 @section text-tag-table
1989 @Class text-tag-table
1990 Superclass: @ref{g-object}
1991
1992 Slots:
1993 @itemize
1994 @end itemize
1995
1996
1997 Signals:
1998 @itemize
1999 @item @anchor{signal.text-tag-table.tag-added}"tag-added". Signature: (instance @ref{text-tag-table}), (arg-1 @ref{text-tag}) @result{} void. Options: run-last.
2000 @item @anchor{signal.text-tag-table.tag-changed}"tag-changed". Signature: (instance @ref{text-tag-table}), (arg-1 @ref{text-tag}), (arg-2 @code{boolean}) @result{} void. Options: run-last.
2001 @item @anchor{signal.text-tag-table.tag-removed}"tag-removed". Signature: (instance @ref{text-tag-table}), (arg-1 @ref{text-tag}) @result{} void. Options: run-last.
2002 @end itemize
2003
2004
2005
2006
2007 @node toggle-action
2008 @section toggle-action
2009 @Class toggle-action
2010 Superclass: @ref{action}
2011
2012 Subclasses: @ref{radio-action}
2013
2014 Slots:
2015 @itemize
2016 @item @anchor{slot.toggle-action.active}active. Type: @code{boolean}. Accessor: @anchor{fn.toggle-action-active}@code{toggle-action-active}.
2017 @item @anchor{slot.toggle-action.draw-as-radio}draw-as-radio. Type: @code{boolean}. Accessor: @anchor{fn.toggle-action-draw-as-radio}@code{toggle-action-draw-as-radio}.
2018 @end itemize
2019
2020
2021 Signals:
2022 @itemize
2023 @item @anchor{signal.toggle-action.toggled}"toggled". Signature: (instance @ref{toggle-action}) @result{} void. Options: run-first.
2024 @end itemize
2025
2026
2027
2028
2029 @node tooltip
2030 @section tooltip
2031 @Class tooltip
2032 Superclass: @ref{g-object}
2033
2034 Slots:
2035 @itemize
2036 @end itemize
2037
2038
2039 Signals:
2040 @itemize
2041 @end itemize
2042
2043
2044
2045
2046 @node tooltips
2047 @section tooltips
2048 @Class tooltips
2049 Superclass: @ref{gtk-object}
2050
2051 Slots:
2052 @itemize
2053 @end itemize
2054
2055
2056 Signals:
2057 @itemize
2058 @end itemize
2059
2060
2061
2062
2063 @node tree-lisp-store
2064 @section tree-lisp-store
2065 @Class tree-lisp-store
2066 Superclass: @ref{g-object}
2067
2068 Slots:
2069 @itemize
2070 @end itemize
2071
2072
2073 Signals:
2074 @itemize
2075 @end itemize
2076
2077
2078
2079
2080 @node tree-model-filter
2081 @section tree-model-filter
2082 @Class tree-model-filter
2083 Superclass: @ref{g-object}
2084
2085 Slots:
2086 @itemize
2087 @item @anchor{slot.tree-model-filter.child-model}child-model. Type: @ref{tree-model}. Accessor: @anchor{fn.tree-model-filter-child-model}@code{tree-model-filter-child-model}.
2088 @item @anchor{slot.tree-model-filter.virtual-root}virtual-root. Type: @ref{tree-path}. Accessor: @anchor{fn.tree-model-filter-virtual-root}@code{tree-model-filter-virtual-root}.
2089 @end itemize
2090
2091
2092 Signals:
2093 @itemize
2094 @end itemize
2095
2096
2097
2098
2099 @node tree-model-sort
2100 @section tree-model-sort
2101 @Class tree-model-sort
2102 Superclass: @ref{g-object}
2103
2104 Slots:
2105 @itemize
2106 @item @anchor{slot.tree-model-sort.model}model. Type: @ref{tree-model}. Accessor: @anchor{fn.tree-model-sort-model}@code{tree-model-sort-model}.
2107 @end itemize
2108
2109
2110 Signals:
2111 @itemize
2112 @end itemize
2113
2114
2115
2116
2117 @node tree-path
2118 @section tree-path
2119 @Class tree-path
2120 Superclass: @ref{g-boxed-opaque}
2121
2122 Slots:
2123 @itemize
2124 @end itemize
2125
2126
2127
2128
2129
2130
2131 @node tree-selection
2132 @section tree-selection
2133 @Class tree-selection
2134 Superclass: @ref{g-object}
2135
2136 Slots:
2137 @itemize
2138 @item @anchor{slot.tree-selection.mode}mode. Type: @ref{selection-mode}. Accessor: @anchor{fn.tree-selection-mode}@code{tree-selection-mode}.
2139 @item @anchor{slot.tree-selection.select-function}select-function. Type: ????. Accessor: @anchor{fn.tree-selection-select-function}@code{tree-selection-select-function}.
2140 @end itemize
2141
2142
2143 Signals:
2144 @itemize
2145 @item @anchor{signal.tree-selection.changed}"changed". Signature: (instance @ref{tree-selection}) @result{} void. Options: run-first.
2146 @end itemize
2147
2148
2149
2150
2151 @node tree-store
2152 @section tree-store
2153 @Class tree-store
2154 Superclass: @ref{g-object}
2155
2156 Slots:
2157 @itemize
2158 @end itemize
2159
2160
2161 Signals:
2162 @itemize
2163 @end itemize
2164
2165
2166
2167
2168 @node tree-view-column
2169 @section tree-view-column
2170 @Class tree-view-column
2171 Superclass: @ref{gtk-object}
2172
2173 Slots:
2174 @itemize
2175 @item @anchor{slot.tree-view-column.alignment}alignment. Type: @code{single-float}. Accessor: @anchor{fn.tree-view-column-alignment}@code{tree-view-column-alignment}.
2176 @item @anchor{slot.tree-view-column.cell-renderers}cell-renderers. Type: list of @ref{g-object}. Accessor: @anchor{fn.tree-view-column-cell-renderers}@code{tree-view-column-cell-renderers}. Read-only.
2177 @item @anchor{slot.tree-view-column.clickable}clickable. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-column-clickable}@code{tree-view-column-clickable}.
2178 @item @anchor{slot.tree-view-column.expand}expand. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-column-expand}@code{tree-view-column-expand}.
2179 @item @anchor{slot.tree-view-column.fixed-width}fixed-width. Type: @code{integer}. Accessor: @anchor{fn.tree-view-column-fixed-width}@code{tree-view-column-fixed-width}.
2180 @item @anchor{slot.tree-view-column.max-width}max-width. Type: @code{integer}. Accessor: @anchor{fn.tree-view-column-max-width}@code{tree-view-column-max-width}.
2181 @item @anchor{slot.tree-view-column.min-width}min-width. Type: @code{integer}. Accessor: @anchor{fn.tree-view-column-min-width}@code{tree-view-column-min-width}.
2182 @item @anchor{slot.tree-view-column.reorderable}reorderable. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-column-reorderable}@code{tree-view-column-reorderable}.
2183 @item @anchor{slot.tree-view-column.resizable}resizable. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-column-resizable}@code{tree-view-column-resizable}.
2184 @item @anchor{slot.tree-view-column.sizing}sizing. Type: @ref{tree-view-column-sizing}. Accessor: @anchor{fn.tree-view-column-sizing}@code{tree-view-column-sizing}.
2185 @item @anchor{slot.tree-view-column.sort-column-id}sort-column-id. Type: @code{integer}. Accessor: @anchor{fn.tree-view-column-sort-column-id}@code{tree-view-column-sort-column-id}.
2186 @item @anchor{slot.tree-view-column.sort-indicator}sort-indicator. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-column-sort-indicator}@code{tree-view-column-sort-indicator}.
2187 @item @anchor{slot.tree-view-column.sort-order}sort-order. Type: @ref{sort-type}. Accessor: @anchor{fn.tree-view-column-sort-order}@code{tree-view-column-sort-order}.
2188 @item @anchor{slot.tree-view-column.spacing}spacing. Type: @code{integer}. Accessor: @anchor{fn.tree-view-column-spacing}@code{tree-view-column-spacing}.
2189 @item @anchor{slot.tree-view-column.title}title. Type: @code{string}. Accessor: @anchor{fn.tree-view-column-title}@code{tree-view-column-title}.
2190 @item @anchor{slot.tree-view-column.tree-view}tree-view. Type: @ref{g-object}. Accessor: @anchor{fn.tree-view-column-tree-view}@code{tree-view-column-tree-view}. Read-only.
2191 @item @anchor{slot.tree-view-column.visible}visible. Type: @code{boolean}. Accessor: @anchor{fn.tree-view-column-visible}@code{tree-view-column-visible}.
2192 @item @anchor{slot.tree-view-column.widget}widget. Type: @ref{widget}. Accessor: @anchor{fn.tree-view-column-widget}@code{tree-view-column-widget}.
2193 @item @anchor{slot.tree-view-column.width}width. Type: @code{integer}. Accessor: @anchor{fn.tree-view-column-width}@code{tree-view-column-width}. Read-only.
2194 @end itemize
2195
2196
2197 Signals:
2198 @itemize
2199 @item @anchor{signal.tree-view-column.clicked}"clicked". Signature: (instance @ref{tree-view-column}) @result{} void. Options: run-last.
2200 @end itemize
2201
2202
2203
2204
2205 @node ui-manager
2206 @section ui-manager
2207 @Class ui-manager
2208 Superclass: @ref{g-object}
2209
2210 Slots:
2211 @itemize
2212 @item @anchor{slot.ui-manager.accel-group}accel-group. Type: @ref{g-object}. Accessor: @anchor{fn.ui-manager-accel-group}@code{ui-manager-accel-group}. Read-only.
2213 @item @anchor{slot.ui-manager.add-tearoffs}add-tearoffs. Type: @code{boolean}. Accessor: @anchor{fn.ui-manager-add-tearoffs}@code{ui-manager-add-tearoffs}.
2214 @item @anchor{slot.ui-manager.ui}ui. Type: @code{string}. Accessor: @anchor{fn.ui-manager-ui}@code{ui-manager-ui}. Read-only.
2215 @end itemize
2216
2217
2218 Signals:
2219 @itemize
2220 @item @anchor{signal.ui-manager.actions-changed}"actions-changed". Signature: (instance @ref{ui-manager}) @result{} void. Options: run-first, no-recurse.
2221 @item @anchor{signal.ui-manager.add-widget}"add-widget". Signature: (instance @ref{ui-manager}), (arg-1 @ref{widget}) @result{} void. Options: run-first, no-recurse.
2222 @item @anchor{signal.ui-manager.connect-proxy}"connect-proxy". Signature: (instance @ref{ui-manager}), (arg-1 @ref{action}), (arg-2 @ref{widget}) @result{} void. Options: run-first, no-recurse.
2223 @item @anchor{signal.ui-manager.disconnect-proxy}"disconnect-proxy". Signature: (instance @ref{ui-manager}), (arg-1 @ref{action}), (arg-2 @ref{widget}) @result{} void. Options: run-first, no-recurse.
2224 @item @anchor{signal.ui-manager.post-activate}"post-activate". Signature: (instance @ref{ui-manager}), (arg-1 @ref{action}) @result{} void. Options: run-first, no-recurse.
2225 @item @anchor{signal.ui-manager.pre-activate}"pre-activate". Signature: (instance @ref{ui-manager}), (arg-1 @ref{action}) @result{} void. Options: run-first, no-recurse.
2226 @end itemize
2227
2228
2229
2230
2231 @node window-group
2232 @section window-group
2233 @Class window-group
2234 Superclass: @ref{g-object}
2235
2236 Slots:
2237 @itemize
2238 @end itemize
2239
2240
2241 Signals:
2242 @itemize
2243 @end itemize
2244
2245
2246
2247