Scale

A gtk.scale.Scale is a slider control used to select a numeric value.

An example GtkScale

To use it, you’ll probably want to investigate the methods on its base class, gtk.range.Range, in addition to the methods for gtk.scale.Scale itself. To set the value of a scale, you would normally use gtk.range.Range.setValue. To detect changes to the value, you would normally use the signal@Gtk.Range::value-changed signal.

Note that using the same upper and lower bounds for the gtk.scale.Scale (through the gtk.range.Range methods) will hide the slider itself. This is useful for applications that want to show an undeterminate value on the scale, without changing the layout of the application (such as movie or music players).

GtkScale as GtkBuildable

gtk.scale.Scale supports a custom <marks> element, which can contain multiple <mark\> elements. The “value” and “position” attributes have the same meaning as gtk.scale.Scale.addMark parameters of the same name. If the element is not empty, its content is taken as the markup to show at the mark. It can be translated with the usual ”translatable” and “context” attributes.

CSS nodes

scale[.fine-tune][.marks-before][.marks-after]
├── [value][.top][.right][.bottom][.left]
├── marks.top
│   ├── mark
│   ┊    ├── [label]
│   ┊    ╰── indicator
┊   ┊
│   ╰── mark
├── marks.bottom
│   ├── mark
│   ┊    ├── indicator
│   ┊    ╰── [label]
┊   ┊
│   ╰── mark
╰── trough
    ├── [fill]
    ├── [highlight]
    ╰── slider

gtk.scale.Scale has a main CSS node with name scale and a subnode for its contents, with subnodes named trough and slider.

The main node gets the style class .fine-tune added when the scale is in 'fine-tuning' mode.

If the scale has an origin (see gtk.scale.Scale.setHasOrigin), there is a subnode with name highlight below the trough node that is used for rendering the highlighted part of the trough.

If the scale is showing a fill level (see gtk.range.Range.setShowFillLevel), there is a subnode with name fill below the trough node that is used for rendering the filled in part of the trough.

If marks are present, there is a marks subnode before or after the trough node, below which each mark gets a node with name mark. The marks nodes get either the .top or .bottom style class.

The mark node has a subnode named indicator. If the mark has text, it also has a subnode named label. When the mark is either above or left of the scale, the label subnode is the first when present. Otherwise, the indicator subnode is the first.

The main CSS node gets the 'marks-before' and/or 'marks-after' style classes added depending on what marks are present.

If the scale is displaying the value (see property@Gtk.Scale:draw-value), there is subnode with name value. This node will get the .top or .bottom style classes similar to the marks node.

Accessibility

gtk.scale.Scale uses the gtk.types.AccessibleRole.Slider role.

class Scale : Range {

this(gtk.types.Orientation orientation, gtk.adjustment.Adjustment adjustment);

static gtk.scale.Scale newWithRange(gtk.types.Orientation orientation, double min, double max, double step);

void addMark(double value, gtk.types.PositionType position, string markup);

void clearMarks();

int getDigits();

bool getDrawValue();

bool getHasOrigin();

pango.layout.Layout getLayout();

void getLayoutOffsets(int x, int y);

gtk.types.PositionType getValuePos();

void setDigits(int digits);

void setDrawValue(bool drawValue);

void setFormatValueFunc(gtk.types.ScaleFormatValueFunc func);

void setHasOrigin(bool hasOrigin);

void setValuePos(gtk.types.PositionType pos);

}

Constructors

this this(gtk.types.Orientation orientation, gtk.adjustment.Adjustment adjustment): Creates a new gtk.scale.Scale.

Members

Functions

