Improved doc-skeleton generator
[cl-gtk2.git] / doc / gtk.interfaces.texi
1 @menu
2 * activatable::
3 * atk-implementor-iface::
4 * buildable::
5 * cell-editable::
6 * cell-layout::
7 * editable::
8 * file-chooser::
9 * file-chooser-embed::
10 * orientable::
11 * print-operation-preview::
12 * recent-chooser::
13 * tool-shell::
14 * tree-drag-dest::
15 * tree-drag-source::
16 * tree-model::
17 * tree-sortable::
18 @end menu
19
20 @node activatable
21 @section activatable
22 @Class activatable
23
24
25 Slots:
26 @itemize
27 @item @anchor{slot.activatable.related-action}related-action. Type: @ref{action}. Accessor: @anchor{fn.activatable-related-action}@code{activatable-related-action}.
28 @item @anchor{slot.activatable.use-action-appearance}use-action-appearance. Type: @code{boolean}. Accessor: @anchor{fn.activatable-use-action-appearance}@code{activatable-use-action-appearance}.
29 @end itemize
30
31
32 Signals:
33 @itemize
34 @end itemize
35
36
37 @node atk-implementor-iface
38 @section atk-implementor-iface
39 @Class atk-implementor-iface
40
41
42 Slots:
43 @itemize
44 @end itemize
45
46
47 Signals:
48 @itemize
49 @end itemize
50
51
52 @node buildable
53 @section buildable
54 @Class buildable
55
56
57 Slots:
58 @itemize
59 @end itemize
60
61
62 Signals:
63 @itemize
64 @end itemize
65
66
67 @node cell-editable
68 @section cell-editable
69 @Class cell-editable
70
71
72 Slots:
73 @itemize
74 @end itemize
75
76
77 Signals:
78 @itemize
79 @item @anchor{signal.cell-editable.editing-done}"editing-done". Signature: (instance @ref{cell-editable}) @result{} void. Options: run-last.
80 @item @anchor{signal.cell-editable.remove-widget}"remove-widget". Signature: (instance @ref{cell-editable}) @result{} void. Options: run-last.
81 @end itemize
82
83
84 @node cell-layout
85 @section cell-layout
86 @Class cell-layout
87
88
89 Slots:
90 @itemize
91 @end itemize
92
93
94 Signals:
95 @itemize
96 @end itemize
97
98
99 @node editable
100 @section editable
101 @Class editable
102
103
104 Slots:
105 @itemize
106 @end itemize
107
108
109 Signals:
110 @itemize
111 @item @anchor{signal.editable.changed}"changed". Signature: (instance GtkEditable) @result{} void. Options: run-last.
112 @item @anchor{signal.editable.insert-text}"insert-text". Signature: (instance GtkEditable), (arg-1 @code{string}), (arg-2 @code{integer}), (arg-3 gpointer) @result{} void. Options: run-last.
113 @item @anchor{signal.editable.delete-text}"delete-text". Signature: (instance GtkEditable), (arg-1 @code{integer}), (arg-2 @code{integer}) @result{} void. Options: run-last.
114 @end itemize
115
116
117 @node file-chooser
118 @section file-chooser
119 @Class file-chooser
120
121
122 Slots:
123 @itemize
124 @item @anchor{slot.file-chooser.do-overwrite-confirmation}do-overwrite-confirmation. Type: @code{boolean}. Accessor: @anchor{fn.file-chooser-do-overwrite-confirmation}@code{file-chooser-do-overwrite-confirmation}.
125 @item @anchor{slot.file-chooser.select-multiple}select-multiple. Type: @code{boolean}. Accessor: @anchor{fn.file-chooser-select-multiple}@code{file-chooser-select-multiple}.
126 @item @anchor{slot.file-chooser.filter}filter. Type: @ref{file-filter}. Accessor: @anchor{fn.file-chooser-filter}@code{file-chooser-filter}.
127 @item @anchor{slot.file-chooser.local-only}local-only. Type: @code{boolean}. Accessor: @anchor{fn.file-chooser-local-only}@code{file-chooser-local-only}.
128 @item @anchor{slot.file-chooser.preview-widget}preview-widget. Type: @ref{widget}. Accessor: @anchor{fn.file-chooser-preview-widget}@code{file-chooser-preview-widget}.
129 @item @anchor{slot.file-chooser.use-preview-label}use-preview-label. Type: @code{boolean}. Accessor: @anchor{fn.file-chooser-use-preview-label}@code{file-chooser-use-preview-label}.
130 @item @anchor{slot.file-chooser.preview-widget-active}preview-widget-active. Type: @code{boolean}. Accessor: @anchor{fn.file-chooser-preview-widget-active}@code{file-chooser-preview-widget-active}.
131 @item @anchor{slot.file-chooser.file-system-backend}file-system-backend. Type: @code{string}. Accessor: @anchor{fn.file-chooser-file-system-backend}@code{file-chooser-file-system-backend}. Write-only.
132 @item @anchor{slot.file-chooser.extra-widget}extra-widget. Type: @ref{widget}. Accessor: @anchor{fn.file-chooser-extra-widget}@code{file-chooser-extra-widget}.
133 @item @anchor{slot.file-chooser.show-hidden}show-hidden. Type: @code{boolean}. Accessor: @anchor{fn.file-chooser-show-hidden}@code{file-chooser-show-hidden}.
134 @item @anchor{slot.file-chooser.action}action. Type: @ref{file-chooser-action}. Accessor: @anchor{fn.file-chooser-action}@code{file-chooser-action}.
135 @item @anchor{slot.file-chooser.current-name}current-name. Type: @code{string}. Accessor: @anchor{fn.file-chooser-current-name}@code{file-chooser-current-name}. Write-only.
136 @item @anchor{slot.file-chooser.filename}filename. Type: @code{string}. Accessor: @anchor{fn.file-chooser-filename}@code{file-chooser-filename}.
137 @item @anchor{slot.file-chooser.current-folder}current-folder. Type: @code{string}. Accessor: @anchor{fn.file-chooser-current-folder}@code{file-chooser-current-folder}.
138 @item @anchor{slot.file-chooser.uri}uri. Type: @code{string}. Accessor: @anchor{fn.file-chooser-uri}@code{file-chooser-uri}.
139 @item @anchor{slot.file-chooser.current-folder-uri}current-folder-uri. Type: @code{string}. Accessor: @anchor{fn.file-chooser-current-folder-uri}@code{file-chooser-current-folder-uri}.
140 @item @anchor{slot.file-chooser.preview-filename}preview-filename. Type: @code{string}. Accessor: @anchor{fn.file-chooser-preview-filename}@code{file-chooser-preview-filename}. Read-only.
141 @item @anchor{slot.file-chooser.preview-uri}preview-uri. Type: @code{string}. Accessor: @anchor{fn.file-chooser-preview-uri}@code{file-chooser-preview-uri}. Read-only.
142 @end itemize
143
144
145 Signals:
146 @itemize
147 @item @anchor{signal.file-chooser.selection-changed}"selection-changed". Signature: (instance @ref{file-chooser}) @result{} void. Options: run-last.
148 @item @anchor{signal.file-chooser.current-folder-changed}"current-folder-changed". Signature: (instance @ref{file-chooser}) @result{} void. Options: run-last.
149 @item @anchor{signal.file-chooser.update-preview}"update-preview". Signature: (instance @ref{file-chooser}) @result{} void. Options: run-last.
150 @item @anchor{signal.file-chooser.file-activated}"file-activated". Signature: (instance @ref{file-chooser}) @result{} void. Options: run-last.
151 @item @anchor{signal.file-chooser.confirm-overwrite}"confirm-overwrite". Signature: (instance @ref{file-chooser}) @result{} @ref{file-chooser-confirmation}. Options: run-last.
152 @end itemize
153
154
155 @node file-chooser-embed
156 @section file-chooser-embed
157 @Class file-chooser-embed
158
159
160 Slots:
161 @itemize
162 @end itemize
163
164
165 Signals:
166 @itemize
167 @end itemize
168
169
170 @node orientable
171 @section orientable
172 @Class orientable
173
174
175 Slots:
176 @itemize
177 @item @anchor{slot.orientable.orientation}orientation. Type: @ref{orientation}. Accessor: @anchor{fn.orientable-orientation}@code{orientable-orientation}.
178 @end itemize
179
180
181 Signals:
182 @itemize
183 @end itemize
184
185
186 @node print-operation-preview
187 @section print-operation-preview
188 @Class print-operation-preview
189
190
191 Slots:
192 @itemize
193 @end itemize
194
195
196 Signals:
197 @itemize
198 @item @anchor{signal.print-operation-preview.ready}"ready". Signature: (instance @ref{print-operation-preview}), (arg-1 @ref{print-context}) @result{} void. Options: run-last.
199 @item @anchor{signal.print-operation-preview.got-page-size}"got-page-size". Signature: (instance @ref{print-operation-preview}), (arg-1 @ref{print-context}), (arg-2 @ref{page-setup}) @result{} void. Options: run-last.
200 @end itemize
201
202
203 @node recent-chooser
204 @section recent-chooser
205 @Class recent-chooser
206
207
208 Slots:
209 @itemize
210 @item @anchor{slot.recent-chooser.show-private}show-private. Type: @code{boolean}. Accessor: @anchor{fn.recent-chooser-show-private}@code{recent-chooser-show-private}.
211 @item @anchor{slot.recent-chooser.show-tips}show-tips. Type: @code{boolean}. Accessor: @anchor{fn.recent-chooser-show-tips}@code{recent-chooser-show-tips}.
212 @item @anchor{slot.recent-chooser.filter}filter. Type: @ref{recent-filter}. Accessor: @anchor{fn.recent-chooser-filter}@code{recent-chooser-filter}.
213 @item @anchor{slot.recent-chooser.show-not-found}show-not-found. Type: @code{boolean}. Accessor: @anchor{fn.recent-chooser-show-not-found}@code{recent-chooser-show-not-found}.
214 @item @anchor{slot.recent-chooser.recent-manager}recent-manager. Type: @ref{recent-manager}. Accessor: @anchor{fn.recent-chooser-recent-manager}@code{recent-chooser-recent-manager}. Write-only.
215 @item @anchor{slot.recent-chooser.limit}limit. Type: @code{integer}. Accessor: @anchor{fn.recent-chooser-limit}@code{recent-chooser-limit}.
216 @item @anchor{slot.recent-chooser.show-icons}show-icons. Type: @code{boolean}. Accessor: @anchor{fn.recent-chooser-show-icons}@code{recent-chooser-show-icons}.
217 @item @anchor{slot.recent-chooser.local-only}local-only. Type: @code{boolean}. Accessor: @anchor{fn.recent-chooser-local-only}@code{recent-chooser-local-only}.
218 @item @anchor{slot.recent-chooser.sort-type}sort-type. Type: @ref{recent-sort-type}. Accessor: @anchor{fn.recent-chooser-sort-type}@code{recent-chooser-sort-type}.
219 @item @anchor{slot.recent-chooser.select-multiple}select-multiple. Type: @code{boolean}. Accessor: @anchor{fn.recent-chooser-select-multiple}@code{recent-chooser-select-multiple}.
220 @end itemize
221
222
223 Signals:
224 @itemize
225 @item @anchor{signal.recent-chooser.item-activated}"item-activated". Signature: (instance @ref{recent-chooser}) @result{} void. Options: run-last.
226 @item @anchor{signal.recent-chooser.selection-changed}"selection-changed". Signature: (instance @ref{recent-chooser}) @result{} void. Options: run-last.
227 @end itemize
228
229
230 @node tool-shell
231 @section tool-shell
232 @Class tool-shell
233
234
235 Slots:
236 @itemize
237 @end itemize
238
239
240 Signals:
241 @itemize
242 @end itemize
243
244
245 @node tree-drag-dest
246 @section tree-drag-dest
247 @Class tree-drag-dest
248
249
250 Slots:
251 @itemize
252 @end itemize
253
254
255 Signals:
256 @itemize
257 @end itemize
258
259
260 @node tree-drag-source
261 @section tree-drag-source
262 @Class tree-drag-source
263
264
265 Slots:
266 @itemize
267 @end itemize
268
269
270 Signals:
271 @itemize
272 @end itemize
273
274
275 @node tree-model
276 @section tree-model
277 @Class tree-model
278
279
280 Slots:
281 @itemize
282 @end itemize
283
284
285 Signals:
286 @itemize
287 @item @anchor{signal.tree-model.row-changed}"row-changed". Signature: (instance @ref{tree-model}), (arg-1 @ref{tree-path}), (arg-2 @ref{tree-iter}) @result{} void. Options: run-last.
288 @item @anchor{signal.tree-model.row-inserted}"row-inserted". Signature: (instance @ref{tree-model}), (arg-1 @ref{tree-path}), (arg-2 @ref{tree-iter}) @result{} void. Options: run-first.
289 @item @anchor{signal.tree-model.row-has-child-toggled}"row-has-child-toggled". Signature: (instance @ref{tree-model}), (arg-1 @ref{tree-path}), (arg-2 @ref{tree-iter}) @result{} void. Options: run-last.
290 @item @anchor{signal.tree-model.row-deleted}"row-deleted". Signature: (instance @ref{tree-model}), (arg-1 @ref{tree-path}) @result{} void. Options: run-first.
291 @item @anchor{signal.tree-model.rows-reordered}"rows-reordered". Signature: (instance @ref{tree-model}), (arg-1 @ref{tree-path}), (arg-2 @ref{tree-iter}), (arg-3 gpointer) @result{} void. Options: run-first.
292 @end itemize
293
294
295 @node tree-sortable
296 @section tree-sortable
297 @Class tree-sortable
298
299
300 Slots:
301 @itemize
302 @end itemize
303
304
305 Signals:
306 @itemize
307 @item @anchor{signal.tree-sortable.sort-column-changed}"sort-column-changed". Signature: (instance @ref{tree-sortable}) @result{} void. Options: run-last.
308 @end itemize
309
310