GTK+ Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# Standard Enumerations

## Name

Standard Enumerations -- Public enumerated types used throughout GTK+.

## Synopsis

    #include <gtk/gtk.h>

    enum        GtkAccelFlags;
    enum        GtkArrowType;
    enum        GtkAttachOptions;
    enum        GtkButtonBoxStyle;
    enum        GtkCornerType;
    enum        GtkCurveType;
    enum        GtkDirectionType;
    enum        GtkJustification;
    enum        GtkMatchType;
    enum        GtkMetricType;
    enum        GtkOrientation;
    enum        GtkPackType;
    enum        GtkPathPriorityType;
    enum        GtkPathType;
    enum        GtkPolicyType;
    enum        GtkPositionType;
    enum        GtkPreviewType;
    enum        GtkReliefStyle;
    enum        GtkResizeMode;
    enum        GtkScrollType;
    enum        GtkSelectionMode;
    enum        GtkShadowType;
    enum        GtkStateType;
    enum        GtkSubmenuDirection;
    enum        GtkSubmenuPlacement;
    enum        GtkToolbarStyle;
    enum        GtkTroughType;
    enum        GtkUpdateType;
    enum        GtkVisibility;
    enum        GtkWindowPosition;
    enum        GtkWindowType;
    enum        GtkSortType;

## Description

## Details

### enum GtkAccelFlags

    typedef enum
    {
      /* should the accelerator appear in
       * the widget's display?
       */
      GTK_ACCEL_VISIBLE        = 1 << 0,
      /* should the signal associated with
       * this accelerator be also visible?
       */
      GTK_ACCEL_SIGNAL_VISIBLE = 1 << 1,
      /* may the accelerator be removed
       * again?
       */
      GTK_ACCEL_LOCKED         = 1 << 2,
      GTK_ACCEL_MASK           = 0x07
    } GtkAccelFlags;

### enum GtkArrowType

    typedef enum
    {
      GTK_ARROW_UP,
      GTK_ARROW_DOWN,
      GTK_ARROW_LEFT,
      GTK_ARROW_RIGHT
    } GtkArrowType;

Used to indicate the direction in which a GtkArrow should point.

`GTK_ARROW_UP` | Represents an upward pointing arrow.
`GTK_ARROW_DOWN` | Represents a downward pointing arrow.
`GTK_ARROW_LEFT` | Represents a left pointing arrow.
`GTK_ARROW_RIGHT` | Represents a right pointing arrow.

### enum GtkAttachOptions

    typedef enum
    {
      GTK_EXPAND = 1 << 0,
      GTK_SHRINK = 1 << 1,
      GTK_FILL   = 1 << 2
    } GtkAttachOptions;

