← Back to branch summary

~ubuntu-branches/ubuntu/raring/rygel/raring

« back to all changes in this revision

Viewing changes to doc/reference/librygel-server/gtkdoc/xml/rygel-search-expression.xml

  • Committer: Package Import Robot
  • Author(s): Andreas Henriksson
  • Date: 2012-09-26 22:34:15 UTC
  • mfrom: (1.3.2)
  • mto: (14.1.10 sid)
  • mto: This revision was merged to the branch mainline in revision 27.
  • Revision ID: package-import@ubuntu.com-20120926223415-mem27auv86jjrj9k
Imported Upstream version 0.16.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/librygel-server/gtkdoc/xml/rygel-search-expression.xml
4
4
[
5
5
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">
6
6
]>
7
 
<refentry id="librygel-server-RygelSearchExpression">
 
7
<refentry id="RygelSearchExpression">
8
8
<refmeta>
9
 
<refentrytitle role="top_of_page" id="librygel-server-RygelSearchExpression.top_of_page">RygelSearchExpression</refentrytitle>
 
9
<refentrytitle role="top_of_page" id="RygelSearchExpression.top_of_page">RygelSearchExpression</refentrytitle>
10
10
<manvolnum>3</manvolnum>
11
11
<refmiscinfo>
12
12
  LIBRYGEL-SERVER Library
17
17
<refpurpose>Represents a SearchExpression tree.</refpurpose>
18
18
</refnamediv>
19
19
 
20
 
<refsynopsisdiv id="librygel-server-RygelSearchExpression.synopsis" role="synopsis">
 
20
<refsynopsisdiv id="RygelSearchExpression.synopsis" role="synopsis">
21
21
<title role="synopsis.title">Synopsis</title>
22
22
 
23
23
<synopsis>#define             <link linkend="RYGEL-TYPE-SEARCH-EXPRESSION:CAPS">RYGEL_TYPE_SEARCH_EXPRESSION</link>
25
25
                                                        (<parameter><link linkend="RygelSearchExpression"><type>RygelSearchExpression</type></link> *self</parameter>,
26
26
                                                         <parameter><link linkend="RygelMediaObject"><type>RygelMediaObject</type></link> *media_object</parameter>);
27
27
<link linkend="gchar"><returnvalue>gchar</returnvalue></link> *             <link linkend="rygel-search-expression-to-string">rygel_search_expression_to_string</link>   (<parameter><link linkend="RygelSearchExpression"><type>RygelSearchExpression</type></link> *self</parameter>);
28
 
struct              <link linkend="RygelSearchExpression">RygelSearchExpression</link>;
 
