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
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
|
<refentry id="streamtuner-st-dialog-api">
<refmeta>
<refentrytitle>st-dialog</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>STREAMTUNER Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>st-dialog</refname><refpurpose>functions for outputting messages and displaying simple dialogs.</refpurpose>
</refnamediv>
<refsynopsisdiv><title>Synopsis</title>
<synopsis>
<link linkend="void">void</link> <link linkend="st-notice">st_notice</link> (const <link linkend="char">char</link> *format,
...);
<link linkend="void">void</link> <link linkend="st-info-dialog">st_info_dialog</link> (const <link linkend="char">char</link> *primary,
const <link linkend="char">char</link> *format,
...);
<link linkend="void">void</link> <link linkend="st-error-dialog">st_error_dialog</link> (const <link linkend="char">char</link> *primary,
const <link linkend="char">char</link> *format,
...);
<link linkend="char">char</link>* <link linkend="st-search-dialog">st_search_dialog</link> (void);
<link linkend="gboolean">gboolean</link> <link linkend="st-auth-dialog">st_auth_dialog</link> (const <link linkend="char">char</link> *default_name,
const <link linkend="char">char</link> *default_password,
<link linkend="char">char</link> **name,
<link linkend="char">char</link> **password,
const <link linkend="char">char</link> *primary,
const <link linkend="char">char</link> *format,
...);
<link linkend="char">char</link>* <link linkend="st-dialog-normalize">st_dialog_normalize</link> (const <link linkend="char">char</link> *str);
<link linkend="void">void</link> <link linkend="st-warning">st_warning</link> (const <link linkend="char">char</link> *format,
...);
<link linkend="void">void</link> <link linkend="st-error">st_error</link> (const <link linkend="char">char</link> *format,
...);
<link linkend="int">int</link> <link linkend="st-question">st_question</link> (const <link linkend="char">char</link> *format,
...);
<link linkend="char">char</link>* <link linkend="st-prompt">st_prompt</link> (<link linkend="gboolean">gboolean</link> hidden,
const <link linkend="char">char</link> *init,
const <link linkend="char">char</link> *format,
...);
</synopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
These functions provide support for outputting messages to the console
as well as displaying graphical message dialogs.
</para>
</refsect1>
<refsect1>
<title>Details</title>
<refsect2>
<title><anchor id="st-notice"/>st_notice ()</title>
<indexterm><primary>st_notice</primary></indexterm><programlisting><link linkend="void">void</link> st_notice (const <link linkend="char">char</link> *format,
...);</programlisting>
<para>
Outputs a formatted streamtuner notice to the standard error output.
</para>
<para>
If you need to output a notice regarding a specific handler, use
<link linkend="st-handler-notice"><function>st_handler_notice()</function></link> instead of this function.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara> the message format. See the <link linkend="printf"><function>printf()</function></link> documentation.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> the parameters to insert into the format string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-info-dialog"/>st_info_dialog ()</title>
<indexterm><primary>st_info_dialog</primary></indexterm><programlisting><link linkend="void">void</link> st_info_dialog (const <link linkend="char">char</link> *primary,
const <link linkend="char">char</link> *format,
...);</programlisting>
<para>
Displays an informational dialog.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>primary</parameter> :</term>
<listitem><simpara> the primary text, or <literal>NULL</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara> the secondary text format, or <literal>NULL</literal>. See the <link linkend="printf"><function>printf()</function></link>
documentation.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> the parameters to insert into the format string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-error-dialog"/>st_error_dialog ()</title>
<indexterm><primary>st_error_dialog</primary></indexterm><programlisting><link linkend="void">void</link> st_error_dialog (const <link linkend="char">char</link> *primary,
const <link linkend="char">char</link> *format,
...);</programlisting>
<para>
Displays an error dialog.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>primary</parameter> :</term>
<listitem><simpara> the primary text, or <literal>NULL</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara> the secondary text format, or <literal>NULL</literal>. See the <link linkend="printf"><function>printf()</function></link>
documentation.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> the parameters to insert into the format string.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-search-dialog"/>st_search_dialog ()</title>
<indexterm><primary>st_search_dialog</primary></indexterm><programlisting><link linkend="char">char</link>* st_search_dialog (void);</programlisting>
<para>
Prompts the user for a search string.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a search string which should be freed after use, or
<literal>NULL</literal> if the user pressed the cancel button.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-auth-dialog"/>st_auth_dialog ()</title>
<indexterm><primary>st_auth_dialog</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> st_auth_dialog (const <link linkend="char">char</link> *default_name,
const <link linkend="char">char</link> *default_password,
<link linkend="char">char</link> **name,
<link linkend="char">char</link> **password,
const <link linkend="char">char</link> *primary,
const <link linkend="char">char</link> *format,
...);</programlisting>
<para>
Prompts the user for a name and password. The name and password
entries will be initialized to <parameter>default_name</parameter> and <parameter>default_password</parameter>,
if provided.
</para>
<para>
The entered name and password will be stored in <parameter>name</parameter> and
<parameter>password</parameter>, and should be freed when no longer needed. If <parameter>name</parameter> is
<literal>NULL</literal>, the name entry will not be made sensitive.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>default_name</parameter> :</term>
<listitem><simpara> a default name, or <literal>NULL</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>default_password</parameter> :</term>
<listitem><simpara> a default password, or <literal>NULL</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>name</parameter> :</term>
<listitem><simpara> a location to return the entered name, or <literal>NULL</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>password</parameter> :</term>
<listitem><simpara> a location to return the entered password.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>primary</parameter> :</term>
<listitem><simpara> the primary text, or <literal>NULL</literal>.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara> the secondary text format, or <literal>NULL</literal>. See the <link linkend="printf"><function>printf()</function></link>
documentation.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara> the parameters to insert into the format string.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <literal>TRUE</literal> if the user pressed the "Authenticate" button,
<literal>FALSE</literal> otherwise. If <literal>FALSE</literal> is returned, <parameter>name</parameter> and <parameter>password</parameter> will
not be set.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-dialog-normalize"/>st_dialog_normalize ()</title>
<indexterm><primary>st_dialog_normalize</primary></indexterm><programlisting><link linkend="char">char</link>* st_dialog_normalize (const <link linkend="char">char</link> *str);</programlisting>
<para>
Normalizes a string so that it can be used stand-alone as the
secondary string of a dialog.
</para>
<para>
Normalization will remove trailing newlines and convert the string
to a sentence.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>str</parameter> :</term>
<listitem><simpara> a string to normalize.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a normalized string, which should be freed after use.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-warning"/>st_warning ()</title>
<indexterm><primary>st_warning</primary></indexterm><programlisting><link linkend="void">void</link> st_warning (const <link linkend="char">char</link> *format,
...);</programlisting>
<warning><para><literal>st_warning</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-error"/>st_error ()</title>
<indexterm><primary>st_error</primary></indexterm><programlisting><link linkend="void">void</link> st_error (const <link linkend="char">char</link> *format,
...);</programlisting>
<warning><para><literal>st_error</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-question"/>st_question ()</title>
<indexterm><primary>st_question</primary></indexterm><programlisting><link linkend="int">int</link> st_question (const <link linkend="char">char</link> *format,
...);</programlisting>
<warning><para><literal>st_question</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="st-prompt"/>st_prompt ()</title>
<indexterm><primary>st_prompt</primary></indexterm><programlisting><link linkend="char">char</link>* st_prompt (<link linkend="gboolean">gboolean</link> hidden,
const <link linkend="char">char</link> *init,
const <link linkend="char">char</link> *format,
...);</programlisting>
<warning><para><literal>st_prompt</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>hidden</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>init</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>format</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>...</parameter> :</term>
<listitem><simpara>
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<link linkend="st-handler-notice"><function>st_handler_notice()</function></link>
</para>
</refsect1>
</refentry>
|
