]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkenums.h
Merge branch 'master' into open-with-dialog
[~andy/gtk] / gtk / gtkenums.h
index 2dc9f8fcdc92fa9de623245afc9215ef8f6a7074..e7dd7f56c9b5bc5641e1bed621dada2ea98fba43 100644 (file)
@@ -24,7 +24,7 @@
  * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
  */
 
-#if defined(GTK_DISABLE_SINGLE_INCLUDES) && !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
+#if !defined (__GTK_H_INSIDE__) && !defined (GTK_COMPILATION)
 #error "Only <gtk/gtk.h> can be included directly."
 #endif
 
 
 G_BEGIN_DECLS
 
-/* 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;
+/**
+ * GtkAlign:
+ * @GTK_ALIGN_FILL: stretch to fill all space if possible, center if
+ *     no meaningful way to stretch
+ * @GTK_ALIGN_START: snap to left or top side, leaving space on right
+ *     or bottom
+ * @GTK_ALIGN_END: snap to right or bottom side, leaving space on left
+ *     or top
+ * @GTK_ALIGN_CENTER: center natural width of widget inside the
+ *     allocation
+ *
+ * Controls how a widget deals with extra space in a single (x or y)
+ * dimension.
+ *
+ * Alignment only matters if the widget receives a "too large" allocation,
+ * for example if you packed the widget with the #GtkWidget:expand
+ * flag inside a #GtkBox, then the widget might get extra space.  If
+ * you have for example a 16x16 icon inside a 32x32 space, the icon
+ * could be scaled and stretched, it could be centered, or it could be
+ * positioned to one side of the space.
+ */
+typedef enum
+{
+  GTK_ALIGN_FILL,
+  GTK_ALIGN_START,
+  GTK_ALIGN_END,
+  GTK_ALIGN_CENTER
+} GtkAlign;
 
 /* Arrow placement */
 typedef enum
@@ -86,22 +93,13 @@ typedef enum
 /* Button box styles */
 typedef enum
 {
-  GTK_BUTTONBOX_DEFAULT_STYLE,
-  GTK_BUTTONBOX_SPREAD,
+  GTK_BUTTONBOX_SPREAD = 1,
   GTK_BUTTONBOX_EDGE,
   GTK_BUTTONBOX_START,
   GTK_BUTTONBOX_END,
   GTK_BUTTONBOX_CENTER
 } GtkButtonBoxStyle;
 
-/* Curve types */
-typedef enum
-{
-  GTK_CURVE_TYPE_LINEAR,       /* linear interpolation */
-  GTK_CURVE_TYPE_SPLINE,       /* spline interpolation */
-  GTK_CURVE_TYPE_FREE          /* free form curve */
-} GtkCurveType;
-
 typedef enum
 {
   GTK_DELETE_CHARS,
@@ -148,7 +146,16 @@ typedef enum
   GTK_ICON_SIZE_DIALOG
 } GtkIconSize;
 
-/* automatic sensitivity */
+/**
+ * GtkSensitivityType:
+ * @GTK_SENSITIVITY_AUTO: The arrow is made insensitive if the
+ *   thumb is at the end
+ * @GTK_SENSITIVITY_ON: The arrow is always sensitive
+ * @GTK_SENSITIVITY_OFF: The arrow is always insensitive
+ *
+ * Determines how GTK+ handles the sensitivity of stepper arrows
+ * at the end of range widgets.
+ */
 typedef enum
 {
   GTK_SENSITIVITY_AUTO,
@@ -156,17 +163,6 @@ typedef enum
   GTK_SENSITIVITY_OFF
 } GtkSensitivityType;
 
-#ifndef GTK_DISABLE_DEPRECATED
-/* side types */
-typedef enum
-{
-  GTK_SIDE_TOP,
-  GTK_SIDE_BOTTOM,
-  GTK_SIDE_LEFT,
-  GTK_SIDE_RIGHT
-} GtkSideType;
-#endif /* GTK_DISABLE_DEPRECATED */
-
 /* Reading directions for text */
 typedef enum
 {
@@ -184,19 +180,6 @@ typedef enum
   GTK_JUSTIFY_FILL
 } GtkJustification;
 
