ScaleProtocol

public protocol ScaleProtocol : RangeProtocol

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, GtkRange, in addition to the methods for GtkScale itself. To set the value of a scale, you would normally use gtk_range_set_value(). To detect changes to the value, you would normally use the GtkRange::value-changed signal.

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

(plain Language Example):

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

GtkScale 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_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 gtk_range_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 GtkScale:draw-value), there is subnode with name value.

The ScaleProtocol protocol exposes the methods and properties of an underlying GtkScale instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see Scale. Alternatively, use ScaleRef as a lighweight, unowned reference if you already have an instance you just want to use.

Show on GitHub

ptr
Untyped pointer to the underlying GtkScale instance.
Declaration
Swift

var ptr: UnsafeMutableRawPointer! { get }
Show on GitHub
scale_ptr Default implementation
Typed pointer to the underlying GtkScale instance.

Default Implementation

Return the stored, untyped pointer as a typed pointer to the GtkScale instance.
Declaration
Swift

var scale_ptr: UnsafeMutablePointer<GtkScale>! { get }
Show on GitHub
init(raw:)
Required Initialiser for types conforming to ScaleProtocol
Declaration
Swift

init(raw: UnsafeMutableRawPointer)
Show on GitHub

Scale Class


                    
                    
                    bind(property:to:_:flags:transformFrom:transformTo:)

Extension method

Bind a ScalePropertyName source property to a given target object.

Declaration

Swift

@discardableResult
@inlinable
func bind<Q, T>(property source_property: ScalePropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

Parameters

`source_property`	the source property to bind
`target`	the target object to bind to
`target_property`	the target property to bind to
`flags`	the flags to pass to the `Binding`
`transform_from`	`ValueTransformer` to use for forward transformation
`transform_to`	`ValueTransformer` to use for backwards transformation

Return Value

binding reference or nil in case of an error

Show on GitHub


                    
                    
                    get(property:)

Extension method

Get the value of a Scale property

Declaration

Swift

@inlinable
func get(property: ScalePropertyName) -> GLibObject.Value

Parameters


                                property

the property to get the value for

Return Value

the value of the named property

Show on GitHub


                    
                    
                    set(property:value:)

Extension method

Set the value of a Scale property. Note that this will only have an effect on properties that are writable and not construct-only!

Declaration

Swift

@inlinable
func set(property: ScalePropertyName, value v: GLibObject.Value)

Parameters


                                property

the property to get the value for

Return Value

the value of the named property

Show on GitHub

Scale signals


                    
                    
                    connect(signal:flags:handler:)

Extension method

Connect a Swift signal handler to the given, typed ScaleSignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: ScaleSignalName, flags f: ConnectFlags = ConnectFlags(0), handler h: @escaping SignalHandler) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`handler`	The Swift signal handler (function or callback) to invoke on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    connect(signal:flags:data:destroyData:signalHandler:)

Extension method

Connect a C signal handler to the given, typed ScaleSignalName signal

Declaration

Swift

@discardableResult
@inlinable
func connect(signal s: ScaleSignalName, flags f: ConnectFlags = ConnectFlags(0), data userData: gpointer!, destroyData destructor: GClosureNotify? = nil, signalHandler h: @escaping GCallback) -> Int

Parameters

`signal`	The signal to connect
`flags`	The connection flags to use
`data`	A pointer to user data to provide to the callback
`destroyData`	A `GClosureNotify` C function to destroy the data pointed to by `userData`
`signalHandler`	The C function to be called on the given signal

Return Value

The signal handler ID (always greater than 0 for successful connections)

Show on GitHub


                    
                    
                    onFormatValue(flags:handler:)

Extension method

Signal which allows you to change how the scale value is displayed. Connect a signal handler which returns an allocated string representing value. That string will then be used to display the scale’s value.

If no user-provided handlers are installed, the value will be displayed on its own, rounded according to the value of the GtkScale:digits property.

