gtkenums.h 11.4 KB
Newer Older
Elliot Lee's avatar
Elliot Lee committed
1 2 3 4
/* GTK - The GIMP Toolkit
 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
 *
 * This library is free software; you can redistribute it and/or
5
 * modify it under the terms of the GNU Lesser General Public
Elliot Lee's avatar
Elliot Lee committed
6 7 8 9 10
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * 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.
Elliot Lee's avatar
Elliot Lee committed
13
 *
14
 * You should have received a copy of the GNU Lesser General Public
15 16 17
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
Elliot Lee's avatar
Elliot Lee committed
18
 */
19 20

/*
21
 * Modified by the GTK+ Team and others 1997-2000.  See the AUTHORS
22 23
 * file for a list of people on the GTK+ Team.  See the ChangeLog
 * files for a list of changes.  These files are distributed with
24
 * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
25 26
 */

27 28 29 30
#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
#error "Only <gtk/gtk.h> can be included directly."
#endif

Elliot Lee's avatar
Elliot Lee committed
31 32 33
#ifndef __GTK_ENUMS_H__
#define __GTK_ENUMS_H__

34
#include <glib-object.h>
35

36
G_BEGIN_DECLS
37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59

/* Anchor types */
typedef enum
{
  GTK_ANCHOR_CENTER,
  GTK_ANCHOR_NORTH,
  GTK_ANCHOR_NORTH_WEST,
  GTK_ANCHOR_NORTH_EAST,
  GTK_ANCHOR_SOUTH,
  GTK_ANCHOR_SOUTH_WEST,
  GTK_ANCHOR_SOUTH_EAST,
  GTK_ANCHOR_WEST,
  GTK_ANCHOR_EAST,
  GTK_ANCHOR_N		= GTK_ANCHOR_NORTH,
  GTK_ANCHOR_NW		= GTK_ANCHOR_NORTH_WEST,
  GTK_ANCHOR_NE		= GTK_ANCHOR_NORTH_EAST,
  GTK_ANCHOR_S		= GTK_ANCHOR_SOUTH,
  GTK_ANCHOR_SW		= GTK_ANCHOR_SOUTH_WEST,
  GTK_ANCHOR_SE		= GTK_ANCHOR_SOUTH_EAST,
  GTK_ANCHOR_W		= GTK_ANCHOR_WEST,
  GTK_ANCHOR_E		= GTK_ANCHOR_EAST
} GtkAnchorType;

Elliot Lee's avatar
Elliot Lee committed
60 61 62
/* Arrow types */
typedef enum
{
63 64 65
  GTK_ARROW_UP,
  GTK_ARROW_DOWN,
  GTK_ARROW_LEFT,
Kristian Rietveld's avatar
Kristian Rietveld committed
66 67
  GTK_ARROW_RIGHT,
  GTK_ARROW_NONE
68
} GtkArrowType;
Elliot Lee's avatar
Elliot Lee committed
69 70 71 72

/* Attach options (for tables) */
typedef enum
{
73 74 75 76
  GTK_EXPAND = 1 << 0,
  GTK_SHRINK = 1 << 1,
  GTK_FILL   = 1 << 2
} GtkAttachOptions;
Elliot Lee's avatar
Elliot Lee committed
77

78
/* Button box styles */
79
typedef enum
Elliot Lee's avatar
Elliot Lee committed
80
{
81 82 83 84
  GTK_BUTTONBOX_DEFAULT_STYLE,
  GTK_BUTTONBOX_SPREAD,
  GTK_BUTTONBOX_EDGE,
  GTK_BUTTONBOX_START,
85 86
  GTK_BUTTONBOX_END,
  GTK_BUTTONBOX_CENTER
87 88 89
} GtkButtonBoxStyle;

/* Curve types */
Elliot Lee's avatar
Elliot Lee committed
90 91
typedef enum
{
92 93 94 95
  GTK_CURVE_TYPE_LINEAR,       /* linear interpolation */
  GTK_CURVE_TYPE_SPLINE,       /* spline interpolation */
  GTK_CURVE_TYPE_FREE          /* free form curve */
} GtkCurveType;
96 97 98

