← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/totem/oneiric-updates

« back to all changes in this revision

Viewing changes to docs/reference/xml/totem-cell-renderer-video.xml

Tags: 2.26.2-1
New upstream bugfix release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/xml/totem-cell-renderer-video.xml
 
1
<?xml version="1.0"?>
 
2
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
 
3
        <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
 
4
        <!ENTITY version SYSTEM "version.xml">
 
5
        <!ENTITY slash "/">
 
6
]>
 
7
<refentry id="TotemCellRendererVideo">
 
8
<refmeta>
 
9
<refentrytitle role="top_of_page" id="TotemCellRendererVideo.top_of_page">TotemCellRendererVideo</refentrytitle>
 
10
<manvolnum>3</manvolnum>
 
11
<refmiscinfo>TOTEM Library</refmiscinfo>
 
12
</refmeta>
 
13
 
 
14
<refnamediv>
 
15
<refname>TotemCellRendererVideo</refname>
 
16
<refpurpose>a <link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link> widget for listing videos</refpurpose>
 
17
</refnamediv>
 
18
<refsect1 id="TotemCellRendererVideo.stability-level">
 
19
<title>Stability Level</title>
 
20
Unstable, unless otherwise indicated
 
21
</refsect1>
 
22
 
 
23
<refsynopsisdiv id="TotemCellRendererVideo.synopsis" role="synopsis">
 
24
<title role="synopsis.title">Synopsis</title>
 
25
 
 
26
<synopsis>
 
27
 
 
28
#include &lt;totem-cell-renderer-video.h&gt;
 
29
 
 
30
                    <link linkend="TotemCellRendererVideo-struct">TotemCellRendererVideo</link>;
 
31
                    <link linkend="TotemCellRendererVideoClass">TotemCellRendererVideoClass</link>;
 
32
<link linkend="TotemCellRendererVideo">TotemCellRendererVideo</link> * <link linkend="totem-cell-renderer-video-new">totem_cell_renderer_video_new</link>  (<link linkend="gboolean">gboolean</link> use_placeholder);
 
33
</synopsis>
 
34
</refsynopsisdiv>
 
35
 
 
36
<refsect1 id="TotemCellRendererVideo.object-hierarchy" role="object_hierarchy">
 
37
<title role="object_hierarchy.title">Object Hierarchy</title>
 
38
<synopsis>
 
39
  <link linkend="GObject">GObject</link>
 
40
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
41
         +----<link linkend="GtkObject">GtkObject</link>
 
42
               +----<link linkend="GtkCellRenderer">GtkCellRenderer</link>
 
43
                     +----TotemCellRendererVideo
 
44
</synopsis>
 
45
</refsect1>
 
46
 
 
47
 
 
48
 
 
49
 
 
50
 
 
51
<refsect1 id="TotemCellRendererVideo.properties" role="properties">
 
52
<title role="properties.title">Properties</title>
 
53
<synopsis>
 
54
  &quot;<link linkend="TotemCellRendererVideo--alignment">alignment</link>&quot;                <link linkend="PangoAlignment">PangoAlignment</link>        : Read / Write
 
55
  &quot;<link linkend="TotemCellRendererVideo--thumbnail">thumbnail</link>&quot;                <link linkend="GdkPixbuf">GdkPixbuf</link>*            : Read / Write
 
56
  &quot;<link linkend="TotemCellRendererVideo--title">title</link>&quot;                    <link linkend="gchar">gchar</link>*                : Read / Write
 
57
  &quot;<link linkend="TotemCellRendererVideo--use-placeholder">use-placeholder</link>&quot;          <link linkend="gboolean">gboolean</link>              : Read / Write
 
58
</synopsis>
 
59
</refsect1>
 
60
 
 
61
 
 
62
 
 
63
<refsect1 id="TotemCellRendererVideo.description" role="desc">
 
64
<title role="desc.title">Description</title>
 
65
<para>
 
66
<link linkend="TotemCellRendererVideo"><type>TotemCellRendererVideo</type></link> is a <link linkend="GtkCellRenderer"><type>GtkCellRenderer</type></link> for rendering video thumbnails, typically in a <link linkend="TotemVideoList"><type>TotemVideoList</type></link>.
 
67
It supports drawing a video thumbnail, and the video's title underneath.</para>
 
68
<para>
 
69
</para>
 
70
</refsect1>
 
71
 
 
72
<refsect1 id="TotemCellRendererVideo.details" role="details">
 
73
<title role="details.title">Details</title>
 
74
<refsect2 id="TotemCellRendererVideo-struct" role="struct">
 
75
<title>TotemCellRendererVideo</title>
 
76
<indexterm zone="TotemCellRendererVideo-struct"><primary sortas="CellRendererVideo">TotemCellRendererVideo</primary></indexterm><programlisting>typedef struct _TotemCellRendererVideo TotemCellRendererVideo;</programlisting>
 
77
<para>
 
78
All the fields in the <link linkend="TotemCellRendererVideo"><type>TotemCellRendererVideo</type></link> structure are private and should never be accessed directly.</para>
 
79
<para>
 
80
</para></refsect2>
 
81
<refsect2 id="TotemCellRendererVideoClass" role="struct">
 
82
<title>TotemCellRendererVideoClass</title>
 
83
<indexterm zone="TotemCellRendererVideoClass"><primary sortas="CellRendererVideoClass">TotemCellRendererVideoClass</primary></indexterm><programlisting>typedef struct {
 
84
        GtkCellRendererClass parent;
 
85
} TotemCellRendererVideoClass;
 
