<html><head><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"><title>STHandlerField</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-STHandler.html" title="STHandler"><link rel="next" href="streamtuner-st-handlers-api.html" title="st-handlers"><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-STHandler.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-handlers-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-handler-field-api"></a><div class="titlepage"></div><div class="refnamediv"><h2><span class="refentrytitle">STHandlerField</span></h2><p>STHandlerField — a structure for defining a stream field.</p></div><div class="refsynopsisdiv"><h2>Synopsis</h2><pre class="synopsis">
struct <a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a>;
enum <a href="streamtuner-st-handler-field-api.html#STHandlerFieldFlags">STHandlerFieldFlags</a>;
<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a>* <a href="streamtuner-st-handler-field-api.html#st-handler-field-new">st_handler_field_new</a> (int id,
const char *label,
GType type,
<a href="streamtuner-st-handler-field-api.html#STHandlerFieldFlags">STHandlerFieldFlags</a> flags);
const char* <a href="streamtuner-st-handler-field-api.html#st-handler-field-get-label">st_handler_field_get_label</a> (<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field);
GType <a href="streamtuner-st-handler-field-api.html#st-handler-field-get-type">st_handler_field_get_type</a> (<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field);
<a href="streamtuner-st-handler-field-api.html#STHandlerFieldFlags">STHandlerFieldFlags</a> <a href="streamtuner-st-handler-field-api.html#st-handler-field-get-flags">st_handler_field_get_flags</a>
(<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field);
void <a href="streamtuner-st-handler-field-api.html#st-handler-field-set-description">st_handler_field_set_description</a>
(<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field,
const char *description);
const char* <a href="streamtuner-st-handler-field-api.html#st-handler-field-get-description">st_handler_field_get_description</a>
(<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field);
</pre></div><div class="refsect1" lang="en"><a name="id2622960"></a><h2>Description</h2><p>
</p></div><div class="refsect1" lang="en"><a name="id2622969"></a><h2>Details</h2><div class="refsect2" lang="en"><a name="id2622974"></a><h3><a name="STHandlerField"></a>struct STHandlerField</h3><a class="indexterm" name="id2622983"></a><pre class="programlisting">struct STHandlerField {
int id;
STHandlerFieldPrivate *priv;
};
</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term">int <i class="structfield"><tt>id</tt></i></span></td><td>the ID passed to <a href="streamtuner-st-handler-field-api.html#st-handler-field-new"><tt class="function">st_handler_field_new()</tt></a> (read-only)
</td></tr><tr><td><span class="term">STHandlerFieldPrivate *<i class="structfield"><tt>priv</tt></i></span></td><td>
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2623112"></a><h3><a name="STHandlerFieldFlags"></a>enum STHandlerFieldFlags</h3><a class="indexterm" name="id2623121"></a><pre class="programlisting">typedef enum
{
ST_HANDLER_FIELD_VISIBLE = 1 << 0,
ST_HANDLER_FIELD_EDITABLE = 1 << 1,
ST_HANDLER_FIELD_VOLATILE = 1 << 2,
ST_HANDLER_FIELD_NO_DEDICATED_COLUMN = 1 << 3,
ST_HANDLER_FIELD_START_HIDDEN = 1 << 4
} STHandlerFieldFlags;
</pre><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><tt class="literal">ST_HANDLER_FIELD_VISIBLE</tt></span></td><td>specifies that the field should be visible
in the user interface.
</td></tr><tr><td><span class="term"><tt class="literal">ST_HANDLER_FIELD_EDITABLE</tt></span></td><td>specifies that the user may edit the field
value.
</td></tr><tr><td><span class="term"><tt class="literal">ST_HANDLER_FIELD_VOLATILE</tt></span></td><td>specifies that the field value should not
be saved to permanent storage.
</td></tr><tr><td><span class="term"><tt class="literal">ST_HANDLER_FIELD_NO_DEDICATED_COLUMN</tt></span></td><td>specifies that the field should
not have a dedicated column in the stream list.
</td></tr><tr><td><span class="term"><tt class="literal">ST_HANDLER_FIELD_START_HIDDEN</tt></span></td><td>specifies that the field should be
hidden by default.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2623211"></a><h3><a name="st-handler-field-new"></a>st_handler_field_new ()</h3><a class="indexterm" name="id2623220"></a><pre class="programlisting"><a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a>* st_handler_field_new (int id,
const char *label,
GType type,
<a href="streamtuner-st-handler-field-api.html#STHandlerFieldFlags">STHandlerFieldFlags</a> flags);</pre><p>
Creates a new <a href="streamtuner-st-handler-field-api.html#STHandlerField"><span class="type">STHandlerField</span></a>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>id</tt></i> :</span></td><td> the numeric ID of the field. Handler fields must be numbered
from 0 to n_fields - 1.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>label</tt></i> :</span></td><td> the field label.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>type</tt></i> :</span></td><td> the field type. Must be <span class="type">G_TYPE_BOOLEAN</span>, <span class="type">G_TYPE_INT</span>,
<span class="type">G_TYPE_UINT</span>, <span class="type">G_TYPE_DOUBLE</span>, <span class="type">G_TYPE_STRING</span>, or, if the
<span class="type">ST_HANDLER_FIELD_EDITABLE</span> flag is not set, <span class="type">GDK_TYPE_PIXBUF</span> or
<span class="type">G_TYPE_VALUE_ARRAY</span>.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>flags</tt></i> :</span></td><td> the field flags.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the newly created <a href="streamtuner-st-handler-field-api.html#STHandlerField"><span class="type">STHandlerField</span></a>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2623463"></a><h3><a name="st-handler-field-get-label"></a>st_handler_field_get_label ()</h3><a class="indexterm" name="id2623472"></a><pre class="programlisting">const char* st_handler_field_get_label (<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field);</pre><p>
Gets the label of <i class="parameter"><tt>field</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i> :</span></td><td> a field.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the label of <i class="parameter"><tt>field</tt></i>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2623538"></a><h3><a name="st-handler-field-get-type"></a>st_handler_field_get_type ()</h3><a class="indexterm" name="id2623546"></a><pre class="programlisting">GType st_handler_field_get_type (<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field);</pre><p>
Gets the value type of <i class="parameter"><tt>field</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i> :</span></td><td> a field.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the type of value held by <i class="parameter"><tt>field</tt></i>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2623611"></a><h3><a name="st-handler-field-get-flags"></a>st_handler_field_get_flags ()</h3><a class="indexterm" name="id2623620"></a><pre class="programlisting"><a href="streamtuner-st-handler-field-api.html#STHandlerFieldFlags">STHandlerFieldFlags</a> st_handler_field_get_flags
(<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field);</pre><p>
Gets the flags of <i class="parameter"><tt>field</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i> :</span></td><td> a field.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the flags of <i class="parameter"><tt>field</tt></i>.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2623752"></a><h3><a name="st-handler-field-set-description"></a>st_handler_field_set_description ()</h3><a class="indexterm" name="id2623765"></a><pre class="programlisting">void st_handler_field_set_description
(<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field,
const char *description);</pre><p>
Sets the description of <i class="parameter"><tt>field</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i> :</span></td><td> a field.
</td></tr><tr><td><span class="term"><i class="parameter"><tt>description</tt></i> :</span></td><td> the field description, or <tt class="literal">NULL</tt> to unset.
</td></tr></tbody></table></div></div><hr><div class="refsect2" lang="en"><a name="id2623840"></a><h3><a name="st-handler-field-get-description"></a>st_handler_field_get_description ()</h3><a class="indexterm" name="id2623852"></a><pre class="programlisting">const char* st_handler_field_get_description
(<a href="streamtuner-st-handler-field-api.html#STHandlerField">STHandlerField</a> *field);</pre><p>
Gets the description of <i class="parameter"><tt>field</tt></i>.</p><p>
</p><div class="variablelist"><table border="0"><col align="left" valign="top"><tbody><tr><td><span class="term"><i class="parameter"><tt>field</tt></i> :</span></td><td> a field.
</td></tr><tr><td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td><td> the description of <i class="parameter"><tt>field</tt></i>, or <tt class="literal">NULL</tt> if not set.
</td></tr></tbody></table></div></div></div><div class="refsect1" lang="en"><a name="id2623925"></a><h2>See Also</h2><p>
<a href="streamtuner-STHandler.html#STHandler"><span class="type">STHandler</span></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-STHandler.html"><b><< STHandler</b></a></td><td align="right"><a accesskey="n" href="streamtuner-st-handlers-api.html"><b>st-handlers >></b></a></td></tr></table></body></html>
distrib
>
Mandriva
>
2010.0
>
i586
>
media
>
contrib-release
>
by-pkgid
>
637cf4b2d824870083c0ced7cd6a354e
>
files
>
47