typedef enum
{
99 100 101 102 103 104 105 106 107
  GTK_DELETE_CHARS,
  GTK_DELETE_WORD_ENDS,           /* delete only the portion of the word to the
                                   * left/right of cursor if we're in the middle
                                   * of a word */
  GTK_DELETE_WORDS,
  GTK_DELETE_DISPLAY_LINES,
  GTK_DELETE_DISPLAY_LINE_ENDS,
  GTK_DELETE_PARAGRAPH_ENDS,      /* like C-k in Emacs (or its reverse) */
  GTK_DELETE_PARAGRAPHS,          /* C-k in pico, kill whole line */
108
  GTK_DELETE_WHITESPACE           /* M-\ in Emacs */
109 110
} GtkDeleteType;

Tim Janik's avatar
Tim Janik committed
111
/* Focus movement types */
Elliot Lee's avatar
Elliot Lee committed
112 113
typedef enum
{
114 115 116 117 118 119 120
  GTK_DIR_TAB_FORWARD,
  GTK_DIR_TAB_BACKWARD,
  GTK_DIR_UP,
  GTK_DIR_DOWN,
  GTK_DIR_LEFT,
  GTK_DIR_RIGHT
} GtkDirectionType;
Elliot Lee's avatar
Elliot Lee committed
121

122 123 124 125 126 127 128 129 130
/* Expander styles */
typedef enum
{
  GTK_EXPANDER_COLLAPSED,
  GTK_EXPANDER_SEMI_COLLAPSED,
  GTK_EXPANDER_SEMI_EXPANDED,
  GTK_EXPANDER_EXPANDED
} GtkExpanderStyle;

131 132 133 134 135 136 137 138
/* Built-in stock icon sizes */
typedef enum
{
  GTK_ICON_SIZE_INVALID,
  GTK_ICON_SIZE_MENU,
  GTK_ICON_SIZE_SMALL_TOOLBAR,
  GTK_ICON_SIZE_LARGE_TOOLBAR,
  GTK_ICON_SIZE_BUTTON,
139
  GTK_ICON_SIZE_DND,
140 141 142
  GTK_ICON_SIZE_DIALOG
} GtkIconSize;

143 144 145 146 147 148 149 150
/* automatic sensitivity */
typedef enum
{
  GTK_SENSITIVITY_AUTO,
  GTK_SENSITIVITY_ON,
  GTK_SENSITIVITY_OFF
} GtkSensitivityType;

151
#ifndef GTK_DISABLE_DEPRECATED
152 153 154 155 156 157 158 159
/* side types */
typedef enum
{
  GTK_SIDE_TOP,
  GTK_SIDE_BOTTOM,
  GTK_SIDE_LEFT,
  GTK_SIDE_RIGHT
} GtkSideType;
160
#endif /* GTK_DISABLE_DEPRECATED */
161

162 163 164 165
/* Reading directions for text */
typedef enum
{
  GTK_TEXT_DIR_NONE,
166 167
  GTK_TEXT_DIR_LTR,
  GTK_TEXT_DIR_RTL
168 169
} GtkTextDirection;

Tim Janik's avatar
Tim Janik committed
170
/* justification for label and maybe other widgets (text?) */
Elliot Lee's avatar
Elliot Lee committed
171 172
typedef enum
{
173 174 175 176 177
  GTK_JUSTIFY_LEFT,
  GTK_JUSTIFY_RIGHT,
  GTK_JUSTIFY_CENTER,
  GTK_JUSTIFY_FILL
} GtkJustification;
Tim Janik's avatar
Tim Janik committed
178

