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

   1 <!-- ##### SECTION Title ##### -->
   2 GtkRange
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 Base class for widgets which visualize an adjustment
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 #GtkRange is the common base class for widgets which visualize an
  10 adjustment, e.g scales or scrollbars.
  11 </para>
  12 <para>
  13 Apart from signals for monitoring the parameters of the adjustment,
  14 GtkRange provides properties and methods for influencing the sensitivity
  15 of the "steppers". It also provides properties and methods for setting a
  16 "fill level" on range widgets. See gtk_range_set_fill_level().
  17 </para>
  18
  19 <!-- ##### SECTION See_Also ##### -->
  20 <para>
  21
  22 </para>
  23
  24 <!-- ##### SECTION Stability_Level ##### -->
  25
  26
  27 <!-- ##### STRUCT GtkRange ##### -->
  28 <para>
  29
  30 </para>
  31
  32
  33 <!-- ##### SIGNAL GtkRange::adjust-bounds ##### -->
  34 <para>
  35
  36 </para>
  37
  38 @range: the object which received the signal.
  39 @arg1:
  40
  41 <!-- ##### SIGNAL GtkRange::change-value ##### -->
  42 <para>
  43
  44 </para>
  45
  46 @range: the object which received the signal.
  47 @arg1:
  48 @arg2:
  49 @Returns:
  50
  51 <!-- ##### SIGNAL GtkRange::move-slider ##### -->
  52 <para>
  53
  54 </para>
  55
  56 @range:
  57 @step:
  58
  59 <!-- ##### SIGNAL GtkRange::value-changed ##### -->
  60 <para>
  61
  62 </para>
  63
  64 @range:
  65
  66 <!-- ##### ARG GtkRange:adjustment ##### -->
  67 <para>
  68
  69 </para>
  70
  71 <!-- ##### ARG GtkRange:fill-level ##### -->
  72 <para>
  73
  74 </para>
  75
  76 <!-- ##### ARG GtkRange:inverted ##### -->
  77 <para>
  78
  79 </para>
  80
  81 <!-- ##### ARG GtkRange:lower-stepper-sensitivity ##### -->
  82 <para>
  83
  84 </para>
  85
  86 <!-- ##### ARG GtkRange:restrict-to-fill-level ##### -->
  87 <para>
  88
  89 </para>
  90
  91 <!-- ##### ARG GtkRange:show-fill-level ##### -->
  92 <para>
  93
  94 </para>
  95
  96 <!-- ##### ARG GtkRange:update-policy ##### -->
  97 <para>
  98
  99 </para>
 100
 101 <!-- ##### ARG GtkRange:upper-stepper-sensitivity ##### -->
 102 <para>
 103
 104 </para>
 105
 106 <!-- ##### ARG GtkRange:activate-slider ##### -->
 107 <para>
 108
 109 </para>
 110
 111 <!-- ##### ARG GtkRange:arrow-displacement-x ##### -->
 112 <para>
 113
 114 </para>
 115
 116 <!-- ##### ARG GtkRange:arrow-displacement-y ##### -->
 117 <para>
 118
 119 </para>
 120
 121 <!-- ##### ARG GtkRange:arrow-scaling ##### -->
 122 <para>
 123
 124 </para>
 125
 126 <!-- ##### ARG GtkRange:slider-width ##### -->
 127 <para>
 128
 129 </para>
 130
 131 <!-- ##### ARG GtkRange:stepper-size ##### -->
 132 <para>
 133
 134 </para>
 135
 136 <!-- ##### ARG GtkRange:stepper-spacing ##### -->
 137 <para>
 138
 139 </para>
 140
 141 <!-- ##### ARG GtkRange:trough-border ##### -->
 142 <para>
 143
 144 </para>
 145
 146 <!-- ##### ARG GtkRange:trough-side-details ##### -->
 147 <para>
 148
 149 </para>
 150
 151 <!-- ##### ARG GtkRange:trough-under-steppers ##### -->
 152 <para>
 153
 154 </para>
 155
 156 <!-- ##### FUNCTION gtk_range_get_fill_level ##### -->
 157 <para>
 158
 159 </para>
 160
 161 @range:
 162 @Returns:
 163
 164
 165 <!-- ##### FUNCTION gtk_range_get_restrict_to_fill_level ##### -->
 166 <para>
 167
 168 </para>
 169
 170 @range:
 171 @Returns:
 172
 173
 174 <!-- ##### FUNCTION gtk_range_get_show_fill_level ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @range:
 180 @Returns:
 181
 182
 183 <!-- ##### FUNCTION gtk_range_set_fill_level ##### -->
 184 <para>
 185
 186 </para>
 187
 188 @range:
 189 @fill_level:
 190
 191
 192 <!-- ##### FUNCTION gtk_range_set_restrict_to_fill_level ##### -->
 193 <para>
 194
 195 </para>
 196
 197 @range:
 198 @restrict_to_fill_level:
 199
 200
 201 <!-- ##### FUNCTION gtk_range_set_show_fill_level ##### -->
 202 <para>
 203
 204 </para>
 205
 206 @range:
 207 @show_fill_level:
 208
 209
 210 <!-- ##### FUNCTION gtk_range_get_adjustment ##### -->
 211 <para>
 212
 213 </para>
 214
 215 @range:
 216 @Returns:
 217
 218
 219 <!-- ##### FUNCTION gtk_range_set_update_policy ##### -->
 220 <para>
 221
 222 </para>
 223
 224 @range:
 225 @policy:
 226
 227
 228 <!-- ##### FUNCTION gtk_range_set_adjustment ##### -->
 229 <para>
 230
 231 </para>
 232
 233 @range:
 234 @adjustment:
 235
 236
 237 <!-- ##### FUNCTION gtk_range_get_inverted ##### -->
 238 <para>
 239
 240 </para>
 241
 242 @range:
 243 @Returns:
 244
 245
 246 <!-- ##### FUNCTION gtk_range_set_inverted ##### -->
 247 <para>
 248
 249 </para>
 250
 251 @range:
 252 @setting:
 253
 254
 255 <!-- ##### FUNCTION gtk_range_get_update_policy ##### -->
 256 <para>
 257
 258 </para>
 259
 260 @range:
 261 @Returns:
 262
 263
 264 <!-- ##### FUNCTION gtk_range_get_value ##### -->
 265 <para>
 266
 267 </para>
 268
 269 @range:
 270 @Returns:
 271
 272
 273 <!-- ##### FUNCTION gtk_range_set_increments ##### -->
 274 <para>
 275
 276 </para>
 277
 278 @range:
 279 @step:
 280 @page:
 281
 282
 283 <!-- ##### FUNCTION gtk_range_set_range ##### -->
 284 <para>
 285
 286 </para>
 287
 288 @range:
 289 @min:
 290 @max:
 291
 292
 293 <!-- ##### FUNCTION gtk_range_set_value ##### -->
 294 <para>
 295
 296 </para>
 297
 298 @range:
 299 @value:
 300
 301
 302 <!-- ##### ENUM GtkSensitivityType ##### -->
 303 <para>
 304 Determines how GTK+ handles the sensitivity of stepper arrows
 305 at the end of range widgets.
 306 </para>
 307
 308 @GTK_SENSITIVITY_AUTO: The arrow is made insensitive if the
 309    thumb is at the end
 310 @GTK_SENSITIVITY_ON: The arrow is always sensitive
 311 @GTK_SENSITIVITY_OFF: The arrow is always insensitive
 312
 313 <!-- ##### FUNCTION gtk_range_set_lower_stepper_sensitivity ##### -->
 314 <para>
 315
 316 </para>
 317
 318 @range:
 319 @sensitivity:
 320
 321
 322 <!-- ##### FUNCTION gtk_range_get_lower_stepper_sensitivity ##### -->
 323 <para>
 324
 325 </para>
 326
 327 @range:
 328 @Returns:
 329
 330
 331 <!-- ##### FUNCTION gtk_range_set_upper_stepper_sensitivity ##### -->
 332 <para>
 333
 334 </para>
 335
 336 @range:
 337 @sensitivity:
 338
 339
 340 <!-- ##### FUNCTION gtk_range_get_upper_stepper_sensitivity ##### -->
 341 <para>
 342
 343 </para>
 344
 345 @range:
 346 @Returns:
 347
 348
 349 <!-- ##### FUNCTION gtk_range_get_flippable ##### -->
 350 <para>
 351
 352 </para>
 353
 354 @range:
 355 @Returns:
 356
 357
 358 <!-- ##### FUNCTION gtk_range_set_flippable ##### -->
 359 <para>
 360
 361 </para>
 362
 363 @range:
 364 @flippable:
 365
 366
 367 <!-- ##### FUNCTION gtk_range_get_min_slider_size ##### -->
 368 <para>
 369
 370 </para>
 371
 372 @range:
 373 @Returns:
 374
 375
 376 <!-- ##### FUNCTION gtk_range_get_range_rect ##### -->
 377 <para>
 378
 379 </para>
 380
 381 @range:
 382 @range_rect:
 383
 384
 385 <!-- ##### FUNCTION gtk_range_get_slider_range ##### -->
 386 <para>
 387
 388 </para>
 389
 390 @range:
 391 @slider_start:
 392 @slider_end:
 393
 394
 395 <!-- ##### FUNCTION gtk_range_get_slider_size_fixed ##### -->
 396 <para>
 397
 398 </para>
 399
 400 @range:
 401 @Returns:
 402
 403
 404 <!-- ##### FUNCTION gtk_range_set_min_slider_size ##### -->
 405 <para>
 406
 407 </para>
 408
 409 @range:
 410 @min_size:
 411
 412
 413 <!-- ##### FUNCTION gtk_range_set_slider_size_fixed ##### -->
 414 <para>
 415
 416 </para>
 417
 418 @range:
 419 @size_fixed:
 420
 421