GTK+ Reference Manual
<<< Previous Page | Home | Up | Next Page >>>

# GtkScale

## Name

GtkScale -- a base class for GtkHScale and GtkVScale.

## Synopsis

    #include <gtk/gtk.h>

    struct      GtkScale;
    void        gtk_scale_set_digits            (GtkScale *scale,
                                                 gint digits);
    void        gtk_scale_set_draw_value        (GtkScale *scale,
                                                 gboolean draw_value);
    void        gtk_scale_set_value_pos         (GtkScale *scale,
                                                 GtkPositionType pos);
    gint        gtk_scale_get_value_width       (GtkScale *scale);

## Object Hierarchy

      GtkObject
       +----GtkWidget
             +----GtkRange
                   +----GtkScale

## Properties

      "digits"               gint                 : Read / Write
      "draw-value"           gboolean             : Read / Write
      "value-pos"            GtkPositionType      : Read / Write

## Description

The GtkScale widget is an abstract class, used only for deriving the subclasses GtkHScale and GtkVScale.

## Details

### struct GtkScale

    struct GtkScale;

The GtkScale struct contains the following fields. (These fields should be considered read-only. They should never be set by an application.)

guint `draw_value`; | non-zero if the scale's current value is displayed next to the slider.
guint `value_pos`; | the position in which the textual value is displayed, selected from GtkPositionType.

### gtk_scale_set_digits ()

    void        gtk_scale_set_digits            (GtkScale *scale,
                                                 gint digits);

Sets the number of decimal places that are displayed in the value.

`scale` : | a GtkScale.
`digits` : | the number of decimal places to display, e.g. use 1 to display 1.0, 2 to display 1.00 etc.

### gtk_scale_set_draw_value ()

    void        gtk_scale_set_draw_value        (GtkScale *scale,
                                                 gboolean draw_value);

Specifies whether the current value is displayed as a string next to the slider.

`scale` : | a GtkScale.
`draw_value` : |

### gtk_scale_set_value_pos ()

    void        gtk_scale_set_value_pos         (GtkScale *scale,
                                                 GtkPositionType pos);

Sets the position in which the current value is displayed.

`scale` : | a GtkScale.
`pos` : | the position in which the current value is displayed.

### gtk_scale_get_value_width ()

    gint        gtk_scale_get_value_width       (GtkScale *scale);

An internal function used to get the maximum width needed to display the value string.

`scale` : | a GtkScale.
Returns : | the maximum width needed to display the value string.

## Properties

"`digits`" (gint : Read / Write)

  The number of decimal places that are displayed in the value.

"`draw-value`" (gboolean : Read / Write)

"`value-pos`" (GtkPositionType : Read / Write)

<<< Previous Page | Home | Up | Next Page >>>
GtkRuler | GtkScrollbar