:right-sidebar: True Scale =================================================================== .. currentmodule:: gi.repository.Gtk .. class:: Scale(**properties: ~typing.Any) :no-contents-entry: Superclasses: :class:`~gi.repository.Gtk.Range`, :class:`~gi.repository.Gtk.Widget`, :class:`~gi.repository.GObject.InitiallyUnowned`, :class:`~gi.repository.GObject.Object` Implemented Interfaces: :class:`~gi.repository.Gtk.Accessible`, :class:`~gi.repository.Gtk.AccessibleRange`, :class:`~gi.repository.Gtk.Buildable`, :class:`~gi.repository.Gtk.ConstraintTarget`, :class:`~gi.repository.Gtk.Orientable` :Constructors: :: Scale(**properties) new(orientation:Gtk.Orientation, adjustment:Gtk.Adjustment=None) -> Gtk.Widget new_with_range(orientation:Gtk.Orientation, min:float, max:float, step:float) -> Gtk.Widget Constructors ------------ .. rst-class:: interim-class .. class:: Scale :no-index: .. classmethod:: new(orientation: ~gi.repository.Gtk.Orientation, adjustment: ~gi.repository.Gtk.Adjustment | None = None) -> ~gi.repository.Gtk.Widget Creates a new ``GtkScale``. :param orientation: the scale’s orientation. :param adjustment: the :obj:`~gi.repository.Gtk.Adjustment` which sets the range of the scale, or :const:`None` to create a new adjustment. .. classmethod:: new_with_range(orientation: ~gi.repository.Gtk.Orientation, min: float, max: float, step: float) -> ~gi.repository.Gtk.Widget Creates a new scale widget with a range from ``min`` to ``max``. The returns scale will have the given orientation and will let the user input a number between ``min`` and ``max`` (including ``min`` and ``max``) with the increment ``step``. ``step`` must be nonzero; it’s the distance the slider moves when using the arrow keys to adjust the scale value. Note that the way in which the precision is derived works best if ``step`` is a power of ten. If the resulting precision is not suitable for your needs, use :obj:`~gi.repository.Gtk.Scale.set_digits` to correct it. :param orientation: the scale’s orientation. :param min: minimum value :param max: maximum value :param step: step increment (tick size) used with keyboard shortcuts Methods ------- .. rst-class:: interim-class .. class:: Scale :no-index: .. method:: add_mark(value: float, position: ~gi.repository.Gtk.PositionType, markup: str | None = None) -> None Adds a mark at ``value``. A mark is indicated visually by drawing a tick mark next to the scale, and GTK makes it easy for the user to position the scale exactly at the marks value. If ``markup`` is not :const:`None`, text is shown next to the tick mark. To remove marks from a scale, use :obj:`~gi.repository.Gtk.Scale.clear_marks`. :param value: the value at which the mark is placed, must be between the lower and upper limits of the scales’ adjustment :param position: where to draw the mark. For a horizontal scale, :const:`~gi.repository.Gtk.PositionType.TOP` and :const:`~gi.repository.Gtk.PositionType.LEFT` are drawn above the scale, anything else below. For a vertical scale, :const:`~gi.repository.Gtk.PositionType.LEFT` and :const:`~gi.repository.Gtk.PositionType.TOP` are drawn to the left of the scale, anything else to the right. :param markup: Text to be shown at the mark, using Pango markup .. method:: clear_marks() -> None Removes any marks that have been added. .. method:: get_digits() -> int Gets the number of decimal places that are displayed in the value. .. method:: get_draw_value() -> bool Returns whether the current value is displayed as a string next to the slider. .. method:: get_has_origin() -> bool Returns whether the scale has an origin. .. method:: get_layout() -> ~gi.repository.Pango.Layout | None Gets the ``PangoLayout`` used to display the scale. The returned object is owned by the scale so does not need to be freed by the caller. .. method:: get_layout_offsets() -> tuple[int, int] Obtains the coordinates where the scale will draw the ``PangoLayout`` representing the text in the scale. Remember when using the ``PangoLayout`` function you need to convert to and from pixels using ``:func:`~gi.repository.Pango.PIXELS``` or ``PANGO_SCALE``. If the :obj:`~gi.repository.Gtk.Scale.props.draw_value` property is :const:`False`, the return values are undefined. .. method:: get_value_pos() -> ~gi.repository.Gtk.PositionType Gets the position in which the current value is displayed. .. method:: set_digits(digits: int) -> None Sets the number of decimal places that are displayed in the value. Also causes the value of the adjustment to be rounded to this number of digits, so the retrieved value matches the displayed one, if :obj:`~gi.repository.Gtk.Scale.props.draw_value` is :const:`True` when the value changes. If you want to enforce rounding the value when :obj:`~gi.repository.Gtk.Scale.props.draw_value` is :const:`False`, you can set :obj:`~gi.repository.Gtk.Range.props.round_digits` instead. Note that rounding to a small number of digits can interfere with the smooth autoscrolling that is built into ``GtkScale``. As an alternative, you can use :obj:`~gi.repository.Gtk.Scale.set_format_value_func` to format the displayed value yourself. :param digits: the number of decimal places to display, e.g. use 1 to display 1.0, 2 to display 1.00, etc .. method:: set_draw_value(draw_value: bool) -> None Specifies whether the current value is displayed as a string next to the slider. :param draw_value: :const:`True` to draw the value .. method:: set_format_value_func(func: ~typing.Callable[[...], str] | None = None, *user_data: ~typing.Any) -> None ``func`` allows you to change how the scale value is displayed. The given function will return an allocated string representing ``value``. That string will then be used to display the scale's value. If :obj:`~gi.repository.None` is passed as ``func``, the value will be displayed on its own, rounded according to the value of the :obj:`~gi.repository.Gtk.Scale.props.digits` property. :param func: function that formats the value :param user_data: user data to pass to ``func`` .. method:: set_has_origin(has_origin: bool) -> None Sets whether the scale has an origin. If :obj:`~gi.repository.Gtk.Scale.props.has_origin` is set to :const:`True` (the default), the scale will highlight the part of the trough between the origin (bottom or left side) and the current value. :param has_origin: :const:`True` if the scale has an origin .. method:: set_value_pos(pos: ~gi.repository.Gtk.PositionType) -> None Sets the position in which the current value is displayed. :param pos: the position in which the current value is displayed Properties ---------- .. rst-class:: interim-class .. class:: Scale :no-index: .. attribute:: props.digits :type: int The number of decimal places that are displayed in the value. .. attribute:: props.draw_value :type: bool Whether the current value is displayed as a string next to the slider. .. attribute:: props.has_origin :type: bool Whether the scale has an origin. .. attribute:: props.value_pos :type: ~gi.repository.Gtk.PositionType The position in which the current value is displayed. Virtual Methods --------------- .. rst-class:: interim-class .. class:: Scale :no-index: .. method:: do_get_layout_offsets() -> tuple[int, int] Obtains the coordinates where the scale will draw the ``PangoLayout`` representing the text in the scale. Remember when using the ``PangoLayout`` function you need to convert to and from pixels using ``:func:`~gi.repository.Pango.PIXELS``` or ``PANGO_SCALE``. If the :obj:`~gi.repository.Gtk.Scale.props.draw_value` property is :const:`False`, the return values are undefined. Fields ------ .. rst-class:: interim-class .. class:: Scale :no-index: .. attribute:: parent_instance