1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
5 Public enumerated types used throughout GTK+
7 <!-- ##### SECTION Long_Description ##### -->
12 <!-- ##### SECTION See_Also ##### -->
17 <!-- ##### SECTION Stability_Level ##### -->
20 <!-- ##### ENUM GtkAccelFlags ##### -->
29 <!-- ##### ENUM GtkAnchorType ##### -->
36 @GTK_ANCHOR_NORTH_WEST:
37 @GTK_ANCHOR_NORTH_EAST:
39 @GTK_ANCHOR_SOUTH_WEST:
40 @GTK_ANCHOR_SOUTH_EAST:
52 <!-- ##### ENUM GtkArrowPlacement ##### -->
54 Used to specify the placement of scroll arrows in scrolling menus.
57 @GTK_ARROWS_BOTH: Place one arrow on each end of the menu.
58 @GTK_ARROWS_START: Place both arrows at the top of the menu.
59 @GTK_ARROWS_END: Place both arrows at the bottom of the menu.
61 <!-- ##### ENUM GtkArrowType ##### -->
63 Used to indicate the direction in which a #GtkArrow should point.
66 @GTK_ARROW_UP: Represents an upward pointing arrow.
67 @GTK_ARROW_DOWN: Represents a downward pointing arrow.
68 @GTK_ARROW_LEFT: Represents a left pointing arrow.
69 @GTK_ARROW_RIGHT: Represents a right pointing arrow.
70 @GTK_ARROW_NONE: No arrow. Since 2.10.
72 <!-- ##### ENUM GtkAttachOptions ##### -->
74 Denotes the expansion properties that a widget will have when it (or its
78 @GTK_EXPAND: the widget should expand to take up any extra space in its
79 container that has been allocated.
80 @GTK_SHRINK: the widget should shrink as and when possible.
81 @GTK_FILL: the widget should fill the space allocated to it.
83 <!-- ##### ENUM GtkButtonBoxStyle ##### -->
85 Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
86 contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
89 @GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
90 @GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the box.
91 @GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the box.
92 @GTK_BUTTONBOX_START: Buttons are grouped towards the start of the box,
93 (on the left for a HBox, or the top for a VBox).
94 @GTK_BUTTONBOX_END: Buttons are grouped towards the end of the box,
95 (on the right for a HBox, or the bottom for a VBox).
96 @GTK_BUTTONBOX_CENTER: Buttons are centered in the box. Since 2.12
98 <!-- ##### ENUM GtkCornerType ##### -->
100 Specifies which corner a child widget should be placed in when packed into
101 a #GtkScrolledWindow. This is effectively the opposite of where the scroll
105 @GTK_CORNER_TOP_LEFT: Place the scrollbars on the right and bottom of the
106 widget (default behaviour).
107 @GTK_CORNER_BOTTOM_LEFT: Place the scrollbars on the top and right of the
109 @GTK_CORNER_TOP_RIGHT: Place the scrollbars on the left and bottom of the
111 @GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the
114 <!-- ##### ENUM GtkCurveType ##### -->
119 @GTK_CURVE_TYPE_LINEAR:
120 @GTK_CURVE_TYPE_SPLINE:
121 @GTK_CURVE_TYPE_FREE:
123 <!-- ##### ENUM GtkDeleteType ##### -->
129 @GTK_DELETE_WORD_ENDS:
131 @GTK_DELETE_DISPLAY_LINES:
132 @GTK_DELETE_DISPLAY_LINE_ENDS:
133 @GTK_DELETE_PARAGRAPH_ENDS:
134 @GTK_DELETE_PARAGRAPHS:
135 @GTK_DELETE_WHITESPACE:
137 <!-- ##### ENUM GtkDirectionType ##### -->
142 @GTK_DIR_TAB_FORWARD:
143 @GTK_DIR_TAB_BACKWARD:
149 <!-- ##### ENUM GtkExpanderStyle ##### -->
151 Used to specify the style of the expanders drawn by a #GtkTreeView.
154 @GTK_EXPANDER_COLLAPSED: The style used for a collapsed subtree.
155 @GTK_EXPANDER_SEMI_COLLAPSED: Intermediate style used during animation.
156 @GTK_EXPANDER_SEMI_EXPANDED: Intermediate style used during animation.
157 @GTK_EXPANDER_EXPANDED: The style used for an expanded subtree.
159 <!-- ##### ENUM GtkIMPreeditStyle ##### -->
164 @GTK_IM_PREEDIT_NOTHING:
165 @GTK_IM_PREEDIT_CALLBACK:
166 @GTK_IM_PREEDIT_NONE:
168 <!-- ##### ENUM GtkIMStatusStyle ##### -->
173 @GTK_IM_STATUS_NOTHING:
174 @GTK_IM_STATUS_CALLBACK:
177 <!-- ##### ENUM GtkJustification ##### -->
179 Used for justifying the text inside a #GtkLabel widget. (See also
183 @GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
184 @GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
185 @GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
186 @GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
188 <!-- ##### ENUM GtkMatchType ##### -->
200 <!-- ##### ENUM GtkMetricType ##### -->
202 Used to indicate which metric is used by a #GtkRuler.
207 @GTK_CENTIMETERS: Centimeters.
209 <!-- ##### ENUM GtkMovementStep ##### -->
214 @GTK_MOVEMENT_LOGICAL_POSITIONS:
215 @GTK_MOVEMENT_VISUAL_POSITIONS:
217 @GTK_MOVEMENT_DISPLAY_LINES:
218 @GTK_MOVEMENT_DISPLAY_LINE_ENDS:
219 @GTK_MOVEMENT_PARAGRAPHS:
220 @GTK_MOVEMENT_PARAGRAPH_ENDS:
222 @GTK_MOVEMENT_BUFFER_ENDS:
223 @GTK_MOVEMENT_HORIZONTAL_PAGES:
225 <!-- ##### ENUM GtkOrientation ##### -->
227 Represents the orientation of widgets which can be switched between horizontal
228 and vertical orientation on the fly, like #GtkToolbar.
231 @GTK_ORIENTATION_HORIZONTAL: The widget is in horizontal orientation.
232 @GTK_ORIENTATION_VERTICAL: The widget is in vertical orientation.
234 <!-- ##### ENUM GtkPackType ##### -->
236 Represents the packing location #GtkBox children. (See: #GtkVBox,
237 #GtkHBox, and #GtkButtonBox).
240 @GTK_PACK_START: The child is packed into the start of the box
241 @GTK_PACK_END: The child is packed into the end of the box
243 <!-- ##### ENUM GtkPathPriorityType ##### -->
248 @GTK_PATH_PRIO_LOWEST:
250 @GTK_PATH_PRIO_APPLICATION:
251 @GTK_PATH_PRIO_THEME:
253 @GTK_PATH_PRIO_HIGHEST:
255 <!-- ##### ENUM GtkPathType ##### -->
261 @GTK_PATH_WIDGET_CLASS:
264 <!-- ##### ENUM GtkPolicyType ##### -->
266 Determines when a scroll bar will be visible.
269 @GTK_POLICY_ALWAYS: The scrollbar is always visible.
270 @GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example,
271 when all of a #GtkCList can not be seen.
272 @GTK_POLICY_NEVER: The scrollbar will never appear.
274 <!-- ##### ENUM GtkPositionType ##### -->
276 Describes which edge of a widget a certain feature is positioned at, e.g. the
277 tabs of a #GtkNotebook, the handle of a #GtkHandleBox or the label of a
281 @GTK_POS_LEFT: The feature is at the left edge.
282 @GTK_POS_RIGHT: The feature is at the right edge.
283 @GTK_POS_TOP: The feature is at the top edge.
284 @GTK_POS_BOTTOM: The feature is at the bottom edge.
286 <!-- ##### ENUM GtkPreviewType ##### -->
288 An enumeration which describes whether a preview
289 contains grayscale or red-green-blue data.
292 @GTK_PREVIEW_COLOR: the preview contains red-green-blue data.
293 @GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data.
295 <!-- ##### ENUM GtkReliefStyle ##### -->
297 Indicated the relief to be drawn around a #GtkButton.
300 @GTK_RELIEF_NORMAL: Draw a normal relief.
301 @GTK_RELIEF_HALF: A half relief.
302 @GTK_RELIEF_NONE: No relief.
304 <!-- ##### ENUM GtkResizeMode ##### -->
311 @GTK_RESIZE_IMMEDIATE: Deprecated.
313 <!-- ##### ENUM GtkScrollStep ##### -->
321 @GTK_SCROLL_HORIZONTAL_STEPS:
322 @GTK_SCROLL_HORIZONTAL_PAGES:
323 @GTK_SCROLL_HORIZONTAL_ENDS:
325 <!-- ##### ENUM GtkScrollType ##### -->
332 @GTK_SCROLL_STEP_BACKWARD:
333 @GTK_SCROLL_STEP_FORWARD:
334 @GTK_SCROLL_PAGE_BACKWARD:
335 @GTK_SCROLL_PAGE_FORWARD:
337 @GTK_SCROLL_STEP_DOWN:
339 @GTK_SCROLL_PAGE_DOWN:
340 @GTK_SCROLL_STEP_LEFT:
341 @GTK_SCROLL_STEP_RIGHT:
342 @GTK_SCROLL_PAGE_LEFT:
343 @GTK_SCROLL_PAGE_RIGHT:
347 <!-- ##### ENUM GtkSelectionMode ##### -->
349 Used to control what selections users are allowed to make.
352 @GTK_SELECTION_NONE: No selection is possible.
353 @GTK_SELECTION_SINGLE: Zero or one element may be selected.
354 @GTK_SELECTION_BROWSE: Exactly one element is selected. In some circumstances,
355 such as initially or during a search operation, it's possible for no element
356 to be selected with %GTK_SELECTION_BROWSE. What is really enforced is that
357 the user can't deselect a currently selected element except by selecting
359 @GTK_SELECTION_MULTIPLE: Any number of elements may be selected.
360 Clicks toggle the state of an item. Any number of elements may be selected.
361 The Ctrl key may be used to enlarge the selection, and Shift key to select
362 between the focus and the child pointed to. Some widgets may also allow
363 Click-drag to select a range of elements.
364 @GTK_SELECTION_EXTENDED: Deprecated, behaves identical to %GTK_SELECTION_MULTIPLE.
366 <!-- ##### ENUM GtkShadowType ##### -->
368 Used to change the appearance of an outline typically provided by a #GtkFrame.
371 @GTK_SHADOW_NONE: No outline.
372 @GTK_SHADOW_IN: The outline is bevelled inwards.
373 @GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
374 @GTK_SHADOW_ETCHED_IN: The outline has a sunken 3d appearance.
375 @GTK_SHADOW_ETCHED_OUT: The outline has a raised 3d appearance
377 <!-- ##### ENUM GtkSideType ##### -->
387 <!-- ##### ENUM GtkStateType ##### -->
389 This type indicates the current state of a widget; the state determines how
390 the widget is drawn. The #GtkStateType enumeration is also used to
391 identify different colors in a #GtkStyle for drawing, so states can be
392 used for subparts of a widget as well as entire widgets.
395 @GTK_STATE_NORMAL: State during normal operation.
396 @GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
397 @GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
398 the widget and the widget will respond to mouse clicks.
399 @GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
400 @GTK_STATE_INSENSITIVE: State indicating that the widget is
401 unresponsive to user actions.
403 <!-- ##### ENUM GtkSubmenuDirection ##### -->
405 Indicates the direction a sub-menu will appear.
408 @GTK_DIRECTION_LEFT: A sub-menu will appear
409 @GTK_DIRECTION_RIGHT:
411 <!-- ##### ENUM GtkSubmenuPlacement ##### -->
419 <!-- ##### ENUM GtkToolbarStyle ##### -->
421 Used to customize the appearance of a #GtkToolbar. Note that
422 setting the toolbar style overrides the user's preferences
423 for the default toolbar style. Note that if the button has only
424 a label set and GTK_TOOLBAR_ICONS is used, the label will be
425 visible, and vice versa.
428 @GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
429 @GTK_TOOLBAR_TEXT: Buttons display only text labels in the toolbar.
430 @GTK_TOOLBAR_BOTH: Buttons display text and icons in the toolbar.
431 @GTK_TOOLBAR_BOTH_HORIZ: Buttons display icons and text alongside each
432 other, rather than vertically stacked
434 <!-- ##### ENUM GtkUpdateType ##### -->
439 @GTK_UPDATE_CONTINUOUS:
440 @GTK_UPDATE_DISCONTINUOUS:
443 <!-- ##### ENUM GtkVisibility ##### -->
445 Used by #GtkCList and #GtkCTree to indicate whether a row is visible.
448 @GTK_VISIBILITY_NONE: The row is not visible.
449 @GTK_VISIBILITY_PARTIAL: The row is partially visible.
450 @GTK_VISIBILITY_FULL: The row is fully visible.
452 <!-- ##### ENUM GtkWindowPosition ##### -->
454 Window placement can be influenced using this enumeration. Note that
455 using #GTK_WIN_POS_CENTER_ALWAYS is almost always a bad idea.
456 It won't necessarily work well with all window managers or on all windowing systems.
459 @GTK_WIN_POS_NONE: No influence is made on placement.
460 @GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen.
461 @GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position.
462 @GTK_WIN_POS_CENTER_ALWAYS: Keep window centered as it changes size, etc.
463 @GTK_WIN_POS_CENTER_ON_PARENT: Center the window on its transient
464 parent (see gtk_window_set_transient_for()).
466 <!-- ##### ENUM GtkWindowType ##### -->
468 A #GtkWindow can be one of these types. Most things you'd consider a
469 "window" should have type #GTK_WINDOW_TOPLEVEL; windows with this type
470 are managed by the window manager and have a frame by default (call
471 gtk_window_set_decorated() to toggle the frame). Windows with type
472 #GTK_WINDOW_POPUP are ignored by the window manager; window manager
473 keybindings won't work on them, the window manager won't decorate the
474 window with a frame, many GTK+ features that rely on the window
475 manager will not work (e.g. resize grips and
476 maximization/minimization). #GTK_WINDOW_POPUP is used to implement
477 widgets such as #GtkMenu or tooltips that you normally don't think of
478 as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL.
479 In particular, do not use #GTK_WINDOW_POPUP just to turn off
480 the window borders; use gtk_window_set_decorated() for that.
483 @GTK_WINDOW_TOPLEVEL: A regular window, such as a dialog.
484 @GTK_WINDOW_POPUP: A special window such as a tooltip.
486 <!-- ##### ENUM GtkSortType ##### -->
488 Determines the direction of a sort.
491 @GTK_SORT_ASCENDING: Sorting is in ascending order.
492 @GTK_SORT_DESCENDING: Sorting is in descending order.
494 <!-- ##### ENUM GtkDragResult ##### -->
496 Gives an indication why a drag operation failed.
497 The value can by obtained by connecting to the
498 #GtkWidget::drag-failed signal.
501 @GTK_DRAG_RESULT_SUCCESS: The drag operation was successful
502 @GTK_DRAG_RESULT_NO_TARGET: No suitable drag target
503 @GTK_DRAG_RESULT_USER_CANCELLED: The user cancelled the drag operation
504 @GTK_DRAG_RESULT_TIMEOUT_EXPIRED: The drag operation timed out
505 @GTK_DRAG_RESULT_GRAB_BROKEN: The pointer or keyboard grab used
506 for the drag operation was broken
507 @GTK_DRAG_RESULT_ERROR: The drag operation failed due to some