Matthias Clasen's avatar
Matthias Clasen committed
179
#ifndef GTK_DISABLE_DEPRECATED
Tim Janik's avatar
Tim Janik committed
180 181 182
/* GtkPatternSpec match types */
typedef enum
{
183 184 185 186 187 188 189
  GTK_MATCH_ALL,       /* "*A?A*" */
  GTK_MATCH_ALL_TAIL,  /* "*A?AA" */
  GTK_MATCH_HEAD,      /* "AAAA*" */
  GTK_MATCH_TAIL,      /* "*AAAA" */
  GTK_MATCH_EXACT,     /* "AAAAA" */
  GTK_MATCH_LAST
} GtkMatchType;
Matthias Clasen's avatar
Matthias Clasen committed
190
#endif /* GTK_DISABLE_DEPRECATED */
191

192 193 194 195 196 197 198 199 200
/* Menu keyboard movement types */
typedef enum
{
  GTK_MENU_DIR_PARENT,
  GTK_MENU_DIR_CHILD,
  GTK_MENU_DIR_NEXT,
  GTK_MENU_DIR_PREV
} GtkMenuDirectionType;

Elliot Lee's avatar
Elliot Lee committed
201 202
typedef enum
{
203 204 205 206
  GTK_PIXELS,
  GTK_INCHES,
  GTK_CENTIMETERS
} GtkMetricType;
Elliot Lee's avatar
Elliot Lee committed
207

208
typedef enum
209
{
210 211
  GTK_MOVEMENT_LOGICAL_POSITIONS, /* move by forw/back graphemes */
  GTK_MOVEMENT_VISUAL_POSITIONS,  /* move by left/right graphemes */
212 213 214 215 216 217
  GTK_MOVEMENT_WORDS,             /* move by forward/back words */
  GTK_MOVEMENT_DISPLAY_LINES,     /* move up/down lines (wrapped lines) */
  GTK_MOVEMENT_DISPLAY_LINE_ENDS, /* move up/down lines (wrapped lines) */
  GTK_MOVEMENT_PARAGRAPHS,        /* move up/down paragraphs (newline-ended lines) */
  GTK_MOVEMENT_PARAGRAPH_ENDS,    /* move to either end of a paragraph */
  GTK_MOVEMENT_PAGES,	          /* move by pages */
218 219
  GTK_MOVEMENT_BUFFER_ENDS,       /* move to ends of the buffer */
  GTK_MOVEMENT_HORIZONTAL_PAGES   /* move horizontally by pages */
220 221
} GtkMovementStep;

222
typedef enum
223 224 225 226 227 228 229 230 231
{
  GTK_SCROLL_STEPS,
  GTK_SCROLL_PAGES,
  GTK_SCROLL_ENDS,
  GTK_SCROLL_HORIZONTAL_STEPS,
  GTK_SCROLL_HORIZONTAL_PAGES,
  GTK_SCROLL_HORIZONTAL_ENDS
} GtkScrollStep;

Tim Janik's avatar
Tim Janik committed
232
/* Orientation for toolbars, etc. */
Elliot Lee's avatar
Elliot Lee committed
233 234
typedef enum
{
235 236 237
  GTK_ORIENTATION_HORIZONTAL,
  GTK_ORIENTATION_VERTICAL
} GtkOrientation;
Elliot Lee's avatar
Elliot Lee committed
238

239 240 241 242 243 244 245 246 247
/* Placement type for scrolled window */
typedef enum
{
  GTK_CORNER_TOP_LEFT,
  GTK_CORNER_BOTTOM_LEFT,
  GTK_CORNER_TOP_RIGHT,
  GTK_CORNER_BOTTOM_RIGHT
} GtkCornerType;

Tim Janik's avatar
Tim Janik committed
248
/* Packing types (for boxes) */
Elliot Lee's avatar
Elliot Lee committed
249 250
typedef enum
{
251 252 253
  GTK_PACK_START,
  GTK_PACK_END
} GtkPackType;
Tim Janik's avatar
Tim Janik committed
254 255 256 257