-#ifndef GTK_DISABLE_DEPRECATED
-/* GtkPatternSpec match types */
-typedef enum
-{
-  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;
-#endif /* GTK_DISABLE_DEPRECATED */
-
 /* Menu keyboard movement types */
 typedef enum
 {
@@ -206,6 +189,16 @@ typedef enum
   GTK_MENU_DIR_PREV
 } GtkMenuDirectionType;
 
+/**
+ * GtkMessageType:
+ * @GTK_MESSAGE_INFO: Informational message
+ * @GTK_MESSAGE_WARNING: Nonfatal warning message
+ * @GTK_MESSAGE_QUESTION: Question requiring a choice
+ * @GTK_MESSAGE_ERROR: Fatal error message
+ * @GTK_MESSAGE_OTHER: None of the above, doesn't get an icon
+ *
+ * The type of message being displayed in the dialog.
+ */
 typedef enum
 {
   GTK_MESSAGE_INFO,
@@ -215,25 +208,31 @@ typedef enum
   GTK_MESSAGE_OTHER
 } GtkMessageType;
 
+/**
+ * GtkMovementStep:
+ * @GTK_MOVEMENT_LOGICAL_POSITIONS: Move forward or back by graphemes
+ * @GTK_MOVEMENT_VISUAL_POSITIONS:  Move left or right by graphemes
+ * @GTK_MOVEMENT_WORDS:             Move forward or back by words
+ * @GTK_MOVEMENT_DISPLAY_LINES:     Move up or down lines (wrapped lines)
+ * @GTK_MOVEMENT_DISPLAY_LINE_ENDS: Move to either end of a line
+ * @GTK_MOVEMENT_PARAGRAPHS:        Move up or down paragraphs (newline-ended lines)
+ * @GTK_MOVEMENT_PARAGRAPH_ENDS:    Move to either end of a paragraph
+ * @GTK_MOVEMENT_PAGES:             Move by pages
+ * @GTK_MOVEMENT_BUFFER_ENDS:       Move to ends of the buffer
+ * @GTK_MOVEMENT_HORIZONTAL_PAGES:  Move horizontally by pages
+ */
 typedef enum
 {
-  GTK_PIXELS,
-  GTK_INCHES,
-  GTK_CENTIMETERS
-} GtkMetricType;
-
-typedef enum
-{
-  GTK_MOVEMENT_LOGICAL_POSITIONS, /* move by forw/back graphemes */
-  GTK_MOVEMENT_VISUAL_POSITIONS,  /* move by left/right graphemes */
-  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 */
-  GTK_MOVEMENT_BUFFER_ENDS,       /* move to ends of the buffer */
-  GTK_MOVEMENT_HORIZONTAL_PAGES   /* move horizontally by pages */
+  GTK_MOVEMENT_LOGICAL_POSITIONS,
+  GTK_MOVEMENT_VISUAL_POSITIONS,
+  GTK_MOVEMENT_WORDS,
+  GTK_MOVEMENT_DISPLAY_LINES,
+  GTK_MOVEMENT_DISPLAY_LINE_ENDS,
+  GTK_MOVEMENT_PARAGRAPHS,
+  GTK_MOVEMENT_PARAGRAPH_ENDS,
+  GTK_MOVEMENT_PAGES,
+  GTK_MOVEMENT_BUFFER_ENDS,
+  GTK_MOVEMENT_HORIZONTAL_PAGES
 } GtkMovementStep;
 
 typedef enum
@@ -305,14 +304,6 @@ typedef enum
   GTK_POS_BOTTOM
 } GtkPositionType;
 
-#ifndef GTK_DISABLE_DEPRECATED
-typedef enum
-{
-  GTK_PREVIEW_COLOR,
-  GTK_PREVIEW_GRAYSCALE
-} GtkPreviewType;
-#endif /* GTK_DISABLE_DEPRECATED */
-
 /* Style for buttons */
 typedef enum
 {
@@ -329,19 +320,6 @@ typedef enum
   GTK_RESIZE_IMMEDIATE         /* Perform the resizes now */
 } GtkResizeMode;
 