86
</programlisting>
 
87
<para>
 
88
The class structure for the <link linkend="TotemCellRendererVideo"><type>TotemCellRendererVideo</type></link> type.</para>
 
89
<para>
 
90
</para><variablelist role="struct">
 
91
<varlistentry>
 
92
<term><link linkend="GtkCellRendererClass">GtkCellRendererClass</link>&#160;<structfield>parent</structfield>;</term>
 
93
<listitem><simpara> the parent class
 
94
</simpara></listitem>
 
95
</varlistentry>
 
96
</variablelist></refsect2>
 
97
<refsect2 id="totem-cell-renderer-video-new" role="function">
 
98
<title>totem_cell_renderer_video_new ()</title>
 
99
<indexterm zone="totem-cell-renderer-video-new"><primary sortas="cell_renderer_video_new">totem_cell_renderer_video_new</primary></indexterm><programlisting><link linkend="TotemCellRendererVideo">TotemCellRendererVideo</link> * totem_cell_renderer_video_new  (<link linkend="gboolean">gboolean</link> use_placeholder);</programlisting>
 
100
<para>
 
101
Creates a new <link linkend="TotemCellRendererVideo"><type>TotemCellRendererVideo</type></link> with its <link linkend="TotemCellRendererVideo--use-placeholder"><type>"use-placeholder"</type></link>
 
102
property set to <parameter>use_placeholder</parameter>. If <parameter>use_placeholder</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>,
 
103
the renderer will display a generic placeholder thumbnail if a
 
104
proper one is not available.</para>
 
105
<para>
 
106
</para><variablelist role="params">
 
107
<varlistentry><term><parameter>use_placeholder</parameter>&#160;:</term>
 
108
<listitem><simpara> if <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, use a placeholder thumbnail
 
109
</simpara></listitem></varlistentry>
 
110
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a new <link linkend="TotemCellRendererVideo"><type>TotemCellRendererVideo</type></link>
 
111
</simpara></listitem></varlistentry>
 
112
</variablelist></refsect2>
 
113
 
 
114
</refsect1>
 
115
<refsect1 id="TotemCellRendererVideo.property-details" role="property_details">
 
116
<title role="property_details.title">Property Details</title>
 
117
<refsect2 id="TotemCellRendererVideo--alignment" role="property"><title>The <literal>&quot;alignment&quot;</literal> property</title>
 
118
<indexterm zone="TotemCellRendererVideo--alignment"><primary sortas="CellRendererVideo:alignment">TotemCellRendererVideo:alignment</primary></indexterm><programlisting>  &quot;alignment&quot;                <link linkend="PangoAlignment">PangoAlignment</link>        : Read / Write</programlisting>
 
119
<para>
 
120
A <link linkend="PangoAlignment"><type>PangoAlignment</type></link> giving the text alignment for the video title.</para>
 
121
<para>
 
122
</para><para>Default value: PANGO_ALIGN_CENTER</para>
 
123
</refsect2>
 
124
<refsect2 id="TotemCellRendererVideo--thumbnail" role="property"><title>The <literal>&quot;thumbnail&quot;</literal> property</title>
 
125
<indexterm zone="TotemCellRendererVideo--thumbnail"><primary sortas="CellRendererVideo:thumbnail">TotemCellRendererVideo:thumbnail</primary></indexterm><programlisting>  &quot;thumbnail&quot;                <link linkend="GdkPixbuf">GdkPixbuf</link>*            : Read / Write</programlisting>
 
126
<para>
 
127
A <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> of a thumbnail of the video to display. When rendered, it will scale to the width of the parent <link linkend="GtkTreeView"><type>GtkTreeView</type></link>,
 
128
so can be as large as reasonable.</para>
 
129
<para>
 
130
</para></refsect2>
 
131
<refsect2 id="TotemCellRendererVideo--title" role="property"><title>The <literal>&quot;title&quot;</literal> property</title>
 
132
<indexterm zone="TotemCellRendererVideo--title"><primary sortas="CellRendererVideo:title">TotemCellRendererVideo:title</primary></indexterm><programlisting>  &quot;title&quot;                    <link linkend="gchar">gchar</link>*                : Read / Write</programlisting>
 
133
<para>
 
134
The title of the video, as it should be displayed.</para>
 
135
<para>
 
136
</para><para>Default value: "Unknown video"</para>
 
137
</refsect2>
 
138
<refsect2 id="TotemCellRendererVideo--use-placeholder" role="property"><title>The <literal>&quot;use-placeholder&quot;</literal> property</title>
 
139
<indexterm zone="TotemCellRendererVideo--use-placeholder"><primary sortas="CellRendererVideo:use-placeholder">TotemCellRendererVideo:use-placeholder</primary></indexterm><programlisting>  &quot;use-placeholder&quot;          <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
140
<para>
 
141
If <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, a placeholder image should be used for the video thumbnail if a <link linkend="TotemCellRendererVideo--thumbnail"><type>"thumbnail"</type></link> isn't provided.</para>
 
142
<para>
 
143
</para><para>Default value: FALSE</para>
 
144
</refsect2>
 
145
</refsect1>
 
146
 
 
147
 
 
148
 
 
149
<refsect1 id="TotemCellRendererVideo.see-also">
 
150
<title>See Also</title>
 
151
<link linkend="TotemVideoList"><type>TotemVideoList</type></link>
 
152
</refsect1>
 
153
 
 
154
</refentry>