28
struct              <link linkend="RygelSearchExpression-struct">RygelSearchExpression</link>;
29
29
<link linkend="gpointer"><returnvalue>gpointer</returnvalue></link>            <link linkend="rygel-search-expression-ref">rygel_search_expression_ref</link>         (<parameter><link linkend="gpointer"><type>gpointer</type></link> instance</parameter>);
30
30
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="rygel-search-expression-unref">rygel_search_expression_unref</link>       (<parameter><link linkend="gpointer"><type>gpointer</type></link> instance</parameter>);
31
31
<link linkend="GParamSpec"><returnvalue>GParamSpec</returnvalue></link> *        <link linkend="rygel-param-spec-search-expression">rygel_param_spec_search_expression</link>  (<parameter>const <link linkend="gchar"><type>gchar</type></link> *name</parameter>,
38
38
<link linkend="gpointer"><returnvalue>gpointer</returnvalue></link>            <link linkend="rygel-value-get-search-expression">rygel_value_get_search_expression</link>   (<parameter>const <link linkend="GValue"><type>GValue</type></link> *value</parameter>);
39
39
<link linkend="void"><returnvalue>void</returnvalue></link>                <link linkend="rygel-value-take-search-expression">rygel_value_take_search_expression</link>  (<parameter><link linkend="GValue"><type>GValue</type></link> *value</parameter>,
40
40
                                                         <parameter><link linkend="gpointer"><type>gpointer</type></link> v_object</parameter>);
 
41
struct              <link linkend="RygelSearchExpressionClass">RygelSearchExpressionClass</link>;
41
42
</synopsis>
42
43
</refsynopsisdiv>
 
44
<refsect1 id="RygelSearchExpression.object-hierarchy" role="object_hierarchy">
 
45
<title role="object_hierarchy.title">Object Hierarchy</title>
 
46
<synopsis>
 
47
  RygelSearchExpression
 
48
   +----<link linkend="RygelLogicalExpression">RygelLogicalExpression</link>
 
49
   +----<link linkend="RygelRelationalExpression">RygelRelationalExpression</link>
 
50
</synopsis>
 
51
</refsect1>
43
52
 
44
 
<refsect1 id="librygel-server-RygelSearchExpression.description" role="desc">
 
53
<refsect1 id="RygelSearchExpression.description" role="desc">
45
54
<title role="desc.title">Description</title>
46
55
 
47
56
</refsect1>
48
 
<refsect1 id="librygel-server-RygelSearchExpression.details" role="details">
 
57
<refsect1 id="RygelSearchExpression.details" role="details">
49
58
<title role="details.title">Details</title>
50
59
<refsect2 id="RYGEL-TYPE-SEARCH-EXPRESSION:CAPS" role="macro">
51
60
<title>RYGEL_TYPE_SEARCH_EXPRESSION</title>
73
82
<varlistentry><term><parameter>self</parameter>&#160;:</term>
74
83
<listitem><simpara>the <link linkend="RygelSearchExpression"><type>RygelSearchExpression</type></link> instance</simpara></listitem></varlistentry>
75
84
</variablelist></refsect2>
76
 
<refsect2 id="RygelSearchExpression" role="struct">
 
85
<refsect2 id="RygelSearchExpression-struct" role="struct">
77
86
<title>struct RygelSearchExpression</title>
78
 
<indexterm zone="RygelSearchExpression"><primary>RygelSearchExpression</primary></indexterm>
79
 
<programlisting>struct RygelSearchExpression {
80
 
        GTypeInstance parent_instance;
81
 
        volatile int ref_count;
82
 
        RygelSearchExpressionPrivate * priv;
83
 
        gpointer op;
84
 
        gpointer operand1;
85
 
        gpointer operand2;
86
 
};
87
 
</programlisting>
 
87
<indexterm zone="RygelSearchExpression-struct"><primary>RygelSearchExpression</primary></indexterm>
 
88
<programlisting>struct RygelSearchExpression;</programlisting>
88
89
<para>
89
90
Represents a SearchExpression tree.
90
91
</para></refsect2>
180
181
<varlistentry><term><parameter>v_object</parameter>&#160;:</term>
181
182
<listitem><simpara>object value to be set</simpara></listitem></varlistentry>
182
183
</variablelist></refsect2>
 
184
<refsect2 id="RygelSearchExpressionClass" role="struct">
 
185
<title>struct RygelSearchExpressionClass</title>
 
186
<indexterm zone="RygelSearchExpressionClass"><primary>RygelSearchExpressionClass</primary></indexterm>
 
187
<programlisting>struct RygelSearchExpressionClass {
 
188
        GTypeClass parent_class;
 
189
        void (*finalize) (RygelSearchExpression *self);
 
190
        gboolean (*satisfied_by) (RygelSearchExpression* self, RygelMediaObject* media_object);
 
191
        gchar* (*to_string) (RygelSearchExpression* self);
 
192
};
 
193
</programlisting>
 
194
<para>
 
195
The class structure for <link linkend="RYGEL-TYPE-SEARCH-EXPRESSION:CAPS"><literal>RYGEL_TYPE_SEARCH_EXPRESSION</literal></link>. All the fields in this structure are private and should never be accessed directly.
 
196
</para><variablelist role="struct">
 
197
<varlistentry><term><link linkend="GTypeClass"><type>GTypeClass</type></link>&#160;<structfield id="RygelSearchExpressionClass.parent-class">parent_class</structfield>;</term>
 
198
<listitem><simpara>the parent class structure</simpara></listitem>
 
199
</varlistentry>
 
200
<varlistentry><term><structfield id="RygelSearchExpressionClass.finalize">finalize</structfield>&#160;()</term>
 
201
<listitem />
 
202
</varlistentry>
 
203
<varlistentry><term><structfield id="RygelSearchExpressionClass.satisfied-by">satisfied_by</structfield>&#160;()</term>
 
204
<listitem><simpara>virtual method called by <link linkend="rygel-search-expression-satisfied-by"><function><link linkend="rygel-search-expression-satisfied-by"><function>rygel_search_expression_satisfied_by()</function></link></function></link></simpara></listitem>
 
205
</varlistentry>
 
206
<varlistentry><term><structfield id="RygelSearchExpressionClass.to-string">to_string</structfield>&#160;()</term>
 
207
<listitem><simpara>virtual method called by <link linkend="rygel-search-expression-to-string"><function><link linkend="rygel-search-expression-to-string"><function>rygel_search_expression_to_string()</function></link></function></link></simpara></listitem>
 
208
</varlistentry>
 
209
</variablelist></refsect2>
183
210
 
184
211
</refsect1>
185
212