BuilderListItemFactoryProtocol

public protocol BuilderListItemFactoryProtocol : ListItemFactoryProtocol

GtkBuilderListItemFactory is a GtkListItemFactory that creates widgets by instantiating GtkBuilder UI templates.

The templates must be extending GtkListItem, and typically use GtkExpressions to obtain data from the items in the model.

Example:

  <interface>
    <template class="GtkListItem">
      <property name="child">
        <object class="GtkLabel">
          <property name="xalign">0</property>
          <binding name="label">
            <lookup name="name" type="SettingsKey">
              <lookup name="item">GtkListItem</lookup>
            </lookup>
          </binding>
        </object>
      </property>
    </template>
  </interface>

The BuilderListItemFactoryProtocol protocol exposes the methods and properties of an underlying GtkBuilderListItemFactory instance. The default implementation of these can be found in the protocol extension below. For a concrete class that implements these methods and properties, see BuilderListItemFactory. Alternatively, use BuilderListItemFactoryRef as a lighweight, unowned reference if you already have an instance you just want to use.

  • ptr

    Untyped pointer to the underlying GtkBuilderListItemFactory instance.

    Declaration

    Swift

    var ptr: UnsafeMutableRawPointer! { get }
  • builder_list_item_factory_ptr Default implementation

    Typed pointer to the underlying GtkBuilderListItemFactory instance.

    Default Implementation

    Return the stored, untyped pointer as a typed pointer to the GtkBuilderListItemFactory instance.

    Declaration

    Swift

    var builder_list_item_factory_ptr: UnsafeMutablePointer<GtkBuilderListItemFactory>! { get }
  • Required Initialiser for types conforming to BuilderListItemFactoryProtocol

    Declaration

    Swift

    init(raw: UnsafeMutableRawPointer)

BuilderListItemFactory Class

  • Bind a BuilderListItemFactoryPropertyName source property to a given target object.

    Declaration

    Swift

    @discardableResult
    @inlinable
    func bind<Q, T>(property source_property: BuilderListItemFactoryPropertyName, to target: T, _ target_property: Q, flags f: BindingFlags = .default, transformFrom transform_from: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }, transformTo transform_to: @escaping GLibObject.ValueTransformer = { $0.transform(destValue: $1) }) -> BindingRef! where Q : PropertyNameProtocol, T : ObjectProtocol

    Parameters

    source_property

    the source property to bind

    target

    the target object to bind to

    target_property

    the target property to bind to

    flags

    the flags to pass to the Binding

    transform_from

    ValueTransformer to use for forward transformation

    transform_to

    ValueTransformer to use for backwards transformation

    Return Value

    binding reference or nil in case of an error

  • get(property:) Extension method

    Get the value of a BuilderListItemFactory property

    Declaration

    Swift

    @inlinable
    func get(property: BuilderListItemFactoryPropertyName) -> GLibObject.Value

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

  • set(property:value:) Extension method

    Set the value of a BuilderListItemFactory property. Note that this will only have an effect on properties that are writable and not construct-only!

    Declaration

    Swift

    @inlinable
    func set(property: BuilderListItemFactoryPropertyName, value v: GLibObject.Value)

    Parameters

    property

    the property to get the value for

    Return Value

    the value of the named property

BuilderListItemFactory Class: BuilderListItemFactoryProtocol extension (methods and fields)

  • getBytes() Extension method

    Gets the data used as the GtkBuilder UI template for constructing listitems.

    Declaration

    Swift

    @inlinable
    func getBytes() -> GLib.BytesRef!
  • getResource() Extension method

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

    Declaration

    Swift

    @inlinable
    func getResource() -> String!
  • getScope() Extension method

    Gets the scope used when constructing listitems.

    Declaration

    Swift

    @inlinable
    func getScope() -> BuilderScopeRef!
  • bytes Extension method

    GBytes containing the UI definition.

    Declaration

    Swift

    @inlinable
    var bytes: GLib.BytesRef! { get }
  • resource Extension method

    Path of the resource containing the UI definition.

    Declaration

    Swift

    @inlinable
    var resource: String! { get }
  • scope Extension method

    GtkBuilderScope to use when instantiating listitems

    Declaration

    Swift

    @inlinable
    var scope: BuilderScopeRef! { get }