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 GtkJustification ##### -->
 114 <para>
 115 Used for justifying the text inside a #GtkLabel widget. (See also
 116 #GtkAlignment).
 117 </para>
 118
 119 @GTK_JUSTIFY_LEFT: The text is placed at the left edge of the label.
 120 @GTK_JUSTIFY_RIGHT: The text is placed at the right edge of the label.
 121 @GTK_JUSTIFY_CENTER: The text is placed in the center of the label.
 122 @GTK_JUSTIFY_FILL: The text is placed is distributed across the label.
 123
 124 <!-- ##### ENUM GtkMatchType ##### -->
 125 <para>
 126
 127 </para>
 128
 129 @GTK_MATCH_ALL:
 130 @GTK_MATCH_ALL_TAIL:
 131 @GTK_MATCH_HEAD:
 132 @GTK_MATCH_TAIL:
 133 @GTK_MATCH_EXACT:
 134 @GTK_MATCH_LAST:
 135
 136 <!-- ##### ENUM GtkMetricType ##### -->
 137 <para>
 138
 139 </para>
 140
 141 @GTK_PIXELS:
 142 @GTK_INCHES:
 143 @GTK_CENTIMETERS:
 144
 145 <!-- ##### ENUM GtkMovementStep ##### -->
 146 <para>
 147
 148 </para>
 149
 150 @GTK_MOVEMENT_LOGICAL_POSITIONS:
 151 @GTK_MOVEMENT_VISUAL_POSITIONS:
 152 @GTK_MOVEMENT_WORDS:
 153 @GTK_MOVEMENT_DISPLAY_LINES:
 154 @GTK_MOVEMENT_DISPLAY_LINE_ENDS:
 155 @GTK_MOVEMENT_PARAGRAPHS:
 156 @GTK_MOVEMENT_PARAGRAPH_ENDS:
 157 @GTK_MOVEMENT_PAGES:
 158 @GTK_MOVEMENT_BUFFER_ENDS:
 159
 160 <!-- ##### ENUM GtkOrientation ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @GTK_ORIENTATION_HORIZONTAL:
 166 @GTK_ORIENTATION_VERTICAL:
 167
 168 <!-- ##### ENUM GtkPackType ##### -->
 169 <para>
 170 Represents the packing location #GtkBox children. (See: #GtkVBox,
 171 #GtkHBox, and #GtkButtonBox).
 172 </para>
 173
 174 @GTK_PACK_START: The child is packed into the start of the box
 175 @GTK_PACK_END: The child is packed into the end of the box
 176
 177 <!-- ##### ENUM GtkPathPriorityType ##### -->
 178 <para>
 179
 180 </para>
 181
 182 @GTK_PATH_PRIO_LOWEST:
 183 @GTK_PATH_PRIO_GTK:
 184 @GTK_PATH_PRIO_APPLICATION:
 185 @GTK_PATH_PRIO_RC:
 186 @GTK_PATH_PRIO_HIGHEST:
 187 @GTK_PATH_PRIO_MASK:
 188
 189 <!-- ##### ENUM GtkPathType ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @GTK_PATH_WIDGET:
 195 @GTK_PATH_WIDGET_CLASS:
 196 @GTK_PATH_CLASS:
 197
 198 <!-- ##### ENUM GtkPolicyType ##### -->
 199 <para>
 200 Determines when a scroll bar will be visible.
 201 </para>
 202
 203 @GTK_POLICY_ALWAYS: The scrollbar is always visible.
 204 @GTK_POLICY_AUTOMATIC: The scrollbar will appear and disappear as necessary. For example,
 205 when all of a #GtkCList can not be seen.
 206 @GTK_POLICY_NEVER: The scrollbar will never appear.
 207
 208 <!-- ##### ENUM GtkPositionType ##### -->
 209 <para>
 210
 211 </para>
 212
 213 @GTK_POS_LEFT:
 214 @GTK_POS_RIGHT:
 215 @GTK_POS_TOP:
 216 @GTK_POS_BOTTOM:
 217
 218 <!-- ##### ENUM GtkPreviewType ##### -->
 219 <para>
 220 An enumeration which describes whether a preview
 221 contains grayscale or red-green-blue data.
 222 </para>
 223
 224 @GTK_PREVIEW_COLOR: the preview contains red-green-blue data.
 225 @GTK_PREVIEW_GRAYSCALE: The preview contains grayscale data.
 226
 227 <!-- ##### ENUM GtkReliefStyle ##### -->
 228 <para>
 229
 230 </para>
 231
 232 @GTK_RELIEF_NORMAL:
 233 @GTK_RELIEF_HALF:
 234 @GTK_RELIEF_NONE:
 235
 236 <!-- ##### ENUM GtkResizeMode ##### -->
 237 <para>
 238
 239 </para>
 240
 241 @GTK_RESIZE_PARENT:
 242 @GTK_RESIZE_QUEUE:
 243 @GTK_RESIZE_IMMEDIATE:
 244
 245 <!-- ##### ENUM GtkScrollType ##### -->
 246 <para>
 247
 248 </para>
 249
 250 @GTK_SCROLL_NONE:
 251 @GTK_SCROLL_STEP_BACKWARD:
 252 @GTK_SCROLL_STEP_FORWARD:
 253 @GTK_SCROLL_PAGE_BACKWARD:
 254 @GTK_SCROLL_PAGE_FORWARD:
 255 @GTK_SCROLL_JUMP:
 256 @GTK_SCROLL_STEP_UP:
 257 @GTK_SCROLL_STEP_DOWN:
 258 @GTK_SCROLL_PAGE_UP:
 259 @GTK_SCROLL_PAGE_DOWN:
 260 @GTK_SCROLL_STEP_LEFT:
 261 @GTK_SCROLL_STEP_RIGHT:
 262 @GTK_SCROLL_PAGE_LEFT:
 263 @GTK_SCROLL_PAGE_RIGHT:
 264
 265 <!-- ##### ENUM GtkSelectionMode ##### -->
 266 <para>
 267
 268 </para>
 269
 270 @GTK_SELECTION_SINGLE:
 271 @GTK_SELECTION_BROWSE:
 272 @GTK_SELECTION_MULTIPLE:
 273 @GTK_SELECTION_EXTENDED:
 274
 275 <!-- ##### ENUM GtkShadowType ##### -->
 276 <para>
 277 Used to change the appearance of an outline typically provided by a #GtkFrame.
 278 </para>
 279
 280 @GTK_SHADOW_NONE: No outline.
 281 @GTK_SHADOW_IN: The outline is bevelled inwards.
 282 @GTK_SHADOW_OUT: The outline is bevelled outwards like a button.
 283 @GTK_SHADOW_ETCHED_IN: The outline itself is an inward bevel, but the frame
 284 does
 285 @GTK_SHADOW_ETCHED_OUT:
 286
 287 <!-- ##### ENUM GtkStateType ##### -->
 288 <para>
 289 This type indicates the current state of a widget.
 290 </para>
 291
 292 @GTK_STATE_NORMAL: The state during normal operation.
 293 @GTK_STATE_ACTIVE: The widget is currently active, such as a
 294 @GTK_STATE_PRELIGHT: The mouse pointer is over the widget.
 295 @GTK_STATE_SELECTED:
 296 @GTK_STATE_INSENSITIVE: The state of the widget can not be altered by the
 297 user. Its appearance will usually indicate this.
 298
 299 <!-- ##### ENUM GtkSubmenuDirection ##### -->
 300 <para>
 301 Indicates the direction a sub-menu will appear.
 302 </para>
 303
 304 @GTK_DIRECTION_LEFT: A sub-menu will appear
 305 @GTK_DIRECTION_RIGHT:
 306
 307 <!-- ##### ENUM GtkSubmenuPlacement ##### -->
 308 <para>
 309
 310 </para>
 311
 312 @GTK_TOP_BOTTOM:
 313 @GTK_LEFT_RIGHT:
 314
 315 <!-- ##### ENUM GtkToolbarStyle ##### -->
 316 <para>
 317 Used to customize the appearance of a #GtkToolbar. Note that
 318 setting the toolbar style overrides the user's preferences
 319 for the default toolbar style.
 320 </para>
 321
 322 @GTK_TOOLBAR_ICONS: Buttons display only icons in the toolbar.
 323 @GTK_TOOLBAR_TEXT: Buttons display only text labels in the toolbar.
 324 @GTK_TOOLBAR_BOTH: Buttons display text and icons in the toolbar.
 325 @GTK_TOOLBAR_BOTH_HORIZ: Buttons display icons and text alongside each
 326 other, rather than vertically stacked
 327
 328 <!-- ##### ENUM GtkTroughType ##### -->
 329 <para>
 330
 331 </para>
 332
 333 @GTK_TROUGH_NONE:
 334 @GTK_TROUGH_START:
 335 @GTK_TROUGH_END:
 336 @GTK_TROUGH_JUMP:
 337
 338 <!-- ##### ENUM GtkUpdateType ##### -->
 339 <para>
 340
 341 </para>
 342
 343 @GTK_UPDATE_CONTINUOUS:
 344 @GTK_UPDATE_DISCONTINUOUS:
 345 @GTK_UPDATE_DELAYED:
 346
 347 <!-- ##### ENUM GtkVisibility ##### -->
 348 <para>
 349
 350 </para>
 351
 352 @GTK_VISIBILITY_NONE:
 353 @GTK_VISIBILITY_PARTIAL:
 354 @GTK_VISIBILITY_FULL:
 355
 356 <!-- ##### ENUM GtkWindowPosition ##### -->
 357 <para>
 358 Window placement can be influenced using this enumeration.
 359 </para>
 360
 361 @GTK_WIN_POS_NONE: No influence is made on placement.
 362 @GTK_WIN_POS_CENTER: Windows should be placed in the center of the screen.
 363 @GTK_WIN_POS_MOUSE: Windows should be placed at the current mouse position.
 364 @GTK_WIN_POS_CENTER_ALWAYS: Keep window centered as it changes size, etc.
 365 @GTK_WIN_POS_CENTER_ON_PARENT: Center the window on its transient
 366 parent (see gtk_window_set_transient_for()).
 367
 368 <!-- ##### ENUM GtkWindowType ##### -->
 369 <para>
 370 A #GtkWindow can be one of these types. Most things you'd consider a
 371 "window" should have type #GTK_WINDOW_TOPLEVEL; windows with this type
 372 are managed by the window manager and have a frame by default (call
 373 gtk_window_set_decorated() to toggle the frame).  Windows with type
 374 #GTK_WINDOW_POPUP are ignored by the window manager; window manager
 375 keybindings won't work on them, the window manager won't decorate the
 376 window with a frame, many GTK+ features that rely on the window
 377 manager will not work (e.g. resize grips and
 378 maximization/minimization). #GTK_WINDOW_POPUP is used to implement
 379 widgets such as #GtkMenu or tooltips that you normally don't think of
 380 as windows per se. Nearly all windows should be #GTK_WINDOW_TOPLEVEL.
 381 In particular, do not use #GTK_WINDOW_POPUP just to turn off
 382 the window borders; use gtk_window_set_decorated() for that.
 383 </para>
 384
 385 @GTK_WINDOW_TOPLEVEL: A regular window, such as a dialog.
 386 @GTK_WINDOW_POPUP: A special window such as a tooltip.
 387
 388 <!-- ##### ENUM GtkSortType ##### -->
 389 <para>
 390 Determines the direction of a sort.
 391 </para>
 392
 393 @GTK_SORT_ASCENDING: Sorting is in ascending order.
 394 @GTK_SORT_DESCENDING: Sorting is in descending order.
 395