Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkenums.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 Standard Enumerations
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Public enumerated types used throughout GTK+
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9
  10 </para>
  11
  12 <!-- ##### SECTION See_Also ##### -->
  13 <para>
  14
  15 </para>
  16
  17 <!-- ##### SECTION Stability_Level ##### -->
  18
  19
  20 <!-- ##### SECTION Image ##### -->
  21
  22
  23 <!-- ##### ENUM GtkAccelFlags ##### -->
  24 <para>
  25
  26 </para>
  27
  28 @GTK_ACCEL_VISIBLE:
  29 @GTK_ACCEL_LOCKED:
  30 @GTK_ACCEL_MASK:
  31
  32 <!-- ##### ENUM GtkAnchorType ##### -->
  33 <para>
  34
  35 </para>
  36
  37 @GTK_ANCHOR_CENTER:
  38 @GTK_ANCHOR_NORTH:
  39 @GTK_ANCHOR_NORTH_WEST:
  40 @GTK_ANCHOR_NORTH_EAST:
  41 @GTK_ANCHOR_SOUTH:
  42 @GTK_ANCHOR_SOUTH_WEST:
  43 @GTK_ANCHOR_SOUTH_EAST:
  44 @GTK_ANCHOR_WEST:
  45 @GTK_ANCHOR_EAST:
  46 @GTK_ANCHOR_N:
  47 @GTK_ANCHOR_NW:
  48 @GTK_ANCHOR_NE:
  49 @GTK_ANCHOR_S:
  50 @GTK_ANCHOR_SW:
  51 @GTK_ANCHOR_SE:
  52 @GTK_ANCHOR_W:
  53 @GTK_ANCHOR_E:
  54
  55 <!-- ##### ENUM GtkArrowPlacement ##### -->
  56 <para>
  57 Used to specify the placement of scroll arrows in scrolling menus.
  58 </para>
  59
  60 @GTK_ARROWS_BOTH: Place one arrow on each end of the menu.
  61 @GTK_ARROWS_START: Place both arrows at the top of the menu.
  62 @GTK_ARROWS_END: Place both arrows at the bottom of the menu.
  63
  64 <!-- ##### ENUM GtkArrowType ##### -->
  65 <para>
  66 Used to indicate the direction in which a #GtkArrow should point.
  67 </para>
  68
  69 @GTK_ARROW_UP: Represents an upward pointing arrow.
  70 @GTK_ARROW_DOWN: Represents a downward pointing arrow.
  71 @GTK_ARROW_LEFT: Represents a left pointing arrow.
  72 @GTK_ARROW_RIGHT: Represents a right pointing arrow.
  73 @GTK_ARROW_NONE: No arrow. Since 2.10.
  74
  75 <!-- ##### ENUM GtkAttachOptions ##### -->
  76 <para>
  77 Denotes the expansion properties that a widget will have when it (or its
  78 parent) is resized.
  79 </para>
  80
  81 @GTK_EXPAND: the widget should expand to take up any extra space in its
  82 container that has been allocated.
  83 @GTK_SHRINK: the widget should shrink as and when possible.
  84 @GTK_FILL: the widget should fill the space allocated to it.
  85
  86 <!-- ##### ENUM GtkButtonBoxStyle ##### -->
  87 <para>
  88 Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
  89 contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
  90 </para>
  91
  92 @GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
  93 @GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the box.
  94 @GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the box.
  95 @GTK_BUTTONBOX_START: Buttons are grouped towards the start of the box,
  96   (on the left for a HBox, or the top for a VBox).
  97 @GTK_BUTTONBOX_END: Buttons are grouped towards the end of the box,
  98   (on the right for a HBox, or the bottom for a VBox).
  99 @GTK_BUTTONBOX_CENTER: Buttons are centered in the box. Since 2.12
 100
 101 <!-- ##### ENUM GtkCornerType ##### -->
 102 <para>
 103 Specifies which corner a child widget should be placed in when packed into
 104 a #GtkScrolledWindow. This is effectively the opposite of where the scroll
 105 bars are placed.
 106 </para>
 107
 108 @GTK_CORNER_TOP_LEFT: Place the scrollbars on the right and bottom of the
 109 widget (default behaviour).
 110 @GTK_CORNER_BOTTOM_LEFT: Place the scrollbars on the top and right of the
 111 widget.
 112 @GTK_CORNER_TOP_RIGHT: Place the scrollbars on the left and bottom of the
 113 widget.
 114 @GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the
 115 widget.
 116
 117 <!-- ##### ENUM GtkDeleteType ##### -->
 118 <para>
 119
 120 </para>
 121
 122 @GTK_DELETE_CHARS:
 123 @GTK_DELETE_WORD_ENDS:
 124 @GTK_DELETE_WORDS:
 125 @GTK_DELETE_DISPLAY_LINES:
 126 @GTK_DELETE_DISPLAY_LINE_ENDS:
 127 @GTK_DELETE_PARAGRAPH_ENDS:
 128 @GTK_DELETE_PARAGRAPHS:
 129 @GTK_DELETE_WHITESPACE:
 130
 131 <!-- ##### ENUM GtkDirectionType ##### -->
 132 <para>
 133
 134 </para>
 135
 136 @GTK_DIR_TAB_FORWARD:
 137 @GTK_DIR_TAB_BACKWARD:
 138 @GTK_DIR_UP:
 139 @GTK_DIR_DOWN:
 140 @GTK_DIR_LEFT:
 141 @GTK_DIR_RIGHT:
 142
 143 <!-- ##### ENUM GtkExpanderStyle ##### -->
 144 <para>
 145 Used to specify the style of the expanders drawn by a #GtkTreeView.
 146 </para>
 147
 148 @GTK_EXPANDER_COLLAPSED: The style used for a collapsed subtree.
 149 @GTK_EXPANDER_SEMI_COLLAPSED: Intermediate style used during animation.
 150 @GTK_EXPANDER_SEMI_EXPANDED: Intermediate style used during animation.
 151 @GTK_EXPANDER_EXPANDED: The style used for an expanded subtree.
 152
 153 <!-- ##### ENUM GtkIMPreeditStyle ##### -->
 154 <para>
 155
 156 </para>
 157
 158 @GTK_IM_PREEDIT_NOTHING:
 159 @GTK_IM_PREEDIT_CALLBACK:
 160 @GTK_IM_PREEDIT_NONE:
 161
 162 <!-- ##### ENUM GtkIMStatusStyle ##### -->
 163 <para>
 164
 165 </para>
 166
 167 @GTK_IM_STATUS_NOTHING:
 168 @GTK_IM_STATUS_CALLBACK:
 169 @GTK_IM_STATUS_NONE:
 170
 171 <!-- ##### ENUM GtkJustification ##### -->
 172 <para>
 173 Used for justifying the text inside a #GtkLabel widget. (See also
 174 #GtkAlignment).
 175 </para>
 176
 177 @GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
 178 @GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
 179 @GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
 180 @GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
 181
 182 <!-- ##### ENUM GtkMetricType ##### -->
 183 <para>
 184 Used to indicate which metric is used by a #GtkRuler.
 185 </para>
 186
 187 @GTK_PIXELS: Pixels.
 188 @GTK_INCHES: Inches.
 189 @GTK_CENTIMETERS: Centimeters.
 190
 191 <!-- ##### ENUM GtkMovementStep ##### -->
 192 <para>
 193
 194 </para>
 195
 196 @GTK_MOVEMENT_LOGICAL_POSITIONS:
 197 @GTK_MOVEMENT_VISUAL_POSITIONS:
 198 @GTK_MOVEMENT_WORDS:
 199 @GTK_MOVEMENT_DISPLAY_LINES:
 200 @GTK_MOVEMENT_DISPLAY_LINE_ENDS:
 201 @GTK_MOVEMENT_PARAGRAPHS:
 202 @GTK_MOVEMENT_PARAGRAPH_ENDS:
 203 @GTK_MOVEMENT_PAGES:
 204 @GTK_MOVEMENT_BUFFER_ENDS:
 205 @GTK_MOVEMENT_HORIZONTAL_PAGES:
 206
 207 <!-- ##### ENUM GtkOrientation ##### -->
 208 <para>
 209 Represents the orientation of widgets which can be switched between horizontal
 210 and vertical orientation on the fly, like #GtkToolbar.
 211 </para>
 212
 213 @GTK_ORIENTATION_HORIZONTAL: The widget is in horizontal orientation.
 214 @GTK_ORIENTATION_VERTICAL: The widget is in vertical orientation.
 215
 216 <!-- ##### ENUM GtkPackType ##### -->
 217 <para>
 218 Represents the packing location #GtkBox children. (See: #GtkVBox,
 219 #GtkHBox, and #GtkButtonBox).
 220 </para>
 221
 222 @GTK_PACK_START: The child is packed into the start of the box
 223 @GTK_PACK_END: The child is packed into the end of the box
 224
 225 <!-- ##### ENUM GtkPathPriorityType ##### -->
 226 <para>
 227
 228 </para>
 229
 230 @GTK_PATH_PRIO_LOWEST:
 231 @GTK_PATH_PRIO_GTK:
 232 @GTK_PATH_PRIO_APPLICATION:
 233 @GTK_PATH_PRIO_THEME:
 234 @GTK_PATH_PRIO_RC:
 235 @GTK_PATH_PRIO_HIGHEST:
 236
 237 <!-- ##### ENUM GtkPathType ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @GTK_PATH_WIDGET:
 243 @GTK_PATH_WIDGET_CLASS:
 244 @GTK_PATH_CLASS:
 245
 246 <!-- ##### ENUM GtkPolicyType ##### -->
 247 <para>
 248 Determines when a scroll bar will be visible.
 249 </para>
 250
 251 @GTK_POLICY_ALWAYS: The scrollbar is always visible.
 252 @GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example,
 253 when all of a #GtkCList can not be seen.
 254 @GTK_POLICY_NEVER: The scrollbar will never appear.
 255
 256 <!-- ##### ENUM GtkPositionType ##### -->
 257 <para>
 258 Describes which edge of a widget a certain feature is positioned at, e.g. the
 259 tabs of a #GtkNotebook, the handle of a #GtkHandleBox or the label of a
 260 #GtkScale.
 261 </para>
 262
 263 @GTK_POS_LEFT: The feature is at the left edge.
 264 @GTK_POS_RIGHT: The feature is at the right edge.
 265 @GTK_POS_TOP: The feature is at the top edge.
 266 @GTK_POS_BOTTOM: The feature is at the bottom edge.
 267
 268 <!-- ##### ENUM GtkReliefStyle ##### -->
 269 <para>
 270 Indicated the relief to be drawn around a #GtkButton.
 271 </para>
 272
 273 @GTK_RELIEF_NORMAL: Draw a normal relief.
 274 @GTK_RELIEF_HALF: A half relief.
 275 @GTK_RELIEF_NONE: No relief.
 276
 277 <!-- ##### ENUM GtkResizeMode ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @GTK_RESIZE_PARENT:
 283 @GTK_RESIZE_QUEUE:
 284 @GTK_RESIZE_IMMEDIATE: Deprecated.
 285
 286 <!-- ##### ENUM GtkScrollStep ##### -->
 287 <para>
 288
 289 </para>
 290
 291 @GTK_SCROLL_STEPS:
 292 @GTK_SCROLL_PAGES:
 293 @GTK_SCROLL_ENDS:
 294 @GTK_SCROLL_HORIZONTAL_STEPS:
 295 @GTK_SCROLL_HORIZONTAL_PAGES:
 296 @GTK_SCROLL_HORIZONTAL_ENDS:
 297
 298 <!-- ##### ENUM GtkScrollType ##### -->
 299 <para>
 300
 301 </para>
 302
 303 @GTK_SCROLL_NONE:
 304 @GTK_SCROLL_JUMP:
 305 @GTK_SCROLL_STEP_BACKWARD:
 306 @GTK_SCROLL_STEP_FORWARD:
 307 @GTK_SCROLL_PAGE_BACKWARD:
 308 @GTK_SCROLL_PAGE_FORWARD:
 309 @GTK_SCROLL_STEP_UP:
 310 @GTK_SCROLL_STEP_DOWN:
 311 @GTK_SCROLL_PAGE_UP:
 312 @GTK_SCROLL_PAGE_DOWN:
 313 @GTK_SCROLL_STEP_LEFT:
 314 @GTK_SCROLL_STEP_RIGHT:
 315 @GTK_SCROLL_PAGE_LEFT:
 316 @GTK_SCROLL_PAGE_RIGHT:
 317 @GTK_SCROLL_START:
 318 @GTK_SCROLL_END:
 319
 320 <!-- ##### ENUM GtkSelectionMode ##### -->
 321 <para>
 322 Used to control what selections users are allowed to make.
 323 </para>
 324
 325 @GTK_SELECTION_NONE: No selection is possible.
 326 @GTK_SELECTION_SINGLE: Zero or one element may be selected.
 327 @GTK_SELECTION_BROWSE: Exactly one element is selected. In some circumstances,
 328   such as initially or during a search operation, it's possible for no element
 329   to be selected with %GTK_SELECTION_BROWSE. What is really enforced is that
 330   the user can't deselect a currently selected element except by selecting
 331   another element.
 332 @GTK_SELECTION_MULTIPLE: Any number of elements may be selected.
 333    Clicks toggle the state of an item. Any number of elements may be selected.
 334    The Ctrl key may be used to enlarge the selection, and Shift key to select
 335    between the focus and the child pointed to. Some widgets may also allow
 336    Click-drag to select a range of elements.
 337 @GTK_SELECTION_EXTENDED: Deprecated, behaves identical to %GTK_SELECTION_MULTIPLE.
 338
 339 <!-- ##### ENUM GtkShadowType ##### -->
 340 <para>
 341 Used to change the appearance of an outline typically provided by a #GtkFrame.
 342 </para>
 343
 344 @GTK_SHADOW_NONE: No outline.
 345 @GTK_SHADOW_IN: The outline is bevelled inwards.
 346 @GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
 347 @GTK_SHADOW_ETCHED_IN: The outline has a sunken 3d appearance.
 348 @GTK_SHADOW_ETCHED_OUT: The outline has a raised 3d appearance
 349
 350 <!-- ##### ENUM GtkStateType ##### -->
 351 <para>
 352 This type indicates the current state of a widget; the state determines how
 353 the widget is drawn. The #GtkStateType enumeration is also used to
 354 identify different colors in a #GtkStyle for drawing, so states can be
 355 used for subparts of a widget as well as entire widgets.
 356 </para>
 357
 358 @GTK_STATE_NORMAL: State during normal operation.
 359 @GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
 360 @GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
 361 the widget and the widget will respond to mouse clicks.
 362 @GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
 363 @GTK_STATE_INSENSITIVE: State indicating that the widget is
 364 unresponsive to user actions.
 365
 366 <!-- ##### ENUM GtkSubmenuDirection ##### -->
 367 <para>
 368 Indicates the direction a sub-menu will appear.
 369 </para>
 370
 371 @GTK_DIRECTION_LEFT: A sub-menu will appear to the left of the current menu.
 372 @GTK_DIRECTION_RIGHT: A sub-menu will appear to the right of the current menu.
 373
 374 <!-- ##### ENUM GtkSubmenuPlacement ##### -->
 375 <para>
 376
 377 </para>
 378
 379 @GTK_TOP_BOTTOM:
 380 @GTK_LEFT_RIGHT:
 381
 382 <!-- ##### ENUM GtkToolbarStyle ##### -->
 383 <para>
 384 Used to customize the appearance of a #GtkToolbar. Note that
 385 setting the toolbar style overrides the user's preferences
 386 for the default toolbar style.  Note that if the button has only
 387 a label set and GTK_TOOLBAR_ICONS is used, the label will be
 388 visible, and vice versa.
 389 </para>
 390
 391 @GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
 392 @GTK_TOOLBAR_TEXT: Buttons display only text labels in the toolbar.
 393 @GTK_TOOLBAR_BOTH: Buttons display text and icons in the toolbar.
 394 @GTK_TOOLBAR_BOTH_HORIZ: Buttons display icons and text alongside each
 395 other, rather than vertically stacked
 396
 397 <!-- ##### ENUM GtkUpdateType ##### -->
 398 <para>
 399 Used by #GtkRange to control the policy for notifying value changes.
 400 </para>
 401
 402 @GTK_UPDATE_CONTINUOUS: Notify updates whenever the value changed
 403 @GTK_UPDATE_DISCONTINUOUS: Notify updates when the mouse button has been released
 404 @GTK_UPDATE_DELAYED: Space out updates with a small timeout
 405
 406 <!-- ##### ENUM GtkVisibility ##### -->
 407 <para>
 408 Used by #GtkCList and #GtkCTree to indicate whether a row is visible.
 409 </para>
 410
 411 @GTK_VISIBILITY_NONE: The row is not visible.
 412 @GTK_VISIBILITY_PARTIAL: The row is partially visible.
 413 @GTK_VISIBILITY_FULL: The row is fully visible.
 414
 415 <!-- ##### ENUM GtkWindowPosition ##### -->
 416 <para>
 417 Window placement can be influenced using this enumeration. Note that
 418 using #GTK_WIN_POS_CENTER_ALWAYS is almost always a bad idea.
 419 It won't necessarily work well with all window managers or on all windowing systems.
 420 </para>
 421
 422 @GTK_WIN_POS_NONE: No influence is made on placement.
 423 @GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen.
 424 @GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position.
 425 @GTK_WIN_POS_CENTER_ALWAYS: Keep window centered as it changes size, etc.
 426 @GTK_WIN_POS_CENTER_ON_PARENT: Center the window on its transient
 427 parent (see gtk_window_set_transient_for()).
 428
 429 <!-- ##### ENUM GtkWindowType ##### -->
 430 <para>
 431 A #GtkWindow can be one of these types. Most things you'd consider a
 432 "window" should have type #GTK_WINDOW_TOPLEVEL; windows with this type
 433 are managed by the window manager and have a frame by default (call
 434 gtk_window_set_decorated() to toggle the frame).  Windows with type
 435 #GTK_WINDOW_POPUP are ignored by the window manager; window manager
 436 keybindings won't work on them, the window manager won't decorate the
 437 window with a frame, many GTK+ features that rely on the window
 438 manager will not work (e.g. resize grips and
 439 maximization/minimization). #GTK_WINDOW_POPUP is used to implement
 440 widgets such as #GtkMenu or tooltips that you normally don't think of
 441 as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL.
 442 In particular, do not use #GTK_WINDOW_POPUP just to turn off
 443 the window borders; use gtk_window_set_decorated() for that.
 444 </para>
 445
 446 @GTK_WINDOW_TOPLEVEL: A regular window, such as a dialog.
 447 @GTK_WINDOW_POPUP: A special window such as a tooltip.
 448
 449 <!-- ##### ENUM GtkSortType ##### -->
 450 <para>
 451 Determines the direction of a sort.
 452 </para>
 453
 454 @GTK_SORT_ASCENDING: Sorting is in ascending order.
 455 @GTK_SORT_DESCENDING: Sorting is in descending order.
 456
 457 <!-- ##### ENUM GtkDragResult ##### -->
 458 <para>
 459 Gives an indication why a drag operation failed.
 460 The value can by obtained by connecting to the
 461 #GtkWidget::drag-failed signal.
 462 </para>
 463
 464 @GTK_DRAG_RESULT_SUCCESS: The drag operation was successful
 465 @GTK_DRAG_RESULT_NO_TARGET: No suitable drag target
 466 @GTK_DRAG_RESULT_USER_CANCELLED: The user cancelled the drag operation
 467 @GTK_DRAG_RESULT_TIMEOUT_EXPIRED: The drag operation timed out
 468 @GTK_DRAG_RESULT_GRAB_BROKEN: The pointer or keyboard grab used
 469    for the drag operation was broken
 470 @GTK_DRAG_RESULT_ERROR: The drag operation failed due to some
 471    unspecified error
 472