Gtk.Scale – gtk+-3.0 Reference Manual

Scale

Object Hierarchy:

Description:

[ CCode ( type_id = "gtk_scale_get_type ()" ) ]
public class Scale : Range, Implementor, Buildable, Orientable

A GtkScale is a slider control used to select a numeric value.

To use it, you’ll probably want to investigate the methods on its base class, Range , in addition to the methods for GtkScale itself. To set the value of a scale, you would normally use set_value. To detect changes to the value, you would normally use the value_changed signal.

Note that using the same upper and lower bounds for the Scale (through the 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

GtkScale supports a custom `<marks>` element, which can contain multiple `<mark>` elements. The “value” and “position” attributes have the same meaning as add_mark 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]
├── marks.top
│	 ├── mark
│	 ┊		├── [label]
│	 ┊		╰── indicator
┊	 ┊
│	 ╰── mark
├── [value]
├── contents
│	 ╰── trough
│			 ├── slider
│			 ├── [highlight]
│			 ╰── [fill]
╰── marks.bottom
		├── mark
		┊		├── indicator
		┊		╰── [label]
		╰── mark

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

If the scale has an origin (see set_has_origin), 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 set_show_fill_level), 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 contents 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 draw_value), there is subnode with name value.

GtkScale

All known sub-classes:

HScale

VScale

Namespace: Gtk

Package: gtk+-3.0

Content:

Properties:

public int digits { get; set; }
public virtual bool draw_value { get; set; }
public bool has_origin { get; set; }
public PositionType value_pos { get; set; }

Creation methods:

public Scale (Orientation orientation, Adjustment? adjustment)
Creates a new Scale.
public Scale.with_range (Orientation orientation, double min, double max, double step)
Creates a new scale widget with the given orientation that lets the user input a number between min and max (including min and max) with the increment step.

Methods:

public void add_mark (double value, PositionType position, string? markup)
Adds a mark at value.
public void clear_marks ()
Removes any marks that have been added with add_mark.
public int get_digits ()
Gets the number of decimal places that are displayed in the value.
public bool get_draw_value ()
Returns whether the current value is displayed as a string next to the slider.
public bool get_has_origin ()
Returns whether the scale has an origin.
public unowned Layout? get_layout ()
Gets the Layout used to display the scale.
public virtual void get_layout_offsets (out int x, out int y)
Obtains the coordinates where the scale will draw the Layout representing the text in the scale.
public PositionType get_value_pos ()
Gets the position in which the current value is displayed.
public void set_digits (int digits)
Sets the number of decimal places that are displayed in the value.
public void set_draw_value (bool draw_value)
Specifies whether the current value is displayed as a string next to the slider.
public void set_has_origin (bool has_origin)
If has_origin is set to true (the default), the scale will highlight the part of the trough between the origin ( bottom or left side) and the current value.
public void set_value_pos (PositionType pos)
Sets the position in which the current value is displayed.

Signals:

public virtual signal string format_value (double value)
Signal which allows you to change how the scale value is displayed.

Inherited Members:

All known members inherited from class Gtk.Range

All known members inherited from class Gtk.Widget

All known members inherited from class GLib.Object

@get
@new
@ref
@set
add_toggle_ref
add_weak_pointer
bind_property
connect
constructed
disconnect
dispose
dup_data
dup_qdata
force_floating
freeze_notify
get_class
get_data

get_property
get_qdata
get_type
getv
interface_find_property
interface_install_property
interface_list_properties
is_floating
new_valist
new_with_properties
newv
notify
notify_property
ref_count
ref_sink
remove_toggle_ref
remove_weak_pointer

replace_data
replace_qdata
set_data
set_data_full
set_property
set_qdata
set_qdata_full
set_valist
setv
steal_data
steal_qdata
thaw_notify
unref
watch_closure
weak_ref
weak_unref

All known members inherited from interface Atk.Implementor

ref_accessible

All known members inherited from interface Gtk.Buildable

All known members inherited from interface Gtk.Orientable

get_orientation

orientation

set_orientation

2022 vala-language.org