1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
|
<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>STCategory</title><meta name="generator" content="DocBook XSL Stylesheets V1.66.1"><link rel="start" href="index.html" title="streamtuner Developers Manual"><link rel="up" href="api-reference.html" title="API Reference"><link rel="prev" href="streamtuner-st-action-api.html" title="st-action"><link rel="next" href="streamtuner-st-dialog-api.html" title="st-dialog"><meta name="generator" content="GTK-Doc V1.2 (XML mode)"><style type="text/css">
.synopsis, .classsynopsis {
background: #eeeeee;
border: solid 1px #aaaaaa;
padding: 0.5em;
}
.programlisting {
background: #feffde;
border: solid 1px #e9ed1c;
padding: 0.5em;
}
.variablelist {
padding: 4px;
margin-left: 3em;
}
.navigation {
background: #daffd1;
border: solid 1px #74ff54;
margin-top: 0.5em;
margin-bottom: 0.5em;
}
.navigation a {
color: #2fba0f;
}
.navigation a:visited {
color: #22850b;
}
.navigation .title {
font-size: 200%;
}
</style></head><body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><table class="navigation" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2"><tr valign="middle"><td><a accesskey="p" href="streamtuner-st-action-api.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td><td><a accesskey="u" href="api-reference.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td><td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td><th width="100%" align="center">streamtuner Developers Manual</th><td><a accesskey="n" href="streamtuner-st-dialog-api.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td></tr></table><div class="refentry" lang="en"><a name="streamtuner-st-category-api"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">STCategory</span></h2><p>STCategory — a structure for defining a category.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
struct <a href="streamtuner-st-category-api.html#STCategory">STCategory</a>;
gboolean (<a href="streamtuner-st-category-api.html#STCategoryURLCallback">*STCategoryURLCallback</a>) (<a href="streamtuner-st-category-api.html#STCategory">STCategory</a> *category);
<a href="streamtuner-st-category-api.html#STCategory">STCategory</a>* <a href="streamtuner-st-category-api.html#st-category-new">st_category_new</a> (void);
void <a href="streamtuner-st-category-api.html#st-category-free">st_category_free</a> (<a href="streamtuner-st-category-api.html#STCategory">STCategory</a> *category);
</pre></div><div class="refsect1" lang="en"><a name="id2597883"></a><h2>Description</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2598234"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2598240"></a><h3><a name="STCategory"></a>struct STCategory</h3><a class="indexterm" name="id2598248"></a><pre class="programlisting">struct STCategory {
char *name;
char *label;
char *url_postfix;
STCategoryURLCallback url_cb;
};
</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term">char *<i class="structfield"><tt>name</tt></i></span></td><td>the category internal name.
</td></tr><tr><td><span class="term">char *<i class="structfield"><tt>label</tt></i></span></td><td>the category human-readable name.
</td></tr><tr><td><span class="term">char *<i class="structfield"><tt>url_postfix</tt></i></span></td><td>the category URL postfix.
</td></tr><tr><td><span class="term"><a href="streamtuner-st-category-api.html#STCategoryURLCallback">STCategoryURLCallback</a> <i class="structfield"><tt>url_cb</tt></i></span></td><td>a function which will be called when the category is about to
be reloaded.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598336"></a><h3><a name="STCategoryURLCallback"></a>STCategoryURLCallback ()</h3><a class="indexterm" name="id2598344"></a><pre class="programlisting">gboolean (*STCategoryURLCallback) (<a href="streamtuner-st-category-api.html#STCategory">STCategory</a> *category);</pre><p>
Specifies the type of function to be stored in the
<i class="structfield"><tt>url_cb</tt></i> member of the <a href="streamtuner-st-category-api.html#STCategory"><span class="type">STCategory</span></a>
structure. The function will be called before reloading <i class="parameter"><tt>category</tt></i>,
and may update its <i class="structfield"><tt>label</tt></i> and
<i class="structfield"><tt>url_postfix</tt></i> members.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i>:</span></td><td> the category which is about to be reloaded.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the function should return <tt class="literal">FALSE</tt> if the reload
should be cancelled.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598498"></a><h3><a name="st-category-new"></a>st_category_new ()</h3><a class="indexterm" name="id2598506"></a><pre class="programlisting"><a href="streamtuner-st-category-api.html#STCategory">STCategory</a>* st_category_new (void);</pre><p>
Creates a new <a href="streamtuner-st-category-api.html#STCategory"><span class="type">STCategory</span></a>. The structure members are initialized to
<tt class="literal">NULL</tt>, and at least the <i class="structfield"><tt>name</tt></i> and
<i class="structfield"><tt>label</tt></i> members must be filled manually.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> a new <a href="streamtuner-st-category-api.html#STCategory"><span class="type">STCategory</span></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2598569"></a><h3><a name="st-category-free"></a>st_category_free ()</h3><a class="indexterm" name="id2598578"></a><pre class="programlisting">void st_category_free (<a href="streamtuner-st-category-api.html#STCategory">STCategory</a> *category);</pre><p>
Destroys <i class="parameter"><tt>category</tt></i> (<tt class="function">g_free()</tt> will be called on the
<i class="structfield"><tt>name</tt></i>, <i class="structfield"><tt>label</tt></i>
and <i class="structfield"><tt>url_postfix</tt></i> members).</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>category</tt></i>:</span></td><td> the <a href="streamtuner-st-category-api.html#STCategory"><span class="type">STCategory</span></a> to destroy.
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2598653"></a><h2>See Also</h2><p>
<a href="streamtuner-STHandler.html#STHandlerEvent"><span class="type">STHandlerEvent</span></a>, <a href="streamtuner-STHandler.html#st-handler-set-stock-categories"><tt class="function">st_handler_set_stock_categories()</tt></a>
</p></div></div><table class="navigation" width="100%" summary="Navigation footer" cellpadding="2" cellspacing="0"><tr valign="middle"><td align="left"><a accesskey="p" href="streamtuner-st-action-api.html"><b><<st-action</b></a></td><td align="right"><a accesskey="n" href="streamtuner-st-dialog-api.html"><b>st-dialog>></b></a></td></tr></table></body></html>
|