Here’s an example signal handler which displays a value 1.0 as with “–>1.0<–”. (C Language Example):

static gchar*
format_value_callback (GtkScale *scale,
                       gdouble   value)
{
  return g_strdup_printf ("-->\%0.*g<--",
                          gtk_scale_get_digits (scale), value);
 }

Note

This represents the underlying format-value signal

Declaration

Swift

@discardableResult
@inlinable
func onFormatValue(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ScaleRef, _ value: Double) -> String) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`value`	the value to format
`handler`	allocated string representing `value` Run the given callback whenever the `formatValue` signal is emitted

Show on GitHub

formatValueSignal Extension method
Typed format-value signal for using the connect(signal:) methods
Declaration
Swift

static var formatValueSignal: ScaleSignalName { get }
Show on GitHub


                    
                    
                    onNotifyDigits(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

Note that getting this signal doesn’t itself guarantee that the value of the property has actually changed. When it is emitted is determined by the derived GObject class. If the implementor did not create the property with G_PARAM_EXPLICIT_NOTIFY, then any call to g_object_set_property() results in notify being emitted, even if the new value is the same as the old. If they did pass G_PARAM_EXPLICIT_NOTIFY, then this signal is emitted only when they explicitly call g_object_notify() or g_object_notify_by_pspec(), and common practice is to do that only when the value has actually changed.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

(C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::digits signal

Declaration

Swift

@discardableResult
@inlinable
func onNotifyDigits(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ScaleRef, _ pspec: ParamSpecRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyDigits` signal is emitted

Show on GitHub

notifyDigitsSignal Extension method
Typed notify::digits signal for using the connect(signal:) methods
Declaration
Swift

static var notifyDigitsSignal: ScaleSignalName { get }
Show on GitHub


                    
                    
                    onNotifyDrawValue(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

(C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::draw-value signal

Declaration

Swift

@discardableResult
@inlinable
func onNotifyDrawValue(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ScaleRef, _ pspec: ParamSpecRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyDrawValue` signal is emitted

Show on GitHub

notifyDrawValueSignal Extension method
Typed notify::draw-value signal for using the connect(signal:) methods
Declaration
Swift

static var notifyDrawValueSignal: ScaleSignalName { get }
Show on GitHub


                    
                    
                    onNotifyHasOrigin(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

(C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::has-origin signal

Declaration

Swift

@discardableResult
@inlinable
func onNotifyHasOrigin(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ScaleRef, _ pspec: ParamSpecRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyHasOrigin` signal is emitted

Show on GitHub

notifyHasOriginSignal Extension method
Typed notify::has-origin signal for using the connect(signal:) methods
Declaration
Swift

static var notifyHasOriginSignal: ScaleSignalName { get }
Show on GitHub


                    
                    
                    onNotifyValuePos(flags:handler:)

Extension method

The notify signal is emitted on an object when one of its properties has its value set through g_object_set_property(), g_object_set(), et al.

This signal is typically used to obtain change notification for a single property, by specifying the property name as a detail in the g_signal_connect() call, like this:

(C Language Example):

g_signal_connect (text_view->buffer, "notify::paste-target-list",
                  G_CALLBACK (gtk_text_view_target_list_notify),
                  text_view)

It is important to note that you must use canonical parameter names as detail strings for the notify signal.

Note

This represents the underlying notify::value-pos signal

Declaration

Swift

@discardableResult
@inlinable
func onNotifyValuePos(flags: ConnectFlags = ConnectFlags(0), handler: @escaping (_ unownedSelf: ScaleRef, _ pspec: ParamSpecRef) -> Void) -> Int

Parameters

`flags`	Flags
`unownedSelf`	Reference to instance of self
`pspec`	the `GParamSpec` of the property which changed.
`handler`	The signal handler to call Run the given callback whenever the `notifyValuePos` signal is emitted

Show on GitHub

notifyValuePosSignal Extension method
Typed notify::value-pos signal for using the connect(signal:) methods
Declaration
Swift

static var notifyValuePosSignal: ScaleSignalName { get }
Show on GitHub

Scale Class: ScaleProtocol extension (methods and fields)

addMark(value:position:markup:) Extension method
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 nil, text is shown next to the tick mark.

To remove marks from a scale, use gtk_scale_clear_marks().
Declaration
Swift

@inlinable func addMark(value: Double, position: GtkPositionType, markup: UnsafePointer<gchar>? = nil)
Show on GitHub
clearMarks() Extension method
Removes any marks that have been added with gtk_scale_add_mark().
Declaration
Swift

@inlinable func clearMarks()
Show on GitHub
getDigits() Extension method
Gets the number of decimal places that are displayed in the value.
Declaration
Swift

@inlinable func getDigits() -> Int
Show on GitHub
getDrawValue() Extension method
Returns whether the current value is displayed as a string next to the slider.
Declaration
Swift

@inlinable func getDrawValue() -> Bool
Show on GitHub
getHasOrigin() Extension method
Returns whether the scale has an origin.
Declaration
Swift

@inlinable func getHasOrigin() -> Bool
Show on GitHub
getLayout() Extension method
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.
Declaration
Swift

@inlinable func getLayout() -> Pango.LayoutRef!
Show on GitHub
getLayoutOffsets(x:y:) Extension method
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 PANGO_PIXELS() or PANGO_SCALE.

If the GtkScale:draw-value property is false, the return values are undefined.
Declaration
Swift

@inlinable func getLayoutOffsets(x: UnsafeMutablePointer<gint>! = nil, y: UnsafeMutablePointer<gint>! = nil)
Show on GitHub
getValuePos() Extension method
Gets the position in which the current value is displayed.
Declaration
Swift

@inlinable func getValuePos() -> GtkPositionType
Show on GitHub
set(digits:) Extension method
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 GtkScale:draw-value is true when the value changes. If you want to enforce rounding the value when GtkScale:draw-value is false, you can set GtkRange: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 the GtkScale::format-value signal to format the displayed value yourself.
Declaration
Swift

@inlinable func set(digits: Int)
Show on GitHub
set(drawValue:) Extension method
Specifies whether the current value is displayed as a string next to the slider.
Declaration
Swift

@inlinable func set(drawValue: Bool)
Show on GitHub
set(hasOrigin:) Extension method
If GtkScale: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.
Declaration
Swift

@inlinable func set(hasOrigin: Bool)
Show on GitHub
setValue(pos:) Extension method
Sets the position in which the current value is displayed.
Declaration
Swift

@inlinable func setValue(pos: GtkPositionType)
Show on GitHub
digits Extension method
Undocumented
Declaration
Swift

@inlinable var digits: Int { get nonmutating set }
Show on GitHub
drawValue Extension method
Returns whether the current value is displayed as a string next to the slider.
Declaration
Swift

@inlinable var drawValue: Bool { get nonmutating set }
Show on GitHub
hasOrigin Extension method
Returns whether the scale has an origin.
Declaration
Swift

@inlinable var hasOrigin: Bool { get nonmutating set }
Show on GitHub
layout Extension method
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.
Declaration
Swift

@inlinable var layout: Pango.LayoutRef! { get }
Show on GitHub
valuePos Extension method
Gets the position in which the current value is displayed.
Declaration
Swift

@inlinable var valuePos: GtkPositionType { get nonmutating set }
Show on GitHub
range Extension method
Undocumented
Declaration
Swift

@inlinable var range: GtkRange { get }
Show on GitHub

ScaleProtocol

GtkScale as GtkBuildable

CSS nodes

Declaration

Default Implementation

Declaration

Declaration

Scale Class

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Scale signals

Declaration

Parameters

Return Value

Declaration

Parameters

Return Value

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Declaration

Parameters

Declaration

Scale Class: ScaleProtocol extension (methods and fields)

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration

Declaration