<?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'">
]>
<refentry id="ListallerUpdater">
<refmeta>
<refentrytitle role="top_of_page" id="ListallerUpdater.top_of_page">ListallerUpdater</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>
  LISTALLER Library
</refmiscinfo>
</refmeta>
<refnamediv>
<refname>ListallerUpdater</refname>
<refpurpose>All necessary methods to keep installed applications up-to-date</refpurpose>
</refnamediv>

<refsect1 id="ListallerUpdater.functions" role="functions_proto">
<title role="functions_proto.title">Functions</title>
<informaltable pgwide="1" frame="none">
<tgroup cols="2">
<colspec colname="functions_return" colwidth="150px"/>
<colspec colname="functions_name"/>
<tbody>
<row><entry role="define_keyword">#define</entry><entry role="function_name"><link linkend="LISTALLER-TYPE-UPDATER:CAPS">LISTALLER_TYPE_UPDATER</link></entry></row>
<row><entry role="function_type"><link linkend="void"><returnvalue>void</returnvalue></link>
</entry><entry role="function_name"><link linkend="listaller-updater-find-updates">listaller_updater_find_updates</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="listaller-updater-apply-updates">listaller_updater_apply_updates</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="listaller-updater-apply-updates-all">listaller_updater_apply_updates_all</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="ListallerUpdater"><returnvalue>ListallerUpdater</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="listaller-updater-new">listaller_updater_new</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="ListallerSetupSettings"><returnvalue>ListallerSetupSettings</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="listaller-updater-get-settings">listaller_updater_get_settings</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="listaller-updater-set-settings">listaller_updater_set_settings</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>
<row><entry role="function_type"><link linkend="GeeArrayList"><returnvalue>GeeArrayList</returnvalue></link>&#160;*
</entry><entry role="function_name"><link linkend="listaller-updater-get-available-updates">listaller_updater_get_available_updates</link>&#160;<phrase role="c_punctuation">()</phrase></entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="ListallerUpdater.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="GeeArrayList"><type>GeeArrayList</type></link>&#160;*</entry><entry role="property_name"><link linkend="ListallerUpdater--available-updates">available-updates</link></entry><entry role="property_flags">Read</entry></row>
<row><entry role="property_type"><link linkend="ListallerSetupSettings"><type>ListallerSetupSettings</type></link>&#160;*</entry><entry role="property_name"><link linkend="ListallerUpdater--settings">settings</link></entry><entry role="property_flags">Read / Write</entry></row>

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="ListallerUpdater.signals" role="signal_proto">
<title role="signal_proto.title">Signals</title>
<informaltable frame="none">
<tgroup cols="3">
<colspec colname="signals_return" colwidth="150px"/>
<colspec colname="signals_name" colwidth="300px"/>
<colspec colname="signals_flags" colwidth="200px"/>
<tbody>
<row><entry role="signal_type"><link linkend="void"><returnvalue>void</returnvalue></link></entry><entry role="signal_name"><link linkend="ListallerUpdater-update">update</link></entry><entry role="signal_flags"><link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></entry></row>

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

</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 id="ListallerUpdater.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="ListallerMessageObject">ListallerMessageObject</link>
        <phrase role="lineart">&#9584;&#9472;&#9472;</phrase> ListallerUpdater
</screen>
</refsect1>


<refsect1 id="ListallerUpdater.description" role="desc">
<title role="desc.title">Description</title>
<para>This class allows installing updates for installed applications.</para>

</refsect1>
<refsect1 id="ListallerUpdater.functions_details" role="details">
<title role="details.title">Functions</title>
<refsect2 id="LISTALLER-TYPE-UPDATER:CAPS" role="macro">
<title>LISTALLER_TYPE_UPDATER</title>
<indexterm zone="LISTALLER-TYPE-UPDATER:CAPS"><primary sortas="TYPE_UPDATER">LISTALLER_TYPE_UPDATER</primary></indexterm>
<programlisting language="C">#define LISTALLER_TYPE_UPDATER (listaller_updater_get_type ())
</programlisting>
<para>The type for <link linkend="ListallerUpdater"><type>ListallerUpdater</type></link>.</para>
</refsect2>
<refsect2 id="listaller-updater-find-updates" role="function">
<title>listaller_updater_find_updates&#160;()</title>
<indexterm zone="listaller-updater-find-updates"><primary sortas="updater_find_updates">listaller_updater_find_updates</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
listaller_updater_find_updates (<parameter><link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> *self</parameter>);</programlisting>
<para>Find updates available for installed applications.</para>
<refsect3 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>the <link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="listaller-updater-apply-updates" role="function">
<title>listaller_updater_apply_updates&#160;()</title>
<indexterm zone="listaller-updater-apply-updates"><primary sortas="updater_apply_updates">listaller_updater_apply_updates</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
listaller_updater_apply_updates (<parameter><link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> *self</parameter>,
                                 <parameter><link linkend="GeeArrayList"><type>GeeArrayList</type></link> *update_list</parameter>);</programlisting>
