<?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="GtkBookmarkList">
<refmeta>
<refentrytitle role="top_of_page" id="GtkBookmarkList.top_of_page">GtkBookmarkList</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>GTK4 Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GtkBookmarkList</refname>
<refpurpose>A list model for recently used files</refpurpose>
</refnamediv>

<refsect1 id="GtkBookmarkList.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="GtkBookmarkList"><returnvalue>GtkBookmarkList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="gtk-bookmark-list-new">gtk_bookmark_list_new</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-bookmark-list-get-filename">gtk_bookmark_list_get_filename</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-bookmark-list-set-attributes">gtk_bookmark_list_set_attributes</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-bookmark-list-get-attributes">gtk_bookmark_list_get_attributes</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-bookmark-list-set-io-priority">gtk_bookmark_list_set_io_priority</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="int"><returnvalue>int</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-bookmark-list-get-io-priority">gtk_bookmark_list_get_io_priority</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
</entry><entry role="function_name"><link linkend="gtk-bookmark-list-is-loading">gtk_bookmark_list_is_loading</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkBookmarkList.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="char"><type>char</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkBookmarkList--attributes">attributes</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="char"><type>char</type></link>&#160;*</entry><entry role="property_name"><link linkend="GtkBookmarkList--filename">filename</link></entry><entry role="property_flags">Read / Write / Construct&#160;Only</entry></row>
<row><entry role="property_type"><link linkend="int"><type>int</type></link></entry><entry role="property_name"><link linkend="GtkBookmarkList--io-priority">io-priority</link></entry><entry role="property_flags">Read / Write</entry></row>
<row><entry role="property_type"><link linkend="gboolean"><type>gboolean</type></link></entry><entry role="property_name"><link linkend="GtkBookmarkList--loading">loading</link></entry><entry role="property_flags">Read</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkBookmarkList.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="GtkBookmarkList-struct">GtkBookmarkList</link></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="GtkBookmarkList.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> GtkBookmarkList
</screen>
</refsect1>
<refsect1 id="GtkBookmarkList.implemented-interfaces" role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GtkBookmarkList implements
 <link linkend="GListModel">GListModel</link>.</para>

</refsect1>

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

<refsect1 id="GtkBookmarkList.description" role="desc">
<title role="desc.title">Description</title>
<para><link linkend="GtkBookmarkList"><type>GtkBookmarkList</type></link> is a list model that wraps GBookmarkFile.
It presents a <link linkend="GListModel"><type>GListModel</type></link> and fills it asynchronously with the <link linkend="GFileInfos"><type>GFileInfos</type></link>
returned from that function.</para>
<para>The <link linkend="GFileInfos"><type>GFileInfos</type></link> in the list have some attributes in the recent namespace
added: recent::private (boolean) and recent:applications (stringv).</para>

</refsect1>
<refsect1 id="GtkBookmarkList.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="gtk-bookmark-list-new" role="function">
<title>gtk_bookmark_list_new&#160;()</title>
<indexterm zone="gtk-bookmark-list-new"><primary>gtk_bookmark_list_new</primary></indexterm>
<programlisting language="C"><link linkend="GtkBookmarkList"><returnvalue>GtkBookmarkList</returnvalue></link>&#160;*
gtk_bookmark_list_new (<parameter>const <link linkend="char"><type>char</type></link> *filename</parameter>,
                       <parameter>const <link linkend="char"><type>char</type></link> *attributes</parameter>);</programlisting>
