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 <!-- ##### ENUM GtkAccelFlags ##### -->
  18 <para>
  19
  20 </para>
  21
  22 @GTK_ACCEL_VISIBLE:
  23 @GTK_ACCEL_SIGNAL_VISIBLE:
  24 @GTK_ACCEL_LOCKED:
  25 @GTK_ACCEL_MASK:
  26
  27 <!-- ##### ENUM GtkArrowType ##### -->
  28 <para>
  29 Used to indicate the direction in which a #GtkArrow should point.
  30 </para>
  31
  32 @GTK_ARROW_UP: Represents an upward pointing arrow.
  33 @GTK_ARROW_DOWN: Represents a downward pointing arrow.
  34 @GTK_ARROW_LEFT: Represents a left pointing arrow.
  35 @GTK_ARROW_RIGHT: Represents a right pointing arrow.
  36
  37 <!-- ##### ENUM GtkAttachOptions ##### -->
  38 <para>
  39 Denotes the expansion properties that a widget will have when it (or it's
  40 parent) is resized.
  41 </para>
  42
  43 @GTK_EXPAND: the widget should expand to take up any extra space in its
  44 container that has been allocated.
  45 @GTK_SHRINK: the widget should shrink as and when possible.
  46 @GTK_FILL: the widget should fill the space allocated to it.
  47
  48 <!-- ##### ENUM GtkButtonBoxStyle ##### -->
  49 <para>
  50 Used to dictate the style that a #GtkButtonBox uses to layout the buttons it
  51 contains. (See also: #GtkVButtonBox and #GtkHButtonBox).
  52 </para>
  53
  54 @GTK_BUTTONBOX_DEFAULT_STYLE: Default packing.
  55 @GTK_BUTTONBOX_SPREAD: Buttons are evenly spread across the ButtonBox.
  56 @GTK_BUTTONBOX_EDGE: Buttons are placed at the edges of the ButtonBox.
  57 @GTK_BUTTONBOX_START: Buttons are grouped towards the start of box, (on the
  58 left for a HBox, or the top for a VBox).
  59 @GTK_BUTTONBOX_END: Buttons are grouped towards the end of a box, (on the
  60 right for a HBox, or the bottom for a VBox).
  61
  62 <!-- ##### ENUM GtkCornerType ##### -->
  63 <para>
  64 Specifies which corner a child widget should be placed in when packed into
  65 a #GtkScrolledWindow. This is effectively the opposite of where the scroll
  66 bars are placed.
  67 </para>
  68
  69 @GTK_CORNER_TOP_LEFT: Place the scrollbars on the right and bottom of the
  70 widget (default behaviour).
  71 @GTK_CORNER_BOTTOM_LEFT: Place the scrollbars on the top and right of the
  72 widget.
  73 @GTK_CORNER_TOP_RIGHT: Place the scrollbars on the left and bottom of the
  74 widget.
  75 @GTK_CORNER_BOTTOM_RIGHT: Place the scrollbars on the top and left of the
  76 widget.
  77
  78 <!-- ##### ENUM GtkCurveType ##### -->
  79 <para>
  80
  81 </para>
  82
  83 @GTK_CURVE_TYPE_LINEAR:
  84 @GTK_CURVE_TYPE_SPLINE:
  85 @GTK_CURVE_TYPE_FREE:
  86
  87 <!-- ##### ENUM GtkDeleteType ##### -->
  88 <para>
  89
  90 </para>
  91
  92 @GTK_DELETE_CHARS:
  93 @GTK_DELETE_WORD_ENDS:
  94 @GTK_DELETE_WORDS:
  95 @GTK_DELETE_DISPLAY_LINES:
  96 @GTK_DELETE_DISPLAY_LINE_ENDS:
  97 @GTK_DELETE_PARAGRAPH_ENDS:
  98 @GTK_DELETE_PARAGRAPHS:
  99 @GTK_DELETE_WHITESPACE:
 100
 101 <!-- ##### ENUM GtkDirectionType ##### -->
 102 <para>
 103
 104 </para>
 105
 106 @GTK_DIR_TAB_FORWARD:
 107 @GTK_DIR_TAB_BACKWARD:
 108 @GTK_DIR_UP:
 109 @GTK_DIR_DOWN:
 110 @GTK_DIR_LEFT:
 111 @GTK_DIR_RIGHT:
 112
 113 <!-- ##### ENUM GtkExpanderStyle ##### -->
 114 <para>
 115
 116 </para>
 117
 118 @GTK_EXPANDER_COLLAPSED:
 119 @GTK_EXPANDER_SEMI_COLLAPSED:
 120 @GTK_EXPANDER_SEMI_EXPANDED:
 121 @GTK_EXPANDER_EXPANDED:
 122
 123 <!-- ##### ENUM GtkJustification ##### -->
 124 <para>
 125 Used for justifying the text inside a #GtkLabel widget. (See also
 126 #GtkAlignment).
 127 </para>
 128
 129 @GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
 130 @GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
 131 @GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
 132 @GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
 133
 134 <!-- ##### ENUM GtkMatchType ##### -->
 135 <para>
 136
 137 </para>
 138
 139 @GTK_MATCH_ALL:
 140 @GTK_MATCH_ALL_TAIL:
 141 @GTK_MATCH_HEAD:
 142 @GTK_MATCH_TAIL:
 143 @GTK_MATCH_EXACT:
 144 @GTK_MATCH_LAST:
 145
 146 <!-- ##### ENUM GtkMetricType ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @GTK_PIXELS:
 152 @GTK_INCHES:
 153 @GTK_CENTIMETERS:
 154
 155 <!-- ##### ENUM GtkMovementStep ##### -->
 156 <para>
 157
 158 </para>
 159
 160 @GTK_MOVEMENT_LOGICAL_POSITIONS:
 161 @GTK_MOVEMENT_VISUAL_POSITIONS:
 162 @GTK_MOVEMENT_WORDS:
 163 @GTK_MOVEMENT_DISPLAY_LINES:
 164 @GTK_MOVEMENT_DISPLAY_LINE_ENDS:
 165 @GTK_MOVEMENT_PARAGRAPHS:
 166 @GTK_MOVEMENT_PARAGRAPH_ENDS:
 167 @GTK_MOVEMENT_PAGES:
 168 @GTK_MOVEMENT_BUFFER_ENDS:
 169
 170 <!-- ##### ENUM GtkOrientation ##### -->
 171 <para>
 172
 173 </para>
 174
 175 @GTK_ORIENTATION_HORIZONTAL:
 176 @GTK_ORIENTATION_VERTICAL:
 177
 178 <!-- ##### ENUM GtkPackType ##### -->
 179 <para>
 180 Represents the packing location #GtkBox children. (See: #GtkVBox,
 181 #GtkHBox, and #GtkButtonBox).
 182 </para>
 183
 184 @GTK_PACK_START: The child is packed into the start of the box
 185 @GTK_PACK_END: The child is packed into the end of the box
 186
 187 <!-- ##### ENUM GtkPathPriorityType ##### -->
 188 <para>
 189
 190 </para>
 191
 192 @GTK_PATH_PRIO_LOWEST:
 193 @GTK_PATH_PRIO_GTK:
 194 @GTK_PATH_PRIO_APPLICATION:
 195 @GTK_PATH_PRIO_THEME:
 196 @GTK_PATH_PRIO_RC:
 197 @GTK_PATH_PRIO_HIGHEST:
 198
 199 <!-- ##### ENUM GtkPathType ##### -->
 200 <para>
 201
 202 </para>
 203
 204 @GTK_PATH_WIDGET:
 205 @GTK_PATH_WIDGET_CLASS:
 206 @GTK_PATH_CLASS:
 207
 208 <!-- ##### ENUM GtkPolicyType ##### -->
 209 <para>
 210 Determines when a scroll bar will be visible.
 211 </para>
 212
 213 @GTK_POLICY_ALWAYS: The scrollbar is always visible.
 214 @GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example,
 215 when all of a #GtkCList can not be seen.
 216 @GTK_POLICY_NEVER: The scrollbar will never appear.
 217
 218 <!-- ##### ENUM GtkPositionType ##### -->
 219 <para>
 220
 221 </para>
 222
 223 @GTK_POS_LEFT:
 224 @GTK_POS_RIGHT:
 225 @GTK_POS_TOP:
 226 @GTK_POS_BOTTOM:
 227
 228 <!-- ##### ENUM GtkPreviewType ##### -->
 229 <para>
 230 An enumeration which describes whether a preview
 231 contains grayscale or red-green-blue data.
 232 </para>
 233
 234 @GTK_PREVIEW_COLOR: the preview contains red-green-blue data.
 235 @GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data.
 236
 237 <!-- ##### ENUM GtkReliefStyle ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @GTK_RELIEF_NORMAL:
 243 @GTK_RELIEF_HALF:
 244 @GTK_RELIEF_NONE:
 245
 246 <!-- ##### ENUM GtkResizeMode ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @GTK_RESIZE_PARENT:
 252 @GTK_RESIZE_QUEUE:
 253 @GTK_RESIZE_IMMEDIATE:
 254
 255 <!-- ##### ENUM GtkScrollType ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @GTK_SCROLL_NONE:
 261 @GTK_SCROLL_JUMP:
 262 @GTK_SCROLL_STEP_BACKWARD:
 263 @GTK_SCROLL_STEP_FORWARD:
 264 @GTK_SCROLL_PAGE_BACKWARD:
 265 @GTK_SCROLL_PAGE_FORWARD:
 266 @GTK_SCROLL_STEP_UP:
 267 @GTK_SCROLL_STEP_DOWN:
 268 @GTK_SCROLL_PAGE_UP:
 269 @GTK_SCROLL_PAGE_DOWN:
 270 @GTK_SCROLL_STEP_LEFT:
 271 @GTK_SCROLL_STEP_RIGHT:
 272 @GTK_SCROLL_PAGE_LEFT:
 273 @GTK_SCROLL_PAGE_RIGHT:
 274 @GTK_SCROLL_START:
 275 @GTK_SCROLL_END:
 276
 277 <!-- ##### ENUM GtkSelectionMode ##### -->
 278 <para>
 279
 280 </para>
 281
 282 @GTK_SELECTION_SINGLE:
 283 @GTK_SELECTION_BROWSE:
 284 @GTK_SELECTION_MULTIPLE:
 285 @GTK_SELECTION_EXTENDED:
 286
 287 <!-- ##### ENUM GtkShadowType ##### -->
 288 <para>
 289 Used to change the appearance of an outline typically provided by a #GtkFrame.
 290 </para>
 291
 292 @GTK_SHADOW_NONE: No outline.
 293 @GTK_SHADOW_IN: The outline is bevelled inwards.
 294 @GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
 295 @GTK_SHADOW_ETCHED_IN: The outline itself is an inward bevel, but the frame
 296 does
 297 @GTK_SHADOW_ETCHED_OUT:
 298
 299 <!-- ##### ENUM GtkStateType ##### -->
 300 <para>
 301 This type indicates the current state of a widget; the state determines how
 302 the widget is drawn. The #GtkStateType enumeration is also used to
 303 identify different colors in a #GtkStyle for drawing, so states can be
 304 used for subparts of a widget as well as entire widgets.
 305 </para>
 306
 307 @GTK_STATE_NORMAL: State during normal operation.
 308 @GTK_STATE_ACTIVE: State of a currently active widget, such as a depressed button.
 309 @GTK_STATE_PRELIGHT: State indicating that the mouse pointer is over
 310 the widget and the widget will respond to mouse clicks.
 311 @GTK_STATE_SELECTED: State of a selected item, such the selected row in a list.
 312 @GTK_STATE_INSENSITIVE: State indicating that the widget is
 313 unresponsive to user actions.
 314
 315 <!-- ##### ENUM GtkSubmenuDirection ##### -->
 316 <para>
 317 Indicates the direction a sub-menu will appear.
 318 </para>
 319
 320 @GTK_DIRECTION_LEFT: A sub-menu will appear
 321 @GTK_DIRECTION_RIGHT:
 322
 323 <!-- ##### ENUM GtkSubmenuPlacement ##### -->
 324 <para>
 325
 326 </para>
 327
 328 @GTK_TOP_BOTTOM:
 329 @GTK_LEFT_RIGHT:
 330
 331 <!-- ##### ENUM GtkToolbarStyle ##### -->
 332 <para>
 333 Used to customize the appearance of a #GtkToolbar. Note that
 334 setting the toolbar style overrides the user's preferences
 335 for the default toolbar style.
 336 </para>
 337
 338 @GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
 339 @GTK_TOOLBAR_TEXT: Buttons display only text labels in the toolbar.
 340 @GTK_TOOLBAR_BOTH: Buttons display text and icons in the toolbar.
 341 @GTK_TOOLBAR_BOTH_HORIZ: Buttons display icons and text alongside each
 342 other, rather than vertically stacked
 343
 344 <!-- ##### ENUM GtkUpdateType ##### -->
 345 <para>
 346
 347 </para>
 348
 349 @GTK_UPDATE_CONTINUOUS:
 350 @GTK_UPDATE_DISCONTINUOUS:
 351 @GTK_UPDATE_DELAYED:
 352
 353 <!-- ##### ENUM GtkVisibility ##### -->
 354 <para>
 355
 356 </para>
 357
 358 @GTK_VISIBILITY_NONE:
 359 @GTK_VISIBILITY_PARTIAL:
 360 @GTK_VISIBILITY_FULL:
 361
 362 <!-- ##### ENUM GtkWindowPosition ##### -->
 363 <para>
 364 Window placement can be influenced using this enumeration.
 365 </para>
 366
 367 @GTK_WIN_POS_NONE: No influence is made on placement.
 368 @GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen.
 369 @GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position.
 370 @GTK_WIN_POS_CENTER_ALWAYS: Keep window centered as it changes size, etc.
 371 @GTK_WIN_POS_CENTER_ON_PARENT: Center the window on its transient
 372 parent (see gtk_window_set_transient_for()).
 373
 374 <!-- ##### ENUM GtkWindowType ##### -->
 375 <para>
 376 A #GtkWindow can be one of these types. Most things you'd consider a
 377 "window" should have type #GTK_WINDOW_TOPLEVEL; windows with this type
 378 are managed by the window manager and have a frame by default (call
 379 gtk_window_set_decorated() to toggle the frame).  Windows with type
 380 #GTK_WINDOW_POPUP are ignored by the window manager; window manager
 381 keybindings won't work on them, the window manager won't decorate the
 382 window with a frame, many GTK+ features that rely on the window
 383 manager will not work (e.g. resize grips and
 384 maximization/minimization). #GTK_WINDOW_POPUP is used to implement
 385 widgets such as #GtkMenu or tooltips that you normally don't think of
 386 as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL.
 387 In particular, do not use #GTK_WINDOW_POPUP just to turn off
 388 the window borders; use gtk_window_set_decorated() for that.
 389 </para>
 390
 391 @GTK_WINDOW_TOPLEVEL: A regular window, such as a dialog.
 392 @GTK_WINDOW_POPUP: A special window such as a tooltip.
 393
 394 <!-- ##### ENUM GtkSortType ##### -->
 395 <para>
 396 Determines the direction of a sort.
 397 </para>
 398
 399 @GTK_SORT_ASCENDING: Sorting is in ascending order.
 400 @GTK_SORT_DESCENDING: Sorting is in descending order.
 401