class Adw::Toggle

Overview

A toggle within #ToggleGroup.

Adw::Toggle can optionally have a name, set with Toggle::name. If the name is set, [property@ToggleGroup:active-name] can be used to access toggles instead of index.

Defined in:

lib/gi-crystal/src/auto/adw-1/toggle.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class GObject::Object

==(other : self) ==, bind_property(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags) : GObject::Binding bind_property, bind_property_full(source_property : String, target : GObject::Object, target_property : String, flags : GObject::BindingFlags, transform_to : GObject::Closure, transform_from : GObject::Closure) : GObject::Binding bind_property_full, data(key : String) : Pointer(Void) | Nil data, finalize finalize, freeze_notify : Nil freeze_notify, getv(names : Enumerable(String), values : Enumerable(_)) : Nil getv, hash(hasher) hash, notify(property_name : String) : Nil notify, notify_by_pspec(pspec : GObject::ParamSpec) : Nil notify_by_pspec, notify_signal notify_signal, property(property_name : String, value : _) : Nil property, qdata(quark : UInt32) : Pointer(Void) | Nil qdata, ref_count : UInt32 ref_count, run_dispose : Nil run_dispose, set_data(key : String, data : Pointer(Void) | Nil) : Nil set_data, set_property(property_name : String, value : _) : Nil set_property, steal_data(key : String) : Pointer(Void) | Nil steal_data, steal_qdata(quark : UInt32) : Pointer(Void) | Nil steal_qdata, thaw_notify : Nil thaw_notify, to_unsafe : Pointer(Void) to_unsafe, watch_closure(closure : GObject::Closure) : Nil watch_closure

Constructor methods inherited from class GObject::Object

cast(obj : GObject::Object) : self cast, new(pointer : Pointer(Void), transfer : GICrystal::Transfer)
new new, newv(object_type : UInt64, parameters : Enumerable(GObject::Parameter)) : self newv

Class methods inherited from class GObject::Object

cast?(obj : GObject::Object) : self | Nil cast?, compat_control(what : UInt64, data : Pointer(Void) | Nil) : UInt64 compat_control, g_type : UInt64 g_type, interface_find_property(g_iface : GObject::TypeInterface, property_name : String) : GObject::ParamSpec interface_find_property, interface_list_properties(g_iface : GObject::TypeInterface) : Enumerable(GObject::ParamSpec) interface_list_properties

Macros inherited from class GObject::Object

previous_vfunc(*args) previous_vfunc, previous_vfunc!(*args) previous_vfunc!, signal(signature) signal

Constructor Detail

def self.new : self #

Creates a new Adw::Toggle.


def self.new(*, child : Gtk::Widget | Nil = nil, enabled : Bool | Nil = nil, icon_name : String | Nil = nil, label : String | Nil = nil, name : String | Nil = nil, tooltip : String | Nil = nil, use_underline : Bool | Nil = nil) #

Class Method Detail

def self.g_type : UInt64 #

Returns the type id (GType) registered in GLib type system.


Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def child : Gtk::Widget | Nil #

Gets the child widget of self.


def child=(child : Gtk::Widget | Nil) : Nil #

Sets the child of self to child.

When the child is set, icon and label are not displayed.

It's recommended to still set the label, as it can still be used by the screen reader.


def enabled : Bool #

Gets whether self is enabled.


def enabled=(enabled : Bool) : Nil #

Sets whether self is enabled.


def enabled? : Bool #

def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def icon_name : String | Nil #

Gets the icon name of self.


def icon_name=(value : String) : String #

def icon_name=(value : Nil) : Nil #

Set #icon_name property to nil.


def icon_name=(icon_name : String | Nil) : Nil #

Sets the icon name of self to icon_name.

The icon will be displayed alone or next to the label, unless Toggle::child is set.


def icon_name? : String | Nil #

Same as #icon_name, but can return nil.


def index : UInt32 #

Gets the index of self within its toggle group.


def label : String | Nil #

Gets the label of self.


def label=(value : String) : String #

def label=(value : Nil) : Nil #

Set #label property to nil.


def label=(label : String | Nil) : Nil #

Sets the label of self to label.

The label will be displayed alone or next to the icon, unless Toggle::child is set, but will still be read out by the screen reader.


def label? : String | Nil #

Same as #label, but can return nil.


def name : String #

Gets the name of self.


def name=(value : String) : String #

def name=(value : Nil) : Nil #

Set #name property to nil.


def name=(name : String | Nil) : Nil #

Sets the name of self to name.

Allows accessing self by its name instead of index.

See [property@ToggleGroup:active-name].


def name? : String | Nil #

Same as #name, but can return nil.


def tooltip : String #

Gets the tooltip of self.


def tooltip=(tooltip : String) : Nil #

Sets the tooltip of self to tooltip. tooltip can be marked up with the Pango text markup language.


def tooltip=(value : Nil) : Nil #

Set #tooltip property to nil.


def tooltip? : String | Nil #

Same as #tooltip, but can return nil.


def use_underline : Bool #

Gets whether self uses underlines.


def use_underline=(use_underline : Bool) : Nil #

Sets whether an embedded underline in the label indicates a mnemonic.

See Toggle::label.


def use_underline? : Bool #