1 /* GTK - The GIMP Toolkit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library. If not, see <http://www.gnu.org/licenses/>.
16 */
17
18 /*
19 * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GTK+ Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
23 */
24
25 #ifndef __GTK_ENUMS_H__
26 #define __GTK_ENUMS_H__
27
28 #if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
29 #error "Only <gtk/gtk.h> can be included directly."
30 #endif
31
32 #include <glib-object.h>
33
34
35 G_BEGIN_DECLS
36
37 /**
38 * GtkAlign:
39 * @GTK_ALIGN_FILL: stretch to fill all space if possible, center if
40 * no meaningful way to stretch
41 * @GTK_ALIGN_START: snap to left or top side, leaving space on right or bottom
42 * @GTK_ALIGN_END: snap to right or bottom side, leaving space on left or top
43 * @GTK_ALIGN_CENTER: center natural width of widget inside the allocation
44 * @GTK_ALIGN_BASELINE: align the widget according to the baseline.
45 * See [class@Gtk.Widget].
46 *
47 * Controls how a widget deals with extra space in a single dimension.
48 *
49 * Alignment only matters if the widget receives a “too large” allocation,
50 * for example if you packed the widget with the [property@Gtk.Widget:hexpand]
51 * property inside a `GtkBox`, then the widget might get extra space.
52 * If you have for example a 16x16 icon inside a 32x32 space, the icon
53 * could be scaled and stretched, it could be centered, or it could be
54 * positioned to one side of the space.
55 *
56 * Note that in horizontal context %GTK_ALIGN_START and %GTK_ALIGN_END
57 * are interpreted relative to text direction.
58 *
59 * %GTK_ALIGN_BASELINE support is optional for containers and widgets, and
60 * it is only supported for vertical alignment. When it's not supported by
61 * a child or a container it is treated as %GTK_ALIGN_FILL.
62 */
63 typedef enum
64 {
65 GTK_ALIGN_FILL,
66 GTK_ALIGN_START,
67 GTK_ALIGN_END,
68 GTK_ALIGN_CENTER,
69 GTK_ALIGN_BASELINE
70 } GtkAlign;
71
72 /**
73 * GtkArrowType:
74 * @GTK_ARROW_UP: Represents an upward pointing arrow.
75 * @GTK_ARROW_DOWN: Represents a downward pointing arrow.
76 * @GTK_ARROW_LEFT: Represents a left pointing arrow.
77 * @GTK_ARROW_RIGHT: Represents a right pointing arrow.
78 * @GTK_ARROW_NONE: No arrow.
79 *
80 * Used to indicate the direction in which an arrow should point.
81 */
82 typedef enum
83 {
84 GTK_ARROW_UP,
85 GTK_ARROW_DOWN,
86 GTK_ARROW_LEFT,
87 GTK_ARROW_RIGHT,
88 GTK_ARROW_NONE
89 } GtkArrowType;
90
91 /**
92 * GtkBaselinePosition:
93 * @GTK_BASELINE_POSITION_TOP: Align the baseline at the top
94 * @GTK_BASELINE_POSITION_CENTER: Center the baseline
95 * @GTK_BASELINE_POSITION_BOTTOM: Align the baseline at the bottom
96 *
97 * Baseline position in a row of widgets.
98 *
99 * Whenever a container has some form of natural row it may align
100 * children in that row along a common typographical baseline. If
101 * the amount of vertical space in the row is taller than the total
102 * requested height of the baseline-aligned children then it can use a
103 * `GtkBaselinePosition` to select where to put the baseline inside the
104 * extra available space.
105 */
106 typedef enum
107 {
108 GTK_BASELINE_POSITION_TOP,
109 GTK_BASELINE_POSITION_CENTER,
110 GTK_BASELINE_POSITION_BOTTOM
111 } GtkBaselinePosition;
112
113 /**
114 * GtkDeleteType:
115 * @GTK_DELETE_CHARS: Delete characters.
116 * @GTK_DELETE_WORD_ENDS: Delete only the portion of the word to the
117 * left/right of cursor if we’re in the middle of a word.
118 * @GTK_DELETE_WORDS: Delete words.
119 * @GTK_DELETE_DISPLAY_LINES: Delete display-lines. Display-lines
120 * refers to the visible lines, with respect to the current line
121 * breaks. As opposed to paragraphs, which are defined by line
122 * breaks in the input.
123 * @GTK_DELETE_DISPLAY_LINE_ENDS: Delete only the portion of the
124 * display-line to the left/right of cursor.
125 * @GTK_DELETE_PARAGRAPH_ENDS: Delete to the end of the
126 * paragraph. Like C-k in Emacs (or its reverse).
127 * @GTK_DELETE_PARAGRAPHS: Delete entire line. Like C-k in pico.
128 * @GTK_DELETE_WHITESPACE: Delete only whitespace. Like M-\ in Emacs.
129 *
130 * Passed to various keybinding signals for deleting text.
131 */
132 typedef enum
133 {
134 GTK_DELETE_CHARS,
135 GTK_DELETE_WORD_ENDS,
136 GTK_DELETE_WORDS,
137 GTK_DELETE_DISPLAY_LINES,
138 GTK_DELETE_DISPLAY_LINE_ENDS,
139 GTK_DELETE_PARAGRAPH_ENDS,
140 GTK_DELETE_PARAGRAPHS,
141 GTK_DELETE_WHITESPACE
142 } GtkDeleteType;
143
144 /* Focus movement types */
145 /**
146 * GtkDirectionType:
147 * @GTK_DIR_TAB_FORWARD: Move forward.
148 * @GTK_DIR_TAB_BACKWARD: Move backward.
149 * @GTK_DIR_UP: Move up.
150 * @GTK_DIR_DOWN: Move down.
151 * @GTK_DIR_LEFT: Move left.
152 * @GTK_DIR_RIGHT: Move right.
153 *
154 * Focus movement types.
155 */
156 typedef enum
157 {
158 GTK_DIR_TAB_FORWARD,
159 GTK_DIR_TAB_BACKWARD,
160 GTK_DIR_UP,
161 GTK_DIR_DOWN,
162 GTK_DIR_LEFT,
163 GTK_DIR_RIGHT
164 } GtkDirectionType;
165
166 /**
167 * GtkIconSize:
168 * @GTK_ICON_SIZE_INHERIT: Keep the size of the parent element
169 * @GTK_ICON_SIZE_NORMAL: Size similar to text size
170 * @GTK_ICON_SIZE_LARGE: Large size, for example in an icon view
171 *
172 * Built-in icon sizes.
173 *
174 * Icon sizes default to being inherited. Where they cannot be
175 * inherited, text size is the default.
176 *
177 * All widgets which use `GtkIconSize` set the normal-icons or
178 * large-icons style classes correspondingly, and let themes
179 * determine the actual size to be used with the
180 * `-gtk-icon-size` CSS property.
181 */
182 typedef enum
183 {
184 GTK_ICON_SIZE_INHERIT,
185 GTK_ICON_SIZE_NORMAL,
186 GTK_ICON_SIZE_LARGE
187 } GtkIconSize;
188
189 /**
190 * GtkSensitivityType:
191 * @GTK_SENSITIVITY_AUTO: The control is made insensitive if no
192 * action can be triggered
193 * @GTK_SENSITIVITY_ON: The control is always sensitive
194 * @GTK_SENSITIVITY_OFF: The control is always insensitive
195 *
196 * Determines how GTK handles the sensitivity of various controls,
197 * such as combo box buttons.
198 */
199 typedef enum
200 {
201 GTK_SENSITIVITY_AUTO,
202 GTK_SENSITIVITY_ON,
203 GTK_SENSITIVITY_OFF
204 } GtkSensitivityType;
205
206 /* Reading directions for text */
207 /**
208 * GtkTextDirection:
209 * @GTK_TEXT_DIR_NONE: No direction.
210 * @GTK_TEXT_DIR_LTR: Left to right text direction.
211 * @GTK_TEXT_DIR_RTL: Right to left text direction.
212 *
213 * Reading directions for text.
214 */
215 typedef enum
216 {
217 GTK_TEXT_DIR_NONE,
218 GTK_TEXT_DIR_LTR,
219 GTK_TEXT_DIR_RTL
220 } GtkTextDirection;
221
222 /**
223 * GtkJustification:
224 * @GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
225 * @GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
226 * @GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
227 * @GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
228 *
229 * Used for justifying the text inside a `GtkLabel` widget.
230 */
231 typedef enum
232 {
233 GTK_JUSTIFY_LEFT,
234 GTK_JUSTIFY_RIGHT,
235 GTK_JUSTIFY_CENTER,
236 GTK_JUSTIFY_FILL
237 } GtkJustification;
238
239 /**
240 * GtkMessageType:
241 * @GTK_MESSAGE_INFO: Informational message
242 * @GTK_MESSAGE_WARNING: Non-fatal warning message
243 * @GTK_MESSAGE_QUESTION: Question requiring a choice
244 * @GTK_MESSAGE_ERROR: Fatal error message
245 * @GTK_MESSAGE_OTHER: None of the above
246 *
247 * The type of message being displayed in a `GtkMessageDialog`.
248 */
249 typedef enum
250 {
251 GTK_MESSAGE_INFO,
252 GTK_MESSAGE_WARNING,
253 GTK_MESSAGE_QUESTION,
254 GTK_MESSAGE_ERROR,
255 GTK_MESSAGE_OTHER
256 } GtkMessageType;
257
258 /**
259 * GtkMovementStep:
260 * @GTK_MOVEMENT_LOGICAL_POSITIONS: Move forward or back by graphemes
261 * @GTK_MOVEMENT_VISUAL_POSITIONS: Move left or right by graphemes
262 * @GTK_MOVEMENT_WORDS: Move forward or back by words
263 * @GTK_MOVEMENT_DISPLAY_LINES: Move up or down lines (wrapped lines)
264 * @GTK_MOVEMENT_DISPLAY_LINE_ENDS: Move to either end of a line
265 * @GTK_MOVEMENT_PARAGRAPHS: Move up or down paragraphs (newline-ended lines)
266 * @GTK_MOVEMENT_PARAGRAPH_ENDS: Move to either end of a paragraph
267 * @GTK_MOVEMENT_PAGES: Move by pages
268 * @GTK_MOVEMENT_BUFFER_ENDS: Move to ends of the buffer
269 * @GTK_MOVEMENT_HORIZONTAL_PAGES: Move horizontally by pages
270 *
271 * Passed as argument to various keybinding signals for moving the
272 * cursor position.
273 */
274 typedef enum
275 {
276 GTK_MOVEMENT_LOGICAL_POSITIONS,
277 GTK_MOVEMENT_VISUAL_POSITIONS,
278 GTK_MOVEMENT_WORDS,
279 GTK_MOVEMENT_DISPLAY_LINES,
280 GTK_MOVEMENT_DISPLAY_LINE_ENDS,
281 GTK_MOVEMENT_PARAGRAPHS,
282 GTK_MOVEMENT_PARAGRAPH_ENDS,
283 GTK_MOVEMENT_PAGES,
284 GTK_MOVEMENT_BUFFER_ENDS,
285 GTK_MOVEMENT_HORIZONTAL_PAGES
286 } GtkMovementStep;
287
288 /**
289 * GtkScrollStep:
290 * @GTK_SCROLL_STEPS: Scroll in steps.
291 * @GTK_SCROLL_PAGES: Scroll by pages.
292 * @GTK_SCROLL_ENDS: Scroll to ends.
293 * @GTK_SCROLL_HORIZONTAL_STEPS: Scroll in horizontal steps.
294 * @GTK_SCROLL_HORIZONTAL_PAGES: Scroll by horizontal pages.
295 * @GTK_SCROLL_HORIZONTAL_ENDS: Scroll to the horizontal ends.
296 *
297 * Passed as argument to various keybinding signals.
298 */
299 typedef enum
300 {
301 GTK_SCROLL_STEPS,
302 GTK_SCROLL_PAGES,
303 GTK_SCROLL_ENDS,
304 GTK_SCROLL_HORIZONTAL_STEPS,
305 GTK_SCROLL_HORIZONTAL_PAGES,
306 GTK_SCROLL_HORIZONTAL_ENDS
307 } GtkScrollStep;
308
309 /**
310 * GtkOrientation:
311 * @GTK_ORIENTATION_HORIZONTAL: The element is in horizontal orientation.
312 * @GTK_ORIENTATION_VERTICAL: The element is in vertical orientation.
313 *
314 * Represents the orientation of widgets and other objects.
315 *
316 * Typical examples are `GtkBox or `GtkGesturePan`.
317 */
318 typedef enum
319 {
320 GTK_ORIENTATION_HORIZONTAL,
321 GTK_ORIENTATION_VERTICAL
322 } GtkOrientation;
323
324 /**
325 * GtkOverflow:
326 * @GTK_OVERFLOW_VISIBLE: No change is applied. Content is drawn at the specified
327 * position.
328 * @GTK_OVERFLOW_HIDDEN: Content is clipped to the bounds of the area. Content
329 * outside the area is not drawn and cannot be interacted with.
330 *
331 * Defines how content overflowing a given area should be handled.
332 *
333 * This is used in [method@Gtk.Widget.set_overflow]. The
334 * [property@Gtk.Widget:overflow] property is modeled after the
335 * CSS overflow property, but implements it only partially.
336 */
337 typedef enum
338 {
339 GTK_OVERFLOW_VISIBLE,
340 GTK_OVERFLOW_HIDDEN
341 } GtkOverflow;
342
343 /**
344 * GtkPackType:
345 * @GTK_PACK_START: The child is packed into the start of the widget
346 * @GTK_PACK_END: The child is packed into the end of the widget
347 *
348 * Represents the packing location of a children in its parent.
349 *
350 * See `GtkWindowControls` for example.
351 */
352 typedef enum
353 {
354 GTK_PACK_START,
355 GTK_PACK_END
356 } GtkPackType;
357
358 /**
359 * GtkPositionType:
360 * @GTK_POS_LEFT: The feature is at the left edge.
361 * @GTK_POS_RIGHT: The feature is at the right edge.
362 * @GTK_POS_TOP: The feature is at the top edge.
363 * @GTK_POS_BOTTOM: The feature is at the bottom edge.
364 *
365 * Describes which edge of a widget a certain feature is positioned at.
366 *
367 * For examples, see the tabs of a `GtkNotebook`, or the label
368 * of a `GtkScale`.
369 */
370 typedef enum
371 {
372 GTK_POS_LEFT,
373 GTK_POS_RIGHT,
374 GTK_POS_TOP,
375 GTK_POS_BOTTOM
376 } GtkPositionType;
377
378 /**
379 * GtkScrollType:
380 * @GTK_SCROLL_NONE: No scrolling.
381 * @GTK_SCROLL_JUMP: Jump to new location.
382 * @GTK_SCROLL_STEP_BACKWARD: Step backward.
383 * @GTK_SCROLL_STEP_FORWARD: Step forward.
384 * @GTK_SCROLL_PAGE_BACKWARD: Page backward.
385 * @GTK_SCROLL_PAGE_FORWARD: Page forward.
386 * @GTK_SCROLL_STEP_UP: Step up.
387 * @GTK_SCROLL_STEP_DOWN: Step down.
388 * @GTK_SCROLL_PAGE_UP: Page up.
389 * @GTK_SCROLL_PAGE_DOWN: Page down.
390 * @GTK_SCROLL_STEP_LEFT: Step to the left.
391 * @GTK_SCROLL_STEP_RIGHT: Step to the right.
392 * @GTK_SCROLL_PAGE_LEFT: Page to the left.
393 * @GTK_SCROLL_PAGE_RIGHT: Page to the right.
394 * @GTK_SCROLL_START: Scroll to start.
395 * @GTK_SCROLL_END: Scroll to end.
396 *
397 * Scrolling types.
398 */
399 typedef enum
400 {
401 GTK_SCROLL_NONE,
402 GTK_SCROLL_JUMP,
403 GTK_SCROLL_STEP_BACKWARD,
404 GTK_SCROLL_STEP_FORWARD,
405 GTK_SCROLL_PAGE_BACKWARD,
406 GTK_SCROLL_PAGE_FORWARD,
407 GTK_SCROLL_STEP_UP,
408 GTK_SCROLL_STEP_DOWN,
409 GTK_SCROLL_PAGE_UP,
410 GTK_SCROLL_PAGE_DOWN,
411 GTK_SCROLL_STEP_LEFT,
412 GTK_SCROLL_STEP_RIGHT,
413 GTK_SCROLL_PAGE_LEFT,
414 GTK_SCROLL_PAGE_RIGHT,
415 GTK_SCROLL_START,
416 GTK_SCROLL_END
417 } GtkScrollType;
418
419 /**
420 * GtkSelectionMode:
421 * @GTK_SELECTION_NONE: No selection is possible.
422 * @GTK_SELECTION_SINGLE: Zero or one element may be selected.
423 * @GTK_SELECTION_BROWSE: Exactly one element is selected.
424 * In some circumstances, such as initially or during a search
425 * operation, it’s possible for no element to be selected with
426 * %GTK_SELECTION_BROWSE. What is really enforced is that the user
427 * can’t deselect a currently selected element except by selecting
428 * another element.
429 * @GTK_SELECTION_MULTIPLE: Any number of elements may be selected.
430 * The Ctrl key may be used to enlarge the selection, and Shift
431 * key to select between the focus and the child pointed to.
432 * Some widgets may also allow Click-drag to select a range of elements.
433 *
434 * Used to control what selections users are allowed to make.
435 */
436 typedef enum
437 {
438 GTK_SELECTION_NONE,
439 GTK_SELECTION_SINGLE,
440 GTK_SELECTION_BROWSE,
441 GTK_SELECTION_MULTIPLE
442 } GtkSelectionMode;
443
444 /* Widget states */
445
446 /**
447 * GtkWrapMode:
448 * @GTK_WRAP_NONE: do not wrap lines; just make the text area wider
449 * @GTK_WRAP_CHAR: wrap text, breaking lines anywhere the cursor can
450 * appear (between characters, usually - if you want to be technical,
451 * between graphemes, see pango_get_log_attrs())
452 * @GTK_WRAP_WORD: wrap text, breaking lines in between words
453 * @GTK_WRAP_WORD_CHAR: wrap text, breaking lines in between words, or if
454 * that is not enough, also between graphemes
455 *
456 * Describes a type of line wrapping.
457 */
458 typedef enum
459 {
460 GTK_WRAP_NONE,
461 GTK_WRAP_CHAR,
462 GTK_WRAP_WORD,
463 GTK_WRAP_WORD_CHAR
464 } GtkWrapMode;
465
466 /**
467 * GtkSortType:
468 * @GTK_SORT_ASCENDING: Sorting is in ascending order.
469 * @GTK_SORT_DESCENDING: Sorting is in descending order.
470 *
471 * Determines the direction of a sort.
472 */
473 typedef enum
474 {
475 GTK_SORT_ASCENDING,
476 GTK_SORT_DESCENDING
477 } GtkSortType;
478
479 /**
480 * GtkPrintPages:
481 * @GTK_PRINT_PAGES_ALL: All pages.
482 * @GTK_PRINT_PAGES_CURRENT: Current page.
483 * @GTK_PRINT_PAGES_RANGES: Range of pages.
484 * @GTK_PRINT_PAGES_SELECTION: Selected pages.
485 *
486 * See also gtk_print_job_set_pages()
487 */
488 typedef enum
489 {
490 GTK_PRINT_PAGES_ALL,
491 GTK_PRINT_PAGES_CURRENT,
492 GTK_PRINT_PAGES_RANGES,
493 GTK_PRINT_PAGES_SELECTION
494 } GtkPrintPages;
495
496 /**
497 * GtkPageSet:
498 * @GTK_PAGE_SET_ALL: All pages.
499 * @GTK_PAGE_SET_EVEN: Even pages.
500 * @GTK_PAGE_SET_ODD: Odd pages.
501 *
502 * See also gtk_print_job_set_page_set().
503 */
504 typedef enum
505 {
506 GTK_PAGE_SET_ALL,
507 GTK_PAGE_SET_EVEN,
508 GTK_PAGE_SET_ODD
509 } GtkPageSet;
510
511 /**
512 * GtkNumberUpLayout:
513 * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM: 
514 * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP: 
515 * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM: 
516 * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP: 
517 * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT: 
518 * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT: 
519 * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT: 
520 * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT: 
521 *
522 * Used to determine the layout of pages on a sheet when printing
523 * multiple pages per sheet.
524 */
525 typedef enum
526 {
527 GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM, /*< nick=lrtb >*/
528 GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP, /*< nick=lrbt >*/
529 GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM, /*< nick=rltb >*/
530 GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP, /*< nick=rlbt >*/
531 GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT, /*< nick=tblr >*/
532 GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT, /*< nick=tbrl >*/
533 GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT, /*< nick=btlr >*/
534 GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT /*< nick=btrl >*/
535 } GtkNumberUpLayout;
536
537 /**
538 * GtkOrdering:
539 * @GTK_ORDERING_SMALLER: the first value is smaller than the second
540 * @GTK_ORDERING_EQUAL: the two values are equal
541 * @GTK_ORDERING_LARGER: the first value is larger than the second
542 *
543 * Describes the way two values can be compared.
544 *
545 * These values can be used with a `GCompareFunc`. However,
546 * a `GCompareFunc` is allowed to return any integer values.
547 * For converting such a value to a `GtkOrdering` value, use
548 * [func@Gtk.Ordering.from_cmpfunc].
549 */
550 typedef enum {
551 GTK_ORDERING_SMALLER = -1,
552 GTK_ORDERING_EQUAL = 0,
553 GTK_ORDERING_LARGER = 1
554 } GtkOrdering;
555
556 /* The GI scanner does not handle static inline functions, because
557 * of the `static` keyword; so we clip this out when parsing the
558 * header, and we replace it with a real function in gtksorter.c
559 * that only exists when parsing the source for introspection.
560 */
561 #ifdef __GI_SCANNER__
562 GtkOrdering gtk_ordering_from_cmpfunc (int cmpfunc_result);
563 #else
564 /**
565 * gtk_ordering_from_cmpfunc:
566 * @cmpfunc_result: Result of a comparison function
567 *
568 * Converts the result of a `GCompareFunc` like strcmp() to a
569 * `GtkOrdering` value.
570 *
571 * Returns: the corresponding `GtkOrdering`
572 **/
573 static inline GtkOrdering
gtk_ordering_from_cmpfunc(int cmpfunc_result)574 gtk_ordering_from_cmpfunc (int cmpfunc_result)
575 {
576 return (GtkOrdering) ((cmpfunc_result > 0) - (cmpfunc_result < 0));
577 }
578 #endif
579
580 /**
581 * GtkPageOrientation:
582 * @GTK_PAGE_ORIENTATION_PORTRAIT: Portrait mode.
583 * @GTK_PAGE_ORIENTATION_LANDSCAPE: Landscape mode.
584 * @GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT: Reverse portrait mode.
585 * @GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE: Reverse landscape mode.
586 *
587 * See also gtk_print_settings_set_orientation().
588 */
589 typedef enum
590 {
591 GTK_PAGE_ORIENTATION_PORTRAIT,
592 GTK_PAGE_ORIENTATION_LANDSCAPE,
593 GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT,
594 GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE
595 } GtkPageOrientation;
596
597 /**
598 * GtkPrintQuality:
599 * @GTK_PRINT_QUALITY_LOW: Low quality.
600 * @GTK_PRINT_QUALITY_NORMAL: Normal quality.
601 * @GTK_PRINT_QUALITY_HIGH: High quality.
602 * @GTK_PRINT_QUALITY_DRAFT: Draft quality.
603 *
604 * See also gtk_print_settings_set_quality().
605 */
606 typedef enum
607 {
608 GTK_PRINT_QUALITY_LOW,
609 GTK_PRINT_QUALITY_NORMAL,
610 GTK_PRINT_QUALITY_HIGH,
611 GTK_PRINT_QUALITY_DRAFT
612 } GtkPrintQuality;
613
614 /**
615 * GtkPrintDuplex:
616 * @GTK_PRINT_DUPLEX_SIMPLEX: No duplex.
617 * @GTK_PRINT_DUPLEX_HORIZONTAL: Horizontal duplex.
618 * @GTK_PRINT_DUPLEX_VERTICAL: Vertical duplex.
619 *
620 * See also gtk_print_settings_set_duplex().
621 */
622 typedef enum
623 {
624 GTK_PRINT_DUPLEX_SIMPLEX,
625 GTK_PRINT_DUPLEX_HORIZONTAL,
626 GTK_PRINT_DUPLEX_VERTICAL
627 } GtkPrintDuplex;
628
629
630 /**
631 * GtkUnit:
632 * @GTK_UNIT_NONE: No units.
633 * @GTK_UNIT_POINTS: Dimensions in points.
634 * @GTK_UNIT_INCH: Dimensions in inches.
635 * @GTK_UNIT_MM: Dimensions in millimeters
636 *
637 * See also gtk_print_settings_set_paper_width().
638 */
639 typedef enum
640 {
641 GTK_UNIT_NONE,
642 GTK_UNIT_POINTS,
643 GTK_UNIT_INCH,
644 GTK_UNIT_MM
645 } GtkUnit;
646
647 #define GTK_UNIT_PIXEL GTK_UNIT_NONE
648
649 /**
650 * GtkTreeViewGridLines:
651 * @GTK_TREE_VIEW_GRID_LINES_NONE: No grid lines.
652 * @GTK_TREE_VIEW_GRID_LINES_HORIZONTAL: Horizontal grid lines.
653 * @GTK_TREE_VIEW_GRID_LINES_VERTICAL: Vertical grid lines.
654 * @GTK_TREE_VIEW_GRID_LINES_BOTH: Horizontal and vertical grid lines.
655 *
656 * Used to indicate which grid lines to draw in a tree view.
657 */
658 typedef enum
659 {
660 GTK_TREE_VIEW_GRID_LINES_NONE,
661 GTK_TREE_VIEW_GRID_LINES_HORIZONTAL,
662 GTK_TREE_VIEW_GRID_LINES_VERTICAL,
663 GTK_TREE_VIEW_GRID_LINES_BOTH
664 } GtkTreeViewGridLines;
665
666 /**
667 * GtkSizeGroupMode:
668 * @GTK_SIZE_GROUP_NONE: group has no effect
669 * @GTK_SIZE_GROUP_HORIZONTAL: group affects horizontal requisition
670 * @GTK_SIZE_GROUP_VERTICAL: group affects vertical requisition
671 * @GTK_SIZE_GROUP_BOTH: group affects both horizontal and vertical requisition
672 *
673 * The mode of the size group determines the directions in which the size
674 * group affects the requested sizes of its component widgets.
675 **/
676 typedef enum {
677 GTK_SIZE_GROUP_NONE,
678 GTK_SIZE_GROUP_HORIZONTAL,
679 GTK_SIZE_GROUP_VERTICAL,
680 GTK_SIZE_GROUP_BOTH
681 } GtkSizeGroupMode;
682
683 /**
684 * GtkSizeRequestMode:
685 * @GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH: Prefer height-for-width geometry management
686 * @GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT: Prefer width-for-height geometry management
687 * @GTK_SIZE_REQUEST_CONSTANT_SIZE: Don’t trade height-for-width or width-for-height
688 *
689 * Specifies a preference for height-for-width or
690 * width-for-height geometry management.
691 */
692 typedef enum
693 {
694 GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH = 0,
695 GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT,
696 GTK_SIZE_REQUEST_CONSTANT_SIZE
697 } GtkSizeRequestMode;
698
699 /**
700 * GtkScrollablePolicy:
701 * @GTK_SCROLL_MINIMUM: Scrollable adjustments are based on the minimum size
702 * @GTK_SCROLL_NATURAL: Scrollable adjustments are based on the natural size
703 *
704 * Defines the policy to be used in a scrollable widget when updating
705 * the scrolled window adjustments in a given orientation.
706 */
707 typedef enum
708 {
709 GTK_SCROLL_MINIMUM = 0,
710 GTK_SCROLL_NATURAL
711 } GtkScrollablePolicy;
712
713 /**
714 * GtkStateFlags:
715 * @GTK_STATE_FLAG_NORMAL: State during normal operation
716 * @GTK_STATE_FLAG_ACTIVE: Widget is active
717 * @GTK_STATE_FLAG_PRELIGHT: Widget has a mouse pointer over it
718 * @GTK_STATE_FLAG_SELECTED: Widget is selected
719 * @GTK_STATE_FLAG_INSENSITIVE: Widget is insensitive
720 * @GTK_STATE_FLAG_INCONSISTENT: Widget is inconsistent
721 * @GTK_STATE_FLAG_FOCUSED: Widget has the keyboard focus
722 * @GTK_STATE_FLAG_BACKDROP: Widget is in a background toplevel window
723 * @GTK_STATE_FLAG_DIR_LTR: Widget is in left-to-right text direction
724 * @GTK_STATE_FLAG_DIR_RTL: Widget is in right-to-left text direction
725 * @GTK_STATE_FLAG_LINK: Widget is a link
726 * @GTK_STATE_FLAG_VISITED: The location the widget points to has already been visited
727 * @GTK_STATE_FLAG_CHECKED: Widget is checked
728 * @GTK_STATE_FLAG_DROP_ACTIVE: Widget is highlighted as a drop target for DND
729 * @GTK_STATE_FLAG_FOCUS_VISIBLE: Widget has the visible focus
730 * @GTK_STATE_FLAG_FOCUS_WITHIN: Widget contains the keyboard focus
731 *
732 * Describes a widget state.
733 *
734 * Widget states are used to match the widget against CSS pseudo-classes.
735 * Note that GTK extends the regular CSS classes and sometimes uses
736 * different names.
737 */
738 typedef enum
739 {
740 GTK_STATE_FLAG_NORMAL = 0,
741 GTK_STATE_FLAG_ACTIVE = 1 << 0,
742 GTK_STATE_FLAG_PRELIGHT = 1 << 1,
743 GTK_STATE_FLAG_SELECTED = 1 << 2,
744 GTK_STATE_FLAG_INSENSITIVE = 1 << 3,
745 GTK_STATE_FLAG_INCONSISTENT = 1 << 4,
746 GTK_STATE_FLAG_FOCUSED = 1 << 5,
747 GTK_STATE_FLAG_BACKDROP = 1 << 6,
748 GTK_STATE_FLAG_DIR_LTR = 1 << 7,
749 GTK_STATE_FLAG_DIR_RTL = 1 << 8,
750 GTK_STATE_FLAG_LINK = 1 << 9,
751 GTK_STATE_FLAG_VISITED = 1 << 10,
752 GTK_STATE_FLAG_CHECKED = 1 << 11,
753 GTK_STATE_FLAG_DROP_ACTIVE = 1 << 12,
754 GTK_STATE_FLAG_FOCUS_VISIBLE = 1 << 13,
755 GTK_STATE_FLAG_FOCUS_WITHIN = 1 << 14
756 } GtkStateFlags;
757
758 /**
759 * GtkBorderStyle:
760 * @GTK_BORDER_STYLE_NONE: No visible border
761 * @GTK_BORDER_STYLE_HIDDEN: Same as %GTK_BORDER_STYLE_NONE
762 * @GTK_BORDER_STYLE_SOLID: A single line segment
763 * @GTK_BORDER_STYLE_INSET: Looks as if the content is sunken into the canvas
764 * @GTK_BORDER_STYLE_OUTSET: Looks as if the content is coming out of the canvas
765 * @GTK_BORDER_STYLE_DOTTED: A series of round dots
766 * @GTK_BORDER_STYLE_DASHED: A series of square-ended dashes
767 * @GTK_BORDER_STYLE_DOUBLE: Two parallel lines with some space between them
768 * @GTK_BORDER_STYLE_GROOVE: Looks as if it were carved in the canvas
769 * @GTK_BORDER_STYLE_RIDGE: Looks as if it were coming out of the canvas
770 *
771 * Describes how the border of a UI element should be rendered.
772 */
773 typedef enum {
774 GTK_BORDER_STYLE_NONE,
775 GTK_BORDER_STYLE_HIDDEN,
776 GTK_BORDER_STYLE_SOLID,
777 GTK_BORDER_STYLE_INSET,
778 GTK_BORDER_STYLE_OUTSET,
779 GTK_BORDER_STYLE_DOTTED,
780 GTK_BORDER_STYLE_DASHED,
781 GTK_BORDER_STYLE_DOUBLE,
782 GTK_BORDER_STYLE_GROOVE,
783 GTK_BORDER_STYLE_RIDGE
784 } GtkBorderStyle;
785
786 /**
787 * GtkLevelBarMode:
788 * @GTK_LEVEL_BAR_MODE_CONTINUOUS: the bar has a continuous mode
789 * @GTK_LEVEL_BAR_MODE_DISCRETE: the bar has a discrete mode
790 *
791 * Describes how `GtkLevelBar` contents should be rendered.
792 *
793 * Note that this enumeration could be extended with additional modes
794 * in the future.
795 */
796 typedef enum {
797 GTK_LEVEL_BAR_MODE_CONTINUOUS,
798 GTK_LEVEL_BAR_MODE_DISCRETE
799 } GtkLevelBarMode;
800
801 G_END_DECLS
802
803 /**
804 * GtkInputPurpose:
805 * @GTK_INPUT_PURPOSE_FREE_FORM: Allow any character
806 * @GTK_INPUT_PURPOSE_ALPHA: Allow only alphabetic characters
807 * @GTK_INPUT_PURPOSE_DIGITS: Allow only digits
808 * @GTK_INPUT_PURPOSE_NUMBER: Edited field expects numbers
809 * @GTK_INPUT_PURPOSE_PHONE: Edited field expects phone number
810 * @GTK_INPUT_PURPOSE_URL: Edited field expects URL
811 * @GTK_INPUT_PURPOSE_EMAIL: Edited field expects email address
812 * @GTK_INPUT_PURPOSE_NAME: Edited field expects the name of a person
813 * @GTK_INPUT_PURPOSE_PASSWORD: Like %GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden
814 * @GTK_INPUT_PURPOSE_PIN: Like %GTK_INPUT_PURPOSE_DIGITS, but characters are hidden
815 * @GTK_INPUT_PURPOSE_TERMINAL: Allow any character, in addition to control codes
816 *
817 * Describes primary purpose of the input widget.
818 *
819 * This information is useful for on-screen keyboards and similar input
820 * methods to decide which keys should be presented to the user.
821 *
822 * Note that the purpose is not meant to impose a totally strict rule
823 * about allowed characters, and does not replace input validation.
824 * It is fine for an on-screen keyboard to let the user override the
825 * character set restriction that is expressed by the purpose. The
826 * application is expected to validate the entry contents, even if
827 * it specified a purpose.
828 *
829 * The difference between %GTK_INPUT_PURPOSE_DIGITS and
830 * %GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits
831 * while the latter also some punctuation (like commas or points, plus,
832 * minus) and “e” or “E” as in 3.14E+000.
833 *
834 * This enumeration may be extended in the future; input methods should
835 * interpret unknown values as “free form”.
836 */
837 typedef enum
838 {
839 GTK_INPUT_PURPOSE_FREE_FORM,
840 GTK_INPUT_PURPOSE_ALPHA,
841 GTK_INPUT_PURPOSE_DIGITS,
842 GTK_INPUT_PURPOSE_NUMBER,
843 GTK_INPUT_PURPOSE_PHONE,
844 GTK_INPUT_PURPOSE_URL,
845 GTK_INPUT_PURPOSE_EMAIL,
846 GTK_INPUT_PURPOSE_NAME,
847 GTK_INPUT_PURPOSE_PASSWORD,
848 GTK_INPUT_PURPOSE_PIN,
849 GTK_INPUT_PURPOSE_TERMINAL,
850 } GtkInputPurpose;
851
852 /**
853 * GtkInputHints:
854 * @GTK_INPUT_HINT_NONE: No special behaviour suggested
855 * @GTK_INPUT_HINT_SPELLCHECK: Suggest checking for typos
856 * @GTK_INPUT_HINT_NO_SPELLCHECK: Suggest not checking for typos
857 * @GTK_INPUT_HINT_WORD_COMPLETION: Suggest word completion
858 * @GTK_INPUT_HINT_LOWERCASE: Suggest to convert all text to lowercase
859 * @GTK_INPUT_HINT_UPPERCASE_CHARS: Suggest to capitalize all text
860 * @GTK_INPUT_HINT_UPPERCASE_WORDS: Suggest to capitalize the first
861 * character of each word
862 * @GTK_INPUT_HINT_UPPERCASE_SENTENCES: Suggest to capitalize the
863 * first word of each sentence
864 * @GTK_INPUT_HINT_INHIBIT_OSK: Suggest to not show an onscreen keyboard
865 * (e.g for a calculator that already has all the keys).
866 * @GTK_INPUT_HINT_VERTICAL_WRITING: The text is vertical
867 * @GTK_INPUT_HINT_EMOJI: Suggest offering Emoji support
868 * @GTK_INPUT_HINT_NO_EMOJI: Suggest not offering Emoji support
869 * @GTK_INPUT_HINT_PRIVATE: Request that the input method should not
870 * update personalized data (like typing history)
871 *
872 * Describes hints that might be taken into account by input methods
873 * or applications.
874 *
875 * Note that input methods may already tailor their behaviour according
876 * to the `GtkInputPurpose` of the entry.
877 *
878 * Some common sense is expected when using these flags - mixing
879 * %GTK_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense.
880 *
881 * This enumeration may be extended in the future; input methods should
882 * ignore unknown values.
883 */
884 typedef enum
885 {
886 GTK_INPUT_HINT_NONE = 0,
887 GTK_INPUT_HINT_SPELLCHECK = 1 << 0,
888 GTK_INPUT_HINT_NO_SPELLCHECK = 1 << 1,
889 GTK_INPUT_HINT_WORD_COMPLETION = 1 << 2,
890 GTK_INPUT_HINT_LOWERCASE = 1 << 3,
891 GTK_INPUT_HINT_UPPERCASE_CHARS = 1 << 4,
892 GTK_INPUT_HINT_UPPERCASE_WORDS = 1 << 5,
893 GTK_INPUT_HINT_UPPERCASE_SENTENCES = 1 << 6,
894 GTK_INPUT_HINT_INHIBIT_OSK = 1 << 7,
895 GTK_INPUT_HINT_VERTICAL_WRITING = 1 << 8,
896 GTK_INPUT_HINT_EMOJI = 1 << 9,
897 GTK_INPUT_HINT_NO_EMOJI = 1 << 10,
898 GTK_INPUT_HINT_PRIVATE = 1 << 11,
899 } GtkInputHints;
900
901 /**
902 * GtkPropagationPhase:
903 * @GTK_PHASE_NONE: Events are not delivered.
904 * @GTK_PHASE_CAPTURE: Events are delivered in the capture phase. The
905 * capture phase happens before the bubble phase, runs from the toplevel down
906 * to the event widget. This option should only be used on containers that
907 * might possibly handle events before their children do.
908 * @GTK_PHASE_BUBBLE: Events are delivered in the bubble phase. The bubble
909 * phase happens after the capture phase, and before the default handlers
910 * are run. This phase runs from the event widget, up to the toplevel.
911 * @GTK_PHASE_TARGET: Events are delivered in the default widget event handlers,
912 * note that widget implementations must chain up on button, motion, touch and
913 * grab broken handlers for controllers in this phase to be run.
914 *
915 * Describes the stage at which events are fed into a `GtkEventController`.
916 */
917 typedef enum
918 {
919 GTK_PHASE_NONE,
920 GTK_PHASE_CAPTURE,
921 GTK_PHASE_BUBBLE,
922 GTK_PHASE_TARGET
923 } GtkPropagationPhase;
924
925 /**
926 * GtkPropagationLimit:
927 * @GTK_LIMIT_NONE: Events are handled regardless of what their
928 * target is.
929 * @GTK_LIMIT_SAME_NATIVE: Events are only handled if their target
930 * is in the same `GtkNative` as the event controllers widget. Note
931 * that some event types have two targets (origin and destination).
932 *
933 * Describes limits of a `GtkEventController` for handling events
934 * targeting other widgets.
935 */
936 typedef enum
937 {
938 GTK_LIMIT_NONE,
939 GTK_LIMIT_SAME_NATIVE
940 } GtkPropagationLimit;
941
942 /**
943 * GtkEventSequenceState:
944 * @GTK_EVENT_SEQUENCE_NONE: The sequence is handled, but not grabbed.
945 * @GTK_EVENT_SEQUENCE_CLAIMED: The sequence is handled and grabbed.
946 * @GTK_EVENT_SEQUENCE_DENIED: The sequence is denied.
947 *
948 * Describes the state of a `GdkEventSequence` in a `GtkGesture`.
949 */
950 typedef enum
951 {
952 GTK_EVENT_SEQUENCE_NONE,
953 GTK_EVENT_SEQUENCE_CLAIMED,
954 GTK_EVENT_SEQUENCE_DENIED
955 } GtkEventSequenceState;
956
957 /**
958 * GtkPanDirection:
959 * @GTK_PAN_DIRECTION_LEFT: panned towards the left
960 * @GTK_PAN_DIRECTION_RIGHT: panned towards the right
961 * @GTK_PAN_DIRECTION_UP: panned upwards
962 * @GTK_PAN_DIRECTION_DOWN: panned downwards
963 *
964 * Describes the panning direction of a `GtkGesturePan`
965 */
966 typedef enum
967 {
968 GTK_PAN_DIRECTION_LEFT,
969 GTK_PAN_DIRECTION_RIGHT,
970 GTK_PAN_DIRECTION_UP,
971 GTK_PAN_DIRECTION_DOWN
972 } GtkPanDirection;
973
974 /**
975 * GtkShortcutScope:
976 * @GTK_SHORTCUT_SCOPE_LOCAL: Shortcuts are handled inside
977 * the widget the controller belongs to.
978 * @GTK_SHORTCUT_SCOPE_MANAGED: Shortcuts are handled by
979 * the first ancestor that is a `GtkShortcutManager`
980 * @GTK_SHORTCUT_SCOPE_GLOBAL: Shortcuts are handled by
981 * the root widget.
982 *
983 * Describes where `GtkShortcut`s added to a
984 * `GtkShortcutController` get handled.
985 */
986 typedef enum
987 {
988 GTK_SHORTCUT_SCOPE_LOCAL,
989 GTK_SHORTCUT_SCOPE_MANAGED,
990 GTK_SHORTCUT_SCOPE_GLOBAL
991 } GtkShortcutScope;
992
993 /**
994 * GtkPickFlags:
995 * @GTK_PICK_DEFAULT: The default behavior, include widgets that are receiving events
996 * @GTK_PICK_INSENSITIVE: Include widgets that are insensitive
997 * @GTK_PICK_NON_TARGETABLE: Include widgets that are marked as non-targetable. See `GtkWidget:can-target`
998 *
999 * Flags that influence the behavior of gtk_widget_pick().
1000 */
1001 typedef enum {
1002 GTK_PICK_DEFAULT = 0,
1003 GTK_PICK_INSENSITIVE = 1 << 0,
1004 GTK_PICK_NON_TARGETABLE = 1 << 1
1005 } GtkPickFlags;
1006
1007 /**
1008 * GtkConstraintRelation:
1009 * @GTK_CONSTRAINT_RELATION_EQ: Equal
1010 * @GTK_CONSTRAINT_RELATION_LE: Less than, or equal
1011 * @GTK_CONSTRAINT_RELATION_GE: Greater than, or equal
1012 *
1013 * The relation between two terms of a constraint.
1014 */
1015 typedef enum {
1016 GTK_CONSTRAINT_RELATION_LE = -1,
1017 GTK_CONSTRAINT_RELATION_EQ = 0,
1018 GTK_CONSTRAINT_RELATION_GE = 1
1019 } GtkConstraintRelation;
1020
1021 /**
1022 * GtkConstraintStrength:
1023 * @GTK_CONSTRAINT_STRENGTH_REQUIRED: The constraint is required towards solving the layout
1024 * @GTK_CONSTRAINT_STRENGTH_STRONG: A strong constraint
1025 * @GTK_CONSTRAINT_STRENGTH_MEDIUM: A medium constraint
1026 * @GTK_CONSTRAINT_STRENGTH_WEAK: A weak constraint
1027 *
1028 * The strength of a constraint, expressed as a symbolic constant.
1029 *
1030 * The strength of a `GtkConstraint` can be expressed with any positive
1031 * integer; the values of this enumeration can be used for readability.
1032 */
1033 typedef enum {
1034 GTK_CONSTRAINT_STRENGTH_REQUIRED = 1001001000,
1035 GTK_CONSTRAINT_STRENGTH_STRONG = 1000000000,
1036 GTK_CONSTRAINT_STRENGTH_MEDIUM = 1000,
1037 GTK_CONSTRAINT_STRENGTH_WEAK = 1
1038 } GtkConstraintStrength;
1039
1040 /**
1041 * GtkConstraintAttribute:
1042 * @GTK_CONSTRAINT_ATTRIBUTE_NONE: No attribute, used for constant
1043 * relations
1044 * @GTK_CONSTRAINT_ATTRIBUTE_LEFT: The left edge of a widget, regardless of
1045 * text direction
1046 * @GTK_CONSTRAINT_ATTRIBUTE_RIGHT: The right edge of a widget, regardless
1047 * of text direction
1048 * @GTK_CONSTRAINT_ATTRIBUTE_TOP: The top edge of a widget
1049 * @GTK_CONSTRAINT_ATTRIBUTE_BOTTOM: The bottom edge of a widget
1050 * @GTK_CONSTRAINT_ATTRIBUTE_START: The leading edge of a widget, depending
1051 * on text direction; equivalent to %GTK_CONSTRAINT_ATTRIBUTE_LEFT for LTR
1052 * languages, and %GTK_CONSTRAINT_ATTRIBUTE_RIGHT for RTL ones
1053 * @GTK_CONSTRAINT_ATTRIBUTE_END: The trailing edge of a widget, depending
1054 * on text direction; equivalent to %GTK_CONSTRAINT_ATTRIBUTE_RIGHT for LTR
1055 * languages, and %GTK_CONSTRAINT_ATTRIBUTE_LEFT for RTL ones
1056 * @GTK_CONSTRAINT_ATTRIBUTE_WIDTH: The width of a widget
1057 * @GTK_CONSTRAINT_ATTRIBUTE_HEIGHT: The height of a widget
1058 * @GTK_CONSTRAINT_ATTRIBUTE_CENTER_X: The center of a widget, on the
1059 * horizontal axis
1060 * @GTK_CONSTRAINT_ATTRIBUTE_CENTER_Y: The center of a widget, on the
1061 * vertical axis
1062 * @GTK_CONSTRAINT_ATTRIBUTE_BASELINE: The baseline of a widget
1063 *
1064 * The widget attributes that can be used when creating a `GtkConstraint`.
1065 */
1066 typedef enum {
1067 GTK_CONSTRAINT_ATTRIBUTE_NONE,
1068 GTK_CONSTRAINT_ATTRIBUTE_LEFT,
1069 GTK_CONSTRAINT_ATTRIBUTE_RIGHT,
1070 GTK_CONSTRAINT_ATTRIBUTE_TOP,
1071 GTK_CONSTRAINT_ATTRIBUTE_BOTTOM,
1072 GTK_CONSTRAINT_ATTRIBUTE_START,
1073 GTK_CONSTRAINT_ATTRIBUTE_END,
1074 GTK_CONSTRAINT_ATTRIBUTE_WIDTH,
1075 GTK_CONSTRAINT_ATTRIBUTE_HEIGHT,
1076 GTK_CONSTRAINT_ATTRIBUTE_CENTER_X,
1077 GTK_CONSTRAINT_ATTRIBUTE_CENTER_Y,
1078 GTK_CONSTRAINT_ATTRIBUTE_BASELINE
1079 } GtkConstraintAttribute;
1080
1081 /**
1082 * GtkConstraintVflParserError:
1083 * @GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_SYMBOL: Invalid or unknown symbol
1084 * @GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_ATTRIBUTE: Invalid or unknown attribute
1085 * @GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_VIEW: Invalid or unknown view
1086 * @GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_METRIC: Invalid or unknown metric
1087 * @GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_PRIORITY: Invalid or unknown priority
1088 * @GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_RELATION: Invalid or unknown relation
1089 *
1090 * Domain for VFL parsing errors.
1091 */
1092 typedef enum {
1093 GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_SYMBOL,
1094 GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_ATTRIBUTE,
1095 GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_VIEW,
1096 GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_METRIC,
1097 GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_PRIORITY,
1098 GTK_CONSTRAINT_VFL_PARSER_ERROR_INVALID_RELATION
1099 } GtkConstraintVflParserError;
1100
1101 /**
1102 * GtkSystemSetting:
1103 * @GTK_SYSTEM_SETTING_DPI: the [property@Gtk.Settings:gtk-xft-dpi] setting has changed
1104 * @GTK_SYSTEM_SETTING_FONT_NAME: The [property@Gtk.Settings:gtk-font-name] setting has changed
1105 * @GTK_SYSTEM_SETTING_FONT_CONFIG: The font configuration has changed in a way that
1106 * requires text to be redrawn. This can be any of the
1107 * [property@Gtk.Settings:gtk-xft-antialias],
1108 * [property@Gtk.Settings:gtk-xft-hinting],
1109 * [property@Gtk.Settings:gtk-xft-hintstyle],
1110 * [property@Gtk.Settings:gtk-xft-rgba] or
1111 * [property@Gtk.Settings:gtk-fontconfig-timestamp] settings
1112 * @GTK_SYSTEM_SETTING_DISPLAY: The display has changed
1113 * @GTK_SYSTEM_SETTING_ICON_THEME: The icon theme has changed in a way that requires
1114 * icons to be looked up again
1115 *
1116 * Values that can be passed to the [vfunc@Gtk.Widget.system_setting_changed]
1117 * vfunc.
1118 *
1119 * The values indicate which system setting has changed.
1120 * Widgets may need to drop caches, or react otherwise.
1121 *
1122 * Most of the values correspond to `GtkSettings` properties.
1123 *
1124 * More values may be added over time.
1125 */
1126 typedef enum {
1127 GTK_SYSTEM_SETTING_DPI,
1128 GTK_SYSTEM_SETTING_FONT_NAME,
1129 GTK_SYSTEM_SETTING_FONT_CONFIG,
1130 GTK_SYSTEM_SETTING_DISPLAY,
1131 GTK_SYSTEM_SETTING_ICON_THEME
1132 } GtkSystemSetting;
1133
1134 /**
1135 * GtkAccessibleRole:
1136 * @GTK_ACCESSIBLE_ROLE_ALERT: An element with important, and usually
1137 * time-sensitive, information
1138 * @GTK_ACCESSIBLE_ROLE_ALERT_DIALOG: A type of dialog that contains an
1139 * alert message
1140 * @GTK_ACCESSIBLE_ROLE_BANNER: Unused
1141 * @GTK_ACCESSIBLE_ROLE_BUTTON: An input element that allows for
1142 * user-triggered actions when clicked or pressed
1143 * @GTK_ACCESSIBLE_ROLE_CAPTION: Unused
1144 * @GTK_ACCESSIBLE_ROLE_CELL: Unused
1145 * @GTK_ACCESSIBLE_ROLE_CHECKBOX: A checkable input element that has
1146 * three possible values: `true`, `false`, or `mixed`
1147 * @GTK_ACCESSIBLE_ROLE_COLUMN_HEADER: A header in a columned list.
1148 * @GTK_ACCESSIBLE_ROLE_COMBO_BOX: An input that controls another element,
1149 * such as a list or a grid, that can dynamically pop up to help the user
1150 * set the value of the input
1151 * @GTK_ACCESSIBLE_ROLE_COMMAND: Abstract role.
1152 * @GTK_ACCESSIBLE_ROLE_COMPOSITE: Abstract role.
1153 * @GTK_ACCESSIBLE_ROLE_DIALOG: A dialog is a window that is designed to interrupt
1154 * the current processing of an application in order to prompt the user to enter
1155 * information or require a response.
1156 * @GTK_ACCESSIBLE_ROLE_DOCUMENT: Unused
1157 * @GTK_ACCESSIBLE_ROLE_FEED: Unused
1158 * @GTK_ACCESSIBLE_ROLE_FORM: Unused
1159 * @GTK_ACCESSIBLE_ROLE_GENERIC: Unused
1160 * @GTK_ACCESSIBLE_ROLE_GRID: A grid of items.
1161 * @GTK_ACCESSIBLE_ROLE_GRID_CELL: An item in a grid or tree grid.
1162 * @GTK_ACCESSIBLE_ROLE_GROUP: An element that groups multiple widgets. GTK uses
1163 * this role for various containers, like `GtkBox`, `GtkViewport`, and `GtkHeaderBar`.
1164 * @GTK_ACCESSIBLE_ROLE_HEADING: Unused
1165 * @GTK_ACCESSIBLE_ROLE_IMG: An image.
1166 * @GTK_ACCESSIBLE_ROLE_INPUT: Abstract role.
1167 * @GTK_ACCESSIBLE_ROLE_LABEL: A visible name or caption for a user interface component.
1168 * @GTK_ACCESSIBLE_ROLE_LANDMARK: Abstract role.
1169 * @GTK_ACCESSIBLE_ROLE_LEGEND: Unused
1170 * @GTK_ACCESSIBLE_ROLE_LINK: A clickable link.
1171 * @GTK_ACCESSIBLE_ROLE_LIST: A list of items.
1172 * @GTK_ACCESSIBLE_ROLE_LIST_BOX: Unused.
1173 * @GTK_ACCESSIBLE_ROLE_LIST_ITEM: An item in a list.
1174 * @GTK_ACCESSIBLE_ROLE_LOG: Unused
1175 * @GTK_ACCESSIBLE_ROLE_MAIN: Unused
1176 * @GTK_ACCESSIBLE_ROLE_MARQUEE: Unused
1177 * @GTK_ACCESSIBLE_ROLE_MATH: Unused
1178 * @GTK_ACCESSIBLE_ROLE_METER: An element that represents a value within a known range.
1179 * @GTK_ACCESSIBLE_ROLE_MENU: A menu.
1180 * @GTK_ACCESSIBLE_ROLE_MENU_BAR: A menubar.
1181 * @GTK_ACCESSIBLE_ROLE_MENU_ITEM: An item in a menu.
1182 * @GTK_ACCESSIBLE_ROLE_MENU_ITEM_CHECKBOX: A check item in a menu.
1183 * @GTK_ACCESSIBLE_ROLE_MENU_ITEM_RADIO: A radio item in a menu.
1184 * @GTK_ACCESSIBLE_ROLE_NAVIGATION: Unused
1185 * @GTK_ACCESSIBLE_ROLE_NONE: An element that is not represented to accessibility technologies.
1186 * @GTK_ACCESSIBLE_ROLE_NOTE: Unused
1187 * @GTK_ACCESSIBLE_ROLE_OPTION: Unused
1188 * @GTK_ACCESSIBLE_ROLE_PRESENTATION: An element that is not represented to accessibility technologies.
1189 * @GTK_ACCESSIBLE_ROLE_PROGRESS_BAR: An element that displays the progress
1190 * status for tasks that take a long time.
1191 * @GTK_ACCESSIBLE_ROLE_RADIO: A checkable input in a group of radio roles,
1192 * only one of which can be checked at a time.
1193 * @GTK_ACCESSIBLE_ROLE_RADIO_GROUP: Unused
1194 * @GTK_ACCESSIBLE_ROLE_RANGE: Abstract role.
1195 * @GTK_ACCESSIBLE_ROLE_REGION: Unused
1196 * @GTK_ACCESSIBLE_ROLE_ROW: A row in a columned list.
1197 * @GTK_ACCESSIBLE_ROLE_ROW_GROUP: Unused
1198 * @GTK_ACCESSIBLE_ROLE_ROW_HEADER: Unused
1199 * @GTK_ACCESSIBLE_ROLE_SCROLLBAR: A graphical object that controls the scrolling
1200 * of content within a viewing area, regardless of whether the content is fully
1201 * displayed within the viewing area.
1202 * @GTK_ACCESSIBLE_ROLE_SEARCH: Unused
1203 * @GTK_ACCESSIBLE_ROLE_SEARCH_BOX: A type of textbox intended for specifying
1204 * search criteria.
1205 * @GTK_ACCESSIBLE_ROLE_SECTION: Abstract role.
1206 * @GTK_ACCESSIBLE_ROLE_SECTION_HEAD: Abstract role.
1207 * @GTK_ACCESSIBLE_ROLE_SELECT: Abstract role.
1208 * @GTK_ACCESSIBLE_ROLE_SEPARATOR: A divider that separates and distinguishes
1209 * sections of content or groups of menuitems.
1210 * @GTK_ACCESSIBLE_ROLE_SLIDER: A user input where the user selects a value
1211 * from within a given range.
1212 * @GTK_ACCESSIBLE_ROLE_SPIN_BUTTON: A form of range that expects the user to
1213 * select from among discrete choices.
1214 * @GTK_ACCESSIBLE_ROLE_STATUS: Unused
1215 * @GTK_ACCESSIBLE_ROLE_STRUCTURE: Abstract role.
1216 * @GTK_ACCESSIBLE_ROLE_SWITCH: A type of checkbox that represents on/off values,
1217 * as opposed to checked/unchecked values.
1218 * @GTK_ACCESSIBLE_ROLE_TAB: An item in a list of tab used for switching pages.
1219 * @GTK_ACCESSIBLE_ROLE_TABLE: Unused
1220 * @GTK_ACCESSIBLE_ROLE_TAB_LIST: A list of tabs for switching pages.
1221 * @GTK_ACCESSIBLE_ROLE_TAB_PANEL: A page in a notebook or stack.
1222 * @GTK_ACCESSIBLE_ROLE_TEXT_BOX: A type of input that allows free-form text
1223 * as its value.
1224 * @GTK_ACCESSIBLE_ROLE_TIME: Unused
1225 * @GTK_ACCESSIBLE_ROLE_TIMER: Unused
1226 * @GTK_ACCESSIBLE_ROLE_TOOLBAR: Unused
1227 * @GTK_ACCESSIBLE_ROLE_TOOLTIP: Unused
1228 * @GTK_ACCESSIBLE_ROLE_TREE: Unused
1229 * @GTK_ACCESSIBLE_ROLE_TREE_GRID: A treeview-like, columned list.
1230 * @GTK_ACCESSIBLE_ROLE_TREE_ITEM: Unused
1231 * @GTK_ACCESSIBLE_ROLE_WIDGET: An interactive component of a graphical user
1232 * interface. This is the role that GTK uses by default for widgets.
1233 * @GTK_ACCESSIBLE_ROLE_WINDOW: An application window.
1234 *
1235 * The accessible role for a `GtkAccessible` implementation.
1236 *
1237 * Abstract roles are only used as part of the ontology; application
1238 * developers must not use abstract roles in their code.
1239 */
1240 typedef enum {
1241 GTK_ACCESSIBLE_ROLE_ALERT,
1242 GTK_ACCESSIBLE_ROLE_ALERT_DIALOG,
1243 GTK_ACCESSIBLE_ROLE_BANNER,
1244 GTK_ACCESSIBLE_ROLE_BUTTON,
1245 GTK_ACCESSIBLE_ROLE_CAPTION,
1246 GTK_ACCESSIBLE_ROLE_CELL,
1247 GTK_ACCESSIBLE_ROLE_CHECKBOX,
1248 GTK_ACCESSIBLE_ROLE_COLUMN_HEADER,
1249 GTK_ACCESSIBLE_ROLE_COMBO_BOX,
1250 GTK_ACCESSIBLE_ROLE_COMMAND,
1251 GTK_ACCESSIBLE_ROLE_COMPOSITE,
1252 GTK_ACCESSIBLE_ROLE_DIALOG,
1253 GTK_ACCESSIBLE_ROLE_DOCUMENT,
1254 GTK_ACCESSIBLE_ROLE_FEED,
1255 GTK_ACCESSIBLE_ROLE_FORM,
1256 GTK_ACCESSIBLE_ROLE_GENERIC,
1257 GTK_ACCESSIBLE_ROLE_GRID,
1258 GTK_ACCESSIBLE_ROLE_GRID_CELL,
1259 GTK_ACCESSIBLE_ROLE_GROUP,
1260 GTK_ACCESSIBLE_ROLE_HEADING,
1261 GTK_ACCESSIBLE_ROLE_IMG,
1262 GTK_ACCESSIBLE_ROLE_INPUT,
1263 GTK_ACCESSIBLE_ROLE_LABEL,
1264 GTK_ACCESSIBLE_ROLE_LANDMARK,
1265 GTK_ACCESSIBLE_ROLE_LEGEND,
1266 GTK_ACCESSIBLE_ROLE_LINK,
1267 GTK_ACCESSIBLE_ROLE_LIST,
1268 GTK_ACCESSIBLE_ROLE_LIST_BOX,
1269 GTK_ACCESSIBLE_ROLE_LIST_ITEM,
1270 GTK_ACCESSIBLE_ROLE_LOG,
1271 GTK_ACCESSIBLE_ROLE_MAIN,
1272 GTK_ACCESSIBLE_ROLE_MARQUEE,
1273 GTK_ACCESSIBLE_ROLE_MATH,
1274 GTK_ACCESSIBLE_ROLE_METER,
1275 GTK_ACCESSIBLE_ROLE_MENU,
1276 GTK_ACCESSIBLE_ROLE_MENU_BAR,
1277 GTK_ACCESSIBLE_ROLE_MENU_ITEM,
1278 GTK_ACCESSIBLE_ROLE_MENU_ITEM_CHECKBOX,
1279 GTK_ACCESSIBLE_ROLE_MENU_ITEM_RADIO,
1280 GTK_ACCESSIBLE_ROLE_NAVIGATION,
1281 GTK_ACCESSIBLE_ROLE_NONE,
1282 GTK_ACCESSIBLE_ROLE_NOTE,
1283 GTK_ACCESSIBLE_ROLE_OPTION,
1284 GTK_ACCESSIBLE_ROLE_PRESENTATION,
1285 GTK_ACCESSIBLE_ROLE_PROGRESS_BAR,
1286 GTK_ACCESSIBLE_ROLE_RADIO,
1287 GTK_ACCESSIBLE_ROLE_RADIO_GROUP,
1288 GTK_ACCESSIBLE_ROLE_RANGE,
1289 GTK_ACCESSIBLE_ROLE_REGION,
1290 GTK_ACCESSIBLE_ROLE_ROW,
1291 GTK_ACCESSIBLE_ROLE_ROW_GROUP,
1292 GTK_ACCESSIBLE_ROLE_ROW_HEADER,
1293 GTK_ACCESSIBLE_ROLE_SCROLLBAR,
1294 GTK_ACCESSIBLE_ROLE_SEARCH,
1295 GTK_ACCESSIBLE_ROLE_SEARCH_BOX,
1296 GTK_ACCESSIBLE_ROLE_SECTION,
1297 GTK_ACCESSIBLE_ROLE_SECTION_HEAD,
1298 GTK_ACCESSIBLE_ROLE_SELECT,
1299 GTK_ACCESSIBLE_ROLE_SEPARATOR,
1300 GTK_ACCESSIBLE_ROLE_SLIDER,
1301 GTK_ACCESSIBLE_ROLE_SPIN_BUTTON,
1302 GTK_ACCESSIBLE_ROLE_STATUS,
1303 GTK_ACCESSIBLE_ROLE_STRUCTURE,
1304 GTK_ACCESSIBLE_ROLE_SWITCH,
1305 GTK_ACCESSIBLE_ROLE_TAB,
1306 GTK_ACCESSIBLE_ROLE_TABLE,
1307 GTK_ACCESSIBLE_ROLE_TAB_LIST,
1308 GTK_ACCESSIBLE_ROLE_TAB_PANEL,
1309 GTK_ACCESSIBLE_ROLE_TEXT_BOX,
1310 GTK_ACCESSIBLE_ROLE_TIME,
1311 GTK_ACCESSIBLE_ROLE_TIMER,
1312 GTK_ACCESSIBLE_ROLE_TOOLBAR,
1313 GTK_ACCESSIBLE_ROLE_TOOLTIP,
1314 GTK_ACCESSIBLE_ROLE_TREE,
1315 GTK_ACCESSIBLE_ROLE_TREE_GRID,
1316 GTK_ACCESSIBLE_ROLE_TREE_ITEM,
1317 GTK_ACCESSIBLE_ROLE_WIDGET,
1318 GTK_ACCESSIBLE_ROLE_WINDOW
1319 } GtkAccessibleRole;
1320
1321 /**
1322 * GtkAccessibleState:
1323 * @GTK_ACCESSIBLE_STATE_BUSY: A “busy” state. This state has boolean values
1324 * @GTK_ACCESSIBLE_STATE_CHECKED: A “checked” state; indicates the current
1325 * state of a `GtkCheckButton`. Value type: `GtkAccessibleTristate`
1326 * @GTK_ACCESSIBLE_STATE_DISABLED: A “disabled” state; corresponds to the
1327 * `GtkWidget:sensitive` property on `GtkWidget`. It indicates a UI element
1328 * that is perceivable, but not editable or operable. Value type: boolean
1329 * @GTK_ACCESSIBLE_STATE_EXPANDED: An “expanded” state; corresponds to the
1330 * `GtkExpander:expanded` property on `GtkExpander`. Value type: boolean
1331 * or undefined
1332 * @GTK_ACCESSIBLE_STATE_HIDDEN: A “hidden” state; corresponds to the
1333 * `GtkWidget:visible` property on `GtkWidget`. You can use this state
1334 * explicitly on UI elements that should not be exposed to an assistive
1335 * technology. Value type: boolean
1336 * See also: %GTK_ACCESSIBLE_STATE_DISABLED
1337 * @GTK_ACCESSIBLE_STATE_INVALID: An “invalid” state; set when a widget
1338 * is showing an error. Value type: `GtkAccessibleInvalidState`
1339 * @GTK_ACCESSIBLE_STATE_PRESSED: A “pressed” state; indicates the current
1340 * state of a `GtkToggleButton`. Value type: `GtkAccessibleTristate`
1341 * enumeration
1342 * @GTK_ACCESSIBLE_STATE_SELECTED: A “selected” state; set when a widget
1343 * is selected. Value type: boolean or undefined
1344 *
1345 * The possible accessible states of a `GtkAccessible`.
1346 */
1347 typedef enum {
1348 GTK_ACCESSIBLE_STATE_BUSY,
1349 GTK_ACCESSIBLE_STATE_CHECKED,
1350 GTK_ACCESSIBLE_STATE_DISABLED,
1351 GTK_ACCESSIBLE_STATE_EXPANDED,
1352 GTK_ACCESSIBLE_STATE_HIDDEN,
1353 GTK_ACCESSIBLE_STATE_INVALID,
1354 GTK_ACCESSIBLE_STATE_PRESSED,
1355 GTK_ACCESSIBLE_STATE_SELECTED
1356 } GtkAccessibleState;
1357
1358 /**
1359 * GTK_ACCESSIBLE_VALUE_UNDEFINED:
1360 *
1361 * An undefined value. The accessible attribute is either unset, or its
1362 * value is undefined.
1363 */
1364 #define GTK_ACCESSIBLE_VALUE_UNDEFINED (-1)
1365
1366 /**
1367 * GtkAccessibleProperty:
1368 * @GTK_ACCESSIBLE_PROPERTY_AUTOCOMPLETE: Indicates whether inputting text
1369 * could trigger display of one or more predictions of the user's intended
1370 * value for a combobox, searchbox, or textbox and specifies how predictions
1371 * would be presented if they were made. Value type: `GtkAccessibleAutocomplete`
1372 * @GTK_ACCESSIBLE_PROPERTY_DESCRIPTION: Defines a string value that describes
1373 * or annotates the current element. Value type: string
1374 * @GTK_ACCESSIBLE_PROPERTY_HAS_POPUP: Indicates the availability and type of
1375 * interactive popup element, such as menu or dialog, that can be triggered
1376 * by an element.
1377 * @GTK_ACCESSIBLE_PROPERTY_KEY_SHORTCUTS: Indicates keyboard shortcuts that an
1378 * author has implemented to activate or give focus to an element. Value type:
1379 * string
1380 * @GTK_ACCESSIBLE_PROPERTY_LABEL: Defines a string value that labels the current
1381 * element. Value type: string
1382 * @GTK_ACCESSIBLE_PROPERTY_LEVEL: Defines the hierarchical level of an element
1383 * within a structure. Value type: integer
1384 * @GTK_ACCESSIBLE_PROPERTY_MODAL: Indicates whether an element is modal when
1385 * displayed. Value type: boolean
1386 * @GTK_ACCESSIBLE_PROPERTY_MULTI_LINE: Indicates whether a text box accepts
1387 * multiple lines of input or only a single line. Value type: boolean
1388 * @GTK_ACCESSIBLE_PROPERTY_MULTI_SELECTABLE: Indicates that the user may select
1389 * more than one item from the current selectable descendants. Value type:
1390 * boolean
1391 * @GTK_ACCESSIBLE_PROPERTY_ORIENTATION: Indicates whether the element's
1392 * orientation is horizontal, vertical, or unknown/ambiguous. Value type:
1393 * `GtkOrientation`
1394 * @GTK_ACCESSIBLE_PROPERTY_PLACEHOLDER: Defines a short hint (a word or short
1395 * phrase) intended to aid the user with data entry when the control has no
1396 * value. A hint could be a sample value or a brief description of the expected
1397 * format. Value type: string
1398 * @GTK_ACCESSIBLE_PROPERTY_READ_ONLY: Indicates that the element is not editable,
1399 * but is otherwise operable. Value type: boolean
1400 * @GTK_ACCESSIBLE_PROPERTY_REQUIRED: Indicates that user input is required on
1401 * the element before a form may be submitted. Value type: boolean
1402 * @GTK_ACCESSIBLE_PROPERTY_ROLE_DESCRIPTION: Defines a human-readable,
1403 * author-localized description for the role of an element. Value type: string
1404 * @GTK_ACCESSIBLE_PROPERTY_SORT: Indicates if items in a table or grid are
1405 * sorted in ascending or descending order. Possible property values are in
1406 * the `GtkAccessibleSort` enumeration. Value type: `GtkAccessibleSort`
1407 * @GTK_ACCESSIBLE_PROPERTY_VALUE_MAX: Defines the maximum allowed value for a
1408 * range widget. Value type: double
1409 * @GTK_ACCESSIBLE_PROPERTY_VALUE_MIN: Defines the minimum allowed value for a
1410 * range widget. Value type: double
1411 * @GTK_ACCESSIBLE_PROPERTY_VALUE_NOW: Defines the current value for a range widget.
1412 * Value type: double
1413 * @GTK_ACCESSIBLE_PROPERTY_VALUE_TEXT: Defines the human readable text alternative
1414 * of aria-valuenow for a range widget. Value type: string
1415 *
1416 * The possible accessible properties of a `GtkAccessible`.
1417 */
1418 typedef enum {
1419 GTK_ACCESSIBLE_PROPERTY_AUTOCOMPLETE,
1420 GTK_ACCESSIBLE_PROPERTY_DESCRIPTION,
1421 GTK_ACCESSIBLE_PROPERTY_HAS_POPUP,
1422 GTK_ACCESSIBLE_PROPERTY_KEY_SHORTCUTS,
1423 GTK_ACCESSIBLE_PROPERTY_LABEL,
1424 GTK_ACCESSIBLE_PROPERTY_LEVEL,
1425 GTK_ACCESSIBLE_PROPERTY_MODAL,
1426 GTK_ACCESSIBLE_PROPERTY_MULTI_LINE,
1427 GTK_ACCESSIBLE_PROPERTY_MULTI_SELECTABLE,
1428 GTK_ACCESSIBLE_PROPERTY_ORIENTATION,
1429 GTK_ACCESSIBLE_PROPERTY_PLACEHOLDER,
1430 GTK_ACCESSIBLE_PROPERTY_READ_ONLY,
1431 GTK_ACCESSIBLE_PROPERTY_REQUIRED,
1432 GTK_ACCESSIBLE_PROPERTY_ROLE_DESCRIPTION,
1433 GTK_ACCESSIBLE_PROPERTY_SORT,
1434 GTK_ACCESSIBLE_PROPERTY_VALUE_MAX,
1435 GTK_ACCESSIBLE_PROPERTY_VALUE_MIN,
1436 GTK_ACCESSIBLE_PROPERTY_VALUE_NOW,
1437 GTK_ACCESSIBLE_PROPERTY_VALUE_TEXT
1438 } GtkAccessibleProperty;
1439
1440 /**
1441 * GtkAccessibleRelation:
1442 * @GTK_ACCESSIBLE_RELATION_ACTIVE_DESCENDANT: Identifies the currently active
1443 * element when focus is on a composite widget, combobox, textbox, group,
1444 * or application. Value type: reference
1445 * @GTK_ACCESSIBLE_RELATION_COL_COUNT: Defines the total number of columns
1446 * in a table, grid, or treegrid. Value type: integer
1447 * @GTK_ACCESSIBLE_RELATION_COL_INDEX: Defines an element's column index or
1448 * position with respect to the total number of columns within a table,
1449 * grid, or treegrid. Value type: integer
1450 * @GTK_ACCESSIBLE_RELATION_COL_INDEX_TEXT: Defines a human readable text
1451 * alternative of %GTK_ACCESSIBLE_RELATION_COL_INDEX. Value type: string
1452 * @GTK_ACCESSIBLE_RELATION_COL_SPAN: Defines the number of columns spanned
1453 * by a cell or gridcell within a table, grid, or treegrid. Value type: integer
1454 * @GTK_ACCESSIBLE_RELATION_CONTROLS: Identifies the element (or elements) whose
1455 * contents or presence are controlled by the current element. Value type: reference
1456 * @GTK_ACCESSIBLE_RELATION_DESCRIBED_BY: Identifies the element (or elements)
1457 * that describes the object. Value type: reference
1458 * @GTK_ACCESSIBLE_RELATION_DETAILS: Identifies the element (or elements) that
1459 * provide additional information related to the object. Value type: reference
1460 * @GTK_ACCESSIBLE_RELATION_ERROR_MESSAGE: Identifies the element that provides
1461 * an error message for an object. Value type: reference
1462 * @GTK_ACCESSIBLE_RELATION_FLOW_TO: Identifies the next element (or elements)
1463 * in an alternate reading order of content which, at the user's discretion,
1464 * allows assistive technology to override the general default of reading in
1465 * document source order. Value type: reference
1466 * @GTK_ACCESSIBLE_RELATION_LABELLED_BY: Identifies the element (or elements)
1467 * that labels the current element. Value type: reference
1468 * @GTK_ACCESSIBLE_RELATION_OWNS: Identifies an element (or elements) in order
1469 * to define a visual, functional, or contextual parent/child relationship
1470 * between elements where the widget hierarchy cannot be used to represent
1471 * the relationship. Value type: reference
1472 * @GTK_ACCESSIBLE_RELATION_POS_IN_SET: Defines an element's number or position
1473 * in the current set of listitems or treeitems. Value type: integer
1474 * @GTK_ACCESSIBLE_RELATION_ROW_COUNT: Defines the total number of rows in a table,
1475 * grid, or treegrid. Value type: integer
1476 * @GTK_ACCESSIBLE_RELATION_ROW_INDEX: Defines an element's row index or position
1477 * with respect to the total number of rows within a table, grid, or treegrid.
1478 * Value type: integer
1479 * @GTK_ACCESSIBLE_RELATION_ROW_INDEX_TEXT: Defines a human readable text
1480 * alternative of aria-rowindex. Value type: string
1481 * @GTK_ACCESSIBLE_RELATION_ROW_SPAN: Defines the number of rows spanned by a
1482 * cell or gridcell within a table, grid, or treegrid. Value type: integer
1483 * @GTK_ACCESSIBLE_RELATION_SET_SIZE: Defines the number of items in the current
1484 * set of listitems or treeitems. Value type: integer
1485 *
1486 * The possible accessible relations of a `GtkAccessible`.
1487 *
1488 * Accessible relations can be references to other widgets,
1489 * integers or strings.
1490 */
1491 typedef enum {
1492 GTK_ACCESSIBLE_RELATION_ACTIVE_DESCENDANT,
1493 GTK_ACCESSIBLE_RELATION_COL_COUNT,
1494 GTK_ACCESSIBLE_RELATION_COL_INDEX,
1495 GTK_ACCESSIBLE_RELATION_COL_INDEX_TEXT,
1496 GTK_ACCESSIBLE_RELATION_COL_SPAN,
1497 GTK_ACCESSIBLE_RELATION_CONTROLS,
1498 GTK_ACCESSIBLE_RELATION_DESCRIBED_BY,
1499 GTK_ACCESSIBLE_RELATION_DETAILS,
1500 GTK_ACCESSIBLE_RELATION_ERROR_MESSAGE,
1501 GTK_ACCESSIBLE_RELATION_FLOW_TO,
1502 GTK_ACCESSIBLE_RELATION_LABELLED_BY,
1503 GTK_ACCESSIBLE_RELATION_OWNS,
1504 GTK_ACCESSIBLE_RELATION_POS_IN_SET,
1505 GTK_ACCESSIBLE_RELATION_ROW_COUNT,
1506 GTK_ACCESSIBLE_RELATION_ROW_INDEX,
1507 GTK_ACCESSIBLE_RELATION_ROW_INDEX_TEXT,
1508 GTK_ACCESSIBLE_RELATION_ROW_SPAN,
1509 GTK_ACCESSIBLE_RELATION_SET_SIZE
1510 } GtkAccessibleRelation;
1511
1512 /**
1513 * GtkAccessibleTristate:
1514 * @GTK_ACCESSIBLE_TRISTATE_FALSE: The state is `false`
1515 * @GTK_ACCESSIBLE_TRISTATE_TRUE: The state is `true`
1516 * @GTK_ACCESSIBLE_TRISTATE_MIXED: The state is `mixed`
1517 *
1518 * The possible values for the %GTK_ACCESSIBLE_STATE_PRESSED
1519 * accessible state.
1520 *
1521 * Note that the %GTK_ACCESSIBLE_TRISTATE_FALSE and
1522 * %GTK_ACCESSIBLE_TRISTATE_TRUE have the same values
1523 * as %FALSE and %TRUE.
1524 */
1525 typedef enum {
1526 GTK_ACCESSIBLE_TRISTATE_FALSE,
1527 GTK_ACCESSIBLE_TRISTATE_TRUE,
1528 GTK_ACCESSIBLE_TRISTATE_MIXED
1529 } GtkAccessibleTristate;
1530
1531 /**
1532 * GtkAccessibleInvalidState:
1533 * @GTK_ACCESSIBLE_INVALID_FALSE: There are no detected errors in the value
1534 * @GTK_ACCESSIBLE_INVALID_TRUE: The value entered by the user has failed validation
1535 * @GTK_ACCESSIBLE_INVALID_GRAMMAR: A grammatical error was detected
1536 * @GTK_ACCESSIBLE_INVALID_SPELLING: A spelling error was detected
1537 *
1538 * The possible values for the %GTK_ACCESSIBLE_STATE_INVALID
1539 * accessible state.
1540 *
1541 * Note that the %GTK_ACCESSIBLE_INVALID_FALSE and
1542 * %GTK_ACCESSIBLE_INVALID_TRUE have the same values
1543 * as %FALSE and %TRUE.
1544 */
1545 typedef enum { /*< prefix=GTK_ACCESSIBLE_INVALID >*/
1546 GTK_ACCESSIBLE_INVALID_FALSE,
1547 GTK_ACCESSIBLE_INVALID_TRUE,
1548 GTK_ACCESSIBLE_INVALID_GRAMMAR,
1549 GTK_ACCESSIBLE_INVALID_SPELLING,
1550 } GtkAccessibleInvalidState;
1551
1552 /**
1553 * GtkAccessibleAutocomplete:
1554 * @GTK_ACCESSIBLE_AUTOCOMPLETE_NONE: Automatic suggestions are not displayed.
1555 * @GTK_ACCESSIBLE_AUTOCOMPLETE_INLINE: When a user is providing input, text
1556 * suggesting one way to complete the provided input may be dynamically
1557 * inserted after the caret.
1558 * @GTK_ACCESSIBLE_AUTOCOMPLETE_LIST: When a user is providing input, an element
1559 * containing a collection of values that could complete the provided input
1560 * may be displayed.
1561 * @GTK_ACCESSIBLE_AUTOCOMPLETE_BOTH: When a user is providing input, an element
1562 * containing a collection of values that could complete the provided input
1563 * may be displayed. If displayed, one value in the collection is automatically
1564 * selected, and the text needed to complete the automatically selected value
1565 * appears after the caret in the input.
1566 *
1567 * The possible values for the %GTK_ACCESSIBLE_PROPERTY_AUTOCOMPLETE
1568 * accessible property.
1569 */
1570 typedef enum { /*< prefix=GTK_ACCESSIBLE_AUTOCOMPLETE >*/
1571 GTK_ACCESSIBLE_AUTOCOMPLETE_NONE,
1572 GTK_ACCESSIBLE_AUTOCOMPLETE_INLINE,
1573 GTK_ACCESSIBLE_AUTOCOMPLETE_LIST,
1574 GTK_ACCESSIBLE_AUTOCOMPLETE_BOTH
1575 } GtkAccessibleAutocomplete;
1576
1577 /**
1578 * GtkAccessibleSort:
1579 * @GTK_ACCESSIBLE_SORT_NONE: There is no defined sort applied to the column.
1580 * @GTK_ACCESSIBLE_SORT_ASCENDING: Items are sorted in ascending order by this column.
1581 * @GTK_ACCESSIBLE_SORT_DESCENDING: Items are sorted in descending order by this column.
1582 * @GTK_ACCESSIBLE_SORT_OTHER: A sort algorithm other than ascending or
1583 * descending has been applied.
1584 *
1585 * The possible values for the %GTK_ACCESSIBLE_PROPERTY_SORT
1586 * accessible property.
1587 */
1588 typedef enum { /*< prefix=GTK_ACCESSIBLE_SORT >*/
1589 GTK_ACCESSIBLE_SORT_NONE,
1590 GTK_ACCESSIBLE_SORT_ASCENDING,
1591 GTK_ACCESSIBLE_SORT_DESCENDING,
1592 GTK_ACCESSIBLE_SORT_OTHER
1593 } GtkAccessibleSort;
1594
1595 #endif /* __GTK_ENUMS_H__ */
1596