libcryptui-doc 3.8.0-1 / usr / share / gtk-doc / html / libcryptui / libcryptui-cryptui-key-chooser.html

This file is indexed.

/usr/share/gtk-doc/html/libcryptui/libcryptui-cryptui-key-chooser.html is in libcryptui-doc 3.8.0-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below. 

  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
300
301
302
303
304
305
306
307
308
309
310
311
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CryptUIKeyChooser</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.78.1">
<link rel="home" href="index.html" title="libcryptui Reference Manual">
<link rel="up" href="ch01.html" title="libcryptui Objects and Functions">
<link rel="prev" href="libcryptui-cryptui-key-list.html" title="cryptui-key-list">
<link rel="next" href="libcryptui-cryptui-key-store.html" title="CryptUIKeyStore">
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="libcryptui-cryptui-key-list.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="ch01.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">libcryptui Reference Manual</th>
<td><a accesskey="n" href="libcryptui-cryptui-key-store.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#libcryptui-cryptui-key-chooser.synopsis" class="shortcut">Top</a>
                   | 
                  <a href="#libcryptui-cryptui-key-chooser.description" class="shortcut">Description</a>
</td></tr>
</table>
<div class="refentry">
<a name="libcryptui-cryptui-key-chooser"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="libcryptui-cryptui-key-chooser.top_of_page"></a>CryptUIKeyChooser</span></h2>
<p>CryptUIKeyChooser</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="libcryptui-cryptui-key-chooser.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">enum                <a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooserMode" title="enum CryptUIKeyChooserMode">CryptUIKeyChooserMode</a>;
                    <a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooserPriv" title="CryptUIKeyChooserPriv">CryptUIKeyChooserPriv</a>;
