Pileus Git - ~andy/gtk/blob - gtk/gtkenums.h

   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:gtkenum
  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  *
  55  * Controls how a widget deals with extra space in a single (x or y)
  56  * dimension.
  57  *
  58  * Alignment only matters if the widget receives a "too large" allocation,
  59  * for example if you packed the widget with the #GtkWidget:expand
  60  * flag inside a #GtkBox, then the widget might get extra space.  If
  61  * you have for example a 16x16 icon inside a 32x32 space, the icon
  62  * could be scaled and stretched, it could be centered, or it could be
  63  * positioned to one side of the space.
  64  *
  65  * Note that in horizontal context @GTK_ALIGN_START and @GTK_ALIGN_END
  66  * are interpreted relative to text direction.
  67  */
  68 typedef enum
  69 {
  70   GTK_ALIGN_FILL,
  71   GTK_ALIGN_START,
  72   GTK_ALIGN_END,
  73   GTK_ALIGN_CENTER
  74 } GtkAlign;
  75
  76
  77 /**
  78  * GtkArrowPlacement:
  79  * @GTK_ARROWS_BOTH: Place one arrow on each end of the menu.
  80  * @GTK_ARROWS_START: Place both arrows at the top of the menu.
  81  * @GTK_ARROWS_END: Place both arrows at the bottom of the menu.
  82  *
  83  * Used to specify the placement of scroll arrows in scrolling menus.
  84  */
  85 typedef enum
  86 {
  87   GTK_ARROWS_BOTH,
  88   GTK_ARROWS_START,
  89   GTK_ARROWS_END
  90 } GtkArrowPlacement;
  91
  92 /**
  93  * GtkArrowType:
  94  * @GTK_ARROW_UP: Represents an upward pointing arrow.
  95  * @GTK_ARROW_DOWN: Represents a downward pointing arrow.
  96  * @GTK_ARROW_LEFT: Represents a left pointing arrow.
  97  * @GTK_ARROW_RIGHT: Represents a right pointing arrow.
  98  * @GTK_ARROW_NONE: No arrow. Since 2.10.
  99  *
 100  * Used to indicate the direction in which a #GtkArrow should point.
 101  */
 102 typedef enum
 103 {
 104   GTK_ARROW_UP,
 105   GTK_ARROW_DOWN,
 106   GTK_ARROW_LEFT,
 107   GTK_ARROW_RIGHT,
 108   GTK_ARROW_NONE
 109 } GtkArrowType;
 110
 111 /**
 112  * GtkAttachOptions:
 113  * @GTK_EXPAND: the widget should expand to take up any extra space in its
 114  * container that has been allocated.
 115  * @GTK_SHRINK: the widget should shrink as and when possible.
 116  * @GTK_FILL: the widget should fill the space allocated to it.
 117  *
 118  * Denotes the expansion properties that a widget will have when it (or its
 119  * parent) is resized.
 120  */
 121 typedef enum
 122 {
 123   GTK_EXPAND = 1 << 0,
 124   GTK_SHRINK = 1 << 1,
 125   GTK_FILL   = 1 << 2
 126 } GtkAttachOptions;
 127
 128 /**
 129  * GtkButtonBoxStyle:
 130  * @GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
 131  * @GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the box.
 132  * @GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the box.
 133  * @GTK_BUTTONBOX_START: Buttons are grouped towards the start of the box,
 134  *   (on the left for a HBox, or the top for a VBox).
 135  * @GTK_BUTTONBOX_END: Buttons are grouped towards the end of the box,
 136  *   (on the right for a HBox, or the bottom for a VBox).
 137  * @GTK_BUTTONBOX_CENTER: Buttons are centered in the box. Since 2.12.
 138  *
 139  * Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
 140  * contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
 141  */
 142 typedef enum
 143 {
 144   GTK_BUTTONBOX_SPREAD = 1,
 145   GTK_BUTTONBOX_EDGE,
 146   GTK_BUTTONBOX_START,
 147   GTK_BUTTONBOX_END,
 148   GTK_BUTTONBOX_CENTER
 149 } GtkButtonBoxStyle;
 150
 151
 152 typedef enum
 153 {
 154   GTK_DELETE_CHARS,
 155   GTK_DELETE_WORD_ENDS,           /* delete only the portion of the word to the
 156                                    * left/right of cursor if we're in the middle
 157                                    * of a word */
 158   GTK_DELETE_WORDS,
 159   GTK_DELETE_DISPLAY_LINES,
 160   GTK_DELETE_DISPLAY_LINE_ENDS,
 161   GTK_DELETE_PARAGRAPH_ENDS,      /* like C-k in Emacs (or its reverse) */
 162   GTK_DELETE_PARAGRAPHS,          /* C-k in pico, kill whole line */
 163   GTK_DELETE_WHITESPACE           /* M-\ in Emacs */
 164 } GtkDeleteType;
 165
 166 /* Focus movement types */
 167 typedef enum
 168 {
 169   GTK_DIR_TAB_FORWARD,
 170   GTK_DIR_TAB_BACKWARD,
 171   GTK_DIR_UP,
 172   GTK_DIR_DOWN,
 173   GTK_DIR_LEFT,
 174   GTK_DIR_RIGHT
 175 } GtkDirectionType;
 176
 177 /**
 178  * GtkExpanderStyle:
 179  * @GTK_EXPANDER_COLLAPSED: The style used for a collapsed subtree.
 180  * @GTK_EXPANDER_SEMI_COLLAPSED: Intermediate style used during animation.
 181  * @GTK_EXPANDER_SEMI_EXPANDED: Intermediate style used during animation.
 182  * @GTK_EXPANDER_EXPANDED: The style used for an expanded subtree.
 183  *
 184  * Used to specify the style of the expanders drawn by a #GtkTreeView.
 185  */
 186 typedef enum
 187 {
 188   GTK_EXPANDER_COLLAPSED,
 189   GTK_EXPANDER_SEMI_COLLAPSED,
 190   GTK_EXPANDER_SEMI_EXPANDED,
 191   GTK_EXPANDER_EXPANDED
 192 } GtkExpanderStyle;
 193
 194 /* Built-in stock icon sizes */
 195 typedef enum
 196 {
 197   GTK_ICON_SIZE_INVALID,
 198   GTK_ICON_SIZE_MENU,
 199   GTK_ICON_SIZE_SMALL_TOOLBAR,
 200   GTK_ICON_SIZE_LARGE_TOOLBAR,
 201   GTK_ICON_SIZE_BUTTON,
 202   GTK_ICON_SIZE_DND,
 203   GTK_ICON_SIZE_DIALOG
 204 } GtkIconSize;
 205
 206 /**
 207  * GtkSensitivityType:
 208  * @GTK_SENSITIVITY_AUTO: The arrow is made insensitive if the
 209  *   thumb is at the end
 210  * @GTK_SENSITIVITY_ON: The arrow is always sensitive
 211  * @GTK_SENSITIVITY_OFF: The arrow is always insensitive
 212  *
 213  * Determines how GTK+ handles the sensitivity of stepper arrows
 214  * at the end of range widgets.
 215  */
 216 typedef enum
 217 {
 218   GTK_SENSITIVITY_AUTO,
 219   GTK_SENSITIVITY_ON,
 220   GTK_SENSITIVITY_OFF
 221 } GtkSensitivityType;
 222
 223 /* Reading directions for text */
 224 typedef enum
 225 {
 226   GTK_TEXT_DIR_NONE,
 227   GTK_TEXT_DIR_LTR,
 228   GTK_TEXT_DIR_RTL
 229 } GtkTextDirection;
 230
 231 /**
 232  * GtkJustification:
 233  * @GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
 234  * @GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
 235  * @GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
 236  * @GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
 237  *
 238  * Used for justifying the text inside a #GtkLabel widget. (See also
 239  * #GtkAlignment).
 240  */
 241 typedef enum
 242 {
 243   GTK_JUSTIFY_LEFT,
 244   GTK_JUSTIFY_RIGHT,
 245   GTK_JUSTIFY_CENTER,
 246   GTK_JUSTIFY_FILL
 247 } GtkJustification;
 248
 249 /**
 250  * GtkMenuDirectionType:
 251  * @GTK_MENU_DIR_PARENT: To the parent menu shell
 252  * @GTK_MENU_DIR_CHILD: To the submenu, if any, associated with the item
 253  * @GTK_MENU_DIR_NEXT: To the next menu item
 254  * @GTK_MENU_DIR_PREV: To the previous menu item
 255  *
 256  * An enumeration representing directional movements within a menu.
 257  */
 258 typedef enum
 259 {
 260   GTK_MENU_DIR_PARENT,
 261   GTK_MENU_DIR_CHILD,
 262   GTK_MENU_DIR_NEXT,
 263   GTK_MENU_DIR_PREV
 264 } GtkMenuDirectionType;
 265
 266 /**
 267  * GtkMessageType:
 268  * @GTK_MESSAGE_INFO: Informational message
 269  * @GTK_MESSAGE_WARNING: Non-fatal warning message
 270  * @GTK_MESSAGE_QUESTION: Question requiring a choice
 271  * @GTK_MESSAGE_ERROR: Fatal error message
 272  * @GTK_MESSAGE_OTHER: None of the above, doesn't get an icon
 273  *
 274  * The type of message being displayed in the dialog.
 275  */
 276 typedef enum
 277 {
 278   GTK_MESSAGE_INFO,
 279   GTK_MESSAGE_WARNING,
 280   GTK_MESSAGE_QUESTION,
 281   GTK_MESSAGE_ERROR,
 282   GTK_MESSAGE_OTHER
 283 } GtkMessageType;
 284
 285 /**
 286  * GtkMovementStep:
 287  * @GTK_MOVEMENT_LOGICAL_POSITIONS: Move forward or back by graphemes
 288  * @GTK_MOVEMENT_VISUAL_POSITIONS:  Move left or right by graphemes
 289  * @GTK_MOVEMENT_WORDS:             Move forward or back by words
 290  * @GTK_MOVEMENT_DISPLAY_LINES:     Move up or down lines (wrapped lines)
 291  * @GTK_MOVEMENT_DISPLAY_LINE_ENDS: Move to either end of a line
 292  * @GTK_MOVEMENT_PARAGRAPHS:        Move up or down paragraphs (newline-ended lines)
 293  * @GTK_MOVEMENT_PARAGRAPH_ENDS:    Move to either end of a paragraph
 294  * @GTK_MOVEMENT_PAGES:             Move by pages
 295  * @GTK_MOVEMENT_BUFFER_ENDS:       Move to ends of the buffer
 296  * @GTK_MOVEMENT_HORIZONTAL_PAGES:  Move horizontally by pages
 297  */
 298 typedef enum
 299 {
 300   GTK_MOVEMENT_LOGICAL_POSITIONS,
 301   GTK_MOVEMENT_VISUAL_POSITIONS,
 302   GTK_MOVEMENT_WORDS,
 303   GTK_MOVEMENT_DISPLAY_LINES,
 304   GTK_MOVEMENT_DISPLAY_LINE_ENDS,
 305   GTK_MOVEMENT_PARAGRAPHS,
 306   GTK_MOVEMENT_PARAGRAPH_ENDS,
 307   GTK_MOVEMENT_PAGES,
 308   GTK_MOVEMENT_BUFFER_ENDS,
 309   GTK_MOVEMENT_HORIZONTAL_PAGES
 310 } GtkMovementStep;
 311
 312 typedef enum
 313 {
 314   GTK_SCROLL_STEPS,
 315   GTK_SCROLL_PAGES,
 316   GTK_SCROLL_ENDS,
 317   GTK_SCROLL_HORIZONTAL_STEPS,
 318   GTK_SCROLL_HORIZONTAL_PAGES,
 319   GTK_SCROLL_HORIZONTAL_ENDS
 320 } GtkScrollStep;
 321
 322 /**
 323  * GtkOrientation:
 324  * @GTK_ORIENTATION_HORIZONTAL: The widget is in horizontal orientation.
 325  * @GTK_ORIENTATION_VERTICAL: The widget is in vertical orientation.
 326  *
 327  * Represents the orientation of widgets which can be switched between horizontal
 328  * and vertical orientation on the fly, like #GtkToolbar.
 329  */
 330 typedef enum
 331 {
 332   GTK_ORIENTATION_HORIZONTAL,
 333   GTK_ORIENTATION_VERTICAL
 334 } GtkOrientation;
 335
 336 /**
 337  * GtkCornerType:
 338  * @GTK_CORNER_TOP_LEFT: Place the scrollbars on the right and bottom of the
 339  *  widget (default behaviour).
 340  * @GTK_CORNER_BOTTOM_LEFT: Place the scrollbars on the top and right of the
 341  *  widget.
 342  * @GTK_CORNER_TOP_RIGHT: Place the scrollbars on the left and bottom of the
 343  *  widget.
 344  * @GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the
 345  *  widget.
 346  *
 347  * Specifies which corner a child widget should be placed in when packed into
 348  * a #GtkScrolledWindow. This is effectively the opposite of where the scroll
 349  * bars are placed.
 350  */
 351 typedef enum
 352 {
 353   GTK_CORNER_TOP_LEFT,
 354   GTK_CORNER_BOTTOM_LEFT,
 355   GTK_CORNER_TOP_RIGHT,
 356   GTK_CORNER_BOTTOM_RIGHT
 357 } GtkCornerType;
 358
 359 /**
 360  * GtkPackType:
 361  * @GTK_PACK_START: The child is packed into the start of the box
 362  * @GTK_PACK_END: The child is packed into the end of the box
 363  *
 364  * Represents the packing location #GtkBox children. (See: #GtkVBox,
 365  * #GtkHBox, and #GtkButtonBox).
 366  */
 367 typedef enum
 368 {
 369   GTK_PACK_START,
 370   GTK_PACK_END
 371 } GtkPackType;
 372
 373 /* priorities for path lookups */
 374 typedef enum
 375 {
 376   GTK_PATH_PRIO_LOWEST      = 0,
 377   GTK_PATH_PRIO_GTK         = 4,
 378   GTK_PATH_PRIO_APPLICATION = 8,
 379   GTK_PATH_PRIO_THEME       = 10,
 380   GTK_PATH_PRIO_RC          = 12,
 381   GTK_PATH_PRIO_HIGHEST     = 15
 382 } GtkPathPriorityType;
 383 #define GTK_PATH_PRIO_MASK 0x0f
 384
 385 /* widget path types */
 386 typedef enum
 387 {
 388   GTK_PATH_WIDGET,
 389   GTK_PATH_WIDGET_CLASS,
 390   GTK_PATH_CLASS
 391 } GtkPathType;
 392
 393 /**
 394  * GtkPolicyType:
 395  * @GTK_POLICY_ALWAYS: The scrollbar is always visible.
 396  * @GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example,
 397  *  when all of a #GtkCList can not be seen.
 398  * @GTK_POLICY_NEVER: The scrollbar will never appear.
 399  *
 400  * Determines when a scroll bar will be visible.
 401  */
 402 typedef enum
 403 {
 404   GTK_POLICY_ALWAYS,
 405   GTK_POLICY_AUTOMATIC,
 406   GTK_POLICY_NEVER
 407 } GtkPolicyType;
 408
 409 /**
 410  * GtkPositionType:
 411  * @GTK_POS_LEFT: The feature is at the left edge.
 412  * @GTK_POS_RIGHT: The feature is at the right edge.
 413  * @GTK_POS_TOP: The feature is at the top edge.
 414  * @GTK_POS_BOTTOM: The feature is at the bottom edge.
 415  *
 416  * Describes which edge of a widget a certain feature is positioned at, e.g. the
 417  * tabs of a #GtkNotebook, the handle of a #GtkHandleBox or the label of a
 418  * #GtkScale.
 419  */
 420 typedef enum
 421 {
 422   GTK_POS_LEFT,
 423   GTK_POS_RIGHT,
 424   GTK_POS_TOP,
 425   GTK_POS_BOTTOM
 426 } GtkPositionType;
 427
 428 /**
 429  * GtkReliefStyle:
 430  * @GTK_RELIEF_NORMAL: Draw a normal relief.
 431  * @GTK_RELIEF_HALF: A half relief.
 432  * @GTK_RELIEF_NONE: No relief.
 433  *
 434  * Indicated the relief to be drawn around a #GtkButton.
 435  */
 436 typedef enum
 437 {
 438   GTK_RELIEF_NORMAL,
 439   GTK_RELIEF_HALF,
 440   GTK_RELIEF_NONE
 441 } GtkReliefStyle;
 442
 443 /**
 444  * GtkResizeMode:
 445  * @GTK_RESIZE_PARENT: Pass resize request to the parent
 446  * @GTK_RESIZE_QUEUE: Queue resizes on this widget
 447  * @GTK_RESIZE_IMMEDIATE: Resize immediately. Deprecated.
 448  */
 449 typedef enum
 450 {
 451   GTK_RESIZE_PARENT,
 452   GTK_RESIZE_QUEUE,
 453   GTK_RESIZE_IMMEDIATE
 454 } GtkResizeMode;
 455
 456 /* scrolling types */
 457 typedef enum
 458 {
 459   GTK_SCROLL_NONE,
 460   GTK_SCROLL_JUMP,
 461   GTK_SCROLL_STEP_BACKWARD,
 462   GTK_SCROLL_STEP_FORWARD,
 463   GTK_SCROLL_PAGE_BACKWARD,
 464   GTK_SCROLL_PAGE_FORWARD,
 465   GTK_SCROLL_STEP_UP,
 466   GTK_SCROLL_STEP_DOWN,
 467   GTK_SCROLL_PAGE_UP,
 468   GTK_SCROLL_PAGE_DOWN,
 469   GTK_SCROLL_STEP_LEFT,
 470   GTK_SCROLL_STEP_RIGHT,
 471   GTK_SCROLL_PAGE_LEFT,
 472   GTK_SCROLL_PAGE_RIGHT,
 473   GTK_SCROLL_START,
 474   GTK_SCROLL_END
 475 } GtkScrollType;
 476
 477 /**
 478  * GtkSelectionMode:
 479  * @GTK_SELECTION_NONE: No selection is possible.
 480  * @GTK_SELECTION_SINGLE: Zero or one element may be selected.
 481  * @GTK_SELECTION_BROWSE: Exactly one element is selected.
 482  *     In some circumstances, such as initially or during a search
 483  *     operation, it's possible for no element to be selected with
 484  *     %GTK_SELECTION_BROWSE. What is really enforced is that the user
 485  *     can't deselect a currently selected element except by selecting
 486  *     another element.
 487  * @GTK_SELECTION_MULTIPLE: Any number of elements may be selected.
 488  *      The Ctrl key may be used to enlarge the selection, and Shift
 489  *      key to select between the focus and the child pointed to.
 490  *      Some widgets may also allow Click-drag to select a range of elements.
 491  *
 492  * Used to control what selections users are allowed to make.
 493  */
 494 typedef enum
 495 {
 496   GTK_SELECTION_NONE,
 497   GTK_SELECTION_SINGLE,
 498   GTK_SELECTION_BROWSE,
 499   GTK_SELECTION_MULTIPLE
 500 } GtkSelectionMode;
 501
 502 /**
 503  * GtkShadowType:
 504  * @GTK_SHADOW_NONE: No outline.
 505  * @GTK_SHADOW_IN: The outline is bevelled inwards.
 506  * @GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
 507  * @GTK_SHADOW_ETCHED_IN: The outline has a sunken 3d appearance.
 508  * @GTK_SHADOW_ETCHED_OUT: The outline has a raised 3d appearance.
 509  *
 510  * Used to change the appearance of an outline typically provided by a #GtkFrame.
 511  */
 512 typedef enum
 513 {
 514   GTK_SHADOW_NONE,
 515   GTK_SHADOW_IN,
 516   GTK_SHADOW_OUT,
 517   GTK_SHADOW_ETCHED_IN,
 518   GTK_SHADOW_ETCHED_OUT
 519 } GtkShadowType;
 520
 521 /* Widget states */
 522
 523 /**
 524  * GtkStateType:
 525  * @GTK_STATE_NORMAL: State during normal operation.
 526  * @GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
 527  * @GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
 528  *                      the widget and the widget will respond to mouse clicks.
 529  * @GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
 530  * @GTK_STATE_INSENSITIVE: State indicating that the widget is
 531  *                         unresponsive to user actions.
 532  * @GTK_STATE_INCONSISTENT: The widget is inconsistent, such as checkbuttons
 533  *                          or radiobuttons that aren't either set to %TRUE nor %FALSE,
 534  *                          or buttons requiring the user attention.
 535  * @GTK_STATE_FOCUSED: The widget has the keyboard focus.
 536  *
 537  * This type indicates the current state of a widget; the state determines how
 538  * the widget is drawn. The #GtkStateType enumeration is also used to
 539  * identify different colors in a #GtkStyle for drawing, so states can be
 540  * used for subparts of a widget as well as entire widgets.
 541  */
 542 typedef enum
 543 {
 544   GTK_STATE_NORMAL,
 545   GTK_STATE_ACTIVE,
 546   GTK_STATE_PRELIGHT,
 547   GTK_STATE_SELECTED,
 548   GTK_STATE_INSENSITIVE,
 549   GTK_STATE_INCONSISTENT,
 550   GTK_STATE_FOCUSED
 551 } GtkStateType;
 552
 553 /**
 554  * GtkToolbarStyle:
 555  * @GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
 556  * @GTK_TOOLBAR_TEXT: Buttons display only text labels in the toolbar.
 557  * @GTK_TOOLBAR_BOTH: Buttons display text and icons in the toolbar.
 558  * @GTK_TOOLBAR_BOTH_HORIZ: Buttons display icons and text alongside each
 559  *  other, rather than vertically stacked
 560  *
 561  * Used to customize the appearance of a #GtkToolbar. Note that
 562  * setting the toolbar style overrides the user's preferences
 563  * for the default toolbar style.  Note that if the button has only
 564  * a label set and GTK_TOOLBAR_ICONS is used, the label will be
 565  * visible, and vice versa.
 566  */
 567 typedef enum
 568 {
 569   GTK_TOOLBAR_ICONS,
 570   GTK_TOOLBAR_TEXT,
 571   GTK_TOOLBAR_BOTH,
 572   GTK_TOOLBAR_BOTH_HORIZ
 573 } GtkToolbarStyle;
 574
 575 /**
 576  * GtkWindowPosition:
 577  * @GTK_WIN_POS_NONE: No influence is made on placement.
 578  * @GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen.
 579  * @GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position.
 580  * @GTK_WIN_POS_CENTER_ALWAYS: Keep window centered as it changes size, etc.
 581  * @GTK_WIN_POS_CENTER_ON_PARENT: Center the window on its transient
 582  *  parent (see gtk_window_set_transient_for()).
 583  *
 584  * Window placement can be influenced using this enumeration. Note that
 585  * using #GTK_WIN_POS_CENTER_ALWAYS is almost always a bad idea.
 586  * It won't necessarily work well with all window managers or on all windowing systems.
 587  */
 588 typedef enum
 589 {
 590   GTK_WIN_POS_NONE,
 591   GTK_WIN_POS_CENTER,
 592   GTK_WIN_POS_MOUSE,
 593   GTK_WIN_POS_CENTER_ALWAYS,
 594   GTK_WIN_POS_CENTER_ON_PARENT
 595 } GtkWindowPosition;
 596
 597 /**
 598  * GtkWindowType:
 599  * @GTK_WINDOW_TOPLEVEL: A regular window, such as a dialog.
 600  * @GTK_WINDOW_POPUP: A special window such as a tooltip.
 601  *
 602  * A #GtkWindow can be one of these types. Most things you'd consider a
 603  * "window" should have type #GTK_WINDOW_TOPLEVEL; windows with this type
 604  * are managed by the window manager and have a frame by default (call
 605  * gtk_window_set_decorated() to toggle the frame).  Windows with type
 606  * #GTK_WINDOW_POPUP are ignored by the window manager; window manager
 607  * keybindings won't work on them, the window manager won't decorate the
 608  * window with a frame, many GTK+ features that rely on the window
 609  * manager will not work (e.g. resize grips and
 610  * maximization/minimization). #GTK_WINDOW_POPUP is used to implement
 611  * widgets such as #GtkMenu or tooltips that you normally don't think of
 612  * as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL.
 613  * In particular, do not use #GTK_WINDOW_POPUP just to turn off
 614  * the window borders; use gtk_window_set_decorated() for that.
 615  */
 616 typedef enum
 617 {
 618   GTK_WINDOW_TOPLEVEL,
 619   GTK_WINDOW_POPUP
 620 } GtkWindowType;
 621
 622 /**
 623  * GtkWrapMode:
 624  * @GTK_WRAP_NONE: do not wrap lines; just make the text area wider
 625  * @GTK_WRAP_CHAR: wrap text, breaking lines anywhere the cursor can
 626  *     appear (between characters, usually - if you want to be technical,
 627  *     between graphemes, see pango_get_log_attrs())
 628  * @GTK_WRAP_WORD: wrap text, breaking lines in between words
 629  * @GTK_WRAP_WORD_CHAR: wrap text, breaking lines in between words, or if
 630  *     that is not enough, also between graphemes
 631  *
 632  * Describes a type of line wrapping.
 633  */
 634 typedef enum
 635 {
 636   GTK_WRAP_NONE,
 637   GTK_WRAP_CHAR,
 638   GTK_WRAP_WORD,
 639   GTK_WRAP_WORD_CHAR
 640 } GtkWrapMode;
 641
 642 /**
 643  * GtkSortType:
 644  * @GTK_SORT_ASCENDING: Sorting is in ascending order.
 645  * @GTK_SORT_DESCENDING: Sorting is in descending order.
 646  *
 647  * Determines the direction of a sort.
 648  */
 649 typedef enum
 650 {
 651   GTK_SORT_ASCENDING,
 652   GTK_SORT_DESCENDING
 653 } GtkSortType;
 654
 655 /* Style for gtk input method preedit/status */
 656 typedef enum
 657 {
 658   GTK_IM_PREEDIT_NOTHING,
 659   GTK_IM_PREEDIT_CALLBACK,
 660   GTK_IM_PREEDIT_NONE
 661 } GtkIMPreeditStyle;
 662
 663 typedef enum
 664 {
 665   GTK_IM_STATUS_NOTHING,
 666   GTK_IM_STATUS_CALLBACK,
 667   GTK_IM_STATUS_NONE
 668 } GtkIMStatusStyle;
 669
 670 /**
 671  * GtkPackDirection:
 672  * @GTK_PACK_DIRECTION_LTR: Widgets are packed left-to-right
 673  * @GTK_PACK_DIRECTION_RTL: Widgets are packed right-to-left
 674  * @GTK_PACK_DIRECTION_TTB: Widgets are packed top-to-bottom
 675  * @GTK_PACK_DIRECTION_BTT: Widgets are packed bottom-to-top
 676  *
 677  * Determines how widgets should be packed inside menubars
 678  * and menuitems contained in menubars.
 679  */
 680 typedef enum
 681 {
 682   GTK_PACK_DIRECTION_LTR,
 683   GTK_PACK_DIRECTION_RTL,
 684   GTK_PACK_DIRECTION_TTB,
 685   GTK_PACK_DIRECTION_BTT
 686 } GtkPackDirection;
 687
 688 typedef enum
 689 {
 690   GTK_PRINT_PAGES_ALL,
 691   GTK_PRINT_PAGES_CURRENT,
 692   GTK_PRINT_PAGES_RANGES,
 693   GTK_PRINT_PAGES_SELECTION
 694 } GtkPrintPages;
 695
 696 typedef enum
 697 {
 698   GTK_PAGE_SET_ALL,
 699   GTK_PAGE_SET_EVEN,
 700   GTK_PAGE_SET_ODD
 701 } GtkPageSet;
 702
 703 /**
 704  * GtkNumberUpLayout:
 705  * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM: <inlinegraphic valign="middle" fileref="layout-lrtb.png" format="PNG"></inlinegraphic>
 706  * @GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP: <inlinegraphic valign="middle" fileref="layout-lrbt.png" format="PNG"></inlinegraphic>
 707  * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM: <inlinegraphic valign="middle" fileref="layout-rltb.png" format="PNG"></inlinegraphic>
 708  * @GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP: <inlinegraphic valign="middle" fileref="layout-rlbt.png" format="PNG"></inlinegraphic>
 709  * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT: <inlinegraphic valign="middle" fileref="layout-tblr.png" format="PNG"></inlinegraphic>
 710  * @GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT: <inlinegraphic valign="middle" fileref="layout-tbrl.png" format="PNG"></inlinegraphic>
 711  * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT: <inlinegraphic valign="middle" fileref="layout-btlr.png" format="PNG"></inlinegraphic>
 712  * @GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT: <inlinegraphic valign="middle" fileref="layout-btrl.png" format="PNG"></inlinegraphic>
 713  *
 714  * Used to determine the layout of pages on a sheet when printing
 715  * multiple pages per sheet.
 716  */
 717 typedef enum
 718 {
 719   GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM, /*< nick=lrtb >*/
 720   GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP, /*< nick=lrbt >*/
 721   GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM, /*< nick=rltb >*/
 722   GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP, /*< nick=rlbt >*/
 723   GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT, /*< nick=tblr >*/
 724   GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT, /*< nick=tbrl >*/
 725   GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT, /*< nick=btlr >*/
 726   GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT  /*< nick=btrl >*/
 727 } GtkNumberUpLayout;
 728
 729 typedef enum
 730 {
 731   GTK_PAGE_ORIENTATION_PORTRAIT,
 732   GTK_PAGE_ORIENTATION_LANDSCAPE,
 733   GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT,
 734   GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE
 735 } GtkPageOrientation;
 736
 737 typedef enum
 738 {
 739   GTK_PRINT_QUALITY_LOW,
 740   GTK_PRINT_QUALITY_NORMAL,
 741   GTK_PRINT_QUALITY_HIGH,
 742   GTK_PRINT_QUALITY_DRAFT
 743 } GtkPrintQuality;
 744
 745 typedef enum
 746 {
 747   GTK_PRINT_DUPLEX_SIMPLEX,
 748   GTK_PRINT_DUPLEX_HORIZONTAL,
 749   GTK_PRINT_DUPLEX_VERTICAL
 750 } GtkPrintDuplex;
 751
 752
 753 typedef enum
 754 {
 755   GTK_UNIT_NONE,
 756   GTK_UNIT_POINTS,
 757   GTK_UNIT_INCH,
 758   GTK_UNIT_MM
 759 } GtkUnit;
 760
 761 #define GTK_UNIT_PIXEL GTK_UNIT_NONE
 762
 763 /**
 764  * GtkTreeViewGridLines:
 765  * @GTK_TREE_VIEW_GRID_LINES_NONE: No grid lines.
 766  * @GTK_TREE_VIEW_GRID_LINES_HORIZONTAL: Horizontal grid lines.
 767  * @GTK_TREE_VIEW_GRID_LINES_VERTICAL: Vertical grid lines.
 768  * @GTK_TREE_VIEW_GRID_LINES_BOTH: Horizontal and vertical grid lines.
 769  *
 770  * Used to indicate which grid lines to draw in a tree view.
 771  */
 772 typedef enum
 773 {
 774   GTK_TREE_VIEW_GRID_LINES_NONE,
 775   GTK_TREE_VIEW_GRID_LINES_HORIZONTAL,
 776   GTK_TREE_VIEW_GRID_LINES_VERTICAL,
 777   GTK_TREE_VIEW_GRID_LINES_BOTH
 778 } GtkTreeViewGridLines;
 779
 780 /**
 781  * GtkDragResult:
 782  * @GTK_DRAG_RESULT_SUCCESS: The drag operation was successful.
 783  * @GTK_DRAG_RESULT_NO_TARGET: No suitable drag target.
 784  * @GTK_DRAG_RESULT_USER_CANCELLED: The user cancelled the drag operation.
 785  * @GTK_DRAG_RESULT_TIMEOUT_EXPIRED: The drag operation timed out.
 786  * @GTK_DRAG_RESULT_GRAB_BROKEN: The pointer or keyboard grab used
 787  *  for the drag operation was broken.
 788  * @GTK_DRAG_RESULT_ERROR: The drag operation failed due to some
 789  *  unspecified error.
 790  *
 791  * Gives an indication why a drag operation failed.
 792  * The value can by obtained by connecting to the
 793  * #GtkWidget::drag-failed signal.
 794  */
 795 typedef enum
 796 {
 797   GTK_DRAG_RESULT_SUCCESS,
 798   GTK_DRAG_RESULT_NO_TARGET,
 799   GTK_DRAG_RESULT_USER_CANCELLED,
 800   GTK_DRAG_RESULT_TIMEOUT_EXPIRED,
 801   GTK_DRAG_RESULT_GRAB_BROKEN,
 802   GTK_DRAG_RESULT_ERROR
 803 } GtkDragResult;
 804
 805 /**
 806  * GtkSizeGroupMode:
 807  * @GTK_SIZE_GROUP_NONE: group has no effect
 808  * @GTK_SIZE_GROUP_HORIZONTAL: group affects horizontal requisition
 809  * @GTK_SIZE_GROUP_VERTICAL: group affects vertical requisition
 810  * @GTK_SIZE_GROUP_BOTH: group affects both horizontal and vertical requisition
 811  *
 812  * The mode of the size group determines the directions in which the size
 813  * group affects the requested sizes of its component widgets.
 814  **/
 815 typedef enum {
 816   GTK_SIZE_GROUP_NONE,
 817   GTK_SIZE_GROUP_HORIZONTAL,
 818   GTK_SIZE_GROUP_VERTICAL,
 819   GTK_SIZE_GROUP_BOTH
 820 } GtkSizeGroupMode;
 821
 822 /**
 823  * GtkSizeRequestMode:
 824  * @GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH: Prefer height-for-width geometry management
 825  * @GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT: Prefer width-for-height geometry management
 826  * @GTK_SIZE_REQUEST_CONSTANT_SIZE: Don't trade height-for-width or width-for-height
 827  *
 828  * Specifies a preference for height-for-width or
 829  * width-for-height geometry management.
 830  */
 831 typedef enum
 832 {
 833   GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH = 0,
 834   GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT,
 835   GTK_SIZE_REQUEST_CONSTANT_SIZE
 836 } GtkSizeRequestMode;
 837
 838 /**
 839  * GtkScrollablePolicy:
 840  * @GTK_SCROLL_MINIMUM: Scrollable adjustments are based on the minimum size
 841  * @GTK_SCROLL_NATURAL: Scrollable adjustments are based on the natural size
 842  *
 843  * Defines the policy to be used in a scrollable widget when updating
 844  * the scrolled window adjustments in a given orientation.
 845  */
 846 typedef enum
 847 {
 848   GTK_SCROLL_MINIMUM = 0,
 849   GTK_SCROLL_NATURAL
 850 } GtkScrollablePolicy;
 851
 852 /**
 853  * GtkStateFlags:
 854  * @GTK_STATE_FLAG_NORMAL: State during normal operation.
 855  * @GTK_STATE_FLAG_ACTIVE: Widget is active.
 856  * @GTK_STATE_FLAG_PRELIGHT: Widget has a mouse pointer over it.
 857  * @GTK_STATE_FLAG_SELECTED: Widget is selected.
 858  * @GTK_STATE_FLAG_INSENSITIVE: Widget is insensitive.
 859  * @GTK_STATE_FLAG_INCONSISTENT: Widget is inconsistent.
 860  * @GTK_STATE_FLAG_FOCUSED: Widget has the keyboard focus.
 861  * @GTK_STATE_FLAG_BACKDROP: Widget is in a background toplevel window.
 862  * @GTK_STATE_FLAG_DIR_LTR: Widget is in left-to-right text direction. Since 3.8
 863  * @GTK_STATE_FLAG_DIR_RTL: Widget is in right-to-left text direction. Since 3.8
 864  *
 865  * Describes a widget state. Widget states are used to match the widget
 866  * against CSS pseudo-classes. Note that GTK extends the regular CSS
 867  * classes and sometimes uses different names.
 868  */
 869 typedef enum
 870 {
 871   GTK_STATE_FLAG_NORMAL       = 0,
 872   GTK_STATE_FLAG_ACTIVE       = 1 << 0,
 873   GTK_STATE_FLAG_PRELIGHT     = 1 << 1,
 874   GTK_STATE_FLAG_SELECTED     = 1 << 2,
 875   GTK_STATE_FLAG_INSENSITIVE  = 1 << 3,
 876   GTK_STATE_FLAG_INCONSISTENT = 1 << 4,
 877   GTK_STATE_FLAG_FOCUSED      = 1 << 5,
 878   GTK_STATE_FLAG_BACKDROP     = 1 << 6,
 879   GTK_STATE_FLAG_DIR_LTR      = 1 << 7,
 880   GTK_STATE_FLAG_DIR_RTL      = 1 << 8
 881 } GtkStateFlags;
 882
 883 /**
 884  * GtkRegionFlags:
 885  * @GTK_REGION_EVEN: Region has an even number within a set.
 886  * @GTK_REGION_ODD: Region has an odd number within a set.
 887  * @GTK_REGION_FIRST: Region is the first one within a set.
 888  * @GTK_REGION_LAST: Region is the last one within a set.
 889  * @GTK_REGION_ONLY: Region is the only one within a set.
 890  * @GTK_REGION_SORTED: Region is part of a sorted area.
 891  *
 892  * Describes a region within a widget.
 893  */
 894 typedef enum {
 895   GTK_REGION_EVEN    = 1 << 0,
 896   GTK_REGION_ODD     = 1 << 1,
 897   GTK_REGION_FIRST   = 1 << 2,
 898   GTK_REGION_LAST    = 1 << 3,
 899   GTK_REGION_ONLY    = 1 << 4,
 900   GTK_REGION_SORTED  = 1 << 5
 901 } GtkRegionFlags;
 902
 903 /**
 904  * GtkJunctionSides:
 905  * @GTK_JUNCTION_NONE: No junctions.
 906  * @GTK_JUNCTION_CORNER_TOPLEFT: Element connects on the top-left corner.
 907  * @GTK_JUNCTION_CORNER_TOPRIGHT: Element connects on the top-right corner.
 908  * @GTK_JUNCTION_CORNER_BOTTOMLEFT: Element connects on the bottom-left corner.
 909  * @GTK_JUNCTION_CORNER_BOTTOMRIGHT: Element connects on the bottom-right corner.
 910  * @GTK_JUNCTION_TOP: Element connects on the top side.
 911  * @GTK_JUNCTION_BOTTOM: Element connects on the bottom side.
 912  * @GTK_JUNCTION_LEFT: Element connects on the left side.
 913  * @GTK_JUNCTION_RIGHT: Element connects on the right side.
 914  *
 915  * Describes how a rendered element connects to adjacent elements.
 916  */
 917 typedef enum {
 918   GTK_JUNCTION_NONE   = 0,
 919   GTK_JUNCTION_CORNER_TOPLEFT = 1 << 0,
 920   GTK_JUNCTION_CORNER_TOPRIGHT = 1 << 1,
 921   GTK_JUNCTION_CORNER_BOTTOMLEFT = 1 << 2,
 922   GTK_JUNCTION_CORNER_BOTTOMRIGHT = 1 << 3,
 923   GTK_JUNCTION_TOP    = (GTK_JUNCTION_CORNER_TOPLEFT | GTK_JUNCTION_CORNER_TOPRIGHT),
 924   GTK_JUNCTION_BOTTOM = (GTK_JUNCTION_CORNER_BOTTOMLEFT | GTK_JUNCTION_CORNER_BOTTOMRIGHT),
 925   GTK_JUNCTION_LEFT   = (GTK_JUNCTION_CORNER_TOPLEFT | GTK_JUNCTION_CORNER_BOTTOMLEFT),
 926   GTK_JUNCTION_RIGHT  = (GTK_JUNCTION_CORNER_TOPRIGHT | GTK_JUNCTION_CORNER_BOTTOMRIGHT)
 927 } GtkJunctionSides;
 928
 929 /**
 930  * GtkBorderStyle:
 931  * @GTK_BORDER_STYLE_NONE: No visible border
 932  * @GTK_BORDER_STYLE_SOLID: A single line segment
 933  * @GTK_BORDER_STYLE_INSET: Looks as if the content is sunken into the canvas
 934  * @GTK_BORDER_STYLE_OUTSET: Looks as if the content is coming out of the canvas
 935  * @GTK_BORDER_STYLE_HIDDEN: Same as @GTK_BORDER_STYLE_NONE
 936  * @GTK_BORDER_STYLE_DOTTED: A series of round dots
 937  * @GTK_BORDER_STYLE_DASHED: A series of square-ended dashes
 938  * @GTK_BORDER_STYLE_DOUBLE: Two parallel lines with some space between them
 939  * @GTK_BORDER_STYLE_GROOVE: Looks as if it were carved in the canvas
 940  * @GTK_BORDER_STYLE_RIDGE: Looks as if it were coming out of the canvas
 941  *
 942  * Describes how the border of a UI element should be rendered.
 943  */
 944 typedef enum {
 945   GTK_BORDER_STYLE_NONE,
 946   GTK_BORDER_STYLE_SOLID,
 947   GTK_BORDER_STYLE_INSET,
 948   GTK_BORDER_STYLE_OUTSET,
 949   GTK_BORDER_STYLE_HIDDEN,
 950   GTK_BORDER_STYLE_DOTTED,
 951   GTK_BORDER_STYLE_DASHED,
 952   GTK_BORDER_STYLE_DOUBLE,
 953   GTK_BORDER_STYLE_GROOVE,
 954   GTK_BORDER_STYLE_RIDGE
 955 } GtkBorderStyle;
 956
 957 /**
 958  * GtkLevelBarMode:
 959  * @GTK_LEVEL_BAR_MODE_CONTINUOUS: the bar has a continuous mode
 960  * @GTK_LEVEL_BAR_MODE_DISCRETE: the bar has a discrete mode
 961  *
 962  * Describes how #GtkLevelBar contents should be rendered.
 963  * Note that this enumeration could be extended with additional modes
 964  * in the future.
 965  *
 966  * Since: 3.6
 967  */
 968 typedef enum {
 969   GTK_LEVEL_BAR_MODE_CONTINUOUS,
 970   GTK_LEVEL_BAR_MODE_DISCRETE
 971 } GtkLevelBarMode;
 972
 973 G_END_DECLS
 974
 975 /**
 976  * GtkInputPurpose:
 977  * @GTK_INPUT_PURPOSE_FREE_FORM: Allow any character
 978  * @GTK_INPUT_PURPOSE_ALPHA: Allow only alphabetic characters
 979  * @GTK_INPUT_PURPOSE_DIGITS: Allow only digits
 980  * @GTK_INPUT_PURPOSE_NUMBER: Edited field expects numbers
 981  * @GTK_INPUT_PURPOSE_PHONE: Edited field expects phone number
 982  * @GTK_INPUT_PURPOSE_URL: Edited field expects URL
 983  * @GTK_INPUT_PURPOSE_EMAIL: Edited field expects email address
 984  * @GTK_INPUT_PURPOSE_NAME: Edited field expects the name of a person
 985  * @GTK_INPUT_PURPOSE_PASSWORD: Like @GTK_INPUT_PURPOSE_FREE_FORM, but characters are hidden
 986  * @GTK_INPUT_PURPOSE_PIN: Like @GTK_INPUT_PURPOSE_DIGITS, but characters are hidden
 987  *
 988  * Describes primary purpose of the input widget. This information is
 989  * useful for on-screen keyboards and similar input methods to decide
 990  * which keys should be presented to the user.
 991  *
 992  * Note that the purpose is not meant to impose a totally strict rule
 993  * about allowed characters, and does not replace input validation.
 994  * It is fine for an on-screen keyboard to let the user override the
 995  * character set restriction that is expressed by the purpose. The
 996  * application is expected to validate the entry contents, even if
 997  * it specified a purpose.
 998  *
 999  * The difference between @GTK_INPUT_PURPOSE_DIGITS and
1000  * @GTK_INPUT_PURPOSE_NUMBER is that the former accepts only digits
1001  * while the latter also some punctuation (like commas or points, plus,
1002  * minus) and 'e' or 'E' as in 3.14E+000.
1003  *
1004  * This enumeration may be extended in the future; input methods should
1005  * interpret unknown values as 'free form'.
1006  *
1007  * Since: 3.6
1008  */
1009 typedef enum
1010 {
1011   GTK_INPUT_PURPOSE_FREE_FORM,
1012   GTK_INPUT_PURPOSE_ALPHA,
1013   GTK_INPUT_PURPOSE_DIGITS,
1014   GTK_INPUT_PURPOSE_NUMBER,
1015   GTK_INPUT_PURPOSE_PHONE,
1016   GTK_INPUT_PURPOSE_URL,
1017   GTK_INPUT_PURPOSE_EMAIL,
1018   GTK_INPUT_PURPOSE_NAME,
1019   GTK_INPUT_PURPOSE_PASSWORD,
1020   GTK_INPUT_PURPOSE_PIN
1021 } GtkInputPurpose;
1022
1023 /**
1024  * GtkInputHints:
1025  * @GTK_INPUT_HINT_NONE: No special behaviour suggested
1026  * @GTK_INPUT_HINT_SPELLCHECK: Suggest checking for typos
1027  * @GTK_INPUT_HINT_NO_SPELLCHECK: Suggest not checking for typos
1028  * @GTK_INPUT_HINT_WORD_COMPLETION: Suggest word completion
1029  * @GTK_INPUT_HINT_LOWERCASE: Suggest to convert all text to lowercase
1030  * @GTK_INPUT_HINT_UPPERCASE_CHARS: Suggest to capitalize all text
1031  * @GTK_INPUT_HINT_UPPERCASE_WORDS: Suggest to capitalize the first
1032  *     character of each word
1033  * @GTK_INPUT_HINT_UPPERCASE_SENTENCES: Suggest to capitalize the
1034  *     first word of each sentence
1035  * @GTK_INPUT_HINT_INHIBIT_OSK: Suggest to not show an onscreen keyboard
1036  *     (e.g for a calculator that already has all the keys).
1037  *
1038  * Describes hints that might be taken into account by input methods
1039  * or applications. Note that input methods may already tailor their
1040  * behaviour according to the #GtkInputPurpose of the entry.
1041  *
1042  * Some common sense is expected when using these flags - mixing
1043  * @GTK_INPUT_HINT_LOWERCASE with any of the uppercase hints makes no sense.
1044  *
1045  * This enumeration may be extended in the future; input methods should
1046  * ignore unknown values.
1047  *
1048  * Since: 3.6
1049  */
1050 typedef enum
1051 {
1052   GTK_INPUT_HINT_NONE                = 0,
1053   GTK_INPUT_HINT_SPELLCHECK          = 1 << 0,
1054   GTK_INPUT_HINT_NO_SPELLCHECK       = 1 << 1,
1055   GTK_INPUT_HINT_WORD_COMPLETION     = 1 << 2,
1056   GTK_INPUT_HINT_LOWERCASE           = 1 << 3,
1057   GTK_INPUT_HINT_UPPERCASE_CHARS     = 1 << 4,
1058   GTK_INPUT_HINT_UPPERCASE_WORDS     = 1 << 5,
1059   GTK_INPUT_HINT_UPPERCASE_SENTENCES = 1 << 6,
1060   GTK_INPUT_HINT_INHIBIT_OSK         = 1 << 7
1061 } GtkInputHints;
1062
1063 #endif /* __GTK_ENUMS_H__ */