manpagez: man pages & more
html files: gtk
Home | html | info | man

Standard Enumerations

Standard Enumerations — Public enumerated types used throughout GTK+

Includes

#include <gtk/gtk.h>

Description

Functions

Types and Values

enum GtkAccelFlags

Accelerator flags used with gtk_accel_group_connect().

Members

GTK_ACCEL_VISIBLE

Accelerator is visible

 

GTK_ACCEL_LOCKED

Accelerator not removable

 

GTK_ACCEL_MASK

Mask

 

enum GtkArrowPlacement

Used to specify the placement of scroll arrows in scrolling menus.

Members

GTK_ARROWS_BOTH

Place one arrow on each end of the menu.

 

GTK_ARROWS_START

Place both arrows at the top of the menu.

 

GTK_ARROWS_END

Place both arrows at the bottom of the menu.

 

enum GtkArrowType

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

Members

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.

 

GTK_ARROW_NONE

No arrow. Since 2.10.

 

enum GtkAttachOptions

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

Members

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 GtkBaselinePosition

Whenever a container has some form of natural row it may align children in that row along a common typographical baseline. If the amount of verical space in the row is taller than the total requested height of the baseline-aligned children then it can use a GtkBaselinePosition to select where to put the baseline inside the extra availible space.

Members

GTK_BASELINE_POSITION_TOP

Align the baseline at the top

 

GTK_BASELINE_POSITION_CENTER

Center the baseline

 

GTK_BASELINE_POSITION_BOTTOM

Align the baseline at the bottom

 

Since 3.10


enum GtkButtonBoxStyle

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

Members

GTK_BUTTONBOX_SPREAD

Buttons are evenly spread across the box.

 

GTK_BUTTONBOX_EDGE

Buttons are placed at the edges of the box.

 

GTK_BUTTONBOX_START

Buttons are grouped towards the start of the box, (on the left for a HBox, or the top for a VBox).

 

GTK_BUTTONBOX_END

Buttons are grouped towards the end of the box, (on the right for a HBox, or the bottom for a VBox).

 

GTK_BUTTONBOX_CENTER

Buttons are centered in the box. Since 2.12.

 

GTK_BUTTONBOX_EXPAND

Buttons expand to fill the box. Since 3.12.

 

enum 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.

Members

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 GtkDeleteType

See also: “delete-from-cursor”.

Members

GTK_DELETE_CHARS

Delete characters.

 

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

Delete words.

 

GTK_DELETE_DISPLAY_LINES

Delete display-lines. Display-lines refers to the visible lines, with respect to to the current line breaks. As opposed to paragraphs, which are defined by line breaks in the input.

 

GTK_DELETE_DISPLAY_LINE_ENDS

Delete only the portion of the display-line to the left/right of cursor.

 

GTK_DELETE_PARAGRAPH_ENDS

Delete to the end of the paragraph. Like C-k in Emacs (or its reverse).

 

GTK_DELETE_PARAGRAPHS

Delete entire line. Like C-k in pico.

 

GTK_DELETE_WHITESPACE

Delete only whitespace. Like M-\ in Emacs.

 

enum GtkDirectionType

Focus movement types.

Members

GTK_DIR_TAB_FORWARD

Move forward.

 

GTK_DIR_TAB_BACKWARD

Move backward.

 

GTK_DIR_UP

Move up.

 

GTK_DIR_DOWN

Move down.

 

GTK_DIR_LEFT

Move left.

 

GTK_DIR_RIGHT

Move right.

 

enum GtkExpanderStyle

Used to specify the style of the expanders drawn by a GtkTreeView.

Members

GTK_EXPANDER_COLLAPSED

The style used for a collapsed subtree.

 

GTK_EXPANDER_SEMI_COLLAPSED

Intermediate style used during animation.

 

GTK_EXPANDER_SEMI_EXPANDED

Intermediate style used during animation.

 

GTK_EXPANDER_EXPANDED

The style used for an expanded subtree.

 

enum GtkIMPreeditStyle

GtkIMPreeditStyle has been deprecated since version 3.10 and should not be used in newly-written code.

Style for input method preedit. See also “gtk-im-preedit-style”

Members

GTK_IM_PREEDIT_NOTHING

Deprecated

 

GTK_IM_PREEDIT_CALLBACK

Deprecated

 

GTK_IM_PREEDIT_NONE

Deprecated

 

enum GtkIMStatusStyle

GtkIMStatusStyle has been deprecated since version 3.10 and should not be used in newly-written code.

Style for input method status. See also “gtk-im-status-style”

Members

GTK_IM_STATUS_NOTHING

Deprecated

 

GTK_IM_STATUS_CALLBACK

Deprecated

 

GTK_IM_STATUS_NONE

Deprecated

 

enum GtkJustification

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

Members

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 GtkMovementStep

Members

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

 

enum GtkOrientation

Represents the orientation of widgets which can be switched between horizontal and vertical orientation on the fly, like GtkToolbar.

Members

GTK_ORIENTATION_HORIZONTAL

