datalist.sgml

GLib是GTK+和GNOME工程的基础底层核心程序库

<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>dl</parameter>&nbsp;:</entry>
<entry>a datalist.
</entry></row>
<row><entry align="right"><parameter>q</parameter>&nbsp;:</entry>
<entry>the <link linkend="GQuark">GQuark</link> identifying the data element.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-datalist-id-remove-no-notify">g_datalist_id_remove_no_notify ()</title>
<programlisting><link linkend="gpointer">gpointer</link>    g_datalist_id_remove_no_notify  (<link linkend="GData">GData</link> **datalist,
                                             <link linkend="GQuark">GQuark</link> key_id);</programlisting>
<para>
Removes an element, without calling its destroy notification function.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>datalist</parameter>&nbsp;:</entry>
<entry>a datalist.
</entry></row>
<row><entry align="right"><parameter>key_id</parameter>&nbsp;:</entry>
<entry>the <link linkend="GQuark">GQuark</link> identifying a data element.
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>the data previously stored at <parameter>key_id</parameter>, or <literal>NULL</literal> if none.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-datalist-set-data">g_datalist_set_data()</title>
<programlisting>#define     g_datalist_set_data(dl, k, d)</programlisting>
<para>
Sets the data element corresponding to the given string identifier.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>dl</parameter>&nbsp;:</entry>
<entry>a datalist.
</entry></row>
<row><entry align="right"><parameter>k</parameter>&nbsp;:</entry>
<entry>the string to identify the data element.
</entry></row>
<row><entry align="right"><parameter>d</parameter>&nbsp;:</entry>
<entry>the data element.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-datalist-set-data-full">g_datalist_set_data_full()</title>
<programlisting>#define     g_datalist_set_data_full(dl, k, d, f)</programlisting>
<para>
Sets the data element corresponding to the given string identifier, and the
function to be called when the data element is removed.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>dl</parameter>&nbsp;:</entry>
<entry>a datalist.
</entry></row>
<row><entry align="right"><parameter>k</parameter>&nbsp;:</entry>
<entry>the string to identify the data element.
</entry></row>
<row><entry align="right"><parameter>d</parameter>&nbsp;:</entry>
<entry>the data element.
</entry></row>
<row><entry align="right"><parameter>f</parameter>&nbsp;:</entry>
<entry>the function to call when the data element is removed. This
function will be called with the data element and can be used to free any
memory allocated for it.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-datalist-get-data">g_datalist_get_data()</title>
<programlisting>#define     g_datalist_get_data(dl, k)</programlisting>
<para>
Gets a data element, using its string identifer.
This is slower than <link linkend="g-datalist-id-get-data">g_datalist_id_get_data</link>() because the string is first
converted to a <link linkend="GQuark">GQuark</link>.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>dl</parameter>&nbsp;:</entry>
<entry>a datalist.
</entry></row>
<row><entry align="right"><parameter>k</parameter>&nbsp;:</entry>
<entry>the string identifying a data element.
</entry></row>
<row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry>the data element, or <literal>NULL</literal> if it is not found.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-datalist-remove-data">g_datalist_remove_data()</title>
<programlisting>#define     g_datalist_remove_data(dl, k)</programlisting>
<para>
Removes an element using its string identifier.
The data element's destroy function is called if it has been set.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>dl</parameter>&nbsp;:</entry>
<entry>a datalist.
</entry></row>
<row><entry align="right"><parameter>k</parameter>&nbsp;:</entry>
<entry>the string identifying the data element.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-datalist-remove-no-notify">g_datalist_remove_no_notify()</title>
<programlisting>#define     g_datalist_remove_no_notify(dl, k)</programlisting>
<para>
Removes an element, without calling its destroy notifier.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>dl</parameter>&nbsp;:</entry>
<entry>a datalist.
</entry></row>
<row><entry align="right"><parameter>k</parameter>&nbsp;:</entry>
<entry>the string identifying the data element.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-datalist-foreach">g_datalist_foreach ()</title>
<programlisting>void        g_datalist_foreach              (<link linkend="GData">GData</link> **datalist,
                                             <link linkend="GDataForeachFunc">GDataForeachFunc</link> func,
                                             <link linkend="gpointer">gpointer</link> user_data);</programlisting>
<para>
Calls the given function for each data element of the datalist.
The function is called with each data element's <link linkend="GQuark">GQuark</link> id and data,
together with the given <parameter>user_data</parameter> parameter.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>datalist</parameter>&nbsp;:</entry>
<entry>a datalist.
</entry></row>
<row><entry align="right"><parameter>func</parameter>&nbsp;:</entry>
<entry>the function to call for each data element.
</entry></row>
<row><entry align="right"><parameter>user_data</parameter>&nbsp;:</entry>
<entry>user data to pass to the function.


</entry></row>
</tbody></tgroup></informaltable></refsect2>
<refsect2>
<title><anchor id="g-datalist-clear">g_datalist_clear ()</title>
<programlisting>void        g_datalist_clear                (<link linkend="GData">GData</link> **datalist);</programlisting>
<para>
Frees all the data elements of the datalist.
The data elements' destroy functions are called if they have been set.
</para><informaltable pgwide="1" frame="none" role="params">
<tgroup cols="2">
<colspec colwidth="2*">
<colspec colwidth="8*">
<tbody>
<row><entry align="right"><parameter>datalist</parameter>&nbsp;:</entry>
<entry>a datalist.


</entry></row>
</tbody></tgroup></informaltable></refsect2>

</refsect1>




</refentry>