1 <!-- ##### SECTION Title ##### -->
4 <!-- ##### SECTION Short_Description ##### -->
5 Public enumerated types used throughout GTK+
7 <!-- ##### SECTION Long_Description ##### -->
12 <!-- ##### SECTION See_Also ##### -->
17 <!-- ##### ENUM GtkAccelFlags ##### -->
26 <!-- ##### ENUM GtkAnchorType ##### -->
33 @GTK_ANCHOR_NORTH_WEST:
34 @GTK_ANCHOR_NORTH_EAST:
36 @GTK_ANCHOR_SOUTH_WEST:
37 @GTK_ANCHOR_SOUTH_EAST:
49 <!-- ##### ENUM GtkArrowType ##### -->
51 Used to indicate the direction in which a #GtkArrow should point.
54 @GTK_ARROW_UP: Represents an upward pointing arrow.
55 @GTK_ARROW_DOWN: Represents a downward pointing arrow.
56 @GTK_ARROW_LEFT: Represents a left pointing arrow.
57 @GTK_ARROW_RIGHT: Represents a right pointing arrow.
59 <!-- ##### ENUM GtkAttachOptions ##### -->
61 Denotes the expansion properties that a widget will have when it (or its
65 @GTK_EXPAND: the widget should expand to take up any extra space in its
66 container that has been allocated.
67 @GTK_SHRINK: the widget should shrink as and when possible.
68 @GTK_FILL: the widget should fill the space allocated to it.
70 <!-- ##### ENUM GtkButtonBoxStyle ##### -->
72 Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
73 contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
76 @GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
77 @GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the ButtonBox.
78 @GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the ButtonBox.
79 @GTK_BUTTONBOX_START: Buttons are grouped towards the start of box, (on the
80 left for a HBox, or the top for a VBox).
81 @GTK_BUTTONBOX_END: Buttons are grouped towards the end of a box, (on the
82 right for a HBox, or the bottom for a VBox).
84 <!-- ##### ENUM GtkCornerType ##### -->
86 Specifies which corner a child widget should be placed in when packed into
87 a #GtkScrolledWindow. This is effectively the opposite of where the scroll
91 @GTK_CORNER_TOP_LEFT: Place the scrollbars on the right and bottom of the
92 widget (default behaviour).
93 @GTK_CORNER_BOTTOM_LEFT: Place the scrollbars on the top and right of the
95 @GTK_CORNER_TOP_RIGHT: Place the scrollbars on the left and bottom of the
97 @GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the
100 <!-- ##### ENUM GtkCurveType ##### -->
105 @GTK_CURVE_TYPE_LINEAR:
106 @GTK_CURVE_TYPE_SPLINE:
107 @GTK_CURVE_TYPE_FREE:
109 <!-- ##### ENUM GtkDeleteType ##### -->
115 @GTK_DELETE_WORD_ENDS:
117 @GTK_DELETE_DISPLAY_LINES:
118 @GTK_DELETE_DISPLAY_LINE_ENDS:
119 @GTK_DELETE_PARAGRAPH_ENDS:
120 @GTK_DELETE_PARAGRAPHS:
121 @GTK_DELETE_WHITESPACE:
123 <!-- ##### ENUM GtkDirectionType ##### -->
128 @GTK_DIR_TAB_FORWARD:
129 @GTK_DIR_TAB_BACKWARD:
135 <!-- ##### ENUM GtkExpanderStyle ##### -->
137 Used to specify the style of the expanders drawn by a #GtkTreeView.
140 @GTK_EXPANDER_COLLAPSED: The style used for a collapsed subtree.
141 @GTK_EXPANDER_SEMI_COLLAPSED: Intermediate style used during animation.
142 @GTK_EXPANDER_SEMI_EXPANDED: Intermediate style used during animation.
143 @GTK_EXPANDER_EXPANDED: The style used for an expanded subtree.
145 <!-- ##### ENUM GtkIMPreeditStyle ##### -->
150 @GTK_IM_PREEDIT_NOTHING:
151 @GTK_IM_PREEDIT_CALLBACK:
152 @GTK_IM_PREEDIT_NONE:
154 <!-- ##### ENUM GtkIMStatusStyle ##### -->
159 @GTK_IM_STATUS_NOTHING:
160 @GTK_IM_STATUS_CALLBACK:
163 <!-- ##### ENUM GtkJustification ##### -->
165 Used for justifying the text inside a #GtkLabel widget. (See also
169 @GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
170 @GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
171 @GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
172 @GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
174 <!-- ##### ENUM GtkMatchType ##### -->
186 <!-- ##### ENUM GtkMetricType ##### -->
188 Used to indicate which metric is used by a #GtkRuler.
193 @GTK_CENTIMETERS: Centimeters.
195 <!-- ##### ENUM GtkMovementStep ##### -->
200 @GTK_MOVEMENT_LOGICAL_POSITIONS:
201 @GTK_MOVEMENT_VISUAL_POSITIONS:
203 @GTK_MOVEMENT_DISPLAY_LINES:
204 @GTK_MOVEMENT_DISPLAY_LINE_ENDS:
205 @GTK_MOVEMENT_PARAGRAPHS:
206 @GTK_MOVEMENT_PARAGRAPH_ENDS:
208 @GTK_MOVEMENT_BUFFER_ENDS:
209 @GTK_MOVEMENT_HORIZONTAL_PAGES:
211 <!-- ##### ENUM GtkOrientation ##### -->
213 Represents the orientation of widgets which can be switched between horizontal
214 and vertical orientation on the fly, like #GtkToolbar.
217 @GTK_ORIENTATION_HORIZONTAL: The widget is in horizontal orientation.
218 @GTK_ORIENTATION_VERTICAL: The widget is in vertical orientation.
220 <!-- ##### ENUM GtkPackType ##### -->
222 Represents the packing location #GtkBox children. (See: #GtkVBox,
223 #GtkHBox, and #GtkButtonBox).
226 @GTK_PACK_START: The child is packed into the start of the box
227 @GTK_PACK_END: The child is packed into the end of the box
229 <!-- ##### ENUM GtkPathPriorityType ##### -->
234 @GTK_PATH_PRIO_LOWEST:
236 @GTK_PATH_PRIO_APPLICATION:
237 @GTK_PATH_PRIO_THEME:
239 @GTK_PATH_PRIO_HIGHEST:
241 <!-- ##### ENUM GtkPathType ##### -->
247 @GTK_PATH_WIDGET_CLASS:
250 <!-- ##### ENUM GtkPolicyType ##### -->
252 Determines when a scroll bar will be visible.
255 @GTK_POLICY_ALWAYS: The scrollbar is always visible.
256 @GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example,
257 when all of a #GtkCList can not be seen.
258 @GTK_POLICY_NEVER: The scrollbar will never appear.
260 <!-- ##### ENUM GtkPositionType ##### -->
262 Describes which edge of a widget a certain feature is positioned at, e.g. the
263 tabs of a #GtkNotebook, the handle of a #GtkHandleBox or the label of a
267 @GTK_POS_LEFT: The feature is at the left edge.
268 @GTK_POS_RIGHT: The feature is at the right edge.
269 @GTK_POS_TOP: The feature is at the top edge.
270 @GTK_POS_BOTTOM: The feature is at the bottom edge.
272 <!-- ##### ENUM GtkPreviewType ##### -->
274 An enumeration which describes whether a preview
275 contains grayscale or red-green-blue data.
278 @GTK_PREVIEW_COLOR: the preview contains red-green-blue data.
279 @GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data.
281 <!-- ##### ENUM GtkReliefStyle ##### -->
283 Indicated the relief to be drawn around a #GtkButton.
286 @GTK_RELIEF_NORMAL: Draw a normal relief.
287 @GTK_RELIEF_HALF: A half relief.
288 @GTK_RELIEF_NONE: No relief.
290 <!-- ##### ENUM GtkResizeMode ##### -->
297 @GTK_RESIZE_IMMEDIATE:
299 <!-- ##### ENUM GtkScrollStep ##### -->
307 @GTK_SCROLL_HORIZONTAL_STEPS:
308 @GTK_SCROLL_HORIZONTAL_PAGES:
309 @GTK_SCROLL_HORIZONTAL_ENDS:
311 <!-- ##### ENUM GtkScrollType ##### -->
318 @GTK_SCROLL_STEP_BACKWARD:
319 @GTK_SCROLL_STEP_FORWARD:
320 @GTK_SCROLL_PAGE_BACKWARD:
321 @GTK_SCROLL_PAGE_FORWARD:
323 @GTK_SCROLL_STEP_DOWN:
325 @GTK_SCROLL_PAGE_DOWN:
326 @GTK_SCROLL_STEP_LEFT:
327 @GTK_SCROLL_STEP_RIGHT:
328 @GTK_SCROLL_PAGE_LEFT:
329 @GTK_SCROLL_PAGE_RIGHT:
333 <!-- ##### ENUM GtkSelectionMode ##### -->
338 @GTK_SELECTION_NONE: No selection is possible.
339 @GTK_SELECTION_SINGLE: Zero or one element may be selected.
340 @GTK_SELECTION_BROWSE: Exactly one element is always selected
341 (this can be false after you have changed the selection mode).
342 @GTK_SELECTION_MULTIPLE: Any number of elements may be selected.
343 Clicks toggle the state of an item. Any number of elements may be selected.
344 Click-drag selects a range of elements; the Ctrl key may be used to enlarge
345 the selection, and Shift key to select between the focus and the child
347 @GTK_SELECTION_EXTENDED: Deprecated, behaves identical to
348 %GTK_SELECTION_MULTIPLE.
350 <!-- ##### ENUM GtkShadowType ##### -->
352 Used to change the appearance of an outline typically provided by a #GtkFrame.
355 @GTK_SHADOW_NONE: No outline.
356 @GTK_SHADOW_IN: The outline is bevelled inwards.
357 @GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
358 @GTK_SHADOW_ETCHED_IN: The outline itself is an inward bevel, but the frame
360 @GTK_SHADOW_ETCHED_OUT:
362 <!-- ##### ENUM GtkSideType ##### -->
372 <!-- ##### ENUM GtkStateType ##### -->
374 This type indicates the current state of a widget; the state determines how
375 the widget is drawn. The #GtkStateType enumeration is also used to
376 identify different colors in a #GtkStyle for drawing, so states can be
377 used for subparts of a widget as well as entire widgets.
380 @GTK_STATE_NORMAL: State during normal operation.
381 @GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
382 @GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
383 the widget and the widget will respond to mouse clicks.
384 @GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
385 @GTK_STATE_INSENSITIVE: State indicating that the widget is
386 unresponsive to user actions.
388 <!-- ##### ENUM GtkSubmenuDirection ##### -->
390 Indicates the direction a sub-menu will appear.
393 @GTK_DIRECTION_LEFT: A sub-menu will appear
394 @GTK_DIRECTION_RIGHT:
396 <!-- ##### ENUM GtkSubmenuPlacement ##### -->
404 <!-- ##### ENUM GtkToolbarStyle ##### -->
406 Used to customize the appearance of a #GtkToolbar. Note that
407 setting the toolbar style overrides the user's preferences
408 for the default toolbar style.
411 @GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
412 @GTK_TOOLBAR_TEXT: Buttons display only text labels in the toolbar.
413 @GTK_TOOLBAR_BOTH: Buttons display text and icons in the toolbar.
414 @GTK_TOOLBAR_BOTH_HORIZ: Buttons display icons and text alongside each
415 other, rather than vertically stacked
417 <!-- ##### ENUM GtkUpdateType ##### -->
422 @GTK_UPDATE_CONTINUOUS:
423 @GTK_UPDATE_DISCONTINUOUS:
426 <!-- ##### ENUM GtkVisibility ##### -->
428 Used by #GtkCList and #GtkCTree to indicate whether a row is visible.
431 @GTK_VISIBILITY_NONE: The row is not visible.
432 @GTK_VISIBILITY_PARTIAL: The row is partially visible.
433 @GTK_VISIBILITY_FULL: The row is fully visible.
435 <!-- ##### ENUM GtkWindowPosition ##### -->
437 Window placement can be influenced using this enumeration.
440 @GTK_WIN_POS_NONE: No influence is made on placement.
441 @GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen.
442 @GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position.
443 @GTK_WIN_POS_CENTER_ALWAYS: Keep window centered as it changes size, etc.
444 @GTK_WIN_POS_CENTER_ON_PARENT: Center the window on its transient
445 parent (see gtk_window_set_transient_for()).
447 <!-- ##### ENUM GtkWindowType ##### -->
449 A #GtkWindow can be one of these types. Most things you'd consider a
450 "window" should have type #GTK_WINDOW_TOPLEVEL; windows with this type
451 are managed by the window manager and have a frame by default (call
452 gtk_window_set_decorated() to toggle the frame). Windows with type
453 #GTK_WINDOW_POPUP are ignored by the window manager; window manager
454 keybindings won't work on them, the window manager won't decorate the
455 window with a frame, many GTK+ features that rely on the window
456 manager will not work (e.g. resize grips and
457 maximization/minimization). #GTK_WINDOW_POPUP is used to implement
458 widgets such as #GtkMenu or tooltips that you normally don't think of
459 as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL.
460 In particular, do not use #GTK_WINDOW_POPUP just to turn off
461 the window borders; use gtk_window_set_decorated() for that.
464 @GTK_WINDOW_TOPLEVEL: A regular window, such as a dialog.
465 @GTK_WINDOW_POPUP: A special window such as a tooltip.
467 <!-- ##### ENUM GtkSortType ##### -->
469 Determines the direction of a sort.
472 @GTK_SORT_ASCENDING: Sorting is in ascending order.
473 @GTK_SORT_DESCENDING: Sorting is in descending order.