<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="PkPackageList">
<refmeta>
<refentrytitle role="top_of_page" id="PkPackageList.top_of_page">PkPackageList</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>PACKAGEKIT Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>PkPackageList</refname>
<refpurpose>A list of Package data needed for an offline cache</refpurpose>
</refnamediv>

<refsynopsisdiv id="PkPackageList.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>

<synopsis>
                    <link linkend="PkPackageListPrivate">PkPackageListPrivate</link>;
                    <link linkend="PkPackageList-struct">PkPackageList</link>;
<link linkend="PkPackageList">PkPackageList</link> *     <link linkend="pk-package-list-new">pk_package_list_new</link>                 (void);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-list-add">pk_package_list_add</link>                 (<link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         <link linkend="PkInfoEnum">PkInfoEnum</link> info,
                                                         const <link linkend="PkPackageId">PkPackageId</link> *ident,
                                                         const <link linkend="gchar">gchar</link> *summary);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-list-contains">pk_package_list_contains</link>            (const <link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         const <link linkend="gchar">gchar</link> *package_id);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-list-remove">pk_package_list_remove</link>              (<link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         const <link linkend="gchar">gchar</link> *package_id);
<link linkend="gchar">gchar</link> **            <link linkend="pk-package-list-to-strv">pk_package_list_to_strv</link>             (const <link linkend="PkPackageList">PkPackageList</link> *plist);
<link linkend="guint">guint</link>               <link linkend="pk-package-list-get-size">pk_package_list_get_size</link>            (const <link linkend="PkPackageList">PkPackageList</link> *plist);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-list-sort">pk_package_list_sort</link>                (<link linkend="PkPackageList">PkPackageList</link> *plist);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-list-sort-info">pk_package_list_sort_info</link>           (<link linkend="PkPackageList">PkPackageList</link> *plist);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-list-sort-summary">pk_package_list_sort_summary</link>        (<link linkend="PkPackageList">PkPackageList</link> *plist);
const <link linkend="PkPackageObj">PkPackageObj</link> * <link linkend="pk-package-list-get-obj">pk_package_list_get_obj</link>            (const <link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         <link linkend="guint">guint</link> item);
<link linkend="gboolean">gboolean</link>            <link linkend="pk-package-list-set-fuzzy-arch">pk_package_list_set_fuzzy_arch</link>      (<link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         <link linkend="gboolean">gboolean</link> fuzzy_arch);
</synopsis>
</refsynopsisdiv>

<refsect1 id="PkPackageList.object-hierarchy" role="object_hierarchy">
<title role="object_hierarchy.title">Object Hierarchy</title>
<synopsis>
  <link linkend="GObject">GObject</link>
   +----<link linkend="PkObjList">PkObjList</link>
         +----PkPackageList
</synopsis>
</refsect1>








<refsect1 id="PkPackageList.description" role="desc">
<title role="desc.title">Description</title>
<para>
These provide a way to query and store a list of packages.</para>
<para>
</para>
</refsect1>

<refsect1 id="PkPackageList.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="PkPackageListPrivate" role="struct">
<title>PkPackageListPrivate</title>
<indexterm zone="PkPackageListPrivate"><primary sortas="PkPackageListPrivate">PkPackageListPrivate</primary></indexterm><programlisting>typedef struct _PkPackageListPrivate PkPackageListPrivate;</programlisting>
<para>
Private <link linkend="PkPackageList"><type>PkPackageList</type></link> data</para>
<para>
</para></refsect2>
<refsect2 id="PkPackageList-struct" role="struct">
<title>PkPackageList</title>
<indexterm zone="PkPackageList-struct"><primary sortas="PkPackageList">PkPackageList</primary></indexterm><programlisting>typedef struct _PkPackageList PkPackageList;</programlisting>
<para>
</para></refsect2>
<refsect2 id="pk-package-list-new" role="function">
<title>pk_package_list_new ()</title>
<indexterm zone="pk-package-list-new"><primary sortas="pk_package_list_new">pk_package_list_new</primary></indexterm><programlisting><link linkend="PkPackageList">PkPackageList</link> *     pk_package_list_new                 (void);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new PkPackageList object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-add" role="function">
<title>pk_package_list_add ()</title>
<indexterm zone="pk-package-list-add"><primary sortas="pk_package_list_add">pk_package_list_add</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_list_add                 (<link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         <link linkend="PkInfoEnum">PkInfoEnum</link> info,
                                                         const <link linkend="PkPackageId">PkPackageId</link> *ident,
                                                         const <link linkend="gchar">gchar</link> *summary);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>info</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ident</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>summary</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-contains" role="function">