/* priorities for path lookups */
typedef enum
{
258 259 260
  GTK_PATH_PRIO_LOWEST      = 0,
  GTK_PATH_PRIO_GTK	    = 4,
  GTK_PATH_PRIO_APPLICATION = 8,
261
  GTK_PATH_PRIO_THEME       = 10,
262
  GTK_PATH_PRIO_RC          = 12,
263
  GTK_PATH_PRIO_HIGHEST     = 15
264
} GtkPathPriorityType;
265
#define GTK_PATH_PRIO_MASK 0x0f
Tim Janik's avatar
Tim Janik committed
266 267 268 269

/* widget path types */
typedef enum
{
270 271 272 273
  GTK_PATH_WIDGET,
  GTK_PATH_WIDGET_CLASS,
  GTK_PATH_CLASS
} GtkPathType;
Tim Janik's avatar
Tim Janik committed
274 275 276 277

/* Scrollbar policy types (for scrolled windows) */
typedef enum
{
278
  GTK_POLICY_ALWAYS,
279 280
  GTK_POLICY_AUTOMATIC,
  GTK_POLICY_NEVER
281
} GtkPolicyType;
Elliot Lee's avatar
Elliot Lee committed
282 283 284

typedef enum
{
285 286 287 288 289
  GTK_POS_LEFT,
  GTK_POS_RIGHT,
  GTK_POS_TOP,
  GTK_POS_BOTTOM
} GtkPositionType;
Elliot Lee's avatar
Elliot Lee committed
290

291
#ifndef GTK_DISABLE_DEPRECATED
Elliot Lee's avatar
Elliot Lee committed
292 293
typedef enum
{
294 295 296
  GTK_PREVIEW_COLOR,
  GTK_PREVIEW_GRAYSCALE
} GtkPreviewType;
297
#endif /* GTK_DISABLE_DEPRECATED */
Elliot Lee's avatar
Elliot Lee committed
298

Tim Janik's avatar
Tim Janik committed
299
/* Style for buttons */
Elliot Lee's avatar
Elliot Lee committed
300 301
typedef enum
{
302
  GTK_RELIEF_NORMAL,
303
  GTK_RELIEF_HALF,
304 305 306
  GTK_RELIEF_NONE
} GtkReliefStyle;

307 308 309 310 311
/* Resize type */
typedef enum
{
  GTK_RESIZE_PARENT,		/* Pass resize request to the parent */
  GTK_RESIZE_QUEUE,		/* Queue resizes on this widget */
312
  GTK_RESIZE_IMMEDIATE		/* Perform the resizes now */
313 314
} GtkResizeMode;

315
#ifndef GTK_DISABLE_DEPRECATED
316 317 318
/* signal run types */
typedef enum			/*< flags >*/
{
319 320
  GTK_RUN_FIRST      = G_SIGNAL_RUN_FIRST,
  GTK_RUN_LAST       = G_SIGNAL_RUN_LAST,
321
  GTK_RUN_BOTH       = (GTK_RUN_FIRST | GTK_RUN_LAST),
322 323 324
  GTK_RUN_NO_RECURSE = G_SIGNAL_NO_RECURSE,
  GTK_RUN_ACTION     = G_SIGNAL_ACTION,
  GTK_RUN_NO_HOOKS   = G_SIGNAL_NO_HOOKS
325
} GtkSignalRunType;
326
#endif /* GTK_DISABLE_DEPRECATED */
Tim Janik's avatar
Tim Janik committed
327 328 329 330

/* scrolling types */
typedef enum
{
331
  GTK_SCROLL_NONE,
332
  GTK_SCROLL_JUMP,
333 334 335 336
  GTK_SCROLL_STEP_BACKWARD,
  GTK_SCROLL_STEP_FORWARD,
  GTK_SCROLL_PAGE_BACKWARD,
  GTK_SCROLL_PAGE_FORWARD,
337 338 339 340 341 342 343
  GTK_SCROLL_STEP_UP,
  GTK_SCROLL_STEP_DOWN,
  GTK_SCROLL_PAGE_UP,
  GTK_SCROLL_PAGE_DOWN,
  GTK_SCROLL_STEP_LEFT,
  GTK_SCROLL_STEP_RIGHT,
  GTK_SCROLL_PAGE_LEFT,
344 345 346
  GTK_SCROLL_PAGE_RIGHT,
  GTK_SCROLL_START,
  GTK_SCROLL_END
347
} GtkScrollType;
Elliot Lee's avatar
Elliot Lee committed
348