The widget is in horizontal orientation.

 

GTK_ORIENTATION_VERTICAL

The widget is in vertical orientation.

 

enum GtkPackType

Represents the packing location GtkBox children. (See: GtkVBox, GtkHBox, and GtkButtonBox).

Members

GTK_PACK_START

The child is packed into the start of the box

 

GTK_PACK_END

The child is packed into the end of the box

 

enum GtkPathPriorityType

GtkPathPriorityType has been deprecated since version 3.0 and should not be used in newly-written code.

Priorities for path lookups. See also gtk_binding_set_add_path().

Members

GTK_PATH_PRIO_LOWEST

Deprecated

 

GTK_PATH_PRIO_GTK

Deprecated

 

GTK_PATH_PRIO_APPLICATION

Deprecated

 

GTK_PATH_PRIO_THEME

Deprecated

 

GTK_PATH_PRIO_RC

Deprecated

 

GTK_PATH_PRIO_HIGHEST

Deprecated

 

enum GtkPathType

GtkPathType has been deprecated since version 3.0 and should not be used in newly-written code.

Widget path types. See also gtk_binding_set_add_path().

Members

GTK_PATH_WIDGET

Deprecated

 

GTK_PATH_WIDGET_CLASS

Deprecated

 

GTK_PATH_CLASS

Deprecated

 

enum GtkPolicyType

Determines when a scroll bar will be visible.

Members

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

Describes which edge of a widget a certain feature is positioned at, e.g. the tabs of a GtkNotebook, the handle of a GtkHandleBox or the label of a GtkScale.

Members

GTK_POS_LEFT

The feature is at the left edge.

 

GTK_POS_RIGHT

The feature is at the right edge.

 

GTK_POS_TOP

The feature is at the top edge.

 

GTK_POS_BOTTOM

The feature is at the bottom edge.

 

enum GtkReliefStyle

Indicated the relief to be drawn around a GtkButton.

Members

GTK_RELIEF_NORMAL

Draw a normal relief.

 

GTK_RELIEF_HALF

A half relief.

 

GTK_RELIEF_NONE

No relief.

 

enum GtkResizeMode

Members

GTK_RESIZE_PARENT

Pass resize request to the parent

 

GTK_RESIZE_QUEUE

Queue resizes on this widget

 

GTK_RESIZE_IMMEDIATE

Resize immediately. Deprecated.

 

enum GtkScrollStep

Members

GTK_SCROLL_STEPS

Scroll in steps.

 

GTK_SCROLL_PAGES

Scroll by pages.

 

GTK_SCROLL_ENDS

Scroll to ends.

 

GTK_SCROLL_HORIZONTAL_STEPS

Scroll in horizontal steps.

 

GTK_SCROLL_HORIZONTAL_PAGES

Scroll by horizontal pages.

 

GTK_SCROLL_HORIZONTAL_ENDS

Scroll to the horizontal ends.

 

enum GtkScrollType

Scrolling types.

Members

GTK_SCROLL_NONE

No scrolling.

 

GTK_SCROLL_JUMP

Jump to new location.

 

GTK_SCROLL_STEP_BACKWARD

Step backward.

 

GTK_SCROLL_STEP_FORWARD

Step forward.

 

GTK_SCROLL_PAGE_BACKWARD

Page backward.

 

GTK_SCROLL_PAGE_FORWARD

Page forward.

 

GTK_SCROLL_STEP_UP

Step up.

 

GTK_SCROLL_STEP_DOWN

Step down.

 

GTK_SCROLL_PAGE_UP

Page up.

 

GTK_SCROLL_PAGE_DOWN

Page down.

 

GTK_SCROLL_STEP_LEFT

Step to the left.

 

GTK_SCROLL_STEP_RIGHT

Step to the right.

 

GTK_SCROLL_PAGE_LEFT

Page to the left.

 

GTK_SCROLL_PAGE_RIGHT

Page to the right.

 

GTK_SCROLL_START

Scroll to start.

 

GTK_SCROLL_END

Scroll to end.

 

enum GtkSelectionMode

Used to control what selections users are allowed to make.

Members

GTK_SELECTION_NONE

No selection is possible.

 

GTK_SELECTION_SINGLE

Zero or one element may be selected.

 

GTK_SELECTION_BROWSE

Exactly one element is selected. In some circumstances, such as initially or during a search operation, it’s possible for no element to be selected with GTK_SELECTION_BROWSE. What is really enforced is that the user can’t deselect a currently selected element except by selecting another element.

 

GTK_SELECTION_MULTIPLE

Any number of elements may be selected. The Ctrl key may be used to enlarge the selection, and Shift key to select between the focus and the child pointed to. Some widgets may also allow Click-drag to select a range of elements.

 

enum GtkShadowType

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

Members

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 has a sunken 3d appearance.

 

GTK_SHADOW_ETCHED_OUT

The outline has a raised 3d appearance.

 

enum GtkStateType

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.

Members

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.

 

enum GtkStateFlags