<title>pk_package_list_contains ()</title>
<indexterm zone="pk-package-list-contains"><primary sortas="pk_package_list_contains">pk_package_list_contains</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_list_contains            (const <link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         const <link linkend="gchar">gchar</link> *package_id);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>package_id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-remove" role="function">
<title>pk_package_list_remove ()</title>
<indexterm zone="pk-package-list-remove"><primary sortas="pk_package_list_remove">pk_package_list_remove</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_list_remove              (<link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         const <link linkend="gchar">gchar</link> *package_id);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>package_id</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-to-strv" role="function">
<title>pk_package_list_to_strv ()</title>
<indexterm zone="pk-package-list-to-strv"><primary sortas="pk_package_list_to_strv">pk_package_list_to_strv</primary></indexterm><programlisting><link linkend="gchar">gchar</link> **            pk_package_list_to_strv             (const <link linkend="PkPackageList">PkPackageList</link> *plist);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-get-size" role="function">
<title>pk_package_list_get_size ()</title>
<indexterm zone="pk-package-list-get-size"><primary sortas="pk_package_list_get_size">pk_package_list_get_size</primary></indexterm><programlisting><link linkend="guint">guint</link>               pk_package_list_get_size            (const <link linkend="PkPackageList">PkPackageList</link> *plist);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-sort" role="function">
<title>pk_package_list_sort ()</title>
<indexterm zone="pk-package-list-sort"><primary sortas="pk_package_list_sort">pk_package_list_sort</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_list_sort                (<link linkend="PkPackageList">PkPackageList</link> *plist);</programlisting>
<para>
Sorts by package_id</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-sort-info" role="function">
<title>pk_package_list_sort_info ()</title>
<indexterm zone="pk-package-list-sort-info"><primary sortas="pk_package_list_sort_info">pk_package_list_sort_info</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_list_sort_info           (<link linkend="PkPackageList">PkPackageList</link> *plist);</programlisting>
<para>
Sorts by PkInfoEnum</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-sort-summary" role="function">
<title>pk_package_list_sort_summary ()</title>
<indexterm zone="pk-package-list-sort-summary"><primary sortas="pk_package_list_sort_summary">pk_package_list_sort_summary</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_list_sort_summary        (<link linkend="PkPackageList">PkPackageList</link> *plist);</programlisting>
<para>
Sorts by summary</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-get-obj" role="function">
<title>pk_package_list_get_obj ()</title>
<indexterm zone="pk-package-list-get-obj"><primary sortas="pk_package_list_get_obj">pk_package_list_get_obj</primary></indexterm><programlisting>const <link linkend="PkPackageObj">PkPackageObj</link> * pk_package_list_get_obj            (const <link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         <link linkend="guint">guint</link> item);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>item</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="pk-package-list-set-fuzzy-arch" role="function">
<title>pk_package_list_set_fuzzy_arch ()</title>
<indexterm zone="pk-package-list-set-fuzzy-arch"><primary sortas="pk_package_list_set_fuzzy_arch">pk_package_list_set_fuzzy_arch</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            pk_package_list_set_fuzzy_arch      (<link linkend="PkPackageList">PkPackageList</link> *plist,
                                                         <link linkend="gboolean">gboolean</link> fuzzy_arch);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>plist</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>fuzzy_arch</parameter>&#160;:</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>




</refentry>
