← Back to branch summary

~ubuntu-branches/ubuntu/oneiric/seahorse/oneiric-proposed-201111150713

« back to all changes in this revision

Viewing changes to reference/libcryptui/xml/cryptui-key-store.xml

  • Committer: Bazaar Package Importer
  • Author(s): Jordi Mallach
  • Date: 2011-04-14 23:26:01 UTC
  • mto: (3.1.7 sid) (1.2.59 upstream)
  • mto: This revision was merged to the branch mainline in revision 97.
  • Revision ID: james.westby@ubuntu.com-20110414232601-a1f1ibqayicoj8sd
Import upstream version 3.0.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
reference/libcryptui/xml/cryptui-key-store.xml
1
 
<?xml version="1.0"?>
2
 
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3
 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
4
 
<!ENTITY version SYSTEM "version.xml"> 
5
 
]>
6
 
<refentry id="libcryptui-CryptUIKeyStore">
7
 
<refmeta>
8
 
<refentrytitle role="top_of_page" id="libcryptui-CryptUIKeyStore.top_of_page">CryptUIKeyStore</refentrytitle>
9
 
<manvolnum>3</manvolnum>
10
 
<refmiscinfo>LIBCRYPTUI Library</refmiscinfo>
11
 
</refmeta>
12
 
 
13
 
<refnamediv>
14
 
<refname>CryptUIKeyStore</refname>
15
 
<refpurpose></refpurpose>
16
 
</refnamediv>
17
 
 
18
 
<refsynopsisdiv id="libcryptui-CryptUIKeyStore.synopsis" role="synopsis">
19
 
<title role="synopsis.title">Synopsis</title>
20
 
 
21
 
<synopsis>
22
 
                    <link linkend="CryptUIKeyStorePriv">CryptUIKeyStorePriv</link>;
23
 
                    <link linkend="CryptUIKeyStore">CryptUIKeyStore</link>;
24
 
enum                <link linkend="CryptUIKeyStoreMode">CryptUIKeyStoreMode</link>;
25
 
<link linkend="gboolean">gboolean</link>            (<link linkend="CryptUIKeyStoreFilterFunc">*CryptUIKeyStoreFilterFunc</link>)        (<link linkend="CryptUIKeyset">CryptUIKeyset</link> *ckset,
26
 
                                                         const <link linkend="gchar">gchar</link> *key,
27
 
                                                         <link linkend="gpointer">gpointer</link> user_data);
28
 
<link linkend="CryptUIKeyStore">CryptUIKeyStore</link>*    <link linkend="cryptui-key-store-new">cryptui_key_store_new</link>               (<link linkend="CryptUIKeyset">CryptUIKeyset</link> *keyset,
29
 
                                                         <link linkend="gboolean">gboolean</link> use_checks,
30
 
                                                         const <link linkend="gchar">gchar</link> *none_option);
31
 
<link linkend="CryptUIKeyset">CryptUIKeyset</link>*      <link linkend="cryptui-key-store-get-keyset">cryptui_key_store_get_keyset</link>        (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore);
32
 
<link linkend="void">void</link>                <link linkend="cryptui-key-store-set-sortable">cryptui_key_store_set_sortable</link>      (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
33
 
                                                         <link linkend="gboolean">gboolean</link> sortable);
34
 
<link linkend="gboolean">gboolean</link>            <link linkend="cryptui-key-store-get-sortable">cryptui_key_store_get_sortable</link>      (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore);
35
 