349 350 351
/* list selection modes */
typedef enum
{
352
  GTK_SELECTION_NONE,                             /* Nothing can be selected */
353 354 355
  GTK_SELECTION_SINGLE,
  GTK_SELECTION_BROWSE,
  GTK_SELECTION_MULTIPLE,
356
  GTK_SELECTION_EXTENDED = GTK_SELECTION_MULTIPLE /* Deprecated */
357
} GtkSelectionMode;
Elliot Lee's avatar
Elliot Lee committed
358

Tim Janik's avatar
Tim Janik committed
359
/* Shadow types */
360 361
typedef enum
{
362 363 364 365 366 367
  GTK_SHADOW_NONE,
  GTK_SHADOW_IN,
  GTK_SHADOW_OUT,
  GTK_SHADOW_ETCHED_IN,
  GTK_SHADOW_ETCHED_OUT
} GtkShadowType;
Tim Janik's avatar
Tim Janik committed
368 369 370 371

/* Widget states */
typedef enum
{
372 373 374 375 376 377 378
  GTK_STATE_NORMAL,
  GTK_STATE_ACTIVE,
  GTK_STATE_PRELIGHT,
  GTK_STATE_SELECTED,
  GTK_STATE_INSENSITIVE
} GtkStateType;

379
#if !defined(GTK_DISABLE_DEPRECATED) || defined (GTK_MENU_INTERNALS)
380
/* Directions for submenus */
Tim Janik's avatar
Tim Janik committed
381 382
typedef enum
{
383 384 385
  GTK_DIRECTION_LEFT,
  GTK_DIRECTION_RIGHT
} GtkSubmenuDirection;
Tim Janik's avatar
Tim Janik committed
386

387
/* Placement of submenus */
Tim Janik's avatar
Tim Janik committed
388 389
typedef enum
{
390 391 392
  GTK_TOP_BOTTOM,
  GTK_LEFT_RIGHT
} GtkSubmenuPlacement;
393
#endif /* GTK_DISABLE_DEPRECATED */
394 395 396 397

/* Style for toolbars */
typedef enum
{
398 399
  GTK_TOOLBAR_ICONS,
  GTK_TOOLBAR_TEXT,
400 401
  GTK_TOOLBAR_BOTH,
  GTK_TOOLBAR_BOTH_HORIZ
402
} GtkToolbarStyle;
403

Tim Janik's avatar
Tim Janik committed
404 405 406
/* Data update types (for ranges) */
typedef enum
{
407 408 409 410
  GTK_UPDATE_CONTINUOUS,
  GTK_UPDATE_DISCONTINUOUS,
  GTK_UPDATE_DELAYED
} GtkUpdateType;
411

412 413 414
/* Generic visibility flags */
typedef enum
{
415 416 417 418
  GTK_VISIBILITY_NONE,
  GTK_VISIBILITY_PARTIAL,
  GTK_VISIBILITY_FULL
} GtkVisibility;
419

420
/* Window position types */
Tim Janik's avatar
Tim Janik committed
421 422
typedef enum
{
423 424
  GTK_WIN_POS_NONE,
  GTK_WIN_POS_CENTER,
425
  GTK_WIN_POS_MOUSE,
426 427
  GTK_WIN_POS_CENTER_ALWAYS,
  GTK_WIN_POS_CENTER_ON_PARENT
428
} GtkWindowPosition;
Tim Janik's avatar
Tim Janik committed
429 430 431 432

/* Window types */
typedef enum
{
433 434 435
  GTK_WINDOW_TOPLEVEL,
  GTK_WINDOW_POPUP
} GtkWindowType;
Tim Janik's avatar
Tim Janik committed
436

