← Back to branch summary

~walkerlee/totem/pre-interview

« back to all changes in this revision

Viewing changes to docs/reference/html/TotemVideoList.html

  • Committer: Package Import Robot
  • Author(s): Jeremy Bicha
  • Date: 2013-05-26 00:07:51 UTC
  • mfrom: (1.6.1) (24.1.4 experimental)
  • Revision ID: package-import@ubuntu.com-20130526000751-kv8ap3x1di4qq8j2
Tags: 3.8.2-0ubuntu1
https://launchpad.net/bugs/1007438
https://launchpad.net/bugs/1039604
* Sync with Debian. Remaining changes: 
* debian/control.in:
  - Drop build-depends on libepc-ui-dev and libgrilo-0.2-dev (in universe)
  - Drop libxtst-dev build-depends so that the (redundant) fake key presses
    for inhibiting the screensaver are disabled (LP: #1007438)
  - Build-depend on libzeitgeist-dev
  - Suggest rather than recommend gstreamer components in universe
  - Add totem-plugins-extra
  - Add XB-Npp-Description and XB-Npp-Filename header to the 
    totem-mozilla package to improve ubufox/ubuntu plugin db integration 
  - Refer to Firefox in totem-mozilla description instead of Iceweasel
  - Don't have totem-mozilla recommend any particular browser
  - Drop obsolete python library dependencies since iplayer is no longer
    included
* debian/totem-common.install, debian/source_totem.py:
  - Install Ubuntu apport debugging hook
* debian/totem-plugins-extra.install:
  - Universe plugins split out of totem-plugins (currently only gromit)
* debian/totem-plugins.install:    
  - Skip the plugins split to -extra and add the zeitgeist plugin
* debian/rules:
  - Build with --fail-missing, to ensure we install everything. 
    + Ignore libtotem.{,l}a since we delibrately don't install these.
  - Re-enable hardening, make sure both PIE and BINDNOW are used
    by setting hardening=+all. (LP: #1039604)
* debian/patches/91_quicklist_entries.patch:
  - Add static quicklist
* debian/patches/92_gst-plugins-good.patch:
  - Build without unnecessary gstreamer1.0-bad dependency
* debian/patches/93_grilo_optional.patch:
  - Allow building without grilo while grilo MIR is still pending
* debian/patches/correct_desktop_mimetypes.patch:
  - Don't list the mimetypes after the unity lists
* debian/patches/revert_shell_menu.patch: 
  - revert the use of a shell menu until indicator-appmenu can handle
    the mixed shell/traditional menus itself
* New upstream release

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/html/TotemVideoList.html
1
 
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
2
 
<html>
3
 
<head>
4
 
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5
 
<title>TotemVideoList</title>
6
 
<meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7
 
<link rel="home" href="index.html" title="Totem Reference Manual">
8
 
<link rel="up" href="widget-api.html" title="Widgets">
9
 
<link rel="prev" href="widget-api.html" title="Widgets">
10
 
<link rel="next" href="TotemCellRendererVideo.html" title="TotemCellRendererVideo">
11
 
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
 
<link rel="stylesheet" href="style.css" type="text/css">
13
 
</head>
14
 
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15
 
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
16
 
<tr valign="middle">
17
 
<td><a accesskey="p" href="widget-api.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18
 
<td><a accesskey="u" href="widget-api.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19
 
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20
 
<th width="100%" align="center">Totem Reference Manual</th>
21
 
<td><a accesskey="n" href="TotemCellRendererVideo.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
22
 
</tr>
23
 
<tr><td colspan="5" class="shortcuts">
24
 
<a href="#TotemVideoList.synopsis" class="shortcut">Top</a>
25
 
                   | 
26
 
                  <a href="#TotemVideoList.description" class="shortcut">Description</a>
27
 
                   | 
28
 
                  <a href="#TotemVideoList.object-hierarchy" class="shortcut">Object Hierarchy</a>
29
 
                   | 
30
 
                  <a href="#TotemVideoList.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
31
 
                   | 
32
 
                  <a href="#TotemVideoList.properties" class="shortcut">Properties</a>
33
 
                   | 
34
 
                  <a href="#TotemVideoList.signals" class="shortcut">Signals</a>
35
 
</td></tr>
36
 
</table>
37
 
<div class="refentry">
38
 
<a name="TotemVideoList"></a><div class="titlepage"></div>
39
 
<div class="refnamediv"><table width="100%"><tr>
40
 
<td valign="top">
41
 
<h2><span class="refentrytitle"><a name="TotemVideoList.top_of_page"></a>TotemVideoList</span></h2>
42
 
<p>TotemVideoList — a <a href="http://developer.gnome.org/devel/gtk/GtkTreeView.html"><span class="type">GtkTreeView</span></a> widget for listing videos</p>
43
 
</td>
44
 
<td valign="top" align="right"></td>
45
 
</tr></table></div>
46
 
<div class="refsect1">
47
 
<a name="TotemVideoList.stability-level"></a><h2>Stability Level</h2>
48
 
Unstable, unless otherwise indicated
49
 
</div>
50
 
<div class="refsynopsisdiv">
51
 
<a name="TotemVideoList.synopsis"></a><h2>Synopsis</h2>
52
 
<pre class="synopsis">
53
 
#include &lt;totem-video-list.h&gt;
54
 
 
55
 
                    <a class="link" href="TotemVideoList.html#TotemVideoList-struct" title="TotemVideoList">TotemVideoList</a>;
56
 
                    <a class="link" href="TotemVideoList.html#TotemVideoListClass" title="TotemVideoListClass">TotemVideoListClass</a>;
57
 
<a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="returnvalue">TotemVideoList</span></a> *    <a class="link" href="TotemVideoList.html#totem-video-list-new" title="totem_video_list_new ()">totem_video_list_new</a>                (<em class="parameter"><code><span class="type">void</span></code></em>);
58
 
<a href="http://developer.gnome.org/devel/gtk/GtkUIManager.html"><span class="returnvalue">GtkUIManager</span></a> *      <a class="link" href="TotemVideoList.html#totem-video-list-get-ui-manager" title="totem_video_list_get_ui_manager ()">totem_video_list_get_ui_manager</a>     (<em class="parameter"><code><a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a> *self</code></em>);
59
 
</pre>
60
 
</div>
61
 
<div class="refsect1">
62
 
<a name="TotemVideoList.object-hierarchy"></a><h2>Object Hierarchy</h2>
63
 
<pre class="synopsis">
64
 
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
65
 
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
66
 
         +----<a href="http://developer.gnome.org/devel/gtk/GtkWidget.html">GtkWidget</a>
67
 
               +----<a href="http://developer.gnome.org/devel/gtk/GtkContainer.html">GtkContainer</a>
68
 
                     +----<a href="http://developer.gnome.org/devel/gtk/GtkTreeView.html">GtkTreeView</a>
69
 
                           +----TotemVideoList
70
 
</pre>
71
 
</div>
72
 
<div class="refsect1">
73
 
<a name="TotemVideoList.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
74
 
<p>
75
 
TotemVideoList implements
76
 
 AtkImplementorIface,  <a href="http://developer.gnome.org/devel/gtk/GtkBuildable.html">GtkBuildable</a> and  <a href="http://developer.gnome.org/devel/gtk/GtkScrollable.html">GtkScrollable</a>.</p>
77
 
</div>
78
 
<div class="refsect1">
79
 
<a name="TotemVideoList.properties"></a><h2>Properties</h2>
80
 
<pre class="synopsis">
81
 
  "<a class="link" href="TotemVideoList.html#TotemVideoList--mrl-column" title='The "mrl-column" property'>mrl-column</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
82
 
  "<a class="link" href="TotemVideoList.html#TotemVideoList--show-tooltip-uri" title='The "show-tooltip-uri" property'>show-tooltip-uri</a>"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
83
 
  "<a class="link" href="TotemVideoList.html#TotemVideoList--tooltip-column" title='The "tooltip-column" property'>tooltip-column</a>"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write
84
 
  "<a class="link" href="TotemVideoList.html#TotemVideoList--totem" title='The "totem" property'>totem</a>"                    <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>*          : Read / Write
85
 
</pre>
86
 
</div>
87
 
<div class="refsect1">
88
 
<a name="TotemVideoList.signals"></a><h2>Signals</h2>
89
 
<pre class="synopsis">
90
 
  "<a class="link" href="TotemVideoList.html#TotemVideoList-starting-video" title='The "starting-video" signal'>starting-video</a>"                                 : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a>
91
 
</pre>
92
 
</div>
93
 
<div class="refsect1">
94
 
<a name="TotemVideoList.description"></a><h2>Description</h2>
95
 
<p>
96
 
<a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a> is a <a href="http://developer.gnome.org/devel/gtk/GtkTreeView.html"><span class="type">GtkTreeView</span></a> designed for listing videos by their thumbnails using <a class="link" href="TotemCellRendererVideo.html" title="TotemCellRendererVideo"><span class="type">TotemCellRendererVideo</span></a>.
97
 
It supports tooltips, loading the videos by activating tree view rows, and <a href="http://developer.gnome.org/devel/gtk/GtkUIManager.html"><span class="type">GtkUIManager</span></a> actions in the popup menu.
98
 
</p>
99
 
<p>
100
 
Note that it requires <a class="link" href="TotemVideoList.html#TotemVideoList--totem" title='The "totem" property'><span class="type">"totem"</span></a> to be set to an instance of <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> to work.
101
 
</p>
102
 
</div>
103
 
<div class="refsect1">
104
 
<a name="TotemVideoList.details"></a><h2>Details</h2>
105
 
<div class="refsect2">
106
 
<a name="TotemVideoList-struct"></a><h3>TotemVideoList</h3>
107
 
<pre class="programlisting">typedef struct _TotemVideoList TotemVideoList;</pre>
108
 
<p>
109
 
All the fields in the <a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a> structure are private and should never be accessed directly.
110
 
</p>
111
 
</div>
112
 
<hr>
113
 
<div class="refsect2">
114
 
<a name="TotemVideoListClass"></a><h3>TotemVideoListClass</h3>
115
 
<pre class="programlisting">typedef struct {
116
 
        GtkTreeViewClass parent;
117
 
        gboolean (*starting_video) (TotemVideoList *video_list, GtkTreePath *path);
118
 
} TotemVideoListClass;
119
 
</pre>
120
 
<p>
121
 
The class structure for the <a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a> type.
122
 
</p>
123
 
<div class="variablelist"><table border="0">
124
 
<col align="left" valign="top">
125
 
<tbody>
126
 
<tr>
127
 
<td><p><span class="term"><span class="type">GtkTreeViewClass</span> <em class="structfield"><code><a name="TotemVideoListClass.parent"></a>parent</code></em>;</span></p></td>
128
 
<td>the parent class</td>
129
 
</tr>
130
 
<tr>
131
 
<td><p><span class="term"><em class="structfield"><code><a name="TotemVideoListClass.starting-video"></a>starting_video</code></em> ()</span></p></td>
132
 
<td>the generic signal handler for the <a class="link" href="TotemVideoList.html#TotemVideoList-starting-video" title='The "starting-video" signal'><span class="type">"starting-video"</span></a> signal,
133
 
which can be overridden by inheriting classes</td>
134
 
</tr>
135
 
</tbody>
136
 
</table></div>
137
 
</div>
138
 
<hr>
139
 
<div class="refsect2">
140
 
<a name="totem-video-list-new"></a><h3>totem_video_list_new ()</h3>
141
 
<pre class="programlisting"><a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="returnvalue">TotemVideoList</span></a> *    totem_video_list_new                (<em class="parameter"><code><span class="type">void</span></code></em>);</pre>
142
 
<p>
143
 
Creates a new <a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a> with default properties.
144
 
</p>
145
 
<div class="variablelist"><table border="0">
146
 
<col align="left" valign="top">
147
 
<tbody><tr>
148
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
149
 
<td>a new <a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a>
150
 
</td>
151
 
</tr></tbody>
152
 
</table></div>
153
 
</div>
154
 
<hr>
155
 
<div class="refsect2">
156
 
<a name="totem-video-list-get-ui-manager"></a><h3>totem_video_list_get_ui_manager ()</h3>
157
 
<pre class="programlisting"><a href="http://developer.gnome.org/devel/gtk/GtkUIManager.html"><span class="returnvalue">GtkUIManager</span></a> *      totem_video_list_get_ui_manager     (<em class="parameter"><code><a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a> *self</code></em>);</pre>
158
 
<p>
159
 
Returns the <a href="http://developer.gnome.org/devel/gtk/GtkUIManager.html"><span class="type">GtkUIManager</span></a> in use by <em class="parameter"><code>self</code></em>.
160
 
</p>
161
 
<div class="variablelist"><table border="0">
162
 
<col align="left" valign="top">
163
 
<tbody>
164
 
<tr>
165
 
<td><p><span class="term"><em class="parameter"><code>self</code></em> :</span></p></td>
166
 
<td>a <a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a>
167
 
</td>
168
 
</tr>
169
 
<tr>
170
 
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
171
 
<td>
172
 
<em class="parameter"><code>self</code></em>'s <a href="http://developer.gnome.org/devel/gtk/GtkUIManager.html"><span class="type">GtkUIManager</span></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
173
 
</td>
174
 
</tr>
175
 
</tbody>
176
 
</table></div>
177
 
</div>
178
 
</div>
179
 
<div class="refsect1">
180
 
<a name="TotemVideoList.property-details"></a><h2>Property Details</h2>
181
 
<div class="refsect2">
182
 
<a name="TotemVideoList--mrl-column"></a><h3>The <code class="literal">"mrl-column"</code> property</h3>
183
 
<pre class="programlisting">  "mrl-column"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
184
 
<p>
185
 
The column number of the <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> column containing MRLs of the videos in the video list.
186
 
If it's set to -1, video rows will not be activatable (e.g. by double-clicking them).
187
 
</p>
188
 
<p>Allowed values: &gt;= G_MAXULONG</p>
189
 
<p>Default value: -1</p>
190
 
</div>
191
 
<hr>
192
 
<div class="refsect2">
193
 
<a name="TotemVideoList--show-tooltip-uri"></a><h3>The <code class="literal">"show-tooltip-uri"</code> property</h3>
194
 
<pre class="programlisting">  "show-tooltip-uri"         <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
195
 
<p>
196
 
If this is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the URI of each video will be displayed in the tooltip for that video (or a message saying "No video URI" will be
197
 
displayed if the URI is unset); otherwise, the tooltip will only display the video name.
198
 
</p>
199
 
<p>Default value: TRUE</p>
200
 
<p class="since">Since 2.90.6</p>
201
 
</div>
202
 
<hr>
203
 
<div class="refsect2">
204
 
<a name="TotemVideoList--tooltip-column"></a><h3>The <code class="literal">"tooltip-column"</code> property</h3>
205
 
<pre class="programlisting">  "tooltip-column"           <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a>                  : Read / Write</pre>
206
 
<p>
207
 
The column number of the <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> column containing tooltips to be displayed by the video list.
208
 
If it's set to -1, no tooltips shall be displayed.
209
 
</p>
210
 
<p>Allowed values: &gt;= G_MAXULONG</p>
211
 
<p>Default value: -1</p>
212
 
</div>
213
 
<hr>
214
 
<div class="refsect2">
215
 
<a name="TotemVideoList--totem"></a><h3>The <code class="literal">"totem"</code> property</h3>
216
 
<pre class="programlisting">  "totem"                    <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a>*          : Read / Write</pre>
217
 
<p>
218
 
A <a class="link" href="TotemObject.html" title="TotemObject"><span class="type">TotemObject</span></a> for integration purposes.
219
 
</p>
220
 
</div>
221
 
</div>
222
 
<div class="refsect1">
223
 
<a name="TotemVideoList.signal-details"></a><h2>Signal Details</h2>
224
 
<div class="refsect2">
225
 
<a name="TotemVideoList-starting-video"></a><h3>The <code class="literal">"starting-video"</code> signal</h3>
226
 
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>            user_function                      (<a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a> *video_list,
227
 
                                                        <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a>    *tree_path,
228
 
                                                        <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a>        user_data)       : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-LAST:CAPS"><code class="literal">Run Last</code></a></pre>
229
 
<p>
230
 
The <a class="link" href="TotemVideoList.html#TotemVideoList-starting-video" title='The "starting-video" signal'><span class="type">"starting-video"</span></a> signal is emitted when a video row is activated, just before the video is
231
 
added to the playlist. It allows for the video's MRL in the <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html"><span class="type">GtkTreeModel</span></a> to be modified, for example.
232
 
</p>
233
 
<p>
234
 
If this returns <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the video will be played; otherwise, it will not.
235
 
</p>
236
 
<div class="variablelist"><table border="0">
237
 
<col align="left" valign="top">
238
 
<tbody>
239
 
<tr>
240
 
<td><p><span class="term"><em class="parameter"><code>video_list</code></em> :</span></p></td>
241
 
<td>the <a class="link" href="TotemVideoList.html" title="TotemVideoList"><span class="type">TotemVideoList</span></a> which received the signal</td>
242
 
</tr>
243
 
<tr>
244
 
<td><p><span class="term"><em class="parameter"><code>tree_path</code></em> :</span></p></td>
245
 
<td>the <a href="http://developer.gnome.org/devel/gtk/GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a> of the video row about to be played</td>
246
 
</tr>
247
 
<tr>
248
 
<td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
249
 
<td>user data set when the signal handler was connected.</td>
250
 
</tr>
251
 
</tbody>
252
 
</table></div>
253
 
</div>
254
 
</div>
255
 
<div class="refsect1">
256
 
<a name="TotemVideoList.see-also"></a><h2>See Also</h2>
257
 
<a class="link" href="TotemCellRendererVideo.html" title="TotemCellRendererVideo"><span class="type">TotemCellRendererVideo</span></a>
258
 
</div>
259
 
</div>
260
 
<div class="footer">
261
 
<hr>
262
 
          Generated by GTK-Doc V1.18</div>
263
 
</body>
264
 
</html>
 
 
b'\\ No newline at end of file'