<link linkend="void">void</link>                <link linkend="cryptui-key-store-check-toggled">cryptui_key_store_check_toggled</link>     (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
36
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view,
37
 
                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
38
 
<link linkend="gboolean">gboolean</link>            <link linkend="cryptui-key-store-get-iter-from-key">cryptui_key_store_get_iter_from_key</link> (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
39
 
                                                         const <link linkend="gchar">gchar</link> *key,
40
 
                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
41
 
const <link linkend="gchar">gchar</link>*        <link linkend="cryptui-key-store-get-key-from-iter">cryptui_key_store_get_key_from_iter</link> (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
42
 
                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);
43
 
const <link linkend="gchar">gchar</link>*        <link linkend="cryptui-key-store-get-key-from-path">cryptui_key_store_get_key_from_path</link> (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
44
 
                                                         <link linkend="GtkTreePath">GtkTreePath</link> *path);
45
 
<link linkend="GList">GList</link>*              <link linkend="cryptui-key-store-get-all-keys">cryptui_key_store_get_all_keys</link>      (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore);
46
 
<link linkend="guint">guint</link>               <link linkend="cryptui-key-store-get-count">cryptui_key_store_get_count</link>         (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore);
47
 
<link linkend="gboolean">gboolean</link>            <link linkend="cryptui-key-store-have-selected-keys">cryptui_key_store_have_selected_keys</link>
48
 
                                                        (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
49
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view);
50
 
<link linkend="GList">GList</link>*              <link linkend="cryptui-key-store-get-selected-keys">cryptui_key_store_get_selected_keys</link> (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
51
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view);
52
 
<link linkend="void">void</link>                <link linkend="cryptui-key-store-set-selected-keys">cryptui_key_store_set_selected_keys</link> (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
53
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view,
54
 
                                                         <link linkend="GList">GList</link> *keys);
55
 
const <link linkend="gchar">gchar</link>*        <link linkend="cryptui-key-store-get-selected-key">cryptui_key_store_get_selected_key</link>  (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
56
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view);
57
 
<link linkend="void">void</link>                <link linkend="cryptui-key-store-set-selected-key">cryptui_key_store_set_selected_key</link>  (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
58
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view,
59
 
                                                         const <link linkend="gchar">gchar</link> *selkey);
60
 
<link linkend="void">void</link>                <link linkend="cryptui-key-store-set-search-mode">cryptui_key_store_set_search_mode</link>   (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
61
 
                                                         <link linkend="CryptUIKeyStoreMode">CryptUIKeyStoreMode</link> mode);
62
 
<link linkend="void">void</link>                <link linkend="cryptui-key-store-set-search-text">cryptui_key_store_set_search_text</link>   (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
63
 
                                                         const <link linkend="gchar">gchar</link> *search_text);
64
 
<link linkend="void">void</link>                <link linkend="cryptui-key-store-set-filter">cryptui_key_store_set_filter</link>        (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
65
 
                                                         <link linkend="CryptUIKeyStoreFilterFunc">CryptUIKeyStoreFilterFunc</link> func,
66
 
                                                         <link linkend="gpointer">gpointer</link> user_data);
67
 
</synopsis>
68
 
</refsynopsisdiv>
69
 
 
70
 
 
71
 
 
72
 
 
73
 
 
74
 
 
75
 
 
76
 
 
77
 
 
78
 
<refsect1 id="libcryptui-CryptUIKeyStore.description" role="desc">
79
 
<title role="desc.title">Description</title>
80
 
<para>
81
 
</para>
82
 
</refsect1>
83
 
 
84
 
<refsect1 id="libcryptui-CryptUIKeyStore.details" role="details">
85
 
<title role="details.title">Details</title>
86
 
<refsect2 id="CryptUIKeyStorePriv" role="struct">
87
 
<title>CryptUIKeyStorePriv</title>
88
 
<indexterm zone="CryptUIKeyStorePriv"><primary sortas="KeyStorePriv">CryptUIKeyStorePriv</primary></indexterm><programlisting>typedef struct _CryptUIKeyStorePriv CryptUIKeyStorePriv;</programlisting>
89
 
<para>
90
 
</para></refsect2>
91
 
<refsect2 id="CryptUIKeyStore" role="struct">
92
 
<title>CryptUIKeyStore</title>
93
 
<indexterm zone="CryptUIKeyStore"><primary sortas="KeyStore">CryptUIKeyStore</primary></indexterm><programlisting>typedef struct {
94
 
    GtkTreeModelSort       parent;
95
 
 
96
 
    CryptUIKeyset          *ckset;
97
 
} CryptUIKeyStore;
98
 
</programlisting>
99
 
<para>
100
 
</para></refsect2>
101
 
<refsect2 id="CryptUIKeyStoreMode" role="enum">
102
 
<title>enum CryptUIKeyStoreMode</title>
103
 
<indexterm zone="CryptUIKeyStoreMode"><primary sortas="KeyStoreMode">CryptUIKeyStoreMode</primary></indexterm><programlisting>typedef enum _CryptUIKeyStoreMode {
104
 
    CRYPTUI_KEY_STORE_MODE_ALL,
105
 
    CRYPTUI_KEY_STORE_MODE_SELECTED,
106
 
    CRYPTUI_KEY_STORE_MODE_RESULTS
107
 
} CryptUIKeyStoreMode;
108
 
</programlisting>
109
 
<para>
110
 
</para></refsect2>
111
 
<refsect2 id="CryptUIKeyStoreFilterFunc" role="function">
112
 
<title>CryptUIKeyStoreFilterFunc ()</title>
113
 
<indexterm zone="CryptUIKeyStoreFilterFunc"><primary sortas="KeyStoreFilterFunc">CryptUIKeyStoreFilterFunc</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            (*CryptUIKeyStoreFilterFunc)        (<link linkend="CryptUIKeyset">CryptUIKeyset</link> *ckset,
114
 
                                                         const <link linkend="gchar">gchar</link> *key,
115
 
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
116
 
<para>
117
 
</para><variablelist role="params">
118
 
<varlistentry><term><parameter>ckset</parameter>&#160;:</term>
119
 
<listitem><simpara>
120
 
</simpara></listitem></varlistentry>
121
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
122
 
<listitem><simpara>
123
 
</simpara></listitem></varlistentry>
124
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
125
 
<listitem><simpara>
126
 
</simpara></listitem></varlistentry>
127
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara>
128
 
</simpara></listitem></varlistentry>
129
 
</variablelist></refsect2>
130
 
<refsect2 id="cryptui-key-store-new" role="function">
131
 
<title>cryptui_key_store_new ()</title>
132
 
<indexterm zone="cryptui-key-store-new"><primary sortas="key_store_new">cryptui_key_store_new</primary></indexterm><programlisting><link linkend="CryptUIKeyStore">CryptUIKeyStore</link>*    cryptui_key_store_new               (<link linkend="CryptUIKeyset">CryptUIKeyset</link> *keyset,
133
 
                                                         <link linkend="gboolean">gboolean</link> use_checks,
134
 
                                                         const <link linkend="gchar">gchar</link> *none_option);</programlisting>
135
 
<para>
136
 
Creates a new libcryptui key store setting the keystore, use-checks and none-option
137
 
properties</para>
138
 
<para>
139
 
</para><variablelist role="params">
140
 
<varlistentry><term><parameter>keyset</parameter>&#160;:</term>
141
 
<listitem><simpara> a libcryptui keyset
142
 
</simpara></listitem></varlistentry>
143
 
<varlistentry><term><parameter>use_checks</parameter>&#160;:</term>
144
 
<listitem><simpara> a gboolean
145
 
</simpara></listitem></varlistentry>
146
 
<varlistentry><term><parameter>none_option</parameter>&#160;:</term>
147
 
<listitem><simpara> a const gchar string
148
 
</simpara></listitem></varlistentry>
149
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the new libcryptui key store
150
 
</simpara></listitem></varlistentry>
151
 
</variablelist></refsect2>
152
 
<refsect2 id="cryptui-key-store-get-keyset" role="function">
153
 
<title>cryptui_key_store_get_keyset ()</title>
154
 
<indexterm zone="cryptui-key-store-get-keyset"><primary sortas="key_store_get_keyset">cryptui_key_store_get_keyset</primary></indexterm><programlisting><link linkend="CryptUIKeyset">CryptUIKeyset</link>*      cryptui_key_store_get_keyset        (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore);</programlisting>
155
 
<para>
156
 
Gets ckstore's internal keyset</para>
157
 
<para>
158
 
</para><variablelist role="params">
159
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
160
 
<listitem><simpara> a libcryptui key store
161
 
</simpara></listitem></varlistentry>
162
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the internal libcryptui keyset
163
 
</simpara></listitem></varlistentry>
164
 
</variablelist></refsect2>
165
 
<refsect2 id="cryptui-key-store-set-sortable" role="function">
166
 
<title>cryptui_key_store_set_sortable ()</title>
167
 
<indexterm zone="cryptui-key-store-set-sortable"><primary sortas="key_store_set_sortable">cryptui_key_store_set_sortable</primary></indexterm><programlisting><link linkend="void">void</link>                cryptui_key_store_set_sortable      (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
168
 
                                                         <link linkend="gboolean">gboolean</link> sortable);</programlisting>
169
 
<para>
170
 
Sets whether ckstore is sortable or not</para>
171
 
<para>
172
 
</para><variablelist role="params">
173
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
174
 
<listitem><simpara> a libcryptui key store
175
 
</simpara></listitem></varlistentry>
176
 
<varlistentry><term><parameter>sortable</parameter>&#160;:</term>
177
 
<listitem><simpara> a gboolean
178
 
</simpara></listitem></varlistentry>
179
 
</variablelist></refsect2>
180
 
<refsect2 id="cryptui-key-store-get-sortable" role="function">
181
 
<title>cryptui_key_store_get_sortable ()</title>
182
 
<indexterm zone="cryptui-key-store-get-sortable"><primary sortas="key_store_get_sortable">cryptui_key_store_get_sortable</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            cryptui_key_store_get_sortable      (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore);</programlisting>
183
 
<para>
184
 
Gets whether ckstore is sortable or not</para>
185
 
<para>
186
 
</para><variablelist role="params">
187
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
188
 
<listitem><simpara> a libcryptui key store
189
 
</simpara></listitem></varlistentry>
190
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if ckstore is sortable, FALSE otherwise
191
 
</simpara></listitem></varlistentry>
192
 
</variablelist></refsect2>
193
 
<refsect2 id="cryptui-key-store-check-toggled" role="function">
194
 
<title>cryptui_key_store_check_toggled ()</title>
195
 
<indexterm zone="cryptui-key-store-check-toggled"><primary sortas="key_store_check_toggled">cryptui_key_store_check_toggled</primary></indexterm><programlisting><link linkend="void">void</link>                cryptui_key_store_check_toggled     (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
196
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view,
197
 
                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
198
 
<para>
199
 
Gets whether the check at iter is toggled</para>
200
 
<para>
201
 
</para><variablelist role="params">
202
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
203
 
<listitem><simpara> a libcryptui key store
204
 
</simpara></listitem></varlistentry>
205
 
<varlistentry><term><parameter>view</parameter>&#160;:</term>
206
 
<listitem><simpara> a GtkTreeView
207
 
</simpara></listitem></varlistentry>
208
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
209
 
<listitem><simpara> a GtkTreeIter
210
 
</simpara></listitem></varlistentry>
211
 
</variablelist></refsect2>
212
 
<refsect2 id="cryptui-key-store-get-iter-from-key" role="function">
213
 
<title>cryptui_key_store_get_iter_from_key ()</title>
214
 
<indexterm zone="cryptui-key-store-get-iter-from-key"><primary sortas="key_store_get_iter_from_key">cryptui_key_store_get_iter_from_key</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            cryptui_key_store_get_iter_from_key (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
215
 
                                                         const <link linkend="gchar">gchar</link> *key,
216
 
                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
217
 
<para>
218
 
Get the iter that the key is stored at in ckstore</para>
219
 
<para>
220
 
</para><variablelist role="params">
221
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
222
 
<listitem><simpara> a libcryptui key store
223
 
</simpara></listitem></varlistentry>
224
 
<varlistentry><term><parameter>key</parameter>&#160;:</term>
225
 
<listitem><simpara> a libcryptui key
226
 
</simpara></listitem></varlistentry>
227
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
228
 
<listitem><simpara> a GtkTreeIter
229
 
</simpara></listitem></varlistentry>
230
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if the key is present in the ckstore and the value of iter
231
 
         has been modified to point to it, FALSE otherwise
232
 
</simpara></listitem></varlistentry>
233
 
</variablelist></refsect2>
234
 
<refsect2 id="cryptui-key-store-get-key-from-iter" role="function">
235
 
<title>cryptui_key_store_get_key_from_iter ()</title>
236
 
<indexterm zone="cryptui-key-store-get-key-from-iter"><primary sortas="key_store_get_key_from_iter">cryptui_key_store_get_key_from_iter</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        cryptui_key_store_get_key_from_iter (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
237
 
                                                         <link linkend="GtkTreeIter">GtkTreeIter</link> *iter);</programlisting>
238
 
<para>
239
 
Gets the key stored at iter in ckstore</para>
240
 
<para>
241
 
</para><variablelist role="params">
242
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
243
 
<listitem><simpara> a libcryptui key store
244
 
</simpara></listitem></varlistentry>
245
 
<varlistentry><term><parameter>iter</parameter>&#160;:</term>
246
 
<listitem><simpara> a GtkTreeIter
247
 
</simpara></listitem></varlistentry>
248
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a libcryptui key
249
 
</simpara></listitem></varlistentry>
250
 
</variablelist></refsect2>
251
 
<refsect2 id="cryptui-key-store-get-key-from-path" role="function">
252
 
<title>cryptui_key_store_get_key_from_path ()</title>
253
 
<indexterm zone="cryptui-key-store-get-key-from-path"><primary sortas="key_store_get_key_from_path">cryptui_key_store_get_key_from_path</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        cryptui_key_store_get_key_from_path (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
254
 
                                                         <link linkend="GtkTreePath">GtkTreePath</link> *path);</programlisting>
255
 
<para>
256
 
Get the key at path in ckstore</para>
257
 
<para>
258
 
</para><variablelist role="params">
259
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
260
 
<listitem><simpara> a libcryptui key store
261
 
</simpara></listitem></varlistentry>
262
 
<varlistentry><term><parameter>path</parameter>&#160;:</term>
263
 
<listitem><simpara> a GtkTreePath
264
 
</simpara></listitem></varlistentry>
265
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a libcryptui key
266
 
</simpara></listitem></varlistentry>
267
 
</variablelist></refsect2>
268
 
<refsect2 id="cryptui-key-store-get-all-keys" role="function">
269
 
<title>cryptui_key_store_get_all_keys ()</title>
270
 
<indexterm zone="cryptui-key-store-get-all-keys"><primary sortas="key_store_get_all_keys">cryptui_key_store_get_all_keys</primary></indexterm><programlisting><link linkend="GList">GList</link>*              cryptui_key_store_get_all_keys      (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore);</programlisting>
271
 
<para>
272
 
Get a list of all keys in ckstore</para>
273
 
<para>
274
 
</para><variablelist role="params">
275
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
276
 
<listitem><simpara> a libcryptui key store
277
 
</simpara></listitem></varlistentry>
278
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a list of libcryptui keys
279
 
</simpara></listitem></varlistentry>
280
 
</variablelist></refsect2>
281
 
<refsect2 id="cryptui-key-store-get-count" role="function">
282
 
<title>cryptui_key_store_get_count ()</title>
283
 
<indexterm zone="cryptui-key-store-get-count"><primary sortas="key_store_get_count">cryptui_key_store_get_count</primary></indexterm><programlisting><link linkend="guint">guint</link>               cryptui_key_store_get_count         (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore);</programlisting>
284
 
<para>
285
 
Get the number of keys stored in ckstore</para>
286
 
<para>
287
 
</para><variablelist role="params">
288
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
289
 
<listitem><simpara> a libcryptui key store
290
 
</simpara></listitem></varlistentry>
291
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> the number of keys
292
 
</simpara></listitem></varlistentry>
293
 
</variablelist></refsect2>
294
 
<refsect2 id="cryptui-key-store-have-selected-keys" role="function">
295
 
<title>cryptui_key_store_have_selected_keys ()</title>
296
 
<indexterm zone="cryptui-key-store-have-selected-keys"><primary sortas="key_store_have_selected_keys">cryptui_key_store_have_selected_keys</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link>            cryptui_key_store_have_selected_keys
297
 
                                                        (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
298
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view);</programlisting>
299
 
<para>
300
 
Determines whether keys are selected or not.</para>
301
 
<para>
302
 
</para><variablelist role="params">
303
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
304
 
<listitem><simpara> a libcryptui key store
305
 
</simpara></listitem></varlistentry>
306
 
<varlistentry><term><parameter>view</parameter>&#160;:</term>
307
 
<listitem><simpara> a GtkTreeView
308
 
</simpara></listitem></varlistentry>
309
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> TRUE if keys have been selected, FALSE otherwise
310
 
</simpara></listitem></varlistentry>
311
 
</variablelist></refsect2>
312
 
<refsect2 id="cryptui-key-store-get-selected-keys" role="function">
313
 
<title>cryptui_key_store_get_selected_keys ()</title>
314
 
<indexterm zone="cryptui-key-store-get-selected-keys"><primary sortas="key_store_get_selected_keys">cryptui_key_store_get_selected_keys</primary></indexterm><programlisting><link linkend="GList">GList</link>*              cryptui_key_store_get_selected_keys (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
315
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view);</programlisting>
316
 
<para>
317
 
Get the currently selected keys</para>
318
 
<para>
319
 
</para><variablelist role="params">
320
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
321
 
<listitem><simpara> a libcryptui key store
322
 
</simpara></listitem></varlistentry>
323
 
<varlistentry><term><parameter>view</parameter>&#160;:</term>
324
 
<listitem><simpara> a GtkTreeView
325
 
</simpara></listitem></varlistentry>
326
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a list of libcryptui keys
327
 
</simpara></listitem></varlistentry>
328
 
</variablelist></refsect2>
329
 
<refsect2 id="cryptui-key-store-set-selected-keys" role="function">
330
 
<title>cryptui_key_store_set_selected_keys ()</title>
331
 
<indexterm zone="cryptui-key-store-set-selected-keys"><primary sortas="key_store_set_selected_keys">cryptui_key_store_set_selected_keys</primary></indexterm><programlisting><link linkend="void">void</link>                cryptui_key_store_set_selected_keys (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
332
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view,
333
 
                                                         <link linkend="GList">GList</link> *keys);</programlisting>
334
 
<para>
335
 
Set the current selection to be the list of keys</para>
336
 
<para>
337
 
</para><variablelist role="params">
338
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
339
 
<listitem><simpara> a libcryptui key store
340
 
</simpara></listitem></varlistentry>
341
 
<varlistentry><term><parameter>view</parameter>&#160;:</term>
342
 
<listitem><simpara> a GtkTreeView
343
 
</simpara></listitem></varlistentry>
344
 
<varlistentry><term><parameter>keys</parameter>&#160;:</term>
345
 
<listitem><simpara> a list of libcryptui keys
346
 
</simpara></listitem></varlistentry>
347
 
</variablelist></refsect2>
348
 
<refsect2 id="cryptui-key-store-get-selected-key" role="function">
349
 
<title>cryptui_key_store_get_selected_key ()</title>
350
 
<indexterm zone="cryptui-key-store-get-selected-key"><primary sortas="key_store_get_selected_key">cryptui_key_store_get_selected_key</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>*        cryptui_key_store_get_selected_key  (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
351
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view);</programlisting>
352
 
<para>
353
 
Get the currently selected key</para>
354
 
<para>
355
 
</para><variablelist role="params">
356
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
357
 
<listitem><simpara> a libcryptui key store
358
 
</simpara></listitem></varlistentry>
359
 
<varlistentry><term><parameter>view</parameter>&#160;:</term>
360
 
<listitem><simpara> a GtkTreeView
361
 
</simpara></listitem></varlistentry>
362
 
<varlistentry><term><emphasis>Returns</emphasis>&#160;:</term><listitem><simpara> a libcryptui key
363
 
</simpara></listitem></varlistentry>
364
 
</variablelist></refsect2>
365
 
<refsect2 id="cryptui-key-store-set-selected-key" role="function">
366
 
<title>cryptui_key_store_set_selected_key ()</title>
367
 
<indexterm zone="cryptui-key-store-set-selected-key"><primary sortas="key_store_set_selected_key">cryptui_key_store_set_selected_key</primary></indexterm><programlisting><link linkend="void">void</link>                cryptui_key_store_set_selected_key  (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
368
 
                                                         <link linkend="GtkTreeView">GtkTreeView</link> *view,
369
 
                                                         const <link linkend="gchar">gchar</link> *selkey);</programlisting>
370
 
<para>
371
 
Marks the given key as selected</para>
372
 
<para>
373
 
</para><variablelist role="params">
374
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
375
 
<listitem><simpara> a libcryptui key store
376
 
</simpara></listitem></varlistentry>
377
 
<varlistentry><term><parameter>view</parameter>&#160;:</term>
378
 
<listitem><simpara> a GtkTreeView
379
 
</simpara></listitem></varlistentry>
380
 
<varlistentry><term><parameter>selkey</parameter>&#160;:</term>
381
 
<listitem><simpara> a libcryptui key
382
 
</simpara></listitem></varlistentry>
383
 
</variablelist></refsect2>
384
 
<refsect2 id="cryptui-key-store-set-search-mode" role="function">
385
 
<title>cryptui_key_store_set_search_mode ()</title>
386
 
<indexterm zone="cryptui-key-store-set-search-mode"><primary sortas="key_store_set_search_mode">cryptui_key_store_set_search_mode</primary></indexterm><programlisting><link linkend="void">void</link>                cryptui_key_store_set_search_mode   (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
387
 
                                                         <link linkend="CryptUIKeyStoreMode">CryptUIKeyStoreMode</link> mode);</programlisting>
388
 
<para>
389
 
Sets whether the keys returned will be all, just those searched for, or
390
 
those selected.</para>
391
 
<para>
392
 
</para><variablelist role="params">
393
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
394
 
<listitem><simpara> a libcryptui key store
395
 
</simpara></listitem></varlistentry>
396
 
<varlistentry><term><parameter>mode</parameter>&#160;:</term>
397
 
<listitem><simpara> search mode
398
 
</simpara></listitem></varlistentry>
399
 
</variablelist></refsect2>
400
 
<refsect2 id="cryptui-key-store-set-search-text" role="function">
401
 
<title>cryptui_key_store_set_search_text ()</title>
402
 
<indexterm zone="cryptui-key-store-set-search-text"><primary sortas="key_store_set_search_text">cryptui_key_store_set_search_text</primary></indexterm><programlisting><link linkend="void">void</link>                cryptui_key_store_set_search_text   (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
403
 
                                                         const <link linkend="gchar">gchar</link> *search_text);</programlisting>
404
 
<para>
405
 
Filters the keys in the store by the text in search_text.</para>
406
 
<para>
407
 
</para><variablelist role="params">
408
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
409
 
<listitem><simpara> a libcryptui key store
410
 
</simpara></listitem></varlistentry>
411
 
<varlistentry><term><parameter>search_text</parameter>&#160;:</term>
412
 
<listitem><simpara> a string
413
 
</simpara></listitem></varlistentry>
414
 
</variablelist></refsect2>
415
 
<refsect2 id="cryptui-key-store-set-filter" role="function">
416
 
<title>cryptui_key_store_set_filter ()</title>
417
 
<indexterm zone="cryptui-key-store-set-filter"><primary sortas="key_store_set_filter">cryptui_key_store_set_filter</primary></indexterm><programlisting><link linkend="void">void</link>                cryptui_key_store_set_filter        (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
418
 
                                                         <link linkend="CryptUIKeyStoreFilterFunc">CryptUIKeyStoreFilterFunc</link> func,
419
 
                                                         <link linkend="gpointer">gpointer</link> user_data);</programlisting>
420
 
<para>
421
 
Filters the key store's keys with the given filter function.</para>
422
 
<para>
423
 
</para><variablelist role="params">
424
 
<varlistentry><term><parameter>ckstore</parameter>&#160;:</term>
425
 
<listitem><simpara> a libcryptui key store
426
 
</simpara></listitem></varlistentry>
427
 
<varlistentry><term><parameter>func</parameter>&#160;:</term>
428
 
<listitem><simpara> a filter function
429
 
</simpara></listitem></varlistentry>
430
 
<varlistentry><term><parameter>user_data</parameter>&#160;:</term>
431
 
<listitem><simpara> a generic pointer
432
 
</simpara></listitem></varlistentry>
433
 
</variablelist></refsect2>
434
 
 
435
 
</refsect1>
436
 
 
437
 
 
438
 
 
439
 
 
440
 
</refentry>