class Gtk::BuilderListItemFactory

Overview

Gtk::BuilderListItemFactory is a Gtk::ListItemFactory that creates widgets by instantiating Gtk::Builder UI templates.

The templates must be extending Gtk::ListItem, and typically use Gtk::Expressions to obtain data from the items in the model.

Example:

WARNING ⚠️ The following code is in xml ⚠️

  <interface>
    <template class="Gtk::ListItem">
      <property name="child">
        <object class="Gtk::Label">
          <property name="xalign">0</property>
          <binding name="label">
            <lookup name="name" type="SettingsKey">
              <lookup name="item">Gtk::ListItem</lookup>
            </lookup>
          </binding>
        </object>
      </property>
    </template>
  </interface>

Defined in:

lib/gi-crystal/src/auto/gtk-4.0/builder_list_item_factory.cr

Constructors

Class Method Summary

Instance Method Summary

Instance methods inherited from class Gtk::ListItemFactory

==(other : self) ==, hash(hasher) hash

Constructor methods inherited from class Gtk::ListItemFactory

new new

Class methods inherited from class Gtk::ListItemFactory

g_type : UInt64 g_type

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 #

Initialize a new BuilderListItemFactory.


[View source]
def self.new(*, bytes : GLib::Bytes | Nil = nil, resource : String | Nil = nil, scope : Gtk::BuilderScope | Nil = nil) #

[View source]
def self.new_from_bytes(scope : Gtk::BuilderScope | Nil, bytes : GLib::Bytes) : self #

Creates a new Gtk::BuilderListItemFactory that instantiates widgets using bytes as the data to pass to Gtk::Builder.


[View source]
def self.new_from_resource(scope : Gtk::BuilderScope | Nil, resource_path : String) : self #

Creates a new Gtk::BuilderListItemFactory that instantiates widgets using data read from the given resource_path to pass to Gtk::Builder.


[View source]

Class Method Detail

def self.g_type : UInt64 #

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


[View source]

Instance Method Detail

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

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


def bytes : GLib::Bytes #

Gets the data used as the Gtk::Builder UI template for constructing listitems.


[View source]
def bytes=(value : GLib::Bytes | Nil) : GLib::Bytes | Nil #

[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def resource : String | Nil #

If the data references a resource, gets the path of that resource.


[View source]
def resource=(value : String) : String #

[View source]
def resource=(value : Nil) : Nil #

Set #resource property to nil.


[View source]
def resource? : String | Nil #

Same as #resource, but can return nil.


[View source]
def scope : Gtk::BuilderScope | Nil #

Gets the scope used when constructing listitems.


[View source]
def scope=(value : Gtk::BuilderScope | Nil) : Gtk::BuilderScope | Nil #

[View source]