struct              <a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser">CryptUIKeyChooser</a>;
<a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="returnvalue">CryptUIKeyChooser</span></a> * <a class="link" href="libcryptui-cryptui-key-chooser.html#cryptui-key-chooser-new" title="cryptui_key_chooser_new ()">cryptui_key_chooser_new</a>             (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-keyset.html#CryptUIKeyset" title="struct CryptUIKeyset"><span class="type">CryptUIKeyset</span></a> *ckset</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooserMode" title="enum CryptUIKeyChooserMode"><span class="type">CryptUIKeyChooserMode</span></a> mode</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libcryptui-cryptui-key-chooser.html#cryptui-key-chooser-get-enforce-prefs" title="cryptui_key_chooser_get_enforce_prefs ()">cryptui_key_chooser_get_enforce_prefs</a>
                                                        (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libcryptui-cryptui-key-chooser.html#cryptui-key-chooser-set-enforce-prefs" title="cryptui_key_chooser_set_enforce_prefs ()">cryptui_key_chooser_set_enforce_prefs</a>
                                                        (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> enforce_prefs</code></em>);
<span class="returnvalue">gboolean</span>            <a class="link" href="libcryptui-cryptui-key-chooser.html#cryptui-key-chooser-have-recipients" title="cryptui_key_chooser_have_recipients ()">cryptui_key_chooser_have_recipients</a> (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>);
<span class="returnvalue">GList</span> *             <a class="link" href="libcryptui-cryptui-key-chooser.html#cryptui-key-chooser-get-recipients" title="cryptui_key_chooser_get_recipients ()">cryptui_key_chooser_get_recipients</a>  (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libcryptui-cryptui-key-chooser.html#cryptui-key-chooser-set-recipients" title="cryptui_key_chooser_set_recipients ()">cryptui_key_chooser_set_recipients</a>  (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>,
                                                         <em class="parameter"><code><span class="type">GList</span> *keys</code></em>);
const <span class="returnvalue">gchar</span> *       <a class="link" href="libcryptui-cryptui-key-chooser.html#cryptui-key-chooser-get-signer" title="cryptui_key_chooser_get_signer ()">cryptui_key_chooser_get_signer</a>      (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>);
<span class="returnvalue">void</span>                <a class="link" href="libcryptui-cryptui-key-chooser.html#cryptui-key-chooser-set-signer" title="cryptui_key_chooser_set_signer ()">cryptui_key_chooser_set_signer</a>      (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="libcryptui-cryptui-key-chooser.description"></a><h2>Description</h2>
<p>
</p>
</div>
<div class="refsect1">
<a name="libcryptui-cryptui-key-chooser.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="CryptUIKeyChooserMode"></a><h3>enum CryptUIKeyChooserMode</h3>
<pre class="programlisting">typedef enum {
    CRYPTUI_KEY_CHOOSER_RECIPIENTS =    0x0001,
    CRYPTUI_KEY_CHOOSER_SIGNER =        0x0002,
    
    CRYPTUI_KEY_CHOOSER_MUSTSIGN =      0x0010
} CryptUIKeyChooserMode;
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CryptUIKeyChooserPriv"></a><h3>CryptUIKeyChooserPriv</h3>
<pre class="programlisting">typedef struct _CryptUIKeyChooserPriv CryptUIKeyChooserPriv;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="CryptUIKeyChooser"></a><h3>struct CryptUIKeyChooser</h3>
<pre class="programlisting">struct CryptUIKeyChooser {
    GtkVBox               parent;
};
</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="cryptui-key-chooser-new"></a><h3>cryptui_key_chooser_new ()</h3>
<pre class="programlisting"><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="returnvalue">CryptUIKeyChooser</span></a> * cryptui_key_chooser_new             (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-keyset.html#CryptUIKeyset" title="struct CryptUIKeyset"><span class="type">CryptUIKeyset</span></a> *ckset</code></em>,
                                                         <em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooserMode" title="enum CryptUIKeyChooserMode"><span class="type">CryptUIKeyChooserMode</span></a> mode</code></em>);</pre>
<p>
Creates a key chooser widget from a key set.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>ckset</code></em> :</span></p></td>
<td>key set to choose keys from</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>mode</code></em> :</span></p></td>
<td>how to display the signer portion of the widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>a key shooser widget</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cryptui-key-chooser-get-enforce-prefs"></a><h3>cryptui_key_chooser_get_enforce_prefs ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            cryptui_key_chooser_get_enforce_prefs
                                                        (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>);</pre>
<p>
Gets whether or not the preference to encrypt to self will be enforced.  If
TRUE, the default signing key will be added to the recipient list.  If FALSE,
the selected recipients will be returned without adding the default signing
key.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>the key chooser widget</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>whether or not the default signing key will be included in the
recipients even if not selected</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cryptui-key-chooser-set-enforce-prefs"></a><h3>cryptui_key_chooser_set_enforce_prefs ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                cryptui_key_chooser_set_enforce_prefs
                                                        (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>,
                                                         <em class="parameter"><code><span class="type">gboolean</span> enforce_prefs</code></em>);</pre>
<p>
Sets whether or not the preference to encrypt to self will be enforced.  If
TRUE, the default signing key will be added to the recipient list.  If FALSE,
the selected recipients will be returned without adding the default signing
key.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>the chooser widget</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>enforce_prefs</code></em> :</span></p></td>
<td>whether or not the default signing key will be included in the
recipients even if not selected</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cryptui-key-chooser-have-recipients"></a><h3>cryptui_key_chooser_have_recipients ()</h3>
<pre class="programlisting"><span class="returnvalue">gboolean</span>            cryptui_key_chooser_have_recipients (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>);</pre>
<p>
Determines if recipient keys have been selected.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>the chooser to check</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if recipients have been selected.</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cryptui-key-chooser-get-recipients"></a><h3>cryptui_key_chooser_get_recipients ()</h3>
<pre class="programlisting"><span class="returnvalue">GList</span> *             cryptui_key_chooser_get_recipients  (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>);</pre>
<p>
This function returns a list of recipients selected in the chooser widget.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>the chooser to get selected recipients from</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the list of recipients</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cryptui-key-chooser-set-recipients"></a><h3>cryptui_key_chooser_set_recipients ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                cryptui_key_chooser_set_recipients  (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>,
                                                         <em class="parameter"><code><span class="type">GList</span> *keys</code></em>);</pre>
<p>
Marks the listed keys as selected in the chooser widget.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>the chooser to set recipients on</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>keys</code></em> :</span></p></td>
<td>the list of recipients to mark selected</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cryptui-key-chooser-get-signer"></a><h3>cryptui_key_chooser_get_signer ()</h3>
<pre class="programlisting">const <span class="returnvalue">gchar</span> *       cryptui_key_chooser_get_signer      (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>);</pre>
<p>
Gets the key of the selected signer from the chooser widget.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>the chooser widget to get the signer from</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the selected signer's key</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="cryptui-key-chooser-set-signer"></a><h3>cryptui_key_chooser_set_signer ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span>                cryptui_key_chooser_set_signer      (<em class="parameter"><code><a class="link" href="libcryptui-cryptui-key-chooser.html#CryptUIKeyChooser" title="struct CryptUIKeyChooser"><span class="type">CryptUIKeyChooser</span></a> *chooser</code></em>,
                                                         <em class="parameter"><code>const <span class="type">gchar</span> *key</code></em>);</pre>
<p>
Sets the signer in the chooser to the provided key.
</p>
<div class="variablelist"><table border="0" class="variablelist">
<colgroup>
<col align="left" valign="top">
<col>
</colgroup>
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>chooser</code></em> :</span></p></td>
<td>the chooser to set the signer on</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>key</code></em> :</span></p></td>
<td>the signer key to set</td>
</tr>
</tbody>
</table></div>
</div>
</div>
</div>
<div class="footer">
<hr>
          Generated by GTK-Doc V1.18</div>
</body>
</html>

APT Browse - Built by Thomas Orozco.