← Back to branch summary

~timo-jyrinki/ubuntu/utopic/rhythmbox/enable_grilo_rhythmbox

« back to all changes in this revision

Viewing changes to doc/reference/xml/rb-query-creator.xml

Tags: upstream-0.11.99.1
Import upstream version 0.11.99.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/reference/xml/rb-query-creator.xml
11
11
<refnamediv>
12
12
<refname>RBQueryCreator</refname>
13
13
<refpurpose>database query creator widget</refpurpose>
14
 
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
15
14
</refnamediv>
16
15
 
17
16
<refsynopsisdiv id="RBQueryCreator.synopsis" role="synopsis">
20
19
<synopsis>
21
20
                    <link linkend="RBQueryCreator-struct">RBQueryCreator</link>;
22
21
                    <link linkend="RBQueryCreatorClass">RBQueryCreatorClass</link>;
23
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="rb-query-creator-new">rb_query_creator_new</link>                (<link linkend="RhythmDB">RhythmDB</link> *db);
24
 
<link linkend="GtkWidget">GtkWidget</link>*          <link linkend="rb-query-creator-new-from-query">rb_query_creator_new_from_query</link>     (<link linkend="RhythmDB">RhythmDB</link> *db,
 
22
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="rb-query-creator-new">rb_query_creator_new</link>                (<link linkend="RhythmDB">RhythmDB</link> *db);
 
23
<link linkend="GtkWidget">GtkWidget</link> *         <link linkend="rb-query-creator-new-from-query">rb_query_creator_new_from_query</link>     (<link linkend="RhythmDB">RhythmDB</link> *db,
25
24
                                                         <link linkend="GPtrArray">GPtrArray</link> *query,
26
25
                                                         <link linkend="RhythmDBQueryModelLimitType">RhythmDBQueryModelLimitType</link> limit_type,
27
26
                                                         <link linkend="GValueArray">GValueArray</link> *limit_value,
28
27
                                                         const <link linkend="char">char</link> *sort_column,
29
28
                                                         <link linkend="gint">gint</link> sort_direction);
30
 
<link linkend="GPtrArray">GPtrArray</link>*          <link linkend="rb-query-creator-get-query">rb_query_creator_get_query</link>          (<link linkend="RBQueryCreator">RBQueryCreator</link> *creator);
 
29
<link linkend="GPtrArray">GPtrArray</link> *         <link linkend="rb-query-creator-get-query">rb_query_creator_get_query</link>          (<link linkend="RBQueryCreator">RBQueryCreator</link> *creator);
31
30
<link linkend="void">void</link>                <link linkend="rb-query-creator-get-limit">rb_query_creator_get_limit</link>          (<link linkend="RBQueryCreator">RBQueryCreator</link> *creator,
32
31
                                                         <link linkend="RhythmDBQueryModelLimitType">RhythmDBQueryModelLimitType</link> *type,
33
32
                                                         <link linkend="GValueArray">GValueArray</link> **limit);
50
49
                                       +----<link linkend="GtkDialog">GtkDialog</link>
51
50
                                             +----RBQueryCreator
52
51
</synopsis>
53
 
 
54
52
</refsect1>
55
53
 
56
54
 
60
58
<para>
61
59
RBQueryCreator implements
62
60
 <link linkend="AtkImplementorIface">AtkImplementorIface</link> and  <link linkend="GtkBuildable">GtkBuildable</link>.</para>
63
 
 
64
61
</refsect1>
65
62
 
66
63
 
92
89
The structure of the query creator is defined in the glade file 
93
90
create-playlist.xml.</para>
94
91
<para>
95
 
 
96
92
</para>
97
93
</refsect1>
98
94
 
100
96
<title role="details.title">Details</title>
101
97
<refsect2 id="RBQueryCreator-struct" role="struct">
102
98
<title>RBQueryCreator</title>
103
 
<indexterm zone="RBQueryCreator-struct"><primary>RBQueryCreator</primary></indexterm><programlisting>typedef struct _RBQueryCreator RBQueryCreator;</programlisting>
 
99
<indexterm zone="RBQueryCreator-struct"><primary sortas="RBQueryCreator">RBQueryCreator</primary></indexterm><programlisting>typedef struct _RBQueryCreator RBQueryCreator;</programlisting>
104
100
<para>
105
 
 
106
101
</para></refsect2>
107
102
<refsect2 id="RBQueryCreatorClass" role="struct">
108
103
<title>RBQueryCreatorClass</title>
109
 
<indexterm zone="RBQueryCreatorClass"><primary>RBQueryCreatorClass</primary></indexterm><programlisting>typedef struct {
 
104
<indexterm zone="RBQueryCreatorClass"><primary sortas="RBQueryCreatorClass">RBQueryCreatorClass</primary></indexterm><programlisting>typedef struct {
110
105
        GtkDialogClass parent_class;
111
106
} RBQueryCreatorClass;
112
107
</programlisting>
113
108
<para>
114
 
 
115
109
</para></refsect2>
116
110
<refsect2 id="rb-query-creator-new" role="function">
117
111
<title>rb_query_creator_new ()</title>
118
 
<indexterm zone="rb-query-creator-new"><primary>rb_query_creator_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          rb_query_creator_new                (<link linkend="RhythmDB">RhythmDB</link> *db);</programlisting>
 
112
<indexterm zone="rb-query-creator-new"><primary sortas="rb_query_creator_new">rb_query_creator_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         rb_query_creator_new                (<link linkend="RhythmDB">RhythmDB</link> *db);</programlisting>
119
113
<para>
120
114
</para>
121
115
<para>
122
 
 
123
116
</para><variablelist role="params">
124
 
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
 
117
<varlistentry><term><parameter>db</parameter>&#160;:</term>
125
118
<listitem><simpara> the <link linkend="RhythmDB"><type>RhythmDB</type></link> instance
126
119
</simpara></listitem></varlistentry>
127
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> new query creator widget
 
120
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> new query creator widget
128
121
</simpara></listitem></varlistentry>
129
122
</variablelist></refsect2>
130
123
<refsect2 id="rb-query-creator-new-from-query" role="function">
131
124
<title>rb_query_creator_new_from_query ()</title>
132
 
<indexterm zone="rb-query-creator-new-from-query"><primary>rb_query_creator_new_from_query</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*          rb_query_creator_new_from_query     (<link linkend="RhythmDB">RhythmDB</link> *db,
 
125
<indexterm zone="rb-query-creator-new-from-query"><primary sortas="rb_query_creator_new_from_query">rb_query_creator_new_from_query</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link> *         rb_query_creator_new_from_query     (<link linkend="RhythmDB">RhythmDB</link> *db,
133
126
                                                         <link linkend="GPtrArray">GPtrArray</link> *query,
134
127
                                                         <link linkend="RhythmDBQueryModelLimitType">RhythmDBQueryModelLimitType</link> limit_type,
135
128
                                                         <link linkend="GValueArray">GValueArray</link> *limit_value,
139
132
Constructs a new query creator with an existing query and limit and sort
140
133
settings.</para>
141
134
<para>
142
 
 
143
135
</para><variablelist role="params">
144
 
<varlistentry><term><parameter>db</parameter>&nbsp;:</term>
 
136
<varlistentry><term><parameter>db</parameter>&#160;:</term>
145
137
<listitem><simpara> the <link linkend="RhythmDB"><type>RhythmDB</type></link> instance
146
138
</simpara></listitem></varlistentry>
147
 
<varlistentry><term><parameter>query</parameter>&nbsp;:</term>
 
139
<varlistentry><term><parameter>query</parameter>&#160;:</term>
148
140
<listitem><simpara> an existing query to start from
149
141
</simpara></listitem></varlistentry>
150
 
<varlistentry><term><parameter>limit_type</parameter>&nbsp;:</term>
 
142
<varlistentry><term><parameter>limit_type</parameter>&#160;:</term>
151
143
<listitem><simpara> the type of result set limit
152
144
</simpara></listitem></varlistentry>
153
 
<varlistentry><term><parameter>limit_value</parameter>&nbsp;:</term>
 
145
<varlistentry><term><parameter>limit_value</parameter>&#160;:</term>
154
146
<listitem><simpara> the result set limit value
155
147
</simpara></listitem></varlistentry>
156
 
<varlistentry><term><parameter>sort_column</parameter>&nbsp;:</term>
 
148
<varlistentry><term><parameter>sort_column</parameter>&#160;:</term>
157
149
<listitem><simpara> the column on which to sort query results
158
150
</simpara></listitem></varlistentry>
159
 
<varlistentry><term><parameter>sort_direction</parameter>&nbsp;:</term>
 
151
<varlistentry><term><parameter>sort_direction</parameter>&#160;:</term>
160
152
<listitem><simpara> the direction in which to sort query results
161
153
</simpara></listitem></varlistentry>
162
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> new query creator widget
 
154
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> new query creator widget
163
155
</simpara></listitem></varlistentry>
164
156
</variablelist></refsect2>
165
157
<refsect2 id="rb-query-creator-get-query" role="function">
166
158
<title>rb_query_creator_get_query ()</title>
167
 
<indexterm zone="rb-query-creator-get-query"><primary>rb_query_creator_get_query</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link>*          rb_query_creator_get_query          (<link linkend="RBQueryCreator">RBQueryCreator</link> *creator);</programlisting>
 
159
<indexterm zone="rb-query-creator-get-query"><primary sortas="rb_query_creator_get_query">rb_query_creator_get_query</primary></indexterm><programlisting><link linkend="GPtrArray">GPtrArray</link> *         rb_query_creator_get_query          (<link linkend="RBQueryCreator">RBQueryCreator</link> *creator);</programlisting>
168
160
<para>
169
161
Constructs a database query that represents the criteria in the query creator.</para>
170
162
<para>
171
 
 
172
163
</para><variablelist role="params">
173
 
<varlistentry><term><parameter>creator</parameter>&nbsp;:</term>
 
164
<varlistentry><term><parameter>creator</parameter>&#160;:</term>
174
165
<listitem><simpara> <link linkend="RBQueryCreator"><type>RBQueryCreator</type></link> instance
175
166
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> database query array
 
167
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> database query array
177
168
</simpara></listitem></varlistentry>
178
169
</variablelist></refsect2>
179
170
<refsect2 id="rb-query-creator-get-limit" role="function">
180
171
<title>rb_query_creator_get_limit ()</title>
181
 
<indexterm zone="rb-query-creator-get-limit"><primary>rb_query_creator_get_limit</primary></indexterm><programlisting><link linkend="void">void</link>                rb_query_creator_get_limit          (<link linkend="RBQueryCreator">RBQueryCreator</link> *creator,
 
172
<indexterm zone="rb-query-creator-get-limit"><primary sortas="rb_query_creator_get_limit">rb_query_creator_get_limit</primary></indexterm><programlisting><link linkend="void">void</link>                rb_query_creator_get_limit          (<link linkend="RBQueryCreator">RBQueryCreator</link> *creator,
182
173
                                                         <link linkend="RhythmDBQueryModelLimitType">RhythmDBQueryModelLimitType</link> *type,
183
174
                                                         <link linkend="GValueArray">GValueArray</link> **limit);</programlisting>
184
175
<para>
186
177
The limit value is returned as the first element in a
187
178
<link linkend="GValueArray"><type>GValueArray</type></link>.</para>
188
179
<para>
189
 
 
190
180
</para><variablelist role="params">
191
 
<varlistentry><term><parameter>creator</parameter>&nbsp;:</term>
 
181
<varlistentry><term><parameter>creator</parameter>&#160;:</term>
192
182
<listitem><simpara> <link linkend="RBQueryCreator"><type>RBQueryCreator</type></link> instance
193
183
</simpara></listitem></varlistentry>
194
 
<varlistentry><term><parameter>type</parameter>&nbsp;:</term>
 
184
<varlistentry><term><parameter>type</parameter>&#160;:</term>
195
185
<listitem><simpara> used to return the limit type
196
186
</simpara></listitem></varlistentry>
197
 
<varlistentry><term><parameter>limit</parameter>&nbsp;:</term>
 
187
<varlistentry><term><parameter>limit</parameter>&#160;:</term>
198
188
<listitem><simpara> used to return the limit value
199
189
</simpara></listitem></varlistentry>
200
190
</variablelist></refsect2>
201
191
<refsect2 id="rb-query-creator-get-sort-order" role="function">
202
192
<title>rb_query_creator_get_sort_order ()</title>
203
 
<indexterm zone="rb-query-creator-get-sort-order"><primary>rb_query_creator_get_sort_order</primary></indexterm><programlisting><link linkend="void">void</link>                rb_query_creator_get_sort_order     (<link linkend="RBQueryCreator">RBQueryCreator</link> *creator,
 
193
<indexterm zone="rb-query-creator-get-sort-order"><primary sortas="rb_query_creator_get_sort_order">rb_query_creator_get_sort_order</primary></indexterm><programlisting><link linkend="void">void</link>                rb_query_creator_get_sort_order     (<link linkend="RBQueryCreator">RBQueryCreator</link> *creator,
204
194
                                                         const <link linkend="char">char</link> **sort_key,
205
195
                                                         <link linkend="gint">gint</link> *sort_direction);</programlisting>
206
196
<para>
207
197
Retrieves the sort settings from the query creator.
208
198
The sort direction is returned as a <link linkend="GtkSortType"><type>GtkSortType</type></link> value.</para>
209
199
<para>
210
 
 
211
200
</para><variablelist role="params">
212
 
<varlistentry><term><parameter>creator</parameter>&nbsp;:</term>
 
201
<varlistentry><term><parameter>creator</parameter>&#160;:</term>
213
202
<listitem><simpara> <link linkend="RBQueryCreator"><type>RBQueryCreator</type></link> instance
214
203
</simpara></listitem></varlistentry>
215
 
<varlistentry><term><parameter>sort_key</parameter>&nbsp;:</term>
 
204
<varlistentry><term><parameter>sort_key</parameter>&#160;:</term>
216
205
<listitem><simpara> returns the sort key name
217
206
</simpara></listitem></varlistentry>
218
 
<varlistentry><term><parameter>sort_direction</parameter>&nbsp;:</term>
 
207
<varlistentry><term><parameter>sort_direction</parameter>&#160;:</term>
219
208
<listitem><simpara> returns the sort direction
220
209
</simpara></listitem></varlistentry>
221
210
</variablelist></refsect2>
223
212
</refsect1>
224
213
<refsect1 id="RBQueryCreator.property-details" role="property_details">
225
214
<title role="property_details.title">Property Details</title>
226
 
<refsect2 id="RBQueryCreator--creating"><title>The <literal>&quot;creating&quot;</literal> property</title>
227
 
<indexterm zone="RBQueryCreator--creating"><primary>RBQueryCreator:creating</primary></indexterm><programlisting>  &quot;creating&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
 
215
<refsect2 id="RBQueryCreator--creating" role="property"><title>The <literal>&quot;creating&quot;</literal> property</title>
 
216
<indexterm zone="RBQueryCreator--creating"><primary sortas="RBQueryCreator:creating">RBQueryCreator:creating</primary></indexterm><programlisting>  &quot;creating&quot;                 <link linkend="gboolean">gboolean</link>              : Read / Write / Construct Only</programlisting>
228
217
<para>
229
218
TRUE if a new playlist is being created.</para>
230
219
<para>
231
 
 
232
220
</para><para>Default value: TRUE</para>
233
221
</refsect2>
234
 
<refsect2 id="RBQueryCreator--db"><title>The <literal>&quot;db&quot;</literal> property</title>
235
 
<indexterm zone="RBQueryCreator--db"><primary>RBQueryCreator:db</primary></indexterm><programlisting>  &quot;db&quot;                       <link linkend="RhythmDB">RhythmDB</link>*             : Read / Write / Construct Only</programlisting>
 
222
<refsect2 id="RBQueryCreator--db" role="property"><title>The <literal>&quot;db&quot;</literal> property</title>
 
223
<indexterm zone="RBQueryCreator--db"><primary sortas="RBQueryCreator:db">RBQueryCreator:db</primary></indexterm><programlisting>  &quot;db&quot;                       <link linkend="RhythmDB">RhythmDB</link>*             : Read / Write / Construct Only</programlisting>
236
224
<para>
237
225
The <link linkend="RhythmDB"><type>RhythmDB</type></link> instance</para>
238
226
<para>
239
 
 
240
227
</para></refsect2>
241
 
 
242
228
</refsect1>
243
229
 
244
230