<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
<!ENTITY version SYSTEM "version.xml">
<!ENTITY pi "&#960;">
<!ENTITY solidus "&#8260;">
]>
<refentry id="GtkBuilderListItemFactory">
<refmeta>
<refentrytitle role="top_of_page" id="GtkBuilderListItemFactory.top_of_page">GtkBuilderListItemFactory</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkBuilderListItemFactory</refname>
<refpurpose>A listitem factory using ui files</refpurpose>
</refnamediv>

<refsect1 id="GtkBuilderListItemFactory.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_proto_type" colwidth="150px"/>
<colspec colname="functions_proto_name"/>
<tbody>
<row><entry role="function_type"><link linkend="GtkListItemFactory"><returnvalue>GtkListItemFactory</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-builder-list-item-factory-new-from-bytes">gtk_builder_list_item_factory_new_from_bytes</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkListItemFactory"><returnvalue>GtkListItemFactory</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-builder-list-item-factory-new-from-resource">gtk_builder_list_item_factory_new_from_resource</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GBytes"><returnvalue>GBytes</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-builder-list-item-factory-get-bytes">gtk_builder_list_item_factory_get_bytes</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-builder-list-item-factory-get-resource">gtk_builder_list_item_factory_get_resource</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GtkBuilderScope"><returnvalue>GtkBuilderScope</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-builder-list-item-factory-get-scope">gtk_builder_list_item_factory_get_scope</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkBuilderListItemFactory.properties" role="properties">
<title role="properties.title">Properties</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="properties_type" colwidth="150px"/>
<colspec colname="properties_name" colwidth="300px"/>
<colspec colname="properties_flags" colwidth="200px"/>
<tbody>
<row><entry role="property_type"><link linkend="GBytes"><type>GBytes</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkBuilderListItemFactory--bytes">bytes</link></entry><entry role="property_flags">Read / Write / Construct&#160;Only</entry></row>
<row><entry role="property_type"><link linkend="char"><type>char</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkBuilderListItemFactory--resource">resource</link></entry><entry role="property_flags">Read / Write / Construct&#160;Only</entry></row>
<row><entry role="property_type"><link linkend="GtkBuilderScope"><type>GtkBuilderScope</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkBuilderListItemFactory--scope">scope</link></entry><entry role="property_flags">Read / Write / Construct&#160;Only</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkBuilderListItemFactory.other" role="other_proto">
<title role="other_proto.title">Types and Values</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="other_proto_type" colwidth="150px"/>
<colspec colname="other_proto_name"/>
<tbody>
<row><entry role="datatype_keyword"></entry><entry role="function_name"><link linkend="GtkBuilderListItemFactory-struct">GtkBuilderListItemFactory</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkBuilderListItemFactory.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<screen>    <link linkend="GObject">GObject</link>
    <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> <link linkend="GtkListItemFactory">GtkListItemFactory</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> GtkBuilderListItemFactory
</screen>
</refsect1>

<refsect1 id="GtkBuilderListItemFactory.includes"><title>Includes</title><synopsis>#include &lt;gtk/gtk.h&gt;
</synopsis></refsect1>

<refsect1 id="GtkBuilderListItemFactory.description" role="desc">
<title role="desc.title">Description</title>
<para><link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link> is a <link linkend="GtkListItemFactory"><type>GtkListItemFactory</type></link> that creates
widgets by instantiating <link linkend="GtkBuilder"><type>GtkBuilder</type></link> UI templates. The templates
must be extending <link linkend="GtkListItem"><type>GtkListItem</type></link>, and typically use <link linkend="GtkExpressions"><type>GtkExpressions</type></link>
to obtain data from the items in the model.</para>
<para>Example:</para>
<informalexample><programlisting role="example"><![CDATA[
  <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>
]]></programlisting></informalexample>
<para></para>

</refsect1>
<refsect1 id="GtkBuilderListItemFactory.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-builder-list-item-factory-new-from-bytes" role="function">
<title>gtk_builder_list_item_factory_new_from_bytes&#160;()</title>
<indexterm zone="gtk-builder-list-item-factory-new-from-bytes"><primary>gtk_builder_list_item_factory_new_from_bytes</primary></indexterm>
<programlisting language="C"><link linkend="GtkListItemFactory"><returnvalue>GtkListItemFactory</returnvalue></link>&#160;*
gtk_builder_list_item_factory_new_from_bytes
                               (<parameter><link linkend="GtkBuilderScope"><type>GtkBuilderScope</type></link> *scope</parameter>,
                                <parameter><link linkend="GBytes"><type>GBytes</type></link> *bytes</parameter>);</programlisting>
<para>Creates s new <link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link> that instantiates widgets
using <parameter>bytes</parameter>
 as the data to pass to <link linkend="GtkBuilder"><type>GtkBuilder</type></link>.</para>
