class Adw::SpinnerPaintable

Overview

A paintable showing a loading spinner.

spinner

Adw::SpinnerPaintable size varies depending on the available space, but is capped at 64×64 pixels.

To be able to animate, Adw::SpinnerPaintable needs a widget. It will be animated according to that widget's frame clock, and only if that widget is mapped. Ideally it should be the same widget the paintable is displayed in, but that's not a requirement.

Most applications should be using #Spinner instead. Adw::SpinnerPaintable is provided for the cases where using a widget is impractical or impossible, such as StatusPage::paintable:

WARNING ⚠️ The following code is in xml ⚠️

<object class="Adw::StatusPage" id="status_page">
  <property name="paintable">
    <object class="Adw::SpinnerPaintable">
      <property name="widget">status_page</property>
    </object>
  </property>
  <!-- ... -->
</object>

Included Modules

Defined in:

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

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from module Gtk::SymbolicPaintable

snapshot_symbolic(snapshot : Gdk::Snapshot, width : Float64, height : Float64, colors : Enumerable(Gdk::RGBA)) : Nil snapshot_symbolic, to_unsafe to_unsafe

Constructor methods inherited from module Gtk::SymbolicPaintable

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gtk::SymbolicPaintable

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type

Instance methods inherited from module Gdk::Paintable

compute_concrete_size(specified_width : Float64, specified_height : Float64, default_width : Float64, default_height : Float64, concrete_width : Float64, concrete_height : Float64) : Nil compute_concrete_size, current_image : Gdk::Paintable current_image, flags : Gdk::PaintableFlags flags, intrinsic_aspect_ratio : Float64 intrinsic_aspect_ratio, intrinsic_height : Int32 intrinsic_height, intrinsic_width : Int32 intrinsic_width, invalidate_contents : Nil invalidate_contents, invalidate_contents_signal invalidate_contents_signal, invalidate_size : Nil invalidate_size, invalidate_size_signal invalidate_size_signal, snapshot(snapshot : Gdk::Snapshot, width : Float64, height : Float64) : Nil snapshot, to_unsafe to_unsafe

Constructor methods inherited from module Gdk::Paintable

cast(obj : GObject::Object) : self cast

Class methods inherited from module Gdk::Paintable

cast?(obj : GObject::Object) : self | Nil cast?, g_type : UInt64 g_type, new_empty(intrinsic_width : Int32, intrinsic_height : Int32) : Gdk::Paintable new_empty

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(widget : Gtk::Widget | Nil) : self #

Creates a new Adw::SpinnerPaintable for widget.


def self.new #

Initialize a new SpinnerPaintable.


def self.new(*, widget : Gtk::Widget | 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 hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def widget : Gtk::Widget | Nil #

Gets the widget used for frame clock.


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

Sets the widget used for frame clock.