<para>Creates a new <link linkend="GtkBookmarkList"><type>GtkBookmarkList</type></link> with the given <parameter>attributes</parameter>
.</para>
<refsect3 id="gtk-bookmark-list-new.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>filename</para></entry>
<entry role="parameter_description"><para>The bookmark file to load. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
<row><entry role="parameter_name"><para>attributes</para></entry>
<entry role="parameter_description"><para>The attributes to query. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-bookmark-list-new.returns" role="returns">
<title>Returns</title>
<para> a new <link linkend="GtkBookmarkList"><type>GtkBookmarkList</type></link></para>
</refsect3></refsect2>
<refsect2 id="gtk-bookmark-list-get-filename" role="function">
<title>gtk_bookmark_list_get_filename&#160;()</title>
<indexterm zone="gtk-bookmark-list-get-filename"><primary>gtk_bookmark_list_get_filename</primary></indexterm>
<programlisting language="C">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
gtk_bookmark_list_get_filename (<parameter><link linkend="GtkBookmarkList"><type>GtkBookmarkList</type></link> *self</parameter>);</programlisting>
<para>Returns the filename of the bookmark file that
this list is loading.</para>
<refsect3 id="gtk-bookmark-list-get-filename.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="GtkBookmarkList"><type>GtkBookmarkList</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-bookmark-list-get-filename.returns" role="returns">
<title>Returns</title>
<para> the filename of the .xbel file</para>
</refsect3></refsect2>
<refsect2 id="gtk-bookmark-list-set-attributes" role="function">
<title>gtk_bookmark_list_set_attributes&#160;()</title>
<indexterm zone="gtk-bookmark-list-set-attributes"><primary>gtk_bookmark_list_set_attributes</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_bookmark_list_set_attributes (<parameter><link linkend="GtkBookmarkList"><type>GtkBookmarkList</type></link> *self</parameter>,
                                  <parameter>const <link linkend="char"><type>char</type></link> *attributes</parameter>);</programlisting>
<para>Sets the <parameter>attributes</parameter>
 to be enumerated and starts the enumeration.</para>
<para>If <parameter>attributes</parameter>
 is <link linkend="NULL:CAPS"><literal>NULL</literal></link>, no attributes will be queried, but a list
of <link linkend="GFileInfos"><type>GFileInfos</type></link> will still be created.</para>
<refsect3 id="gtk-bookmark-list-set-attributes.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="GtkBookmarkList"><type>GtkBookmarkList</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>attributes</para></entry>
<entry role="parameter_description"><para>the attributes to enumerate. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>allow-none</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-bookmark-list-get-attributes" role="function">
<title>gtk_bookmark_list_get_attributes&#160;()</title>
<indexterm zone="gtk-bookmark-list-get-attributes"><primary>gtk_bookmark_list_get_attributes</primary></indexterm>
<programlisting language="C">const <link linkend="char"><returnvalue>char</returnvalue></link>&#160;*
gtk_bookmark_list_get_attributes (<parameter><link linkend="GtkBookmarkList"><type>GtkBookmarkList</type></link> *self</parameter>);</programlisting>
<para>Gets the attributes queried on the children.</para>
<refsect3 id="gtk-bookmark-list-get-attributes.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="GtkBookmarkList"><type>GtkBookmarkList</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-bookmark-list-get-attributes.returns" role="returns">
<title>Returns</title>
<para>The queried attributes. </para>
<para><emphasis role="annotation">[<acronym>nullable</acronym>][<acronym>transfer none</acronym>]</emphasis></para>
</refsect3></refsect2>
<refsect2 id="gtk-bookmark-list-set-io-priority" role="function">
<title>gtk_bookmark_list_set_io_priority&#160;()</title>
<indexterm zone="gtk-bookmark-list-set-io-priority"><primary>gtk_bookmark_list_set_io_priority</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
gtk_bookmark_list_set_io_priority (<parameter><link linkend="GtkBookmarkList"><type>GtkBookmarkList</type></link> *self</parameter>,
                                   <parameter><link linkend="int"><type>int</type></link> io_priority</parameter>);</programlisting>