<refsect3 id="gtk-builder-list-item-factory-new-from-bytes.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>scope</para></entry>
<entry role="parameter_description"><para>A scope to use when instantiating. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>][<acronym>transfer none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>bytes</para></entry>
<entry role="parameter_description"><para>the bytes containing the ui file to instantiate</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-builder-list-item-factory-new-from-bytes.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-builder-list-item-factory-new-from-resource" role="function">
<title>gtk_builder_list_item_factory_new_from_resource&#160;()</title>
<indexterm zone="gtk-builder-list-item-factory-new-from-resource"><primary>gtk_builder_list_item_factory_new_from_resource</primary></indexterm>
<programlisting language="C"><link linkend="GtkListItemFactory"><returnvalue>GtkListItemFactory</returnvalue></link>&#160;*
gtk_builder_list_item_factory_new_from_resource
                               (<parameter><link linkend="GtkBuilderScope"><type>GtkBuilderScope</type></link> *scope</parameter>,
                                <parameter>const <link linkend="char"><type>char</type></link> *resource_path</parameter>);</programlisting>
<para>Creates s new <link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link> that instantiates widgets
using data read from the given <parameter>resource_path</parameter>
 to pass to <link linkend="GtkBuilder"><type>GtkBuilder</type></link>.</para>
<refsect3 id="gtk-builder-list-item-factory-new-from-resource.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>scope</para></entry>
<entry role="parameter_description"><para>A scope to use when instantiating. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>nullable</acronym>][<acronym>transfer none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>resource_path</para></entry>
<entry role="parameter_description"><para>valid path to a resource that contains the data</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-builder-list-item-factory-new-from-resource.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-builder-list-item-factory-get-bytes" role="function">
<title>gtk_builder_list_item_factory_get_bytes&#160;()</title>
<indexterm zone="gtk-builder-list-item-factory-get-bytes"><primary>gtk_builder_list_item_factory_get_bytes</primary></indexterm>
<programlisting language="C"><link linkend="GBytes"><returnvalue>GBytes</returnvalue></link>&#160;*
gtk_builder_list_item_factory_get_bytes
                               (<parameter><link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link> *self</parameter>);</programlisting>
<para>Gets the data used as the <link linkend="GtkBuilder"><type>GtkBuilder</type></link> UI template for constructing
listitems.</para>
<refsect3 id="gtk-builder-list-item-factory-get-bytes.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-builder-list-item-factory-get-bytes.returns" role="returns">
<title>Returns</title>
<para>The GtkBuilder data. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-builder-list-item-factory-get-resource" role="function">
<title>gtk_builder_list_item_factory_get_resource&#160;()</title>
<indexterm zone="gtk-builder-list-item-factory-get-resource"><primary>gtk_builder_list_item_factory_get_resource</primary></indexterm>
<programlisting language="C">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
gtk_builder_list_item_factory_get_resource
                               (<parameter><link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link> *self</parameter>);</programlisting>
<para>If the data references a resource, gets the path of that resource.</para>
<refsect3 id="gtk-builder-list-item-factory-get-resource.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-builder-list-item-factory-get-resource.returns" role="returns">
<title>Returns</title>
<para>The path to the resource or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
if none. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-builder-list-item-factory-get-scope" role="function">
<title>gtk_builder_list_item_factory_get_scope&#160;()</title>
<indexterm zone="gtk-builder-list-item-factory-get-scope"><primary>gtk_builder_list_item_factory_get_scope</primary></indexterm>
<programlisting language="C"><link linkend="GtkBuilderScope"><returnvalue>GtkBuilderScope</returnvalue></link>&#160;*
gtk_builder_list_item_factory_get_scope
                               (<parameter><link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link> *self</parameter>);</programlisting>
<para>Gets the scope used when constructing listitems.</para>
<refsect3 id="gtk-builder-list-item-factory-get-scope.parameters" role="parameters">
<title>Parameters</title>
<informaltable role="parameters_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="parameters_name" colwidth="150px"/>
<colspec colname="parameters_description"/>
<colspec colname="parameters_annotations" colwidth="200px"/>
<tbody>
<row><entry role="parameter_name"><para>self</para></entry>
<entry role="parameter_description"><para>a <link linkend="GtkBuilderListItemFactory"><type>GtkBuilderListItemFactory</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-builder-list-item-factory-get-scope.returns" role="returns">
<title>Returns</title>
<para>The scope used when constructing listitems. </para>
<para><emphasis role="annotation">[<acronym>transfer none</acronym>][<acronym>nullable</acronym>]</emphasis></para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="GtkBuilderListItemFactory.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="GtkBuilderListItemFactory-struct" role="struct">
<title>GtkBuilderListItemFactory</title>
<indexterm zone="GtkBuilderListItemFactory-struct"><primary>GtkBuilderListItemFactory</primary></indexterm>
<programlisting language="C">typedef struct _GtkBuilderListItemFactory GtkBuilderListItemFactory;</programlisting>
</refsect2>

</refsect1>
<refsect1 id="GtkBuilderListItemFactory.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkBuilderListItemFactory--bytes" role="property"><title>The <literal>“bytes”</literal> property</title>
<indexterm zone="GtkBuilderListItemFactory--bytes"><primary>GtkBuilderListItemFactory:bytes</primary></indexterm>
<programlisting>  “bytes”                    <link linkend="GBytes"><type>GBytes</type></link>&#160;*</programlisting>
<para>bytes containing the UI definition</para>
<para>Owner: GtkBuilderListItemFactory</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
</refsect2>
<refsect2 id="GtkBuilderListItemFactory--resource" role="property"><title>The <literal>“resource”</literal> property</title>
<indexterm zone="GtkBuilderListItemFactory--resource"><primary>GtkBuilderListItemFactory:resource</primary></indexterm>
<programlisting>  “resource”                 <link linkend="char"><type>char</type></link>&#160;*</programlisting>
<para>resource containing the UI definition</para>
<para>Owner: GtkBuilderListItemFactory</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
<para>Default value: NULL</para>
</refsect2>
<refsect2 id="GtkBuilderListItemFactory--scope" role="property"><title>The <literal>“scope”</literal> property</title>
<indexterm zone="GtkBuilderListItemFactory--scope"><primary>GtkBuilderListItemFactory:scope</primary></indexterm>
<programlisting>  “scope”                    <link linkend="GtkBuilderScope"><type>GtkBuilderScope</type></link>&#160;*</programlisting>
<para>scope to use when instantiating listitems</para>
<para>Owner: GtkBuilderListItemFactory</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
</refsect2>

</refsect1>

</refentry>
