~ubuntu-branches/ubuntu/karmic/libtinymail/karmic : revision 1

1

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">

2

<html>

3

<head>

4

5

<title>TnyPasswordGetter</title>

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

</head>

25

26

27

28

29

30

31

<th width="100%" align="center">Reference Manual of the tinymail framework</th>

32

33

</tr>

34

35

 | 

36

<a href="#id2631336" class="shortcut">Description</a>

37

 | 

38

<a href="#id2631288" class="shortcut">Object Hierarchy</a>

39

 | 

40

<a href="#id2631313" class="shortcut">Known Implementations</a></nobr></td></tr>

41

</table>

42

43

44

45

46

<h2>

47

<a name="id2631174"></a><span class="refentrytitle">TnyPasswordGetter</span>

48

</h2>

49

<p>TnyPasswordGetter — A type for asking the user for a password</p>

50

</td>

51

52

</tr></table></div>

53

54

<h2>Synopsis</h2>

55

56

57

58

59

<a href="libtinymail-tny-password-getter.html#TnyPasswordGetter-struct">TnyPasswordGetter</a>;

60

<a href="libtinymail-tny-password-getter.html#TnyPasswordGetterIface">TnyPasswordGetterIface</a>;

61

const gchar* <a href="libtinymail-tny-password-getter.html#tny-password-getter-get-password">tny_password_getter_get_password</a> (<a href="libtinymail-tny-password-getter.html#TnyPasswordGetter">TnyPasswordGetter</a> *self,

62

const gchar *aid,

63

const gchar *prompt,

64

gboolean *cancel);

65

void <a href="libtinymail-tny-password-getter.html#tny-password-getter-forget-password">tny_password_getter_forget_password</a> (<a href="libtinymail-tny-password-getter.html#TnyPasswordGetter">TnyPasswordGetter</a> *self,

66

const gchar *aid);

67

68

</pre>

69

</div>

70

71

<a name="id2631288"></a><h2>Object Hierarchy</h2>

72

73

74

GInterface

75

+----TnyPasswordGetter

76

</pre>

77

</div>

78

79

<a name="id2631313"></a><h2>Known Implementations</h2>

80

<p>

81

TnyPasswordGetter is implemented by

82

<a href="TnyGtkPasswordDialog.html" title="TnyGtkPasswordDialog">TnyGtkPasswordDialog</a>.</p>

83

</div>

84

85

<a name="id2631336"></a><h2>Description</h2>

86

<p>

87

A type for asking the user for a password

88

</p>

89

</div>

90

91

<a name="id2631351"></a><h2>Details</h2>

92

93

94

<a name="TnyPasswordGetter-struct"></a>TnyPasswordGetter</h3>

95

<a class="indexterm" name="id2631375"></a><pre class="programlisting">typedef struct _TnyPasswordGetter TnyPasswordGetter;</pre>

96

<p>

97

98

</p>

99

</div>

100

<hr>

101

102

103

<a name="TnyPasswordGetterIface"></a>TnyPasswordGetterIface</h3>

104

<a class="indexterm" name="id2631404"></a><pre class="programlisting">typedef struct {

105

GTypeInterface parent;

106

107

const gchar* (*get_password_func) (TnyPasswordGetter *self, const gchar *aid, const gchar *prompt, gboolean *cancel);

108

void (*forget_password_func) (TnyPasswordGetter *self, const gchar *aid);

109

} TnyPasswordGetterIface;

110

</pre>

111

<p>

112

113

</p>

114

</div>

115

<hr>

116

117

118

<a name="tny-password-getter-get-password"></a>tny_password_getter_get_password ()</h3>

119

<a class="indexterm" name="id2631437"></a><pre class="programlisting">const gchar* tny_password_getter_get_password (<a href="libtinymail-tny-password-getter.html#TnyPasswordGetter">TnyPasswordGetter</a> *self,

120

const gchar *aid,

121

const gchar *prompt,

122

gboolean *cancel);</pre>

123

<p>

124

Get the password of <em class="parameter"><code>self</code></em> identified by <em class="parameter"><code>aid</code></em>. If you set the by reference

125

boolean <em class="parameter"><code>cancel</code></em> to TRUE, the caller (who requested the password) will see

126

this as a negative answer (For example when the user didn't know the password,

127

and therefore pressed a cancel button).

128

</p>

129

<p>

130

The <em class="parameter"><code>aid</code></em> string can be used for so called password stores. It will contain

131

a unique string. Possible values of this string are "acap.server.com" or the

132

result of a tny_account_get_id.</p>

133

<p>

134

135

</p>

136

137

138

<tbody>

139

<tr>

140

141

<td> a <a href="libtinymail-tny-password-getter.html#TnyPasswordGetter"><span class="type">TnyPasswordGetter</span></a> object

142

</td>

143

</tr>

144

<tr>

145

146

<td> a unique string identifying the requested password

147

</td>

148

</tr>

149

<tr>

150

<td><span class="term"><em class="parameter"><code>prompt</code></em> :</span></td>

151

<td> A human-readable password question, possibly containing an untranslated error

152

message directly from the server. This should be ignored by most implementations,

153

so NULL is an acceptable value.

154

</td>

155

</tr>

156

<tr>

157

<td><span class="term"><em class="parameter"><code>cancel</code></em> :</span></td>

158

<td> whether or not the user cancelled

159

</td>

160

</tr>

161

<tr>

162

<td><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></td>

163

<td> the password

164

</td>

165

</tr>

166

</tbody>

167

</table></div>

168

</div>

169

<hr>

170

171

172

<a name="tny-password-getter-forget-password"></a>tny_password_getter_forget_password ()</h3>

173

<a class="indexterm" name="id2631624"></a><pre class="programlisting">void tny_password_getter_forget_password (<a href="libtinymail-tny-password-getter.html#TnyPasswordGetter">TnyPasswordGetter</a> *self,

174

const gchar *aid);</pre>

175

<p>

176

Forget the password in <em class="parameter"><code>self</code></em> identified by <em class="parameter"><code>aid</code></em>.</p>

177

<p>

178

179

</p>

180

181

182

<tbody>

183

<tr>

184

185

<td> a <a href="libtinymail-tny-password-getter.html#TnyPasswordGetter"><span class="type">TnyPasswordGetter</span></a> object

186

</td>

187

</tr>

188

<tr>

189

190

<td> a unique string identifying the requested password

191

</td>

192

</tr>

193

</tbody>

194

</table></div>

195

</div>

196

</div>

197

198

199

<p>

200

<a href="TnyGtkPasswordDialog.html" title="TnyGtkPasswordDialog"><span class="type">TnyGtkPasswordDialog</span></a>

201

</p>

202

</div>

203

</div>

204

</body>

205

</html>