<para>Apply updates selected in update_list.</para>
<refsect3 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>the <link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>update_list</para></entry>
<entry role="parameter_description"><para> &nbsp;.  A list containing valid UpdateItems. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>in</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="listaller-updater-apply-updates-all" role="function">
<title>listaller_updater_apply_updates_all&#160;()</title>
<indexterm zone="listaller-updater-apply-updates-all"><primary sortas="updater_apply_updates_all">listaller_updater_apply_updates_all</primary></indexterm>
<programlisting language="C"><link linkend="gboolean"><returnvalue>gboolean</returnvalue></link>
listaller_updater_apply_updates_all (<parameter><link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> *self</parameter>);</programlisting>
<para>Apply all available updates</para>
<refsect3 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>the <link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> instance</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="listaller-updater-new" role="function">
<title>listaller_updater_new&#160;()</title>
<indexterm zone="listaller-updater-new"><primary sortas="updater_new">listaller_updater_new</primary></indexterm>
<programlisting language="C"><link linkend="ListallerUpdater"><returnvalue>ListallerUpdater</returnvalue></link>&#160;*
listaller_updater_new (<parameter><link linkend="gboolean"><type>gboolean</type></link> shared_mode</parameter>);</programlisting>
<para>Create a new Listaller update manager</para>
<refsect3 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>shared_mode</para></entry>
<entry role="parameter_description"><para> &nbsp;.  Whether we are in shared mode or not. </para></entry>
<entry role="parameter_annotations"><emphasis role="annotation">[<acronym>in</acronym>]</emphasis></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="listaller-updater-get-settings" role="function">
<title>listaller_updater_get_settings&#160;()</title>
<indexterm zone="listaller-updater-get-settings"><primary sortas="updater_get_settings">listaller_updater_get_settings</primary></indexterm>
<programlisting language="C"><link linkend="ListallerSetupSettings"><returnvalue>ListallerSetupSettings</returnvalue></link>&#160;*
listaller_updater_get_settings (<parameter><link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> *self</parameter>);</programlisting>
<para>Get and return the current value of the <link linkend="ListallerUpdater--settings"><type>"settings"</type></link> property.</para>
<refsect3 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>the <link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> instance to query</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the value of the <link linkend="ListallerUpdater--settings"><type>"settings"</type></link> property</para>
<para></para>
</refsect3></refsect2>
<refsect2 id="listaller-updater-set-settings" role="function">
<title>listaller_updater_set_settings&#160;()</title>
<indexterm zone="listaller-updater-set-settings"><primary sortas="updater_set_settings">listaller_updater_set_settings</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
listaller_updater_set_settings (<parameter><link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> *self</parameter>,
                                <parameter><link linkend="ListallerSetupSettings"><type>ListallerSetupSettings</type></link> *value</parameter>);</programlisting>
<para>Set the value of the <link linkend="ListallerUpdater--settings"><type>"settings"</type></link> property to <parameter>value</parameter>
.</para>
<refsect3 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>the <link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> instance to modify</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>value</para></entry>
<entry role="parameter_description"><para>the new value of the <link linkend="ListallerUpdater--settings"><type>"settings"</type></link> property</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3></refsect2>
<refsect2 id="listaller-updater-get-available-updates" role="function">
<title>listaller_updater_get_available_updates&#160;()</title>
<indexterm zone="listaller-updater-get-available-updates"><primary sortas="updater_get_available_updates">listaller_updater_get_available_updates</primary></indexterm>
<programlisting language="C"><link linkend="GeeArrayList"><returnvalue>GeeArrayList</returnvalue></link>&#160;*
listaller_updater_get_available_updates
                               (<parameter><link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> *self</parameter>);</programlisting>
<para>Get and return the current value of the <link linkend="ListallerUpdater--available-updates"><type>"available-updates"</type></link> property.</para>
<refsect3 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>the <link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> instance to query</para></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><refsect3 role="returns">
<title>Returns</title>
<para> the value of the <link linkend="ListallerUpdater--available-updates"><type>"available-updates"</type></link> property</para>
<para></para>
</refsect3></refsect2>

