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 G_BEGIN_DECLS
  37
  38 /* Anchor types */
  39 typedef enum
  40 {
  41   GTK_ANCHOR_CENTER,
  42   GTK_ANCHOR_NORTH,
  43   GTK_ANCHOR_NORTH_WEST,
  44   GTK_ANCHOR_NORTH_EAST,
  45   GTK_ANCHOR_SOUTH,
  46   GTK_ANCHOR_SOUTH_WEST,
  47   GTK_ANCHOR_SOUTH_EAST,
  48   GTK_ANCHOR_WEST,
  49   GTK_ANCHOR_EAST,
  50   GTK_ANCHOR_N          = GTK_ANCHOR_NORTH,
  51   GTK_ANCHOR_NW         = GTK_ANCHOR_NORTH_WEST,
  52   GTK_ANCHOR_NE         = GTK_ANCHOR_NORTH_EAST,
  53   GTK_ANCHOR_S          = GTK_ANCHOR_SOUTH,
  54   GTK_ANCHOR_SW         = GTK_ANCHOR_SOUTH_WEST,
  55   GTK_ANCHOR_SE         = GTK_ANCHOR_SOUTH_EAST,
  56   GTK_ANCHOR_W          = GTK_ANCHOR_WEST,
  57   GTK_ANCHOR_E          = GTK_ANCHOR_EAST
  58 } GtkAnchorType;
  59
  60 /* Arrow placement */
  61 typedef enum
  62 {
  63   GTK_ARROWS_BOTH,
  64   GTK_ARROWS_START,
  65   GTK_ARROWS_END
  66 } GtkArrowPlacement;
  67
  68 /* Arrow types */
  69 typedef enum
  70 {
  71   GTK_ARROW_UP,
  72   GTK_ARROW_DOWN,
  73   GTK_ARROW_LEFT,
  74   GTK_ARROW_RIGHT,
  75   GTK_ARROW_NONE
  76 } GtkArrowType;
  77
  78 /* Attach options (for tables) */
  79 typedef enum
  80 {
  81   GTK_EXPAND = 1 << 0,
  82   GTK_SHRINK = 1 << 1,
  83   GTK_FILL   = 1 << 2
  84 } GtkAttachOptions;
  85
  86 /* Button box styles */
  87 typedef enum
  88 {
  89   GTK_BUTTONBOX_DEFAULT_STYLE,
  90   GTK_BUTTONBOX_SPREAD,
  91   GTK_BUTTONBOX_EDGE,
  92   GTK_BUTTONBOX_START,
  93   GTK_BUTTONBOX_END,
  94   GTK_BUTTONBOX_CENTER
  95 } GtkButtonBoxStyle;
  96
  97 typedef enum
  98 {
  99   GTK_DELETE_CHARS,
 100   GTK_DELETE_WORD_ENDS,           /* delete only the portion of the word to the
 101                                    * left/right of cursor if we're in the middle
 102                                    * of a word */
 103   GTK_DELETE_WORDS,
 104   GTK_DELETE_DISPLAY_LINES,
 105   GTK_DELETE_DISPLAY_LINE_ENDS,
 106   GTK_DELETE_PARAGRAPH_ENDS,      /* like C-k in Emacs (or its reverse) */
 107   GTK_DELETE_PARAGRAPHS,          /* C-k in pico, kill whole line */
 108   GTK_DELETE_WHITESPACE           /* M-\ in Emacs */
 109 } GtkDeleteType;
 110
 111 /* Focus movement types */
 112 typedef enum
 113 {
 114   GTK_DIR_TAB_FORWARD,
 115   GTK_DIR_TAB_BACKWARD,
 116   GTK_DIR_UP,
 117   GTK_DIR_DOWN,
 118   GTK_DIR_LEFT,
 119   GTK_DIR_RIGHT
 120 } GtkDirectionType;
 121
 122 /* Expander styles */
 123 typedef enum
 124 {
 125   GTK_EXPANDER_COLLAPSED,
 126   GTK_EXPANDER_SEMI_COLLAPSED,
 127   GTK_EXPANDER_SEMI_EXPANDED,
 128   GTK_EXPANDER_EXPANDED
 129 } GtkExpanderStyle;
 130
 131 /* Built-in stock icon sizes */
 132 typedef enum
 133 {
 134   GTK_ICON_SIZE_INVALID,
 135   GTK_ICON_SIZE_MENU,
 136   GTK_ICON_SIZE_SMALL_TOOLBAR,
 137   GTK_ICON_SIZE_LARGE_TOOLBAR,
 138   GTK_ICON_SIZE_BUTTON,
 139   GTK_ICON_SIZE_DND,
 140   GTK_ICON_SIZE_DIALOG
 141 } GtkIconSize;
 142
 143 /* automatic sensitivity */
 144 typedef enum
 145 {
 146   GTK_SENSITIVITY_AUTO,
 147   GTK_SENSITIVITY_ON,
 148   GTK_SENSITIVITY_OFF
 149 } GtkSensitivityType;
 150
 151 /* Reading directions for text */
 152 typedef enum
 153 {
 154   GTK_TEXT_DIR_NONE,
 155   GTK_TEXT_DIR_LTR,
 156   GTK_TEXT_DIR_RTL
 157 } GtkTextDirection;
 158
 159 /* justification for label and maybe other widgets (text?) */
 160 typedef enum
 161 {
 162   GTK_JUSTIFY_LEFT,
 163   GTK_JUSTIFY_RIGHT,
 164   GTK_JUSTIFY_CENTER,
 165   GTK_JUSTIFY_FILL
 166 } GtkJustification;
 167
 168 /* Menu keyboard movement types */
 169 typedef enum
 170 {
 171   GTK_MENU_DIR_PARENT,
 172   GTK_MENU_DIR_CHILD,
 173   GTK_MENU_DIR_NEXT,
 174   GTK_MENU_DIR_PREV
 175 } GtkMenuDirectionType;
 176
 177 /**
 178  * GtkMessageType:
 179  * @GTK_MESSAGE_INFO: Informational message
 180  * @GTK_MESSAGE_WARNING: Nonfatal warning message
 181  * @GTK_MESSAGE_QUESTION: Question requiring a choice
 182  * @GTK_MESSAGE_ERROR: Fatal error message
 183  * @GTK_MESSAGE_OTHER: None of the above, doesn't get an icon
 184  *
 185  * The type of message being displayed in the dialog.
 186  */
 187 typedef enum
 188 {
 189   GTK_MESSAGE_INFO,
 190   GTK_MESSAGE_WARNING,
 191   GTK_MESSAGE_QUESTION,
 192   GTK_MESSAGE_ERROR,
 193   GTK_MESSAGE_OTHER
 194 } GtkMessageType;
 195
 196 typedef enum
 197 {
 198   GTK_PIXELS,
 199   GTK_INCHES,
 200   GTK_CENTIMETERS
 201 } GtkMetricType;
 202
 203 typedef enum
 204 {
 205   GTK_MOVEMENT_LOGICAL_POSITIONS, /* move by forw/back graphemes */
 206   GTK_MOVEMENT_VISUAL_POSITIONS,  /* move by left/right graphemes */
 207   GTK_MOVEMENT_WORDS,             /* move by forward/back words */
 208   GTK_MOVEMENT_DISPLAY_LINES,     /* move up/down lines (wrapped lines) */
 209   GTK_MOVEMENT_DISPLAY_LINE_ENDS, /* move to either end of a line */
 210   GTK_MOVEMENT_PARAGRAPHS,        /* move up/down paragraphs (newline-ended lines) */
 211   GTK_MOVEMENT_PARAGRAPH_ENDS,    /* move to either end of a paragraph */
 212   GTK_MOVEMENT_PAGES,             /* move by pages */
 213   GTK_MOVEMENT_BUFFER_ENDS,       /* move to ends of the buffer */
 214   GTK_MOVEMENT_HORIZONTAL_PAGES   /* move horizontally by pages */
 215 } GtkMovementStep;
 216
 217 typedef enum
 218 {
 219   GTK_SCROLL_STEPS,
 220   GTK_SCROLL_PAGES,
 221   GTK_SCROLL_ENDS,
 222   GTK_SCROLL_HORIZONTAL_STEPS,
 223   GTK_SCROLL_HORIZONTAL_PAGES,
 224   GTK_SCROLL_HORIZONTAL_ENDS
 225 } GtkScrollStep;
 226
 227 /* Orientation for toolbars, etc. */
 228 typedef enum
 229 {
 230   GTK_ORIENTATION_HORIZONTAL,
 231   GTK_ORIENTATION_VERTICAL
 232 } GtkOrientation;
 233
 234 /* Placement type for scrolled window */
 235 typedef enum
 236 {
 237   GTK_CORNER_TOP_LEFT,
 238   GTK_CORNER_BOTTOM_LEFT,
 239   GTK_CORNER_TOP_RIGHT,
 240   GTK_CORNER_BOTTOM_RIGHT
 241 } GtkCornerType;
 242
 243 /* Packing types (for boxes) */
 244 typedef enum
 245 {
 246   GTK_PACK_START,
 247   GTK_PACK_END
 248 } GtkPackType;
 249
 250 /* priorities for path lookups */
 251 typedef enum
 252 {
 253   GTK_PATH_PRIO_LOWEST      = 0,
 254   GTK_PATH_PRIO_GTK         = 4,
 255   GTK_PATH_PRIO_APPLICATION = 8,
 256   GTK_PATH_PRIO_THEME       = 10,
 257   GTK_PATH_PRIO_RC          = 12,
 258   GTK_PATH_PRIO_HIGHEST     = 15
 259 } GtkPathPriorityType;
 260 #define GTK_PATH_PRIO_MASK 0x0f
 261
 262 /* widget path types */
 263 typedef enum
 264 {
 265   GTK_PATH_WIDGET,
 266   GTK_PATH_WIDGET_CLASS,
 267   GTK_PATH_CLASS
 268 } GtkPathType;
 269
 270 /* Scrollbar policy types (for scrolled windows) */
 271 typedef enum
 272 {
 273   GTK_POLICY_ALWAYS,
 274   GTK_POLICY_AUTOMATIC,
 275   GTK_POLICY_NEVER
 276 } GtkPolicyType;
 277
 278 typedef enum
 279 {
 280   GTK_POS_LEFT,
 281   GTK_POS_RIGHT,
 282   GTK_POS_TOP,
 283   GTK_POS_BOTTOM
 284 } GtkPositionType;
 285
 286 /* Style for buttons */
 287 typedef enum
 288 {
 289   GTK_RELIEF_NORMAL,
 290   GTK_RELIEF_HALF,
 291   GTK_RELIEF_NONE
 292 } GtkReliefStyle;
 293
 294 /* Resize type */
 295 typedef enum
 296 {
 297   GTK_RESIZE_PARENT,            /* Pass resize request to the parent */
 298   GTK_RESIZE_QUEUE,             /* Queue resizes on this widget */
 299   GTK_RESIZE_IMMEDIATE          /* Perform the resizes now */
 300 } GtkResizeMode;
 301
 302 /* scrolling types */
 303 typedef enum
 304 {
 305   GTK_SCROLL_NONE,
 306   GTK_SCROLL_JUMP,
 307   GTK_SCROLL_STEP_BACKWARD,
 308   GTK_SCROLL_STEP_FORWARD,
 309   GTK_SCROLL_PAGE_BACKWARD,
 310   GTK_SCROLL_PAGE_FORWARD,
 311   GTK_SCROLL_STEP_UP,
 312   GTK_SCROLL_STEP_DOWN,
 313   GTK_SCROLL_PAGE_UP,
 314   GTK_SCROLL_PAGE_DOWN,
 315   GTK_SCROLL_STEP_LEFT,
 316   GTK_SCROLL_STEP_RIGHT,
 317   GTK_SCROLL_PAGE_LEFT,
 318   GTK_SCROLL_PAGE_RIGHT,
 319   GTK_SCROLL_START,
 320   GTK_SCROLL_END
 321 } GtkScrollType;
 322
 323 /* list selection modes */
 324 typedef enum
 325 {
 326   GTK_SELECTION_NONE,                             /* Nothing can be selected */
 327   GTK_SELECTION_SINGLE,
 328   GTK_SELECTION_BROWSE,
 329   GTK_SELECTION_MULTIPLE,
 330   GTK_SELECTION_EXTENDED = GTK_SELECTION_MULTIPLE /* Deprecated */
 331 } GtkSelectionMode;
 332
 333 /* Shadow types */
 334 typedef enum
 335 {
 336   GTK_SHADOW_NONE,
 337   GTK_SHADOW_IN,
 338   GTK_SHADOW_OUT,
 339   GTK_SHADOW_ETCHED_IN,
 340   GTK_SHADOW_ETCHED_OUT
 341 } GtkShadowType;
 342
 343 /* Widget states */
 344 typedef enum
 345 {
 346   GTK_STATE_NORMAL,
 347   GTK_STATE_ACTIVE,
 348   GTK_STATE_PRELIGHT,
 349   GTK_STATE_SELECTED,
 350   GTK_STATE_INSENSITIVE
 351 } GtkStateType;
 352
 353 #if !defined(GTK_DISABLE_DEPRECATED) || defined (GTK_MENU_INTERNALS)
 354 /* Directions for submenus */
 355 typedef enum
 356 {
 357   GTK_DIRECTION_LEFT,
 358   GTK_DIRECTION_RIGHT
 359 } GtkSubmenuDirection;
 360
 361 /* Placement of submenus */
 362 typedef enum
 363 {
 364   GTK_TOP_BOTTOM,
 365   GTK_LEFT_RIGHT
 366 } GtkSubmenuPlacement;
 367 #endif /* GTK_DISABLE_DEPRECATED */
 368
 369 /* Style for toolbars */
 370 typedef enum
 371 {
 372   GTK_TOOLBAR_ICONS,
 373   GTK_TOOLBAR_TEXT,
 374   GTK_TOOLBAR_BOTH,
 375   GTK_TOOLBAR_BOTH_HORIZ
 376 } GtkToolbarStyle;
 377
 378 /* Data update types (for ranges) */
 379 typedef enum
 380 {
 381   GTK_UPDATE_CONTINUOUS,
 382   GTK_UPDATE_DISCONTINUOUS,
 383   GTK_UPDATE_DELAYED
 384 } GtkUpdateType;
 385
 386 /* Generic visibility flags */
 387 typedef enum
 388 {
 389   GTK_VISIBILITY_NONE,
 390   GTK_VISIBILITY_PARTIAL,
 391   GTK_VISIBILITY_FULL
 392 } GtkVisibility;
 393
 394 /* Window position types */
 395 typedef enum
 396 {
 397   GTK_WIN_POS_NONE,
 398   GTK_WIN_POS_CENTER,
 399   GTK_WIN_POS_MOUSE,
 400   GTK_WIN_POS_CENTER_ALWAYS,
 401   GTK_WIN_POS_CENTER_ON_PARENT
 402 } GtkWindowPosition;
 403
 404 /* Window types */
 405 typedef enum
 406 {
 407   GTK_WINDOW_TOPLEVEL,
 408   GTK_WINDOW_POPUP
 409 } GtkWindowType;
 410
 411 /* Text wrap */
 412 typedef enum
 413 {
 414   GTK_WRAP_NONE,
 415   GTK_WRAP_CHAR,
 416   GTK_WRAP_WORD,
 417   GTK_WRAP_WORD_CHAR
 418 } GtkWrapMode;
 419
 420 /* How to sort */
 421 typedef enum
 422 {
 423   GTK_SORT_ASCENDING,
 424   GTK_SORT_DESCENDING
 425 } GtkSortType;
 426
 427 /* Style for gtk input method preedit/status */
 428 typedef enum
 429 {
 430   GTK_IM_PREEDIT_NOTHING,
 431   GTK_IM_PREEDIT_CALLBACK,
 432   GTK_IM_PREEDIT_NONE
 433 } GtkIMPreeditStyle;
 434
 435 typedef enum
 436 {
 437   GTK_IM_STATUS_NOTHING,
 438   GTK_IM_STATUS_CALLBACK,
 439   GTK_IM_STATUS_NONE
 440 } GtkIMStatusStyle;
 441
 442 typedef enum
 443 {
 444   GTK_PACK_DIRECTION_LTR,
 445   GTK_PACK_DIRECTION_RTL,
 446   GTK_PACK_DIRECTION_TTB,
 447   GTK_PACK_DIRECTION_BTT
 448 } GtkPackDirection;
 449
 450 typedef enum
 451 {
 452   GTK_PRINT_PAGES_ALL,
 453   GTK_PRINT_PAGES_CURRENT,
 454   GTK_PRINT_PAGES_RANGES,
 455   GTK_PRINT_PAGES_SELECTION
 456 } GtkPrintPages;
 457
 458 typedef enum
 459 {
 460   GTK_PAGE_SET_ALL,
 461   GTK_PAGE_SET_EVEN,
 462   GTK_PAGE_SET_ODD
 463 } GtkPageSet;
 464
 465 typedef enum
 466 {
 467   GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM, /*< nick=lrtb >*/
 468   GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP, /*< nick=lrbt >*/
 469   GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM, /*< nick=rltb >*/
 470   GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP, /*< nick=rlbt >*/
 471   GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT, /*< nick=tblr >*/
 472   GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT, /*< nick=tbrl >*/
 473   GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT, /*< nick=btlr >*/
 474   GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT  /*< nick=btrl >*/
 475 } GtkNumberUpLayout;
 476
 477 typedef enum
 478 {
 479   GTK_PAGE_ORIENTATION_PORTRAIT,
 480   GTK_PAGE_ORIENTATION_LANDSCAPE,
 481   GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT,
 482   GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE
 483 } GtkPageOrientation;
 484
 485 typedef enum
 486 {
 487   GTK_PRINT_QUALITY_LOW,
 488   GTK_PRINT_QUALITY_NORMAL,
 489   GTK_PRINT_QUALITY_HIGH,
 490   GTK_PRINT_QUALITY_DRAFT
 491 } GtkPrintQuality;
 492
 493 typedef enum
 494 {
 495   GTK_PRINT_DUPLEX_SIMPLEX,
 496   GTK_PRINT_DUPLEX_HORIZONTAL,
 497   GTK_PRINT_DUPLEX_VERTICAL
 498 } GtkPrintDuplex;
 499
 500
 501 typedef enum
 502 {
 503   GTK_UNIT_PIXEL,
 504   GTK_UNIT_POINTS,
 505   GTK_UNIT_INCH,
 506   GTK_UNIT_MM
 507 } GtkUnit;
 508
 509 typedef enum
 510 {
 511   GTK_TREE_VIEW_GRID_LINES_NONE,
 512   GTK_TREE_VIEW_GRID_LINES_HORIZONTAL,
 513   GTK_TREE_VIEW_GRID_LINES_VERTICAL,
 514   GTK_TREE_VIEW_GRID_LINES_BOTH
 515 } GtkTreeViewGridLines;
 516
 517 typedef enum
 518 {
 519   GTK_DRAG_RESULT_SUCCESS,
 520   GTK_DRAG_RESULT_NO_TARGET,
 521   GTK_DRAG_RESULT_USER_CANCELLED,
 522   GTK_DRAG_RESULT_TIMEOUT_EXPIRED,
 523   GTK_DRAG_RESULT_GRAB_BROKEN,
 524   GTK_DRAG_RESULT_ERROR
 525 } GtkDragResult;
 526
 527 G_END_DECLS
 528
 529 #endif /* __GTK_ENUMS_H__ */