Struct SpinRow 

pub struct SpinRow { /* private fields */ }

Available on crate feature v1_4 only.

An ActionRow with an embedded spin button.

Example of an SpinRow UI definition:

<object class="AdwSpinRow">
  <property name="title" translatable="yes">Spin Row</property>
  <property name="adjustment">
    <object class="GtkAdjustment">
      <property name="lower">0</property>
      <property name="upper">100</property>
      <property name="value">50</property>
      <property name="page-increment">10</property>
      <property name="step-increment">1</property>
    </object>
  </property>
</object>

See Gtk::SpinButton for details.

CSS nodes

SpinRow has the same structure as ActionRow, as well as the .spin style class on the main node.

Accessibility

SpinRow uses an internal GtkSpinButton with the GTK_ACCESSIBLE_ROLE_SPIN_BUTTON role.

Properties

adjustment

The adjustment that holds the value of the spin row.

Readable | Writeable

climb-rate

The acceleration rate when you hold down a button or key.

Readable | Writeable

digits

The number of decimal places to display.

Readable | Writeable

numeric

Whether non-numeric characters should be ignored.

Readable | Writeable

snap-to-ticks

Whether invalid values are snapped to the nearest step increment.

Readable | Writeable

update-policy

The policy for updating the spin row.

The options are always, or only when the value is invalid.

Readable | Writeable

value

The current value.

Readable | Writeable

wrap

Whether the spin row should wrap upon reaching its limits.

Readable | Writeable

ActionRow

activatable-widget

The widget to activate when the row is activated.

The row can be activated either by clicking on it, calling ActionRowExt::activate(), or via mnemonics in the title. See the use-underline property to enable mnemonics.

The target widget will be activated by emitting the mnemonic-activate signal on it.

Readable | Writeable

icon-name

The icon name for this row.

Readable | Writeable

subtitle

The subtitle for this row.

The subtitle is interpreted as Pango markup unless use-markup is set to FALSE.

Readable | Writeable

subtitle-lines

The number of lines at the end of which the subtitle label will be ellipsized.

If the value is 0, the number of lines won’t be limited.

Readable | Writeable

subtitle-selectable

Whether the user can copy the subtitle from the label.

