]> Pileus Git - ~andy/gtk/blobdiff - gtk/gtkenums.h
Hide GtkTreeViewColumn buttons when header_window is not visible
[~andy/gtk] / gtk / gtkenums.h
index 6d9b491204540f3f3d6799683ea137d007740737..2891dadf5bee9b281a2cc819a80f78c08a113e4b 100644 (file)
 
 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,8 +93,7 @@ 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,
@@ -202,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 to either end of a line */
-  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
@@ -335,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 */
@@ -350,31 +361,37 @@ typedef enum
 } GtkShadowType;
 
 /* Widget states */
+
+/**
+ * GtkStateType:
+ * @GTK_STATE_NORMAL: State during normal operation.
+ * @GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
+ * @GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
+ *                      the widget and the widget will respond to mouse clicks.
+ * @GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
+ * @GTK_STATE_INSENSITIVE: State indicating that the widget is
+ *                         unresponsive to user actions.
+ * @GTK_STATE_INCONSISTENT: The widget is inconsistent, such as checkbuttons
+ *                          or radiobuttons that aren't either set to %TRUE nor %FALSE,
+ *                          or buttons requiring the user attention.
+ * @GTK_STATE_FOCUSED: The widget has the keyboard focus.
+ *
+ * This type indicates the current state of a widget; the state determines how
+ * the widget is drawn. The #GtkStateType enumeration is also used to
+ * identify different colors in a #GtkStyle for drawing, so states can be
+ * used for subparts of a widget as well as entire widgets.
+ */
 typedef enum
 {
   GTK_STATE_NORMAL,
   GTK_STATE_ACTIVE,
   GTK_STATE_PRELIGHT,
   GTK_STATE_SELECTED,
-  GTK_STATE_INSENSITIVE
+  GTK_STATE_INSENSITIVE,
+  GTK_STATE_INCONSISTENT,
+  GTK_STATE_FOCUSED
 } 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
 {
@@ -392,14 +409,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
 {
@@ -515,6 +524,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,
@@ -533,6 +551,116 @@ 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;
+
+/**
+ * GtkStateFlags:
+ * @GTK_STATE_FLAG_ACTIVE: Widget is active.
+ * @GTK_STATE_FLAG_PRELIGHT: Widget has a mouse pointer over it.
+ * @GTK_STATE_FLAG_SELECTED: Widget is selected.
+ * @GTK_STATE_FLAG_INSENSITIVE: Widget is insensitive.
+ * @GTK_STATE_FLAG_INCONSISTENT: Widget is inconsistent.
+ * @GTK_STATE_FLAG_FOCUSED: Widget has the keyboard focus.
+ *
+ * Describes a widget state.
+ */
+typedef enum
+{
+  GTK_STATE_FLAG_ACTIVE       = 1 << 0,
+  GTK_STATE_FLAG_PRELIGHT     = 1 << 1,
+  GTK_STATE_FLAG_SELECTED     = 1 << 2,
+  GTK_STATE_FLAG_INSENSITIVE  = 1 << 3,
+  GTK_STATE_FLAG_INCONSISTENT = 1 << 4,
+  GTK_STATE_FLAG_FOCUSED      = 1 << 5
+} GtkStateFlags;
+
+/**
+ * GtkRegionFlags:
+ * @GTK_REGION_EVEN: Region has an even number within a set.
+ * @GTK_REGION_ODD: Region has an odd number within a set.
+ * @GTK_REGION_FIRST: Region is the first one within a set.
+ * @GTK_REGION_LAST: Region is the last one within a set.
+ * @GTK_REGION_SORTED: Region is part of a sorted area.
+ *
+ * Describes a region within a widget.
+ */
+typedef enum {
+  GTK_REGION_EVEN    = 1 << 0,
+  GTK_REGION_ODD     = 1 << 1,
+  GTK_REGION_FIRST   = 1 << 2,
+  GTK_REGION_LAST    = 1 << 3,
+  GTK_REGION_SORTED  = 1 << 5
+} GtkRegionFlags;
+
+/**
+ * GtkJunctionSides:
+ * @GTK_JUNCTION_NONE: No junctions.
+ * @GTK_JUNCTION_CORNER_TOPLEFT: Element connects on the top-left corner.
+ * @GTK_JUNCTION_CORNER_TOPRIGHT: Element connects on the top-right corner.
+ * @GTK_JUNCTION_CORNER_BOTTOMLEFT: Element connects on the bottom-left corner.
+ * @GTK_JUNCTION_CORNER_BOTTOMRIGHT: Element connects on the bottom-right corner.
+ * @GTK_JUNCTION_TOP: Element connects on the top side.
+ * @GTK_JUNCTION_BOTTOM: Element connects on the bottom side.
+ * @GTK_JUNCTION_LEFT: Element connects on the left side.
+ * @GTK_JUNCTION_RIGHT: Element connects on the right side.
+ *
+ * Describes how a rendered element connects to adjacent elements.
+ */
+typedef enum {
+  GTK_JUNCTION_NONE   = 0,
+  GTK_JUNCTION_CORNER_TOPLEFT = 1 << 0,
+  GTK_JUNCTION_CORNER_TOPRIGHT = 1 << 1,
+  GTK_JUNCTION_CORNER_BOTTOMLEFT = 1 << 2,
+  GTK_JUNCTION_CORNER_BOTTOMRIGHT = 1 << 3,
+  GTK_JUNCTION_TOP    = (GTK_JUNCTION_CORNER_TOPLEFT | GTK_JUNCTION_CORNER_TOPRIGHT),
+  GTK_JUNCTION_BOTTOM = (GTK_JUNCTION_CORNER_BOTTOMLEFT | GTK_JUNCTION_CORNER_BOTTOMRIGHT),
+  GTK_JUNCTION_LEFT   = (GTK_JUNCTION_CORNER_TOPLEFT | GTK_JUNCTION_CORNER_BOTTOMLEFT),
+  GTK_JUNCTION_RIGHT  = (GTK_JUNCTION_CORNER_TOPRIGHT | GTK_JUNCTION_CORNER_BOTTOMRIGHT)
+} GtkJunctionSides;
+
+/**
+ * GtkBorderStyle:
+ * @GTK_BORDER_STYLE_NONE: No visible border
+ * @GTK_BORDER_STYLE_SOLID: A solid border
+ * @GTK_BORDER_STYLE_INSET: An inset border
+ * @GTK_BORDER_STYLE_OUTSET: An outset border
+ *
+ * Describes how the border of a UI element should be rendered.
+ */
+typedef enum {
+  GTK_BORDER_STYLE_NONE,
+  GTK_BORDER_STYLE_SOLID,
+  GTK_BORDER_STYLE_INSET,
+  GTK_BORDER_STYLE_OUTSET
+} GtkBorderStyle;
+
 G_END_DECLS
 
+
 #endif /* __GTK_ENUMS_H__ */