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 GtkArrowType ##### -->
54 Used to indicate the direction in which a #GtkArrow should point.
57 @GTK_ARROW_UP: Represents an upward pointing arrow.
58 @GTK_ARROW_DOWN: Represents a downward pointing arrow.
59 @GTK_ARROW_LEFT: Represents a left pointing arrow.
60 @GTK_ARROW_RIGHT: Represents a right pointing arrow.
62 <!-- ##### ENUM GtkAttachOptions ##### -->
64 Denotes the expansion properties that a widget will have when it (or its
68 @GTK_EXPAND: the widget should expand to take up any extra space in its
69 container that has been allocated.
70 @GTK_SHRINK: the widget should shrink as and when possible.
71 @GTK_FILL: the widget should fill the space allocated to it.
73 <!-- ##### ENUM GtkButtonBoxStyle ##### -->
75 Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
76 contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
79 @GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
80 @GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the ButtonBox.
81 @GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the ButtonBox.
82 @GTK_BUTTONBOX_START: Buttons are grouped towards the start of box, (on the
83 left for a HBox, or the top for a VBox).
84 @GTK_BUTTONBOX_END: Buttons are grouped towards the end of a box, (on the
85 right for a HBox, or the bottom for a VBox).
87 <!-- ##### ENUM GtkCornerType ##### -->
89 Specifies which corner a child widget should be placed in when packed into
90 a #GtkScrolledWindow. This is effectively the opposite of where the scroll
94 @GTK_CORNER_TOP_LEFT: Place the scrollbars on the right and bottom of the
95 widget (default behaviour).
96 @GTK_CORNER_BOTTOM_LEFT: Place the scrollbars on the top and right of the
98 @GTK_CORNER_TOP_RIGHT: Place the scrollbars on the left and bottom of the
100 @GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the
103 <!-- ##### ENUM GtkCurveType ##### -->
108 @GTK_CURVE_TYPE_LINEAR:
109 @GTK_CURVE_TYPE_SPLINE:
110 @GTK_CURVE_TYPE_FREE:
112 <!-- ##### ENUM GtkDeleteType ##### -->
118 @GTK_DELETE_WORD_ENDS:
120 @GTK_DELETE_DISPLAY_LINES:
121 @GTK_DELETE_DISPLAY_LINE_ENDS:
122 @GTK_DELETE_PARAGRAPH_ENDS:
123 @GTK_DELETE_PARAGRAPHS:
124 @GTK_DELETE_WHITESPACE:
126 <!-- ##### ENUM GtkDirectionType ##### -->
131 @GTK_DIR_TAB_FORWARD:
132 @GTK_DIR_TAB_BACKWARD:
138 <!-- ##### ENUM GtkExpanderStyle ##### -->
140 Used to specify the style of the expanders drawn by a #GtkTreeView.
143 @GTK_EXPANDER_COLLAPSED: The style used for a collapsed subtree.
144 @GTK_EXPANDER_SEMI_COLLAPSED: Intermediate style used during animation.
145 @GTK_EXPANDER_SEMI_EXPANDED: Intermediate style used during animation.
146 @GTK_EXPANDER_EXPANDED: The style used for an expanded subtree.
148 <!-- ##### ENUM GtkIMPreeditStyle ##### -->
153 @GTK_IM_PREEDIT_NOTHING:
154 @GTK_IM_PREEDIT_CALLBACK:
155 @GTK_IM_PREEDIT_NONE:
157 <!-- ##### ENUM GtkIMStatusStyle ##### -->
162 @GTK_IM_STATUS_NOTHING:
163 @GTK_IM_STATUS_CALLBACK:
166 <!-- ##### ENUM GtkJustification ##### -->
168 Used for justifying the text inside a #GtkLabel widget. (See also
172 @GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
173 @GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
174 @GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
175 @GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
177 <!-- ##### ENUM GtkMatchType ##### -->
189 <!-- ##### ENUM GtkMetricType ##### -->
191 Used to indicate which metric is used by a #GtkRuler.
196 @GTK_CENTIMETERS: Centimeters.
198 <!-- ##### ENUM GtkMovementStep ##### -->
203 @GTK_MOVEMENT_LOGICAL_POSITIONS:
204 @GTK_MOVEMENT_VISUAL_POSITIONS:
206 @GTK_MOVEMENT_DISPLAY_LINES:
207 @GTK_MOVEMENT_DISPLAY_LINE_ENDS:
208 @GTK_MOVEMENT_PARAGRAPHS:
209 @GTK_MOVEMENT_PARAGRAPH_ENDS:
211 @GTK_MOVEMENT_BUFFER_ENDS:
212 @GTK_MOVEMENT_HORIZONTAL_PAGES:
214 <!-- ##### ENUM GtkOrientation ##### -->
216 Represents the orientation of widgets which can be switched between horizontal
217 and vertical orientation on the fly, like #GtkToolbar.
220 @GTK_ORIENTATION_HORIZONTAL: The widget is in horizontal orientation.
221 @GTK_ORIENTATION_VERTICAL: The widget is in vertical orientation.
223 <!-- ##### ENUM GtkPackType ##### -->
225 Represents the packing location #GtkBox children. (See: #GtkVBox,
226 #GtkHBox, and #GtkButtonBox).
229 @GTK_PACK_START: The child is packed into the start of the box
230 @GTK_PACK_END: The child is packed into the end of the box
232 <!-- ##### ENUM GtkPathPriorityType ##### -->
237 @GTK_PATH_PRIO_LOWEST:
239 @GTK_PATH_PRIO_APPLICATION:
240 @GTK_PATH_PRIO_THEME:
242 @GTK_PATH_PRIO_HIGHEST:
244 <!-- ##### ENUM GtkPathType ##### -->
250 @GTK_PATH_WIDGET_CLASS:
253 <!-- ##### ENUM GtkPolicyType ##### -->
255 Determines when a scroll bar will be visible.
258 @GTK_POLICY_ALWAYS: The scrollbar is always visible.
259 @GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example,
260 when all of a #GtkCList can not be seen.
261 @GTK_POLICY_NEVER: The scrollbar will never appear.
263 <!-- ##### ENUM GtkPositionType ##### -->
265 Describes which edge of a widget a certain feature is positioned at, e.g. the
266 tabs of a #GtkNotebook, the handle of a #GtkHandleBox or the label of a
270 @GTK_POS_LEFT: The feature is at the left edge.
271 @GTK_POS_RIGHT: The feature is at the right edge.
272 @GTK_POS_TOP: The feature is at the top edge.
273 @GTK_POS_BOTTOM: The feature is at the bottom edge.
275 <!-- ##### ENUM GtkPreviewType ##### -->
277 An enumeration which describes whether a preview
278 contains grayscale or red-green-blue data.
281 @GTK_PREVIEW_COLOR: the preview contains red-green-blue data.
282 @GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data.
284 <!-- ##### ENUM GtkReliefStyle ##### -->
286 Indicated the relief to be drawn around a #GtkButton.
289 @GTK_RELIEF_NORMAL: Draw a normal relief.
290 @GTK_RELIEF_HALF: A half relief.
291 @GTK_RELIEF_NONE: No relief.
293 <!-- ##### ENUM GtkResizeMode ##### -->
300 @GTK_RESIZE_IMMEDIATE: Deprecated.
302 <!-- ##### ENUM GtkScrollStep ##### -->
310 @GTK_SCROLL_HORIZONTAL_STEPS:
311 @GTK_SCROLL_HORIZONTAL_PAGES:
312 @GTK_SCROLL_HORIZONTAL_ENDS:
314 <!-- ##### ENUM GtkScrollType ##### -->
321 @GTK_SCROLL_STEP_BACKWARD:
322 @GTK_SCROLL_STEP_FORWARD:
323 @GTK_SCROLL_PAGE_BACKWARD:
324 @GTK_SCROLL_PAGE_FORWARD:
326 @GTK_SCROLL_STEP_DOWN:
328 @GTK_SCROLL_PAGE_DOWN:
329 @GTK_SCROLL_STEP_LEFT:
330 @GTK_SCROLL_STEP_RIGHT:
331 @GTK_SCROLL_PAGE_LEFT:
332 @GTK_SCROLL_PAGE_RIGHT:
336 <!-- ##### ENUM GtkSelectionMode ##### -->
338 Used to control what selections users are allowed to make.
341 @GTK_SELECTION_NONE: No selection is possible.
342 @GTK_SELECTION_SINGLE: Zero or one element may be selected.
343 @GTK_SELECTION_BROWSE: Exactly one element is selected. In some circumstances,
344 such as initially or during a search operation, it's possible for no element
345 to be selected with %GTK_SELECTION_BROWSE. What is really enforced is that
346 the user can't deselect a currently selected element except by selecting
348 @GTK_SELECTION_MULTIPLE: Any number of elements may be selected.
349 Clicks toggle the state of an item. Any number of elements may be selected.
350 The Ctrl key may be used to enlarge the selection, and Shift key to select
351 between the focus and the child pointed to. Some widgets may also allow
352 Click-drag to select a range of elements.
353 @GTK_SELECTION_EXTENDED: Deprecated, behaves identical to %GTK_SELECTION_MULTIPLE.
355 <!-- ##### ENUM GtkShadowType ##### -->
357 Used to change the appearance of an outline typically provided by a #GtkFrame.
360 @GTK_SHADOW_NONE: No outline.
361 @GTK_SHADOW_IN: The outline is bevelled inwards.
362 @GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
363 @GTK_SHADOW_ETCHED_IN: The outline itself is an inward bevel, but the frame
365 @GTK_SHADOW_ETCHED_OUT:
367 <!-- ##### ENUM GtkSideType ##### -->
377 <!-- ##### ENUM GtkStateType ##### -->
379 This type indicates the current state of a widget; the state determines how
380 the widget is drawn. The #GtkStateType enumeration is also used to
381 identify different colors in a #GtkStyle for drawing, so states can be
382 used for subparts of a widget as well as entire widgets.
385 @GTK_STATE_NORMAL: State during normal operation.
386 @GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
387 @GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
388 the widget and the widget will respond to mouse clicks.
389 @GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
390 @GTK_STATE_INSENSITIVE: State indicating that the widget is
391 unresponsive to user actions.
393 <!-- ##### ENUM GtkSubmenuDirection ##### -->
395 Indicates the direction a sub-menu will appear.
398 @GTK_DIRECTION_LEFT: A sub-menu will appear
399 @GTK_DIRECTION_RIGHT:
401 <!-- ##### ENUM GtkSubmenuPlacement ##### -->
409 <!-- ##### ENUM GtkToolbarStyle ##### -->
411 Used to customize the appearance of a #GtkToolbar. Note that
412 setting the toolbar style overrides the user's preferences
413 for the default toolbar style. Note that if the button has only
414 a label set and GTK_TOOLBAR_ICONS is used, the label will be
415 visible, and vice versa.
418 @GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
419 @GTK_TOOLBAR_TEXT: Buttons display only text labels in the toolbar.
420 @GTK_TOOLBAR_BOTH: Buttons display text and icons in the toolbar.
421 @GTK_TOOLBAR_BOTH_HORIZ: Buttons display icons and text alongside each
422 other, rather than vertically stacked
424 <!-- ##### ENUM GtkUpdateType ##### -->
429 @GTK_UPDATE_CONTINUOUS:
430 @GTK_UPDATE_DISCONTINUOUS:
433 <!-- ##### ENUM GtkVisibility ##### -->
435 Used by #GtkCList and #GtkCTree to indicate whether a row is visible.
438 @GTK_VISIBILITY_NONE: The row is not visible.
439 @GTK_VISIBILITY_PARTIAL: The row is partially visible.
440 @GTK_VISIBILITY_FULL: The row is fully visible.
442 <!-- ##### ENUM GtkWindowPosition ##### -->
444 Window placement can be influenced using this enumeration.
447 @GTK_WIN_POS_NONE: No influence is made on placement.
448 @GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen.
449 @GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position.
450 @GTK_WIN_POS_CENTER_ALWAYS: Keep window centered as it changes size, etc.
451 @GTK_WIN_POS_CENTER_ON_PARENT: Center the window on its transient
452 parent (see gtk_window_set_transient_for()).
454 <!-- ##### ENUM GtkWindowType ##### -->
456 A #GtkWindow can be one of these types. Most things you'd consider a
457 "window" should have type #GTK_WINDOW_TOPLEVEL; windows with this type
458 are managed by the window manager and have a frame by default (call
459 gtk_window_set_decorated() to toggle the frame). Windows with type
460 #GTK_WINDOW_POPUP are ignored by the window manager; window manager
461 keybindings won't work on them, the window manager won't decorate the
462 window with a frame, many GTK+ features that rely on the window
463 manager will not work (e.g. resize grips and
464 maximization/minimization). #GTK_WINDOW_POPUP is used to implement
465 widgets such as #GtkMenu or tooltips that you normally don't think of
466 as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL.
467 In particular, do not use #GTK_WINDOW_POPUP just to turn off
468 the window borders; use gtk_window_set_decorated() for that.
471 @GTK_WINDOW_TOPLEVEL: A regular window, such as a dialog.
472 @GTK_WINDOW_POPUP: A special window such as a tooltip.
474 <!-- ##### ENUM GtkSortType ##### -->
476 Determines the direction of a sort.
479 @GTK_SORT_ASCENDING: Sorting is in ascending order.
480 @GTK_SORT_DESCENDING: Sorting is in descending order.