addMark void addMark(double value, gtk.types.PositionType position, string markup): Adds a mark at value.
clearMarks void clearMarks(): Removes any marks that have been added.
getDigits int getDigits(): Gets the number of decimal places that are displayed in the value.
getDrawValue bool getDrawValue(): Returns whether the current value is displayed as a string next to the slider.
getHasOrigin bool getHasOrigin(): Returns whether the scale has an origin.
getLayout pango.layout.Layout getLayout(): Gets the pango.layout.Layout used to display the scale.
getLayoutOffsets void getLayoutOffsets(int x, int y): Obtains the coordinates where the scale will draw the pango.layout.Layout representing the text in the scale.
getValuePos gtk.types.PositionType getValuePos(): Gets the position in which the current value is displayed.
setDigits void setDigits(int digits): Sets the number of decimal places that are displayed in the value.
setDrawValue void setDrawValue(bool drawValue): Specifies whether the current value is displayed as a string next to the slider.
setFormatValueFunc void setFormatValueFunc(gtk.types.ScaleFormatValueFunc func): func allows you to change how the scale value is displayed.
setHasOrigin void setHasOrigin(bool hasOrigin): Sets whether the scale has an origin.
setValuePos void setValuePos(gtk.types.PositionType pos): Sets the position in which the current value is displayed.

Static functions

newWithRange gtk.scale.Scale newWithRange(gtk.types.Orientation orientation, double min, double max, double step): Creates a new scale widget with a range from min to max.

Inherited Members

From Range

getAdjustment gtk.adjustment.Adjustment getAdjustment(): Get the adjustment which is the “model” object for gtk.range.Range.
getFillLevel double getFillLevel(): Gets the current position of the fill level indicator.
getFlippable bool getFlippable(): Gets whether the gtk.range.Range respects text direction.
getInverted bool getInverted(): Gets whether the range is inverted.
getRangeRect void getRangeRect(gdk.rectangle.Rectangle rangeRect): This function returns the area that contains the range’s trough, in coordinates relative to range's origin.
getRestrictToFillLevel bool getRestrictToFillLevel(): Gets whether the range is restricted to the fill level.
getRoundDigits int getRoundDigits(): Gets the number of digits to round the value to when it changes.
getShowFillLevel bool getShowFillLevel(): Gets whether the range displays the fill level graphically.
getSliderRange void getSliderRange(int sliderStart, int sliderEnd): This function returns sliders range along the long dimension, in widget->window coordinates.
getSliderSizeFixed bool getSliderSizeFixed(): This function is useful mainly for gtk.range.Range subclasses.
getValue double getValue(): Gets the current value of the range.
setAdjustment void setAdjustment(gtk.adjustment.Adjustment adjustment): Sets the adjustment to be used as the “model” object for the gtk.range.Range
setFillLevel void setFillLevel(double fillLevel): Set the new position of the fill level indicator.
setFlippable void setFlippable(bool flippable): Sets whether the gtk.range.Range respects text direction.
setIncrements void setIncrements(double step, double page): Sets the step and page sizes for the range.
setInverted void setInverted(bool setting): Sets whether to invert the range.
setRange void setRange(double min, double max): Sets the allowable values in the gtk.range.Range.
setRestrictToFillLevel void setRestrictToFillLevel(bool restrictToFillLevel): Sets whether the slider is restricted to the fill level.
setRoundDigits void setRoundDigits(int roundDigits): Sets the number of digits to round the value to when it changes.
setShowFillLevel void setShowFillLevel(bool showFillLevel): Sets whether a graphical fill level is show on the trough.
setSliderSizeFixed void setSliderSizeFixed(bool sizeFixed): Sets whether the range’s slider has a fixed size, or a size that depends on its adjustment’s page size.
setValue void setValue(double value): Sets the current value of the range.
connectAdjustBounds ulong connectAdjustBounds(T callback, Flag!"After" after): Connect to AdjustBounds signal.
connectChangeValue ulong connectChangeValue(T callback, Flag!"After" after): Connect to ChangeValue signal.
connectMoveSlider ulong connectMoveSlider(T callback, Flag!"After" after): Connect to MoveSlider signal.
connectValueChanged ulong connectValueChanged(T callback, Flag!"After" after): Connect to ValueChanged signal.

gtk scale classes

Scale