Denotes the expansion properties that a widget will have when it (or it's parent) is resized.

`GTK_EXPAND` | the widget should expand to take up any extra space in its container that has been allocated.
`GTK_SHRINK` | the widget should shrink as and when possible.
`GTK_FILL` | the widget should fill the space allocated to it.

### enum GtkButtonBoxStyle

    typedef enum
    {
      GTK_BUTTONBOX_DEFAULT_STYLE,
      GTK_BUTTONBOX_SPREAD,
      GTK_BUTTONBOX_EDGE,
      GTK_BUTTONBOX_START,
      GTK_BUTTONBOX_END
    } GtkButtonBoxStyle;

Used to dictate the style that a GtkButtonBox uses to layout the buttons it contains. (See also: GtkVButtonBox and GtkHButtonBox).

`GTK_BUTTONBOX_DEFAULT_STYLE` | Default packing.
`GTK_BUTTONBOX_SPREAD` | Buttons are evenly spread across the ButtonBox.
`GTK_BUTTONBOX_EDGE` | Buttons are placed at the edges of the ButtonBox.
`GTK_BUTTONBOX_START` | Buttons are grouped towards the start of box, (on the left for a HBox, or the top for a VBox).
`GTK_BUTTONBOX_END` | Buttons are grouped towards the end of a box, (on the right for a HBox, or the bottom for a VBox).

### enum GtkCornerType

    typedef enum
    {
      GTK_CORNER_TOP_LEFT,
      GTK_CORNER_BOTTOM_LEFT,
      GTK_CORNER_TOP_RIGHT,
      GTK_CORNER_BOTTOM_RIGHT
    } GtkCornerType;

Specifies which corner a child widget should be placed in when packed into a GtkScrolledWindow. This is effectively the opposite of where the scroll bars are placed.

`GTK_CORNER_TOP_LEFT` | Place the scrollbars on the right and bottom of the widget (default behaviour).
`GTK_CORNER_BOTTOM_LEFT` | Place the scrollbars on the top and right of the widget.
`GTK_CORNER_TOP_RIGHT` | Place the scrollbars on the left and bottom of the widget.
`GTK_CORNER_BOTTOM_RIGHT` | Place the scrollbars on the top and left of the widget.

### enum GtkCurveType

    typedef enum
    {
      GTK_CURVE_TYPE_LINEAR,       /* linear interpolation */
      GTK_CURVE_TYPE_SPLINE,       /* spline interpolation */
      GTK_CURVE_TYPE_FREE          /* free form curve */
    } GtkCurveType;

### enum GtkDirectionType

    typedef enum
    {
      GTK_DIR_TAB_FORWARD,
      GTK_DIR_TAB_BACKWARD,
      GTK_DIR_UP,
      GTK_DIR_DOWN,
      GTK_DIR_LEFT,
      GTK_DIR_RIGHT
    } GtkDirectionType;

### enum GtkJustification

    typedef enum
    {
      GTK_JUSTIFY_LEFT,
      GTK_JUSTIFY_RIGHT,
      GTK_JUSTIFY_CENTER,
      GTK_JUSTIFY_FILL
    } GtkJustification;

Used for justifying the text inside a GtkLabel widget. (See also GtkAlignment).

`GTK_JUSTIFY_LEFT` | The text is placed at the left edge of the label.
`GTK_JUSTIFY_RIGHT` | The text is placed at the right edge of the label.
`GTK_JUSTIFY_CENTER` | The text is placed in the center of the label.
`GTK_JUSTIFY_FILL` | The text is placed is distributed across the label.

### enum GtkMatchType

    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;

### enum GtkMetricType

    typedef enum
    {
      GTK_PIXELS,
      GTK_INCHES,
      GTK_CENTIMETERS
    } GtkMetricType;

### enum GtkOrientation

    typedef enum
    {
      GTK_ORIENTATION_HORIZONTAL,
      GTK_ORIENTATION_VERTICAL
    } GtkOrientation;

### enum GtkPackType

    typedef enum
    {
      GTK_PACK_START,
      GTK_PACK_END
    } GtkPackType;

Used for packing widgets into GtkBox widgets. (See also: GtkVBox, GtkHBox, and GtkButtonBox).

`GTK_PACK_START` | The
`GTK_PACK_END` |

### enum GtkPathPriorityType

    typedef enum
    {
      GTK_PATH_PRIO_LOWEST      = 0,
      GTK_PATH_PRIO_GTK	    = 4,
      GTK_PATH_PRIO_APPLICATION = 8,
      GTK_PATH_PRIO_RC          = 12,
      GTK_PATH_PRIO_HIGHEST     = 15,
      GTK_PATH_PRIO_MASK        = 0x0f
    } GtkPathPriorityType;

### enum GtkPathType

    typedef enum
    {
      GTK_PATH_WIDGET,
      GTK_PATH_WIDGET_CLASS,
      GTK_PATH_CLASS
    } GtkPathType;

### enum GtkPolicyType

    typedef enum
    {
      GTK_POLICY_ALWAYS,
      GTK_POLICY_AUTOMATIC,
      GTK_POLICY_NEVER
    } GtkPolicyType;

Determines when a scroll bar will be visible.

`GTK_POLICY_ALWAYS` | The scrollbar is always visible.
`GTK_POLICY_AUTOMATIC` | The scrollbar will appear and disappear as necessary. For example, when all of a GtkCList can not be seen.
`GTK_POLICY_NEVER` | The scrollbar will never appear.

### enum GtkPositionType

    typedef enum
    {
      GTK_POS_LEFT,
      GTK_POS_RIGHT,
      GTK_POS_TOP,
      GTK_POS_BOTTOM
    } GtkPositionType;

### enum GtkPreviewType

    typedef enum
    {
      GTK_PREVIEW_COLOR,
      GTK_PREVIEW_GRAYSCALE
    } GtkPreviewType;

An enumeration which describes whether a preview contains grayscale or red-green-blue data.

`GTK_PREVIEW_COLOR` | the preview contains red-green-blue data.
`GTK_PREVIEW_GRAYSCALE` | The preview contains grayscale data.

### enum GtkReliefStyle

    typedef enum
    {
      GTK_RELIEF_NORMAL,
      GTK_RELIEF_HALF,
      GTK_RELIEF_NONE
    } GtkReliefStyle;

### enum GtkResizeMode

    typedef enum
    {
      GTK_RESIZE_PARENT,		/* Pass resize request to the parent */
      GTK_RESIZE_QUEUE,		/* Queue resizes on this widget */
      GTK_RESIZE_IMMEDIATE		/* Perform the resizes now */
    } GtkResizeMode;

### enum GtkScrollType

    typedef enum
    {
      GTK_SCROLL_NONE,
      GTK_SCROLL_STEP_BACKWARD,
      GTK_SCROLL_STEP_FORWARD,
      GTK_SCROLL_PAGE_BACKWARD,
      GTK_SCROLL_PAGE_FORWARD,
      GTK_SCROLL_JUMP
    } GtkScrollType;

### enum GtkSelectionMode

    typedef enum
    {
      GTK_SELECTION_SINGLE,
      GTK_SELECTION_BROWSE,
      GTK_SELECTION_MULTIPLE,
      GTK_SELECTION_EXTENDED
    } GtkSelectionMode;

### enum GtkShadowType

    typedef enum
    {
      GTK_SHADOW_NONE,
      GTK_SHADOW_IN,
      GTK_SHADOW_OUT,
      GTK_SHADOW_ETCHED_IN,
      GTK_SHADOW_ETCHED_OUT
    } GtkShadowType;

Used to change the appearance of an outline typically provided by a GtkFrame.

`GTK_SHADOW_NONE` | No outline.
`GTK_SHADOW_IN` | The outline is bevelled inwards.
`GTK_SHADOW_OUT` | The outline is bevelled outwards like a button.
`GTK_SHADOW_ETCHED_IN` | The outline itself is an inward bevel, but the frame does
`GTK_SHADOW_ETCHED_OUT` |

### enum GtkStateType

    typedef enum
    {
      GTK_STATE_NORMAL,
      GTK_STATE_ACTIVE,
      GTK_STATE_PRELIGHT,
      GTK_STATE_SELECTED,
      GTK_STATE_INSENSITIVE
    } GtkStateType;

This type indicates the current state of a widget.

`GTK_STATE_NORMAL` | The state during normal operation.
`GTK_STATE_ACTIVE` | The widget is currently active, such as a
`GTK_STATE_PRELIGHT` | The mouse pointer is over the widget.
`GTK_STATE_SELECTED` |
`GTK_STATE_INSENSITIVE` | The state of the widget can not be altered by the user. Its appearance will usually indicate this.

### enum GtkSubmenuDirection

    typedef enum
    {
      GTK_DIRECTION_LEFT,
      GTK_DIRECTION_RIGHT
    } GtkSubmenuDirection;

Indicates the direction a sub-menu will appear.

`GTK_DIRECTION_LEFT` | A sub-menu will appear
`GTK_DIRECTION_RIGHT` |

### enum GtkSubmenuPlacement

    typedef enum
    {
      GTK_TOP_BOTTOM,
      GTK_LEFT_RIGHT
    } GtkSubmenuPlacement;

### enum GtkToolbarStyle

    typedef enum
    {
      GTK_TOOLBAR_ICONS,
      GTK_TOOLBAR_TEXT,
      GTK_TOOLBAR_BOTH
    } GtkToolbarStyle;

Used to customize the appearance of a GtkToolbar.

`GTK_TOOLBAR_ICONS` | Buttons should display only icons in the toolbar.
`GTK_TOOLBAR_TEXT` | Buttons should display only text labels in the toolbar.
`GTK_TOOLBAR_BOTH` | Buttons should display text and icons in the toolbar.

### enum GtkTroughType

    typedef enum
    {
      GTK_TROUGH_NONE,
      GTK_TROUGH_START,
      GTK_TROUGH_END,
      GTK_TROUGH_JUMP
    } GtkTroughType;

### enum GtkUpdateType

    typedef enum
    {
      GTK_UPDATE_CONTINUOUS,
      GTK_UPDATE_DISCONTINUOUS,
      GTK_UPDATE_DELAYED
    } GtkUpdateType;

### enum GtkVisibility

    typedef enum
    {
      GTK_VISIBILITY_NONE,
      GTK_VISIBILITY_PARTIAL,
      GTK_VISIBILITY_FULL
    } GtkVisibility;

### enum GtkWindowPosition

    typedef enum
    {
      GTK_WIN_POS_NONE,
      GTK_WIN_POS_CENTER,
      GTK_WIN_POS_MOUSE
    } GtkWindowPosition;

Window placement can be influenced using this enumeration.

`GTK_WIN_POS_NONE` | No influence is made on placement.
`GTK_WIN_POS_CENTER` | Windows should be placed in the center of the screen.
`GTK_WIN_POS_MOUSE` | Windows should be placed at the current mouse position.

### enum GtkWindowType

    typedef enum
    {
      GTK_WINDOW_TOPLEVEL,
      GTK_WINDOW_DIALOG,
      GTK_WINDOW_POPUP
    } GtkWindowType;

A GtkWindow can be of these types. A toplevel window has standard window decorations by default. A dialog may have fewer decorations and obey a different placement policy. A popup window will have no decorations.

It should be noted that such decorations can often be over-ridden by modern window managers.

`GTK_WINDOW_TOPLEVEL` | A window for a typical application.
`GTK_WINDOW_DIALOG` | A window for transient messages and dialogs.
`GTK_WINDOW_POPUP` | A window for popups.

### enum GtkSortType

    typedef enum
    {
      GTK_SORT_ASCENDING,
      GTK_SORT_DESCENDING
    } GtkSortType;

Determines the direction of a sort.

`GTK_SORT_ASCENDING` | Sorting is in ascending order.
`GTK_SORT_DESCENDING` | Sorting is in descending order.

<<< Previous Page | Home | Up | Next Page >>>
Bindings | Private Information