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
|
<?xml version="1.0"?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
<!ENTITY version SYSTEM "version.xml">
]>
<refentry id="libcryptui-cryptui-key-list">
<refmeta>
<refentrytitle role="top_of_page" id="libcryptui-cryptui-key-list.top_of_page">cryptui-key-list</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBCRYPTUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>cryptui-key-list</refname>
<refpurpose></refpurpose>
</refnamediv>
<refsynopsisdiv id="libcryptui-cryptui-key-list.synopsis" role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
<link linkend="GtkTreeView">GtkTreeView</link>* <link linkend="cryptui-key-list-new">cryptui_key_list_new</link> (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
<link linkend="guint">guint</link> flags);
<link linkend="void">void</link> <link linkend="cryptui-key-list-setup">cryptui_key_list_setup</link> (<link linkend="GtkTreeView">GtkTreeView</link> *view,
<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
<link linkend="guint">guint</link> flags);
<link linkend="CryptUIKeyStore">CryptUIKeyStore</link>* <link linkend="cryptui-key-list-get-key-store">cryptui_key_list_get_key_store</link> (<link linkend="GtkTreeView">GtkTreeView</link> *list);
<link linkend="CryptUIKeyset">CryptUIKeyset</link>* <link linkend="cryptui-key-list-get-keyset">cryptui_key_list_get_keyset</link> (<link linkend="GtkTreeView">GtkTreeView</link> *list);
<link linkend="gboolean">gboolean</link> <link linkend="cryptui-key-list-have-selected-keys">cryptui_key_list_have_selected_keys</link> (<link linkend="GtkTreeView">GtkTreeView</link> *list);
<link linkend="GList">GList</link>* <link linkend="cryptui-key-list-get-selected-keys">cryptui_key_list_get_selected_keys</link> (<link linkend="GtkTreeView">GtkTreeView</link> *list);
<link linkend="void">void</link> <link linkend="cryptui-key-list-set-selected-keys">cryptui_key_list_set_selected_keys</link> (<link linkend="GtkTreeView">GtkTreeView</link> *list,
<link linkend="GList">GList</link> *keys);
const <link linkend="gchar">gchar</link>* <link linkend="cryptui-key-list-get-selected-key">cryptui_key_list_get_selected_key</link> (<link linkend="GtkTreeView">GtkTreeView</link> *list);
<link linkend="void">void</link> <link linkend="cryptui-key-list-set-selected-key">cryptui_key_list_set_selected_key</link> (<link linkend="GtkTreeView">GtkTreeView</link> *list,
const <link linkend="gchar">gchar</link> *key);
</synopsis>
</refsynopsisdiv>
<refsect1 id="libcryptui-cryptui-key-list.description" role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 id="libcryptui-cryptui-key-list.details" role="details">
<title role="details.title">Details</title>
<refsect2 id="cryptui-key-list-new" role="function">
<title>cryptui_key_list_new ()</title>
<indexterm zone="cryptui-key-list-new"><primary sortas="key_list_new">cryptui_key_list_new</primary></indexterm><programlisting><link linkend="GtkTreeView">GtkTreeView</link>* cryptui_key_list_new (<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
<link linkend="guint">guint</link> flags);</programlisting>
<para>
Creates a new key list widget displaying keys from the key store that match
the given flags.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>ckstore</parameter> :</term>
<listitem><simpara> a CryptUIKeyStore containing keys to list
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> CryptUIKeyFlags indicating which keys from the store to list
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the new key list widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cryptui-key-list-setup" role="function">
<title>cryptui_key_list_setup ()</title>
<indexterm zone="cryptui-key-list-setup"><primary sortas="key_list_setup">cryptui_key_list_setup</primary></indexterm><programlisting><link linkend="void">void</link> cryptui_key_list_setup (<link linkend="GtkTreeView">GtkTreeView</link> *view,
<link linkend="CryptUIKeyStore">CryptUIKeyStore</link> *ckstore,
<link linkend="guint">guint</link> flags);</programlisting>
<para>
Changes an existing GtkTreeView into a CryptUIKeyList using the key store
as the model and the filters the view based on the given flags.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>view</parameter> :</term>
<listitem><simpara> an existing tree view to be turned into a CryptUIKeyList
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>ckstore</parameter> :</term>
<listitem><simpara> a CryptUIKeyStore containing keys to list
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>flags</parameter> :</term>
<listitem><simpara> CryptUIKeyFlags indicating which keys from the store to list
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cryptui-key-list-get-key-store" role="function">
<title>cryptui_key_list_get_key_store ()</title>
<indexterm zone="cryptui-key-list-get-key-store"><primary sortas="key_list_get_key_store">cryptui_key_list_get_key_store</primary></indexterm><programlisting><link linkend="CryptUIKeyStore">CryptUIKeyStore</link>* cryptui_key_list_get_key_store (<link linkend="GtkTreeView">GtkTreeView</link> *list);</programlisting>
<para>
Gets the CryptuiKeyStore used as a model by the CryptuiKeyList</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> a CryptUIKeyList
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a CryptUIKeyList
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cryptui-key-list-get-keyset" role="function">
<title>cryptui_key_list_get_keyset ()</title>
<indexterm zone="cryptui-key-list-get-keyset"><primary sortas="key_list_get_keyset">cryptui_key_list_get_keyset</primary></indexterm><programlisting><link linkend="CryptUIKeyset">CryptUIKeyset</link>* cryptui_key_list_get_keyset (<link linkend="GtkTreeView">GtkTreeView</link> *list);</programlisting>
<para>
Gets the keyset from the key store set as the model in the list</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> a CryptUIKeyList
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a CryptUIKeyset
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cryptui-key-list-have-selected-keys" role="function">
<title>cryptui_key_list_have_selected_keys ()</title>
<indexterm zone="cryptui-key-list-have-selected-keys"><primary sortas="key_list_have_selected_keys">cryptui_key_list_have_selected_keys</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> cryptui_key_list_have_selected_keys (<link linkend="GtkTreeView">GtkTreeView</link> *list);</programlisting>
<para>
Used to determine if any keys have been selected</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> a CryptUIKeyList
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> TRUE if keys have been selected, FALSE otherwise
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cryptui-key-list-get-selected-keys" role="function">
<title>cryptui_key_list_get_selected_keys ()</title>
<indexterm zone="cryptui-key-list-get-selected-keys"><primary sortas="key_list_get_selected_keys">cryptui_key_list_get_selected_keys</primary></indexterm><programlisting><link linkend="GList">GList</link>* cryptui_key_list_get_selected_keys (<link linkend="GtkTreeView">GtkTreeView</link> *list);</programlisting>
<para>
Gets the kyes selected in the list</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> a CryptUIKeyList
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a list of selected keys
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cryptui-key-list-set-selected-keys" role="function">
<title>cryptui_key_list_set_selected_keys ()</title>
<indexterm zone="cryptui-key-list-set-selected-keys"><primary sortas="key_list_set_selected_keys">cryptui_key_list_set_selected_keys</primary></indexterm><programlisting><link linkend="void">void</link> cryptui_key_list_set_selected_keys (<link linkend="GtkTreeView">GtkTreeView</link> *list,
<link linkend="GList">GList</link> *keys);</programlisting>
<para>
Selects the given list of keys in the list</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> a CryptUIKeyList
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>keys</parameter> :</term>
<listitem><simpara> a list of CryptUI keys
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cryptui-key-list-get-selected-key" role="function">
<title>cryptui_key_list_get_selected_key ()</title>
<indexterm zone="cryptui-key-list-get-selected-key"><primary sortas="key_list_get_selected_key">cryptui_key_list_get_selected_key</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* cryptui_key_list_get_selected_key (<link linkend="GtkTreeView">GtkTreeView</link> *list);</programlisting>
<para>
</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> a CryptUIKeyList
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the selected key
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2 id="cryptui-key-list-set-selected-key" role="function">
<title>cryptui_key_list_set_selected_key ()</title>
<indexterm zone="cryptui-key-list-set-selected-key"><primary sortas="key_list_set_selected_key">cryptui_key_list_set_selected_key</primary></indexterm><programlisting><link linkend="void">void</link> cryptui_key_list_set_selected_key (<link linkend="GtkTreeView">GtkTreeView</link> *list,
const <link linkend="gchar">gchar</link> *key);</programlisting>
<para>
Selects the given key in the list widget</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>list</parameter> :</term>
<listitem><simpara> a CryptUIKeyList
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>key</parameter> :</term>
<listitem><simpara> the key to set
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