<para>Sets the IO priority to use while loading files.</para>
<para>The default IO priority is <link linkend="G-PRIORITY-DEFAULT:CAPS"><literal>G_PRIORITY_DEFAULT</literal></link>.</para>
<refsect3 id="gtk-bookmark-list-set-io-priority.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="GtkBookmarkList"><type>GtkBookmarkList</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>io_priority</para></entry>
<entry role="parameter_description"><para>IO priority to use</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="gtk-bookmark-list-get-io-priority" role="function">
<title>gtk_bookmark_list_get_io_priority&#160;()</title>
<indexterm zone="gtk-bookmark-list-get-io-priority"><primary>gtk_bookmark_list_get_io_priority</primary></indexterm>
<programlisting language="C"><link linkend="int"><returnvalue>int</returnvalue></link>
gtk_bookmark_list_get_io_priority (<parameter><link linkend="GtkBookmarkList"><type>GtkBookmarkList</type></link> *self</parameter>);</programlisting>
<para>Gets the IO priority set via <link linkend="gtk-bookmark-list-set-io-priority"><function>gtk_bookmark_list_set_io_priority()</function></link>.</para>
<refsect3 id="gtk-bookmark-list-get-io-priority.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="GtkBookmarkList"><type>GtkBookmarkList</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-bookmark-list-get-io-priority.returns" role="returns">
<title>Returns</title>
<para> The IO priority.</para>
</refsect3></refsect2>
<refsect2 id="gtk-bookmark-list-is-loading" role="function">
<title>gtk_bookmark_list_is_loading&#160;()</title>
<indexterm zone="gtk-bookmark-list-is-loading"><primary>gtk_bookmark_list_is_loading</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
gtk_bookmark_list_is_loading (<parameter><link linkend="GtkBookmarkList"><type>GtkBookmarkList</type></link> *self</parameter>);</programlisting>
<para>Returns <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if the files are currently being loaded.</para>
<para>Files will be added to <parameter>self</parameter>
 from time to time while loading is
going on. The order in which are added is undefined and may change
in between runs.</para>
<refsect3 id="gtk-bookmark-list-is-loading.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="GtkBookmarkList"><type>GtkBookmarkList</type></link></para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 id="gtk-bookmark-list-is-loading.returns" role="returns">
<title>Returns</title>
<para> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if <parameter>self</parameter>
is loading</para>
</refsect3></refsect2>

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

</refsect1>
<refsect1 id="GtkBookmarkList.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="GtkBookmarkList--attributes" role="property"><title>The <literal>“attributes”</literal> property</title>
<indexterm zone="GtkBookmarkList--attributes"><primary>GtkBookmarkList:attributes</primary></indexterm>
<programlisting>  “attributes”               <link linkend="char"><type>char</type></link>&#160;*</programlisting>
<para>The attributes to query</para>
<para>Owner: GtkBookmarkList</para>
<para>Flags: Read / Write</para>
<para>Default value: NULL</para>
</refsect2>
<refsect2 id="GtkBookmarkList--filename" role="property"><title>The <literal>“filename”</literal> property</title>
<indexterm zone="GtkBookmarkList--filename"><primary>GtkBookmarkList:filename</primary></indexterm>
<programlisting>  “filename”                 <link linkend="char"><type>char</type></link>&#160;*</programlisting>
<para>Bookmark file to load.</para><para>Owner: GtkBookmarkList</para>
<para>Flags: Read / Write / Construct&#160;Only</para>
<para>Default value: NULL</para>
</refsect2>
<refsect2 id="GtkBookmarkList--io-priority" role="property"><title>The <literal>“io-priority”</literal> property</title>
<indexterm zone="GtkBookmarkList--io-priority"><primary>GtkBookmarkList:io-priority</primary></indexterm>
<programlisting>  “io-priority”              <link linkend="int"><type>int</type></link></programlisting>
<para>Priority used when loading</para>
<para>Owner: GtkBookmarkList</para>
<para>Flags: Read / Write</para>
<para>Allowed values: &gt;= -2147483647</para>
<para>Default value: 0</para>
</refsect2>
<refsect2 id="GtkBookmarkList--loading" role="property"><title>The <literal>“loading”</literal> property</title>
<indexterm zone="GtkBookmarkList--loading"><primary>GtkBookmarkList:loading</primary></indexterm>
<programlisting>  “loading”                  <link linkend="gboolean"><type>gboolean</type></link></programlisting>
<para><link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if files are being loaded</para>
<para>Owner: GtkBookmarkList</para>
<para>Flags: Read</para>
<para>Default value: FALSE</para>
</refsect2>

</refsect1>
<refsect1 id="GtkBookmarkList.see-also">
<title>See Also</title>
<para><link linkend="GListModel"><type>GListModel</type></link>, <link linkend="GBookmarkFile"><type>GBookmarkFile</type></link></para>

</refsect1>

</refentry>