-#ifndef GTK_DISABLE_DEPRECATED
-/* signal run types */
-typedef enum                   /*< flags >*/
-{
-  GTK_RUN_FIRST      = G_SIGNAL_RUN_FIRST,
-  GTK_RUN_LAST       = G_SIGNAL_RUN_LAST,
-  GTK_RUN_BOTH       = (GTK_RUN_FIRST | GTK_RUN_LAST),
-  GTK_RUN_NO_RECURSE = G_SIGNAL_NO_RECURSE,
-  GTK_RUN_ACTION     = G_SIGNAL_ACTION,
-  GTK_RUN_NO_HOOKS   = G_SIGNAL_NO_HOOKS
-} GtkSignalRunType;
-#endif /* GTK_DISABLE_DEPRECATED */
-
 /* scrolling types */
 typedef enum
 {
@@ -369,8 +347,7 @@ typedef enum
   GTK_SELECTION_NONE,                             /* Nothing can be selected */
   GTK_SELECTION_SINGLE,
   GTK_SELECTION_BROWSE,
-  GTK_SELECTION_MULTIPLE,
-  GTK_SELECTION_EXTENDED = GTK_SELECTION_MULTIPLE /* Deprecated */
+  GTK_SELECTION_MULTIPLE
 } GtkSelectionMode;
 
 /* Shadow types */
@@ -393,22 +370,6 @@ typedef enum
   GTK_STATE_INSENSITIVE
 } GtkStateType;
 
-#if !defined(GTK_DISABLE_DEPRECATED) || defined (GTK_MENU_INTERNALS)
-/* Directions for submenus */
-typedef enum
-{
-  GTK_DIRECTION_LEFT,
-  GTK_DIRECTION_RIGHT
-} GtkSubmenuDirection;
-
-/* Placement of submenus */
-typedef enum
-{
-  GTK_TOP_BOTTOM,
-  GTK_LEFT_RIGHT
-} GtkSubmenuPlacement;
-#endif /* GTK_DISABLE_DEPRECATED */
-
 /* Style for toolbars */
 typedef enum
 {
@@ -426,14 +387,6 @@ typedef enum
   GTK_UPDATE_DELAYED
 } GtkUpdateType;
 
-/* Generic visibility flags */
-typedef enum
-{
-  GTK_VISIBILITY_NONE,
-  GTK_VISIBILITY_PARTIAL,
-  GTK_VISIBILITY_FULL
-} GtkVisibility;
-
 /* Window position types */
 typedef enum
 {
@@ -549,6 +502,15 @@ typedef enum
   GTK_UNIT_MM
 } GtkUnit;
 
+/**
+ * GtkTreeViewGridLines:
+ * @GTK_TREE_VIEW_GRID_LINES_NONE: No grid lines.
+ * @GTK_TREE_VIEW_GRID_LINES_HORIZONTAL: Horizontal grid lines.
+ * @GTK_TREE_VIEW_GRID_LINES_VERTICAL: Vertical grid lines.
+ * @GTK_TREE_VIEW_GRID_LINES_BOTH: Horizontal and vertical grid lines.
+ *
+ * Used to indicate which grid lines to draw in a tree view.
+ */
 typedef enum
 {
   GTK_TREE_VIEW_GRID_LINES_NONE,
@@ -567,6 +529,35 @@ typedef enum
   GTK_DRAG_RESULT_ERROR
 } GtkDragResult;
 
+/**
+ * GtkSizeRequestMode:
+ * @GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH: Prefer height-for-width geometry management
+ * @GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT: Prefer width-for-height geometry management
+ * 
+ * Specifies a preference for height-for-width or
+ * width-for-height geometry management.
+ */
+typedef enum
+{
+  GTK_SIZE_REQUEST_HEIGHT_FOR_WIDTH = 0,
+  GTK_SIZE_REQUEST_WIDTH_FOR_HEIGHT
+} GtkSizeRequestMode;
+
+/**
+ * GtkScrollablePolicy:
+ * @GTK_SCROLL_MINIMUM: Scrollable adjustments are based on the minimum size
+ * @GTK_SCROLL_NATURAL: Scrollable adjustments are based on the natural size
+ *
+ * Defines the policy to be used in a scrollable widget when updating
+ * the scrolled window adjustments in a given orientation.
+ */
+typedef enum
+{
+  GTK_SCROLL_MINIMUM = 0,
+  GTK_SCROLL_NATURAL
+} GtkScrollablePolicy;
+
 G_END_DECLS
 
+
 #endif /* __GTK_ENUMS_H__ */