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