← Back to branch summary

~swem/totem/assignment

« back to all changes in this revision

Viewing changes to docs/reference/xml/totem-object.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-01-27 09:40:18 UTC
  • mfrom: (1.4.2 upstream) (5.1.13 sid)
  • Revision ID: james.westby@ubuntu.com-20100127094018-q6rzt7va0y8ketwt
Tags: 2.29.4-1
* New upstream development release:
  + debian/patches/90_autotools.patch:
    - Refreshed for the new version.
  + debian/control.in:
    - Update build dependencies and dependencies.
    - Drop tracker plugin, it needs tracker 0.7.
  + debian/totem-mozilla.links:
    - Drop the complex plugin, it doesn't exist anymore.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/totem-object.xml
104
104
                                                         const <link linkend="char">char</link> *subtitle_uri);
105
105
<link linkend="guint">guint</link>               <link linkend="totem-get-playlist-length">totem_get_playlist_length</link>           (<link linkend="Totem">Totem</link> *totem);
106
106
<link linkend="int">int</link>                 <link linkend="totem-get-playlist-pos">totem_get_playlist_pos</link>              (<link linkend="Totem">Totem</link> *totem);
107
 
<link linkend="char">char</link> *              <link linkend="totem-get-short-title">totem_get_short_title</link>               (<link linkend="Totem">Totem</link> *totem);
108
107
<link linkend="char">char</link> *              <link linkend="totem-get-title-at-playlist-pos">totem_get_title_at_playlist_pos</link>     (<link linkend="Totem">Totem</link> *totem,
109
108
                                                         <link linkend="guint">guint</link> playlist_index);
 
109
<link linkend="char">char</link> *              <link linkend="totem-get-short-title">totem_get_short_title</link>               (<link linkend="Totem">Totem</link> *totem);
110
110
<link linkend="void">void</link>                <link linkend="totem-add-sidebar-page">totem_add_sidebar_page</link>              (<link linkend="Totem">Totem</link> *totem,
111
111
                                                         const <link linkend="char">char</link> *page_id,
112
112
                                                         const <link linkend="char">char</link> *title,
789
789
<indexterm zone="totem-action-volume-relative"><primary sortas="action_volume_relative">totem_action_volume_relative</primary></indexterm><programlisting><link linkend="void">void</link>                totem_action_volume_relative        (<link linkend="Totem">Totem</link> *totem,
790
790
                                                         <link linkend="double">double</link> off_pct);</programlisting>
791
791
<para>
792
 
Sets the volume relative to its current level, with 1.0 being the
793
 
maximum, and 0.0 being the minimum level.</para>
 
792
Sets the volume relative to its current level, with <link linkend="1--CAPS"><literal>1</literal></link>.0 being the
 
793
maximum, and <link linkend="0--CAPS"><literal>0</literal></link>.0 being the minimum level.</para>
794
794
<para>
795
795
</para><variablelist role="params">
796
796
<varlistentry><term><parameter>totem</parameter>&#160;:</term>
1100
1100
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the index of the current playlist entry, or <link linkend="1--CAPS"><literal>-1</literal></link>
1101
1101
</simpara></listitem></varlistentry>
1102
1102
</variablelist></refsect2>
1103
 
<refsect2 id="totem-get-short-title" role="function">
1104
 
<title>totem_get_short_title ()</title>
1105
 
<indexterm zone="totem-get-short-title"><primary sortas="get_short_title">totem_get_short_title</primary></indexterm><programlisting><link linkend="char">char</link> *              totem_get_short_title               (<link linkend="Totem">Totem</link> *totem);</programlisting>
1106
 
<para>
1107
 
Gets the title of the current entry in the playlist.</para>
1108
 
<para>
1109
 
</para><variablelist role="params">
1110
 
<varlistentry><term><parameter>totem</parameter>&#160;:</term>
1111
 
<listitem><simpara> a <link linkend="TotemObject"><type>TotemObject</type></link>
1112
 
</simpara></listitem></varlistentry>
1113
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current entry's title, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>; free with <link linkend="g-free"><function>g_free()</function></link>
1114
 
</simpara></listitem></varlistentry>
1115
 
</variablelist></refsect2>
1116
1103
<refsect2 id="totem-get-title-at-playlist-pos" role="function">
1117
1104
<title>totem_get_title_at_playlist_pos ()</title>
1118
1105
<indexterm zone="totem-get-title-at-playlist-pos"><primary sortas="get_title_at_playlist_pos">totem_get_title_at_playlist_pos</primary></indexterm><programlisting><link linkend="char">char</link> *              totem_get_title_at_playlist_pos     (<link linkend="Totem">Totem</link> *totem,
1125
1112
<listitem><simpara> a <link linkend="TotemObject"><type>TotemObject</type></link>
1126
1113
</simpara></listitem></varlistentry>
1127
1114
<varlistentry><term><parameter>playlist_index</parameter>&#160;:</term>
1128
 
<listitem><simpara>
 
1115
<listitem><simpara> the <link linkend="0--CAPS"><literal>0</literal></link>-based entry index
1129
1116
</simpara></listitem></varlistentry>
1130
1117
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the entry title at <parameter>index</parameter>, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>; free with <link linkend="g-free"><function>g_free()</function></link>
1131
1118
</simpara></listitem></varlistentry>
1132
1119
</variablelist></refsect2>
 
1120
<refsect2 id="totem-get-short-title" role="function">
 
1121
<title>totem_get_short_title ()</title>
 
1122
<indexterm zone="totem-get-short-title"><primary sortas="get_short_title">totem_get_short_title</primary></indexterm><programlisting><link linkend="char">char</link> *              totem_get_short_title               (<link linkend="Totem">Totem</link> *totem);</programlisting>
 
1123
<para>
 
1124
Gets the title of the current entry in the playlist.</para>
 
1125
<para>
 
1126
</para><variablelist role="params">
 
1127
<varlistentry><term><parameter>totem</parameter>&#160;:</term>
 
1128
<listitem><simpara> a <link linkend="TotemObject"><type>TotemObject</type></link>
 
1129
</simpara></listitem></varlistentry>
 
1130
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the current entry's title, or <link linkend="NULL--CAPS"><literal>NULL</literal></link>; free with <link linkend="g-free"><function>g_free()</function></link>
 
1131
</simpara></listitem></varlistentry>
 
1132
</variablelist></refsect2>
1133
1133
<refsect2 id="totem-add-sidebar-page" role="function">
1134
1134
<title>totem_add_sidebar_page ()</title>
1135
1135
<indexterm zone="totem-add-sidebar-page"><primary sortas="add_sidebar_page">totem_add_sidebar_page</primary></indexterm><programlisting><link linkend="void">void</link>                totem_add_sidebar_page              (<link linkend="Totem">Totem</link> *totem,