Describes a widget state. Widget states are used to match the widget against CSS pseudo-classes. Note that GTK extends the regular CSS classes and sometimes uses different names.

Members

GTK_STATE_FLAG_NORMAL

State during normal operation.

 

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.

 

GTK_STATE_FLAG_BACKDROP

Widget is in a background toplevel window.

 

GTK_STATE_FLAG_DIR_LTR

Widget is in left-to-right text direction. Since 3.8

 

GTK_STATE_FLAG_DIR_RTL

Widget is in right-to-left text direction. Since 3.8

 

GTK_STATE_FLAG_LINK

Widget is a link. Since 3.12

 

GTK_STATE_FLAG_VISITED

The location the widget points to has already been visited. Since 3.12

 

enum GtkToolbarStyle

Used to customize the appearance of a GtkToolbar. Note that setting the toolbar style overrides the user’s preferences for the default toolbar style. Note that if the button has only a label set and GTK_TOOLBAR_ICONS is used, the label will be visible, and vice versa.

Members

GTK_TOOLBAR_ICONS

Buttons display only icons in the toolbar.

 

GTK_TOOLBAR_TEXT

Buttons display only text labels in the toolbar.

 

GTK_TOOLBAR_BOTH

Buttons display text and icons in the toolbar.

 

GTK_TOOLBAR_BOTH_HORIZ

Buttons display icons and text alongside each other, rather than vertically stacked

 

enum GtkWindowPosition

Window placement can be influenced using this enumeration. Note that using GTK_WIN_POS_CENTER_ALWAYS is almost always a bad idea. It won’t necessarily work well with all window managers or on all windowing systems.

Members

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.

 

GTK_WIN_POS_CENTER_ALWAYS

Keep window centered as it changes size, etc.

 

GTK_WIN_POS_CENTER_ON_PARENT

Center the window on its transient parent (see gtk_window_set_transient_for()).

 

enum GtkWindowType

A GtkWindow can be one of these types. Most things you’d consider a “window” should have type GTK_WINDOW_TOPLEVEL; windows with this type are managed by the window manager and have a frame by default (call gtk_window_set_decorated() to toggle the frame). Windows with type GTK_WINDOW_POPUP are ignored by the window manager; window manager keybindings won’t work on them, the window manager won’t decorate the window with a frame, many GTK+ features that rely on the window manager will not work (e.g. resize grips and maximization/minimization). GTK_WINDOW_POPUP is used to implement widgets such as GtkMenu or tooltips that you normally don’t think of as windows per se. Nearly all windows should be GTK_WINDOW_TOPLEVEL. In particular, do not use GTK_WINDOW_POPUP just to turn off the window borders; use gtk_window_set_decorated() for that.

Members

GTK_WINDOW_TOPLEVEL

A regular window, such as a dialog.

 

GTK_WINDOW_POPUP

A special window such as a tooltip.

 

enum GtkSortType

Determines the direction of a sort.

Members

GTK_SORT_ASCENDING

Sorting is in ascending order.

 

GTK_SORT_DESCENDING

Sorting is in descending order.

 

enum GtkDragResult

Gives an indication why a drag operation failed. The value can by obtained by connecting to the “drag-failed” signal.

Members

GTK_DRAG_RESULT_SUCCESS

The drag operation was successful.

 

GTK_DRAG_RESULT_NO_TARGET

No suitable drag target.

 

GTK_DRAG_RESULT_USER_CANCELLED

The user cancelled the drag operation.

 

GTK_DRAG_RESULT_TIMEOUT_EXPIRED

The drag operation timed out.

 

GTK_DRAG_RESULT_GRAB_BROKEN

The pointer or keyboard grab used for the drag operation was broken.

 

GTK_DRAG_RESULT_ERROR

The drag operation failed due to some unspecified error.

 

enum GtkJunctionSides

Describes how a rendered element connects to adjacent elements.

Members

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.

 

enum GtkBorderStyle

Describes how the border of a UI element should be rendered.

Members

GTK_BORDER_STYLE_NONE

No visible border

 

GTK_BORDER_STYLE_SOLID

A single line segment

 

GTK_BORDER_STYLE_INSET

Looks as if the content is sunken into the canvas

 

GTK_BORDER_STYLE_OUTSET

Looks as if the content is coming out of the canvas

 

GTK_BORDER_STYLE_HIDDEN

Same as GTK_BORDER_STYLE_NONE

 

GTK_BORDER_STYLE_DOTTED

A series of round dots

 

GTK_BORDER_STYLE_DASHED

A series of square-ended dashes

 

GTK_BORDER_STYLE_DOUBLE

Two parallel lines with some space between them

 

GTK_BORDER_STYLE_GROOVE

Looks as if it were carved in the canvas

 

GTK_BORDER_STYLE_RIDGE

Looks as if it were coming out of the canvas

 

enum GtkRegionFlags

Describes a region within a widget.

Members

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_ONLY

Region is the only one within a set.

 

GTK_REGION_SORTED

Region is part of a sorted area.

 
© manpagez.com 2000-2017
Individual documents may contain additional copyright information.