</refsect1>
<refsect1 id="ListallerUpdater.other_details" role="details">
<title role="details.title">Types and Values</title>
<refsect2 id="ListallerUpdater-struct" role="struct">
<title>struct ListallerUpdater</title>
<indexterm zone="ListallerUpdater-struct"><primary sortas="Updater">ListallerUpdater</primary></indexterm>
<programlisting language="C">struct ListallerUpdater;</programlisting>
<para>All necessary methods to keep installed applications up-to-date</para>
<para>This class allows installing updates for installed applications.</para>
</refsect2>
<refsect2 id="ListallerUpdaterClass" role="struct">
<title>struct ListallerUpdaterClass</title>
<indexterm zone="ListallerUpdaterClass"><primary sortas="UpdaterClass">ListallerUpdaterClass</primary></indexterm>
<programlisting language="C">struct ListallerUpdaterClass {
	ListallerMessageObjectClass parent_class;
};
</programlisting>
<para>The class structure for <link linkend="LISTALLER-TYPE-UPDATER:CAPS"><literal>LISTALLER_TYPE_UPDATER</literal></link>. All the fields in this structure are private and should never be accessed directly.</para>
<refsect3 role="struct_members">
<title>Members</title>
<informaltable role="struct_members_table" pgwide="1" frame="none">
<tgroup cols="3">
<colspec colname="struct_members_name" colwidth="300px"/>
<colspec colname="struct_members_description"/>
<colspec colname="struct_members_annotations" colwidth="200px"/>
<tbody>
<row><entry role="struct_member_name"><para><link linkend="ListallerMessageObjectClass"><type>ListallerMessageObjectClass</type></link>&#160;<structfield id="ListallerUpdaterClass.parent-class">parent_class</structfield>;</para></entry>
<listitem><para>the parent class structure</para></listitem>
<entry role="struct_member_description"><para>the parent class structure</para></entry>
<entry role="struct_member_annotations"></entry>
</row>
</tbody></tgroup></informaltable>
</refsect3>
</refsect2>

</refsect1>
<refsect1 id="ListallerUpdater.property-details" role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2 id="ListallerUpdater--available-updates" role="property"><title>The <literal>“available-updates”</literal> property</title>
<indexterm zone="ListallerUpdater--available-updates"><primary sortas="Updater:available-updates">ListallerUpdater:available-updates</primary></indexterm>
<programlisting>  “available-updates”        <link linkend="GeeArrayList"><type>GeeArrayList</type></link>&#160;*</programlisting>
<para>available-updates.</para><para>Flags: Read</para>
</refsect2>
<refsect2 id="ListallerUpdater--settings" role="property"><title>The <literal>“settings”</literal> property</title>
<indexterm zone="ListallerUpdater--settings"><primary sortas="Updater:settings">ListallerUpdater:settings</primary></indexterm>
<programlisting>  “settings”                 <link linkend="ListallerSetupSettings"><type>ListallerSetupSettings</type></link>&#160;*</programlisting>
<para>settings.</para><para>Flags: Read / Write</para>
</refsect2>

</refsect1>
<refsect1 id="ListallerUpdater.signal-details" role="signals">
<title role="signals.title">Signal Details</title>
<refsect2 id="ListallerUpdater-update" role="signal"><title>The <literal>“update”</literal> signal</title>
<indexterm zone="ListallerUpdater-update"><primary sortas="Updater::update">ListallerUpdater::update</primary></indexterm>
<programlisting language="C"><link linkend="void"><returnvalue>void</returnvalue></link>
user_function (<link linkend="ListallerUpdater"><type>ListallerUpdater</type></link>    *updater,
               <link linkend="ListallerUpdateItem"><type>ListallerUpdateItem</type></link> *update,
               <link linkend="gpointer"><type>gpointer</type></link>             user_data)</programlisting>
<refsect3 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>updater</para></entry>
<entry role="parameter_description"><para>the <link linkend="ListallerUpdater"><type>ListallerUpdater</type></link> instance that received the signal</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><para>update</para></entry>
<entry role="parameter_description"><para>&nbsp;</para></entry>
<entry role="parameter_annotations"></entry></row>
<row><entry role="parameter_name"><simpara>user_data</simpara></entry>
<entry role="parameter_description"><simpara>user data set when the signal handler was connected.</simpara></entry>
<entry role="parameter_annotations"></entry></row>
</tbody></tgroup></informaltable>
</refsect3><para>Flags: <link linkend="G-SIGNAL-RUN-LAST:CAPS">Run Last</link></para>
</refsect2>
</refsect1>

</refentry>