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