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 /**
36  * SECTION:gtkenums
37  * @Short_description: Public enumerated types used throughout GTK+
38  * @Title: Standard Enumerations
39  */
40 
41 
42 G_BEGIN_DECLS
43 
44 /**
45  * GtkAlign:
46  * @GTK_ALIGN_FILL: stretch to fill all space if possible, center if
47  *     no meaningful way to stretch
48  * @GTK_ALIGN_START: snap to left or top side, leaving space on right
49  *     or bottom
50  * @GTK_ALIGN_END: snap to right or bottom side, leaving space on left
51  *     or top
52  * @GTK_ALIGN_CENTER: center natural width of widget inside the
53  *     allocation
54  * @GTK_ALIGN_BASELINE: align the widget according to the baseline. Since 3.10.
55  *
56  * Controls how a widget deals with extra space in a single (x or y)
57  * dimension.
58  *
59  * Alignment only matters if the widget receives a “too large” allocation,
60  * for example if you packed the widget with the #GtkWidget:expand
61  * flag inside a #GtkBox, then the widget might get extra space.  If
62  * you have for example a 16x16 icon inside a 32x32 space, the icon
63  * could be scaled and stretched, it could be centered, or it could be
64  * positioned to one side of the space.
65  *
66  * Note that in horizontal context @GTK_ALIGN_START and @GTK_ALIGN_END
67  * are interpreted relative to text direction.
68  *
69  * GTK_ALIGN_BASELINE support for it is optional for containers and widgets, and
70  * it is only supported for vertical alignment.  When its not supported by
71  * a child or a container it is treated as @GTK_ALIGN_FILL.
72  */
73 typedef enum
74 {
75   GTK_ALIGN_FILL,
76   GTK_ALIGN_START,
77   GTK_ALIGN_END,
78   GTK_ALIGN_CENTER,
79   GTK_ALIGN_BASELINE
80 } GtkAlign;
81 
82 /**
83  * GtkArrowType:
84  * @GTK_ARROW_UP: Represents an upward pointing arrow.
85  * @GTK_ARROW_DOWN: Represents a downward pointing arrow.
86  * @GTK_ARROW_LEFT: Represents a left pointing arrow.
87  * @GTK_ARROW_RIGHT: Represents a right pointing arrow.
88  * @GTK_ARROW_NONE: No arrow. Since 2.10.
89  *
90  * Used to indicate the direction in which an arrow should point.
91  */
92 typedef enum
93 {
94   GTK_ARROW_UP,
95   GTK_ARROW_DOWN,
96   GTK_ARROW_LEFT,
97   GTK_ARROW_RIGHT,
98   GTK_ARROW_NONE
99 } GtkArrowType;
100 
101 /**
102  * GtkBaselinePosition:
103  * @GTK_BASELINE_POSITION_TOP: Align the baseline at the top
104  * @GTK_BASELINE_POSITION_CENTER: Center the baseline
105  * @GTK_BASELINE_POSITION_BOTTOM: Align the baseline at the bottom
106  *
107  * Whenever a container has some form of natural row it may align
108  * children in that row along a common typographical baseline. If
109  * the amount of verical space in the row is taller than the total
110  * requested height of the baseline-aligned children then it can use a
111  * #GtkBaselinePosition to select where to put the baseline inside the
112  * extra availible space.
113  *
114  * Since: 3.10
115  */
116 typedef enum
117 {
118   GTK_BASELINE_POSITION_TOP,
119   GTK_BASELINE_POSITION_CENTER,
120   GTK_BASELINE_POSITION_BOTTOM
121 } GtkBaselinePosition;
122 
123 /**
124  * GtkDeleteType:
125  * @GTK_DELETE_CHARS: Delete characters.
126  * @GTK_DELETE_WORD_ENDS: Delete only the portion of the word to the
127  *   left/right of cursor if we’re in the middle of a word.
128  * @GTK_DELETE_WORDS: Delete words.
129  * @GTK_DELETE_DISPLAY_LINES: Delete display-lines. Display-lines
130  *   refers to the visible lines, with respect to to the current line
131  *   breaks. As opposed to paragraphs, which are defined by line
132  *   breaks in the input.
133  * @GTK_DELETE_DISPLAY_LINE_ENDS: Delete only the portion of the
134  *   display-line to the left/right of cursor.
135  * @GTK_DELETE_PARAGRAPH_ENDS: Delete to the end of the
136  *   paragraph. Like C-k in Emacs (or its reverse).
137  * @GTK_DELETE_PARAGRAPHS: Delete entire line. Like C-k in pico.
138  * @GTK_DELETE_WHITESPACE: Delete only whitespace. Like M-\ in Emacs.
139  *
140  * See also: #GtkEntry::delete-from-cursor.
141  */
142 typedef enum
143 {
144   GTK_DELETE_CHARS,
145   GTK_DELETE_WORD_ENDS,
146   GTK_DELETE_WORDS,
147   GTK_DELETE_DISPLAY_LINES,
148   GTK_DELETE_DISPLAY_LINE_ENDS,
149   GTK_DELETE_PARAGRAPH_ENDS,
150   GTK_DELETE_PARAGRAPHS,
151   GTK_DELETE_WHITESPACE
152 } GtkDeleteType;
153 
154 /* Focus movement types */
155 /**
156  * GtkDirectionType:
157  * @GTK_DIR_TAB_FORWARD: Move forward.
158  * @GTK_DIR_TAB_BACKWARD: Move backward.
159  * @GTK_DIR_UP: Move up.
160  * @GTK_DIR_DOWN: Move down.
161  * @GTK_DIR_LEFT: Move left.
162  * @GTK_DIR_RIGHT: Move right.
163  *
164  * Focus movement types.
165  */
166 typedef enum
167 {
168   GTK_DIR_TAB_FORWARD,
169   GTK_DIR_TAB_BACKWARD,
170   GTK_DIR_UP,
171   GTK_DIR_DOWN,
172   GTK_DIR_LEFT,
173   GTK_DIR_RIGHT
174 } GtkDirectionType;
175 
176 /**
177  * GtkIconSize:
178  * @GTK_ICON_SIZE_INVALID: Invalid size.
179  * @GTK_ICON_SIZE_MENU: Size appropriate for menus (16px).
180  * @GTK_ICON_SIZE_SMALL_TOOLBAR: Size appropriate for small toolbars (16px).
181  * @GTK_ICON_SIZE_LARGE_TOOLBAR: Size appropriate for large toolbars (24px)
182  * @GTK_ICON_SIZE_BUTTON: Size appropriate for buttons (16px)
183  * @GTK_ICON_SIZE_DND: Size appropriate for drag and drop (32px)
184  * @GTK_ICON_SIZE_DIALOG: Size appropriate for dialogs (48px)
185  *
186  * Built-in stock icon sizes.
187  */
188 typedef enum
189 {
190   GTK_ICON_SIZE_INVALID,
191   GTK_ICON_SIZE_MENU,
192   GTK_ICON_SIZE_SMALL_TOOLBAR,
193   GTK_ICON_SIZE_LARGE_TOOLBAR,
194   GTK_ICON_SIZE_BUTTON,
195   GTK_ICON_SIZE_DND,
196   GTK_ICON_SIZE_DIALOG
197 } GtkIconSize;
198 
199 /**
200  * GtkSensitivityType:
201  * @GTK_SENSITIVITY_AUTO: The arrow is made insensitive if the
202  *   thumb is at the end
203  * @GTK_SENSITIVITY_ON: The arrow is always sensitive
204  * @GTK_SENSITIVITY_OFF: The arrow is always insensitive
205  *
206  * Determines how GTK+ handles the sensitivity of stepper arrows
207  * at the end of range widgets.
208  */
209 typedef enum
210 {
211   GTK_SENSITIVITY_AUTO,
212   GTK_SENSITIVITY_ON,
213   GTK_SENSITIVITY_OFF
214 } GtkSensitivityType;
215 
216 /* Reading directions for text */
217 /**
218  * GtkTextDirection:
219  * @GTK_TEXT_DIR_NONE: No direction.
220  * @GTK_TEXT_DIR_LTR: Left to right text direction.
221  * @GTK_TEXT_DIR_RTL: Right to left text direction.
222  *
223  * Reading directions for text.
224  */
225 typedef enum
226 {
227   GTK_TEXT_DIR_NONE,
228   GTK_TEXT_DIR_LTR,
229   GTK_TEXT_DIR_RTL
230 } GtkTextDirection;
231 
232 /**
233  * GtkJustification:
234  * @GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
235  * @GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
236  * @GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
237  * @GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
238  *
239  * Used for justifying the text inside a #GtkLabel widget. (See also
240  * #GtkAlignment).
241  */
242 typedef enum
243 {
244   GTK_JUSTIFY_LEFT,
245   GTK_JUSTIFY_RIGHT,
246   GTK_JUSTIFY_CENTER,
247   GTK_JUSTIFY_FILL
248 } GtkJustification;
249 
250 /**
251  * GtkMenuDirectionType:
252  * @GTK_MENU_DIR_PARENT: To the parent menu shell
253  * @GTK_MENU_DIR_CHILD: To the submenu, if any, associated with the item
254  * @GTK_MENU_DIR_NEXT: To the next menu item
255  * @GTK_MENU_DIR_PREV: To the previous menu item
256  *
257  * An enumeration representing directional movements within a menu.
258  */
259 typedef enum
260 {
261   GTK_MENU_DIR_PARENT,
262   GTK_MENU_DIR_CHILD,
263   GTK_MENU_DIR_NEXT,
264   GTK_MENU_DIR_PREV
265 } GtkMenuDirectionType;
266 
267 /**
268  * GtkMessageType:
269  * @GTK_MESSAGE_INFO: Informational message
270  * @GTK_MESSAGE_WARNING: Non-fatal warning message
271  * @GTK_MESSAGE_QUESTION: Question requiring a choice
272  * @GTK_MESSAGE_ERROR: Fatal error message
273  * @GTK_MESSAGE_OTHER: None of the above
274  *
275  * The type of message being displayed in the dialog.
276  */
277 typedef enum
278 {
279   GTK_MESSAGE_INFO,
280   GTK_MESSAGE_WARNING,
281   GTK_MESSAGE_QUESTION,
282   GTK_MESSAGE_ERROR,
283   GTK_MESSAGE_OTHER
284 } GtkMessageType;
285 
286 /**
287  * GtkMovementStep:
288  * @GTK_MOVEMENT_LOGICAL_POSITIONS: Move forward or back by graphemes
289  * @GTK_MOVEMENT_VISUAL_POSITIONS:  Move left or right by graphemes
290  * @GTK_MOVEMENT_WORDS:             Move forward or back by words
291  * @GTK_MOVEMENT_DISPLAY_LINES:     Move up or down lines (wrapped lines)
292  * @GTK_MOVEMENT_DISPLAY_LINE_ENDS: Move to either end of a line
293  * @GTK_MOVEMENT_PARAGRAPHS:        Move up or down paragraphs (newline-ended lines)
294  * @GTK_MOVEMENT_PARAGRAPH_ENDS:    Move to either end of a paragraph
295  * @GTK_MOVEMENT_PAGES:             Move by pages
296  * @GTK_MOVEMENT_BUFFER_ENDS:       Move to ends of the buffer
297  * @GTK_MOVEMENT_HORIZONTAL_PAGES:  Move horizontally by pages
298  */
299 typedef enum
300 {
301   GTK_MOVEMENT_LOGICAL_POSITIONS,
302   GTK_MOVEMENT_VISUAL_POSITIONS,
303   GTK_MOVEMENT_WORDS,
304   GTK_MOVEMENT_DISPLAY_LINES,
305   GTK_MOVEMENT_DISPLAY_LINE_ENDS,
306   GTK_MOVEMENT_PARAGRAPHS,
307   GTK_MOVEMENT_PARAGRAPH_ENDS,
308   GTK_MOVEMENT_PAGES,
309   GTK_MOVEMENT_BUFFER_ENDS,
310   GTK_MOVEMENT_HORIZONTAL_PAGES
311 } GtkMovementStep;
312 
313 /**
314  * GtkScrollStep:
315  * @GTK_SCROLL_STEPS: Scroll in steps.
316  * @GTK_SCROLL_PAGES: Scroll by pages.
317  * @GTK_SCROLL_ENDS: Scroll to ends.
318  * @GTK_SCROLL_HORIZONTAL_STEPS: Scroll in horizontal steps.
319  * @GTK_SCROLL_HORIZONTAL_PAGES: Scroll by horizontal pages.
320  * @GTK_SCROLL_HORIZONTAL_ENDS: Scroll to the horizontal ends.
321  */
322 typedef enum
323 {
324   GTK_SCROLL_STEPS,
325   GTK_SCROLL_PAGES,
326   GTK_SCROLL_ENDS,
327   GTK_SCROLL_HORIZONTAL_STEPS,
328   GTK_SCROLL_HORIZONTAL_PAGES,
329   GTK_SCROLL_HORIZONTAL_ENDS
330 } GtkScrollStep;
331 
332 /**
333  * GtkOrientation:
334  * @GTK_ORIENTATION_HORIZONTAL: The element is in horizontal orientation.
335  * @GTK_ORIENTATION_VERTICAL: The element is in vertical orientation.
336  *
337  * Represents the orientation of widgets and other objects which can be switched
338  * between horizontal and vertical orientation on the fly, like #GtkToolbar or
339  * #GtkGesturePan.
340  */
341 typedef enum
342 {
343   GTK_ORIENTATION_HORIZONTAL,
344   GTK_ORIENTATION_VERTICAL
345 } GtkOrientation;
346 
347 /**
348  * GtkPackType:
349  * @GTK_PACK_START: The child is packed into the start of the box
350  * @GTK_PACK_END: The child is packed into the end of the box
351  *
352  * Represents the packing location #GtkBox children. (See: #GtkVBox,
353  * #GtkHBox, and #GtkButtonBox).
354  */
355 typedef enum
356 {
357   GTK_PACK_START,
358   GTK_PACK_END
359 } GtkPackType;
360 
361 /**
362  * GtkPositionType:
363  * @GTK_POS_LEFT: The feature is at the left edge.
364  * @GTK_POS_RIGHT: The feature is at the right edge.
365  * @GTK_POS_TOP: The feature is at the top edge.
366  * @GTK_POS_BOTTOM: The feature is at the bottom edge.
367  *
368  * Describes which edge of a widget a certain feature is positioned at, e.g. the
369  * tabs of a #GtkNotebook, the handle of a #GtkHandleBox or the label of a
370  * #GtkScale.
371  */
372 typedef enum
373 {
374   GTK_POS_LEFT,
375   GTK_POS_RIGHT,
376   GTK_POS_TOP,
377   GTK_POS_BOTTOM
378 } GtkPositionType;
379 
380 /**
381  * GtkReliefStyle:
382  * @GTK_RELIEF_NORMAL: Draw a normal relief.
383  * @GTK_RELIEF_HALF: A half relief. Deprecated in 3.14, does the same as @GTK_RELIEF_NORMAL
384  * @GTK_RELIEF_NONE: No relief.
385  *
386  * Indicated the relief to be drawn around a #GtkButton.
387  */
388 typedef enum
389 {
390   GTK_RELIEF_NORMAL,
391   GTK_RELIEF_HALF,
392   GTK_RELIEF_NONE
393 } GtkReliefStyle;
394 
395 /**
396  * GtkScrollType:
397  * @GTK_SCROLL_NONE: No scrolling.
398  * @GTK_SCROLL_JUMP: Jump to new location.
399  * @GTK_SCROLL_STEP_BACKWARD: Step backward.
400  * @GTK_SCROLL_STEP_FORWARD: Step forward.
401  * @GTK_SCROLL_PAGE_BACKWARD: Page backward.
402  * @GTK_SCROLL_PAGE_FORWARD: Page forward.
403  * @GTK_SCROLL_STEP_UP: Step up.
404  * @GTK_SCROLL_STEP_DOWN: Step down.
405  * @GTK_SCROLL_PAGE_UP: Page up.
406  * @GTK_SCROLL_PAGE_DOWN: Page down.
407  * @GTK_SCROLL_STEP_LEFT: Step to the left.
408  * @GTK_SCROLL_STEP_RIGHT: Step to the right.
409  * @GTK_SCROLL_PAGE_LEFT: Page to the left.
410  * @GTK_SCROLL_PAGE_RIGHT: Page to the right.
411  * @GTK_SCROLL_START: Scroll to start.
412  * @GTK_SCROLL_END: Scroll to end.
413  *
414  * Scrolling types.
415  */
416 typedef enum
417 {
418   GTK_SCROLL_NONE,
419   GTK_SCROLL_JUMP,
420   GTK_SCROLL_STEP_BACKWARD,
421   GTK_SCROLL_STEP_FORWARD,
422   GTK_SCROLL_PAGE_BACKWARD,
423   GTK_SCROLL_PAGE_FORWARD,
424   GTK_SCROLL_STEP_UP,
425   GTK_SCROLL_STEP_DOWN,
426   GTK_SCROLL_PAGE_UP,
427   GTK_SCROLL_PAGE_DOWN,
428   GTK_SCROLL_STEP_LEFT,
429   GTK_SCROLL_STEP_RIGHT,
430   GTK_SCROLL_PAGE_LEFT,
431   GTK_SCROLL_PAGE_RIGHT,
432   GTK_SCROLL_START,
433   GTK_SCROLL_END
434 } GtkScrollType;
435 
436 /**
437  * GtkSelectionMode:
438  * @GTK_SELECTION_NONE: No selection is possible.
439  * @GTK_SELECTION_SINGLE: Zero or one element may be selected.
440  * @GTK_SELECTION_BROWSE: Exactly one element is selected.
441  *     In some circumstances, such as initially or during a search
442  *     operation, it’s possible for no element to be selected with
443  *     %GTK_SELECTION_BROWSE. What is really enforced is that the user
444  *     can’t deselect a currently selected element except by selecting
445  *     another element.
446  * @GTK_SELECTION_MULTIPLE: Any number of elements may be selected.
447  *      The Ctrl key may be used to enlarge the selection, and Shift
448  *      key to select between the focus and the child pointed to.
449  *      Some widgets may also allow Click-drag to select a range of elements.
450  *
451  * Used to control what selections users are allowed to make.
452  */
453 typedef enum
454 {
455   GTK_SELECTION_NONE,
456   GTK_SELECTION_SINGLE,
457   GTK_SELECTION_BROWSE,
458   GTK_SELECTION_MULTIPLE
459 } GtkSelectionMode;
460 
461 /**
462  * GtkShadowType:
463  * @GTK_SHADOW_NONE: No outline.
464  * @GTK_SHADOW_IN: The outline is bevelled inwards.
465  * @GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
466  * @GTK_SHADOW_ETCHED_IN: The outline has a sunken 3d appearance.
467  * @GTK_SHADOW_ETCHED_OUT: The outline has a raised 3d appearance.
468  *
469  * Used to change the appearance of an outline typically provided by a #GtkFrame.
470  *
471  * Note that many themes do not differentiate the appearance of the
472  * various shadow types: Either their is no visible shadow (@GTK_SHADOW_NONE),
473  * or there is (any other value).
474  */
475 typedef enum
476 {
477   GTK_SHADOW_NONE,
478   GTK_SHADOW_IN,
479   GTK_SHADOW_OUT,
480   GTK_SHADOW_ETCHED_IN,
481   GTK_SHADOW_ETCHED_OUT
482 } GtkShadowType;
483 
484 /* Widget states */
485 
486 /**
487  * GtkStateType:
488  * @GTK_STATE_NORMAL: State during normal operation.
489  * @GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
490  * @GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
491  *                      the widget and the widget will respond to mouse clicks.
492  * @GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
493  * @GTK_STATE_INSENSITIVE: State indicating that the widget is
494  *                         unresponsive to user actions.
495  * @GTK_STATE_INCONSISTENT: The widget is inconsistent, such as checkbuttons
496  *                          or radiobuttons that aren’t either set to %TRUE nor %FALSE,
497  *                          or buttons requiring the user attention.
498  * @GTK_STATE_FOCUSED: The widget has the keyboard focus.
499  *
500  * This type indicates the current state of a widget; the state determines how
501  * the widget is drawn. The #GtkStateType enumeration is also used to
502  * identify different colors in a #GtkStyle for drawing, so states can be
503  * used for subparts of a widget as well as entire widgets.
504  *
505  * Deprecated: 3.14: All APIs that are using this enumeration have been deprecated
506  *     in favor of alternatives using #GtkStateFlags.
507  */
508 typedef enum
509 {
510   GTK_STATE_NORMAL,
511   GTK_STATE_ACTIVE,
512   GTK_STATE_PRELIGHT,
513   GTK_STATE_SELECTED,
514   GTK_STATE_INSENSITIVE,
515   GTK_STATE_INCONSISTENT,
516   GTK_STATE_FOCUSED
517 } GtkStateType;
518 
519 /**
520  * GtkToolbarStyle:
521  * @GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
522  * @GTK_TOOLBAR_TEXT: Buttons display only text labels in the toolbar.
523  * @GTK_TOOLBAR_BOTH: Buttons display text and icons in the toolbar.
524  * @GTK_TOOLBAR_BOTH_HORIZ: Buttons display icons and text alongside each
525  *  other, rather than vertically stacked
526  *
527  * Used to customize the appearance of a #GtkToolbar. Note that
528  * setting the toolbar style overrides the user’s preferences
529  * for the default toolbar style.  Note that if the button has only
530  * a label set and GTK_TOOLBAR_ICONS is used, the label will be
531  * visible, and vice versa.
532  */
533 typedef enum
534 {
535   GTK_TOOLBAR_ICONS,
536   GTK_TOOLBAR_TEXT,
537   GTK_TOOLBAR_BOTH,
538   GTK_TOOLBAR_BOTH_HORIZ
539 } GtkToolbarStyle;
540 
541 /**
542  * GtkWrapMode:
543  * @GTK_WRAP_NONE: do not wrap lines; just make the text area wider
544  * @GTK_WRAP_CHAR: wrap text, breaking lines anywhere the cursor can
545  *     appear (between characters, usually - if you want to be technical,
546  *     between graphemes, see pango_get_log_attrs())
547  * @GTK_WRAP_WORD: wrap text, breaking lines in between words
548  * @GTK_WRAP_WORD_CHAR: wrap text, breaking lines in between words, or if
549  *     that is not enough, also between graphemes
550  *
551  * Describes a type of line wrapping.
552  */
553 typedef enum
554 {
555   GTK_WRAP_NONE,
556   GTK_WRAP_CHAR,
557   GTK_WRAP_WORD,
558   GTK_WRAP_WORD_CHAR
559 } GtkWrapMode;
560 
561 /**
562  * GtkSortType:
563  * @GTK_SORT_ASCENDING: Sorting is in ascending order.
564  * @GTK_SORT_DESCENDING: Sorting is in descending order.
565  *
566  * Determines the direction of a sort.
567  */
568 typedef enum
569 {
570   GTK_SORT_ASCENDING,
571   GTK_SORT_DESCENDING
572 } GtkSortType;
573 
574 /* Style for gtk input method preedit/status */
575 /**
576  * GtkIMPreeditStyle:
577  * @GTK_IM_PREEDIT_NOTHING: Deprecated
578  * @GTK_IM_PREEDIT_CALLBACK: Deprecated
579  * @GTK_IM_PREEDIT_NONE: Deprecated
580  *
581  * Style for input method preedit. See also
582  * #GtkSettings:gtk-im-preedit-style
583  *
584  * Deprecated: 3.10
585  */
586 typedef enum
587 {
588   GTK_IM_PREEDIT_NOTHING,
589   GTK_IM_PREEDIT_CALLBACK,
590   GTK_IM_PREEDIT_NONE
591 } GtkIMPreeditStyle;
592 
593 /**
594  * GtkIMStatusStyle:
595  * @GTK_IM_STATUS_NOTHING: Deprecated
596  * @GTK_IM_STATUS_CALLBACK: Deprecated
597  * @GTK_IM_STATUS_NONE: Deprecated
598  *
599  * Style for input method status. See also
600  * #GtkSettings:gtk-im-status-style
601  *
602  * Deprecated: 3.10
603  */
604 typedef enum
605 {
606   GTK_IM_STATUS_NOTHING,
607   GTK_IM_STATUS_CALLBACK,
608   GTK_IM_STATUS_NONE
609 } GtkIMStatusStyle;
610 
611 /**
612  * GtkPackDirection:
613  * @GTK_PACK_DIRECTION_LTR: Widgets are packed left-to-right
614  * @GTK_PACK_DIRECTION_RTL: Widgets are packed right-to-left
615  * @GTK_PACK_DIRECTION_TTB: Widgets are packed top-to-bottom
616  * @GTK_PACK_DIRECTION_BTT: Widgets are packed bottom-to-top
617  *
618  * Determines how widgets should be packed inside menubars
619  * and menuitems contained in menubars.
620  */
621 typedef enum
622 {
623   GTK_PACK_DIRECTION_LTR,
624   GTK_PACK_DIRECTION_RTL,
625   GTK_PACK_DIRECTION_TTB,
626   GTK_PACK_DIRECTION_BTT
627 } GtkPackDirection;
628 
629 /**
630  * GtkPrintPages:
631  * @GTK_PRINT_PAGES_ALL: All pages.
632  * @GTK_PRINT_PAGES_CURRENT: Current page.
633  * @GTK_PRINT_PAGES_RANGES: Range of pages.
634  * @GTK_PRINT_PAGES_SELECTION: Selected pages.
635  *
636  * See also gtk_print_job_set_pages()
637  */
638 typedef enum
639 {
640   GTK_PRINT_PAGES_ALL,
641   GTK_PRINT_PAGES_CURRENT,
642   GTK_PRINT_PAGES_RANGES,
643   GTK_PRINT_PAGES_SELECTION
644 } GtkPrintPages;
645 
646 /**
647  * GtkPageSet:
648  * @GTK_PAGE_SET_ALL: All pages.
649  * @GTK_PAGE_SET_EVEN: Even pages.
650  * @GTK_PAGE_SET_ODD: Odd pages.
651  *
652  * See also gtk_print_job_set_page_set().
653  */
654 typedef enum
655 {
656   GTK_PAGE_SET_ALL,
657   GTK_PAGE_SET_EVEN,
658   GTK_PAGE_SET_ODD
659 } GtkPageSet;
660 
661 /**
662  * GtkNumberUpLayout:
663  * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM: ![](layout-lrtb.png)
664  * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP: ![](layout-lrbt.png)
665  * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM: ![](layout-rltb.png)
666  * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP: ![](layout-rlbt.png)
667  * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT: ![](layout-tblr.png)
668  * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT: ![](layout-tbrl.png)
669  * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT: ![](layout-btlr.png)
670  * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT: ![](layout-btrl.png)
671  *
672  * Used to determine the layout of pages on a sheet when printing
673  * multiple pages per sheet.
674  */
675 typedef enum
676 {
677   GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM, /*< nick=lrtb >*/
678   GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP, /*< nick=lrbt >*/
679   GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM, /*< nick=rltb >*/
680   GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP, /*< nick=rlbt >*/
681   GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT, /*< nick=tblr >*/
682   GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT, /*< nick=tbrl >*/
683   GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT, /*< nick=btlr >*/
684   GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT  /*< nick=btrl >*/
685 } GtkNumberUpLayout;
686 
687 /**
688  * GtkPageOrientation:
689  * @GTK_PAGE_ORIENTATION_PORTRAIT: Portrait mode.
690  * @GTK_PAGE_ORIENTATION_LANDSCAPE: Landscape mode.
691  * @GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT: Reverse portrait mode.
692  * @GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE: Reverse landscape mode.
693  *
694  * See also gtk_print_settings_set_orientation().
695  */
696 typedef enum
697 {
698   GTK_PAGE_ORIENTATION_PORTRAIT,
699   GTK_PAGE_ORIENTATION_LANDSCAPE,
700   GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT,
701   GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE
702 } GtkPageOrientation;
703 
704 /**
705  * GtkPrintQuality:
706  * @GTK_PRINT_QUALITY_LOW: Low quality.
707  * @GTK_PRINT_QUALITY_NORMAL: Normal quality.
708  * @GTK_PRINT_QUALITY_HIGH: High quality.
709  * @GTK_PRINT_QUALITY_DRAFT: Draft quality.
710  *
711  * See also gtk_print_settings_set_quality().
712  */
713 typedef enum
714 {
715   GTK_PRINT_QUALITY_LOW,
716   GTK_PRINT_QUALITY_NORMAL,
717   GTK_PRINT_QUALITY_HIGH,
718   GTK_PRINT_QUALITY_DRAFT
719 } GtkPrintQuality;
720 
721 /**
722  * GtkPrintDuplex:
723  * @GTK_PRINT_DUPLEX_SIMPLEX: No duplex.
724  * @GTK_PRINT_DUPLEX_HORIZONTAL: Horizontal duplex.
725  * @GTK_PRINT_DUPLEX_VERTICAL: Vertical duplex.
726  *
727  * See also gtk_print_settings_set_duplex().
728  */
729 typedef enum
730 {
731   GTK_PRINT_DUPLEX_SIMPLEX,
732   GTK_PRINT_DUPLEX_HORIZONTAL,
733   GTK_PRINT_DUPLEX_VERTICAL
734 } GtkPrintDuplex;
735 
736 
737 /**
738  * GtkUnit:
739  * @GTK_UNIT_NONE: No units.
740  * @GTK_UNIT_POINTS: Dimensions in points.
741  * @GTK_UNIT_INCH: Dimensions in inches.
742  * @GTK_UNIT_MM: Dimensions in millimeters
743  *
744  * See also gtk_print_settings_set_paper_width().
745  */
746 typedef enum
747 {
748   GTK_UNIT_NONE,
749   GTK_UNIT_POINTS,
750   GTK_UNIT_INCH,
751   GTK_UNIT_MM
752 } GtkUnit;
753 
754 #define GTK_UNIT_PIXEL GTK_UNIT_NONE
755 
756 /**
757  * GtkTreeViewGridLines:
758  * @GTK_TREE_VIEW_GRID_LINES_NONE: No grid lines.
759  * @GTK_TREE_VIEW_GRID_LINES_HORIZONTAL: Horizontal grid lines.
760  * @GTK_TREE_VIEW_GRID_LINES_VERTICAL: Vertical grid lines.
761  * @GTK_TREE_VIEW_GRID_LINES_BOTH: Horizontal and vertical grid lines.
762  *
763  * Used to indicate which grid lines to draw in a tree view.
764  */
765 typedef enum
766 {
767   GTK_TREE_VIEW_GRID_LINES_NONE,
768   GTK_TREE_VIEW_GRID_LINES_HORIZONTAL,
769   GTK_TREE_VIEW_GRID_LINES_VERTICAL,
770   GTK_TREE_VIEW_GRID_LINES_BOTH
771 } GtkTreeViewGridLines;
772 
773 /**
774  * GtkDragResult:
775  * @GTK_DRAG_RESULT_SUCCESS: The drag operation was successful.
776  * @GTK_DRAG_RESULT_NO_TARGET: No suitable drag target.
777  * @GTK_DRAG_RESULT_USER_CANCELLED: The user cancelled the drag operation.
778  * @GTK_DRAG_RESULT_TIMEOUT_EXPIRED: The drag operation timed out.
779  * @GTK_DRAG_RESULT_GRAB_BROKEN: The pointer or keyboard grab used
780  *  for the drag operation was broken.
781  * @GTK_DRAG_RESULT_ERROR: The drag operation failed due to some
782  *  unspecified error.
783  *
784  * Gives an indication why a drag operation failed.
785  * The value can by obtained by connecting to the
786  * #GtkWidget::drag-failed signal.
787  */
788 typedef enum
789 {
790   GTK_DRAG_RESULT_SUCCESS,
791   GTK_DRAG_RESULT_NO_TARGET,
792   GTK_DRAG_RESULT_USER_CANCELLED,
793   GTK_DRAG_RESULT_TIMEOUT_EXPIRED,
794   GTK_DRAG_RESULT_GRAB_BROKEN,
795   GTK_DRAG_RESULT_ERROR
796 } GtkDragResult;
797 
798 /**
799  * GtkSizeGroupMode:
800  * @GTK_SIZE_GROUP_NONE: group has no effect
801  * @GTK_SIZE_GROUP_HORIZONTAL: group affects horizontal requisition
802  * @GTK_SIZE_GROUP_VERTICAL: group affects vertical requisition
803  * @GTK_SIZE_GROUP_BOTH: group affects both horizontal and vertical requisition
804  *
805  * The mode of the size group determines the directions in which the size
806  * group affects the requested sizes of its component widgets.
807  **/
808 typedef enum {
809   GTK_SIZE_GROUP_NONE,
810   GTK_SIZE_GROUP_HORIZONTAL,
811   GTK_SIZE_GROUP_VERTICAL,
812   GTK_SIZE_GROUP_BOTH
813 } GtkSizeGroupMode;
814 
815 /**
816  * GtkSizeRequestMode:
817  * @GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH: Prefer height-for-width geometry management
818  * @GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT: Prefer width-for-height geometry management
819  * @GTK_SIZE_REQUEST_CONSTANT_SIZE: Don’t trade height-for-width or width-for-height
820  *
821  * Specifies a preference for height-for-width or
822  * width-for-height geometry management.
823  */
824 typedef enum
825 {
826   GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH = 0,
827   GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT,
828   GTK_SIZE_REQUEST_CONSTANT_SIZE
829 } GtkSizeRequestMode;
830 
831 /**
832  * GtkScrollablePolicy:
833  * @GTK_SCROLL_MINIMUM: Scrollable adjustments are based on the minimum size
834  * @GTK_SCROLL_NATURAL: Scrollable adjustments are based on the natural size
835  *
836  * Defines the policy to be used in a scrollable widget when updating
837  * the scrolled window adjustments in a given orientation.
838  */
839 typedef enum
840 {
841   GTK_SCROLL_MINIMUM = 0,
842   GTK_SCROLL_NATURAL
843 } GtkScrollablePolicy;
844 
845 /**
846  * GtkStateFlags:
847  * @GTK_STATE_FLAG_NORMAL: State during normal operation.
848  * @GTK_STATE_FLAG_ACTIVE: Widget is active.
849  * @GTK_STATE_FLAG_PRELIGHT: Widget has a mouse pointer over it.
850  * @GTK_STATE_FLAG_SELECTED: Widget is selected.
851  * @GTK_STATE_FLAG_INSENSITIVE: Widget is insensitive.
852  * @GTK_STATE_FLAG_INCONSISTENT: Widget is inconsistent.
853  * @GTK_STATE_FLAG_FOCUSED: Widget has the keyboard focus.
854  * @GTK_STATE_FLAG_BACKDROP: Widget is in a background toplevel window.
855  * @GTK_STATE_FLAG_DIR_LTR: Widget is in left-to-right text direction. Since 3.8
856  * @GTK_STATE_FLAG_DIR_RTL: Widget is in right-to-left text direction. Since 3.8
857  * @GTK_STATE_FLAG_LINK: Widget is a link. Since 3.12
858  * @GTK_STATE_FLAG_VISITED: The location the widget points to has already been visited. Since 3.12
859  * @GTK_STATE_FLAG_CHECKED: Widget is checked. Since 3.14
860  * @GTK_STATE_FLAG_DROP_ACTIVE: Widget is highlighted as a drop target for DND. Since 3.20
861  *
862  * Describes a widget state. Widget states are used to match the widget
863  * against CSS pseudo-classes. Note that GTK extends the regular CSS
864  * classes and sometimes uses different names.
865  */
866 typedef enum
867 {
868   GTK_STATE_FLAG_NORMAL       = 0,
869   GTK_STATE_FLAG_ACTIVE       = 1 << 0,
870   GTK_STATE_FLAG_PRELIGHT     = 1 << 1,
871   GTK_STATE_FLAG_SELECTED     = 1 << 2,
872   GTK_STATE_FLAG_INSENSITIVE  = 1 << 3,
873   GTK_STATE_FLAG_INCONSISTENT = 1 << 4,
874   GTK_STATE_FLAG_FOCUSED      = 1 << 5,
875   GTK_STATE_FLAG_BACKDROP     = 1 << 6,
876   GTK_STATE_FLAG_DIR_LTR      = 1 << 7,
877   GTK_STATE_FLAG_DIR_RTL      = 1 << 8,
878   GTK_STATE_FLAG_LINK         = 1 << 9,
879   GTK_STATE_FLAG_VISITED      = 1 << 10,
880   GTK_STATE_FLAG_CHECKED      = 1 << 11,
881   GTK_STATE_FLAG_DROP_ACTIVE  = 1 << 12
882 } GtkStateFlags;
883 
884 /**
885  * GtkRegionFlags:
886  * @GTK_REGION_EVEN: Region has an even number within a set.
887  * @GTK_REGION_ODD: Region has an odd number within a set.
888  * @GTK_REGION_FIRST: Region is the first one within a set.
889  * @GTK_REGION_LAST: Region is the last one within a set.
890  * @GTK_REGION_ONLY: Region is the only one within a set.
891  * @GTK_REGION_SORTED: Region is part of a sorted area.
892  *
893  * Describes a region within a widget.
894  */
895 typedef enum {
896   GTK_REGION_EVEN    = 1 << 0,
897   GTK_REGION_ODD     = 1 << 1,
898   GTK_REGION_FIRST   = 1 << 2,
899   GTK_REGION_LAST    = 1 << 3,
900   GTK_REGION_ONLY    = 1 << 4,
901   GTK_REGION_SORTED  = 1 << 5
902 } GtkRegionFlags;
903 
904 /**
905  * GtkJunctionSides:
906  * @GTK_JUNCTION_NONE: No junctions.
907  * @GTK_JUNCTION_CORNER_TOPLEFT: Element connects on the top-left corner.
908  * @GTK_JUNCTION_CORNER_TOPRIGHT: Element connects on the top-right corner.
909  * @GTK_JUNCTION_CORNER_BOTTOMLEFT: Element connects on the bottom-left corner.
910  * @GTK_JUNCTION_CORNER_BOTTOMRIGHT: Element connects on the bottom-right corner.
911  * @GTK_JUNCTION_TOP: Element connects on the top side.
912  * @GTK_JUNCTION_BOTTOM: Element connects on the bottom side.
913  * @GTK_JUNCTION_LEFT: Element connects on the left side.
914  * @GTK_JUNCTION_RIGHT: Element connects on the right side.
915  *
916  * Describes how a rendered element connects to adjacent elements.
917  */
918 typedef enum {
919   GTK_JUNCTION_NONE   = 0,
920   GTK_JUNCTION_CORNER_TOPLEFT = 1 << 0,
921   GTK_JUNCTION_CORNER_TOPRIGHT = 1 << 1,
922   GTK_JUNCTION_CORNER_BOTTOMLEFT = 1 << 2,
923   GTK_JUNCTION_CORNER_BOTTOMRIGHT = 1 << 3,
924   GTK_JUNCTION_TOP    = (GTK_JUNCTION_CORNER_TOPLEFT | GTK_JUNCTION_CORNER_TOPRIGHT),
925   GTK_JUNCTION_BOTTOM = (GTK_JUNCTION_CORNER_BOTTOMLEFT | GTK_JUNCTION_CORNER_BOTTOMRIGHT),
926   GTK_JUNCTION_LEFT   = (GTK_JUNCTION_CORNER_TOPLEFT | GTK_JUNCTION_CORNER_BOTTOMLEFT),
927   GTK_JUNCTION_RIGHT  = (GTK_JUNCTION_CORNER_TOPRIGHT | GTK_JUNCTION_CORNER_BOTTOMRIGHT)
928 } GtkJunctionSides;
929 
930 /**
931  * GtkBorderStyle:
932  * @GTK_BORDER_STYLE_NONE: No visible border
933  * @GTK_BORDER_STYLE_SOLID: A single line segment
934  * @GTK_BORDER_STYLE_INSET: Looks as if the content is sunken into the canvas
935  * @GTK_BORDER_STYLE_OUTSET: Looks as if the content is coming out of the canvas
936  * @GTK_BORDER_STYLE_HIDDEN: Same as @GTK_BORDER_STYLE_NONE
937  * @GTK_BORDER_STYLE_DOTTED: A series of round dots
938  * @GTK_BORDER_STYLE_DASHED: A series of square-ended dashes
939  * @GTK_BORDER_STYLE_DOUBLE: Two parallel lines with some space between them
940  * @GTK_BORDER_STYLE_GROOVE: Looks as if it were carved in the canvas
941  * @GTK_BORDER_STYLE_RIDGE: Looks as if it were coming out of the canvas
942  *
943  * Describes how the border of a UI element should be rendered.
944  */
945 typedef enum {
946   GTK_BORDER_STYLE_NONE,
947   GTK_BORDER_STYLE_SOLID,
948   GTK_BORDER_STYLE_INSET,
949   GTK_BORDER_STYLE_OUTSET,
950   GTK_BORDER_STYLE_HIDDEN,
951   GTK_BORDER_STYLE_DOTTED,
952   GTK_BORDER_STYLE_DASHED,
953   GTK_BORDER_STYLE_DOUBLE,
954   GTK_BORDER_STYLE_GROOVE,
955   GTK_BORDER_STYLE_RIDGE
956 } GtkBorderStyle;
957 
958 /**
959  * GtkLevelBarMode:
960  * @GTK_LEVEL_BAR_MODE_CONTINUOUS: the bar has a continuous mode
961  * @GTK_LEVEL_BAR_MODE_DISCRETE: the bar has a discrete mode
962  *
963  * Describes how #GtkLevelBar contents should be rendered.
964  * Note that this enumeration could be extended with additional modes
965  * in the future.
966  *
967  * Since: 3.6
968  */
969 typedef enum {
970   GTK_LEVEL_BAR_MODE_CONTINUOUS,
971   GTK_LEVEL_BAR_MODE_DISCRETE
972 } GtkLevelBarMode;
973 
974 G_END_DECLS
975 
976 /**
977  * GtkInputPurpose:
978  * @GTK_INPUT_PURPOSE_FREE_FORM: Allow any character
979  * @GTK_INPUT_PURPOSE_ALPHA: Allow only alphabetic characters
980  * @GTK_INPUT_PURPOSE_DIGITS: Allow only digits
981  * @GTK_INPUT_PURPOSE_NUMBER: Edited field expects numbers
982  * @GTK_INPUT_PURPOSE_PHONE: Edited field expects phone number
983  * @GTK_INPUT_PURPOSE_URL: Edited field expects URL
984  * @GTK_INPUT_PURPOSE_EMAIL: Edited field expects email address
985  * @GTK_INPUT_PURPOSE_NAME: Edited field expects the name of a person
986  * @GTK_INPUT_PURPOSE_PASSWORD: Like @GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden
987  * @GTK_INPUT_PURPOSE_PIN: Like @GTK_INPUT_PURPOSE_DIGITS, but characters are hidden
988  * @GTK_INPUT_PURPOSE_TERMINAL: Allow any character, in addition to control codes
989  *
990  * Describes primary purpose of the input widget. This information is
991  * useful for on-screen keyboards and similar input methods to decide
992  * which keys should be presented to the user.
993  *
994  * Note that the purpose is not meant to impose a totally strict rule
995  * about allowed characters, and does not replace input validation.
996  * It is fine for an on-screen keyboard to let the user override the
997  * character set restriction that is expressed by the purpose. The
998  * application is expected to validate the entry contents, even if
999  * it specified a purpose.
1000  *
1001  * The difference between @GTK_INPUT_PURPOSE_DIGITS and
1002  * @GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits
1003  * while the latter also some punctuation (like commas or points, plus,
1004  * minus) and “e” or “E” as in 3.14E+000.
1005  *
1006  * This enumeration may be extended in the future; input methods should
1007  * interpret unknown values as “free form”.
1008  *
1009  * Since: 3.6
1010  */
1011 typedef enum
1012 {
1013   GTK_INPUT_PURPOSE_FREE_FORM,
1014   GTK_INPUT_PURPOSE_ALPHA,
1015   GTK_INPUT_PURPOSE_DIGITS,
1016   GTK_INPUT_PURPOSE_NUMBER,
1017   GTK_INPUT_PURPOSE_PHONE,
1018   GTK_INPUT_PURPOSE_URL,
1019   GTK_INPUT_PURPOSE_EMAIL,
1020   GTK_INPUT_PURPOSE_NAME,
1021   GTK_INPUT_PURPOSE_PASSWORD,
1022   GTK_INPUT_PURPOSE_PIN,
1023   GTK_INPUT_PURPOSE_TERMINAL,
1024 } GtkInputPurpose;
1025 
1026 /**
1027  * GtkInputHints:
1028  * @GTK_INPUT_HINT_NONE: No special behaviour suggested
1029  * @GTK_INPUT_HINT_SPELLCHECK: Suggest checking for typos
1030  * @GTK_INPUT_HINT_NO_SPELLCHECK: Suggest not checking for typos
1031  * @GTK_INPUT_HINT_WORD_COMPLETION: Suggest word completion
1032  * @GTK_INPUT_HINT_LOWERCASE: Suggest to convert all text to lowercase
1033  * @GTK_INPUT_HINT_UPPERCASE_CHARS: Suggest to capitalize all text
1034  * @GTK_INPUT_HINT_UPPERCASE_WORDS: Suggest to capitalize the first
1035  *     character of each word
1036  * @GTK_INPUT_HINT_UPPERCASE_SENTENCES: Suggest to capitalize the
1037  *     first word of each sentence
1038  * @GTK_INPUT_HINT_INHIBIT_OSK: Suggest to not show an onscreen keyboard
1039  *     (e.g for a calculator that already has all the keys).
1040  * @GTK_INPUT_HINT_VERTICAL_WRITING: The text is vertical. Since 3.18
1041  * @GTK_INPUT_HINT_EMOJI: Suggest offering Emoji support. Since 3.22.20
1042  * @GTK_INPUT_HINT_NO_EMOJI: Suggest not offering Emoji support. Since 3.22.20
1043  *
1044  * Describes hints that might be taken into account by input methods
1045  * or applications. Note that input methods may already tailor their
1046  * behaviour according to the #GtkInputPurpose of the entry.
1047  *
1048  * Some common sense is expected when using these flags - mixing
1049  * @GTK_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense.
1050  *
1051  * This enumeration may be extended in the future; input methods should
1052  * ignore unknown values.
1053  *
1054  * Since: 3.6
1055  */
1056 typedef enum
1057 {
1058   GTK_INPUT_HINT_NONE                = 0,
1059   GTK_INPUT_HINT_SPELLCHECK          = 1 << 0,
1060   GTK_INPUT_HINT_NO_SPELLCHECK       = 1 << 1,
1061   GTK_INPUT_HINT_WORD_COMPLETION     = 1 << 2,
1062   GTK_INPUT_HINT_LOWERCASE           = 1 << 3,
1063   GTK_INPUT_HINT_UPPERCASE_CHARS     = 1 << 4,
1064   GTK_INPUT_HINT_UPPERCASE_WORDS     = 1 << 5,
1065   GTK_INPUT_HINT_UPPERCASE_SENTENCES = 1 << 6,
1066   GTK_INPUT_HINT_INHIBIT_OSK         = 1 << 7,
1067   GTK_INPUT_HINT_VERTICAL_WRITING    = 1 << 8,
1068   GTK_INPUT_HINT_EMOJI               = 1 << 9,
1069   GTK_INPUT_HINT_NO_EMOJI            = 1 << 10
1070 } GtkInputHints;
1071 
1072 /**
1073  * GtkPropagationPhase:
1074  * @GTK_PHASE_NONE: Events are not delivered automatically. Those can be
1075  *   manually fed through gtk_event_controller_handle_event(). This should
1076  *   only be used when full control about when, or whether the controller
1077  *   handles the event is needed.
1078  * @GTK_PHASE_CAPTURE: Events are delivered in the capture phase. The
1079  *   capture phase happens before the bubble phase, runs from the toplevel down
1080  *   to the event widget. This option should only be used on containers that
1081  *   might possibly handle events before their children do.
1082  * @GTK_PHASE_BUBBLE: Events are delivered in the bubble phase. The bubble
1083  *   phase happens after the capture phase, and before the default handlers
1084  *   are run. This phase runs from the event widget, up to the toplevel.
1085  * @GTK_PHASE_TARGET: Events are delivered in the default widget event handlers,
1086  *   note that widget implementations must chain up on button, motion, touch and
1087  *   grab broken handlers for controllers in this phase to be run.
1088  *
1089  * Describes the stage at which events are fed into a #GtkEventController.
1090  *
1091  * Since: 3.14
1092  */
1093 typedef enum
1094 {
1095   GTK_PHASE_NONE,
1096   GTK_PHASE_CAPTURE,
1097   GTK_PHASE_BUBBLE,
1098   GTK_PHASE_TARGET
1099 } GtkPropagationPhase;
1100 
1101 /**
1102  * GtkEventSequenceState:
1103  * @GTK_EVENT_SEQUENCE_NONE: The sequence is handled, but not grabbed.
1104  * @GTK_EVENT_SEQUENCE_CLAIMED: The sequence is handled and grabbed.
1105  * @GTK_EVENT_SEQUENCE_DENIED: The sequence is denied.
1106  *
1107  * Describes the state of a #GdkEventSequence in a #GtkGesture.
1108  *
1109  * Since: 3.14
1110  */
1111 typedef enum
1112 {
1113   GTK_EVENT_SEQUENCE_NONE,
1114   GTK_EVENT_SEQUENCE_CLAIMED,
1115   GTK_EVENT_SEQUENCE_DENIED
1116 } GtkEventSequenceState;
1117 
1118 /**
1119  * GtkPanDirection:
1120  * @GTK_PAN_DIRECTION_LEFT: panned towards the left
1121  * @GTK_PAN_DIRECTION_RIGHT: panned towards the right
1122  * @GTK_PAN_DIRECTION_UP: panned upwards
1123  * @GTK_PAN_DIRECTION_DOWN: panned downwards
1124  *
1125  * Describes the panning direction of a #GtkGesturePan
1126  *
1127  * Since: 3.14
1128  */
1129 typedef enum
1130 {
1131   GTK_PAN_DIRECTION_LEFT,
1132   GTK_PAN_DIRECTION_RIGHT,
1133   GTK_PAN_DIRECTION_UP,
1134   GTK_PAN_DIRECTION_DOWN
1135 } GtkPanDirection;
1136 
1137 /**
1138  * GtkPopoverConstraint:
1139  * @GTK_POPOVER_CONSTRAINT_NONE: Don't constrain the popover position
1140  *   beyond what is imposed by the implementation
1141  * @GTK_POPOVER_CONSTRAINT_WINDOW: Constrain the popover to the boundaries
1142  *   of the window that it is attached to
1143  *
1144  * Describes constraints to positioning of popovers. More values
1145  * may be added to this enumeration in the future.
1146  *
1147  * Since: 3.20
1148  */
1149 typedef enum
1150 {
1151   GTK_POPOVER_CONSTRAINT_NONE,
1152   GTK_POPOVER_CONSTRAINT_WINDOW
1153 } GtkPopoverConstraint;
1154 
1155 
1156 #endif /* __GTK_ENUMS_H__ */
1157