]> Pileus Git - ~andy/gtk/blob - gtk/gtkenums.h
[gtk] Deprecate GtkCurveType enum
[~andy/gtk] / 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_DISABLE_SINGLE_INCLUDES) && !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 #ifndef GTK_DISABLE_DEPRECATED
98 /* Curve types */
99 typedef enum
100 {
101   GTK_CURVE_TYPE_LINEAR,       /* linear interpolation */
102   GTK_CURVE_TYPE_SPLINE,       /* spline interpolation */
103   GTK_CURVE_TYPE_FREE          /* free form curve */
104 } GtkCurveType;
105 #endif
106
107 typedef enum
108 {
109   GTK_DELETE_CHARS,
110   GTK_DELETE_WORD_ENDS,           /* delete only the portion of the word to the
111                                    * left/right of cursor if we're in the middle
112                                    * of a word */
113   GTK_DELETE_WORDS,
114   GTK_DELETE_DISPLAY_LINES,
115   GTK_DELETE_DISPLAY_LINE_ENDS,
116   GTK_DELETE_PARAGRAPH_ENDS,      /* like C-k in Emacs (or its reverse) */
117   GTK_DELETE_PARAGRAPHS,          /* C-k in pico, kill whole line */
118   GTK_DELETE_WHITESPACE           /* M-\ in Emacs */
119 } GtkDeleteType;
120
121 /* Focus movement types */
122 typedef enum
123 {
124   GTK_DIR_TAB_FORWARD,
125   GTK_DIR_TAB_BACKWARD,
126   GTK_DIR_UP,
127   GTK_DIR_DOWN,
128   GTK_DIR_LEFT,
129   GTK_DIR_RIGHT
130 } GtkDirectionType;
131
132 /* Expander styles */
133 typedef enum
134 {
135   GTK_EXPANDER_COLLAPSED,
136   GTK_EXPANDER_SEMI_COLLAPSED,
137   GTK_EXPANDER_SEMI_EXPANDED,
138   GTK_EXPANDER_EXPANDED
139 } GtkExpanderStyle;
140
141 /* Built-in stock icon sizes */
142 typedef enum
143 {
144   GTK_ICON_SIZE_INVALID,
145   GTK_ICON_SIZE_MENU,
146   GTK_ICON_SIZE_SMALL_TOOLBAR,
147   GTK_ICON_SIZE_LARGE_TOOLBAR,
148   GTK_ICON_SIZE_BUTTON,
149   GTK_ICON_SIZE_DND,
150   GTK_ICON_SIZE_DIALOG
151 } GtkIconSize;
152
153 /* automatic sensitivity */
154 typedef enum
155 {
156   GTK_SENSITIVITY_AUTO,
157   GTK_SENSITIVITY_ON,
158   GTK_SENSITIVITY_OFF
159 } GtkSensitivityType;
160
161 #ifndef GTK_DISABLE_DEPRECATED
162 /* side types */
163 typedef enum
164 {
165   GTK_SIDE_TOP,
166   GTK_SIDE_BOTTOM,
167   GTK_SIDE_LEFT,
168   GTK_SIDE_RIGHT
169 } GtkSideType;
170 #endif /* GTK_DISABLE_DEPRECATED */
171
172 /* Reading directions for text */
173 typedef enum
174 {
175   GTK_TEXT_DIR_NONE,
176   GTK_TEXT_DIR_LTR,
177   GTK_TEXT_DIR_RTL
178 } GtkTextDirection;
179
180 /* justification for label and maybe other widgets (text?) */
181 typedef enum
182 {
183   GTK_JUSTIFY_LEFT,
184   GTK_JUSTIFY_RIGHT,
185   GTK_JUSTIFY_CENTER,
186   GTK_JUSTIFY_FILL
187 } GtkJustification;
188
189 #ifndef GTK_DISABLE_DEPRECATED
190 /* GtkPatternSpec match types */
191 typedef enum
192 {
193   GTK_MATCH_ALL,       /* "*A?A*" */
194   GTK_MATCH_ALL_TAIL,  /* "*A?AA" */
195   GTK_MATCH_HEAD,      /* "AAAA*" */
196   GTK_MATCH_TAIL,      /* "*AAAA" */
197   GTK_MATCH_EXACT,     /* "AAAAA" */
198   GTK_MATCH_LAST
199 } GtkMatchType;
200 #endif /* GTK_DISABLE_DEPRECATED */
201
202 /* Menu keyboard movement types */
203 typedef enum
204 {
205   GTK_MENU_DIR_PARENT,
206   GTK_MENU_DIR_CHILD,
207   GTK_MENU_DIR_NEXT,
208   GTK_MENU_DIR_PREV
209 } GtkMenuDirectionType;
210
211 typedef enum
212 {
213   GTK_MESSAGE_INFO,
214   GTK_MESSAGE_WARNING,
215   GTK_MESSAGE_QUESTION,
216   GTK_MESSAGE_ERROR,
217   GTK_MESSAGE_OTHER
218 } GtkMessageType;
219
220 typedef enum
221 {
222   GTK_PIXELS,
223   GTK_INCHES,
224   GTK_CENTIMETERS
225 } GtkMetricType;
226
227 typedef enum
228 {
229   GTK_MOVEMENT_LOGICAL_POSITIONS, /* move by forw/back graphemes */
230   GTK_MOVEMENT_VISUAL_POSITIONS,  /* move by left/right graphemes */
231   GTK_MOVEMENT_WORDS,             /* move by forward/back words */
232   GTK_MOVEMENT_DISPLAY_LINES,     /* move up/down lines (wrapped lines) */
233   GTK_MOVEMENT_DISPLAY_LINE_ENDS, /* move to either end of a line */
234   GTK_MOVEMENT_PARAGRAPHS,        /* move up/down paragraphs (newline-ended lines) */
235   GTK_MOVEMENT_PARAGRAPH_ENDS,    /* move to either end of a paragraph */
236   GTK_MOVEMENT_PAGES,             /* move by pages */
237   GTK_MOVEMENT_BUFFER_ENDS,       /* move to ends of the buffer */
238   GTK_MOVEMENT_HORIZONTAL_PAGES   /* move horizontally by pages */
239 } GtkMovementStep;
240
241 typedef enum
242 {
243   GTK_SCROLL_STEPS,
244   GTK_SCROLL_PAGES,
245   GTK_SCROLL_ENDS,
246   GTK_SCROLL_HORIZONTAL_STEPS,
247   GTK_SCROLL_HORIZONTAL_PAGES,
248   GTK_SCROLL_HORIZONTAL_ENDS
249 } GtkScrollStep;
250
251 /* Orientation for toolbars, etc. */
252 typedef enum
253 {
254   GTK_ORIENTATION_HORIZONTAL,
255   GTK_ORIENTATION_VERTICAL
256 } GtkOrientation;
257
258 /* Placement type for scrolled window */
259 typedef enum
260 {
261   GTK_CORNER_TOP_LEFT,
262   GTK_CORNER_BOTTOM_LEFT,
263   GTK_CORNER_TOP_RIGHT,
264   GTK_CORNER_BOTTOM_RIGHT
265 } GtkCornerType;
266
267 /* Packing types (for boxes) */
268 typedef enum
269 {
270   GTK_PACK_START,
271   GTK_PACK_END
272 } GtkPackType;
273
274 /* priorities for path lookups */
275 typedef enum
276 {
277   GTK_PATH_PRIO_LOWEST      = 0,
278   GTK_PATH_PRIO_GTK         = 4,
279   GTK_PATH_PRIO_APPLICATION = 8,
280   GTK_PATH_PRIO_THEME       = 10,
281   GTK_PATH_PRIO_RC          = 12,
282   GTK_PATH_PRIO_HIGHEST     = 15
283 } GtkPathPriorityType;
284 #define GTK_PATH_PRIO_MASK 0x0f
285
286 /* widget path types */
287 typedef enum
288 {
289   GTK_PATH_WIDGET,
290   GTK_PATH_WIDGET_CLASS,
291   GTK_PATH_CLASS
292 } GtkPathType;
293
294 /* Scrollbar policy types (for scrolled windows) */
295 typedef enum
296 {
297   GTK_POLICY_ALWAYS,
298   GTK_POLICY_AUTOMATIC,
299   GTK_POLICY_NEVER
300 } GtkPolicyType;
301
302 typedef enum
303 {
304   GTK_POS_LEFT,
305   GTK_POS_RIGHT,
306   GTK_POS_TOP,
307   GTK_POS_BOTTOM
308 } GtkPositionType;
309
310 #ifndef GTK_DISABLE_DEPRECATED
311 typedef enum
312 {
313   GTK_PREVIEW_COLOR,
314   GTK_PREVIEW_GRAYSCALE
315 } GtkPreviewType;
316 #endif /* GTK_DISABLE_DEPRECATED */
317
318 /* Style for buttons */
319 typedef enum
320 {
321   GTK_RELIEF_NORMAL,
322   GTK_RELIEF_HALF,
323   GTK_RELIEF_NONE
324 } GtkReliefStyle;
325
326 /* Resize type */
327 typedef enum
328 {
329   GTK_RESIZE_PARENT,            /* Pass resize request to the parent */
330   GTK_RESIZE_QUEUE,             /* Queue resizes on this widget */
331   GTK_RESIZE_IMMEDIATE          /* Perform the resizes now */
332 } GtkResizeMode;
333
334 #ifndef GTK_DISABLE_DEPRECATED
335 /* signal run types */
336 typedef enum                    /*< flags >*/
337 {
338   GTK_RUN_FIRST      = G_SIGNAL_RUN_FIRST,
339   GTK_RUN_LAST       = G_SIGNAL_RUN_LAST,
340   GTK_RUN_BOTH       = (GTK_RUN_FIRST | GTK_RUN_LAST),
341   GTK_RUN_NO_RECURSE = G_SIGNAL_NO_RECURSE,
342   GTK_RUN_ACTION     = G_SIGNAL_ACTION,
343   GTK_RUN_NO_HOOKS   = G_SIGNAL_NO_HOOKS
344 } GtkSignalRunType;
345 #endif /* GTK_DISABLE_DEPRECATED */
346
347 /* scrolling types */
348 typedef enum
349 {
350   GTK_SCROLL_NONE,
351   GTK_SCROLL_JUMP,
352   GTK_SCROLL_STEP_BACKWARD,
353   GTK_SCROLL_STEP_FORWARD,
354   GTK_SCROLL_PAGE_BACKWARD,
355   GTK_SCROLL_PAGE_FORWARD,
356   GTK_SCROLL_STEP_UP,
357   GTK_SCROLL_STEP_DOWN,
358   GTK_SCROLL_PAGE_UP,
359   GTK_SCROLL_PAGE_DOWN,
360   GTK_SCROLL_STEP_LEFT,
361   GTK_SCROLL_STEP_RIGHT,
362   GTK_SCROLL_PAGE_LEFT,
363   GTK_SCROLL_PAGE_RIGHT,
364   GTK_SCROLL_START,
365   GTK_SCROLL_END
366 } GtkScrollType;
367
368 /* list selection modes */
369 typedef enum
370 {
371   GTK_SELECTION_NONE,                             /* Nothing can be selected */
372   GTK_SELECTION_SINGLE,
373   GTK_SELECTION_BROWSE,
374   GTK_SELECTION_MULTIPLE,
375   GTK_SELECTION_EXTENDED = GTK_SELECTION_MULTIPLE /* Deprecated */
376 } GtkSelectionMode;
377
378 /* Shadow types */
379 typedef enum
380 {
381   GTK_SHADOW_NONE,
382   GTK_SHADOW_IN,
383   GTK_SHADOW_OUT,
384   GTK_SHADOW_ETCHED_IN,
385   GTK_SHADOW_ETCHED_OUT
386 } GtkShadowType;
387
388 /* Widget states */
389 typedef enum
390 {
391   GTK_STATE_NORMAL,
392   GTK_STATE_ACTIVE,
393   GTK_STATE_PRELIGHT,
394   GTK_STATE_SELECTED,
395   GTK_STATE_INSENSITIVE
396 } GtkStateType;
397
398 #if !defined(GTK_DISABLE_DEPRECATED) || defined (GTK_MENU_INTERNALS)
399 /* Directions for submenus */
400 typedef enum
401 {
402   GTK_DIRECTION_LEFT,
403   GTK_DIRECTION_RIGHT
404 } GtkSubmenuDirection;
405
406 /* Placement of submenus */
407 typedef enum
408 {
409   GTK_TOP_BOTTOM,
410   GTK_LEFT_RIGHT
411 } GtkSubmenuPlacement;
412 #endif /* GTK_DISABLE_DEPRECATED */
413
414 /* Style for toolbars */
415 typedef enum
416 {
417   GTK_TOOLBAR_ICONS,
418   GTK_TOOLBAR_TEXT,
419   GTK_TOOLBAR_BOTH,
420   GTK_TOOLBAR_BOTH_HORIZ
421 } GtkToolbarStyle;
422
423 /* Data update types (for ranges) */
424 typedef enum
425 {
426   GTK_UPDATE_CONTINUOUS,
427   GTK_UPDATE_DISCONTINUOUS,
428   GTK_UPDATE_DELAYED
429 } GtkUpdateType;
430
431 /* Generic visibility flags */
432 typedef enum
433 {
434   GTK_VISIBILITY_NONE,
435   GTK_VISIBILITY_PARTIAL,
436   GTK_VISIBILITY_FULL
437 } GtkVisibility;
438
439 /* Window position types */
440 typedef enum
441 {
442   GTK_WIN_POS_NONE,
443   GTK_WIN_POS_CENTER,
444   GTK_WIN_POS_MOUSE,
445   GTK_WIN_POS_CENTER_ALWAYS,
446   GTK_WIN_POS_CENTER_ON_PARENT
447 } GtkWindowPosition;
448
449 /* Window types */
450 typedef enum
451 {
452   GTK_WINDOW_TOPLEVEL,
453   GTK_WINDOW_POPUP
454 } GtkWindowType;
455
456 /* Text wrap */
457 typedef enum
458 {
459   GTK_WRAP_NONE,
460   GTK_WRAP_CHAR,
461   GTK_WRAP_WORD,
462   GTK_WRAP_WORD_CHAR
463 } GtkWrapMode;
464
465 /* How to sort */
466 typedef enum
467 {
468   GTK_SORT_ASCENDING,
469   GTK_SORT_DESCENDING
470 } GtkSortType;
471
472 /* Style for gtk input method preedit/status */
473 typedef enum
474 {
475   GTK_IM_PREEDIT_NOTHING,
476   GTK_IM_PREEDIT_CALLBACK,
477   GTK_IM_PREEDIT_NONE
478 } GtkIMPreeditStyle;
479
480 typedef enum
481 {
482   GTK_IM_STATUS_NOTHING,
483   GTK_IM_STATUS_CALLBACK,
484   GTK_IM_STATUS_NONE
485 } GtkIMStatusStyle;
486
487 typedef enum
488 {
489   GTK_PACK_DIRECTION_LTR,
490   GTK_PACK_DIRECTION_RTL,
491   GTK_PACK_DIRECTION_TTB,
492   GTK_PACK_DIRECTION_BTT
493 } GtkPackDirection;
494
495 typedef enum
496 {
497   GTK_PRINT_PAGES_ALL,
498   GTK_PRINT_PAGES_CURRENT,
499   GTK_PRINT_PAGES_RANGES,
500   GTK_PRINT_PAGES_SELECTION
501 } GtkPrintPages;
502
503 typedef enum
504 {
505   GTK_PAGE_SET_ALL,
506   GTK_PAGE_SET_EVEN,
507   GTK_PAGE_SET_ODD
508 } GtkPageSet;
509
510 typedef enum
511 {
512   GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_TOP_TO_BOTTOM, /*< nick=lrtb >*/
513   GTK_NUMBER_UP_LAYOUT_LEFT_TO_RIGHT_BOTTOM_TO_TOP, /*< nick=lrbt >*/
514   GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_TOP_TO_BOTTOM, /*< nick=rltb >*/
515   GTK_NUMBER_UP_LAYOUT_RIGHT_TO_LEFT_BOTTOM_TO_TOP, /*< nick=rlbt >*/
516   GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_LEFT_TO_RIGHT, /*< nick=tblr >*/
517   GTK_NUMBER_UP_LAYOUT_TOP_TO_BOTTOM_RIGHT_TO_LEFT, /*< nick=tbrl >*/
518   GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_LEFT_TO_RIGHT, /*< nick=btlr >*/
519   GTK_NUMBER_UP_LAYOUT_BOTTOM_TO_TOP_RIGHT_TO_LEFT  /*< nick=btrl >*/
520 } GtkNumberUpLayout;
521
522 typedef enum
523 {
524   GTK_PAGE_ORIENTATION_PORTRAIT,
525   GTK_PAGE_ORIENTATION_LANDSCAPE,
526   GTK_PAGE_ORIENTATION_REVERSE_PORTRAIT,
527   GTK_PAGE_ORIENTATION_REVERSE_LANDSCAPE
528 } GtkPageOrientation;
529
530 typedef enum
531 {
532   GTK_PRINT_QUALITY_LOW,
533   GTK_PRINT_QUALITY_NORMAL,
534   GTK_PRINT_QUALITY_HIGH,
535   GTK_PRINT_QUALITY_DRAFT
536 } GtkPrintQuality;
537
538 typedef enum
539 {
540   GTK_PRINT_DUPLEX_SIMPLEX,
541   GTK_PRINT_DUPLEX_HORIZONTAL,
542   GTK_PRINT_DUPLEX_VERTICAL
543 } GtkPrintDuplex;
544
545
546 typedef enum
547 {
548   GTK_UNIT_PIXEL,
549   GTK_UNIT_POINTS,
550   GTK_UNIT_INCH,
551   GTK_UNIT_MM
552 } GtkUnit;
553
554 typedef enum
555 {
556   GTK_TREE_VIEW_GRID_LINES_NONE,
557   GTK_TREE_VIEW_GRID_LINES_HORIZONTAL,
558   GTK_TREE_VIEW_GRID_LINES_VERTICAL,
559   GTK_TREE_VIEW_GRID_LINES_BOTH
560 } GtkTreeViewGridLines;
561
562 typedef enum
563 {
564   GTK_DRAG_RESULT_SUCCESS,
565   GTK_DRAG_RESULT_NO_TARGET,
566   GTK_DRAG_RESULT_USER_CANCELLED,
567   GTK_DRAG_RESULT_TIMEOUT_EXPIRED,
568   GTK_DRAG_RESULT_GRAB_BROKEN,
569   GTK_DRAG_RESULT_ERROR
570 } GtkDragResult;
571
572 G_END_DECLS
573
574 #endif /* __GTK_ENUMS_H__ */