See also [selectable][struct@crate::Gtk::Label#selectable].

Readable | Writeable

title-lines

The number of lines at the end of which the title label will be ellipsized.

If the value is 0, the number of lines won’t be limited.

Readable | Writeable

PreferencesRow

title

The title of the preference represented by this row.

The title is interpreted as Pango markup unless use-markup is set to FALSE.

Readable | Writeable

title-selectable

Whether the user can copy the title from the label.

See also [selectable][struct@crate::Gtk::Label#selectable].

Readable | Writeable

use-markup

Whether to use Pango markup for the title label.

Subclasses may also use it for other labels, such as subtitle.

See also parse_markup().

Readable | Writeable

use-underline

Whether an embedded underline in the title indicates a mnemonic.

Readable | Writeable

ListBoxRow

activatable

Determines whether the ::row-activated signal will be emitted for this row.

Readable | Writeable

child

The child widget.

Readable | Writeable

selectable

Determines whether this row can be selected.

Readable | Writeable

Widget

can-focus

Whether the widget or any of its descendents can accept the input focus.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

can-target

Whether the widget can receive pointer events.

Readable | Writeable

css-classes

A list of css classes applied to this widget.

Readable | Writeable

css-name

The name of this widget in the CSS tree.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable | Construct Only

cursor

The cursor used by @widget.

Readable | Writeable

focus-on-click

Whether the widget should grab focus when it is clicked with the mouse.

This property is only relevant for widgets that can take focus.

Readable | Writeable

focusable

Whether this widget itself will accept the input focus.

Readable | Writeable

halign

How to distribute horizontal space if widget gets extra space.

Readable | Writeable

has-default

Whether the widget is the default widget.

Readable

has-focus

Whether the widget has the input focus.

Readable

has-tooltip

Enables or disables the emission of the query-tooltip signal on @widget.

A true value indicates that @widget can have a tooltip, in this case the widget will be queried using query-tooltip to determine whether it will provide a tooltip or not.

Readable | Writeable

height-request

Overrides for height request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

hexpand

Whether to expand horizontally.

Readable | Writeable

hexpand-set

Whether to use the hexpand property.

Readable | Writeable

layout-manager

The gtk::LayoutManager instance to use to compute the preferred size of the widget, and allocate its children.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

limit-events

Makes this widget act like a modal dialog, with respect to event delivery.

Global event controllers will not handle events with targets inside the widget, unless they are set up to ignore propagation limits. See Gtk::EventController::set_propagation_limit().

Readable | Writeable

margin-bottom

Margin on bottom side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-end

Margin on end of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-start

Margin on start of widget, horizontally.

This property supports left-to-right and right-to-left text directions.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

margin-top

Margin on top side of widget.

This property adds margin outside of the widget’s normal size request, the margin will be added in addition to the size from [WidgetExtManual::set_size_request()][crate::gtk::prelude::WidgetExtManual::set_size_request()] for example.

Readable | Writeable

name

The name of the widget.

Readable | Writeable

opacity

The requested opacity of the widget.

Readable | Writeable

overflow

How content outside the widget’s content area is treated.

This property is meant to be set by widget implementations, typically in their instance init function.

Readable | Writeable

parent

The parent widget of this widget.

Readable

receives-default

Whether the widget will receive the default action when it is focused.

Readable | Writeable

root

The gtk::Root widget of the widget tree containing this widget.

This will be NULL if the widget is not contained in a root widget.

Readable

scale-factor

The scale factor of the widget.

Readable

sensitive

Whether the widget responds to input.

Readable | Writeable

tooltip-markup

Sets the text of tooltip to be the given string, which is marked up with Pango markup.

Also see Gtk::Tooltip::set_markup().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

tooltip-text

Sets the text of tooltip to be the given string.

Also see Gtk::Tooltip::set_text().

This is a convenience property which will take care of getting the tooltip shown if the given string is not NULL: has-tooltip will automatically be set to true and there will be taken care of query-tooltip in the default signal handler.

Note that if both tooltip-text and tooltip-markup are set, the last one wins.

Readable | Writeable

valign

How to distribute vertical space if widget gets extra space.

Readable | Writeable

vexpand

Whether to expand vertically.

Readable | Writeable

vexpand-set

Whether to use the vexpand property.

Readable | Writeable

visible

Whether the widget is visible.

Readable | Writeable

width-request

Overrides for width request of the widget.

If this is -1, the natural request will be used.

Readable | Writeable

Accessible

accessible-role

The accessible role of the given gtk::Accessible implementation.

The accessible role cannot be changed once set.

Readable | Writeable

Actionable

action-name

The name of the action with which this widget should be associated.

Readable | Writeable

action-target

The target value of the actionable widget’s action.

Readable | Writeable

Editable

cursor-position

The current position of the insertion cursor in chars.

Readable

editable

Whether the entry contents can be edited.

Readable | Writeable

enable-undo

If undo/redo should be enabled for the editable.

Readable | Writeable

max-width-chars

The desired maximum width of the entry, in characters.

Readable | Writeable

selection-bound

The position of the opposite end of the selection from the cursor in chars.

Readable

text

The contents of the entry.

Readable | Writeable

width-chars

Number of characters to leave space for in the entry.

Readable | Writeable

xalign

The horizontal alignment, from 0 (left) to 1 (right).

Reversed for RTL layouts.

Readable | Writeable

Signals

input

Emitted to convert the user’s input into a double value.

The signal handler is expected to use [EditableExtManual::text()][crate::gtk::prelude::EditableExtManual::text()] to retrieve the text of the spinbutton and set new_value to the new value.

The default conversion uses strtod().

See [input][struct@crate::Gtk::SpinButton#input].

output

Emitted to tweak the formatting of the value for display.

See [output][struct@crate::Gtk::SpinButton#output].

wrapped

Emitted right after the spinbutton wraps.

See [wrapped][struct@crate::Gtk::SpinButton#wrapped].

ActionRow

activated

This signal is emitted after the row has been activated.

ListBoxRow

activate

This is a keybinding signal, which will cause this row to be activated.

If you want to be notified when the user activates a row (by key or not), use the [row-activated][struct@crate::Gtk::ListBox#row-activated] signal on the row’s parent GtkListBox.

Action

Widget

destroy

Signals that all holders of a reference to the widget should release the reference that they hold.

May result in finalization of the widget if all references are released.

This signal is not suitable for saving widget state.

direction-changed

Emitted when the text direction of a widget changes.

hide

Emitted when @widget is hidden.

keynav-failed

Emitted if keyboard navigation fails.

See [WidgetExtManual::keynav_failed()][crate::gtk::prelude::WidgetExtManual::keynav_failed()] for details.

map

Emitted when @widget is going to be mapped.

A widget is mapped when the widget is visible (which is controlled with visible) and all its parents up to the toplevel widget are also visible.

The ::map signal can be used to determine whether a widget will be drawn, for instance it can resume an animation that was stopped during the emission of unmap.

mnemonic-activate

Emitted when a widget is activated via a mnemonic.

The default handler for this signal activates @widget if @group_cycling is false, or just makes @widget grab focus if @group_cycling is true.

move-focus

Emitted when the focus is moved.

The ::move-focus signal is a keybinding signal.

The default bindings for this signal are Tab to move forward, and Shift+Tab to move backward.

Action

query-tooltip

Emitted when the widget’s tooltip is about to be shown.

This happens when the has-tooltip property is true and the hover timeout has expired with the cursor hovering above @widget; or emitted when @widget got focus in keyboard mode.

Using the given coordinates, the signal handler should determine whether a tooltip should be shown for @widget. If this is the case true should be returned, false otherwise. Note that if @keyboard_mode is true, the values of @x and @y are undefined and should not be used.

The signal handler is free to manipulate @tooltip with the therefore destined function calls.

realize

Emitted when @widget is associated with a GdkSurface.

This means that [WidgetExtManual::realize()][crate::gtk::prelude::WidgetExtManual::realize()] has been called or the widget has been mapped (that is, it is going to be drawn).

show

Emitted when @widget is shown.

state-flags-changed

Emitted when the widget state changes.

See [WidgetExtManual::state_flags()][crate::gtk::prelude::WidgetExtManual::state_flags()].

unmap

Emitted when @widget is going to be unmapped.

A widget is unmapped when either it or any of its parents up to the toplevel widget have been set as hidden.

As ::unmap indicates that a widget will not be shown any longer, it can be used to, for example, stop an animation on the widget.

unrealize

Emitted when the GdkSurface associated with @widget is destroyed.

This means that [WidgetExtManual::unrealize()][crate::gtk::prelude::WidgetExtManual::unrealize()] has been called or the widget has been unmapped (that is, it is going to be hidden).

Editable

changed

Emitted at the end of a single user-visible operation on the contents.

E.g., a paste operation that replaces the contents of the selection will cause only one signal emission (even though it is implemented by first deleting the selection, then inserting the new content, and may cause multiple ::notify::text signals to be emitted).

delete-text

Emitted when text is deleted from the widget by the user.

The default handler for this signal will normally be responsible for deleting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the range of deleted text, or prevent it from being deleted entirely.

The @start_pos and @end_pos parameters are interpreted as for [EditableExtManual::delete_text()][crate::gtk::prelude::EditableExtManual::delete_text()].

insert-text

Emitted when text is inserted into the widget by the user.

The default handler for this signal will normally be responsible for inserting the text, so by connecting to this signal and then stopping the signal with g_signal_stop_emission(), it is possible to modify the inserted text, or prevent it from being inserted entirely.

Implements

ActionRowExt, PreferencesRowExt, gtk::prelude::ListBoxRowExt, gtk::prelude::WidgetExt, [trait@glib::ObjectExt], gtk::prelude::AccessibleExt, gtk::prelude::BuildableExt, gtk::prelude::ConstraintTargetExt, gtk::prelude::ActionableExt, gtk::prelude::EditableExt

GLib type: GObject with reference counted clone semantics.

Implementations

impl SpinRow

pub fn new( adjustment: Option<&impl IsA<Adjustment>>, climb_rate: f64, digits: u32, ) -> SpinRow

Creates a new SpinRow.

adjustment

the adjustment that this spin row should use

climb_rate

the rate the value changes when holding a button or key

digits

the number of decimal places to display

Returns

the newly created SpinRow

pub fn with_range(min: f64, max: f64, step: f64) -> SpinRow

Creates a new SpinRow with the given properties.

This is a convenience constructor that allows creation of a numeric SpinRow without manually creating an adjustment. The value is initially set to the minimum value and a page increment of 10 * @step is the default. The precision of the spin row is equivalent to the precisions of @step.

::: note 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 set_digits() to correct it.

min

minimum allowable value

max

maximum allowable value

step

increment added or subtracted by spinning the widget

Returns

the new SpinRow

pub fn builder() -> SpinRowBuilder

Creates a new builder-pattern struct instance to construct SpinRow objects.

This method returns an instance of SpinRowBuilder which can be used to create SpinRow objects.

pub fn configure( &self, adjustment: Option<&impl IsA<Adjustment>>, climb_rate: f64, digits: u32, )

Changes the properties of an existing spin row.

The adjustment, climb rate, and number of decimal places are updated accordingly.

adjustment

the adjustment that this spin row should use

climb_rate

the new climb rate

digits

the number of decimal places to display

pub fn adjustment(&self) -> Adjustment

Gets the adjustment that holds the value for the spin row.

Returns

the adjustment that holds the spin row’s value

pub fn climb_rate(&self) -> f64

Gets the acceleration rate when you hold down a button or key.

Returns

the acceleration rate when you hold down a button or key

pub fn digits(&self) -> u32

Gets the number of decimal places to display.

Returns

the number of decimal places to display

pub fn is_numeric(&self) -> bool

Gets whether non-numeric characters should be ignored.

Returns

whether non-numeric characters should be ignored.

pub fn snaps_to_ticks(&self) -> bool

Gets whether invalid values are snapped to nearest step increment.

Returns

whether invalid values are snapped to the nearest step increment

pub fn update_policy(&self) -> SpinButtonUpdatePolicy

Gets the policy for updating the spin row.

Returns

the policy for updating the spin row

pub fn value(&self) -> f64

Gets the current value.

Returns

the current value

pub fn wraps(&self) -> bool

Gets whether the spin row should wrap upon reaching its limits.

Returns

whether the spin row should wrap upon reaching its limits

pub fn set_adjustment(&self, adjustment: Option<&impl IsA<Adjustment>>)

Sets the adjustment that holds the value for the spin row.

adjustment

an adjustment

pub fn set_climb_rate(&self, climb_rate: f64)

Sets the acceleration rate when you hold down a button or key.

climb_rate

the acceleration rate when you hold down a button or key

pub fn set_digits(&self, digits: u32)

Sets the number of decimal places to display.

digits

the number of decimal places to display

pub fn set_numeric(&self, numeric: bool)

Sets whether non-numeric characters should be ignored.

numeric

whether non-numeric characters should be ignored

pub fn set_range(&self, min: f64, max: f64)

Sets the minimum and maximum allowable values for @self.

If the current value is outside this range, it will be adjusted to fit within the range, otherwise it will remain unchanged.

min

minimum allowable value

max

maximum allowable value

pub fn set_snap_to_ticks(&self, snap_to_ticks: bool)

Sets whether invalid values are snapped to the nearest step increment.

snap_to_ticks

whether invalid values are snapped to the nearest step increment

pub fn set_update_policy(&self, policy: SpinButtonUpdatePolicy)

Sets the policy for updating the spin row.

The options are always, or only when the value is invalid.

policy

the policy for updating the spin row

pub fn set_value(&self, value: f64)

Sets the current value.

value

a new value

pub fn set_wrap(&self, wrap: bool)

Sets whether the spin row should wrap upon reaching its limits.

wrap

whether the spin row should wrap upon reaching its limits

pub fn update(&self)

Manually force an update of the spin row.

pub fn connect_output<F: Fn(&Self) -> bool + 'static>( &self, f: F, ) -> SignalHandlerId

Emitted to tweak the formatting of the value for display.

See [output][struct@crate::Gtk::SpinButton#output].

Returns

TRUE if the value has been displayed

pub fn connect_wrapped<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId

Emitted right after the spinbutton wraps.

See [wrapped][struct@crate::Gtk::SpinButton#wrapped].

pub fn connect_adjustment_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_climb_rate_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_digits_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_numeric_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_snap_to_ticks_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_update_policy_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_value_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

pub fn connect_wrap_notify<F: Fn(&Self) + 'static>( &self, f: F, ) -> SignalHandlerId

impl SpinRow

pub fn connect_input<F>(&self, f: F) -> SignalHandlerId

where F: Fn(&Self) -> Option<Result<f64, ()>> + 'static,

Emitted to convert the user’s input into a double value.

The signal handler is expected to use [EditableExtManual::text()][crate::gtk::prelude::EditableExtManual::text()] to retrieve the text of the spinbutton and set new_value to the new value.

The default conversion uses strtod().

See [input][struct@crate::Gtk::SpinButton#input].

Returns

TRUE for a successful conversion, FALSE if the input was not handled, and GTK_INPUT_ERROR if the conversion failed.

new_value

return location for the new value

Trait Implementations

impl Clone for SpinRow

fn clone(&self) -> Self

Makes a clone of this shared reference.

This increments the strong reference count of the object. Dropping the object will decrement it again.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpinRow

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SpinRow

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SpinRow

type ParamSpec = ParamSpecObject

type SetValue = SpinRow

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(&str) -> ParamSpecObjectBuilder<'_, SpinRow>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SpinRow

fn hash<H>(&self, state: &mut H)

where H: Hasher,

Hashes the memory address of this object.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<T: SpinRowImpl> IsSubclassable<T> for SpinRow

fn class_init(class: &mut Class<Self>)

Override the virtual methods of this class for the given subclass and do other class initialization.

fn instance_init(instance: &mut InitializingObject<T>)

Instance specific initialization.

impl Ord for SpinRow

fn cmp(&self, other: &Self) -> Ordering

Comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl ParentClassIs for SpinRow

type Parent = ActionRow

impl<OT: ObjectType> PartialEq<OT> for SpinRow

fn eq(&self, other: &OT) -> bool

Equality for two GObjects.

Two GObjects are equal if their memory addresses are equal.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<OT: ObjectType> PartialOrd<OT> for SpinRow

fn partial_cmp(&self, other: &OT) -> Option<Ordering>

Partial comparison for two GObjects.

Compares the memory addresses of the provided objects.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for SpinRow

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SpinRow

impl IsA<Accessible> for SpinRow

impl IsA<ActionRow> for SpinRow

impl IsA<Actionable> for SpinRow

impl IsA<Buildable> for SpinRow

impl IsA<ConstraintTarget> for SpinRow

impl IsA<Editable> for SpinRow

impl IsA<ListBoxRow> for SpinRow

impl IsA<PreferencesRow> for SpinRow

impl IsA<Widget> for SpinRow