437 438 439 440 441
/* Text wrap */
typedef enum
{
  GTK_WRAP_NONE,
  GTK_WRAP_CHAR,
442 443
  GTK_WRAP_WORD,
  GTK_WRAP_WORD_CHAR
444 445
} GtkWrapMode;

Stefan Jeske's avatar
Stefan Jeske committed
446 447 448 449 450 451 452
/* How to sort */
typedef enum
{
  GTK_SORT_ASCENDING,
  GTK_SORT_DESCENDING
} GtkSortType;

453
/* Style for gtk input method preedit/status */
454 455 456
typedef enum
{
  GTK_IM_PREEDIT_NOTHING,
457 458
  GTK_IM_PREEDIT_CALLBACK,
  GTK_IM_PREEDIT_NONE
459 460 461 462 463
} GtkIMPreeditStyle;

typedef enum
{
  GTK_IM_STATUS_NOTHING,
464 465
  GTK_IM_STATUS_CALLBACK,
  GTK_IM_STATUS_NONE
466 467
} GtkIMStatusStyle;

468 469 470 471 472 473 474
typedef enum
{
  GTK_PACK_DIRECTION_LTR,
  GTK_PACK_DIRECTION_RTL,
  GTK_PACK_DIRECTION_TTB,
  GTK_PACK_DIRECTION_BTT
} GtkPackDirection;
Elliot Lee's avatar
Elliot Lee committed
475

476 477
typedef enum
{
478 479 480 481 482
  GTK_PRINT_PAGES_ALL,
  GTK_PRINT_PAGES_CURRENT,
  GTK_PRINT_PAGES_RANGES
} GtkPrintPages;

483 484
typedef enum
{
485 486 487 488 489
  GTK_PAGE_SET_ALL,
  GTK_PAGE_SET_EVEN,
  GTK_PAGE_SET_ODD
} GtkPageSet;

490 491
typedef enum
{
492 493 494 495 496 497
  GTK_PAGE_ORIENTATION_PORTRAIT,
  GTK_PAGE_ORIENTATION_LANDSCAPE,
  GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT,
  GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE
} GtkPageOrientation;

498 499
typedef enum
{
500 501 502 503 504 505
  GTK_PRINT_QUALITY_LOW,
  GTK_PRINT_QUALITY_NORMAL,
  GTK_PRINT_QUALITY_HIGH,
  GTK_PRINT_QUALITY_DRAFT
} GtkPrintQuality;

506 507
typedef enum
{
508 509 510 511 512 513
  GTK_PRINT_DUPLEX_SIMPLEX,
  GTK_PRINT_DUPLEX_HORIZONTAL,
  GTK_PRINT_DUPLEX_VERTICAL
} GtkPrintDuplex;


514 515
typedef enum
{
516 517 518 519 520 521
  GTK_UNIT_PIXEL,
  GTK_UNIT_POINTS,
  GTK_UNIT_INCH,
  GTK_UNIT_MM
} GtkUnit;

522 523
typedef enum
{
524 525 526 527 528 529
  GTK_TREE_VIEW_GRID_LINES_NONE,
  GTK_TREE_VIEW_GRID_LINES_HORIZONTAL,
  GTK_TREE_VIEW_GRID_LINES_VERTICAL,
  GTK_TREE_VIEW_GRID_LINES_BOTH
} GtkTreeViewGridLines;

530 531
typedef enum
{
532 533 534 535 536 537 538 539
  GTK_DRAG_RESULT_SUCCESS,
  GTK_DRAG_RESULT_NO_TARGET,
  GTK_DRAG_RESULT_USER_CANCELLED,
  GTK_DRAG_RESULT_TIMEOUT_EXPIRED,
  GTK_DRAG_RESULT_GRAB_BROKEN,
  GTK_DRAG_RESULT_ERROR
} GtkDragResult;

540
G_END_DECLS
Elliot Lee's avatar
Elliot Lee committed
541 542

#endif /* __GTK_ENUMS_H__ */