← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/rhythmbox/oneiric

« back to all changes in this revision

Viewing changes to doc/reference/html/RBRandomPlayOrder.html

  • Committer: Bazaar Package Importer
  • Author(s): Rico Tzschichholz
  • Date: 2011-07-29 16:41:38 UTC
  • mto: This revision was merged to the branch mainline in revision 191.
  • Revision ID: james.westby@ubuntu.com-20110729164138-wwicy8nqalm18ck7
Tags: upstream-2.90.1~20110802
Import upstream version 2.90.1~20110802

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/html/RBRandomPlayOrder.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>RBRandomPlayOrder</title>
 
6
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
 
7
<link rel="home" href="index.html" title="Rhythmbox Development Reference Manual">
 
8
<link rel="up" href="ch05.html" title="Shell">
 
9
<link rel="prev" href="RBPlayOrder.html" title="RBPlayOrder">
 
10
<link rel="next" href="RBPlaylistManager.html" title="RBPlaylistManager">
 
11
<meta name="generator" content="GTK-Doc V1.17 (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="RBPlayOrder.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
 
18
<td><a accesskey="u" href="ch05.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">Rhythmbox Development Reference Manual</th>
 
21
<td><a accesskey="n" href="RBPlaylistManager.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="#RBRandomPlayOrder.synopsis" class="shortcut">Top</a>
 
25
                   | 
 
26
                  <a href="#RBRandomPlayOrder.description" class="shortcut">Description</a>
 
27
                   | 
 
28
                  <a href="#RBRandomPlayOrder.object-hierarchy" class="shortcut">Object Hierarchy</a>
 
29
</td></tr>
 
30
</table>
 
31
<div class="refentry">
 
32
<a name="RBRandomPlayOrder"></a><div class="titlepage"></div>
 
33
<div class="refnamediv"><table width="100%"><tr>
 
34
<td valign="top">
 
35
<h2><span class="refentrytitle"><a name="RBRandomPlayOrder.top_of_page"></a>RBRandomPlayOrder</span></h2>
 
36
<p>RBRandomPlayOrder — base class for weighted random play orders</p>
 
37
</td>
 
38
<td valign="top" align="right"></td>
 
39
</tr></table></div>
 
40
<div class="refsynopsisdiv">
 
41
<a name="RBRandomPlayOrder.synopsis"></a><h2>Synopsis</h2>
 
42
<pre class="synopsis">struct              <a class="link" href="RBRandomPlayOrder.html#RBRandomPlayOrder-struct" title="struct RBRandomPlayOrder">RBRandomPlayOrder</a>;
 
43
struct              <a class="link" href="RBRandomPlayOrder.html#RBRandomPlayOrderClass" title="struct RBRandomPlayOrderClass">RBRandomPlayOrderClass</a>;
 
44
</pre>
 
45
</div>
 
46
<div class="refsect1">
 
47
<a name="RBRandomPlayOrder.object-hierarchy"></a><h2>Object Hierarchy</h2>
 
48
<pre class="synopsis">
 
49
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
50
   +----<a class="link" href="RBPlayOrder.html" title="RBPlayOrder">RBPlayOrder</a>
 
51
         +----RBRandomPlayOrder
 
52
</pre>
 
53
</div>
 
54
<div class="refsect1">
 
55
<a name="RBRandomPlayOrder.description"></a><h2>Description</h2>
 
56
<p>
 
57
Subclasses only need to override <code class="function">get_entry_weight()</code> to return the
 
58
right weight for a given entry.
 
59
</p>
 
60
<p>
 
61
This class also delays committing any changes until the user moves to the
 
62
next or previous song. So if the user changes the entry-view to contain
 
63
different songs, but changes it back before the current song finishes, they
 
64
will not see any changes to their history of played songs.
 
65
</p>
 
66
</div>
 
67
<div class="refsect1">
 
68
<a name="RBRandomPlayOrder.details"></a><h2>Details</h2>
 
69
<div class="refsect2">
 
70
<a name="RBRandomPlayOrder-struct"></a><h3>struct RBRandomPlayOrder</h3>
 
71
<pre class="programlisting">struct RBRandomPlayOrder;</pre>
 
72
<p>
 
73
</p>
 
74
</div>
 
75
<hr>
 
76
<div class="refsect2">
 
77
<a name="RBRandomPlayOrderClass"></a><h3>struct RBRandomPlayOrderClass</h3>
 
78
<pre class="programlisting">struct RBRandomPlayOrderClass {
 
79
        RBPlayOrderClass parent_class;
 
80
 
 
81
        /**
 
82
         * get_entry_weight:
 
83
         * @rorder: the play order
 
84
         * @db: the #RhythmDB
 
85
         * @entry: the #RhythmDBEntry to weight
 
86
         *
 
87
         * This method should return a weight for the given @entry.
 
88
         *
 
89
         * Return value: weighting for @entry
 
90
         */
 
91
        double (*get_entry_weight) (RBRandomPlayOrder *rorder, RhythmDB *db, RhythmDBEntry *entry);
 
92
};
 
93
</pre>
 
94
<p>
 
95
</p>
 
96
</div>
 
97
</div>
 
98
</div>
 
99
<div class="footer">
 
100
<hr>
 
101
          Generated by GTK-Doc V1.17</div>
 
102
</body>
 
103
</html>
 
 
b'\\ No newline at end of file'