Struct libadwaita::SwitchRow

pub struct SwitchRow { /* private fields */ }

Available on crate feature v1_4 only.

A gtk::ListBoxRow used to represent two states.

The SwitchRow widget contains a Gtk::Switch that allows the user to select between two states: “on” or “off”. When activated, the row will invert its active state.

The user can control the switch by activating the row or by dragging on the switch handle.

See Gtk::Switch for details.

Example of an SwitchRow UI definition:

<object class="AdwSwitchRow">
  <property name="title" translatable="yes">Switch Row</property>
  <signal name="notify::active" handler="switch_row_notify_active_cb"/>
</object>

The active property should be connected to in order to monitor changes to the active state.

Properties

active

Whether the switch row is in the “on” or “off” position.

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 value of true 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

Override 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

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 None 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 None: 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 None: 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

Override 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

Readable | Writeable

action-target

Readable | Writeable

Implements

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

Implementations

impl SwitchRow

pub fn new() -> SwitchRow

Creates a new SwitchRow.

Returns

the newly created SwitchRow

pub fn builder() -> SwitchRowBuilder

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

This method returns an instance of SwitchRowBuilder which can be used to create SwitchRow objects.

pub fn is_active(&self) -> bool

Gets whether @self is in its “on” or “off” position.

Returns

whether @self is active or not

pub fn set_active(&self, is_active: bool)

Sets whether @self is in its “on” or “off” position

is_active

whether @self should be active

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

Trait Implementations

impl Clone for SwitchRow

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SwitchRow

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

Formats the value using the given formatter.

impl Default for SwitchRow

fn default() -> Self

Returns the “default value” for a type.

impl HasParamSpec for SwitchRow

type ParamSpec = ParamSpecObject

type SetValue = SwitchRow

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

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

fn param_spec_builder() -> Self::BuilderFn

impl Hash for SwitchRow

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

where H: Hasher,

Feeds this value into the given Hasher.

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 Ord for SwitchRow

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

This method returns an Ordering between self and other.

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 + PartialOrd,

Restrict a value to a certain interval.

impl ParentClassIs for SwitchRow

type Parent = ActionRow

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

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

This method tests for self and other values to be equal, and is used by ==.

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

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

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

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

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl StaticType for SwitchRow

fn static_type() -> Type

Returns the type identifier of Self.

impl Eq for SwitchRow

impl IsA<Accessible> for SwitchRow

impl IsA<ActionRow> for SwitchRow

impl IsA<Actionable> for SwitchRow

impl IsA<Buildable> for SwitchRow

impl IsA<ConstraintTarget> for SwitchRow

impl IsA<ListBoxRow> for SwitchRow

impl IsA<PreferencesRow> for SwitchRow

impl IsA<Widget> for SwitchRow